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

spotifywebapi/models/audiobook_object.py

@@ -0,0 +1,369 @@
+"""spotifywebapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: E501
+from spotifywebapi.api_helper import APIHelper
+from spotifywebapi.models.author_object import (
+    AuthorObject,
+)
+from spotifywebapi.models.copyright_object import (
+    CopyrightObject,
+)
+from spotifywebapi.models.external_url_object import (
+    ExternalUrlObject,
+)
+from spotifywebapi.models.image_object import (
+    ImageObject,
+)
+from spotifywebapi.models.narrator_object import (
+    NarratorObject,
+)
+from spotifywebapi.models.paging_simplified_chapter_object import (
+    PagingSimplifiedChapterObject,
+)
+
+
+class AudiobookObject(object):
+    """Implementation of the 'AudiobookObject' model.
+
+    Attributes:
+        authors (List[AuthorObject]): The author(s) for the audiobook.
+        available_markets (List[str]): A list of the countries in which the audiobook
+            can be played, identified by their [ISO 3166-1
+            alpha-2](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code.
+        copyrights (List[CopyrightObject]): The copyright statements of the audiobook.
+        description (str): A description of the audiobook. HTML tags are stripped
+            away from this field, use `html_description` field in case HTML tags are
+            needed.
+        html_description (str): A description of the audiobook. This field may
+            contain HTML tags.
+        edition (str): The edition of the audiobook.
+        explicit (bool): Whether or not the audiobook has explicit content (true =
+            yes it does; false = no it does not OR unknown).
+        external_urls (ExternalUrlObject): External URLs for this audiobook.
+        href (str): A link to the Web API endpoint providing full details of the
+            audiobook.
+        id (str): The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids)
+            for the audiobook.
+        images (List[ImageObject]): The cover art for the audiobook in various sizes,
+            widest first.
+        languages (List[str]): A list of the languages used in the audiobook,
+            identified by their [ISO 639](https://en.wikipedia.org/wiki/ISO_639) code.
+        media_type (str): The media type of the audiobook.
+        name (str): The name of the audiobook.
+        narrators (List[NarratorObject]): The narrator(s) for the audiobook.
+        publisher (str): The publisher of the audiobook.
+        mtype (Type9Enum): The object type.
+        uri (str): The [Spotify
+            URI](/documentation/web-api/concepts/spotify-uris-ids) for the audiobook.
+        total_chapters (int): The number of chapters in this audiobook.
+        chapters (PagingSimplifiedChapterObject): The chapters of the audiobook.
+
+    """
+
+    # Create a mapping from Model property names to API property names
+    _names = {
+        "authors": "authors",
+        "available_markets": "available_markets",
+        "copyrights": "copyrights",
+        "description": "description",
+        "html_description": "html_description",
+        "explicit": "explicit",
+        "external_urls": "external_urls",
+        "href": "href",
+        "id": "id",
+        "images": "images",
+        "languages": "languages",
+        "media_type": "media_type",
+        "name": "name",
+        "narrators": "narrators",
+        "publisher": "publisher",
+        "mtype": "type",
+        "uri": "uri",
+        "total_chapters": "total_chapters",
+        "chapters": "chapters",
+        "edition": "edition",
+    }
+
+    _optionals = [
+        "edition",
+    ]
+
+    def __init__(
+        self,
+        authors=None,
+        available_markets=None,
+        copyrights=None,
+        description=None,
+        html_description=None,
+        explicit=None,
+        external_urls=None,
+        href=None,
+        id=None,
+        images=None,
+        languages=None,
+        media_type=None,
+        name=None,
+        narrators=None,
+        publisher=None,
+        mtype=None,
+        uri=None,
+        total_chapters=None,
+        chapters=None,
+        edition=APIHelper.SKIP):
+        """Initialize a AudiobookObject instance."""
+        # Initialize members of the class
+        self.authors = authors
+        self.available_markets = available_markets
+        self.copyrights = copyrights
+        self.description = description
+        self.html_description = html_description
+        if edition is not APIHelper.SKIP:
+            self.edition = edition
+        self.explicit = explicit
+        self.external_urls = external_urls
+        self.href = href
+        self.id = id
+        self.images = images
+        self.languages = languages
+        self.media_type = media_type
+        self.name = name
+        self.narrators = narrators
+        self.publisher = publisher
+        self.mtype = mtype
+        self.uri = uri
+        self.total_chapters = total_chapters
+        self.chapters = chapters
+
+    @classmethod
+    def from_dictionary(cls,
+                        dictionary):
+        """Create an instance of this model from a dictionary
+
+        Args:
+            dictionary (dictionary): A dictionary representation of the object
+            as obtained from the deserialization of the server's response. The
+            keys MUST match property names in the API description.
+
+        Returns:
+            object: An instance of this structure class.
+
+        """
+        if not isinstance(dictionary, dict) or dictionary is None:
+            return None
+
+        # Extract variables from the dictionary
+        authors = None
+        if dictionary.get("authors") is not None:
+            authors = [
+                AuthorObject.from_dictionary(x)
+                    for x in dictionary.get("authors")
+            ]
+        available_markets =\
+            dictionary.get("available_markets")\
+            if dictionary.get("available_markets")\
+                else None
+        copyrights = None
+        if dictionary.get("copyrights") is not None:
+            copyrights = [
+                CopyrightObject.from_dictionary(x)
+                    for x in dictionary.get("copyrights")
+            ]
+        description =\
+            dictionary.get("description")\
+            if dictionary.get("description")\
+                else None
+        html_description =\
+            dictionary.get("html_description")\
+            if dictionary.get("html_description")\
+                else None
+        explicit =\
+            dictionary.get("explicit")\
+            if "explicit" in dictionary.keys()\
+                else None
+        external_urls =\
+            ExternalUrlObject.from_dictionary(
+                dictionary.get("external_urls"))\
+                if dictionary.get("external_urls") else None
+        href =\
+            dictionary.get("href")\
+            if dictionary.get("href")\
+                else None
+        id =\
+            dictionary.get("id")\
+            if dictionary.get("id")\
+                else None
+        images = None
+        if dictionary.get("images") is not None:
+            images = [
+                ImageObject.from_dictionary(x)
+                    for x in dictionary.get("images")
+            ]
+        languages =\
+            dictionary.get("languages")\
+            if dictionary.get("languages")\
+                else None
+        media_type =\
+            dictionary.get("media_type")\
+            if dictionary.get("media_type")\
+                else None
+        name =\
+            dictionary.get("name")\
+            if dictionary.get("name")\
+                else None
+        narrators = None
+        if dictionary.get("narrators") is not None:
+            narrators = [
+                NarratorObject.from_dictionary(x)
+                    for x in dictionary.get("narrators")
+            ]
+        publisher =\
+            dictionary.get("publisher")\
+            if dictionary.get("publisher")\
+                else None
+        mtype =\
+            dictionary.get("type")\
+            if dictionary.get("type")\
+                else None
+        uri =\
+            dictionary.get("uri")\
+            if dictionary.get("uri")\
+                else None
+        total_chapters =\
+            dictionary.get("total_chapters")\
+            if dictionary.get("total_chapters")\
+                else None
+        chapters =\
+            PagingSimplifiedChapterObject.from_dictionary(
+                dictionary.get("chapters"))\
+                if dictionary.get("chapters") else None
+        edition =\
+            dictionary.get("edition")\
+            if dictionary.get("edition")\
+                else APIHelper.SKIP
+
+        # Return an object of this model
+        return cls(authors,
+                   available_markets,
+                   copyrights,
+                   description,
+                   html_description,
+                   explicit,
+                   external_urls,
+                   href,
+                   id,
+                   images,
+                   languages,
+                   media_type,
+                   name,
+                   narrators,
+                   publisher,
+                   mtype,
+                   uri,
+                   total_chapters,
+                   chapters,
+                   edition)
+
+    def __repr__(self):
+        """Return a unambiguous string representation."""
+        _authors=self.authors
+        _available_markets=self.available_markets
+        _copyrights=self.copyrights
+        _description=self.description
+        _html_description=self.html_description
+        _edition=(
+            self.edition
+            if hasattr(self, "edition")
+            else None
+        )
+        _explicit=self.explicit
+        _external_urls=self.external_urls
+        _href=self.href
+        _id=self.id
+        _images=self.images
+        _languages=self.languages
+        _media_type=self.media_type
+        _name=self.name
+        _narrators=self.narrators
+        _publisher=self.publisher
+        _mtype=self.mtype
+        _uri=self.uri
+        _total_chapters=self.total_chapters
+        _chapters=self.chapters
+        return (
+            f"{self.__class__.__name__}("
+            f"authors={_authors!r}, "
+            f"available_markets={_available_markets!r}, "
+            f"copyrights={_copyrights!r}, "
+            f"description={_description!r}, "
+            f"html_description={_html_description!r}, "
+            f"edition={_edition!r}, "
+            f"explicit={_explicit!r}, "
+            f"external_urls={_external_urls!r}, "
+            f"href={_href!r}, "
+            f"id={_id!r}, "
+            f"images={_images!r}, "
+            f"languages={_languages!r}, "
+            f"media_type={_media_type!r}, "
+            f"name={_name!r}, "
+            f"narrators={_narrators!r}, "
+            f"publisher={_publisher!r}, "
+            f"mtype={_mtype!r}, "
+            f"uri={_uri!r}, "
+            f"total_chapters={_total_chapters!r}, "
+            f"chapters={_chapters!r}, "
+            f")"
+        )
+
+    def __str__(self):
+        """Return a human-readable string representation."""
+        _authors=self.authors
+        _available_markets=self.available_markets
+        _copyrights=self.copyrights
+        _description=self.description
+        _html_description=self.html_description
+        _edition=(
+            self.edition
+            if hasattr(self, "edition")
+            else None
+        )
+        _explicit=self.explicit
+        _external_urls=self.external_urls
+        _href=self.href
+        _id=self.id
+        _images=self.images
+        _languages=self.languages
+        _media_type=self.media_type
+        _name=self.name
+        _narrators=self.narrators
+        _publisher=self.publisher
+        _mtype=self.mtype
+        _uri=self.uri
+        _total_chapters=self.total_chapters
+        _chapters=self.chapters
+        return (
+            f"{self.__class__.__name__}("
+            f"authors={_authors!s}, "
+            f"available_markets={_available_markets!s}, "
+            f"copyrights={_copyrights!s}, "
+            f"description={_description!s}, "
+            f"html_description={_html_description!s}, "
+            f"edition={_edition!s}, "
+            f"explicit={_explicit!s}, "
+            f"external_urls={_external_urls!s}, "
+            f"href={_href!s}, "
+            f"id={_id!s}, "
+            f"images={_images!s}, "
+            f"languages={_languages!s}, "
+            f"media_type={_media_type!s}, "
+            f"name={_name!s}, "
+            f"narrators={_narrators!s}, "
+            f"publisher={_publisher!s}, "
+            f"mtype={_mtype!s}, "
+            f"uri={_uri!s}, "
+            f"total_chapters={_total_chapters!s}, "
+            f"chapters={_chapters!s}, "
+            f")"
+        )

spotifywebapi/models/author_object.py

@@ -0,0 +1,85 @@
+"""spotifywebapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: E501
+from spotifywebapi.api_helper import APIHelper
+
+
+class AuthorObject(object):
+    """Implementation of the 'AuthorObject' model.
+
+    Attributes:
+        name (str): The name of the author.
+
+    """
+
+    # Create a mapping from Model property names to API property names
+    _names = {
+        "name": "name",
+    }
+
+    _optionals = [
+        "name",
+    ]
+
+    def __init__(
+        self,
+        name=APIHelper.SKIP):
+        """Initialize a AuthorObject instance."""
+        # Initialize members of the class
+        if name is not APIHelper.SKIP:
+            self.name = name
+
+    @classmethod
+    def from_dictionary(cls,
+                        dictionary):
+        """Create an instance of this model from a dictionary
+
+        Args:
+            dictionary (dictionary): A dictionary representation of the object
+            as obtained from the deserialization of the server's response. The
+            keys MUST match property names in the API description.
+
+        Returns:
+            object: An instance of this structure class.
+
+        """
+        if not isinstance(dictionary, dict) or dictionary is None:
+            return None
+
+        # Extract variables from the dictionary
+        name =\
+            dictionary.get("name")\
+            if dictionary.get("name")\
+                else APIHelper.SKIP
+
+        # Return an object of this model
+        return cls(name)
+
+    def __repr__(self):
+        """Return a unambiguous string representation."""
+        _name=(
+            self.name
+            if hasattr(self, "name")
+            else None
+        )
+        return (
+            f"{self.__class__.__name__}("
+            f"name={_name!r}, "
+            f")"
+        )
+
+    def __str__(self):
+        """Return a human-readable string representation."""
+        _name=(
+            self.name
+            if hasattr(self, "name")
+            else None
+        )
+        return (
+            f"{self.__class__.__name__}("
+            f"name={_name!s}, "
+            f")"
+        )

spotifywebapi/models/categories.py

@@ -0,0 +1,162 @@
+"""spotifywebapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: E501
+from spotifywebapi.models.category_object import (
+    CategoryObject,
+)
+
+
+class Categories(object):
+    """Implementation of the 'Categories' model.
+
+    Attributes:
+        href (str): A link to the Web API endpoint returning the full result of the
+            request
+        limit (int): The maximum number of items in the response (as set in the query
+            or by default).
+        next (str): URL to the next page of items. ( `null` if none)
+        offset (int): The offset of the items returned (as set in the query or by
+            default)
+        previous (str): URL to the previous page of items. ( `null` if none)
+        total (int): The total number of items available to return.
+        items (List[CategoryObject]): The model property of type List[CategoryObject].
+
+    """
+
+    # Create a mapping from Model property names to API property names
+    _names = {
+        "href": "href",
+        "limit": "limit",
+        "next": "next",
+        "offset": "offset",
+        "previous": "previous",
+        "total": "total",
+        "items": "items",
+    }
+
+    _nullables = [
+        "next",
+        "previous",
+    ]
+
+    def __init__(
+        self,
+        href=None,
+        limit=None,
+        next=None,
+        offset=None,
+        previous=None,
+        total=None,
+        items=None):
+        """Initialize a Categories instance."""
+        # Initialize members of the class
+        self.href = href
+        self.limit = limit
+        self.next = next
+        self.offset = offset
+        self.previous = previous
+        self.total = total
+        self.items = items
+
+    @classmethod
+    def from_dictionary(cls,
+                        dictionary):
+        """Create an instance of this model from a dictionary
+
+        Args:
+            dictionary (dictionary): A dictionary representation of the object
+            as obtained from the deserialization of the server's response. The
+            keys MUST match property names in the API description.
+
+        Returns:
+            object: An instance of this structure class.
+
+        """
+        if not isinstance(dictionary, dict) or dictionary is None:
+            return None
+
+        # Extract variables from the dictionary
+        href =\
+            dictionary.get("href")\
+            if dictionary.get("href")\
+                else None
+        limit =\
+            dictionary.get("limit")\
+            if dictionary.get("limit")\
+                else None
+        next =\
+            dictionary.get("next")\
+            if dictionary.get("next")\
+                else None
+        offset =\
+            dictionary.get("offset")\
+            if dictionary.get("offset")\
+                else None
+        previous =\
+            dictionary.get("previous")\
+            if dictionary.get("previous")\
+                else None
+        total =\
+            dictionary.get("total")\
+            if dictionary.get("total")\
+                else None
+        items = None
+        if dictionary.get("items") is not None:
+            items = [
+                CategoryObject.from_dictionary(x)
+                    for x in dictionary.get("items")
+            ]
+
+        # Return an object of this model
+        return cls(href,
+                   limit,
+                   next,
+                   offset,
+                   previous,
+                   total,
+                   items)
+
+    def __repr__(self):
+        """Return a unambiguous string representation."""
+        _href=self.href
+        _limit=self.limit
+        _next=self.next
+        _offset=self.offset
+        _previous=self.previous
+        _total=self.total
+        _items=self.items
+        return (
+            f"{self.__class__.__name__}("
+            f"href={_href!r}, "
+            f"limit={_limit!r}, "
+            f"next={_next!r}, "
+            f"offset={_offset!r}, "
+            f"previous={_previous!r}, "
+            f"total={_total!r}, "
+            f"items={_items!r}, "
+            f")"
+        )
+
+    def __str__(self):
+        """Return a human-readable string representation."""
+        _href=self.href
+        _limit=self.limit
+        _next=self.next
+        _offset=self.offset
+        _previous=self.previous
+        _total=self.total
+        _items=self.items
+        return (
+            f"{self.__class__.__name__}("
+            f"href={_href!s}, "
+            f"limit={_limit!s}, "
+            f"next={_next!s}, "
+            f"offset={_offset!s}, "
+            f"previous={_previous!s}, "
+            f"total={_total!s}, "
+            f"items={_items!s}, "
+            f")"
+        )