spotifywebapiPython 1.0.242__py3-none-any.whl

spotifywebapipython/models/trackpagesaved.py

@@ -0,0 +1,85 @@
+# external package imports.
+
+# our package imports.
+from ..sautils import export
+from .track import Track
+from .tracksaved import TrackSaved
+from .pageobject import PageObject
+
+@export
+class TrackPageSaved(PageObject):
+    """
+    Spotify Web API TrackPageSaved object.
+    
+    This allows for multiple pages of `TrackSaved` objects to be navigated.
+    """
+
+    def __init__(self, root:dict=None) -> None:
+        """
+        Initializes a new instance of the class.
+        
+        Args:
+            root (dict):
+                Spotify Web API JSON response in dictionary format, used to load object
+                attributes; otherwise, None to not load attributes.
+        """
+        # initialize base class.
+        super().__init__(root=root)
+        
+        # initialize storage.
+        self._Items:list[TrackSaved] = []
+        
+        if (root is None):
+
+            pass
+        
+        else:
+
+            # process all collections and objects.
+            items:list = root.get('items',None)
+            if items is not None:
+                for item in items:
+                    if item is not None:
+                        self._Items.append(TrackSaved(root=item))
+
+        
+    def __repr__(self) -> str:
+        return self.ToString()
+
+
+    def __str__(self) -> str:
+        return self.ToString()
+
+
+    @property
+    def Items(self) -> list[TrackSaved]:
+        """ 
+        Array of `TrackSaved` objects.
+        """
+        return self._Items
+    
+
+    def GetTracks(self) -> list[Track]:
+        """ 
+        Gets a list of all tracks contained in the underlying `Items` list.
+        
+        This is a convenience method so one does not have to loop through the `Items`
+        array of TrackSaved objects to get the list of tracks.
+        """
+        result:list[Track] = []
+        item:TrackSaved
+        for item in self._Items:
+            result.append(item.Track)
+        return result
+    
+
+    def ToString(self, includeItems:bool=False) -> str:
+        """
+        Returns a displayable string representation of the class.
+        
+        Args:
+            includeItems (bool):
+                True to include the Items collection of objects; otherwise, False
+                to only return base properties.
+        """
+        return 'TrackPageSaved: %s' % super().ToString(includeItems)

spotifywebapipython/models/trackpagesimplified.py

@@ -0,0 +1,88 @@
+# external package imports.
+
+# our package imports.
+from ..sautils import export
+from .tracksimplified import TrackSimplified
+from .pageobject import PageObject
+
+@export
+class TrackPageSimplified(PageObject):
+    """
+    Spotify Web API SimplifiedTrackPage object.
+    
+    This allows for multiple pages of `TrackSimplified` objects to be navigated.
+    """
+
+    def __init__(self, root:dict=None) -> None:
+        """
+        Initializes a new instance of the class.
+        
+        Args:
+            root (dict):
+                Spotify Web API JSON response in dictionary format, used to load object
+                attributes; otherwise, None to not load attributes.
+        """
+        # initialize base class.
+        super().__init__(root=root)
+        
+        # initialize storage.
+        self._Items:list[TrackSimplified] = []
+        
+        if (root is None):
+
+            pass
+        
+        else:
+
+            # process all collections and objects.
+            items:list = root.get('items',None)
+            if items is not None:
+                for item in items:
+                    if item is not None:
+                        self._Items.append(TrackSimplified(root=item))
+
+        
+    def __repr__(self) -> str:
+        return self.ToString()
+
+
+    def __str__(self) -> str:
+        return self.ToString()
+
+
+    @property
+    def Items(self) -> list[TrackSimplified]:
+        """ 
+        Array of `TrackSimplified` objects.
+        """
+        return self._Items
+    
+
+    def ContainsId(self, itemId:str=False) -> bool:
+        """
+        Checks the `Items` collection to see if an item already exists with the
+        specified Id value.
+        
+        Returns True if the itemId exists in the collection; otherwise, False.
+        """
+        result:bool = False
+        
+        item:TrackSimplified
+        for item in self._Items:
+            if item.Id == itemId:
+                result = True
+                break
+            
+        return result
+        
+
+    def ToString(self, includeItems:bool=False) -> str:
+        """
+        Returns a displayable string representation of the class.
+        
+        Args:
+            includeItems (bool):
+                True to include the Items collection of objects; otherwise, False
+                to only return base properties.
+        """
+        return 'TrackPageSimplified: %s' % super().ToString(includeItems)

spotifywebapipython/models/trackrecommendations.py

