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

spotifywebapi/models/paging_artist_object.py

@@ -0,0 +1,162 @@
+"""spotifywebapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: E501
+from spotifywebapi.models.artist_object import (
+    ArtistObject,
+)
+
+
+class PagingArtistObject(object):
+    """Implementation of the 'PagingArtistObject' model.
+
+    Attributes:
+        href (str): A link to the Web API endpoint returning the full result of the
+            request
+        limit (int): The maximum number of items in the response (as set in the query
+            or by default).
+        next (str): URL to the next page of items. ( `null` if none)
+        offset (int): The offset of the items returned (as set in the query or by
+            default)
+        previous (str): URL to the previous page of items. ( `null` if none)
+        total (int): The total number of items available to return.
+        items (List[ArtistObject]): The model property of type List[ArtistObject].
+
+    """
+
+    # Create a mapping from Model property names to API property names
+    _names = {
+        "href": "href",
+        "limit": "limit",
+        "next": "next",
+        "offset": "offset",
+        "previous": "previous",
+        "total": "total",
+        "items": "items",
+    }
+
+    _nullables = [
+        "next",
+        "previous",
+    ]
+
+    def __init__(
+        self,
+        href=None,
+        limit=None,
+        next=None,
+        offset=None,
+        previous=None,
+        total=None,
+        items=None):
+        """Initialize a PagingArtistObject instance."""
+        # Initialize members of the class
+        self.href = href
+        self.limit = limit
+        self.next = next
+        self.offset = offset
+        self.previous = previous
+        self.total = total
+        self.items = items
+
+    @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
+        href =\
+            dictionary.get("href")\
+            if dictionary.get("href")\
+                else None
+        limit =\
+            dictionary.get("limit")\
+            if dictionary.get("limit")\
+                else None
+        next =\
+            dictionary.get("next")\
+            if dictionary.get("next")\
+                else None
+        offset =\
+            dictionary.get("offset")\
+            if dictionary.get("offset")\
+                else None
+        previous =\
+            dictionary.get("previous")\
+            if dictionary.get("previous")\
+                else None
+        total =\
+            dictionary.get("total")\
+            if dictionary.get("total")\
+                else None
+        items = None
+        if dictionary.get("items") is not None:
+            items = [
+                ArtistObject.from_dictionary(x)
+                    for x in dictionary.get("items")
+            ]
+
+        # Return an object of this model
+        return cls(href,
+                   limit,
+                   next,
+                   offset,
+                   previous,
+                   total,
+                   items)
+
+    def __repr__(self):
+        """Return a unambiguous string representation."""
+        _href=self.href
+        _limit=self.limit
+        _next=self.next
+        _offset=self.offset
+        _previous=self.previous
+        _total=self.total
+        _items=self.items
+        return (
+            f"{self.__class__.__name__}("
+            f"href={_href!r}, "
+            f"limit={_limit!r}, "
+            f"next={_next!r}, "
+            f"offset={_offset!r}, "
+            f"previous={_previous!r}, "
+            f"total={_total!r}, "
+            f"items={_items!r}, "
+            f")"
+        )
+
+    def __str__(self):
+        """Return a human-readable string representation."""
+        _href=self.href
+        _limit=self.limit
+        _next=self.next
+        _offset=self.offset
+        _previous=self.previous
+        _total=self.total
+        _items=self.items
+        return (
+            f"{self.__class__.__name__}("
+            f"href={_href!s}, "
+            f"limit={_limit!s}, "
+            f"next={_next!s}, "
+            f"offset={_offset!s}, "
+            f"previous={_previous!s}, "
+            f"total={_total!s}, "
+            f"items={_items!s}, "
+            f")"
+        )

spotifywebapi/models/paging_featured_playlist_object.py

@@ -0,0 +1,113 @@
+"""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.paging_playlist_object import (
+    PagingPlaylistObject,
+)
+
+
+class PagingFeaturedPlaylistObject(object):
+    """Implementation of the 'PagingFeaturedPlaylistObject' model.
+
+    Attributes:
+        message (str): The localized message of a playlist.
+        playlists (PagingPlaylistObject): The model property of type
+            PagingPlaylistObject.
+
+    """
+
+    # Create a mapping from Model property names to API property names
+    _names = {
+        "message": "message",
+        "playlists": "playlists",
+    }
+
+    _optionals = [
+        "message",
+        "playlists",
+    ]
+
+    def __init__(
+        self,
+        message=APIHelper.SKIP,
+        playlists=APIHelper.SKIP):
+        """Initialize a PagingFeaturedPlaylistObject instance."""
+        # Initialize members of the class
+        if message is not APIHelper.SKIP:
+            self.message = message
+        if playlists is not APIHelper.SKIP:
+            self.playlists = playlists
+
+    @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
+        message =\
+            dictionary.get("message")\
+            if dictionary.get("message")\
+                else APIHelper.SKIP
+        playlists =\
+            PagingPlaylistObject.from_dictionary(
+                dictionary.get("playlists"))\
+                if "playlists" in dictionary.keys()\
+                else APIHelper.SKIP
+
+        # Return an object of this model
+        return cls(message,
+                   playlists)
+
+    def __repr__(self):
+        """Return a unambiguous string representation."""
+        _message=(
+            self.message
+            if hasattr(self, "message")
+            else None
+        )
+        _playlists=(
+            self.playlists
+            if hasattr(self, "playlists")
+            else None
+        )
+        return (
+            f"{self.__class__.__name__}("
+            f"message={_message!r}, "
+            f"playlists={_playlists!r}, "
+            f")"
+        )
+
+    def __str__(self):
+        """Return a human-readable string representation."""
+        _message=(
+            self.message
+            if hasattr(self, "message")
+            else None
+        )
+        _playlists=(
+            self.playlists
+            if hasattr(self, "playlists")
+            else None
+        )
+        return (
+            f"{self.__class__.__name__}("
+            f"message={_message!s}, "
+            f"playlists={_playlists!s}, "
+            f")"
+        )

