spotify-apimatic-sdk 1.0.0__py3-none-any.whl

spotifywebapi/controllers/audiobooks_controller.py

@@ -0,0 +1,441 @@
+"""spotifywebapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: D410, E501, E101, D206
+from apimatic_core.authentication.multiple.single_auth import (
+    Single,
+)
+from apimatic_core.request_builder import RequestBuilder
+from apimatic_core.response_handler import ResponseHandler
+from apimatic_core.types.parameter import Parameter
+
+from spotifywebapi.api_helper import APIHelper
+from spotifywebapi.configuration import Server
+from spotifywebapi.controllers.base_controller import (
+    BaseController,
+)
+from spotifywebapi.exceptions.bad_request_exception import (
+    BadRequestException,
+)
+from spotifywebapi.exceptions.forbidden_exception import (
+    ForbiddenException,
+)
+from spotifywebapi.exceptions.not_found_exception import (
+    NotFoundException,
+)
+from spotifywebapi.exceptions.too_many_requests_exception import (
+    TooManyRequestsException,
+)
+from spotifywebapi.exceptions.unauthorized_exception import (
+    UnauthorizedException,
+)
+from spotifywebapi.http.http_method_enum import (
+    HttpMethodEnum,
+)
+from spotifywebapi.models.audiobook_object import (
+    AudiobookObject,
+)
+from spotifywebapi.models.many_audiobooks import (
+    ManyAudiobooks,
+)
+from spotifywebapi.models.paging_saved_audiobook_object import (
+    PagingSavedAudiobookObject,
+)
+from spotifywebapi.models.paging_simplified_chapter_object import (
+    PagingSimplifiedChapterObject,
+)
+
+
+class AudiobooksController(BaseController):
+    """A Controller to access Endpoints in the spotifywebapi API."""
+
+    def __init__(self, config):
+        """Initialize AudiobooksController object."""
+        super(AudiobooksController, self).__init__(config)
+
+    def get_an_audiobook(self,
+                         id,
+                         market=None):
+        """Perform a GET request to /audiobooks/{id}.
+
+        Get Spotify catalog information for a single audiobook. Audiobooks are only
+        available within the US, UK, Canada, Ireland, New Zealand and Australia
+        markets.
+
+        Args:
+            id (str): The request template parameter.
+            market (str, optional): The request query parameter.
+
+        Returns:
+            ApiResponse: An object with the response value as well as other useful
+                information such as status codes and headers. An Audiobook
+
+        Raises:
+            APIException: When an error occurs while fetching the data from the
+                remote API. This exception includes the HTTP Response code, an error
+                message, and the HTTP body that was received in the request.
+
+        """
+        return super().new_api_call_builder.request(
+            RequestBuilder().server(Server.DEFAULT)
+            .path("/audiobooks/{id}")
+            .http_method(HttpMethodEnum.GET)
+            .template_param(Parameter()
+                .key("id")
+                .value(id)
+                .should_encode(True))
+            .query_param(Parameter()
+                .key("market")
+                .value(market))
+            .header_param(Parameter()
+                .key("accept")
+                .value("application/json"))
+            .auth(Single("oauth_2_0")),
+        ).response(
+            ResponseHandler()
+            .deserializer(APIHelper.json_deserialize)
+            .deserialize_into(AudiobookObject.from_dictionary)
+            .is_api_response(True)
+            .local_error("400",
+                "The request contains malformed data in path, query parameters, or bo"
+                "dy.\n",
+                BadRequestException)
+            .local_error("401",
+                "Bad or expired token. This can happen if the user revoked a token or"
+                "\nthe access token has expired. You should re-authenticate the user."
+                "\n",
+                UnauthorizedException)
+            .local_error("403",
+                "Bad OAuth request (wrong consumer key, bad nonce, expired\ntimestamp"
+                "...). Unfortunately, re-authenticating the user won't help here.\n",
+                ForbiddenException)
+            .local_error("404",
+                "The requested resource cannot be found.\n",
+                NotFoundException)
+            .local_error("429",
+                "The app has exceeded its rate limits.\n",
+                TooManyRequestsException),
+        ).execute()
+
+    def get_multiple_audiobooks(self,
+                                ids,
+                                market=None):
+        """Perform a GET request to /audiobooks.
+
+        Get Spotify catalog information for several audiobooks identified by their
+        Spotify IDs. Audiobooks are only available within the US, UK, Canada,
+        Ireland, New Zealand and Australia markets.
+
+        Args:
+            ids (str): The request query parameter.
+            market (str, optional): The request query parameter.
+
+        Returns:
+            ApiResponse: An object with the response value as well as other useful
+                information such as status codes and headers. A set of audiobooks. If
+                one of the requested audiobooks is unavailable then you'll find a
+                `null` item in the `audiobooks` array where the audiobook object
+                would otherwise be.
+
+        Raises:
+            APIException: When an error occurs while fetching the data from the
+                remote API. This exception includes the HTTP Response code, an error
+                message, and the HTTP body that was received in the request.
+
+        """
+        return super().new_api_call_builder.request(
+            RequestBuilder().server(Server.DEFAULT)
+            .path("/audiobooks")
+            .http_method(HttpMethodEnum.GET)
+            .query_param(Parameter()
+                .key("ids")
+                .value(ids))
+            .query_param(Parameter()
+                .key("market")
+                .value(market))
+            .header_param(Parameter()
+                .key("accept")
+                .value("application/json"))
+            .auth(Single("oauth_2_0")),
+        ).response(
+            ResponseHandler()
+            .deserializer(APIHelper.json_deserialize)
+            .deserialize_into(ManyAudiobooks.from_dictionary)
+            .is_api_response(True)
+            .local_error("401",
+                "Bad or expired token. This can happen if the user revoked a token or"
+                "\nthe access token has expired. You should re-authenticate the user."
+                "\n",
+                UnauthorizedException)
+            .local_error("403",
+                "Bad OAuth request (wrong consumer key, bad nonce, expired\ntimestamp"
+                "...). Unfortunately, re-authenticating the user won't help here.\n",
+                ForbiddenException)
+            .local_error("429",
+                "The app has exceeded its rate limits.\n",
+                TooManyRequestsException),
+        ).execute()
+
+    def get_audiobook_chapters(self,
+                               id,
+                               market=None,
+                               limit=20,
+                               offset=0):
+        """Perform a GET request to /audiobooks/{id}/chapters.
+
+        Get Spotify catalog information about an audiobook's chapters. Audiobooks are
+        only available within the US, UK, Canada, Ireland, New Zealand and Australia
+        markets.
+
+        Args:
+            id (str): The request template parameter.
+            market (str, optional): The request query parameter.
+            limit (int, optional): The request query parameter. Example: 20
+            offset (int, optional): The request query parameter. Example: 0
+
+        Returns:
+            ApiResponse: An object with the response value as well as other useful
+                information such as status codes and headers. Pages of chapters
+
+        Raises:
+            APIException: When an error occurs while fetching the data from the
+                remote API. This exception includes the HTTP Response code, an error
+                message, and the HTTP body that was received in the request.
+
+        """
+        return super().new_api_call_builder.request(
+            RequestBuilder().server(Server.DEFAULT)
+            .path("/audiobooks/{id}/chapters")
+            .http_method(HttpMethodEnum.GET)
+            .template_param(Parameter()
+                .key("id")
+                .value(id)
+                .should_encode(True))
+            .query_param(Parameter()
+                .key("market")
+                .value(market))
+            .query_param(Parameter()
+                .key("limit")
+                .value(limit))
+            .query_param(Parameter()
+                .key("offset")
+                .value(offset))
+            .header_param(Parameter()
+                .key("accept")
+                .value("application/json"))
+            .auth(Single("oauth_2_0")),
+        ).response(
+            ResponseHandler()
+            .deserializer(APIHelper.json_deserialize)
+            .deserialize_into(PagingSimplifiedChapterObject.from_dictionary)
+            .is_api_response(True)
+            .local_error("401",
+                "Bad or expired token. This can happen if the user revoked a token or"
+                "\nthe access token has expired. You should re-authenticate the user."
+                "\n",
+                UnauthorizedException)
+            .local_error("403",
+                "Bad OAuth request (wrong consumer key, bad nonce, expired\ntimestamp"
+                "...). Unfortunately, re-authenticating the user won't help here.\n",
+                ForbiddenException)
+            .local_error("429",
+                "The app has exceeded its rate limits.\n",
+                TooManyRequestsException),
+        ).execute()
+
+    def get_users_saved_audiobooks(self,
+                                   limit=20,
+                                   offset=0):
+        """Perform a GET request to /me/audiobooks.
+
+        Get a list of the audiobooks saved in the current Spotify user's 'Your Music'
+        library.
+
+        Args:
+            limit (int, optional): The request query parameter. Example: 20
+            offset (int, optional): The request query parameter. Example: 0
+
+        Returns:
+            ApiResponse: An object with the response value as well as other useful
+                information such as status codes and headers. Pages of saved
+                audiobooks
+
+        Raises:
+            APIException: When an error occurs while fetching the data from the
+                remote API. This exception includes the HTTP Response code, an error
+                message, and the HTTP body that was received in the request.
+
+        """
+        return super().new_api_call_builder.request(
+            RequestBuilder().server(Server.DEFAULT)
+            .path("/me/audiobooks")
+            .http_method(HttpMethodEnum.GET)
+            .query_param(Parameter()
+                .key("limit")
+                .value(limit))
+            .query_param(Parameter()
+                .key("offset")
+                .value(offset))
+            .header_param(Parameter()
+                .key("accept")
+                .value("application/json"))
+            .auth(Single("oauth_2_0")),
+        ).response(
+            ResponseHandler()
+            .deserializer(APIHelper.json_deserialize)
+            .deserialize_into(PagingSavedAudiobookObject.from_dictionary)
+            .is_api_response(True)
+            .local_error("401",
+                "Bad or expired token. This can happen if the user revoked a token or"
+                "\nthe access token has expired. You should re-authenticate the user."
+                "\n",
+                UnauthorizedException)
+            .local_error("403",
+                "Bad OAuth request (wrong consumer key, bad nonce, expired\ntimestamp"
+                "...). Unfortunately, re-authenticating the user won't help here.\n",
+                ForbiddenException)
+            .local_error("429",
+                "The app has exceeded its rate limits.\n",
+                TooManyRequestsException),
+        ).execute()
+
+    def save_audiobooks_user(self,
+                             ids):
+        """Perform a PUT request to /me/audiobooks.
+
+        Save one or more audiobooks to the current Spotify user's library.
+
+        Args:
+            ids (str): The request query parameter.
+
+        Returns:
+            ApiResponse: An object with the response value as well as other useful
+                information such as status codes and headers. Audiobook(s) are saved
+                to the library
+
+        Raises:
+            APIException: When an error occurs while fetching the data from the
+                remote API. This exception includes the HTTP Response code, an error
+                message, and the HTTP body that was received in the request.
+
+        """
+        return super().new_api_call_builder.request(
+            RequestBuilder().server(Server.DEFAULT)
+            .path("/me/audiobooks")
+            .http_method(HttpMethodEnum.PUT)
+            .query_param(Parameter()
+                .key("ids")
+                .value(ids))
+            .auth(Single("oauth_2_0")),
+        ).response(
+            ResponseHandler()
+            .is_api_response(True)
+            .local_error("401",
+                "Bad or expired token. This can happen if the user revoked a token or"
+                "\nthe access token has expired. You should re-authenticate the user."
+                "\n",
+                UnauthorizedException)
+            .local_error("403",
+                "Bad OAuth request (wrong consumer key, bad nonce, expired\ntimestamp"
+                "...). Unfortunately, re-authenticating the user won't help here.\n",
+                ForbiddenException)
+            .local_error("429",
+                "The app has exceeded its rate limits.\n",
+                TooManyRequestsException),
+        ).execute()
+
+    def remove_audiobooks_user(self,
+                               ids):
+        """Perform a DELETE request to /me/audiobooks.
+
+        Remove one or more audiobooks from the Spotify user's library.
+
+        Args:
+            ids (str): The request query parameter.
+
+        Returns:
+            ApiResponse: An object with the response value as well as other useful
+                information such as status codes and headers. Audiobook(s) have been
+                removed from the library
+
+        Raises:
+            APIException: When an error occurs while fetching the data from the
+                remote API. This exception includes the HTTP Response code, an error
+                message, and the HTTP body that was received in the request.
+
+        """
+        return super().new_api_call_builder.request(
+            RequestBuilder().server(Server.DEFAULT)
+            .path("/me/audiobooks")
+            .http_method(HttpMethodEnum.DELETE)
+            .query_param(Parameter()
+                .key("ids")
+                .value(ids))
+            .auth(Single("oauth_2_0")),
+        ).response(
+            ResponseHandler()
+            .is_api_response(True)
+            .local_error("401",
+                "Bad or expired token. This can happen if the user revoked a token or"
+                "\nthe access token has expired. You should re-authenticate the user."
+                "\n",
+                UnauthorizedException)
+            .local_error("403",
+                "Bad OAuth request (wrong consumer key, bad nonce, expired\ntimestamp"
+                "...). Unfortunately, re-authenticating the user won't help here.\n",
+                ForbiddenException)
+            .local_error("429",
+                "The app has exceeded its rate limits.\n",
+                TooManyRequestsException),
+        ).execute()
+
+    def check_users_saved_audiobooks(self,
+                                     ids):
+        """Perform a GET request to /me/audiobooks/contains.
+
+        Check if one or more audiobooks are already saved in the current Spotify
+        user's library.
+
+        Args:
+            ids (str): The request query parameter.
+
+        Returns:
+            ApiResponse: An object with the response value as well as other useful
+                information such as status codes and headers. Array of booleans
+
+        Raises:
+            APIException: When an error occurs while fetching the data from the
+                remote API. This exception includes the HTTP Response code, an error
+                message, and the HTTP body that was received in the request.
+
+        """
+        return super().new_api_call_builder.request(
+            RequestBuilder().server(Server.DEFAULT)
+            .path("/me/audiobooks/contains")
+            .http_method(HttpMethodEnum.GET)
+            .query_param(Parameter()
+                .key("ids")
+                .value(ids))
+            .header_param(Parameter()
+                .key("accept")
+                .value("application/json"))
+            .auth(Single("oauth_2_0")),
+        ).response(
+            ResponseHandler()
+            .deserializer(APIHelper.json_deserialize)
+            .is_api_response(True)
+            .local_error("401",
+                "Bad or expired token. This can happen if the user revoked a token or"
+                "\nthe access token has expired. You should re-authenticate the user."
+                "\n",
+                UnauthorizedException)
+            .local_error("403",
+                "Bad OAuth request (wrong consumer key, bad nonce, expired\ntimestamp"
+                "...). Unfortunately, re-authenticating the user won't help here.\n",
+                ForbiddenException)
+            .local_error("429",
+                "The app has exceeded its rate limits.\n",
+                TooManyRequestsException),
+        ).execute()

spotifywebapi/controllers/base_controller.py

@@ -0,0 +1,67 @@
+"""spotifywebapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+from apimatic_core.api_call import ApiCall
+from apimatic_core.types.error_case import ErrorCase
+
+from spotifywebapi.exceptions.api_exception import (
+    APIException,
+)
+
+
+class BaseController(object):
+    """All controllers inherit from this base class.
+
+    Attributes:
+        config (Configuration): The HttpClient which a specific controller
+            instance will use. By default all the controller objects share
+            the same HttpClient. A user can use his own custom HttpClient
+            as well.
+        http_call_back (HttpCallBack): An object which holds call back
+            methods to be called before and after the execution of an HttpRequest.
+        new_api_call_builder (APICall): Returns the API Call builder instance.
+
+    """
+
+    @staticmethod
+    def user_agent():
+        """Return UserAgent value."""
+        return "APIMATIC 3.0"
+
+    @staticmethod
+    def user_agent_parameters():
+        """Return UserAgentParameters value."""
+        return {
+        }
+
+    @staticmethod
+    def global_errors():
+        """Return GlobalErrors value."""
+        return {
+            "default": ErrorCase()
+                .error_message("HTTP response not OK.")
+                .exception_type(APIException),
+        }
+
+    def __init__(self, config):
+        """Initialize BaseController object."""
+        self._config = config.get_http_client_configuration()
+        self._http_call_back = self.config.http_callback
+        self.api_call = ApiCall(config)
+
+    @property
+    def config(self):
+        """Return Configuration object."""
+        return self._config
+
+    @property
+    def http_call_back(self):
+        """Return HttpCallBack object."""
+        return self._http_call_back
+
+    @property
+    def new_api_call_builder(self):
+        """Return New ApiCallBuilder object."""
+        return self.api_call.new_builder

