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

spotifywebapi/models/playlist_object.py

@@ -0,0 +1,425 @@
+"""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,
+)
+from spotifywebapi.models.followers_object import (
+    FollowersObject,
+)
+from spotifywebapi.models.image_object import (
+    ImageObject,
+)
+from spotifywebapi.models.paging_playlist_track_object import (
+    PagingPlaylistTrackObject,
+)
+from spotifywebapi.models.playlist_owner_object import (
+    PlaylistOwnerObject,
+)
+
+
+class PlaylistObject(object):
+    """Implementation of the 'PlaylistObject' model.
+
+    Attributes:
+        collaborative (bool): `true` if the owner allows other users to modify the
+            playlist.
+        description (str): The playlist description. _Only returned for modified,
+            verified playlists, otherwise_ `null`.
+        external_urls (ExternalUrlObject): Known external URLs for this playlist.
+        followers (FollowersObject): Information about the followers of the playlist.
+        href (str): A link to the Web API endpoint providing full details of the
+            playlist.
+        id (str): The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids)
+            for the playlist.
+        images (List[ImageObject]): Images for the playlist. The array may be empty
+            or contain up to three images. The images are returned by size in
+            descending order. See [Working with
+            Playlists](/documentation/web-api/concepts/playlists). _**Note**: If
+            returned, the source URL for the image (`url`) is temporary and will
+            expire in less than a day._
+        name (str): The name of the playlist.
+        owner (PlaylistOwnerObject): The user who owns the playlist
+        public (bool): The playlist's public/private status: `true` the playlist is
+            public, `false` the playlist is private, `null` the playlist status is
+            not relevant. For more about public/private status, see [Working with
+            Playlists](/documentation/web-api/concepts/playlists)
+        snapshot_id (str): The version identifier for the current playlist. Can be
+            supplied in other requests to target a specific playlist version
+        tracks (PagingPlaylistTrackObject): The tracks of the playlist.
+        mtype (str): The object type: "playlist"
+        uri (str): The [Spotify
+            URI](/documentation/web-api/concepts/spotify-uris-ids) for the playlist.
+
+    """
+
+    # Create a mapping from Model property names to API property names
+    _names = {
+        "collaborative": "collaborative",
+        "description": "description",
+        "external_urls": "external_urls",
+        "followers": "followers",
+        "href": "href",
+        "id": "id",
+        "images": "images",
+        "name": "name",
+        "owner": "owner",
+        "public": "public",
+        "snapshot_id": "snapshot_id",
+        "tracks": "tracks",
+        "mtype": "type",
+        "uri": "uri",
+    }
+
+    _optionals = [
+        "collaborative",
+        "description",
+        "external_urls",
+        "followers",
+        "href",
+        "id",
+        "images",
+        "name",
+        "owner",
+        "public",
+        "snapshot_id",
+        "tracks",
+        "mtype",
+        "uri",
+    ]
+
+    _nullables = [
+        "description",
+    ]
+
+    def __init__(
+        self,
+        collaborative=APIHelper.SKIP,
+        description=APIHelper.SKIP,
+        external_urls=APIHelper.SKIP,
+        followers=APIHelper.SKIP,
+        href=APIHelper.SKIP,
+        id=APIHelper.SKIP,
+        images=APIHelper.SKIP,
+        name=APIHelper.SKIP,
+        owner=APIHelper.SKIP,
+        public=APIHelper.SKIP,
+        snapshot_id=APIHelper.SKIP,
+        tracks=APIHelper.SKIP,
+        mtype=APIHelper.SKIP,
+        uri=APIHelper.SKIP):
+        """Initialize a PlaylistObject instance."""
+        # Initialize members of the class
+        if collaborative is not APIHelper.SKIP:
+            self.collaborative = collaborative
+        if description is not APIHelper.SKIP:
+            self.description = description
+        if external_urls is not APIHelper.SKIP:
+            self.external_urls = external_urls
+        if followers is not APIHelper.SKIP:
+            self.followers = followers
+        if href is not APIHelper.SKIP:
+            self.href = href
+        if id is not APIHelper.SKIP:
+            self.id = id
+        if images is not APIHelper.SKIP:
+            self.images = images
+        if name is not APIHelper.SKIP:
+            self.name = name
+        if owner is not APIHelper.SKIP:
+            self.owner = owner
+        if public is not APIHelper.SKIP:
+            self.public = public
+        if snapshot_id is not APIHelper.SKIP:
+            self.snapshot_id = snapshot_id
+        if tracks is not APIHelper.SKIP:
+            self.tracks = tracks
+        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
+        collaborative =\
+            dictionary.get("collaborative")\
+            if "collaborative" in dictionary.keys()\
+                else APIHelper.SKIP
+        description =\
+            dictionary.get("description")\
+            if "description" in dictionary.keys()\
+                else APIHelper.SKIP
+        external_urls =\
+            ExternalUrlObject.from_dictionary(
+                dictionary.get("external_urls"))\
+                if "external_urls" in dictionary.keys()\
+                else APIHelper.SKIP
+        followers =\
+            FollowersObject.from_dictionary(
+                dictionary.get("followers"))\
+                if "followers" 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
+        images = None
+        if dictionary.get("images") is not None:
+            images = [
+                ImageObject.from_dictionary(x)
+                    for x in dictionary.get("images")
+            ]
+        else:
+            images = APIHelper.SKIP
+        name =\
+            dictionary.get("name")\
+            if dictionary.get("name")\
+                else APIHelper.SKIP
+        owner =\
+            PlaylistOwnerObject.from_dictionary(
+                dictionary.get("owner"))\
+                if "owner" in dictionary.keys()\
+                else APIHelper.SKIP
+        public =\
+            dictionary.get("public")\
+            if "public" in dictionary.keys()\
+                else APIHelper.SKIP
+        snapshot_id =\
+            dictionary.get("snapshot_id")\
+            if dictionary.get("snapshot_id")\
+                else APIHelper.SKIP
+        tracks =\
+            PagingPlaylistTrackObject.from_dictionary(
+                dictionary.get("tracks"))\
+                if "tracks" in dictionary.keys()\
+                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(collaborative,
+                   description,
+                   external_urls,
+                   followers,
+                   href,
+                   id,
+                   images,
+                   name,
+                   owner,
+                   public,
+                   snapshot_id,
+                   tracks,
+                   mtype,
+                   uri)
+
+    def __repr__(self):
+        """Return a unambiguous string representation."""
+        _collaborative=(
+            self.collaborative
+            if hasattr(self, "collaborative")
+            else None
+        )
+        _description=(
+            self.description
+            if hasattr(self, "description")
+            else None
+        )
+        _external_urls=(
+            self.external_urls
+            if hasattr(self, "external_urls")
+            else None
+        )
+        _followers=(
+            self.followers
+            if hasattr(self, "followers")
+            else None
+        )
+        _href=(
+            self.href
+            if hasattr(self, "href")
+            else None
+        )
+        _id=(
+            self.id
+            if hasattr(self, "id")
+            else None
+        )
+        _images=(
+            self.images
+            if hasattr(self, "images")
+            else None
+        )
+        _name=(
+            self.name
+            if hasattr(self, "name")
+            else None
+        )
+        _owner=(
+            self.owner
+            if hasattr(self, "owner")
+            else None
+        )
+        _public=(
+            self.public
+            if hasattr(self, "public")
+            else None
+        )
+        _snapshot_id=(
+            self.snapshot_id
+            if hasattr(self, "snapshot_id")
+            else None
+        )
+        _tracks=(
+            self.tracks
+            if hasattr(self, "tracks")
+            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"collaborative={_collaborative!r}, "
+            f"description={_description!r}, "
+            f"external_urls={_external_urls!r}, "
+            f"followers={_followers!r}, "
+            f"href={_href!r}, "
+            f"id={_id!r}, "
+            f"images={_images!r}, "
+            f"name={_name!r}, "
+            f"owner={_owner!r}, "
+            f"public={_public!r}, "
+            f"snapshot_id={_snapshot_id!r}, "
+            f"tracks={_tracks!r}, "
+            f"mtype={_mtype!r}, "
+            f"uri={_uri!r}, "
+            f")"
+        )
+
+    def __str__(self):
+        """Return a human-readable string representation."""
+        _collaborative=(
+            self.collaborative
+            if hasattr(self, "collaborative")
+            else None
+        )
+        _description=(
+            self.description
+            if hasattr(self, "description")
+            else None
+        )
+        _external_urls=(
+            self.external_urls
+            if hasattr(self, "external_urls")
+            else None
+        )
+        _followers=(
+            self.followers
+            if hasattr(self, "followers")
+            else None
+        )
+        _href=(
+            self.href
+            if hasattr(self, "href")
+            else None
+        )
+        _id=(
+            self.id
+            if hasattr(self, "id")
+            else None
+        )
+        _images=(
+            self.images
+            if hasattr(self, "images")
+            else None
+        )
+        _name=(
+            self.name
+            if hasattr(self, "name")
+            else None
+        )
+        _owner=(
+            self.owner
+            if hasattr(self, "owner")
+            else None
+        )
+        _public=(
+            self.public
+            if hasattr(self, "public")
+            else None
+        )
+        _snapshot_id=(
+            self.snapshot_id
+            if hasattr(self, "snapshot_id")
+            else None
+        )
+        _tracks=(
+            self.tracks
+            if hasattr(self, "tracks")
+            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"collaborative={_collaborative!s}, "
+            f"description={_description!s}, "
+            f"external_urls={_external_urls!s}, "
+            f"followers={_followers!s}, "
+            f"href={_href!s}, "
+            f"id={_id!s}, "
+            f"images={_images!s}, "
+            f"name={_name!s}, "
+            f"owner={_owner!s}, "
+            f"public={_public!s}, "
+            f"snapshot_id={_snapshot_id!s}, "
+            f"tracks={_tracks!s}, "
+            f"mtype={_mtype!s}, "
+            f"uri={_uri!s}, "
+            f")"
+        )

spotifywebapi/models/playlist_owner_object.py

@@ -0,0 +1,238 @@
+"""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,
+)
+from spotifywebapi.models.followers_object import (
+    FollowersObject,
+)
+
+
+class PlaylistOwnerObject(object):
+    """Implementation of the 'PlaylistOwnerObject' model.
+
+    Attributes:
+        external_urls (ExternalUrlObject): Known public external URLs for this user.
+        followers (FollowersObject): Information about the followers of this user.
+        href (str): A link to the Web API endpoint for this user.
+        id (str): The [Spotify user
+            ID](/documentation/web-api/concepts/spotify-uris-ids) for this user.
+        mtype (Type4Enum): The object type.
+        uri (str): The [Spotify
+            URI](/documentation/web-api/concepts/spotify-uris-ids) for this user.
+        display_name (str): The name displayed on the user's profile. `null` if not
+            available.
+
+    """
+
+    # Create a mapping from Model property names to API property names
+    _names = {
+        "external_urls": "external_urls",
+        "followers": "followers",
+        "href": "href",
+        "id": "id",
+        "mtype": "type",
+        "uri": "uri",
+        "display_name": "display_name",
+    }
+
+    _optionals = [
+        "external_urls",
+        "followers",
+        "href",
+        "id",
+        "mtype",
+        "uri",
+        "display_name",
+    ]
+
+    _nullables = [
+        "display_name",
+    ]
+
+    def __init__(
+        self,
+        external_urls=APIHelper.SKIP,
+        followers=APIHelper.SKIP,
+        href=APIHelper.SKIP,
+        id=APIHelper.SKIP,
+        mtype=APIHelper.SKIP,
+        uri=APIHelper.SKIP,
+        display_name=APIHelper.SKIP):
+        """Initialize a PlaylistOwnerObject instance."""
+        # Initialize members of the class
+        if external_urls is not APIHelper.SKIP:
+            self.external_urls = external_urls
+        if followers is not APIHelper.SKIP:
+            self.followers = followers
+        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
+        if display_name is not APIHelper.SKIP:
+            self.display_name = display_name
+
+    @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
+        followers =\
+            FollowersObject.from_dictionary(
+                dictionary.get("followers"))\
+                if "followers" 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
+        display_name =\
+            dictionary.get("display_name")\
+            if "display_name" in dictionary.keys()\
+                else APIHelper.SKIP
+
+        # Return an object of this model
+        return cls(external_urls,
+                   followers,
+                   href,
+                   id,
+                   mtype,
+                   uri,
+                   display_name)
+
+    def __repr__(self):
+        """Return a unambiguous string representation."""
+        _external_urls=(
+            self.external_urls
+            if hasattr(self, "external_urls")
+            else None
+        )
+        _followers=(
+            self.followers
+            if hasattr(self, "followers")
+            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
+        )
+        _display_name=(
+            self.display_name
+            if hasattr(self, "display_name")
+            else None
+        )
+        return (
+            f"{self.__class__.__name__}("
+            f"external_urls={_external_urls!r}, "
+            f"followers={_followers!r}, "
+            f"href={_href!r}, "
+            f"id={_id!r}, "
+            f"mtype={_mtype!r}, "
+            f"uri={_uri!r}, "
+            f"display_name={_display_name!r}, "
+            f")"
+        )
+
+    def __str__(self):
+        """Return a human-readable string representation."""
+        _external_urls=(
+            self.external_urls
+            if hasattr(self, "external_urls")
+            else None
+        )
+        _followers=(
+            self.followers
+            if hasattr(self, "followers")
+            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
+        )
+        _display_name=(
+            self.display_name
+            if hasattr(self, "display_name")
+            else None
+        )
+        return (
+            f"{self.__class__.__name__}("
+            f"external_urls={_external_urls!s}, "
+            f"followers={_followers!s}, "
+            f"href={_href!s}, "
+            f"id={_id!s}, "
+            f"mtype={_mtype!s}, "
+            f"uri={_uri!s}, "
+            f"display_name={_display_name!s}, "
+            f")"
+        )