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

spotifywebapi/models/queue_object.py

@@ -0,0 +1,118 @@
+"""spotifywebapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: E501
+from spotifywebapi.api_helper import APIHelper
+
+
+class QueueObject(object):
+    """Implementation of the 'QueueObject' model.
+
+    Attributes:
+        currently_playing (TrackObject | EpisodeObject | None): The currently playing
+            track or episode. Can be `null`.
+        queue (List[TrackObject | EpisodeObject] | None): The tracks or episodes in
+            the queue. Can be empty.
+
+    """
+
+    # Create a mapping from Model property names to API property names
+    _names = {
+        "currently_playing": "currently_playing",
+        "queue": "queue",
+    }
+
+    _optionals = [
+        "currently_playing",
+        "queue",
+    ]
+
+    def __init__(
+        self,
+        currently_playing=APIHelper.SKIP,
+        queue=APIHelper.SKIP):
+        """Initialize a QueueObject instance."""
+        # Initialize members of the class
+        if currently_playing is not APIHelper.SKIP:
+            self.currently_playing = currently_playing
+        if queue is not APIHelper.SKIP:
+            self.queue = queue
+
+    @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.
+
+        """
+        from spotifywebapi.utilities.union_type_lookup import (
+            UnionTypeLookUp,
+        )
+
+        if not isinstance(dictionary, dict) or dictionary is None:
+            return None
+
+        # Extract variables from the dictionary
+        currently_playing = APIHelper.deserialize_union_type(
+            UnionTypeLookUp.get("QueueObjectCurrentlyPlaying"),
+            dictionary.get("currently_playing"),
+            False)\
+            if dictionary.get("currently_playing") is not None\
+            else APIHelper.SKIP
+        queue = APIHelper.deserialize_union_type(
+            UnionTypeLookUp.get("QueueObjectQueue"),
+            dictionary.get("queue"),
+            False)\
+            if dictionary.get("queue") is not None\
+            else APIHelper.SKIP
+
+        # Return an object of this model
+        return cls(currently_playing,
+                   queue)
+
+    def __repr__(self):
+        """Return a unambiguous string representation."""
+        _currently_playing=(
+            self.currently_playing
+            if hasattr(self, "currently_playing")
+            else None
+        )
+        _queue=(
+            self.queue
+            if hasattr(self, "queue")
+            else None
+        )
+        return (
+            f"{self.__class__.__name__}("
+            f"currently_playing={_currently_playing!r}, "
+            f"queue={_queue!r}, "
+            f")"
+        )
+
+    def __str__(self):
+        """Return a human-readable string representation."""
+        _currently_playing=(
+            self.currently_playing
+            if hasattr(self, "currently_playing")
+            else None
+        )
+        _queue=(
+            self.queue
+            if hasattr(self, "queue")
+            else None
+        )
+        return (
+            f"{self.__class__.__name__}("
+            f"currently_playing={_currently_playing!s}, "
+            f"queue={_queue!s}, "
+            f")"
+        )

spotifywebapi/models/reason_enum.py

