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

spotifywebapi/models/cursor_paging_simplified_artist_object.py

@@ -0,0 +1,213 @@
+"""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.artist_object import (
+    ArtistObject,
+)
+from spotifywebapi.models.cursor_object import (
+    CursorObject,
+)
+
+
+class CursorPagingSimplifiedArtistObject(object):
+    """Implementation of the 'CursorPagingSimplifiedArtistObject' 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[ArtistObject]): The model property of type List[ArtistObject].
+
+    """
+
+    # 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 CursorPagingSimplifiedArtistObject 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 = [
+                ArtistObject.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")"
+        )

spotifywebapi/models/device_object.py

@@ -0,0 +1,278 @@
+"""spotifywebapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: E501
+from spotifywebapi.api_helper import APIHelper
+
+
+class DeviceObject(object):
+    """Implementation of the 'DeviceObject' model.
+
+    Attributes:
+        id (str): The device ID. This ID is unique and persistent to some extent.
+            However, this is not guaranteed and any cached `device_id` should
+            periodically be cleared out and refetched as necessary.
+        is_active (bool): If this device is the currently active device.
+        is_private_session (bool): If this device is currently in a private session.
+        is_restricted (bool): Whether controlling this device is restricted. At
+            present if this is "true" then no Web API commands will be accepted by
+            this device.
+        name (str): A human-readable name for the device. Some devices have a name
+            that the user can configure (e.g. \"Loudest speaker\") and some devices
+            have a generic name associated with the manufacturer or device model.
+        mtype (str): Device type, such as "computer", "smartphone" or "speaker".
+        volume_percent (int): The current volume in percent.
+        supports_volume (bool): If this device can be used to set the volume.
+
+    """
+
+    # Create a mapping from Model property names to API property names
+    _names = {
+        "id": "id",
+        "is_active": "is_active",
+        "is_private_session": "is_private_session",
+        "is_restricted": "is_restricted",
+        "name": "name",
+        "mtype": "type",
+        "volume_percent": "volume_percent",
+        "supports_volume": "supports_volume",
+    }
+
+    _optionals = [
+        "id",
+        "is_active",
+        "is_private_session",
+        "is_restricted",
+        "name",
+        "mtype",
+        "volume_percent",
+        "supports_volume",
+    ]
+
+    _nullables = [
+        "id",
+        "volume_percent",
+    ]
+
+    def __init__(
+        self,
+        id=APIHelper.SKIP,
+        is_active=APIHelper.SKIP,
+        is_private_session=APIHelper.SKIP,
+        is_restricted=APIHelper.SKIP,
+        name=APIHelper.SKIP,
+        mtype=APIHelper.SKIP,
+        volume_percent=APIHelper.SKIP,
+        supports_volume=APIHelper.SKIP):
+        """Initialize a DeviceObject instance."""
+        # Initialize members of the class
+        if id is not APIHelper.SKIP:
+            self.id = id
+        if is_active is not APIHelper.SKIP:
+            self.is_active = is_active
+        if is_private_session is not APIHelper.SKIP:
+            self.is_private_session = is_private_session
+        if is_restricted is not APIHelper.SKIP:
+            self.is_restricted = is_restricted
+        if name is not APIHelper.SKIP:
+            self.name = name
+        if mtype is not APIHelper.SKIP:
+            self.mtype = mtype
+        if volume_percent is not APIHelper.SKIP:
+            self.volume_percent = volume_percent
+        if supports_volume is not APIHelper.SKIP:
+            self.supports_volume = supports_volume
+
+    @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
+        id =\
+            dictionary.get("id")\
+            if "id" in dictionary.keys()\
+                else APIHelper.SKIP
+        is_active =\
+            dictionary.get("is_active")\
+            if "is_active" in dictionary.keys()\
+                else APIHelper.SKIP
+        is_private_session =\
+            dictionary.get("is_private_session")\
+            if "is_private_session" in dictionary.keys()\
+                else APIHelper.SKIP
+        is_restricted =\
+            dictionary.get("is_restricted")\
+            if "is_restricted" in dictionary.keys()\
+                else APIHelper.SKIP
+        name =\
+            dictionary.get("name")\
+            if dictionary.get("name")\
+                else APIHelper.SKIP
+        mtype =\
+            dictionary.get("type")\
+            if dictionary.get("type")\
+                else APIHelper.SKIP
+        volume_percent =\
+            dictionary.get("volume_percent")\
+            if "volume_percent" in dictionary.keys()\
+                else APIHelper.SKIP
+        supports_volume =\
+            dictionary.get("supports_volume")\
+            if "supports_volume" in dictionary.keys()\
+                else APIHelper.SKIP
+
+        # Return an object of this model
+        return cls(id,
+                   is_active,
+                   is_private_session,
+                   is_restricted,
+                   name,
+                   mtype,
+                   volume_percent,
+                   supports_volume)
+
+    @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."""
+        _id=(
+            self.id
+            if hasattr(self, "id")
+            else None
+        )
+        _is_active=(
+            self.is_active
+            if hasattr(self, "is_active")
+            else None
+        )
+        _is_private_session=(
+            self.is_private_session
+            if hasattr(self, "is_private_session")
+            else None
+        )
+        _is_restricted=(
+            self.is_restricted
+            if hasattr(self, "is_restricted")
+            else None
+        )
+        _name=(
+            self.name
+            if hasattr(self, "name")
+            else None
+        )
+        _mtype=(
+            self.mtype
+            if hasattr(self, "mtype")
+            else None
+        )
+        _volume_percent=(
+            self.volume_percent
+            if hasattr(self, "volume_percent")
+            else None
+        )
+        _supports_volume=(
+            self.supports_volume
+            if hasattr(self, "supports_volume")
+            else None
+        )
+        return (
+            f"{self.__class__.__name__}("
+            f"id={_id!r}, "
+            f"is_active={_is_active!r}, "
+            f"is_private_session={_is_private_session!r}, "
+            f"is_restricted={_is_restricted!r}, "
+            f"name={_name!r}, "
+            f"mtype={_mtype!r}, "
+            f"volume_percent={_volume_percent!r}, "
+            f"supports_volume={_supports_volume!r}, "
+            f")"
+        )
+
+    def __str__(self):
+        """Return a human-readable string representation."""
+        _id=(
+            self.id
+            if hasattr(self, "id")
+            else None
+        )
+        _is_active=(
+            self.is_active
+            if hasattr(self, "is_active")
+            else None
+        )
+        _is_private_session=(
+            self.is_private_session
+            if hasattr(self, "is_private_session")
+            else None
+        )
+        _is_restricted=(
+            self.is_restricted
+            if hasattr(self, "is_restricted")
+            else None
+        )
+        _name=(
+            self.name
+            if hasattr(self, "name")
+            else None
+        )
+        _mtype=(
+            self.mtype
+            if hasattr(self, "mtype")
+            else None
+        )
+        _volume_percent=(
+            self.volume_percent
+            if hasattr(self, "volume_percent")
+            else None
+        )
+        _supports_volume=(
+            self.supports_volume
+            if hasattr(self, "supports_volume")
+            else None
+        )
+        return (
+            f"{self.__class__.__name__}("
+            f"id={_id!s}, "
+            f"is_active={_is_active!s}, "
+            f"is_private_session={_is_private_session!s}, "
+            f"is_restricted={_is_restricted!s}, "
+            f"name={_name!s}, "
+            f"mtype={_mtype!s}, "
+            f"volume_percent={_volume_percent!s}, "
+            f"supports_volume={_supports_volume!s}, "
+            f")"
+        )