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

spotifywebapi/models/playlists_request.py

@@ -0,0 +1,160 @@
+"""spotifywebapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: E501
+from spotifywebapi.api_helper import APIHelper
+
+
+class PlaylistsRequest(object):
+    """Implementation of the 'Playlists Request' model.
+
+    Attributes:
+        name (str): The new name for the playlist, for example `"My New Playlist
+            Title"`
+        public (bool): If `true` the playlist will be public, if `false` it will be
+            private.
+        collaborative (bool): If `true`, the playlist will become collaborative and
+            other users will be able to modify the playlist in their Spotify client.
+            <br/> _**Note**: You can only set `collaborative` to `true` on non-public
+            playlists._
+        description (str): Value for playlist description as displayed in Spotify
+            Clients and in the Web API.
+
+    """
+
+    # Create a mapping from Model property names to API property names
+    _names = {
+        "name": "name",
+        "public": "public",
+        "collaborative": "collaborative",
+        "description": "description",
+    }
+
+    _optionals = [
+        "name",
+        "public",
+        "collaborative",
+        "description",
+    ]
+
+    def __init__(
+        self,
+        name=APIHelper.SKIP,
+        public=APIHelper.SKIP,
+        collaborative=APIHelper.SKIP,
+        description=APIHelper.SKIP):
+        """Initialize a PlaylistsRequest instance."""
+        # Initialize members of the class
+        if name is not APIHelper.SKIP:
+            self.name = name
+        if public is not APIHelper.SKIP:
+            self.public = public
+        if collaborative is not APIHelper.SKIP:
+            self.collaborative = collaborative
+        if description is not APIHelper.SKIP:
+            self.description = description
+
+    @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
+        public =\
+            dictionary.get("public")\
+            if "public" in dictionary.keys()\
+                else APIHelper.SKIP
+        collaborative =\
+            dictionary.get("collaborative")\
+            if "collaborative" in dictionary.keys()\
+                else APIHelper.SKIP
+        description =\
+            dictionary.get("description")\
+            if dictionary.get("description")\
+                else APIHelper.SKIP
+
+        # Return an object of this model
+        return cls(name,
+                   public,
+                   collaborative,
+                   description)
+
+    def __repr__(self):
+        """Return a unambiguous string representation."""
+        _name=(
+            self.name
+            if hasattr(self, "name")
+            else None
+        )
+        _public=(
+            self.public
+            if hasattr(self, "public")
+            else None
+        )
+        _collaborative=(
+            self.collaborative
+            if hasattr(self, "collaborative")
+            else None
+        )
+        _description=(
+            self.description
+            if hasattr(self, "description")
+            else None
+        )
+        return (
+            f"{self.__class__.__name__}("
+            f"name={_name!r}, "
+            f"public={_public!r}, "
+            f"collaborative={_collaborative!r}, "
+            f"description={_description!r}, "
+            f")"
+        )
+
+    def __str__(self):
+        """Return a human-readable string representation."""
+        _name=(
+            self.name
+            if hasattr(self, "name")
+            else None
+        )
+        _public=(
+            self.public
+            if hasattr(self, "public")
+            else None
+        )
+        _collaborative=(
+            self.collaborative
+            if hasattr(self, "collaborative")
+            else None
+        )
+        _description=(
+            self.description
+            if hasattr(self, "description")
+            else None
+        )
+        return (
+            f"{self.__class__.__name__}("
+            f"name={_name!s}, "
+            f"public={_public!s}, "
+            f"collaborative={_collaborative!s}, "
+            f"description={_description!s}, "
+            f")"
+        )

spotifywebapi/models/playlists_tracks_request.py

@@ -0,0 +1,121 @@
+"""spotifywebapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: E501
+from spotifywebapi.api_helper import APIHelper
+
+
+class PlaylistsTracksRequest(object):
+    """Implementation of the 'Playlists Tracks Request' model.
+
+    Attributes:
+        uris (List[str]): A JSON array of the [Spotify
+            URIs](/documentation/web-api/concepts/spotify-uris-ids) to add. For
+            example: `{"uris":
+            ["spotify:track:4iV5W9uYEdYUVa79Axb7Rh","spotify:track:1301WleyT98MSxVHPZC
+            A6M", "spotify:episode:512ojhOuo1ktJprKbVcKyQ"]}`<br/>A maximum of 100
+            items can be added in one request. _**Note**: if the `uris` parameter is
+            present in the query string, any URIs listed here in the body will be
+            ignored._
+        position (int): The position to insert the items, a zero-based index. For
+            example, to insert the items in the first position: `position=0` ; to
+            insert the items in the third position: `position=2`. If omitted, the
+            items will be appended to the playlist. Items are added in the order they
+            appear in the uris array. For example: `{"uris":
+            ["spotify:track:4iV5W9uYEdYUVa79Axb7Rh","spotify:track:1301WleyT98MSxVHPZC
+            A6M"], "position": 3}`
+
+    """
+
+    # Create a mapping from Model property names to API property names
+    _names = {
+        "uris": "uris",
+        "position": "position",
+    }
+
+    _optionals = [
+        "uris",
+        "position",
+    ]
+
+    def __init__(
+        self,
+        uris=APIHelper.SKIP,
+        position=APIHelper.SKIP):
+        """Initialize a PlaylistsTracksRequest instance."""
+        # Initialize members of the class
+        if uris is not APIHelper.SKIP:
+            self.uris = uris
+        if position is not APIHelper.SKIP:
+            self.position = position
+
+    @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
+        uris =\
+            dictionary.get("uris")\
+            if dictionary.get("uris")\
+                else APIHelper.SKIP
+        position =\
+            dictionary.get("position")\
+            if dictionary.get("position")\
+                else APIHelper.SKIP
+
+        # Return an object of this model
+        return cls(uris,
+                   position)
+
+    def __repr__(self):
+        """Return a unambiguous string representation."""
+        _uris=(
+            self.uris
+            if hasattr(self, "uris")
+            else None
+        )
+        _position=(
+            self.position
+            if hasattr(self, "position")
+            else None
+        )
+        return (
+            f"{self.__class__.__name__}("
+            f"uris={_uris!r}, "
+            f"position={_position!r}, "
+            f")"
+        )
+
+    def __str__(self):
+        """Return a human-readable string representation."""
+        _uris=(
+            self.uris
+            if hasattr(self, "uris")
+            else None
+        )
+        _position=(
+            self.position
+            if hasattr(self, "position")
+            else None
+        )
+        return (
+            f"{self.__class__.__name__}("
+            f"uris={_uris!s}, "
+            f"position={_position!s}, "
+            f")"
+        )

