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

spotifywebapi/models/cursor_object.py

@@ -0,0 +1,108 @@
+"""spotifywebapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: E501
+from spotifywebapi.api_helper import APIHelper
+
+
+class CursorObject(object):
+    """Implementation of the 'CursorObject' model.
+
+    Attributes:
+        after (str): The cursor to use as key to find the next page of items.
+        before (str): The cursor to use as key to find the previous page of items.
+
+    """
+
+    # Create a mapping from Model property names to API property names
+    _names = {
+        "after": "after",
+        "before": "before",
+    }
+
+    _optionals = [
+        "after",
+        "before",
+    ]
+
+    def __init__(
+        self,
+        after=APIHelper.SKIP,
+        before=APIHelper.SKIP):
+        """Initialize a CursorObject instance."""
+        # Initialize members of the class
+        if after is not APIHelper.SKIP:
+            self.after = after
+        if before is not APIHelper.SKIP:
+            self.before = before
+
+    @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 =\
+            dictionary.get("after")\
+            if dictionary.get("after")\
+                else APIHelper.SKIP
+        before =\
+            dictionary.get("before")\
+            if dictionary.get("before")\
+                else APIHelper.SKIP
+
+        # Return an object of this model
+        return cls(after,
+                   before)
+
+    def __repr__(self):
+        """Return a unambiguous string representation."""
+        _after=(
+            self.after
+            if hasattr(self, "after")
+            else None
+        )
+        _before=(
+            self.before
+            if hasattr(self, "before")
+            else None
+        )
+        return (
+            f"{self.__class__.__name__}("
+            f"after={_after!r}, "
+            f"before={_before!r}, "
+            f")"
+        )
+
+    def __str__(self):
+        """Return a human-readable string representation."""
+        _after=(
+            self.after
+            if hasattr(self, "after")
+            else None
+        )
+        _before=(
+            self.before
+            if hasattr(self, "before")
+            else None
+        )
+        return (
+            f"{self.__class__.__name__}("
+            f"after={_after!s}, "
+            f"before={_before!s}, "
+            f")"
+        )

spotifywebapi/models/cursor_paged_artists.py

@@ -0,0 +1,75 @@
+"""spotifywebapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: E501
+from spotifywebapi.models.cursor_paging_simplified_artist_object import (
+    CursorPagingSimplifiedArtistObject,
+)
+
+
+class CursorPagedArtists(object):
+    """Implementation of the 'CursorPagedArtists' model.
+
+    Attributes:
+        artists (CursorPagingSimplifiedArtistObject): The model property of type
+            CursorPagingSimplifiedArtistObject.
+
+    """
+
+    # Create a mapping from Model property names to API property names
+    _names = {
+        "artists": "artists",
+    }
+
+    def __init__(
+        self,
+        artists=None):
+        """Initialize a CursorPagedArtists instance."""
+        # Initialize members of the class
+        self.artists = artists
+
+    @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
+        artists =\
+            CursorPagingSimplifiedArtistObject.from_dictionary(
+                dictionary.get("artists"))\
+                if dictionary.get("artists") else None
+
+        # Return an object of this model
+        return cls(artists)
+
+    def __repr__(self):
+        """Return a unambiguous string representation."""
+        _artists=self.artists
+        return (
+            f"{self.__class__.__name__}("
+            f"artists={_artists!r}, "
+            f")"
+        )
+
+    def __str__(self):
+        """Return a human-readable string representation."""
+        _artists=self.artists
+        return (
+            f"{self.__class__.__name__}("
+            f"artists={_artists!s}, "
+            f")"
+        )

spotifywebapi/models/cursor_paging_object.py