@@ -0,0 +1,65 @@
+"""spotifywebapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: E501
+
+class ReasonEnum(object):
+    """Implementation of the 'Reason' enum.
+
+    The reason for the restriction. Albums may be restricted if the content is not
+    available in a given market, to the user's subscription type, or when the user's
+    account is set to not play explicit content.
+    Additional reasons may be added in the future.
+
+    Attributes:
+        MARKET: The enum member of type str.
+        PRODUCT: The enum member of type str.
+        EXPLICIT: The enum member of type str.
+
+    """
+
+    _all_values = ["market", "product", "explicit"]
+    MARKET = "market"
+
+    PRODUCT = "product"
+
+    EXPLICIT = "explicit"
+
+    @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/recommendation_seed_object.py

@@ -0,0 +1,208 @@
+"""spotifywebapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: E501
+from spotifywebapi.api_helper import APIHelper
+
+
+class RecommendationSeedObject(object):
+    """Implementation of the 'RecommendationSeedObject' model.
+
+    Attributes:
+        after_filtering_size (int): The number of tracks available after min\_\* and
+            max\_\* filters have been applied.
+        after_relinking_size (int): The number of tracks available after relinking
+            for regional availability.
+        href (str): A link to the full track or artist data for this seed. For tracks
+            this will be a link to a Track Object. For artists a link to an Artist
+            Object. For genre seeds, this value will be `null`.
+        id (str): The id used to select this seed. This will be the same as the
+            string used in the `seed_artists`, `seed_tracks` or `seed_genres`
+            parameter.
+        initial_pool_size (int): The number of recommended tracks available for this
+            seed.
+        mtype (str): The entity type of this seed. One of `artist`, `track` or
+            `genre`.
+
+    """
+
+    # Create a mapping from Model property names to API property names
+    _names = {
+        "after_filtering_size": "afterFilteringSize",
+        "after_relinking_size": "afterRelinkingSize",
+        "href": "href",
+        "id": "id",
+        "initial_pool_size": "initialPoolSize",
+        "mtype": "type",
+    }
+
+    _optionals = [
+        "after_filtering_size",
+        "after_relinking_size",
+        "href",
+        "id",
+        "initial_pool_size",
+        "mtype",
+    ]
+
+    def __init__(
+        self,
+        after_filtering_size=APIHelper.SKIP,
+        after_relinking_size=APIHelper.SKIP,
+        href=APIHelper.SKIP,
+        id=APIHelper.SKIP,
+        initial_pool_size=APIHelper.SKIP,
+        mtype=APIHelper.SKIP):
+        """Initialize a RecommendationSeedObject instance."""
+        # Initialize members of the class
+        if after_filtering_size is not APIHelper.SKIP:
+            self.after_filtering_size = after_filtering_size
+        if after_relinking_size is not APIHelper.SKIP:
+            self.after_relinking_size = after_relinking_size
+        if href is not APIHelper.SKIP:
+            self.href = href
+        if id is not APIHelper.SKIP:
+            self.id = id
+        if initial_pool_size is not APIHelper.SKIP:
+            self.initial_pool_size = initial_pool_size
+        if mtype is not APIHelper.SKIP:
+            self.mtype = mtype
+
+    @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
+        after_filtering_size =\
+            dictionary.get("afterFilteringSize")\
+            if dictionary.get("afterFilteringSize")\
+                else APIHelper.SKIP
+        after_relinking_size =\
+            dictionary.get("afterRelinkingSize")\
+            if dictionary.get("afterRelinkingSize")\
+                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
+        initial_pool_size =\
+            dictionary.get("initialPoolSize")\
+            if dictionary.get("initialPoolSize")\
+                else APIHelper.SKIP
+        mtype =\
+            dictionary.get("type")\
+            if dictionary.get("type")\
+                else APIHelper.SKIP
+
+        # Return an object of this model
+        return cls(after_filtering_size,
+                   after_relinking_size,
+                   href,
+                   id,
+                   initial_pool_size,
+                   mtype)
+
+    def __repr__(self):
+        """Return a unambiguous string representation."""
+        _after_filtering_size=(
+            self.after_filtering_size
+            if hasattr(self, "after_filtering_size")
+            else None
+        )
+        _after_relinking_size=(
+            self.after_relinking_size
+            if hasattr(self, "after_relinking_size")
+            else None
+        )
+        _href=(
+            self.href
+            if hasattr(self, "href")
+            else None
+        )
+        _id=(
+            self.id
+            if hasattr(self, "id")
+            else None
+        )
+        _initial_pool_size=(
+            self.initial_pool_size
+            if hasattr(self, "initial_pool_size")
+            else None
+        )
+        _mtype=(
+            self.mtype
+            if hasattr(self, "mtype")
+            else None
+        )
+        return (
+            f"{self.__class__.__name__}("
+            f"after_filtering_size={_after_filtering_size!r}, "
+            f"after_relinking_size={_after_relinking_size!r}, "
+            f"href={_href!r}, "
+            f"id={_id!r}, "
+            f"initial_pool_size={_initial_pool_size!r}, "
+            f"mtype={_mtype!r}, "
+            f")"
+        )
+
+    def __str__(self):
+        """Return a human-readable string representation."""
+        _after_filtering_size=(
+            self.after_filtering_size
+            if hasattr(self, "after_filtering_size")
+            else None
+        )
+        _after_relinking_size=(
+            self.after_relinking_size
+            if hasattr(self, "after_relinking_size")
+            else None
+        )
+        _href=(
+            self.href
+            if hasattr(self, "href")
+            else None
+        )
+        _id=(
+            self.id
+            if hasattr(self, "id")
+            else None
+        )
+        _initial_pool_size=(
+            self.initial_pool_size
+            if hasattr(self, "initial_pool_size")
+            else None
+        )
+        _mtype=(
+            self.mtype
+            if hasattr(self, "mtype")
+            else None
+        )
+        return (
+            f"{self.__class__.__name__}("
+            f"after_filtering_size={_after_filtering_size!s}, "
+            f"after_relinking_size={_after_relinking_size!s}, "
+            f"href={_href!s}, "
+            f"id={_id!s}, "
+            f"initial_pool_size={_initial_pool_size!s}, "
+            f"mtype={_mtype!s}, "
+            f")"
+        )

spotifywebapi/models/recommendations_object.py