spotifywebapi/models/playlists_tracks_request_1.py

@@ -0,0 +1,188 @@
+"""spotifywebapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: E501
+from spotifywebapi.api_helper import APIHelper
+
+
+class PlaylistsTracksRequest1(object):
+    """Implementation of the 'Playlists Tracks Request1' model.
+
+    Attributes:
+        uris (List[str]): The model property of type List[str].
+        range_start (int): The position of the first item to be reordered.
+        insert_before (int): The position where the items should be inserted.<br/>To
+            reorder the items to the end of the playlist, simply set _insert_before_
+            to the position after the last item.<br/>Examples:<br/>To reorder the
+            first item to the last position in a playlist with 10 items, set
+            _range_start_ to 0, and _insert_before_ to 10.<br/>To reorder the last
+            item in a playlist with 10 items to the start of the playlist, set
+            _range_start_ to 9, and _insert_before_ to 0.
+        range_length (int): The amount of items to be reordered. Defaults to 1 if not
+            set.<br/>The range of items to be reordered begins from the _range_start_
+            position, and includes the _range_length_ subsequent
+            items.<br/>Example:<br/>To move the items at index 9-10 to the start of
+            the playlist, _range_start_ is set to 9, and _range_length_ is set to 2.
+        snapshot_id (str): The playlist's snapshot ID against which you want to make
+            the changes.
+
+    """
+
+    # Create a mapping from Model property names to API property names
+    _names = {
+        "uris": "uris",
+        "range_start": "range_start",
+        "insert_before": "insert_before",
+        "range_length": "range_length",
+        "snapshot_id": "snapshot_id",
+    }
+
+    _optionals = [
+        "uris",
+        "range_start",
+        "insert_before",
+        "range_length",
+        "snapshot_id",
+    ]
+
+    def __init__(
+        self,
+        uris=APIHelper.SKIP,
+        range_start=APIHelper.SKIP,
+        insert_before=APIHelper.SKIP,
+        range_length=APIHelper.SKIP,
+        snapshot_id=APIHelper.SKIP):
+        """Initialize a PlaylistsTracksRequest1 instance."""
+        # Initialize members of the class
+        if uris is not APIHelper.SKIP:
+            self.uris = uris
+        if range_start is not APIHelper.SKIP:
+            self.range_start = range_start
+        if insert_before is not APIHelper.SKIP:
+            self.insert_before = insert_before
+        if range_length is not APIHelper.SKIP:
+            self.range_length = range_length
+        if snapshot_id is not APIHelper.SKIP:
+            self.snapshot_id = snapshot_id
+
+    @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
+        uris =\
+            dictionary.get("uris")\
+            if dictionary.get("uris")\
+                else APIHelper.SKIP
+        range_start =\
+            dictionary.get("range_start")\
+            if dictionary.get("range_start")\
+                else APIHelper.SKIP
+        insert_before =\
+            dictionary.get("insert_before")\
+            if dictionary.get("insert_before")\
+                else APIHelper.SKIP
+        range_length =\
+            dictionary.get("range_length")\
+            if dictionary.get("range_length")\
+                else APIHelper.SKIP
+        snapshot_id =\
+            dictionary.get("snapshot_id")\
+            if dictionary.get("snapshot_id")\
+                else APIHelper.SKIP
+
+        # Return an object of this model
+        return cls(uris,
+                   range_start,
+                   insert_before,
+                   range_length,
+                   snapshot_id)
+
+    def __repr__(self):
+        """Return a unambiguous string representation."""
+        _uris=(
+            self.uris
+            if hasattr(self, "uris")
+            else None
+        )
+        _range_start=(
+            self.range_start
+            if hasattr(self, "range_start")
+            else None
+        )
+        _insert_before=(
+            self.insert_before
+            if hasattr(self, "insert_before")
+            else None
+        )
+        _range_length=(
+            self.range_length
+            if hasattr(self, "range_length")
+            else None
+        )
+        _snapshot_id=(
+            self.snapshot_id
+            if hasattr(self, "snapshot_id")
+            else None
+        )
+        return (
+            f"{self.__class__.__name__}("
+            f"uris={_uris!r}, "
+            f"range_start={_range_start!r}, "
+            f"insert_before={_insert_before!r}, "
+            f"range_length={_range_length!r}, "
+            f"snapshot_id={_snapshot_id!r}, "
+            f")"
+        )
+
+    def __str__(self):
+        """Return a human-readable string representation."""
+        _uris=(
+            self.uris
+            if hasattr(self, "uris")
+            else None
+        )
+        _range_start=(
+            self.range_start
+            if hasattr(self, "range_start")
+            else None
+        )
+        _insert_before=(
+            self.insert_before
+            if hasattr(self, "insert_before")
+            else None
+        )
+        _range_length=(
+            self.range_length
+            if hasattr(self, "range_length")
+            else None
+        )
+        _snapshot_id=(
+            self.snapshot_id
+            if hasattr(self, "snapshot_id")
+            else None
+        )
+        return (
+            f"{self.__class__.__name__}("
+            f"uris={_uris!s}, "
+            f"range_start={_range_start!s}, "
+            f"insert_before={_insert_before!s}, "
+            f"range_length={_range_length!s}, "
+            f"snapshot_id={_snapshot_id!s}, "
+            f")"
+        )

spotifywebapi/models/playlists_tracks_request_2.py

@@ -0,0 +1,109 @@
+"""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.track_1 import Track1
+
+
+class PlaylistsTracksRequest2(object):
+    """Implementation of the 'Playlists Tracks Request2' model.
+
+    Attributes:
+        tracks (List[Track1]): An array of objects containing [Spotify
+            URIs](/documentation/web-api/concepts/spotify-uris-ids) of the tracks or
+            episodes to remove. For example: `{ "tracks": [{ "uri":
+            "spotify:track:4iV5W9uYEdYUVa79Axb7Rh" },{ "uri":
+            "spotify:track:1301WleyT98MSxVHPZCA6M" }] }`. A maximum of 100 objects
+            can be sent at once.
+        snapshot_id (str): The playlist's snapshot ID against which you want to make
+            the changes. The API will validate that the specified items exist and in
+            the specified positions and make the changes, even if more recent changes
+            have been made to the playlist.
+
+    """
+
+    # Create a mapping from Model property names to API property names
+    _names = {
+        "tracks": "tracks",
+        "snapshot_id": "snapshot_id",
+    }
+
+    _optionals = [
+        "snapshot_id",
+    ]
+
+    def __init__(
+        self,
+        tracks=None,
+        snapshot_id=APIHelper.SKIP):
+        """Initialize a PlaylistsTracksRequest2 instance."""
+        # Initialize members of the class
+        self.tracks = tracks
+        if snapshot_id is not APIHelper.SKIP:
+            self.snapshot_id = snapshot_id
+
+    @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
+        tracks = None
+        if dictionary.get("tracks") is not None:
+            tracks = [
+                Track1.from_dictionary(x)
+                    for x in dictionary.get("tracks")
+            ]
+        snapshot_id =\
+            dictionary.get("snapshot_id")\
+            if dictionary.get("snapshot_id")\
+                else APIHelper.SKIP
+
+        # Return an object of this model
+        return cls(tracks,
+                   snapshot_id)
+
+    def __repr__(self):
+        """Return a unambiguous string representation."""
+        _tracks=self.tracks
+        _snapshot_id=(
+            self.snapshot_id
+            if hasattr(self, "snapshot_id")
+            else None
+        )
+        return (
+            f"{self.__class__.__name__}("
+            f"tracks={_tracks!r}, "
+            f"snapshot_id={_snapshot_id!r}, "
+            f")"
+        )
+
+    def __str__(self):
+        """Return a human-readable string representation."""
+        _tracks=self.tracks
+        _snapshot_id=(
+            self.snapshot_id
+            if hasattr(self, "snapshot_id")
+            else None
+        )
+        return (
+            f"{self.__class__.__name__}("
+            f"tracks={_tracks!s}, "
+            f"snapshot_id={_snapshot_id!s}, "
+            f")"
+        )