@@ -0,0 +1,183 @@
+"""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.cursor_object import (
+    CursorObject,
+)
+
+
+class CursorPagingObject(object):
+    """Implementation of the 'CursorPagingObject' 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)
+        cursors (CursorObject): The cursors used to find the next set of items.
+        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",
+        "cursors": "cursors",
+        "total": "total",
+    }
+
+    _optionals = [
+        "href",
+        "limit",
+        "next",
+        "cursors",
+        "total",
+    ]
+
+    def __init__(
+        self,
+        href=APIHelper.SKIP,
+        limit=APIHelper.SKIP,
+        next=APIHelper.SKIP,
+        cursors=APIHelper.SKIP,
+        total=APIHelper.SKIP):
+        """Initialize a CursorPagingObject instance."""
+        # Initialize members of the class
+        if href is not APIHelper.SKIP:
+            self.href = href
+        if limit is not APIHelper.SKIP:
+            self.limit = limit
+        if next is not APIHelper.SKIP:
+            self.next = next
+        if cursors is not APIHelper.SKIP:
+            self.cursors = cursors
+        if total is not APIHelper.SKIP:
+            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 APIHelper.SKIP
+        limit =\
+            dictionary.get("limit")\
+            if dictionary.get("limit")\
+                else APIHelper.SKIP
+        next =\
+            dictionary.get("next")\
+            if dictionary.get("next")\
+                else APIHelper.SKIP
+        cursors =\
+            CursorObject.from_dictionary(
+                dictionary.get("cursors"))\
+                if "cursors" in dictionary.keys()\
+                else APIHelper.SKIP
+        total =\
+            dictionary.get("total")\
+            if dictionary.get("total")\
+                else APIHelper.SKIP
+
+        # Return an object of this model
+        return cls(href,
+                   limit,
+                   next,
+                   cursors,
+                   total)
+
+    def __repr__(self):
+        """Return a unambiguous string representation."""
+        _href=(
+            self.href
+            if hasattr(self, "href")
+            else None
+        )
+        _limit=(
+            self.limit
+            if hasattr(self, "limit")
+            else None
+        )
+        _next=(
+            self.next
+            if hasattr(self, "next")
+            else None
+        )
+        _cursors=(
+            self.cursors
+            if hasattr(self, "cursors")
+            else None
+        )
+        _total=(
+            self.total
+            if hasattr(self, "total")
+            else None
+        )
+        return (
+            f"{self.__class__.__name__}("
+            f"href={_href!r}, "
+            f"limit={_limit!r}, "
+            f"next={_next!r}, "
+            f"cursors={_cursors!r}, "
+            f"total={_total!r}, "
+            f")"
+        )
+
+    def __str__(self):
+        """Return a human-readable string representation."""
+        _href=(
+            self.href
+            if hasattr(self, "href")
+            else None
+        )
+        _limit=(
+            self.limit
+            if hasattr(self, "limit")
+            else None
+        )
+        _next=(
+            self.next
+            if hasattr(self, "next")
+            else None
+        )
+        _cursors=(
+            self.cursors
+            if hasattr(self, "cursors")
+            else None
+        )
+        _total=(
+            self.total
+            if hasattr(self, "total")
+            else None
+        )
+        return (
+            f"{self.__class__.__name__}("
+            f"href={_href!s}, "
+            f"limit={_limit!s}, "
+            f"next={_next!s}, "
+            f"cursors={_cursors!s}, "
+            f"total={_total!s}, "
+            f")"
+        )

spotifywebapi/models/cursor_paging_play_history_object.py