@@ -0,0 +1,96 @@
+"""spotifywebapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: E501
+from spotifywebapi.models.recommendation_seed_object import (
+    RecommendationSeedObject,
+)
+from spotifywebapi.models.track_object import (
+    TrackObject,
+)
+
+
+class RecommendationsObject(object):
+    """Implementation of the 'RecommendationsObject' model.
+
+    Attributes:
+        seeds (List[RecommendationSeedObject]): An array of recommendation seed
+            objects.
+        tracks (List[TrackObject]): An array of track objects ordered according to
+            the parameters supplied.
+
+    """
+
+    # Create a mapping from Model property names to API property names
+    _names = {
+        "seeds": "seeds",
+        "tracks": "tracks",
+    }
+
+    def __init__(
+        self,
+        seeds=None,
+        tracks=None):
+        """Initialize a RecommendationsObject instance."""
+        # Initialize members of the class
+        self.seeds = seeds
+        self.tracks = tracks
+
+    @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
+        seeds = None
+        if dictionary.get("seeds") is not None:
+            seeds = [
+                RecommendationSeedObject.from_dictionary(x)
+                    for x in dictionary.get("seeds")
+            ]
+        tracks = None
+        if dictionary.get("tracks") is not None:
+            tracks = [
+                TrackObject.from_dictionary(x)
+                    for x in dictionary.get("tracks")
+            ]
+
+        # Return an object of this model
+        return cls(seeds,
+                   tracks)
+
+    def __repr__(self):
+        """Return a unambiguous string representation."""
+        _seeds=self.seeds
+        _tracks=self.tracks
+        return (
+            f"{self.__class__.__name__}("
+            f"seeds={_seeds!r}, "
+            f"tracks={_tracks!r}, "
+            f")"
+        )
+
+    def __str__(self):
+        """Return a human-readable string representation."""
+        _seeds=self.seeds
+        _tracks=self.tracks
+        return (
+            f"{self.__class__.__name__}("
+            f"seeds={_seeds!s}, "
+            f"tracks={_tracks!s}, "
+            f")"
+        )

spotifywebapi/models/release_date_precision_enum.py

@@ -0,0 +1,62 @@
+"""spotifywebapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: E501
+
+class ReleaseDatePrecisionEnum(object):
+    """Implementation of the 'ReleaseDatePrecision' enum.
+
+    The precision with which `release_date` value is known.
+
+    Attributes:
+        YEAR: The enum member of type str.
+        MONTH: The enum member of type str.
+        DAY: The enum member of type str.
+
+    """
+
+    _all_values = ["year", "month", "day"]
+    YEAR = "year"
+
+    MONTH = "month"
+
+    DAY = "day"
+
+    @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/resume_point_object.py

@@ -0,0 +1,131 @@
+"""spotifywebapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: E501
+from spotifywebapi.api_helper import APIHelper
+
+
+class ResumePointObject(object):
+    """Implementation of the 'ResumePointObject' model.
+
+    Attributes:
+        fully_played (bool): Whether or not the episode has been fully played by the
+            user.
+        resume_position_ms (int): The user's most recent position in the episode in
+            milliseconds.
+
+    """
+
+    # Create a mapping from Model property names to API property names
+    _names = {
+        "fully_played": "fully_played",
+        "resume_position_ms": "resume_position_ms",
+    }
+
+    _optionals = [
+        "fully_played",
+        "resume_position_ms",
+    ]
+
+    def __init__(
+        self,
+        fully_played=APIHelper.SKIP,
+        resume_position_ms=APIHelper.SKIP):
+        """Initialize a ResumePointObject instance."""
+        # Initialize members of the class
+        if fully_played is not APIHelper.SKIP:
+            self.fully_played = fully_played
+        if resume_position_ms is not APIHelper.SKIP:
+            self.resume_position_ms = resume_position_ms
+
+    @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
+        fully_played =\
+            dictionary.get("fully_played")\
+            if "fully_played" in dictionary.keys()\
+                else APIHelper.SKIP
+        resume_position_ms =\
+            dictionary.get("resume_position_ms")\
+            if dictionary.get("resume_position_ms")\
+                else APIHelper.SKIP
+
+        # Return an object of this model
+        return cls(fully_played,
+                   resume_position_ms)
+
+    @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."""
+        _fully_played=(
+            self.fully_played
+            if hasattr(self, "fully_played")
+            else None
+        )
+        _resume_position_ms=(
+            self.resume_position_ms
+            if hasattr(self, "resume_position_ms")
+            else None
+        )
+        return (
+            f"{self.__class__.__name__}("
+            f"fully_played={_fully_played!r}, "
+            f"resume_position_ms={_resume_position_ms!r}, "
+            f")"
+        )
+
+    def __str__(self):
+        """Return a human-readable string representation."""
+        _fully_played=(
+            self.fully_played
+            if hasattr(self, "fully_played")
+            else None
+        )
+        _resume_position_ms=(
+            self.resume_position_ms
+            if hasattr(self, "resume_position_ms")
+            else None
+        )
+        return (
+            f"{self.__class__.__name__}("
+            f"fully_played={_fully_played!s}, "
+            f"resume_position_ms={_resume_position_ms!s}, "
+            f")"
+        )