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

spotifywebapi/models/markets.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 Markets(object):
+    """Implementation of the 'Markets' model.
+
+    Attributes:
+        markets (List[str]): The model property of type List[str].
+
+    """
+
+    # Create a mapping from Model property names to API property names
+    _names = {
+        "markets": "markets",
+    }
+
+    _optionals = [
+        "markets",
+    ]
+
+    def __init__(
+        self,
+        markets=APIHelper.SKIP):
+        """Initialize a Markets instance."""
+        # Initialize members of the class
+        if markets is not APIHelper.SKIP:
+            self.markets = markets
+
+    @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
+        markets =\
+            dictionary.get("markets")\
+            if dictionary.get("markets")\
+                else APIHelper.SKIP
+
+        # Return an object of this model
+        return cls(markets)
+
+    def __repr__(self):
+        """Return a unambiguous string representation."""
+        _markets=(
+            self.markets
+            if hasattr(self, "markets")
+            else None
+        )
+        return (
+            f"{self.__class__.__name__}("
+            f"markets={_markets!r}, "
+            f")"
+        )
+
+    def __str__(self):
+        """Return a human-readable string representation."""
+        _markets=(
+            self.markets
+            if hasattr(self, "markets")
+            else None
+        )
+        return (
+            f"{self.__class__.__name__}("
+            f"markets={_markets!s}, "
+            f")"
+        )

spotifywebapi/models/me_albums_request.py

@@ -0,0 +1,90 @@
+"""spotifywebapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: E501
+from spotifywebapi.api_helper import APIHelper
+
+
+class MeAlbumsRequest(object):
+    """Implementation of the 'Me Albums Request' model.
+
+    Attributes:
+        ids (List[str]): A JSON array of the [Spotify
+            IDs](/documentation/web-api/concepts/spotify-uris-ids). For example:
+            `["4iV5W9uYEdYUVa79Axb7Rh", "1301WleyT98MSxVHPZCA6M"]`<br/>A maximum of
+            50 items can be specified in one request. _**Note**: if the `ids`
+            parameter is present in the query string, any IDs listed here in the body
+            will be ignored._
+
+    """
+
+    # Create a mapping from Model property names to API property names
+    _names = {
+        "ids": "ids",
+    }
+
+    _optionals = [
+        "ids",
+    ]
+
+    def __init__(
+        self,
+        ids=APIHelper.SKIP):
+        """Initialize a MeAlbumsRequest instance."""
+        # Initialize members of the class
+        if ids is not APIHelper.SKIP:
+            self.ids = ids
+
+    @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
+        ids =\
+            dictionary.get("ids")\
+            if dictionary.get("ids")\
+                else APIHelper.SKIP
+
+        # Return an object of this model
+        return cls(ids)
+
+    def __repr__(self):
+        """Return a unambiguous string representation."""
+        _ids=(
+            self.ids
+            if hasattr(self, "ids")
+            else None
+        )
+        return (
+            f"{self.__class__.__name__}("
+            f"ids={_ids!r}, "
+            f")"
+        )
+
+    def __str__(self):
+        """Return a human-readable string representation."""
+        _ids=(
+            self.ids
+            if hasattr(self, "ids")
+            else None
+        )
+        return (
+            f"{self.__class__.__name__}("
+            f"ids={_ids!s}, "
+            f")"
+        )

spotifywebapi/models/me_episodes_request.py

@@ -0,0 +1,73 @@
+"""spotifywebapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: E501
+class MeEpisodesRequest(object):
+    """Implementation of the 'Me Episodes Request' model.
+
+    Attributes:
+        ids (List[str]): A JSON array of the [Spotify
+            IDs](/documentation/web-api/concepts/spotify-uris-ids). <br/>A maximum of
+            50 items can be specified in one request. _**Note**: if the `ids`
+            parameter is present in the query string, any IDs listed here in the body
+            will be ignored._
+
+    """
+
+    # Create a mapping from Model property names to API property names
+    _names = {
+        "ids": "ids",
+    }
+
+    def __init__(
+        self,
+        ids=None):
+        """Initialize a MeEpisodesRequest instance."""
+        # Initialize members of the class
+        self.ids = ids
+
+    @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
+        ids =\
+            dictionary.get("ids")\
+            if dictionary.get("ids")\
+                else None
+
+        # Return an object of this model
+        return cls(ids)
+
+    def __repr__(self):
+        """Return a unambiguous string representation."""
+        _ids=self.ids
+        return (
+            f"{self.__class__.__name__}("
+            f"ids={_ids!r}, "
+            f")"
+        )
+
+    def __str__(self):
+        """Return a human-readable string representation."""
+        _ids=self.ids
+        return (
+            f"{self.__class__.__name__}("
+            f"ids={_ids!s}, "
+            f")"
+        )

spotifywebapi/models/me_episodes_request_1.py

