spotifywebapiPython 1.0.84__py3-none-any.whl → 1.0.86__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.

This version of spotifywebapiPython might be problematic. Click here for more details.

Files changed (22) hide show
  1. {spotifywebapiPython-1.0.84.dist-info → spotifywebapiPython-1.0.86.dist-info}/METADATA +1 -1
  2. {spotifywebapiPython-1.0.84.dist-info → spotifywebapiPython-1.0.86.dist-info}/RECORD +22 -22
  3. spotifywebapipython/const.py +6 -1
  4. spotifywebapipython/docs/__init__.html +19 -2
  5. spotifywebapipython/docs/index.html +2 -2
  6. spotifywebapipython/docs/search.js +1 -1
  7. spotifywebapipython/docs/spotifywebapiPython/const.html +20 -3
  8. spotifywebapipython/docs/spotifywebapiPython/saappmessages.html +2 -2
  9. spotifywebapipython/docs/spotifywebapiPython/sautils.html +2 -2
  10. spotifywebapipython/docs/spotifywebapiPython/spotifyapierror.html +2 -2
  11. spotifywebapipython/docs/spotifywebapiPython/spotifyapimessage.html +2 -2
  12. spotifywebapipython/docs/spotifywebapiPython/spotifyauthtoken.html +2 -2
  13. spotifywebapipython/docs/spotifywebapiPython/spotifyclient.html +128 -42
  14. spotifywebapipython/docs/spotifywebapiPython/spotifydiscovery.html +2 -2
  15. spotifywebapipython/docs/spotifywebapiPython/spotifywebapiauthenticationerror.html +2 -2
  16. spotifywebapipython/docs/spotifywebapiPython/spotifywebapierror.html +2 -2
  17. spotifywebapipython/oauthcli/authclient.py +22 -5
  18. spotifywebapipython/spotifyclient.py +196 -27
  19. spotifywebapipython/zeroconfapi/zeroconfconnect.py +20 -1
  20. {spotifywebapiPython-1.0.84.dist-info → spotifywebapiPython-1.0.86.dist-info}/LICENSE +0 -0
  21. {spotifywebapiPython-1.0.84.dist-info → spotifywebapiPython-1.0.86.dist-info}/WHEEL +0 -0
  22. {spotifywebapiPython-1.0.84.dist-info → spotifywebapiPython-1.0.86.dist-info}/top_level.txt +0 -0
spotifywebapipython/docs/spotifywebapiPython/spotifyclient.html CHANGED
@@ -9,7 +9,7 @@
9
9
  </title>
10
10
  <link rel="icon" type="image/svg+xml" href="data:image/svg+xml,%3Csvg%20xmlns%3D%22http%3A//www.w3.org/2000/svg%22%20role%3D%22img%22%20aria-label%3D%22pdoc%20logo%22%20width%3D%22300%22%20height%3D%22150%22%20viewBox%3D%22-1%200%2060%2030%22%3E%3Ctitle%3Epdoc%3C/title%3E%3Cpath%20d%3D%22M29.621%2021.293c-.011-.273-.214-.475-.511-.481a.5.5%200%200%200-.489.503l-.044%201.393c-.097.551-.695%201.215-1.566%201.704-.577.428-1.306.486-2.193.182-1.426-.617-2.467-1.654-3.304-2.487l-.173-.172a3.43%203.43%200%200%200-.365-.306.49.49%200%200%200-.286-.196c-1.718-1.06-4.931-1.47-7.353.191l-.219.15c-1.707%201.187-3.413%202.131-4.328%201.03-.02-.027-.49-.685-.141-1.763.233-.721.546-2.408.772-4.076.042-.09.067-.187.046-.288.166-1.347.277-2.625.241-3.351%201.378-1.008%202.271-2.586%202.271-4.362%200-.976-.272-1.935-.788-2.774-.057-.094-.122-.18-.184-.268.033-.167.052-.339.052-.516%200-1.477-1.202-2.679-2.679-2.679-.791%200-1.496.352-1.987.9a6.3%206.3%200%200%200-1.001.029c-.492-.564-1.207-.929-2.012-.929-1.477%200-2.679%201.202-2.679%202.679A2.65%202.65%200%200%200%20.97%206.554c-.383.747-.595%201.572-.595%202.41%200%202.311%201.507%204.29%203.635%205.107-.037.699-.147%202.27-.423%203.294l-.137.461c-.622%202.042-2.515%208.257%201.727%2010.643%201.614.908%203.06%201.248%204.317%201.248%202.665%200%204.492-1.524%205.322-2.401%201.476-1.559%202.886-1.854%206.491.82%201.877%201.393%203.514%201.753%204.861%201.068%202.223-1.713%202.811-3.867%203.399-6.374.077-.846.056-1.469.054-1.537zm-4.835%204.313c-.054.305-.156.586-.242.629-.034-.007-.131-.022-.307-.157-.145-.111-.314-.478-.456-.908.221.121.432.25.675.355.115.039.219.051.33.081zm-2.251-1.238c-.05.33-.158.648-.252.694-.022.001-.125-.018-.307-.157-.217-.166-.488-.906-.639-1.573.358.344.754.693%201.198%201.036zm-3.887-2.337c-.006-.116-.018-.231-.041-.342.635.145%201.189.368%201.599.625.097.231.166.481.174.642-.03.049-.055.101-.067.158-.046.013-.128.026-.298.004-.278-.037-.901-.57-1.367-1.087zm-1.127-.497c.116.306.176.625.12.71-.019.014-.117.045-.345.016-.206-.027-.604-.332-.986-.695.41-.051.816-.056%201.211-.031zm-4.535%201.535c.209.22.379.47.358.598-.006.041-.088.138-.351.234-.144.055-.539-.063-.979-.259a11.66%2011.66%200%200%200%20.972-.573zm.983-.664c.359-.237.738-.418%201.126-.554.25.237.479.548.457.694-.006.042-.087.138-.351.235-.174.064-.694-.105-1.232-.375zm-3.381%201.794c-.022.145-.061.29-.149.401-.133.166-.358.248-.69.251h-.002c-.133%200-.306-.26-.45-.621.417.091.854.07%201.291-.031zm-2.066-8.077a4.78%204.78%200%200%201-.775-.584c.172-.115.505-.254.88-.378l-.105.962zm-.331%202.302a10.32%2010.32%200%200%201-.828-.502c.202-.143.576-.328.984-.49l-.156.992zm-.45%202.157l-.701-.403c.214-.115.536-.249.891-.376a11.57%2011.57%200%200%201-.19.779zm-.181%201.716c.064.398.194.702.298.893-.194-.051-.435-.162-.736-.398.061-.119.224-.3.438-.495zM8.87%204.141c0%20.152-.123.276-.276.276s-.275-.124-.275-.276.123-.276.276-.276.275.124.275.276zm-.735-.389a1.15%201.15%200%200%200-.314.783%201.16%201.16%200%200%200%201.162%201.162c.457%200%20.842-.27%201.032-.653.026.117.042.238.042.362a1.68%201.68%200%200%201-1.679%201.679%201.68%201.68%200%200%201-1.679-1.679c0-.843.626-1.535%201.436-1.654zM5.059%205.406A1.68%201.68%200%200%201%203.38%207.085a1.68%201.68%200%200%201-1.679-1.679c0-.037.009-.072.011-.109.21.3.541.508.935.508a1.16%201.16%200%200%200%201.162-1.162%201.14%201.14%200%200%200-.474-.912c.015%200%20.03-.005.045-.005.926.001%201.679.754%201.679%201.68zM3.198%204.141c0%20.152-.123.276-.276.276s-.275-.124-.275-.276.123-.276.276-.276.275.124.275.276zM1.375%208.964c0-.52.103-1.035.288-1.52.466.394%201.06.64%201.717.64%201.144%200%202.116-.725%202.499-1.738.383%201.012%201.355%201.738%202.499%201.738.867%200%201.631-.421%202.121-1.062.307.605.478%201.267.478%201.942%200%202.486-2.153%204.51-4.801%204.51s-4.801-2.023-4.801-4.51zm24.342%2019.349c-.985.498-2.267.168-3.813-.979-3.073-2.281-5.453-3.199-7.813-.705-1.315%201.391-4.163%203.365-8.423.97-3.174-1.786-2.239-6.266-1.261-9.479l.146-.492c.276-1.02.395-2.457.444-3.268a6.11%206.11%200%200%200%201.18.115%206.01%206.01%200%200%200%202.536-.562l-.006.175c-.802.215-1.848.612-2.021%201.25-.079.295.021.601.274.837.219.203.415.364.598.501-.667.304-1.243.698-1.311%201.179-.02.144-.022.507.393.787.213.144.395.26.564.365-1.285.521-1.361.96-1.381%201.126-.018.142-.011.496.427.746l.854.489c-.473.389-.971.914-.999%201.429-.018.278.095.532.316.713.675.556%201.231.721%201.653.721.059%200%20.104-.014.158-.02.207.707.641%201.64%201.513%201.64h.013c.8-.008%201.236-.345%201.462-.626.173-.216.268-.457.325-.692.424.195.93.374%201.372.374.151%200%20.294-.021.423-.068.732-.27.944-.704.993-1.021.009-.061.003-.119.002-.179.266.086.538.147.789.147.15%200%20.294-.021.423-.069.542-.2.797-.489.914-.754.237.147.478.258.704.288.106.014.205.021.296.021.356%200%20.595-.101.767-.229.438.435%201.094.992%201.656%201.067.106.014.205.021.296.021a1.56%201.56%200%200%200%20.323-.035c.17.575.453%201.289.866%201.605.358.273.665.362.914.362a.99.99%200%200%200%20.421-.093%201.03%201.03%200%200%200%20.245-.164c.168.428.39.846.68%201.068.358.273.665.362.913.362a.99.99%200%200%200%20.421-.093c.317-.148.512-.448.639-.762.251.157.495.257.726.257.127%200%20.25-.024.37-.071.427-.17.706-.617.841-1.314.022-.015.047-.022.068-.038.067-.051.133-.104.196-.159-.443%201.486-1.107%202.761-2.086%203.257zM8.66%209.925a.5.5%200%201%200-1%200c0%20.653-.818%201.205-1.787%201.205s-1.787-.552-1.787-1.205a.5.5%200%201%200-1%200c0%201.216%201.25%202.205%202.787%202.205s2.787-.989%202.787-2.205zm4.4%2015.965l-.208.097c-2.661%201.258-4.708%201.436-6.086.527-1.542-1.017-1.88-3.19-1.844-4.198a.4.4%200%200%200-.385-.414c-.242-.029-.406.164-.414.385-.046%201.249.367%203.686%202.202%204.896.708.467%201.547.7%202.51.7%201.248%200%202.706-.392%204.362-1.174l.185-.086a.4.4%200%200%200%20.205-.527c-.089-.204-.326-.291-.527-.206zM9.547%202.292c.093.077.205.114.317.114a.5.5%200%200%200%20.318-.886L8.817.397a.5.5%200%200%200-.703.068.5.5%200%200%200%20.069.703l1.364%201.124zm-7.661-.065c.086%200%20.173-.022.253-.068l1.523-.893a.5.5%200%200%200-.506-.863l-1.523.892a.5.5%200%200%200-.179.685c.094.158.261.247.432.247z%22%20transform%3D%22matrix%28-1%200%200%201%2058%200%29%22%20fill%3D%22%233bb300%22/%3E%3Cpath%20d%3D%22M.3%2021.86V10.18q0-.46.02-.68.04-.22.18-.5.28-.54%201.34-.54%201.06%200%201.42.28.38.26.44.78.76-1.04%202.38-1.04%201.64%200%203.1%201.54%201.46%201.54%201.46%203.58%200%202.04-1.46%203.58-1.44%201.54-3.08%201.54-1.64%200-2.38-.92v4.04q0%20.46-.04.68-.02.22-.18.5-.14.3-.5.42-.36.12-.98.12-.62%200-1-.12-.36-.12-.52-.4-.14-.28-.18-.5-.02-.22-.02-.68zm3.96-9.42q-.46.54-.46%201.18%200%20.64.46%201.18.48.52%201.2.52.74%200%201.24-.52.52-.52.52-1.18%200-.66-.48-1.18-.48-.54-1.26-.54-.76%200-1.22.54zm14.741-8.36q.16-.3.54-.42.38-.12%201-.12.64%200%201.02.12.38.12.52.42.16.3.18.54.04.22.04.68v11.94q0%20.46-.04.7-.02.22-.18.5-.3.54-1.7.54-1.38%200-1.54-.98-.84.96-2.34.96-1.8%200-3.28-1.56-1.48-1.58-1.48-3.66%200-2.1%201.48-3.68%201.5-1.58%203.28-1.58%201.48%200%202.3%201v-4.2q0-.46.02-.68.04-.24.18-.52zm-3.24%2010.86q.52.54%201.26.54.74%200%201.22-.54.5-.54.5-1.18%200-.66-.48-1.22-.46-.56-1.26-.56-.8%200-1.28.56-.48.54-.48%201.2%200%20.66.52%201.2zm7.833-1.2q0-2.4%201.68-3.96%201.68-1.56%203.84-1.56%202.16%200%203.82%201.56%201.66%201.54%201.66%203.94%200%201.66-.86%202.96-.86%201.28-2.1%201.9-1.22.6-2.54.6-1.32%200-2.56-.64-1.24-.66-2.1-1.92-.84-1.28-.84-2.88zm4.18%201.44q.64.48%201.3.48.66%200%201.32-.5.66-.5.66-1.48%200-.98-.62-1.46-.62-.48-1.34-.48-.72%200-1.34.5-.62.5-.62%201.48%200%20.96.64%201.46zm11.412-1.44q0%20.84.56%201.32.56.46%201.18.46.64%200%201.18-.36.56-.38.9-.38.6%200%201.46%201.06.46.58.46%201.04%200%20.76-1.1%201.42-1.14.8-2.8.8-1.86%200-3.58-1.34-.82-.64-1.34-1.7-.52-1.08-.52-2.36%200-1.3.52-2.34.52-1.06%201.34-1.7%201.66-1.32%203.54-1.32.76%200%201.48.22.72.2%201.06.4l.32.2q.36.24.56.38.52.4.52.92%200%20.5-.42%201.14-.72%201.1-1.38%201.1-.38%200-1.08-.44-.36-.34-1.04-.34-.66%200-1.24.48-.58.48-.58%201.34z%22%20fill%3D%22green%22/%3E%3C/svg%3E"/>