spotifywebapi/controllers/categories_controller.py

@@ -0,0 +1,161 @@
+"""spotifywebapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: D410, E501, E101, D206
+from apimatic_core.authentication.multiple.single_auth import (
+    Single,
+)
+from apimatic_core.request_builder import RequestBuilder
+from apimatic_core.response_handler import ResponseHandler
+from apimatic_core.types.parameter import Parameter
+
+from spotifywebapi.api_helper import APIHelper
+from spotifywebapi.configuration import Server
+from spotifywebapi.controllers.base_controller import (
+    BaseController,
+)
+from spotifywebapi.exceptions.forbidden_exception import (
+    ForbiddenException,
+)
+from spotifywebapi.exceptions.too_many_requests_exception import (
+    TooManyRequestsException,
+)
+from spotifywebapi.exceptions.unauthorized_exception import (
+    UnauthorizedException,
+)
+from spotifywebapi.http.http_method_enum import (
+    HttpMethodEnum,
+)
+from spotifywebapi.models.category_object import (
+    CategoryObject,
+)
+from spotifywebapi.models.paged_categories import (
+    PagedCategories,
+)
+
+
+class CategoriesController(BaseController):
+    """A Controller to access Endpoints in the spotifywebapi API."""
+
+    def __init__(self, config):
+        """Initialize CategoriesController object."""
+        super(CategoriesController, self).__init__(config)
+
+    def get_categories(self,
+                       locale=None,
+                       limit=20,
+                       offset=0):
+        """Perform a GET request to /browse/categories.
+
+        Get a list of categories used to tag items in Spotify (on, for example, the
+        Spotify player’s “Browse” tab).
+
+        Args:
+            locale (str, optional): The request query parameter.
+            limit (int, optional): The request query parameter. Example: 20
+            offset (int, optional): The request query parameter. Example: 0
+
+        Returns:
+            ApiResponse: An object with the response value as well as other useful
+                information such as status codes and headers. A paged set of
+                categories
+
+        Raises:
+            APIException: When an error occurs while fetching the data from the
+                remote API. This exception includes the HTTP Response code, an error
+                message, and the HTTP body that was received in the request.
+
+        """
+        return super().new_api_call_builder.request(
+            RequestBuilder().server(Server.DEFAULT)
+            .path("/browse/categories")
+            .http_method(HttpMethodEnum.GET)
+            .query_param(Parameter()
+                .key("locale")
+                .value(locale))
+            .query_param(Parameter()
+                .key("limit")
+                .value(limit))
+            .query_param(Parameter()
+                .key("offset")
+                .value(offset))
+            .header_param(Parameter()
+                .key("accept")
+                .value("application/json"))
+            .auth(Single("oauth_2_0")),
+        ).response(
+            ResponseHandler()
+            .deserializer(APIHelper.json_deserialize)
+            .deserialize_into(PagedCategories.from_dictionary)
+            .is_api_response(True)
+            .local_error("401",
+                "Bad or expired token. This can happen if the user revoked a token or"
+                "\nthe access token has expired. You should re-authenticate the user."
+                "\n",
+                UnauthorizedException)
+            .local_error("403",
+                "Bad OAuth request (wrong consumer key, bad nonce, expired\ntimestamp"
+                "...). Unfortunately, re-authenticating the user won't help here.\n",
+                ForbiddenException)
+            .local_error("429",
+                "The app has exceeded its rate limits.\n",
+                TooManyRequestsException),
+        ).execute()
+
+    def get_a_category(self,
+                       category_id,
+                       locale=None):
+        """Perform a GET request to /browse/categories/{category_id}.
+
+        Get a single category used to tag items in Spotify (on, for example, the
+        Spotify player’s “Browse” tab).
+
+        Args:
+            category_id (str): The request template parameter.
+            locale (str, optional): The request query parameter.
+
+        Returns:
+            ApiResponse: An object with the response value as well as other useful
+                information such as status codes and headers. A category
+
+        Raises:
+            APIException: When an error occurs while fetching the data from the
+                remote API. This exception includes the HTTP Response code, an error
+                message, and the HTTP body that was received in the request.
+
+        """
+        return super().new_api_call_builder.request(
+            RequestBuilder().server(Server.DEFAULT)
+            .path("/browse/categories/{category_id}")
+            .http_method(HttpMethodEnum.GET)
+            .template_param(Parameter()
+                .key("category_id")
+                .value(category_id)
+                .should_encode(True))
+            .query_param(Parameter()
+                .key("locale")
+                .value(locale))
+            .header_param(Parameter()
+                .key("accept")
+                .value("application/json"))
+            .auth(Single("oauth_2_0")),
+        ).response(
+            ResponseHandler()
+            .deserializer(APIHelper.json_deserialize)
+            .deserialize_into(CategoryObject.from_dictionary)
+            .is_api_response(True)
+            .local_error("401",
+                "Bad or expired token. This can happen if the user revoked a token or"
+                "\nthe access token has expired. You should re-authenticate the user."
+                "\n",
+                UnauthorizedException)
+            .local_error("403",
+                "Bad OAuth request (wrong consumer key, bad nonce, expired\ntimestamp"
+                "...). Unfortunately, re-authenticating the user won't help here.\n",
+                ForbiddenException)
+            .local_error("429",
+                "The app has exceeded its rate limits.\n",
+                TooManyRequestsException),
+        ).execute()