@@ -0,0 +1,89 @@
+"""spotifywebapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: E501
+from spotifywebapi.api_helper import APIHelper
+
+
+class MeEpisodesRequest1(object):
+    """Implementation of the 'Me Episodes Request1' model.
+
+    Attributes:
+        ids (List[str]): A JSON array of the [Spotify
+            IDs](/documentation/web-api/concepts/spotify-uris-ids). <br/>A maximum of
+            50 items can be specified in one request. _**Note**: if the `ids`
+            parameter is present in the query string, any IDs listed here in the body
+            will be ignored._
+
+    """
+
+    # Create a mapping from Model property names to API property names
+    _names = {
+        "ids": "ids",
+    }
+
+    _optionals = [
+        "ids",
+    ]
+
+    def __init__(
+        self,
+        ids=APIHelper.SKIP):
+        """Initialize a MeEpisodesRequest1 instance."""
+        # Initialize members of the class
+        if ids is not APIHelper.SKIP:
+            self.ids = ids
+
+    @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
+        ids =\
+            dictionary.get("ids")\
+            if dictionary.get("ids")\
+                else APIHelper.SKIP
+
+        # Return an object of this model
+        return cls(ids)
+
+    def __repr__(self):
+        """Return a unambiguous string representation."""
+        _ids=(
+            self.ids
+            if hasattr(self, "ids")
+            else None
+        )
+        return (
+            f"{self.__class__.__name__}("
+            f"ids={_ids!r}, "
+            f")"
+        )
+
+    def __str__(self):
+        """Return a human-readable string representation."""
+        _ids=(
+            self.ids
+            if hasattr(self, "ids")
+            else None
+        )
+        return (
+            f"{self.__class__.__name__}("
+            f"ids={_ids!s}, "
+            f")"
+        )

spotifywebapi/models/me_following_request.py

@@ -0,0 +1,74 @@
+"""spotifywebapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: E501
+class MeFollowingRequest(object):
+    """Implementation of the 'Me Following Request' model.
+
+    Attributes:
+        ids (List[str]): A JSON array of the artist or user [Spotify
+            IDs](/documentation/web-api/concepts/spotify-uris-ids). For example:
+            `{ids:["74ASZWbe4lXaubB36ztrGX", "08td7MxkoHQkXnWAYD8d6Q"]}`. A maximum
+            of 50 IDs can be sent in one request. _**Note**: if the `ids` parameter
+            is present in the query string, any IDs listed here in the body will be
+            ignored._
+
+    """
+
+    # Create a mapping from Model property names to API property names
+    _names = {
+        "ids": "ids",
+    }
+
+    def __init__(
+        self,
+        ids=None):
+        """Initialize a MeFollowingRequest instance."""
+        # Initialize members of the class
+        self.ids = ids
+
+    @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
+        ids =\
+            dictionary.get("ids")\
+            if dictionary.get("ids")\
+                else None
+
+        # Return an object of this model
+        return cls(ids)
+
+    def __repr__(self):
+        """Return a unambiguous string representation."""
+        _ids=self.ids
+        return (
+            f"{self.__class__.__name__}("
+            f"ids={_ids!r}, "
+            f")"
+        )
+
+    def __str__(self):
+        """Return a human-readable string representation."""
+        _ids=self.ids
+        return (
+            f"{self.__class__.__name__}("
+            f"ids={_ids!s}, "
+            f")"
+        )

spotifywebapi/models/me_following_request_1.py

