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

spotifywebapi/models/search_items.py

@@ -0,0 +1,256 @@
+"""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_artist_object import (
+    PagingArtistObject,
+)
+from spotifywebapi.models.paging_playlist_object import (
+    PagingPlaylistObject,
+)
+from spotifywebapi.models.paging_simplified_album_object import (
+    PagingSimplifiedAlbumObject,
+)
+from spotifywebapi.models.paging_simplified_audiobook_object import (
+    PagingSimplifiedAudiobookObject,
+)
+from spotifywebapi.models.paging_simplified_episode_object import (
+    PagingSimplifiedEpisodeObject,
+)
+from spotifywebapi.models.paging_simplified_show_object import (
+    PagingSimplifiedShowObject,
+)
+from spotifywebapi.models.paging_track_object import (
+    PagingTrackObject,
+)
+
+
+class SearchItems(object):
+    """Implementation of the 'SearchItems' model.
+
+    Attributes:
+        tracks (PagingTrackObject): The model property of type PagingTrackObject.
+        artists (PagingArtistObject): The model property of type PagingArtistObject.
+        albums (PagingSimplifiedAlbumObject): The model property of type
+            PagingSimplifiedAlbumObject.
+        playlists (PagingPlaylistObject): The model property of type
+            PagingPlaylistObject.
+        shows (PagingSimplifiedShowObject): The model property of type
+            PagingSimplifiedShowObject.
+        episodes (PagingSimplifiedEpisodeObject): The model property of type
+            PagingSimplifiedEpisodeObject.
+        audiobooks (PagingSimplifiedAudiobookObject): The model property of type
+            PagingSimplifiedAudiobookObject.
+
+    """
+
+    # Create a mapping from Model property names to API property names
+    _names = {
+        "tracks": "tracks",
+        "artists": "artists",
+        "albums": "albums",
+        "playlists": "playlists",
+        "shows": "shows",
+        "episodes": "episodes",
+        "audiobooks": "audiobooks",
+    }
+
+    _optionals = [
+        "tracks",
+        "artists",
+        "albums",
+        "playlists",
+        "shows",
+        "episodes",
+        "audiobooks",
+    ]
+
+    def __init__(
+        self,
+        tracks=APIHelper.SKIP,
+        artists=APIHelper.SKIP,
+        albums=APIHelper.SKIP,
+        playlists=APIHelper.SKIP,
+        shows=APIHelper.SKIP,
+        episodes=APIHelper.SKIP,
+        audiobooks=APIHelper.SKIP):
+        """Initialize a SearchItems instance."""
+        # Initialize members of the class
+        if tracks is not APIHelper.SKIP:
+            self.tracks = tracks
+        if artists is not APIHelper.SKIP:
+            self.artists = artists
+        if albums is not APIHelper.SKIP:
+            self.albums = albums
+        if playlists is not APIHelper.SKIP:
+            self.playlists = playlists
+        if shows is not APIHelper.SKIP:
+            self.shows = shows
+        if episodes is not APIHelper.SKIP:
+            self.episodes = episodes
+        if audiobooks is not APIHelper.SKIP:
+            self.audiobooks = audiobooks
+
+    @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
+        tracks =\
+            PagingTrackObject.from_dictionary(
+                dictionary.get("tracks"))\
+                if "tracks" in dictionary.keys()\
+                else APIHelper.SKIP
+        artists =\
+            PagingArtistObject.from_dictionary(
+                dictionary.get("artists"))\
+                if "artists" in dictionary.keys()\
+                else APIHelper.SKIP
+        albums =\
+            PagingSimplifiedAlbumObject.from_dictionary(
+                dictionary.get("albums"))\
+                if "albums" in dictionary.keys()\
+                else APIHelper.SKIP
+        playlists =\
+            PagingPlaylistObject.from_dictionary(
+                dictionary.get("playlists"))\
+                if "playlists" in dictionary.keys()\
+                else APIHelper.SKIP
+        shows =\
+            PagingSimplifiedShowObject.from_dictionary(
+                dictionary.get("shows"))\
+                if "shows" in dictionary.keys()\
+                else APIHelper.SKIP
+        episodes =\
+            PagingSimplifiedEpisodeObject.from_dictionary(
+                dictionary.get("episodes"))\
+                if "episodes" in dictionary.keys()\
+                else APIHelper.SKIP
+        audiobooks =\
+            PagingSimplifiedAudiobookObject.from_dictionary(
+                dictionary.get("audiobooks"))\
+                if "audiobooks" in dictionary.keys()\
+                else APIHelper.SKIP
+
+        # Return an object of this model
+        return cls(tracks,
+                   artists,
+                   albums,
+                   playlists,
+                   shows,
+                   episodes,
+                   audiobooks)
+
+    def __repr__(self):
+        """Return a unambiguous string representation."""
+        _tracks=(
+            self.tracks
+            if hasattr(self, "tracks")
+            else None
+        )
+        _artists=(
+            self.artists
+            if hasattr(self, "artists")
+            else None
+        )
+        _albums=(
+            self.albums
+            if hasattr(self, "albums")
+            else None
+        )
+        _playlists=(
+            self.playlists
+            if hasattr(self, "playlists")
+            else None
+        )
+        _shows=(
+            self.shows
+            if hasattr(self, "shows")
+            else None
+        )
+        _episodes=(
+            self.episodes
+            if hasattr(self, "episodes")
+            else None
+        )
+        _audiobooks=(
+            self.audiobooks
+            if hasattr(self, "audiobooks")
+            else None
+        )
+        return (
+            f"{self.__class__.__name__}("
+            f"tracks={_tracks!r}, "
+            f"artists={_artists!r}, "
+            f"albums={_albums!r}, "
+            f"playlists={_playlists!r}, "
+            f"shows={_shows!r}, "
+            f"episodes={_episodes!r}, "
+            f"audiobooks={_audiobooks!r}, "
+            f")"
+        )
+
+    def __str__(self):
+        """Return a human-readable string representation."""
+        _tracks=(
+            self.tracks
+            if hasattr(self, "tracks")
+            else None
+        )
+        _artists=(
+            self.artists
+            if hasattr(self, "artists")
+            else None
+        )
+        _albums=(
+            self.albums
+            if hasattr(self, "albums")
+            else None
+        )
+        _playlists=(
+            self.playlists
+            if hasattr(self, "playlists")
+            else None
+        )
+        _shows=(
+            self.shows
+            if hasattr(self, "shows")
+            else None
+        )
+        _episodes=(
+            self.episodes
+            if hasattr(self, "episodes")
+            else None
+        )
+        _audiobooks=(
+            self.audiobooks
+            if hasattr(self, "audiobooks")
+            else None
+        )
+        return (
+            f"{self.__class__.__name__}("
+            f"tracks={_tracks!s}, "
+            f"artists={_artists!s}, "
+            f"albums={_albums!s}, "
+            f"playlists={_playlists!s}, "
+            f"shows={_shows!s}, "
+            f"episodes={_episodes!s}, "
+            f"audiobooks={_audiobooks!s}, "
+            f")"
+        )

spotifywebapi/models/section_object.py

@@ -0,0 +1,362 @@
+"""spotifywebapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: E501
+from spotifywebapi.api_helper import APIHelper
+
+
+class SectionObject(object):
+    """Implementation of the 'SectionObject' model.
+
+    Attributes:
+        start (float): The starting point (in seconds) of the section.
+        duration (float): The duration (in seconds) of the section.
+        confidence (float): The confidence, from 0.0 to 1.0, of the reliability of
+            the section's "designation".
+        loudness (float): The overall loudness of the section in decibels (dB).
+            Loudness values are useful for comparing relative loudness of sections
+            within tracks.
+        tempo (float): The overall estimated tempo of the section in beats per minute
+            (BPM). In musical terminology, tempo is the speed or pace of a given
+            piece and derives directly from the average beat duration.
+        tempo_confidence (float): The confidence, from 0.0 to 1.0, of the reliability
+            of the tempo. Some tracks contain tempo changes or sounds which don't
+            contain tempo (like pure speech) which would correspond to a low value in
+            this field.
+        key (int): The estimated overall key of the section. The values in this field
+            ranging from 0 to 11 mapping to pitches using standard Pitch Class
+            notation (E.g. 0 = C, 1 = C♯/D♭, 2 = D, and so on). If no key was
+            detected, the value is -1.
+        key_confidence (float): The confidence, from 0.0 to 1.0, of the reliability
+            of the key. Songs with many key changes may correspond to low values in
+            this field.
+        mode (ModeEnum): Indicates the modality (major or minor) of a section, the
+            type of scale from which its melodic content is derived. This field will
+            contain a 0 for "minor", a 1 for "major", or a -1 for no result. Note
+            that the major key (e.g. C major) could more likely be confused with the
+            minor key at 3 semitones lower (e.g. A minor) as both keys carry the same
+            pitches.
+        mode_confidence (float): The confidence, from 0.0 to 1.0, of the reliability
+            of the `mode`.
+        time_signature (int): An estimated time signature. The time signature (meter)
+            is a notational convention to specify how many beats are in each bar (or
+            measure). The time signature ranges from 3 to 7 indicating time
+            signatures of "3/4", to "7/4".
+        time_signature_confidence (float): The confidence, from 0.0 to 1.0, of the
+            reliability of the `time_signature`. Sections with time signature changes
+            may correspond to low values in this field.
+
+    """
+
+    # Create a mapping from Model property names to API property names
+    _names = {
+        "start": "start",
+        "duration": "duration",
+        "confidence": "confidence",
+        "loudness": "loudness",
+        "tempo": "tempo",
+        "tempo_confidence": "tempo_confidence",
+        "key": "key",
+        "key_confidence": "key_confidence",
+        "mode": "mode",
+        "mode_confidence": "mode_confidence",
+        "time_signature": "time_signature",
+        "time_signature_confidence": "time_signature_confidence",
+    }
+
+    _optionals = [
+        "start",
+        "duration",
+        "confidence",
+        "loudness",
+        "tempo",
+        "tempo_confidence",
+        "key",
+        "key_confidence",
+        "mode",
+        "mode_confidence",
+        "time_signature",
+        "time_signature_confidence",
+    ]
+
+    def __init__(
+        self,
+        start=APIHelper.SKIP,
+        duration=APIHelper.SKIP,
+        confidence=APIHelper.SKIP,
+        loudness=APIHelper.SKIP,
+        tempo=APIHelper.SKIP,
+        tempo_confidence=APIHelper.SKIP,
+        key=APIHelper.SKIP,
+        key_confidence=APIHelper.SKIP,
+        mode=APIHelper.SKIP,
+        mode_confidence=APIHelper.SKIP,
+        time_signature=APIHelper.SKIP,
+        time_signature_confidence=APIHelper.SKIP):
+        """Initialize a SectionObject instance."""
+        # Initialize members of the class
+        if start is not APIHelper.SKIP:
+            self.start = start
+        if duration is not APIHelper.SKIP:
+            self.duration = duration
+        if confidence is not APIHelper.SKIP:
+            self.confidence = confidence
+        if loudness is not APIHelper.SKIP:
+            self.loudness = loudness
+        if tempo is not APIHelper.SKIP:
+            self.tempo = tempo
+        if tempo_confidence is not APIHelper.SKIP:
+            self.tempo_confidence = tempo_confidence
+        if key is not APIHelper.SKIP:
+            self.key = key
+        if key_confidence is not APIHelper.SKIP:
+            self.key_confidence = key_confidence
+        if mode is not APIHelper.SKIP:
+            self.mode = mode
+        if mode_confidence is not APIHelper.SKIP:
+            self.mode_confidence = mode_confidence
+        if time_signature is not APIHelper.SKIP:
+            self.time_signature = time_signature
+        if time_signature_confidence is not APIHelper.SKIP:
+            self.time_signature_confidence = time_signature_confidence
+
+    @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
+        start =\
+            dictionary.get("start")\
+            if dictionary.get("start")\
+                else APIHelper.SKIP
+        duration =\
+            dictionary.get("duration")\
+            if dictionary.get("duration")\
+                else APIHelper.SKIP
+        confidence =\
+            dictionary.get("confidence")\
+            if dictionary.get("confidence")\
+                else APIHelper.SKIP
+        loudness =\
+            dictionary.get("loudness")\
+            if dictionary.get("loudness")\
+                else APIHelper.SKIP
+        tempo =\
+            dictionary.get("tempo")\
+            if dictionary.get("tempo")\
+                else APIHelper.SKIP
+        tempo_confidence =\
+            dictionary.get("tempo_confidence")\
+            if dictionary.get("tempo_confidence")\
+                else APIHelper.SKIP
+        key =\
+            dictionary.get("key")\
+            if dictionary.get("key")\
+                else APIHelper.SKIP
+        key_confidence =\
+            dictionary.get("key_confidence")\
+            if dictionary.get("key_confidence")\
+                else APIHelper.SKIP
+        mode =\
+            dictionary.get("mode")\
+            if dictionary.get("mode")\
+                else APIHelper.SKIP
+        mode_confidence =\
+            dictionary.get("mode_confidence")\
+            if dictionary.get("mode_confidence")\
+                else APIHelper.SKIP
+        time_signature =\
+            dictionary.get("time_signature")\
+            if dictionary.get("time_signature")\
+                else APIHelper.SKIP
+        time_signature_confidence =\
+            dictionary.get("time_signature_confidence")\
+            if dictionary.get("time_signature_confidence")\
+                else APIHelper.SKIP
+
+        # Return an object of this model
+        return cls(start,
+                   duration,
+                   confidence,
+                   loudness,
+                   tempo,
+                   tempo_confidence,
+                   key,
+                   key_confidence,
+                   mode,
+                   mode_confidence,
+                   time_signature,
+                   time_signature_confidence)
+
+    def __repr__(self):
+        """Return a unambiguous string representation."""
+        _start=(
+            self.start
+            if hasattr(self, "start")
+            else None
+        )
+        _duration=(
+            self.duration
+            if hasattr(self, "duration")
+            else None
+        )
+        _confidence=(
+            self.confidence
+            if hasattr(self, "confidence")
+            else None
+        )
+        _loudness=(
+            self.loudness
+            if hasattr(self, "loudness")
+            else None
+        )
+        _tempo=(
+            self.tempo
+            if hasattr(self, "tempo")
+            else None
+        )
+        _tempo_confidence=(
+            self.tempo_confidence
+            if hasattr(self, "tempo_confidence")
+            else None
+        )
+        _key=(
+            self.key
+            if hasattr(self, "key")
+            else None
+        )
+        _key_confidence=(
+            self.key_confidence
+            if hasattr(self, "key_confidence")
+            else None
+        )
+        _mode=(
+            self.mode
+            if hasattr(self, "mode")
+            else None
+        )
+        _mode_confidence=(
+            self.mode_confidence
+            if hasattr(self, "mode_confidence")
+            else None
+        )
+        _time_signature=(
+            self.time_signature
+            if hasattr(self, "time_signature")
+            else None
+        )
+        _time_signature_confidence=(
+            self.time_signature_confidence
+            if hasattr(self, "time_signature_confidence")
+            else None
+        )
+        return (
+            f"{self.__class__.__name__}("
+            f"start={_start!r}, "
+            f"duration={_duration!r}, "
+            f"confidence={_confidence!r}, "
+            f"loudness={_loudness!r}, "
+            f"tempo={_tempo!r}, "
+            f"tempo_confidence={_tempo_confidence!r}, "
+            f"key={_key!r}, "
+            f"key_confidence={_key_confidence!r}, "
+            f"mode={_mode!r}, "
+            f"mode_confidence={_mode_confidence!r}, "
+            f"time_signature={_time_signature!r}, "
+            f"time_signature_confidence={_time_signature_confidence!r}, "
+            f")"
+        )
+
+    def __str__(self):
+        """Return a human-readable string representation."""
+        _start=(
+            self.start
+            if hasattr(self, "start")
+            else None
+        )
+        _duration=(
+            self.duration
+            if hasattr(self, "duration")
+            else None
+        )
+        _confidence=(
+            self.confidence
+            if hasattr(self, "confidence")
+            else None
+        )
+        _loudness=(
+            self.loudness
+            if hasattr(self, "loudness")
+            else None
+        )
+        _tempo=(
+            self.tempo
+            if hasattr(self, "tempo")
+            else None
+        )
+        _tempo_confidence=(
+            self.tempo_confidence
+            if hasattr(self, "tempo_confidence")
+            else None
+        )
+        _key=(
+            self.key
+            if hasattr(self, "key")
+            else None
+        )
+        _key_confidence=(
+            self.key_confidence
+            if hasattr(self, "key_confidence")
+            else None
+        )
+        _mode=(
+            self.mode
+            if hasattr(self, "mode")
+            else None
+        )
+        _mode_confidence=(
+            self.mode_confidence
+            if hasattr(self, "mode_confidence")
+            else None
+        )
+        _time_signature=(
+            self.time_signature
+            if hasattr(self, "time_signature")
+            else None
+        )
+        _time_signature_confidence=(
+            self.time_signature_confidence
+            if hasattr(self, "time_signature_confidence")
+            else None
+        )
+        return (
+            f"{self.__class__.__name__}("
+            f"start={_start!s}, "
+            f"duration={_duration!s}, "
+            f"confidence={_confidence!s}, "
+            f"loudness={_loudness!s}, "
+            f"tempo={_tempo!s}, "
+            f"tempo_confidence={_tempo_confidence!s}, "
+            f"key={_key!s}, "
+            f"key_confidence={_key_confidence!s}, "
+            f"mode={_mode!s}, "
+            f"mode_confidence={_mode_confidence!s}, "
+            f"time_signature={_time_signature!s}, "
+            f"time_signature_confidence={_time_signature_confidence!s}, "
+            f")"
+        )