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

spotifywebapi/models/image_object.py

@@ -0,0 +1,168 @@
+"""spotifywebapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: E501
+from spotifywebapi.api_helper import APIHelper
+
+
+class ImageObject(object):
+    """Implementation of the 'ImageObject' model.
+
+    Attributes:
+        url (str): The source URL of the image.
+        height (int): The image height in pixels.
+        width (int): The image width in pixels.
+
+    """
+
+    # Create a mapping from Model property names to API property names
+    _names = {
+        "url": "url",
+        "height": "height",
+        "width": "width",
+    }
+
+    _nullables = [
+        "height",
+        "width",
+    ]
+
+    def __init__(
+        self,
+        url=None,
+        height=None,
+        width=None):
+        """Initialize a ImageObject instance."""
+        # Initialize members of the class
+        self.url = url
+        self.height = height
+        self.width = width
+
+    @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
+        url =\
+            dictionary.get("url")\
+            if dictionary.get("url")\
+                else None
+        height =\
+            dictionary.get("height")\
+            if dictionary.get("height")\
+                else None
+        width =\
+            dictionary.get("width")\
+            if dictionary.get("width")\
+                else None
+
+        # Return an object of this model
+        return cls(url,
+                   height,
+                   width)
+
+    @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.url,
+                    type_callable=lambda value:
+                        isinstance(
+                        value,
+                        str,
+                )) \
+                and APIHelper.is_valid_type(
+                    value=dictionary.height,
+                    type_callable=lambda value:
+                        isinstance(
+                        value,
+                        int,
+                ),
+                    is_value_nullable=True) \
+                and APIHelper.is_valid_type(
+                    value=dictionary.width,
+                    type_callable=lambda value:
+                        isinstance(
+                        value,
+                        int,
+                ),
+                    is_value_nullable=True)
+
+        if not isinstance(dictionary, dict):
+            return False
+
+        return APIHelper.is_valid_type(
+                value=dictionary.get("url"),
+                type_callable=lambda value:
+                    isinstance(
+                    value,
+                    str,
+            )) \
+            and APIHelper.is_valid_type(
+                value=dictionary.get("height"),
+                type_callable=lambda value:
+                    isinstance(
+                    value,
+                    int,
+            ),
+                is_value_nullable=True) \
+            and APIHelper.is_valid_type(
+                value=dictionary.get("width"),
+                type_callable=lambda value:
+                    isinstance(
+                    value,
+                    int,
+            ),
+                is_value_nullable=True)
+
+    def __repr__(self):
+        """Return a unambiguous string representation."""
+        _url=self.url
+        _height=self.height
+        _width=self.width
+        return (
+            f"{self.__class__.__name__}("
+            f"url={_url!r}, "
+            f"height={_height!r}, "
+            f"width={_width!r}, "
+            f")"
+        )
+
+    def __str__(self):
+        """Return a human-readable string representation."""
+        _url=self.url
+        _height=self.height
+        _width=self.width
+        return (
+            f"{self.__class__.__name__}("
+            f"url={_url!s}, "
+            f"height={_height!s}, "
+            f"width={_width!s}, "
+            f")"
+        )

spotifywebapi/models/include_external_enum.py

@@ -0,0 +1,45 @@
+"""spotifywebapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: E501
+
+class IncludeExternalEnum(object):
+    """Implementation of the 'Include External' enum.
+
+    If `include_external=audio` is specified it signals that the client can play
+    externally hosted audio content, and marks
+    the content as playable in the response. By default externally hosted audio
+    content is marked as unplayable in the response.
+
+    Attributes:
+        AUDIO: The enum member of type str.
+
+    """
+
+    AUDIO = "audio"
+
+    @classmethod
+    def from_value(cls, value, default=None):
+        """Return the matching enum value for the given input."""
+        if value is None:
+            return default
+
+        # If numeric and matches directly
+        if isinstance(value, int):
+            for name, val in cls.__dict__.items():
+                if not name.startswith("_") and val == value:
+                    return val
+
+        # If string, perform case-insensitive match
+        if isinstance(value, str):
+            value_lower = value.lower()
+            for name, val in cls.__dict__.items():
+                if not name.startswith("_") and (
+                    name.lower() == value_lower or str(val).lower() == value_lower
+                ):
+                    return val
+
+        # Fallback to default
+        return default