11
11
  <!-- build env - Package Name = "spotifywebapiPython" -->
12
- <!-- build env - Package Version = "1.0.84" -->
12
+ <!-- build env - Package Version = "1.0.86" -->
13
13
  <!-- pdoc module.modulename = "spotifywebapipython.spotifyclient" -->
14
14
  <!-- pdoc module.is_package = "False" -->
15
15
  <!-- pdoc root_module_name = "None" -->
@@ -75,6 +75,9 @@
75
75
  <li>
76
76
  <a class="variable" href="#SpotifyClient.TokenStorageDir">TokenStorageDir</a>
77
77
  </li>
78
+ <li>
79
+ <a class="variable" href="#SpotifyClient.TokenStorageFile">TokenStorageFile</a>
80
+ </li>
78
81
  <li>
79
82
  <a class="variable" href="#SpotifyClient.UserProfile">UserProfile</a>
80
83
  </li>
@@ -455,7 +458,7 @@
455
458
 
456
459
  <footer class="footertext">
457
460
  spotifywebapiPython</br>
458
- Version 1.0.84</br>
461
+ Version 1.0.86</br>
459
462
  <a href="https://developer.spotify.com/documentation/web-api" target="_blank">
460
463
  <img src="../spotifywebapipython.ico" alt="brand icon" style="width:32px; height:32px; padding:4px;"/>
461
464
  A Spotify Web Api Client
@@ -499,7 +502,7 @@ Spotify music service.</p>
499
502
  <div id="SpotifyClient.__init__" class="classattr">
500
503
  <div class="attr function">
501
504
 