@@ -0,0 +1,214 @@
+"""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.cursor_object import (
+    CursorObject,
+)
+from spotifywebapi.models.play_history_object import (
+    PlayHistoryObject,
+)
+
+
+class CursorPagingPlayHistoryObject(object):
+    """Implementation of the 'CursorPagingPlayHistoryObject' 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)
+        cursors (CursorObject): The cursors used to find the next set of items.
+        total (int): The total number of items available to return.
+        items (List[PlayHistoryObject]): The model property of type
+            List[PlayHistoryObject].
+
+    """
+
+    # Create a mapping from Model property names to API property names
+    _names = {
+        "href": "href",
+        "limit": "limit",
+        "next": "next",
+        "cursors": "cursors",
+        "total": "total",
+        "items": "items",
+    }
+
+    _optionals = [
+        "href",
+        "limit",
+        "next",
+        "cursors",
+        "total",
+        "items",
+    ]
+
+    def __init__(
+        self,
+        href=APIHelper.SKIP,
+        limit=APIHelper.SKIP,
+        next=APIHelper.SKIP,
+        cursors=APIHelper.SKIP,
+        total=APIHelper.SKIP,
+        items=APIHelper.SKIP):
+        """Initialize a CursorPagingPlayHistoryObject instance."""
+        # Initialize members of the class
+        if href is not APIHelper.SKIP:
+            self.href = href
+        if limit is not APIHelper.SKIP:
+            self.limit = limit
+        if next is not APIHelper.SKIP:
+            self.next = next
+        if cursors is not APIHelper.SKIP:
+            self.cursors = cursors
+        if total is not APIHelper.SKIP:
+            self.total = total
+        if items is not APIHelper.SKIP:
+            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 APIHelper.SKIP
+        limit =\
+            dictionary.get("limit")\
+            if dictionary.get("limit")\
+                else APIHelper.SKIP
+        next =\
+            dictionary.get("next")\
+            if dictionary.get("next")\
+                else APIHelper.SKIP
+        cursors =\
+            CursorObject.from_dictionary(
+                dictionary.get("cursors"))\
+                if "cursors" in dictionary.keys()\
+                else APIHelper.SKIP
+        total =\
+            dictionary.get("total")\
+            if dictionary.get("total")\
+                else APIHelper.SKIP
+        items = None
+        if dictionary.get("items") is not None:
+            items = [
+                PlayHistoryObject.from_dictionary(x)
+                    for x in dictionary.get("items")
+            ]
+        else:
+            items = APIHelper.SKIP
+
+        # Return an object of this model
+        return cls(href,
+                   limit,
+                   next,
+                   cursors,
+                   total,
+                   items)
+
+    def __repr__(self):
+        """Return a unambiguous string representation."""
+        _href=(
+            self.href
+            if hasattr(self, "href")
+            else None
+        )
+        _limit=(
+            self.limit
+            if hasattr(self, "limit")
+            else None
+        )
+        _next=(
+            self.next
+            if hasattr(self, "next")
+            else None
+        )
+        _cursors=(
+            self.cursors
+            if hasattr(self, "cursors")
+            else None
+        )
+        _total=(
+            self.total
+            if hasattr(self, "total")
+            else None
+        )
+        _items=(
+            self.items
+            if hasattr(self, "items")
+            else None
+        )
+        return (
+            f"{self.__class__.__name__}("
+            f"href={_href!r}, "
+            f"limit={_limit!r}, "
+            f"next={_next!r}, "
+            f"cursors={_cursors!r}, "
+            f"total={_total!r}, "
+            f"items={_items!r}, "
+            f")"
+        )
+
+    def __str__(self):
+        """Return a human-readable string representation."""
+        _href=(
+            self.href
+            if hasattr(self, "href")
+            else None
+        )
+        _limit=(
+            self.limit
+            if hasattr(self, "limit")
+            else None
+        )
+        _next=(
+            self.next
+            if hasattr(self, "next")
+            else None
+        )
+        _cursors=(
+            self.cursors
+            if hasattr(self, "cursors")
+            else None
+        )
+        _total=(
+            self.total
+            if hasattr(self, "total")
+            else None
+        )
+        _items=(
+            self.items
+            if hasattr(self, "items")
+            else None
+        )
+        return (
+            f"{self.__class__.__name__}("
+            f"href={_href!s}, "
+            f"limit={_limit!s}, "
+            f"next={_next!s}, "
+            f"cursors={_cursors!s}, "
+            f"total={_total!s}, "
+            f"items={_items!s}, "
+            f")"
+        )