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

spotifywebapi/models/simplified_album_object.py

@@ -0,0 +1,468 @@
+"""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.album_restriction_object import (
+    AlbumRestrictionObject,
+)
+from spotifywebapi.models.album_type_enum import (
+    AlbumTypeEnum,
+)
+from spotifywebapi.models.external_url_object import (
+    ExternalUrlObject,
+)
+from spotifywebapi.models.image_object import (
+    ImageObject,
+)
+from spotifywebapi.models.release_date_precision_enum import (
+    ReleaseDatePrecisionEnum,
+)
+from spotifywebapi.models.simplified_artist_object import (
+    SimplifiedArtistObject,
+)
+from spotifywebapi.models.type_2_enum import (
+    Type2Enum,
+)
+
+
+class SimplifiedAlbumObject(object):
+    """Implementation of the 'SimplifiedAlbumObject' model.
+
+    Attributes:
+        album_type (AlbumTypeEnum): The type of the album.
+        total_tracks (int): The number of tracks in the album.
+        available_markets (List[str]): The markets in which the album is available:
+            [ISO 3166-1 alpha-2 country
+            codes](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). _**NOTE**: an
+            album is considered available in a market when at least 1 of its tracks
+            is available in that market._
+        external_urls (ExternalUrlObject): Known external URLs for this album.
+        href (str): A link to the Web API endpoint providing full details of the
+            album.
+        id (str): The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids)
+            for the album.
+        images (List[ImageObject]): The cover art for the album in various sizes,
+            widest first.
+        name (str): The name of the album. In case of an album takedown, the value
+            may be an empty string.
+        release_date (str): The date the album was first released.
+        release_date_precision (ReleaseDatePrecisionEnum): The precision with which
+            `release_date` value is known.
+        restrictions (AlbumRestrictionObject): Included in the response when a
+            content restriction is applied.
+        mtype (Type2Enum): The object type.
+        uri (str): The [Spotify
+            URI](/documentation/web-api/concepts/spotify-uris-ids) for the album.
+        artists (List[SimplifiedArtistObject]): The artists of the album. Each artist
+            object includes a link in `href` to more detailed information about the
+            artist.
+
+    """
+
+    # Create a mapping from Model property names to API property names
+    _names = {
+        "album_type": "album_type",
+        "total_tracks": "total_tracks",
+        "available_markets": "available_markets",
+        "external_urls": "external_urls",
+        "href": "href",
+        "id": "id",
+        "images": "images",
+        "name": "name",
+        "release_date": "release_date",
+        "release_date_precision": "release_date_precision",
+        "mtype": "type",
+        "uri": "uri",
+        "artists": "artists",
+        "restrictions": "restrictions",
+    }
+
+    _optionals = [
+        "restrictions",
+    ]
+
+    def __init__(
+        self,
+        album_type=None,
+        total_tracks=None,
+        available_markets=None,
+        external_urls=None,
+        href=None,
+        id=None,
+        images=None,
+        name=None,
+        release_date=None,
+        release_date_precision=None,
+        mtype=None,
+        uri=None,
+        artists=None,
+        restrictions=APIHelper.SKIP):
+        """Initialize a SimplifiedAlbumObject instance."""
+        # Initialize members of the class
+        self.album_type = album_type
+        self.total_tracks = total_tracks
+        self.available_markets = available_markets
+        self.external_urls = external_urls
+        self.href = href
+        self.id = id
+        self.images = images
+        self.name = name
+        self.release_date = release_date
+        self.release_date_precision = release_date_precision
+        if restrictions is not APIHelper.SKIP:
+            self.restrictions = restrictions
+        self.mtype = mtype
+        self.uri = uri
+        self.artists = artists
+
+    @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
+        album_type =\
+            dictionary.get("album_type")\
+            if dictionary.get("album_type")\
+                else None
+        total_tracks =\
+            dictionary.get("total_tracks")\
+            if dictionary.get("total_tracks")\
+                else None
+        available_markets =\
+            dictionary.get("available_markets")\
+            if dictionary.get("available_markets")\
+                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")
+            ]
+        name =\
+            dictionary.get("name")\
+            if dictionary.get("name")\
+                else None
+        release_date =\
+            dictionary.get("release_date")\
+            if dictionary.get("release_date")\
+                else None
+        release_date_precision =\
+            dictionary.get("release_date_precision")\
+            if dictionary.get("release_date_precision")\
+                else None
+        mtype =\
+            dictionary.get("type")\
+            if dictionary.get("type")\
+                else None
+        uri =\
+            dictionary.get("uri")\
+            if dictionary.get("uri")\
+                else None
+        artists = None
+        if dictionary.get("artists") is not None:
+            artists = [
+                SimplifiedArtistObject.from_dictionary(x)
+                    for x in dictionary.get("artists")
+            ]
+        restrictions =\
+            AlbumRestrictionObject.from_dictionary(
+                dictionary.get("restrictions"))\
+                if "restrictions" in dictionary.keys()\
+                else APIHelper.SKIP
+
+        # Return an object of this model
+        return cls(album_type,
+                   total_tracks,
+                   available_markets,
+                   external_urls,
+                   href,
+                   id,
+                   images,
+                   name,
+                   release_date,
+                   release_date_precision,
+                   mtype,
+                   uri,
+                   artists,
+                   restrictions)
+
+    @classmethod
+    def validate(cls, dictionary):
+        """Validate dictionary against class required properties
+
+        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:
+            boolean : if dictionary is valid contains required properties.
+
+        """
+        if isinstance(dictionary, cls):
+            return APIHelper.is_valid_type(
+                    value=dictionary.album_type,
+                    type_callable=lambda value:
+                        AlbumTypeEnum.validate(value)) \
+                and APIHelper.is_valid_type(
+                    value=dictionary.total_tracks,
+                    type_callable=lambda value:
+                        isinstance(
+                        value,
+                        int,
+                )) \
+                and APIHelper.is_valid_type(
+                    value=dictionary.available_markets,
+                    type_callable=lambda value:
+                        isinstance(
+                        value,
+                        str,
+                )) \
+                and APIHelper.is_valid_type(
+                    value=dictionary.external_urls,
+                    type_callable=lambda value:
+                        ExternalUrlObject.validate(value),
+                    is_model_dict=True) \
+                and APIHelper.is_valid_type(
+                    value=dictionary.href,
+                    type_callable=lambda value:
+                        isinstance(
+                        value,
+                        str,
+                )) \
+                and APIHelper.is_valid_type(
+                    value=dictionary.id,
+                    type_callable=lambda value:
+                        isinstance(
+                        value,
+                        str,
+                )) \
+                and APIHelper.is_valid_type(
+                    value=dictionary.images,
+                    type_callable=lambda value:
+                        ImageObject.validate(value),
+                    is_model_dict=True,
+                    is_inner_model_dict=True) \
+                and APIHelper.is_valid_type(
+                    value=dictionary.name,
+                    type_callable=lambda value:
+                        isinstance(
+                        value,
+                        str,
+                )) \
+                and APIHelper.is_valid_type(
+                    value=dictionary.release_date,
+                    type_callable=lambda value:
+                        isinstance(
+                        value,
+                        str,
+                )) \
+                and APIHelper.is_valid_type(
+                    value=dictionary.release_date_precision,
+                    type_callable=lambda value:
+                        ReleaseDatePrecisionEnum.validate(value)) \
+                and APIHelper.is_valid_type(
+                    value=dictionary.mtype,
+                    type_callable=lambda value:
+                        Type2Enum.validate(value)) \
+                and APIHelper.is_valid_type(
+                    value=dictionary.uri,
+                    type_callable=lambda value:
+                        isinstance(
+                        value,
+                        str,
+                )) \
+                and APIHelper.is_valid_type(
+                    value=dictionary.artists,
+                    type_callable=lambda value:
+                        SimplifiedArtistObject.validate(value),
+                    is_model_dict=True,
+                    is_inner_model_dict=True)
+
+        if not isinstance(dictionary, dict):
+            return False
+
+        return APIHelper.is_valid_type(
+                value=dictionary.get("album_type"),
+                type_callable=lambda value:
+                    AlbumTypeEnum.validate(value)) \
+            and APIHelper.is_valid_type(
+                value=dictionary.get("total_tracks"),
+                type_callable=lambda value:
+                    isinstance(
+                    value,
+                    int,
+            )) \
+            and APIHelper.is_valid_type(
+                value=dictionary.get("available_markets"),
+                type_callable=lambda value:
+                    isinstance(
+                    value,
+                    str,
+            )) \
+            and APIHelper.is_valid_type(
+                value=dictionary.get("external_urls"),
+                type_callable=lambda value:
+                    ExternalUrlObject.validate(value),
+                is_model_dict=True) \
+            and APIHelper.is_valid_type(
+                value=dictionary.get("href"),
+                type_callable=lambda value:
+                    isinstance(
+                    value,
+                    str,
+            )) \
+            and APIHelper.is_valid_type(
+                value=dictionary.get("id"),
+                type_callable=lambda value:
+                    isinstance(
+                    value,
+                    str,
+            )) \
+            and APIHelper.is_valid_type(
+                value=dictionary.get("images"),
+                type_callable=lambda value:
+                    ImageObject.validate(value),
+                is_model_dict=True,
+                is_inner_model_dict=True) \
+            and APIHelper.is_valid_type(
+                value=dictionary.get("name"),
+                type_callable=lambda value:
+                    isinstance(
+                    value,
+                    str,
+            )) \
+            and APIHelper.is_valid_type(
+                value=dictionary.get("release_date"),
+                type_callable=lambda value:
+                    isinstance(
+                    value,
+                    str,
+            )) \
+            and APIHelper.is_valid_type(
+                value=dictionary.get("release_date_precision"),
+                type_callable=lambda value:
+                    ReleaseDatePrecisionEnum.validate(value)) \
+            and APIHelper.is_valid_type(
+                value=dictionary.get("type"),
+                type_callable=lambda value:
+                    Type2Enum.validate(value)) \
+            and APIHelper.is_valid_type(
+                value=dictionary.get("uri"),
+                type_callable=lambda value:
+                    isinstance(
+                    value,
+                    str,
+            )) \
+            and APIHelper.is_valid_type(
+                value=dictionary.get("artists"),
+                type_callable=lambda value:
+                    SimplifiedArtistObject.validate(value),
+                is_model_dict=True,
+                is_inner_model_dict=True)
+
+    def __repr__(self):
+        """Return a unambiguous string representation."""
+        _album_type=self.album_type
+        _total_tracks=self.total_tracks
+        _available_markets=self.available_markets
+        _external_urls=self.external_urls
+        _href=self.href
+        _id=self.id
+        _images=self.images
+        _name=self.name
+        _release_date=self.release_date
+        _release_date_precision=self.release_date_precision
+        _restrictions=(
+            self.restrictions
+            if hasattr(self, "restrictions")
+            else None
+        )
+        _mtype=self.mtype
+        _uri=self.uri
+        _artists=self.artists
+        return (
+            f"{self.__class__.__name__}("
+            f"album_type={_album_type!r}, "
+            f"total_tracks={_total_tracks!r}, "
+            f"available_markets={_available_markets!r}, "
+            f"external_urls={_external_urls!r}, "
+            f"href={_href!r}, "
+            f"id={_id!r}, "
+            f"images={_images!r}, "
+            f"name={_name!r}, "
+            f"release_date={_release_date!r}, "
+            f"release_date_precision={_release_date_precision!r}, "
+            f"restrictions={_restrictions!r}, "
+            f"mtype={_mtype!r}, "
+            f"uri={_uri!r}, "
+            f"artists={_artists!r}, "
+            f")"
+        )
+
+    def __str__(self):
+        """Return a human-readable string representation."""
+        _album_type=self.album_type
+        _total_tracks=self.total_tracks
+        _available_markets=self.available_markets
+        _external_urls=self.external_urls
+        _href=self.href
+        _id=self.id
+        _images=self.images
+        _name=self.name
+        _release_date=self.release_date
+        _release_date_precision=self.release_date_precision
+        _restrictions=(
+            self.restrictions
+            if hasattr(self, "restrictions")
+            else None
+        )
+        _mtype=self.mtype
+        _uri=self.uri
+        _artists=self.artists
+        return (
+            f"{self.__class__.__name__}("
+            f"album_type={_album_type!s}, "
+            f"total_tracks={_total_tracks!s}, "
+            f"available_markets={_available_markets!s}, "
+            f"external_urls={_external_urls!s}, "
+            f"href={_href!s}, "
+            f"id={_id!s}, "
+            f"images={_images!s}, "
+            f"name={_name!s}, "
+            f"release_date={_release_date!s}, "
+            f"release_date_precision={_release_date_precision!s}, "
+            f"restrictions={_restrictions!s}, "
+            f"mtype={_mtype!s}, "
+            f"uri={_uri!s}, "
+            f"artists={_artists!s}, "
+            f")"
+        )

spotifywebapi/models/simplified_artist_object.py

@@ -0,0 +1,228 @@
+"""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.external_url_object import (
+    ExternalUrlObject,
+)
+
+
+class SimplifiedArtistObject(object):
+    """Implementation of the 'SimplifiedArtistObject' model.
+
+    Attributes:
+        external_urls (ExternalUrlObject): Known external URLs for this artist.
+        href (str): A link to the Web API endpoint providing full details of the
+            artist.
+        id (str): The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids)
+            for the artist.
+        name (str): The name of the artist.
+        mtype (TypeEnum): The object type.
+        uri (str): The [Spotify
+            URI](/documentation/web-api/concepts/spotify-uris-ids) for the artist.
+
+    """
+
+    # Create a mapping from Model property names to API property names
+    _names = {
+        "external_urls": "external_urls",
+        "href": "href",
+        "id": "id",
+        "name": "name",
+        "mtype": "type",
+        "uri": "uri",
+    }
+
+    _optionals = [
+        "external_urls",
+        "href",
+        "id",
+        "name",
+        "mtype",
+        "uri",
+    ]
+
+    def __init__(
+        self,
+        external_urls=APIHelper.SKIP,
+        href=APIHelper.SKIP,
+        id=APIHelper.SKIP,
+        name=APIHelper.SKIP,
+        mtype=APIHelper.SKIP,
+        uri=APIHelper.SKIP):
+        """Initialize a SimplifiedArtistObject instance."""
+        # Initialize members of the class
+        if external_urls is not APIHelper.SKIP:
+            self.external_urls = external_urls
+        if href is not APIHelper.SKIP:
+            self.href = href
+        if id is not APIHelper.SKIP:
+            self.id = id
+        if name is not APIHelper.SKIP:
+            self.name = name
+        if mtype is not APIHelper.SKIP:
+            self.mtype = mtype
+        if uri is not APIHelper.SKIP:
+            self.uri = uri
+
+    @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
+        external_urls =\
+            ExternalUrlObject.from_dictionary(
+                dictionary.get("external_urls"))\
+                if "external_urls" in dictionary.keys()\
+                else APIHelper.SKIP
+        href =\
+            dictionary.get("href")\
+            if dictionary.get("href")\
+                else APIHelper.SKIP
+        id =\
+            dictionary.get("id")\
+            if dictionary.get("id")\
+                else APIHelper.SKIP
+        name =\
+            dictionary.get("name")\
+            if dictionary.get("name")\
+                else APIHelper.SKIP
+        mtype =\
+            dictionary.get("type")\
+            if dictionary.get("type")\
+                else APIHelper.SKIP
+        uri =\
+            dictionary.get("uri")\
+            if dictionary.get("uri")\
+                else APIHelper.SKIP
+
+        # Return an object of this model
+        return cls(external_urls,
+                   href,
+                   id,
+                   name,
+                   mtype,
+                   uri)
+
+    @classmethod
+    def validate(cls, dictionary):
+        """Validate dictionary against class required properties
+
+        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:
+            boolean : if dictionary is valid contains required properties.
+
+        """
+        if isinstance(dictionary, cls):
+            return True
+
+        if not isinstance(dictionary, dict):
+            return False
+
+        return True
+
+    def __repr__(self):
+        """Return a unambiguous string representation."""
+        _external_urls=(
+            self.external_urls
+            if hasattr(self, "external_urls")
+            else None
+        )
+        _href=(
+            self.href
+            if hasattr(self, "href")
+            else None
+        )
+        _id=(
+            self.id
+            if hasattr(self, "id")
+            else None
+        )
+        _name=(
+            self.name
+            if hasattr(self, "name")
+            else None
+        )
+        _mtype=(
+            self.mtype
+            if hasattr(self, "mtype")
+            else None
+        )
+        _uri=(
+            self.uri
+            if hasattr(self, "uri")
+            else None
+        )
+        return (
+            f"{self.__class__.__name__}("
+            f"external_urls={_external_urls!r}, "
+            f"href={_href!r}, "
+            f"id={_id!r}, "
+            f"name={_name!r}, "
+            f"mtype={_mtype!r}, "
+            f"uri={_uri!r}, "
+            f")"
+        )
+
+    def __str__(self):
+        """Return a human-readable string representation."""
+        _external_urls=(
+            self.external_urls
+            if hasattr(self, "external_urls")
+            else None
+        )
+        _href=(
+            self.href
+            if hasattr(self, "href")
+            else None
+        )
+        _id=(
+            self.id
+            if hasattr(self, "id")
+            else None
+        )
+        _name=(
+            self.name
+            if hasattr(self, "name")
+            else None
+        )
+        _mtype=(
+            self.mtype
+            if hasattr(self, "mtype")
+            else None
+        )
+        _uri=(
+            self.uri
+            if hasattr(self, "uri")
+            else None
+        )
+        return (
+            f"{self.__class__.__name__}("
+            f"external_urls={_external_urls!s}, "
+            f"href={_href!s}, "
+            f"id={_id!s}, "
+            f"name={_name!s}, "
+            f"mtype={_mtype!s}, "
+            f"uri={_uri!s}, "
+            f")"
+        )