502
- <span class="name">SpotifyClient</span><span class="signature pdoc-code multiline">(<span class="param"> <span class="n">manager</span><span class="p">:</span> <span class="n">urllib3</span><span class="o">.</span><span class="n">poolmanager</span><span class="o">.</span><span class="n">PoolManager</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param"> <span class="n">tokenStorageDir</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param"> <span class="n">tokenUpdater</span><span class="p">:</span> <span class="n">Callable</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param"> <span class="n">zeroconfClient</span><span class="p">:</span> <span class="n">zeroconf</span><span class="o">.</span><span class="n">_core</span><span class="o">.</span><span class="n">Zeroconf</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param"> <span class="n">spotifyConnectUsername</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param"> <span class="n">spotifyConnectPassword</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param"> <span class="n">spotifyConnectLoginId</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param"> <span class="n">spotifyConnectDiscoveryTimeout</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="mf">2.0</span></span>)</span>
505
+ <span class="name">SpotifyClient</span><span class="signature pdoc-code multiline">(<span class="param"> <span class="n">manager</span><span class="p">:</span> <span class="n">urllib3</span><span class="o">.</span><span class="n">poolmanager</span><span class="o">.</span><span class="n">PoolManager</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param"> <span class="n">tokenStorageDir</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param"> <span class="n">tokenStorageFile</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param"> <span class="n">tokenUpdater</span><span class="p">:</span> <span class="n">Callable</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param"> <span class="n">zeroconfClient</span><span class="p">:</span> <span class="n">zeroconf</span><span class="o">.</span><span class="n">_core</span><span class="o">.</span><span class="n">Zeroconf</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param"> <span class="n">spotifyConnectUsername</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param"> <span class="n">spotifyConnectPassword</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param"> <span class="n">spotifyConnectLoginId</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param"> <span class="n">spotifyConnectDiscoveryTimeout</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="mf">2.0</span></span>)</span>
503
506
 
504
507
 
505
508
  </div>
@@ -511,9 +514,11 @@ Spotify music service.</p>
511
514
 
512
515
  <ul>
513
516
  <li><strong>manager (urllib3.PoolManager):</strong> The manager for HTTP requests to the device.</li>
514
- <li><strong>tokenStorageDir (str):</strong> The directory path that will contain the <code>tokens.json</code> file. <br />
517
+ <li><strong>tokenStorageDir (str):</strong> The directory path that will contain the authorization Token Cache file. <br />
515
518
  A null value will default to the platform specific storage location: <br />
516
519
  Example for Windows OS = <code>C:\ProgramData\SpotifyWebApiPython</code></li>
520
+ <li><strong>tokenStorageFile (str):</strong> The filename and extension of the authorization Token Cache file. <br />
521
+ Default is <code>SpotifyWebApiPython_tokens.json</code>.</li>
517
522
  <li><strong>tokenUpdater (Callable):</strong> A method to call when a token needs to be refreshed by an external provider. <br />
518
523
  The defined method is called with no parameters, and should return a token dictionary. <br />
519
524
  Default is null. </li>
@@ -709,6 +714,19 @@ dictionary entries can be changed, but not the dictionary itself.</p>
709
714
  </div>
710
715
 
711
716
 
717
+ </div>
718
+ <div id="SpotifyClient.TokenStorageFile" class="classattr">
719
+ <div class="attr variable">
720
+ <span class="name">TokenStorageFile</span><span class="annotation">: str</span>
721
+
722
+
723
+ </div>
724
+ <a class="headerlink" href="#SpotifyClient.TokenStorageFile"></a>
725
+
726
+ <div class="docstring"><p>The filename and extension of the authorization token cache file.</p>
727
+ </div>
728
+
729
+
712
730
  </div>
713
731
  <div id="SpotifyClient.UserProfile" class="classattr">
714
732
  <div class="attr variable">
@@ -2406,7 +2424,8 @@ and the response contains error information.</li>
2406
2424
 
2407
2425
  <ul>
2408
2426
  <li><strong>limit (int):</strong> The maximum number of items to return in a page of items when manual paging is used. <br />
2409
- Default: 20, Range: 1 to 50. </li>
2427
+ Default: 20, Range: 1 to 50. <br />
2428
+ See the <code>limitTotal</code> argument for automatic paging option. </li>
2410
2429
  <li><strong>offset (int):</strong> The page index offset of the first item to return. <br />
2411
2430
  Use with limit to get the next set of items. <br />
2412
2431
  Default: 0 (the first item). </li>
@@ -2559,7 +2578,8 @@ Spotify player's "Browse" tab).</p>
2559
2578
 
2560
2579
  <ul>
2561
2580
  <li><strong>limit (int):</strong> The maximum number of items to return in a page of items when manual paging is used. <br />
2562
- Default: 20, Range: 1 to 50. </li>
2581
+ Default: 20, Range: 1 to 50. <br />
2582
+ See the <code>limitTotal</code> argument for automatic paging option. </li>
2563
2583
  <li><strong>offset (int):</strong> The page index offset of the first item to return. <br />
2564
2584
  Use with limit to get the next set of items. <br />
2565
2585
  Default: 0 (the first item). </li>
@@ -2802,7 +2822,8 @@ and the response contains error information.</li>
2802
2822
  <li><strong>albumId (str):</strong> The Spotify ID of the album. <br />
2803
2823
  Example: <code>6vc9OTcyd3hyzabCmsdnwE</code></li>
2804
2824
  <li><strong>limit (int):</strong> The maximum number of items to return in a page of items when manual paging is used. <br />
2805
- Default: 20, Range: 1 to 50. </li>
2825
+ Default: 20, Range: 1 to 50. <br />
2826
+ See the <code>limitTotal</code> argument for automatic paging option. </li>
2806
2827
  <li><strong>offset (int):</strong> The index of the first item to return; use with limit to get the next set of items. <br />
2807
2828
  Default: 0 (the first item). </li>
2808
2829
  <li><strong>market (str):</strong> An ISO 3166-1 alpha-2 country code. If a country code is specified, only content that
@@ -3030,7 +3051,8 @@ If not supplied, all album types will be returned. <br />
3030
3051
  Valid values are: <code>album</code>, <code>single</code>, <code>appears_on</code>, <code>compilation</code> <br />
3031
3052
  Example: <code>single,appears_on</code></li>
3032
3053
  <li><strong>limit (int):</strong> The maximum number of items to return in a page of items when manual paging is used. <br />
3033
- Default: 20, Range: 1 to 50. </li>
3054
+ Default: 20, Range: 1 to 50. <br />
3055
+ See the <code>limitTotal</code> argument for automatic paging option. </li>
3034
3056
  <li><strong>offset (int):</strong> The index of the first item to return; use with limit to get the next set of items. <br />
3035
3057
  Default: 0 (the first item). </li>
3036
3058
  <li><strong>market (str):</strong> An ISO 3166-1 alpha-2 country code. If a country code is specified, only content that is
@@ -3408,7 +3430,8 @@ and the response contains error information.</li>
3408
3430
  the first request. <br />
3409
3431
  Example: <code>6APm8EjxOHSYM5B4i3vT3q</code> </li>
3410
3432
  <li><strong>limit (int):</strong> The maximum number of items to return in a page of items when manual paging is used. <br />
3411
- Default: 20, Range: 1 to 50. </li>
3433
+ Default: 20, Range: 1 to 50. <br />
3434
+ See the <code>limitTotal</code> argument for automatic paging option. </li>
3412
3435
  <li><strong>limitTotal (int):</strong> The maximum number of items to return for the request. <br />
3413
3436
  If specified, this argument overrides the limit and offset argument values
3414
3437
  and paging is automatically used to retrieve all available items up to the
@@ -3760,7 +3783,8 @@ and the response contains error information.</li>
3760
3783
  <li><strong>audiobookId (str):</strong> The Spotify ID for the audiobook.
3761
3784
  Example: <code>74aydHJKgYz3AIq3jjBSv1</code></li>
3762
3785
  <li><strong>limit (int):</strong> The maximum number of items to return in a page of items when manual paging is used. <br />
3763
- Default: 20, Range: 1 to 50. </li>
3786
+ Default: 20, Range: 1 to 50. <br />
3787
+ See the <code>limitTotal</code> argument for automatic paging option. </li>
3764
3788
  <li><strong>offset (int):</strong> The index of the first item to return; use with limit to get the next set of items. <br />
3765
3789
  Default: 0 (the first item). </li>
3766
3790
  <li><strong>market (str):</strong> An ISO 3166-1 alpha-2 country code. If a country code is specified, only content that
@@ -3935,7 +3959,8 @@ and the response contains error information.</li>
3935
3959
 
3936
3960
  <ul>
3937
3961
  <li><strong>limit (int):</strong> The maximum number of items to return in a page of items when manual paging is used. <br />
3938
- Default: 20, Range: 1 to 50. </li>
3962
+ Default: 20, Range: 1 to 50. <br />
3963
+ See the <code>limitTotal</code> argument for automatic paging option. </li>
3939
3964
  <li><strong>offset (int):</strong> The page index offset of the first item to return. <br />
3940
3965
  Use with limit to get the next set of items. <br />
3941
3966
  Default: 0 (the first item). </li>
@@ -4273,7 +4298,8 @@ the spotify web api request. This results in better performance.</p>
4273
4298
 
4274
4299
  <ul>
4275
4300
  <li><strong>limit (int):</strong> The maximum number of items to return in a page of items when manual paging is used. <br />
4276
- Default: 20, Range: 1 to 50. </li>
4301
+ Default: 20, Range: 1 to 50. <br />
4302
+ See the <code>limitTotal</code> argument for automatic paging option. </li>
4277
4303
  <li><strong>offset (int):</strong> The page index offset of the first item to return. <br />
4278
4304
  Use with limit to get the next set of items. <br />
4279
4305
  Default: 0 (the first item). </li>
@@ -4534,7 +4560,8 @@ the spotify web api request. This results in better performance.</p>
4534
4560
  <li><strong>categoryId (str):</strong> The Spotify category ID for the category. <br />
4535
4561
  Example: <code>dinner</code></li>
4536
4562
  <li><strong>limit (int):</strong> The maximum number of items to return in a page of items when manual paging is used. <br />
4537
- Default: 20, Range: 1 to 50. </li>
4563
+ Default: 20, Range: 1 to 50. <br />
4564
+ See the <code>limitTotal</code> argument for automatic paging option. </li>
4538
4565
  <li><strong>offset (int):</strong> The page index offset of the first item to return. <br />
4539
4566
  Use with limit to get the next set of items. <br />
4540
4567
  Default: 0 (the first item). </li>
@@ -5027,7 +5054,8 @@ and the response contains error information.</li>
5027
5054
 
5028
5055
  <ul>
5029
5056
  <li><strong>limit (int):</strong> The maximum number of items to return in a page of items when manual paging is used. <br />
5030
- Default: 20, Range: 1 to 50. </li>
5057
+ Default: 20, Range: 1 to 50. <br />
5058
+ See the <code>limitTotal</code> argument for automatic paging option. </li>
5031
5059
  <li><strong>offset (int):</strong> The page index offset of the first item to return. <br />
5032
5060
  Use with limit to get the next set of items. <br />
5033
5061
  Default: 0 (the first item). </li>
@@ -5297,7 +5325,8 @@ and the response contains error information.</li>
5297
5325
 
5298
5326
  <ul>
5299
5327
  <li><strong>limit (int):</strong> The maximum number of items to return in a page of items when manual paging is used. <br />
5300
- Default: 20, Range: 1 to 50. </li>
5328
+ Default: 20, Range: 1 to 50. <br />
5329
+ See the <code>limitTotal</code> argument for automatic paging option. </li>
5301
5330
  <li><strong>offset (int):</strong> The page index offset of the first item to return. <br />
5302
5331
  Use with limit to get the next set of items. <br />
5303
5332
  Default: 0 (the first item). </li>
@@ -6383,7 +6412,8 @@ Note: Currently doesn't support podcast episodes.</p>
6383
6412
 
6384
6413
  <ul>
6385
6414
  <li><strong>limit (int):</strong> The maximum number of items to return in a page of items when manual paging is used. <br />
6386
- Default: 20, Range: 1 to 50. </li>
6415
+ Default: 20, Range: 1 to 50. <br />
6416
+ See the <code>limitTotal</code> argument for automatic paging option. </li>
6387
6417
  <li><strong>after (int):</strong> Returns all items after (but not including) this cursor position, which is
6388
6418
  a Unix timestamp in milliseconds. <br />
6389
6419
  If <code>after</code> is specified, <code>before</code> must not be specified. <br />
@@ -6751,7 +6781,8 @@ and the response contains error information.</li>
6751
6781
  <li><strong>playlistId (str):</strong> The Spotify ID of the playlist. <br />
6752
6782
  Example: <code>5v5ETK9WFXAnGQ3MRubKuE</code></li>
6753
6783
  <li><strong>limit (int):</strong> The maximum number of items to return in a page of items when manual paging is used. <br />
6754
- Default: 50, Range: 1 to 50. </li>
6784
+ Default: 50, Range: 1 to 50. <br />
6785
+ See the <code>limitTotal</code> argument for automatic paging option. </li>
6755
6786
  <li><strong>offset (int):</strong> The page index offset of the first item to return. <br />
6756
6787
  Use with limit to get the next set of items. <br />
6757
6788
  Default: 0 (the first item). </li>
@@ -6929,7 +6960,8 @@ and the response contains error information.</li>
6929
6960
 
6930
6961
  <ul>
6931
6962
  <li><strong>limit (int):</strong> The maximum number of items to return in a page of items when manual paging is used. <br />
6932
- Default: 20, Range: 1 to 50. </li>
6963
+ Default: 20, Range: 1 to 50. <br />
6964
+ See the <code>limitTotal</code> argument for automatic paging option. </li>
6933
6965
  <li><strong>offset (int):</strong> The page index offset of the first item to return. <br />
6934
6966
  Use with limit to get the next set of items. <br />
6935
6967
  Default: 0 (the first item). </li>
@@ -7093,7 +7125,8 @@ and the response contains error information.</li>
7093
7125
  <li><strong>userId (str):</strong> The user's Spotify user ID. <br />
7094
7126
  Example: <code>smedjan</code></li>
7095
7127
  <li><strong>limit (int):</strong> The maximum number of items to return in a page of items when manual paging is used. <br />
7096
- Default: 20, Range: 1 to 50. </li>
7128
+ Default: 20, Range: 1 to 50. <br />
7129
+ See the <code>limitTotal</code> argument for automatic paging option. </li>
7097
7130
  <li><strong>offset (int):</strong> The page index offset of the first item to return. <br />
7098
7131
  Use with limit to get the next set of items. <br />
7099
7132
  Default: 0 (the first item). </li>
@@ -7372,7 +7405,8 @@ and the response contains error information.</li>
7372
7405
  <li><strong>showId (str):</strong> The Spotify ID for the show.
7373
7406
  Example: <code>6kAsbP8pxwaU2kPibKTuHE</code></li>
7374
7407
  <li><strong>limit (int):</strong> The maximum number of items to return in a page of items when manual paging is used. <br />
7375
- Default: 20, Range: 1 to 50. </li>
7408
+ Default: 20, Range: 1 to 50. <br />
7409
+ See the <code>limitTotal</code> argument for automatic paging option. </li>
7376
7410
  <li><strong>offset (int):</strong> The index of the first item to return; use with limit to get the next set of items. <br />
7377
7411
  Default: 0 (the first item). </li>
7378
7412
  <li><strong>market (str):</strong> An ISO 3166-1 alpha-2 country code. If a country code is specified, only content that
@@ -7547,7 +7581,8 @@ and the response contains error information.</li>
7547
7581
 
7548
7582
  <ul>
7549
7583
  <li><strong>limit (int):</strong> The maximum number of items to return in a page of items when manual paging is used. <br />
7550
- Default: 20, Range: 1 to 50. </li>
7584
+ Default: 20, Range: 1 to 50. <br />
7585
+ See the <code>limitTotal</code> argument for automatic paging option. </li>
7551
7586
  <li><strong>offset (int):</strong> The page index offset of the first item to return. <br />
7552
7587
  Use with limit to get the next set of items. <br />
7553
7588
  Default: 0 (the first item). </li>
@@ -8216,7 +8251,8 @@ and the response contains error information.</li>
8216
8251
 
8217
8252
  <ul>
8218
8253
  <li><strong>limit (int):</strong> The maximum number of items to return in a page of items when manual paging is used. <br />
8219
- Default: 20, Range: 1 to 50. </li>
8254
+ Default: 20, Range: 1 to 50. <br />
8255
+ See the <code>limitTotal</code> argument for automatic paging option. </li>
8220
8256
  <li><strong>offset (int):</strong> The page index offset of the first item to return. <br />
8221
8257
  Use with limit to get the next set of items. <br />
8222
8258
  Default: 0 (the first item). </li>
@@ -8982,7 +9018,8 @@ Default: <code>medium_term</code> <br />
8982
9018
  Example: <code>long_term</code></li>
8983
9019
  </ul></li>
8984
9020
  <li><strong>limit (int):</strong> The maximum number of items to return in a page of items when manual paging is used. <br />
8985
- Default: 20, Range: 1 to 50. </li>
9021
+ Default: 20, Range: 1 to 50. <br />
9022
+ See the <code>limitTotal</code> argument for automatic paging option. </li>
8986
9023
  <li><strong>offset (int):</strong> The page index offset of the first item to return. <br />
8987
9024
  Use with limit to get the next set of items. <br />
8988
9025
  Default: 0 (the first item), Range: 0 to 1000</li>
@@ -9147,7 +9184,8 @@ Default: <code>medium_term</code> <br />
9147
9184
  Example: <code>long_term</code></li>
9148
9185
  </ul></li>
9149
9186
  <li><strong>limit (int):</strong> The maximum number of items to return in a page of items when manual paging is used. <br />
9150
- Default: 20, Range: 1 to 50. </li>
9187
+ Default: 20, Range: 1 to 50. <br />
9188
+ See the <code>limitTotal</code> argument for automatic paging option. </li>
9151
9189
  <li><strong>offset (int):</strong> The page index offset of the first item to return. <br />
9152
9190
  Use with limit to get the next set of items. <br />
9153
9191
  Default: 0 (the first item). </li>
@@ -10860,7 +10898,7 @@ in the Spotify music catalog.</p>
10860
10898
  <div class="attr function">
10861
10899
 
10862
10900
  <span class="def">def</span>
10863
- <span class="name">RemoveAudiobookFavorites</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="n">ids</span><span class="p">:</span> <span class="nb">str</span></span><span class="return-annotation">) -> <span class="kc">None</span>:</span></span>
10901
+ <span class="name">RemoveAudiobookFavorites</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="n">ids</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span></span><span class="return-annotation">) -> <span class="kc">None</span>:</span></span>
10864
10902
 