spotifywebapi/models/paging_object.py

@@ -0,0 +1,142 @@
+"""spotifywebapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: E501
+class PagingObject(object):
+    """Implementation of the 'PagingObject' model.
+
+    Attributes:
+        href (str): A link to the Web API endpoint returning the full result of the
+            request
+        limit (int): The maximum number of items in the response (as set in the query
+            or by default).
+        next (str): URL to the next page of items. ( `null` if none)
+        offset (int): The offset of the items returned (as set in the query or by
+            default)
+        previous (str): URL to the previous page of items. ( `null` if none)
+        total (int): The total number of items available to return.
+
+    """
+
+    # Create a mapping from Model property names to API property names
+    _names = {
+        "href": "href",
+        "limit": "limit",
+        "next": "next",
+        "offset": "offset",
+        "previous": "previous",
+        "total": "total",
+    }
+
+    _nullables = [
+        "next",
+        "previous",
+    ]
+
+    def __init__(
+        self,
+        href=None,
+        limit=None,
+        next=None,
+        offset=None,
+        previous=None,
+        total=None):
+        """Initialize a PagingObject instance."""
+        # Initialize members of the class
+        self.href = href
+        self.limit = limit
+        self.next = next
+        self.offset = offset
+        self.previous = previous
+        self.total = total
+
+    @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
+        href =\
+            dictionary.get("href")\
+            if dictionary.get("href")\
+                else None
+        limit =\
+            dictionary.get("limit")\
+            if dictionary.get("limit")\
+                else None
+        next =\
+            dictionary.get("next")\
+            if dictionary.get("next")\
+                else None
+        offset =\
+            dictionary.get("offset")\
+            if dictionary.get("offset")\
+                else None
+        previous =\
+            dictionary.get("previous")\
+            if dictionary.get("previous")\
+                else None
+        total =\
+            dictionary.get("total")\
+            if dictionary.get("total")\
+                else None
+
+        # Return an object of this model
+        return cls(href,
+                   limit,
+                   next,
+                   offset,
+                   previous,
+                   total)
+
+    def __repr__(self):
+        """Return a unambiguous string representation."""
+        _href=self.href
+        _limit=self.limit
+        _next=self.next
+        _offset=self.offset
+        _previous=self.previous
+        _total=self.total
+        return (
+            f"{self.__class__.__name__}("
+            f"href={_href!r}, "
+            f"limit={_limit!r}, "
+            f"next={_next!r}, "
+            f"offset={_offset!r}, "
+            f"previous={_previous!r}, "
+            f"total={_total!r}, "
+            f")"
+        )
+
+    def __str__(self):
+        """Return a human-readable string representation."""
+        _href=self.href
+        _limit=self.limit
+        _next=self.next
+        _offset=self.offset
+        _previous=self.previous
+        _total=self.total
+        return (
+            f"{self.__class__.__name__}("
+            f"href={_href!s}, "
+            f"limit={_limit!s}, "
+            f"next={_next!s}, "
+            f"offset={_offset!s}, "
+            f"previous={_previous!s}, "
+            f"total={_total!s}, "
+            f")"
+        )

spotifywebapi/models/paging_playlist_object.py

@@ -0,0 +1,163 @@
+"""spotifywebapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: E501
+from spotifywebapi.models.simplified_playlist_object import (
+    SimplifiedPlaylistObject,
+)
+
+
+class PagingPlaylistObject(object):
+    """Implementation of the 'PagingPlaylistObject' model.
+
+    Attributes:
+        href (str): A link to the Web API endpoint returning the full result of the
+            request
+        limit (int): The maximum number of items in the response (as set in the query
+            or by default).
+        next (str): URL to the next page of items. ( `null` if none)
+        offset (int): The offset of the items returned (as set in the query or by
+            default)
+        previous (str): URL to the previous page of items. ( `null` if none)
+        total (int): The total number of items available to return.
+        items (List[SimplifiedPlaylistObject]): The model property of type
+            List[SimplifiedPlaylistObject].
+
+    """
+
+    # Create a mapping from Model property names to API property names
+    _names = {
+        "href": "href",
+        "limit": "limit",
+        "next": "next",
+        "offset": "offset",
+        "previous": "previous",
+        "total": "total",
+        "items": "items",
+    }
+
+    _nullables = [
+        "next",
+        "previous",
+    ]
+
+    def __init__(
+        self,
+        href=None,
+        limit=None,
+        next=None,
+        offset=None,
+        previous=None,
+        total=None,
+        items=None):
+        """Initialize a PagingPlaylistObject instance."""
+        # Initialize members of the class
+        self.href = href
+        self.limit = limit
+        self.next = next
+        self.offset = offset
+        self.previous = previous
+        self.total = total
+        self.items = items
+
+    @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
+        href =\
+            dictionary.get("href")\
+            if dictionary.get("href")\
+                else None
+        limit =\
+            dictionary.get("limit")\
+            if dictionary.get("limit")\
+                else None
+        next =\
+            dictionary.get("next")\
+            if dictionary.get("next")\
+                else None
+        offset =\
+            dictionary.get("offset")\
+            if dictionary.get("offset")\
+                else None
+        previous =\
+            dictionary.get("previous")\
+            if dictionary.get("previous")\
+                else None
+        total =\
+            dictionary.get("total")\
+            if dictionary.get("total")\
+                else None
+        items = None
+        if dictionary.get("items") is not None:
+            items = [
+                SimplifiedPlaylistObject.from_dictionary(x)
+                    for x in dictionary.get("items")
+            ]
+
+        # Return an object of this model
+        return cls(href,
+                   limit,
+                   next,
+                   offset,
+                   previous,
+                   total,
+                   items)
+
+    def __repr__(self):
+        """Return a unambiguous string representation."""
+        _href=self.href
+        _limit=self.limit
+        _next=self.next
+        _offset=self.offset
+        _previous=self.previous
+        _total=self.total
+        _items=self.items
+        return (
+            f"{self.__class__.__name__}("
+            f"href={_href!r}, "
+            f"limit={_limit!r}, "
+            f"next={_next!r}, "
+            f"offset={_offset!r}, "
+            f"previous={_previous!r}, "
+            f"total={_total!r}, "
+            f"items={_items!r}, "
+            f")"
+        )
+
+    def __str__(self):
+        """Return a human-readable string representation."""
+        _href=self.href
+        _limit=self.limit
+        _next=self.next
+        _offset=self.offset
+        _previous=self.previous
+        _total=self.total
+        _items=self.items
+        return (
+            f"{self.__class__.__name__}("
+            f"href={_href!s}, "
+            f"limit={_limit!s}, "
+            f"next={_next!s}, "
+            f"offset={_offset!s}, "
+            f"previous={_previous!s}, "
+            f"total={_total!s}, "
+            f"items={_items!s}, "
+            f")"
+        )