@@ -0,0 +1,88 @@
+# external package imports.
+
+# our package imports.
+from ..sautils import export
+from .recommendationseed import RecommendationSeed
+from .track import Track
+
+@export
+class TrackRecommendations:
+    """
+    Spotify Web API TrackRecommendations object.
+    """
+
+    def __init__(self, root:dict=None) -> None:
+        """
+        Initializes a new instance of the class.
+        
+        Args:
+            root (dict):
+                Spotify Web API JSON response in dictionary format, used to load object
+                attributes; otherwise, None to not load attributes.
+        """
+        self._Seeds:list[RecommendationSeed] = []
+        self._Tracks:list[Track] = []
+        
+        if (root is None):
+
+            pass
+        
+        else:
+
+            # process all collections and objects.
+            items:list = root.get('seeds', [])
+            if items is not None:
+                for item in items:
+                    self._Seeds.append(RecommendationSeed(root=item))
+        
+            items:list = root.get('tracks', [])
+            if items is not None:
+                for item in items:
+                    self._Tracks.append(Track(root=item))
+
+        
+    def __repr__(self) -> str:
+        return self.ToString()
+
+
+    def __str__(self) -> str:
+        return self.ToString()
+
+
+    @property
+    def Seeds(self) -> list[RecommendationSeed]:
+        """ 
+        A list of recommendation seed objects. 
+        """
+        return self._Seeds
+
+
+    @property
+    def Tracks(self) -> list[Track]:
+        """ 
+        A list of Track objects, ordered according to the parameters supplied
+        to the `GetTrackRecommendations` method.
+        """
+        return self._Tracks
+
+
+    def ToDictionary(self) -> dict:
+        """
+        Returns a dictionary representation of the class.
+        """
+        result:dict = \
+        {
+            'seeds': [ item.ToDictionary() for item in self._Seeds ],
+            'tracks': [ item.ToDictionary() for item in self._Tracks ],
+        }
+        return result
+        
+
+    def ToString(self) -> str:
+        """
+        Returns a displayable string representation of the class.
+        """
+        msg:str = 'TrackRecommendations:'
+        if self._Seeds is not None: msg = '%s\n Seeds Count=%s' % (msg, str(len(self._Seeds)))
+        if self._Tracks is not None: msg = '%s\n Tracks Count=%s' % (msg, str(len(self._Tracks)))
+        return msg 

spotifywebapipython/models/tracksaved.py

@@ -0,0 +1,99 @@
+# external package imports.
+
+# our package imports.
+from ..sautils import export
+from .track import Track
+
+@export
+class TrackSaved:
+    """
+    Spotify Web API SavedTrack object.
+    """
+
+    def __init__(self, root:dict=None) -> None:
+        """
+        Initializes a new instance of the class.
+        
+        Args:
+            root (dict):
+                Spotify Web API JSON response in dictionary format, used to load object
+                attributes; otherwise, None to not load attributes.
+        """
+        self._AddedAt:str = None
+        self._Track:Track = None
+        
+        if (root is None):
+
+            pass
+        
+        else:
+
+            self._AddedAt = root.get('added_at', None)
+
+            # process all collections and objects.
+            item:dict = root.get('track',None)
+            if item is not None:
+                self._Track = Track(root=item)
+
+        
+    def __repr__(self) -> str:
+        return self.ToString()
+
+
+    def __str__(self) -> str:
+        return self.ToString()
+
+
+    @property
+    def AddedAt(self) -> str:
+        """ 
+        The date and time the track was saved. 
+        
+        Timestamps are returned in ISO 8601 format as Coordinated Universal Time (UTC) with a zero 
+        offset: YYYY-MM-DDTHH:MM:SSZ. If the time is imprecise (for example, the date/time of an 
+        album release), an additional field indicates the precision; see for example, release_date 
+        in an album object.
+        """
+        return self._AddedAt
+
+
+    @property
+    def Track(self) -> Track:
+        """ 
+        Information about the track.
+        """
+        return self._Track
+    
+
+    def ToDictionary(self) -> dict:
+        """
+        Returns a dictionary representation of the class.
+        """
+        track:dict = {}
+        if self._Track is not None:
+            track = self._Track.ToDictionary()
+
+        result:dict = \
+        {
+            'added_at': self._AddedAt,
+            'track': track
+        }
+        return result
+        
+
+    def ToString(self, includeItems:bool=False) -> str:
+        """
+        Returns a displayable string representation of the class.
+        
+        Args:
+            includeItems (bool):
+                True to include the Items collection of objects; otherwise, False
+                to only return base properties.
+        """
+        msg:str = 'TrackSaved:'
+        if self._AddedAt is not None: msg = '%s\n AddedAt="%s"' % (msg, str(self._AddedAt))
+        
+        if (includeItems):
+            if self._Track is not None: msg = '%s\n %s' % (msg, str(self._Track))
+            
+        return msg