10865
10903
 
10866
10904
  </div>
@@ -10875,7 +10913,8 @@ in the Spotify music catalog.</p>
10875
10913
  <ul>
10876
10914
  <li><strong>ids (str):</strong> A comma-separated list of the Spotify IDs for the audiobooks. <br />
10877
10915
  Maximum: 50 IDs. <br />
10878
- Example: <code>3PFyizE2tGCSRLusl2Qizf,7iHfbu1YPACw6oZPAFJtqe</code></li>
10916
+ Example: <code>3PFyizE2tGCSRLusl2Qizf,7iHfbu1YPACw6oZPAFJtqe</code>
10917
+ If null, the currently playing track album uri id value is used.</li>
10879
10918
  </ul>
10880
10919
 
10881
10920
  <h6 id="raises">Raises:</h6>
@@ -10925,6 +10964,12 @@ in the Spotify music catalog.</p>
10925
10964
 
10926
10965
  <span class="nb">print</span><span class="p">(</span><span class="s1">&#39;</span><span class="se">\n</span><span class="s1">Success - audiobook(s) were removed&#39;</span><span class="p">)</span>
10927
10966
 
10967
+ <span class="c1"># remove nowplaying audiobook from the current user&#39;s &#39;Your Library&#39;.</span>
10968
+ <span class="nb">print</span><span class="p">(</span><span class="s1">&#39;</span><span class="se">\n</span><span class="s1">Removing nowplaying audiobook from the current users profile&#39;</span><span class="p">)</span>
10969
+ <span class="n">spotify</span><span class="o">.</span><span class="n">RemoveAudiobookFavorites</span><span class="p">()</span>
10970
+
10971
+ <span class="nb">print</span><span class="p">(</span><span class="s1">&#39;</span><span class="se">\n</span><span class="s1">Success - audiobook(s) were removed&#39;</span><span class="p">)</span>
10972
+
10928
10973
  <span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">ex</span><span class="p">:</span>
10929
10974
 
10930
10975
  <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;** Exception: </span><span class="si">%s</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="nb">str</span><span class="p">(</span><span class="n">ex</span><span class="p">))</span>
@@ -10940,7 +10985,7 @@ in the Spotify music catalog.</p>
10940
10985
  <div class="attr function">
10941
10986
 
10942
10987
  <span class="def">def</span>
10943
- <span class="name">RemoveEpisodeFavorites</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="n">ids</span><span class="p">:</span> <span class="nb">str</span></span><span class="return-annotation">) -> <span class="kc">None</span>:</span></span>
10988
+ <span class="name">RemoveEpisodeFavorites</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="n">ids</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span></span><span class="return-annotation">) -> <span class="kc">None</span>:</span></span>
10944
10989
 
