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

spotifywebapi/models/artist_object.py

@@ -0,0 +1,335 @@
+"""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.external_url_object import (
+    ExternalUrlObject,
+)
+from spotifywebapi.models.followers_object import (
+    FollowersObject,
+)
+from spotifywebapi.models.image_object import (
+    ImageObject,
+)
+
+
+class ArtistObject(object):
+    """Implementation of the 'ArtistObject' model.
+
+    Attributes:
+        external_urls (ExternalUrlObject): Known external URLs for this artist.
+        followers (FollowersObject): Information about the followers of the artist.
+        genres (List[str]): A list of the genres the artist is associated with. If
+            not yet classified, the array is empty.
+        href (str): A link to the Web API endpoint providing full details of the
+            artist.
+        id (str): The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids)
+            for the artist.
+        images (List[ImageObject]): Images of the artist in various sizes, widest
+            first.
+        name (str): The name of the artist.
+        popularity (int): The popularity of the artist. The value will be between 0
+            and 100, with 100 being the most popular. The artist's popularity is
+            calculated from the popularity of all the artist's tracks.
+        mtype (TypeEnum): The object type.
+        uri (str): The [Spotify
+            URI](/documentation/web-api/concepts/spotify-uris-ids) for the artist.
+
+    """
+
+    # Create a mapping from Model property names to API property names
+    _names = {
+        "external_urls": "external_urls",
+        "followers": "followers",
+        "genres": "genres",
+        "href": "href",
+        "id": "id",
+        "images": "images",
+        "name": "name",
+        "popularity": "popularity",
+        "mtype": "type",
+        "uri": "uri",
+    }
+
+    _optionals = [
+        "external_urls",
+        "followers",
+        "genres",
+        "href",
+        "id",
+        "images",
+        "name",
+        "popularity",
+        "mtype",
+        "uri",
+    ]
+
+    def __init__(
+        self,
+        external_urls=APIHelper.SKIP,
+        followers=APIHelper.SKIP,
+        genres=APIHelper.SKIP,
+        href=APIHelper.SKIP,
+        id=APIHelper.SKIP,
+        images=APIHelper.SKIP,
+        name=APIHelper.SKIP,
+        popularity=APIHelper.SKIP,
+        mtype=APIHelper.SKIP,
+        uri=APIHelper.SKIP):
+        """Initialize a ArtistObject instance."""
+        # Initialize members of the class
+        if external_urls is not APIHelper.SKIP:
+            self.external_urls = external_urls
+        if followers is not APIHelper.SKIP:
+            self.followers = followers
+        if genres is not APIHelper.SKIP:
+            self.genres = genres
+        if href is not APIHelper.SKIP:
+            self.href = href
+        if id is not APIHelper.SKIP:
+            self.id = id
+        if images is not APIHelper.SKIP:
+            self.images = images
+        if name is not APIHelper.SKIP:
+            self.name = name
+        if popularity is not APIHelper.SKIP:
+            self.popularity = popularity
+        if mtype is not APIHelper.SKIP:
+            self.mtype = mtype
+        if uri is not APIHelper.SKIP:
+            self.uri = uri
+
+    @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
+        external_urls =\
+            ExternalUrlObject.from_dictionary(
+                dictionary.get("external_urls"))\
+                if "external_urls" in dictionary.keys()\
+                else APIHelper.SKIP
+        followers =\
+            FollowersObject.from_dictionary(
+                dictionary.get("followers"))\
+                if "followers" in dictionary.keys()\
+                else APIHelper.SKIP
+        genres =\
+            dictionary.get("genres")\
+            if dictionary.get("genres")\
+                else APIHelper.SKIP
+        href =\
+            dictionary.get("href")\
+            if dictionary.get("href")\
+                else APIHelper.SKIP
+        id =\
+            dictionary.get("id")\
+            if dictionary.get("id")\
+                else APIHelper.SKIP
+        images = None
+        if dictionary.get("images") is not None:
+            images = [
+                ImageObject.from_dictionary(x)
+                    for x in dictionary.get("images")
+            ]
+        else:
+            images = APIHelper.SKIP
+        name =\
+            dictionary.get("name")\
+            if dictionary.get("name")\
+                else APIHelper.SKIP
+        popularity =\
+            dictionary.get("popularity")\
+            if dictionary.get("popularity")\
+                else APIHelper.SKIP
+        mtype =\
+            dictionary.get("type")\
+            if dictionary.get("type")\
+                else APIHelper.SKIP
+        uri =\
+            dictionary.get("uri")\
+            if dictionary.get("uri")\
+                else APIHelper.SKIP
+
+        # Return an object of this model
+        return cls(external_urls,
+                   followers,
+                   genres,
+                   href,
+                   id,
+                   images,
+                   name,
+                   popularity,
+                   mtype,
+                   uri)
+
+    @classmethod
+    def validate(cls, dictionary):
+        """Validate dictionary against class required properties
+
+        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:
+            boolean : if dictionary is valid contains required properties.
+
+        """
+        if isinstance(dictionary, cls):
+            return True
+
+        if not isinstance(dictionary, dict):
+            return False
+
+        return True
+
+    def __repr__(self):
+        """Return a unambiguous string representation."""
+        _external_urls=(
+            self.external_urls
+            if hasattr(self, "external_urls")
+            else None
+        )
+        _followers=(
+            self.followers
+            if hasattr(self, "followers")
+            else None
+        )
+        _genres=(
+            self.genres
+            if hasattr(self, "genres")
+            else None
+        )
+        _href=(
+            self.href
+            if hasattr(self, "href")
+            else None
+        )
+        _id=(
+            self.id
+            if hasattr(self, "id")
+            else None
+        )
+        _images=(
+            self.images
+            if hasattr(self, "images")
+            else None
+        )
+        _name=(
+            self.name
+            if hasattr(self, "name")
+            else None
+        )
+        _popularity=(
+            self.popularity
+            if hasattr(self, "popularity")
+            else None
+        )
+        _mtype=(
+            self.mtype
+            if hasattr(self, "mtype")
+            else None
+        )
+        _uri=(
+            self.uri
+            if hasattr(self, "uri")
+            else None
+        )
+        return (
+            f"{self.__class__.__name__}("
+            f"external_urls={_external_urls!r}, "
+            f"followers={_followers!r}, "
+            f"genres={_genres!r}, "
+            f"href={_href!r}, "
+            f"id={_id!r}, "
+            f"images={_images!r}, "
+            f"name={_name!r}, "
+            f"popularity={_popularity!r}, "
+            f"mtype={_mtype!r}, "
+            f"uri={_uri!r}, "
+            f")"
+        )
+
+    def __str__(self):
+        """Return a human-readable string representation."""
+        _external_urls=(
+            self.external_urls
+            if hasattr(self, "external_urls")
+            else None
+        )
+        _followers=(
+            self.followers
+            if hasattr(self, "followers")
+            else None
+        )
+        _genres=(
+            self.genres
+            if hasattr(self, "genres")
+            else None
+        )
+        _href=(
+            self.href
+            if hasattr(self, "href")
+            else None
+        )
+        _id=(
+            self.id
+            if hasattr(self, "id")
+            else None
+        )
+        _images=(
+            self.images
+            if hasattr(self, "images")
+            else None
+        )
+        _name=(
+            self.name
+            if hasattr(self, "name")
+            else None
+        )
+        _popularity=(
+            self.popularity
+            if hasattr(self, "popularity")
+            else None
+        )
+        _mtype=(
+            self.mtype
+            if hasattr(self, "mtype")
+            else None
+        )
+        _uri=(
+            self.uri
+            if hasattr(self, "uri")
+            else None
+        )
+        return (
+            f"{self.__class__.__name__}("
+            f"external_urls={_external_urls!s}, "
+            f"followers={_followers!s}, "
+            f"genres={_genres!s}, "
+            f"href={_href!s}, "
+            f"id={_id!s}, "
+            f"images={_images!s}, "
+            f"name={_name!s}, "
+            f"popularity={_popularity!s}, "
+            f"mtype={_mtype!s}, "
+            f"uri={_uri!s}, "
+            f")"
+        )

spotifywebapi/models/audio_analysis_object.py

@@ -0,0 +1,266 @@
+"""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.meta import Meta
+from spotifywebapi.models.section_object import (
+    SectionObject,
+)
+from spotifywebapi.models.segment_object import (
+    SegmentObject,
+)
+from spotifywebapi.models.time_interval_object import (
+    TimeIntervalObject,
+)
+from spotifywebapi.models.track import Track
+
+
+class AudioAnalysisObject(object):
+    """Implementation of the 'AudioAnalysisObject' model.
+
+    Attributes:
+        meta (Meta): The model property of type Meta.
+        track (Track): The model property of type Track.
+        bars (List[TimeIntervalObject]): The time intervals of the bars throughout
+            the track. A bar (or measure) is a segment of time defined as a given
+            number of beats.
+        beats (List[TimeIntervalObject]): The time intervals of beats throughout the
+            track. A beat is the basic time unit of a piece of music; for example,
+            each tick of a metronome. Beats are typically multiples of tatums.
+        sections (List[SectionObject]): Sections are defined by large variations in
+            rhythm or timbre, e.g. chorus, verse, bridge, guitar solo, etc. Each
+            section contains its own descriptions of tempo, key, mode,
+            time_signature, and loudness.
+        segments (List[SegmentObject]): Each segment contains a roughly conisistent
+            sound throughout its duration.
+        tatums (List[TimeIntervalObject]): A tatum represents the lowest regular
+            pulse train that a listener intuitively infers from the timing of
+            perceived musical events (segments).
+
+    """
+
+    # Create a mapping from Model property names to API property names
+    _names = {
+        "meta": "meta",
+        "track": "track",
+        "bars": "bars",
+        "beats": "beats",
+        "sections": "sections",
+        "segments": "segments",
+        "tatums": "tatums",
+    }
+
+    _optionals = [
+        "meta",
+        "track",
+        "bars",
+        "beats",
+        "sections",
+        "segments",
+        "tatums",
+    ]
+
+    def __init__(
+        self,
+        meta=APIHelper.SKIP,
+        track=APIHelper.SKIP,
+        bars=APIHelper.SKIP,
+        beats=APIHelper.SKIP,
+        sections=APIHelper.SKIP,
+        segments=APIHelper.SKIP,
+        tatums=APIHelper.SKIP):
+        """Initialize a AudioAnalysisObject instance."""
+        # Initialize members of the class
+        if meta is not APIHelper.SKIP:
+            self.meta = meta
+        if track is not APIHelper.SKIP:
+            self.track = track
+        if bars is not APIHelper.SKIP:
+            self.bars = bars
+        if beats is not APIHelper.SKIP:
+            self.beats = beats
+        if sections is not APIHelper.SKIP:
+            self.sections = sections
+        if segments is not APIHelper.SKIP:
+            self.segments = segments
+        if tatums is not APIHelper.SKIP:
+            self.tatums = tatums
+
+    @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
+        meta =\
+            Meta.from_dictionary(
+                dictionary.get("meta"))\
+                if "meta" in dictionary.keys()\
+                else APIHelper.SKIP
+        track =\
+            Track.from_dictionary(
+                dictionary.get("track"))\
+                if "track" in dictionary.keys()\
+                else APIHelper.SKIP
+        bars = None
+        if dictionary.get("bars") is not None:
+            bars = [
+                TimeIntervalObject.from_dictionary(x)
+                    for x in dictionary.get("bars")
+            ]
+        else:
+            bars = APIHelper.SKIP
+        beats = None
+        if dictionary.get("beats") is not None:
+            beats = [
+                TimeIntervalObject.from_dictionary(x)
+                    for x in dictionary.get("beats")
+            ]
+        else:
+            beats = APIHelper.SKIP
+        sections = None
+        if dictionary.get("sections") is not None:
+            sections = [
+                SectionObject.from_dictionary(x)
+                    for x in dictionary.get("sections")
+            ]
+        else:
+            sections = APIHelper.SKIP
+        segments = None
+        if dictionary.get("segments") is not None:
+            segments = [
+                SegmentObject.from_dictionary(x)
+                    for x in dictionary.get("segments")
+            ]
+        else:
+            segments = APIHelper.SKIP
+        tatums = None
+        if dictionary.get("tatums") is not None:
+            tatums = [
+                TimeIntervalObject.from_dictionary(x)
+                    for x in dictionary.get("tatums")
+            ]
+        else:
+            tatums = APIHelper.SKIP
+
+        # Return an object of this model
+        return cls(meta,
+                   track,
+                   bars,
+                   beats,
+                   sections,
+                   segments,
+                   tatums)
+
+    def __repr__(self):
+        """Return a unambiguous string representation."""
+        _meta=(
+            self.meta
+            if hasattr(self, "meta")
+            else None
+        )
+        _track=(
+            self.track
+            if hasattr(self, "track")
+            else None
+        )
+        _bars=(
+            self.bars
+            if hasattr(self, "bars")
+            else None
+        )
+        _beats=(
+            self.beats
+            if hasattr(self, "beats")
+            else None
+        )
+        _sections=(
+            self.sections
+            if hasattr(self, "sections")
+            else None
+        )
+        _segments=(
+            self.segments
+            if hasattr(self, "segments")
+            else None
+        )
+        _tatums=(
+            self.tatums
+            if hasattr(self, "tatums")
+            else None
+        )
+        return (
+            f"{self.__class__.__name__}("
+            f"meta={_meta!r}, "
+            f"track={_track!r}, "
+            f"bars={_bars!r}, "
+            f"beats={_beats!r}, "
+            f"sections={_sections!r}, "
+            f"segments={_segments!r}, "
+            f"tatums={_tatums!r}, "
+            f")"
+        )
+
+    def __str__(self):
+        """Return a human-readable string representation."""
+        _meta=(
+            self.meta
+            if hasattr(self, "meta")
+            else None
+        )
+        _track=(
+            self.track
+            if hasattr(self, "track")
+            else None
+        )
+        _bars=(
+            self.bars
+            if hasattr(self, "bars")
+            else None
+        )
+        _beats=(
+            self.beats
+            if hasattr(self, "beats")
+            else None
+        )
+        _sections=(
+            self.sections
+            if hasattr(self, "sections")
+            else None
+        )
+        _segments=(
+            self.segments
+            if hasattr(self, "segments")
+            else None
+        )
+        _tatums=(
+            self.tatums
+            if hasattr(self, "tatums")
+            else None
+        )
+        return (
+            f"{self.__class__.__name__}("
+            f"meta={_meta!s}, "
+            f"track={_track!s}, "
+            f"bars={_bars!s}, "
+            f"beats={_beats!s}, "
+            f"sections={_sections!s}, "
+            f"segments={_segments!s}, "
+            f"tatums={_tatums!s}, "
+            f")"
+        )