@@ -0,0 +1,90 @@
+"""spotifywebapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: E501
+from spotifywebapi.api_helper import APIHelper
+
+
+class MeFollowingRequest1(object):
+    """Implementation of the 'Me Following Request1' model.
+
+    Attributes:
+        ids (List[str]): A JSON array of the artist or user [Spotify
+            IDs](/documentation/web-api/concepts/spotify-uris-ids). For example:
+            `{ids:["74ASZWbe4lXaubB36ztrGX", "08td7MxkoHQkXnWAYD8d6Q"]}`. A maximum
+            of 50 IDs can be sent in one request. _**Note**: if the `ids` parameter
+            is present in the query string, any IDs listed here in the body will be
+            ignored._
+
+    """
+
+    # Create a mapping from Model property names to API property names
+    _names = {
+        "ids": "ids",
+    }
+
+    _optionals = [
+        "ids",
+    ]
+
+    def __init__(
+        self,
+        ids=APIHelper.SKIP):
+        """Initialize a MeFollowingRequest1 instance."""
+        # Initialize members of the class
+        if ids is not APIHelper.SKIP:
+            self.ids = ids
+
+    @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
+        ids =\
+            dictionary.get("ids")\
+            if dictionary.get("ids")\
+                else APIHelper.SKIP
+
+        # Return an object of this model
+        return cls(ids)
+
+    def __repr__(self):
+        """Return a unambiguous string representation."""
+        _ids=(
+            self.ids
+            if hasattr(self, "ids")
+            else None
+        )
+        return (
+            f"{self.__class__.__name__}("
+            f"ids={_ids!r}, "
+            f")"
+        )
+
+    def __str__(self):
+        """Return a human-readable string representation."""
+        _ids=(
+            self.ids
+            if hasattr(self, "ids")
+            else None
+        )
+        return (
+            f"{self.__class__.__name__}("
+            f"ids={_ids!s}, "
+            f")"
+        )

spotifywebapi/models/me_player_play_request.py

@@ -0,0 +1,165 @@
+"""spotifywebapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: E501
+from spotifywebapi.api_helper import APIHelper
+
+
+class MePlayerPlayRequest(object):
+    """Implementation of the 'Me Player Play Request' model.
+
+    Attributes:
+        context_uri (str): Optional. Spotify URI of the context to play. Valid
+            contexts are albums, artists & playlists.
+            `{context_uri:"spotify:album:1Je1IMUlBXcx1Fz0WE7oPT"}`
+        uris (List[str]): Optional. A JSON array of the Spotify track URIs to play.
+            For example: `{"uris": ["spotify:track:4iV5W9uYEdYUVa79Axb7Rh",
+            "spotify:track:1301WleyT98MSxVHPZCA6M"]}`
+        offset (Any): Optional. Indicates from where in the context playback should
+            start. Only available when context_uri corresponds to an album or
+            playlist object "position" is zero based and can’t be negative. Example:
+            `"offset": {"position": 5}` "uri" is a string representing the uri of the
+            item to start at. Example: `"offset": {"uri":
+            "spotify:track:1301WleyT98MSxVHPZCA6M"}`
+        position_ms (int): Indicates from what position to start playback. Must be a
+            positive number. Passing in a position that is greater than the length of
+            the track will cause the player to start playing the next song.
+
+    """
+
+    # Create a mapping from Model property names to API property names
+    _names = {
+        "context_uri": "context_uri",
+        "uris": "uris",
+        "offset": "offset",
+        "position_ms": "position_ms",
+    }
+
+    _optionals = [
+        "context_uri",
+        "uris",
+        "offset",
+        "position_ms",
+    ]
+
+    def __init__(
+        self,
+        context_uri=APIHelper.SKIP,
+        uris=APIHelper.SKIP,
+        offset=APIHelper.SKIP,
+        position_ms=APIHelper.SKIP):
+        """Initialize a MePlayerPlayRequest instance."""
+        # Initialize members of the class
+        if context_uri is not APIHelper.SKIP:
+            self.context_uri = context_uri
+        if uris is not APIHelper.SKIP:
+            self.uris = uris
+        if offset is not APIHelper.SKIP:
+            self.offset = offset
+        if position_ms is not APIHelper.SKIP:
+            self.position_ms = 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
+        context_uri =\
+            dictionary.get("context_uri")\
+            if dictionary.get("context_uri")\
+                else APIHelper.SKIP
+        uris =\
+            dictionary.get("uris")\
+            if dictionary.get("uris")\
+                else APIHelper.SKIP
+        offset =\
+            dictionary.get("offset")\
+            if dictionary.get("offset")\
+                else APIHelper.SKIP
+        position_ms =\
+            dictionary.get("position_ms")\
+            if dictionary.get("position_ms")\
+                else APIHelper.SKIP
+
+        # Return an object of this model
+        return cls(context_uri,
+                   uris,
+                   offset,
+                   position_ms)
+
+    def __repr__(self):
+        """Return a unambiguous string representation."""
+        _context_uri=(
+            self.context_uri
+            if hasattr(self, "context_uri")
+            else None
+        )
+        _uris=(
+            self.uris
+            if hasattr(self, "uris")
+            else None
+        )
+        _offset=(
+            self.offset
+            if hasattr(self, "offset")
+            else None
+        )
+        _position_ms=(
+            self.position_ms
+            if hasattr(self, "position_ms")
+            else None
+        )
+        return (
+            f"{self.__class__.__name__}("
+            f"context_uri={_context_uri!r}, "
+            f"uris={_uris!r}, "
+            f"offset={_offset!r}, "
+            f"position_ms={_position_ms!r}, "
+            f")"
+        )
+
+    def __str__(self):
+        """Return a human-readable string representation."""
+        _context_uri=(
+            self.context_uri
+            if hasattr(self, "context_uri")
+            else None
+        )
+        _uris=(
+            self.uris
+            if hasattr(self, "uris")
+            else None
+        )
+        _offset=(
+            self.offset
+            if hasattr(self, "offset")
+            else None
+        )
+        _position_ms=(
+            self.position_ms
+            if hasattr(self, "position_ms")
+            else None
+        )
+        return (
+            f"{self.__class__.__name__}("
+            f"context_uri={_context_uri!s}, "
+            f"uris={_uris!s}, "
+            f"offset={_offset!s}, "
+            f"position_ms={_position_ms!s}, "
+            f")"
+        )