10945
10990
 
10946
10991
  </div>
@@ -10955,7 +11000,8 @@ in the Spotify music catalog.</p>
10955
11000
  <ul>
10956
11001
  <li><strong>ids (str):</strong> A comma-separated list of the Spotify IDs for the episodes. <br />
10957
11002
  Maximum: 50 IDs. <br />
10958
- Example: <code>6kAsbP8pxwaU2kPibKTuHE,4rOoJ6Egrf8K2IrywzwOMk</code></li>
11003
+ Example: <code>6kAsbP8pxwaU2kPibKTuHE,4rOoJ6Egrf8K2IrywzwOMk</code>
11004
+ If null, the currently playing context uri id value is used.</li>
10959
11005
  </ul>
10960
11006
 
10961
11007
  <h6 id="raises">Raises:</h6>
@@ -11005,6 +11051,12 @@ in the Spotify music catalog.</p>
11005
11051
 
11006
11052
  <span class="nb">print</span><span class="p">(</span><span class="s1">&#39;</span><span class="se">\n</span><span class="s1">Success - episode(s) were removed&#39;</span><span class="p">)</span>
11007
11053
 
11054
+ <span class="c1"># remove nowplaying episode from the current user&#39;s &#39;Your Library&#39;.</span>
11055
+ <span class="nb">print</span><span class="p">(</span><span class="s1">&#39;</span><span class="se">\n</span><span class="s1">Removing nowplaying episode from the current users profile&#39;</span><span class="p">)</span>
11056
+ <span class="n">spotify</span><span class="o">.</span><span class="n">RemoveEpisodeFavorites</span><span class="p">()</span>
11057
+
11058
+ <span class="nb">print</span><span class="p">(</span><span class="s1">&#39;</span><span class="se">\n</span><span class="s1">Success - episode(s) were removed&#39;</span><span class="p">)</span>
11059
+
11008
11060
  <span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">ex</span><span class="p">:</span>
11009
11061
 
11010
11062
  <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;** Exception: </span><span class="si">%s</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="nb">str</span><span class="p">(</span><span class="n">ex</span><span class="p">))</span>
@@ -11218,7 +11270,7 @@ new snapshot id value will be returned.</p>
11218
11270
  <div class="attr function">
11219
11271
 
11220
11272
  <span class="def">def</span>
11221
- <span class="name">RemoveShowFavorites</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="n">ids</span><span class="p">:</span> <span class="nb">str</span></span><span class="return-annotation">) -> <span class="kc">None</span>:</span></span>
11273
+ <span class="name">RemoveShowFavorites</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="n">ids</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span></span><span class="return-annotation">) -> <span class="kc">None</span>:</span></span>
11222
11274
 
11223
11275
 
11224
11276
  </div>
@@ -11233,7 +11285,8 @@ new snapshot id value will be returned.</p>
11233
11285
  <ul>
11234
11286
  <li><strong>ids (str):</strong> A comma-separated list of the Spotify IDs for the shows. <br />
11235
11287
  Maximum: 50 IDs. <br />
11236
- Example: <code>6kAsbP8pxwaU2kPibKTuHE,4rOoJ6Egrf8K2IrywzwOMk</code></li>
11288
+ Example: <code>6kAsbP8pxwaU2kPibKTuHE,4rOoJ6Egrf8K2IrywzwOMk</code>
11289
+ If null, the currently playing context uri id value is used.</li>
11237
11290
  </ul>
11238
11291
 
11239
11292
  <h6 id="raises">Raises:</h6>
@@ -11283,6 +11336,12 @@ in the Spotify music catalog.</p>
11283
11336
 
11284
11337
  <span class="nb">print</span><span class="p">(</span><span class="s1">&#39;</span><span class="se">\n</span><span class="s1">Success - show(s) were removed&#39;</span><span class="p">)</span>
11285
11338
 
11339
+ <span class="c1"># remove nowplaying show from the current user&#39;s &#39;Your Library&#39;.</span>
11340
+ <span class="nb">print</span><span class="p">(</span><span class="s1">&#39;</span><span class="se">\n</span><span class="s1">Removing nowplaying show from the current users profile&#39;</span><span class="p">)</span>
11341
+ <span class="n">spotify</span><span class="o">.</span><span class="n">RemoveShowFavorites</span><span class="p">()</span>
11342
+
11343
+ <span class="nb">print</span><span class="p">(</span><span class="s1">&#39;</span><span class="se">\n</span><span class="s1">Success - show(s) were removed&#39;</span><span class="p">)</span>
11344
+
11286
11345
  <span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">ex</span><span class="p">:</span>
11287
11346
 
11288
11347
  <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;** Exception: </span><span class="si">%s</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="nb">str</span><span class="p">(</span><span class="n">ex</span><span class="p">))</span>
@@ -11682,7 +11741,7 @@ in the Spotify music catalog.</p>
11682
11741
  <div class="attr function">
11683
11742
 
11684
11743
  <span class="def">def</span>
11685
- <span class="name">SaveAudiobookFavorites</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="n">ids</span><span class="p">:</span> <span class="nb">str</span></span><span class="return-annotation">) -> <span class="kc">None</span>:</span></span>
11744
+ <span class="name">SaveAudiobookFavorites</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="n">ids</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span></span><span class="return-annotation">) -> <span class="kc">None</span>:</span></span>
11686
11745
 