spotifywebapi/models/item_type_1_enum.py

@@ -0,0 +1,56 @@
+"""spotifywebapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: E501
+
+class ItemType1Enum(object):
+    """Implementation of the 'Item Type1' enum.
+
+    The ID type: currently only `artist` is supported.
+
+    Attributes:
+        ARTIST: The enum member of type str.
+
+    """
+
+    _all_values = ["artist"]
+    ARTIST = "artist"
+
+    @classmethod
+    def validate(cls, value):
+        """Validate value contains in enum
+
+        Args:
+            value: the value to be validated
+
+        Returns:
+            boolean : if value is valid enum values.
+
+        """
+        return value in cls._all_values
+
+    @classmethod
+    def from_value(cls, value, default=None):
+        """Return the matching enum value for the given input."""
+        if value is None:
+            return default
+
+        # If numeric and matches directly
+        if isinstance(value, int):
+            for name, val in cls.__dict__.items():
+                if not name.startswith("_") and val == value:
+                    return val
+
+        # If string, perform case-insensitive match
+        if isinstance(value, str):
+            value_lower = value.lower()
+            for name, val in cls.__dict__.items():
+                if not name.startswith("_") and (
+                    name.lower() == value_lower or str(val).lower() == value_lower
+                ):
+                    return val
+
+        # Fallback to default
+        return default

spotifywebapi/models/item_type_2_enum.py

@@ -0,0 +1,45 @@
+"""spotifywebapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: E501
+
+class ItemType2Enum(object):
+    """Implementation of the 'Item Type2' enum.
+
+    The ID type.
+
+    Attributes:
+        ARTIST: The enum member of type str.
+        USER: The enum member of type str.
+
+    """
+
+    ARTIST = "artist"
+
+    USER = "user"
+
+    @classmethod
+    def from_value(cls, value, default=None):
+        """Return the matching enum value for the given input."""
+        if value is None:
+            return default
+
+        # If numeric and matches directly
+        if isinstance(value, int):
+            for name, val in cls.__dict__.items():
+                if not name.startswith("_") and val == value:
+                    return val
+
+        # If string, perform case-insensitive match
+        if isinstance(value, str):
+            value_lower = value.lower()
+            for name, val in cls.__dict__.items():
+                if not name.startswith("_") and (
+                    name.lower() == value_lower or str(val).lower() == value_lower
+                ):
+                    return val
+
+        # Fallback to default
+        return default

spotifywebapi/models/item_type_3_enum.py

@@ -0,0 +1,45 @@
+"""spotifywebapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: E501
+
+class ItemType3Enum(object):
+    """Implementation of the 'Item Type3' enum.
+
+    The ID type: either `artist` or `user`.
+
+    Attributes:
+        ARTIST: The enum member of type str.
+        USER: The enum member of type str.
+
+    """
+
+    ARTIST = "artist"
+
+    USER = "user"
+
+    @classmethod
+    def from_value(cls, value, default=None):
+        """Return the matching enum value for the given input."""
+        if value is None:
+            return default
+
+        # If numeric and matches directly
+        if isinstance(value, int):
+            for name, val in cls.__dict__.items():
+                if not name.startswith("_") and val == value:
+                    return val
+
+        # If string, perform case-insensitive match
+        if isinstance(value, str):
+            value_lower = value.lower()
+            for name, val in cls.__dict__.items():
+                if not name.startswith("_") and (
+                    name.lower() == value_lower or str(val).lower() == value_lower
+                ):
+                    return val
+
+        # Fallback to default
+        return default

spotifywebapi/models/item_type_enum.py

@@ -0,0 +1,58 @@
+"""spotifywebapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: E501
+
+class ItemTypeEnum(object):
+    """Implementation of the 'Item type' enum.
+
+    Attributes:
+        ALBUM: The enum member of type str.
+        ARTIST: The enum member of type str.
+        PLAYLIST: The enum member of type str.
+        TRACK: The enum member of type str.
+        SHOW: The enum member of type str.
+        EPISODE: The enum member of type str.
+        AUDIOBOOK: The enum member of type str.
+
+    """
+
+    ALBUM = "album"
+
+    ARTIST = "artist"
+
+    PLAYLIST = "playlist"
+
+    TRACK = "track"
+
+    SHOW = "show"
+
+    EPISODE = "episode"
+
+    AUDIOBOOK = "audiobook"
+
+    @classmethod
+    def from_value(cls, value, default=None):
+        """Return the matching enum value for the given input."""
+        if value is None:
+            return default
+
+        # If numeric and matches directly
+        if isinstance(value, int):
+            for name, val in cls.__dict__.items():
+                if not name.startswith("_") and val == value:
+                    return val
+
+        # If string, perform case-insensitive match
+        if isinstance(value, str):
+            value_lower = value.lower()
+            for name, val in cls.__dict__.items():
+                if not name.startswith("_") and (
+                    name.lower() == value_lower or str(val).lower() == value_lower
+                ):
+                    return val
+
+        # Fallback to default
+        return default

