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

spotifywebapi/models/paging_track_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.track_object import (
+    TrackObject,
+)
+
+
+class PagingTrackObject(object):
+    """Implementation of the 'PagingTrackObject' 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[TrackObject]): The model property of type List[TrackObject].
+
+    """
+
+    # 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 PagingTrackObject 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 = [
+                TrackObject.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/play_history_object.py

@@ -0,0 +1,141 @@
+"""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.context_object import (
+    ContextObject,
+)
+from spotifywebapi.models.track_object import (
+    TrackObject,
+)
+
+
+class PlayHistoryObject(object):
+    """Implementation of the 'PlayHistoryObject' model.
+
+    Attributes:
+        track (TrackObject): The track the user listened to.
+        played_at (datetime): The date and time the track was played.
+        context (ContextObject): The context the track was played from.
+
+    """
+
+    # Create a mapping from Model property names to API property names
+    _names = {
+        "track": "track",
+        "played_at": "played_at",
+        "context": "context",
+    }
+
+    _optionals = [
+        "track",
+        "played_at",
+        "context",
+    ]
+
+    def __init__(
+        self,
+        track=APIHelper.SKIP,
+        played_at=APIHelper.SKIP,
+        context=APIHelper.SKIP):
+        """Initialize a PlayHistoryObject instance."""
+        # Initialize members of the class
+        if track is not APIHelper.SKIP:
+            self.track = track
+        if played_at is not APIHelper.SKIP:
+            self.played_at =\
+                 APIHelper.apply_datetime_converter(
+                played_at, APIHelper.RFC3339DateTime)\
+                 if played_at else None
+        if context is not APIHelper.SKIP:
+            self.context = context
+
+    @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
+        track =\
+            TrackObject.from_dictionary(
+                dictionary.get("track"))\
+                if "track" in dictionary.keys()\
+                else APIHelper.SKIP
+        played_at = APIHelper.RFC3339DateTime.from_value(
+            dictionary.get("played_at")).datetime\
+            if dictionary.get("played_at") else APIHelper.SKIP
+        context =\
+            ContextObject.from_dictionary(
+                dictionary.get("context"))\
+                if "context" in dictionary.keys()\
+                else APIHelper.SKIP
+
+        # Return an object of this model
+        return cls(track,
+                   played_at,
+                   context)
+
+    def __repr__(self):
+        """Return a unambiguous string representation."""
+        _track=(
+            self.track
+            if hasattr(self, "track")
+            else None
+        )
+        _played_at=(
+            self.played_at
+            if hasattr(self, "played_at")
+            else None
+        )
+        _context=(
+            self.context
+            if hasattr(self, "context")
+            else None
+        )
+        return (
+            f"{self.__class__.__name__}("
+            f"track={_track!r}, "
+            f"played_at={_played_at!r}, "
+            f"context={_context!r}, "
+            f")"
+        )
+
+    def __str__(self):
+        """Return a human-readable string representation."""
+        _track=(
+            self.track
+            if hasattr(self, "track")
+            else None
+        )
+        _played_at=(
+            self.played_at
+            if hasattr(self, "played_at")
+            else None
+        )
+        _context=(
+            self.context
+            if hasattr(self, "context")
+            else None
+        )
+        return (
+            f"{self.__class__.__name__}("
+            f"track={_track!s}, "
+            f"played_at={_played_at!s}, "
+            f"context={_context!s}, "
+            f")"
+        )