11687
11746
 
11688
11747
  </div>
@@ -11747,6 +11806,12 @@ in the Spotify music catalog.</p>
11747
11806
 
11748
11807
  <span class="nb">print</span><span class="p">(</span><span class="s1">&#39;</span><span class="se">\n</span><span class="s1">Success - audiobook(s) were added&#39;</span><span class="p">)</span>
11749
11808
 
11809
+ <span class="c1"># save nowplaying audiobook to the current user&#39;s &#39;Your Library&#39;.</span>
11810
+ <span class="nb">print</span><span class="p">(</span><span class="s1">&#39;</span><span class="se">\n</span><span class="s1">Adding nowplaying audiobook to the current users profile&#39;</span><span class="p">)</span>
11811
+ <span class="n">spotify</span><span class="o">.</span><span class="n">SaveAudiobookFavorites</span><span class="p">()</span>
11812
+
11813
+ <span class="nb">print</span><span class="p">(</span><span class="s1">&#39;</span><span class="se">\n</span><span class="s1">Success - audiobook(s) were added&#39;</span><span class="p">)</span>
11814
+
11750
11815
  <span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">ex</span><span class="p">:</span>
11751
11816
 
11752
11817
  <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;** Exception: </span><span class="si">%s</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="nb">str</span><span class="p">(</span><span class="n">ex</span><span class="p">))</span>
@@ -11762,7 +11827,7 @@ in the Spotify music catalog.</p>
11762
11827
  <div class="attr function">
11763
11828
 
11764
11829
  <span class="def">def</span>
11765
- <span class="name">SaveEpisodeFavorites</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="n">ids</span><span class="p">:</span> <span class="nb">str</span></span><span class="return-annotation">) -> <span class="kc">None</span>:</span></span>
11830
+ <span class="name">SaveEpisodeFavorites</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="n">ids</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span></span><span class="return-annotation">) -> <span class="kc">None</span>:</span></span>
11766
11831
 
11767
11832
 
11768
11833
  </div>
@@ -11777,7 +11842,8 @@ in the Spotify music catalog.</p>
11777
11842
  <ul>
11778
11843
  <li><strong>ids (str):</strong> A comma-separated list of the Spotify IDs for the episodes. <br />
11779
11844
  Maximum: 50 IDs. <br />
11780
- Example: <code>6kAsbP8pxwaU2kPibKTuHE,4rOoJ6Egrf8K2IrywzwOMk</code></li>
11845
+ Example: <code>6kAsbP8pxwaU2kPibKTuHE,4rOoJ6Egrf8K2IrywzwOMk</code>
11846
+ If null, the currently playing context uri id value is used.</li>
11781
11847
  </ul>
11782
11848
 
11783
11849
  <h6 id="raises">Raises:</h6>
@@ -11827,6 +11893,12 @@ in the Spotify music catalog.</p>
11827
11893
 
11828
11894
  <span class="nb">print</span><span class="p">(</span><span class="s1">&#39;</span><span class="se">\n</span><span class="s1">Success - episode(s) were added&#39;</span><span class="p">)</span>
11829
11895
 
11896
+ <span class="c1"># save nowplaying episode to the current user&#39;s &#39;Your Library&#39;.</span>
11897
+ <span class="nb">print</span><span class="p">(</span><span class="s1">&#39;</span><span class="se">\n</span><span class="s1">Adding nowplaying episode to the current users profile&#39;</span><span class="p">)</span>
11898
+ <span class="n">spotify</span><span class="o">.</span><span class="n">SaveEpisodeFavorites</span><span class="p">()</span>
11899
+
11900
+ <span class="nb">print</span><span class="p">(</span><span class="s1">&#39;</span><span class="se">\n</span><span class="s1">Success - episode(s) were added&#39;</span><span class="p">)</span>
11901
+
11830
11902
  <span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">ex</span><span class="p">:</span>
11831
11903
 
11832
11904
  <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;** Exception: </span><span class="si">%s</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="nb">str</span><span class="p">(</span><span class="n">ex</span><span class="p">))</span>
@@ -11842,7 +11914,7 @@ in the Spotify music catalog.</p>
11842
11914
  <div class="attr function">
11843
11915
 
11844
11916
  <span class="def">def</span>
11845
- <span class="name">SaveShowFavorites</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="n">ids</span><span class="p">:</span> <span class="nb">str</span></span><span class="return-annotation">) -> <span class="kc">None</span>:</span></span>
11917
+ <span class="name">SaveShowFavorites</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="n">ids</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span></span><span class="return-annotation">) -> <span class="kc">None</span>:</span></span>
11846
11918
 
11847
11919
 
11848
11920
  </div>
@@ -11857,7 +11929,8 @@ in the Spotify music catalog.</p>
11857
11929
  <ul>
11858
11930
  <li><strong>ids (str):</strong> A comma-separated list of the Spotify IDs for the shows. <br />
11859
11931
  Maximum: 50 IDs. <br />
11860
- Example: <code>6kAsbP8pxwaU2kPibKTuHE,4rOoJ6Egrf8K2IrywzwOMk</code></li>
11932
+ Example: <code>6kAsbP8pxwaU2kPibKTuHE,4rOoJ6Egrf8K2IrywzwOMk</code>
11933
+ If null, the currently playing context uri id value is used.</li>
11861
11934
  </ul>
11862
11935
 
11863
11936
  <h6 id="raises">Raises:</h6>
@@ -11907,6 +11980,12 @@ in the Spotify music catalog.</p>
11907
11980
 