spotifywebapi/models/linked_track_object.py

@@ -0,0 +1,205 @@
+"""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 LinkedTrackObject(object):
+    """Implementation of the 'LinkedTrackObject' model.
+
+    Attributes:
+        external_urls (ExternalUrlObject): Known external URLs for this track.
+        href (str): A link to the Web API endpoint providing full details of the
+            track.
+        id (str): The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids)
+            for the track.
+        mtype (str): The object type: "track".
+        uri (str): The [Spotify
+            URI](/documentation/web-api/concepts/spotify-uris-ids) for the track.
+
+    """
+
+    # Create a mapping from Model property names to API property names
+    _names = {
+        "external_urls": "external_urls",
+        "href": "href",
+        "id": "id",
+        "mtype": "type",
+        "uri": "uri",
+    }
+
+    _optionals = [
+        "external_urls",
+        "href",
+        "id",
+        "mtype",
+        "uri",
+    ]
+
+    def __init__(
+        self,
+        external_urls=APIHelper.SKIP,
+        href=APIHelper.SKIP,
+        id=APIHelper.SKIP,
+        mtype=APIHelper.SKIP,
+        uri=APIHelper.SKIP):
+        """Initialize a LinkedTrackObject 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 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
+        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,
+                   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
+        )
+        _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"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
+        )
+        _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"mtype={_mtype!s}, "
+            f"uri={_uri!s}, "
+            f")"
+        )

spotifywebapi/models/many_albums.py

@@ -0,0 +1,76 @@
+"""spotifywebapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: E501
+from spotifywebapi.models.album_object import (
+    AlbumObject,
+)
+
+
+class ManyAlbums(object):
+    """Implementation of the 'ManyAlbums' model.
+
+    Attributes:
+        albums (List[AlbumObject]): The model property of type List[AlbumObject].
+
+    """
+
+    # Create a mapping from Model property names to API property names
+    _names = {
+        "albums": "albums",
+    }
+
+    def __init__(
+        self,
+        albums=None):
+        """Initialize a ManyAlbums instance."""
+        # Initialize members of the class
+        self.albums = albums
+
+    @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
+        albums = None
+        if dictionary.get("albums") is not None:
+            albums = [
+                AlbumObject.from_dictionary(x)
+                    for x in dictionary.get("albums")
+            ]
+
+        # Return an object of this model
+        return cls(albums)
+
+    def __repr__(self):
+        """Return a unambiguous string representation."""
+        _albums=self.albums
+        return (
+            f"{self.__class__.__name__}("
+            f"albums={_albums!r}, "
+            f")"
+        )
+
+    def __str__(self):
+        """Return a human-readable string representation."""
+        _albums=self.albums
+        return (
+            f"{self.__class__.__name__}("
+            f"albums={_albums!s}, "
+            f")"
+        )