11908
11981
  <span class="nb">print</span><span class="p">(</span><span class="s1">&#39;</span><span class="se">\n</span><span class="s1">Success - show(s) were added&#39;</span><span class="p">)</span>
11909
11982
 
11983
+ <span class="c1"># save nowplaying episode show to the current user&#39;s &#39;Your Library&#39;.</span>
11984
+ <span class="nb">print</span><span class="p">(</span><span class="s1">&#39;</span><span class="se">\n</span><span class="s1">Adding nowplaying episode show to the current users profile&#39;</span><span class="p">)</span>
11985
+ <span class="n">spotify</span><span class="o">.</span><span class="n">SaveShowFavorites</span><span class="p">()</span>
11986
+
11987
+ <span class="nb">print</span><span class="p">(</span><span class="s1">&#39;</span><span class="se">\n</span><span class="s1">Success - show(s) were added&#39;</span><span class="p">)</span>
11988
+
11910
11989
  <span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">ex</span><span class="p">:</span>
11911
11990
 
11912
11991
  <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;** Exception: </span><span class="si">%s</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="nb">str</span><span class="p">(</span><span class="n">ex</span><span class="p">))</span>
@@ -12031,7 +12110,8 @@ The upc, tag:new and tag:hipster filters can only be used while searching albums
12031
12110
  The tag:new filter will return albums released in the past two weeks and tag:hipster
12032
12111
  can be used to return only albums with the lowest 10% popularity.</li>
12033
12112
  <li><strong>limit (int):</strong> The maximum number of items to return in a page of items when manual paging is used. <br />
12034
- Default: 20, Range: 1 to 50. </li>
12113
+ Default: 20, Range: 1 to 50. <br />
12114
+ See the <code>limitTotal</code> argument for automatic paging option. </li>
12035
12115
  <li><strong>offset (int):</strong> The page index offset of the first item to return. <br />
12036
12116
  Use with limit to get the next set of items. <br />
12037
12117
  Default: 0 (the first item). Range: 0 to 1000. </li>
@@ -12217,7 +12297,8 @@ The upc, tag:new and tag:hipster filters can only be used while searching albums
12217
12297
  The tag:new filter will return albums released in the past two weeks and tag:hipster
12218
12298
  can be used to return only albums with the lowest 10% popularity.</li>
12219
12299
  <li><strong>limit (int):</strong> The maximum number of items to return in a page of items when manual paging is used. <br />
12220
- Default: 20, Range: 1 to 50. </li>
12300
+ Default: 20, Range: 1 to 50. <br />
12301
+ See the <code>limitTotal</code> argument for automatic paging option. </li>
12221
12302
  <li><strong>offset (int):</strong> The page index offset of the first item to return. <br />
12222
12303
  Use with limit to get the next set of items. <br />
12223
12304
  Default: 0 (the first item). Range: 0 to 1000. </li>
@@ -12402,7 +12483,8 @@ The upc, tag:new and tag:hipster filters can only be used while searching albums
12402
12483
  The tag:new filter will return albums released in the past two weeks and tag:hipster
12403
12484
  can be used to return only albums with the lowest 10% popularity.</li>
12404
12485
  <li><strong>limit (int):</strong> The maximum number of items to return in a page of items when manual paging is used. <br />
12405
- Default: 20, Range: 1 to 50. </li>
12486
+ Default: 20, Range: 1 to 50. <br />
12487
+ See the <code>limitTotal</code> argument for automatic paging option. </li>
12406
12488
  <li><strong>offset (int):</strong> The page index offset of the first item to return. <br />
12407
12489
  Use with limit to get the next set of items. <br />
12408
12490
  Default: 0 (the first item). Range: 0 to 1000. </li>
@@ -12603,7 +12685,8 @@ The upc, tag:new and tag:hipster filters can only be used while searching albums
12603
12685
  The tag:new filter will return albums released in the past two weeks and tag:hipster
12604
12686
  can be used to return only albums with the lowest 10% popularity.</li>
12605
12687
  <li><strong>limit (int):</strong> The maximum number of items to return in a page of items when manual paging is used. <br />
12606
- Default: 20, Range: 1 to 50. </li>
12688
+ Default: 20, Range: 1 to 50. <br />
12689
+ See the <code>limitTotal</code> argument for automatic paging option. </li>
12607
12690
  <li><strong>offset (int):</strong> The page index offset of the first item to return. <br />
12608
12691
  Use with limit to get the next set of items. <br />
12609
12692
  Default: 0 (the first item). Range: 0 to 1000. </li>
@@ -12802,7 +12885,8 @@ The upc, tag:new and tag:hipster filters can only be used while searching albums
12802
12885
  The tag:new filter will return albums released in the past two weeks and tag:hipster
12803
12886
  can be used to return only albums with the lowest 10% popularity.</li>
12804
12887
  <li><strong>limit (int):</strong> The maximum number of items to return in a page of items when manual paging is used. <br />
12805
- Default: 20, Range: 1 to 50. </li>
12888
+ Default: 20, Range: 1 to 50. <br />
12889
+ See the <code>limitTotal</code> argument for automatic paging option. </li>
12806
12890
  <li><strong>offset (int):</strong> The page index offset of the first item to return. <br />
12807
12891
  Use with limit to get the next set of items. <br />
12808
12892
  Default: 0 (the first item). Range: 0 to 1000. </li>
@@ -13001,7 +13085,8 @@ The upc, tag:new and tag:hipster filters can only be used while searching albums
13001
13085
  The tag:new filter will return albums released in the past two weeks and tag:hipster
13002
13086
  can be used to return only albums with the lowest 10% popularity.</li>
13003
13087
  <li><strong>limit (int):</strong> The maximum number of items to return in a page of items when manual paging is used. <br />
13004
- Default: 20, Range: 1 to 50. </li>
13088
+ Default: 20, Range: 1 to 50. <br />
13089
+ See the <code>limitTotal</code> argument for automatic paging option. </li>
13005
13090
  <li><strong>offset (int):</strong> The page index offset of the first item to return. <br />
13006
13091
  Use with limit to get the next set of items. <br />
13007
13092
  Default: 0 (the first item). Range: 0 to 1000. </li>
@@ -13204,7 +13289,8 @@ The upc, tag:new and tag:hipster filters can only be used while searching albums
13204
13289
  The tag:new filter will return albums released in the past two weeks and tag:hipster
13205
13290
  can be used to return only albums with the lowest 10% popularity.</li>
13206
13291
  <li><strong>limit (int):</strong> The maximum number of items to return in a page of items when manual paging is used. <br />
13207
- Default: 20, Range: 1 to 50. </li>
13292
+ Default: 20, Range: 1 to 50. <br />
13293
+ See the <code>limitTotal</code> argument for automatic paging option. </li>
13208
13294
  <li><strong>offset (int):</strong> The page index offset of the first item to return. <br />
13209
13295
  Use with limit to get the next set of items. <br />
13210
13296
  Default: 0 (the first item). Range: 0 to 1000. </li>
spotifywebapipython/docs/spotifywebapiPython/spotifydiscovery.html CHANGED
@@ -9,7 +9,7 @@
9
9
  </title>
10
10
  <link rel="icon" type="image/svg+xml" href="data:image/svg+xml,%3Csvg%20xmlns%3D%22http%3A//www.w3.org/2000/svg%22%20role%3D%22img%22%20aria-label%3D%22pdoc%20logo%22%20width%3D%22300%22%20height%3D%22150%22%20viewBox%3D%22-1%200%2060%2030%22%3E%3Ctitle%3Epdoc%3C/title%3E%3Cpath%20d%3D%22M29.621%2021.293c-.011-.273-.214-.475-.511-.481a.5.5%200%200%200-.489.503l-.044%201.393c-.097.551-.695%201.215-1.566%201.704-.577.428-1.306.486-2.193.182-1.426-.617-2.467-1.654-3.304-2.487l-.173-.172a3.43%203.43%200%200%200-.365-.306.49.49%200%200%200-.286-.196c-1.718-1.06-4.931-1.47-7.353.191l-.219.15c-1.707%201.187-3.413%202.131-4.328%201.03-.02-.027-.49-.685-.141-1.763.233-.721.546-2.408.772-4.076.042-.09.067-.187.046-.288.166-1.347.277-2.625.241-3.351%201.378-1.008%202.271-2.586%202.271-4.362%200-.976-.272-1.935-.788-2.774-.057-.094-.122-.18-.184-.268.033-.167.052-.339.052-.516%200-1.477-1.202-2.679-2.679-2.679-.791%200-1.496.352-1.987.9a6.3%206.3%200%200%200-1.001.029c-.492-.564-1.207-.929-2.012-.929-1.477%200-2.679%201.202-2.679%202.679A2.65%202.65%200%200%200%20.97%206.554c-.383.747-.595%201.572-.595%202.41%200%202.311%201.507%204.29%203.635%205.107-.037.699-.147%202.27-.423%203.294l-.137.461c-.622%202.042-2.515%208.257%201.727%2010.643%201.614.908%203.06%201.248%204.317%201.248%202.665%200%204.492-1.524%205.322-2.401%201.476-1.559%202.886-1.854%206.491.82%201.877%201.393%203.514%201.753%204.861%201.068%202.223-1.713%202.811-3.867%203.399-6.374.077-.846.056-1.469.054-1.537zm-4.835%204.313c-.054.305-.156.586-.242.629-.034-.007-.131-.022-.307-.157-.145-.111-.314-.478-.456-.908.221.121.432.25.675.355.115.039.219.051.33.081zm-2.251-1.238c-.05.33-.158.648-.252.694-.022.001-.125-.018-.307-.157-.217-.166-.488-.906-.639-1.573.358.344.754.693%201.198%201.036zm-3.887-2.337c-.006-.116-.018-.231-.041-.342.635.145%201.189.368%201.599.625.097.231.166.481.174.642-.03.049-.055.101-.067.158-.046.013-.128.026-.298.004-.278-.037-.901-.57-1.367-1.087zm-1.127-.497c.116.306.176.625.12.71-.019.014-.117.045-.345.016-.206-.027-.604-.332-.986-.695.41-.051.816-.056%201.211-.031zm-4.535%201.535c.209.22.379.47.358.598-.006.041-.088.138-.351.234-.144.055-.539-.063-.979-.259a11.66%2011.66%200%200%200%20.972-.573zm.983-.664c.359-.237.738-.418%201.126-.554.25.237.479.548.457.694-.006.042-.087.138-.351.235-.174.064-.694-.105-1.232-.375zm-3.381%201.794c-.022.145-.061.29-.149.401-.133.166-.358.248-.69.251h-.002c-.133%200-.306-.26-.45-.621.417.091.854.07%201.291-.031zm-2.066-8.077a4.78%204.78%200%200%201-.775-.584c.172-.115.505-.254.88-.378l-.105.962zm-.331%202.302a10.32%2010.32%200%200%201-.828-.502c.202-.143.576-.328.984-.49l-.156.992zm-.45%202.157l-.701-.403c.214-.115.536-.249.891-.376a11.57%2011.57%200%200%201-.19.779zm-.181%201.716c.064.398.194.702.298.893-.194-.051-.435-.162-.736-.398.061-.119.224-.3.438-.495zM8.87%204.141c0%20.152-.123.276-.276.276s-.275-.124-.275-.276.123-.276.276-.276.275.124.275.276zm-.735-.389a1.15%201.15%200%200%200-.314.783%201.16%201.16%200%200%200%201.162%201.162c.457%200%20.842-.27%201.032-.653.026.117.042.238.042.362a1.68%201.68%200%200%201-1.679%201.679%201.68%201.68%200%200%201-1.679-1.679c0-.843.626-1.535%201.436-1.654zM5.059%205.406A1.68%201.68%200%200%201%203.38%207.085a1.68%201.68%200%200%201-1.679-1.679c0-.037.009-.072.011-.109.21.3.541.508.935.508a1.16%201.16%200%200%200%201.162-1.162%201.14%201.14%200%200%200-.474-.912c.015%200%20.03-.005.045-.005.926.001%201.679.754%201.679%201.68zM3.198%204.141c0%20.152-.123.276-.276.276s-.275-.124-.275-.276.123-.276.276-.276.275.124.275.276zM1.375%208.964c0-.52.103-1.035.288-1.52.466.394%201.06.64%201.717.64%201.144%200%202.116-.725%202.499-1.738.383%201.012%201.355%201.738%202.499%201.738.867%200%201.631-.421%202.121-1.062.307.605.478%201.267.478%201.942%200%202.486-2.153%204.51-4.801%204.51s-4.801-2.023-4.801-4.51zm24.342%2019.349c-.985.498-2.267.168-3.813-.979-3.073-2.281-5.453-3.199-7.813-.705-1.315%201.391-4.163%203.365-8.423.97-3.174-1.786-2.239-6.266-1.261-9.479l.146-.492c.276-1.02.395-2.457.444-3.268a6.11%206.11%200%200%200%201.18.115%206.01%206.01%200%200%200%202.536-.562l-.006.175c-.802.215-1.848.612-2.021%201.25-.079.295.021.601.274.837.219.203.415.364.598.501-.667.304-1.243.698-1.311%201.179-.02.144-.022.507.393.787.213.144.395.26.564.365-1.285.521-1.361.96-1.381%201.126-.018.142-.011.496.427.746l.854.489c-.473.389-.971.914-.999%201.429-.018.278.095.532.316.713.675.556%201.231.721%201.653.721.059%200%20.104-.014.158-.02.207.707.641%201.64%201.513%201.64h.013c.8-.008%201.236-.345%201.462-.626.173-.216.268-.457.325-.692.424.195.93.374%201.372.374.151%200%20.294-.021.423-.068.732-.27.944-.704.993-1.021.009-.061.003-.119.002-.179.266.086.538.147.789.147.15%200%20.294-.021.423-.069.542-.2.797-.489.914-.754.237.147.478.258.704.288.106.014.205.021.296.021.356%200%20.595-.101.767-.229.438.435%201.094.992%201.656%201.067.106.014.205.021.296.021a1.56%201.56%200%200%200%20.323-.035c.17.575.453%201.289.866%201.605.358.273.665.362.914.362a.99.99%200%200%200%20.421-.093%201.03%201.03%200%200%200%20.245-.164c.168.428.39.846.68%201.068.358.273.665.362.913.362a.99.99%200%200%200%20.421-.093c.317-.148.512-.448.639-.762.251.157.495.257.726.257.127%200%20.25-.024.37-.071.427-.17.706-.617.841-1.314.022-.015.047-.022.068-.038.067-.051.133-.104.196-.159-.443%201.486-1.107%202.761-2.086%203.257zM8.66%209.925a.5.5%200%201%200-1%200c0%20.653-.818%201.205-1.787%201.205s-1.787-.552-1.787-1.205a.5.5%200%201%200-1%200c0%201.216%201.25%202.205%202.787%202.205s2.787-.989%202.787-2.205zm4.4%2015.965l-.208.097c-2.661%201.258-4.708%201.436-6.086.527-1.542-1.017-1.88-3.19-1.844-4.198a.4.4%200%200%200-.385-.414c-.242-.029-.406.164-.414.385-.046%201.249.367%203.686%202.202%204.896.708.467%201.547.7%202.51.7%201.248%200%202.706-.392%204.362-1.174l.185-.086a.4.4%200%200%200%20.205-.527c-.089-.204-.326-.291-.527-.206zM9.547%202.292c.093.077.205.114.317.114a.5.5%200%200%200%20.318-.886L8.817.397a.5.5%200%200%200-.703.068.5.5%200%200%200%20.069.703l1.364%201.124zm-7.661-.065c.086%200%20.173-.022.253-.068l1.523-.893a.5.5%200%200%200-.506-.863l-1.523.892a.5.5%200%200%200-.179.685c.094.158.261.247.432.247z%22%20transform%3D%22matrix%28-1%200%200%201%2058%200%29%22%20fill%3D%22%233bb300%22/%3E%3Cpath%20d%3D%22M.3%2021.86V10.18q0-.46.02-.68.04-.22.18-.5.28-.54%201.34-.54%201.06%200%201.42.28.38.26.44.78.76-1.04%202.38-1.04%201.64%200%203.1%201.54%201.46%201.54%201.46%203.58%200%202.04-1.46%203.58-1.44%201.54-3.08%201.54-1.64%200-2.38-.92v4.04q0%20.46-.04.68-.02.22-.18.5-.14.3-.5.42-.36.12-.98.12-.62%200-1-.12-.36-.12-.52-.4-.14-.28-.18-.5-.02-.22-.02-.68zm3.96-9.42q-.46.54-.46%201.18%200%20.64.46%201.18.48.52%201.2.52.74%200%201.24-.52.52-.52.52-1.18%200-.66-.48-1.18-.48-.54-1.26-.54-.76%200-1.22.54zm14.741-8.36q.16-.3.54-.42.38-.12%201-.12.64%200%201.02.12.38.12.52.42.16.3.18.54.04.22.04.68v11.94q0%20.46-.04.7-.02.22-.18.5-.3.54-1.7.54-1.38%200-1.54-.98-.84.96-2.34.96-1.8%200-3.28-1.56-1.48-1.58-1.48-3.66%200-2.1%201.48-3.68%201.5-1.58%203.28-1.58%201.48%200%202.3%201v-4.2q0-.46.02-.68.04-.24.18-.52zm-3.24%2010.86q.52.54%201.26.54.74%200%201.22-.54.5-.54.5-1.18%200-.66-.48-1.22-.46-.56-1.26-.56-.8%200-1.28.56-.48.54-.48%201.2%200%20.66.52%201.2zm7.833-1.2q0-2.4%201.68-3.96%201.68-1.56%203.84-1.56%202.16%200%203.82%201.56%201.66%201.54%201.66%203.94%200%201.66-.86%202.96-.86%201.28-2.1%201.9-1.22.6-2.54.6-1.32%200-2.56-.64-1.24-.66-2.1-1.92-.84-1.28-.84-2.88zm4.18%201.44q.64.48%201.3.48.66%200%201.32-.5.66-.5.66-1.48%200-.98-.62-1.46-.62-.48-1.34-.48-.72%200-1.34.5-.62.5-.62%201.48%200%20.96.64%201.46zm11.412-1.44q0%20.84.56%201.32.56.46%201.18.46.64%200%201.18-.36.56-.38.9-.38.6%200%201.46%201.06.46.58.46%201.04%200%20.76-1.1%201.42-1.14.8-2.8.8-1.86%200-3.58-1.34-.82-.64-1.34-1.7-.52-1.08-.52-2.36%200-1.3.52-2.34.52-1.06%201.34-1.7%201.66-1.32%203.54-1.32.76%200%201.48.22.72.2%201.06.4l.32.2q.36.24.56.38.52.4.52.92%200%20.5-.42%201.14-.72%201.1-1.38%201.1-.38%200-1.08-.44-.36-.34-1.04-.34-.66%200-1.24.48-.58.48-.58%201.34z%22%20fill%3D%22green%22/%3E%3C/svg%3E"/>
11
11
  <!-- build env - Package Name = "spotifywebapiPython" -->
12
- <!-- build env - Package Version = "1.0.84" -->
12
+ <!-- build env - Package Version = "1.0.86" -->
13
13
  <!-- pdoc module.modulename = "spotifywebapipython.spotifydiscovery" -->
14
14
  <!-- pdoc module.is_package = "False" -->
15
15
  <!-- pdoc root_module_name = "None" -->
@@ -71,7 +71,7 @@
71
71
 
72
72
  <footer class="footertext">
73
73
  spotifywebapiPython</br>
74
- Version 1.0.84</br>
74
+ Version 1.0.86</br>
75
75
  <a href="https://developer.spotify.com/documentation/web-api" target="_blank">
76
76
  <img src="../spotifywebapipython.ico" alt="brand icon" style="width:32px; height:32px; padding:4px;"/>
77
77
  A Spotify Web Api Client