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

spotifywebapi/models/narrator_object.py

@@ -0,0 +1,85 @@
+"""spotifywebapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: E501
+from spotifywebapi.api_helper import APIHelper
+
+
+class NarratorObject(object):
+    """Implementation of the 'NarratorObject' model.
+
+    Attributes:
+        name (str): The name of the Narrator.
+
+    """
+
+    # Create a mapping from Model property names to API property names
+    _names = {
+        "name": "name",
+    }
+
+    _optionals = [
+        "name",
+    ]
+
+    def __init__(
+        self,
+        name=APIHelper.SKIP):
+        """Initialize a NarratorObject instance."""
+        # Initialize members of the class
+        if name is not APIHelper.SKIP:
+            self.name = name
+
+    @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
+        name =\
+            dictionary.get("name")\
+            if dictionary.get("name")\
+                else APIHelper.SKIP
+
+        # Return an object of this model
+        return cls(name)
+
+    def __repr__(self):
+        """Return a unambiguous string representation."""
+        _name=(
+            self.name
+            if hasattr(self, "name")
+            else None
+        )
+        return (
+            f"{self.__class__.__name__}("
+            f"name={_name!r}, "
+            f")"
+        )
+
+    def __str__(self):
+        """Return a human-readable string representation."""
+        _name=(
+            self.name
+            if hasattr(self, "name")
+            else None
+        )
+        return (
+            f"{self.__class__.__name__}("
+            f"name={_name!s}, "
+            f")"
+        )

spotifywebapi/models/o_auth_provider_error_enum.py

@@ -0,0 +1,67 @@
+"""spotifywebapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: E501
+
+class OAuthProviderErrorEnum(object):
+    """Implementation of the 'OAuthProviderError' enum.
+
+    OAuth 2 Authorization error codes
+
+    Attributes:
+        INVALID_REQUEST: The request is missing a required parameter, includes an
+            unsupported parameter value (other than grant type), repeats a parameter,
+            includes multiple credentials, utilizes more than one mechanism for
+            authenticating the client, or is otherwise malformed.
+        INVALID_CLIENT: Client authentication failed (e.g., unknown client, no client
+            authentication included, or unsupported authentication method).
+        INVALID_GRANT: The provided authorization grant (e.g., authorization code,
+            resource owner credentials) or refresh token is invalid, expired,
+            revoked, does not match the redirection URI used in the authorization
+            request, or was issued to another client.
+        UNAUTHORIZED_CLIENT: The authenticated client is not authorized to use this
+            authorization grant type.
+        UNSUPPORTED_GRANT_TYPE: The authorization grant type is not supported by the
+            authorization server.
+        INVALID_SCOPE: The requested scope is invalid, unknown, malformed, or exceeds
+            the scope granted by the resource owner.
+
+    """
+
+    INVALID_REQUEST = "invalid_request"
+
+    INVALID_CLIENT = "invalid_client"
+
+    INVALID_GRANT = "invalid_grant"
+
+    UNAUTHORIZED_CLIENT = "unauthorized_client"
+
+    UNSUPPORTED_GRANT_TYPE = "unsupported_grant_type"
+
+    INVALID_SCOPE = "invalid_scope"
+
+    @classmethod
+    def from_value(cls, value, default=None):
+        """Return the matching enum value for the given input."""
+        if value is None:
+            return default
+
+        # If numeric and matches directly
+        if isinstance(value, int):
+            for name, val in cls.__dict__.items():
+                if not name.startswith("_") and val == value:
+                    return val
+
+        # If string, perform case-insensitive match
+        if isinstance(value, str):
+            value_lower = value.lower()
+            for name, val in cls.__dict__.items():
+                if not name.startswith("_") and (
+                    name.lower() == value_lower or str(val).lower() == value_lower
+                ):
+                    return val
+
+        # Fallback to default
+        return default

spotifywebapi/models/o_auth_scope_enum.py

@@ -0,0 +1,98 @@
+"""spotifywebapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: E501
+
+class OAuthScopeEnum(object):
+    """Implementation of the 'OAuth Scope' enum.
+
+    OAuth 2 scopes supported by the API
+
+    Attributes:
+        APP-REMOTE-CONTROL: Communicate with the Spotify app on your device.
+        PLAYLIST-READ-PRIVATE: Access your private playlists.
+        PLAYLIST-READ-COLLABORATIVE: Access your collaborative playlists.
+        PLAYLIST-MODIFY-PUBLIC: Manage your public playlists.
+        PLAYLIST-MODIFY-PRIVATE: Manage your private playlists.
+        USER-LIBRARY-READ: Access your saved content.
+        USER-LIBRARY-MODIFY: Manage your saved content.
+        USER-READ-PRIVATE: Access your subscription details.
+        USER-READ-EMAIL: Get your real email address.
+        USER-FOLLOW-READ: Access your followers and who you are following.
+        USER-FOLLOW-MODIFY: Manage your saved content.
+        USER-TOP-READ: Read your top artists and content.
+        USER-READ-PLAYBACK-POSITION: Read your position in content you have played.
+        USER-READ-PLAYBACK-STATE: Read your currently playing content and Spotify
+            Connect devices information.
+        USER-READ-RECENTLY-PLAYED: Access your recently played items.
+        USER-READ-CURRENTLY-PLAYING: Read your currently playing content.
+        USER-MODIFY-PLAYBACK-STATE: Control playback on your Spotify clients and
+            Spotify Connect devices.
+        UGC-IMAGE-UPLOAD: Upload images to Spotify on your behalf.
+        STREAMING: Play content and control playback on your other devices.
+
+    """
+
+    APP_REMOTE_CONTROL = "app-remote-control"
+
+    PLAYLIST_READ_PRIVATE = "playlist-read-private"
+
+    PLAYLIST_READ_COLLABORATIVE = "playlist-read-collaborative"
+
+    PLAYLIST_MODIFY_PUBLIC = "playlist-modify-public"
+
+    PLAYLIST_MODIFY_PRIVATE = "playlist-modify-private"
+
+    USER_LIBRARY_READ = "user-library-read"
+
+    USER_LIBRARY_MODIFY = "user-library-modify"
+
+    USER_READ_PRIVATE = "user-read-private"
+
+    USER_READ_EMAIL = "user-read-email"
+
+    USER_FOLLOW_READ = "user-follow-read"
+
+    USER_FOLLOW_MODIFY = "user-follow-modify"
+
+    USER_TOP_READ = "user-top-read"
+
+    USER_READ_PLAYBACK_POSITION = "user-read-playback-position"
+
+    USER_READ_PLAYBACK_STATE = "user-read-playback-state"
+
+    USER_READ_RECENTLY_PLAYED = "user-read-recently-played"
+
+    USER_READ_CURRENTLY_PLAYING = "user-read-currently-playing"
+
+    USER_MODIFY_PLAYBACK_STATE = "user-modify-playback-state"
+
+    UGC_IMAGE_UPLOAD = "ugc-image-upload"
+
+    STREAMING = "streaming"
+
+    @classmethod
+    def from_value(cls, value, default=None):
+        """Return the matching enum value for the given input."""
+        if value is None:
+            return default
+
+        # If numeric and matches directly
+        if isinstance(value, int):
+            for name, val in cls.__dict__.items():
+                if not name.startswith("_") and val == value:
+                    return val
+
+        # If string, perform case-insensitive match
+        if isinstance(value, str):
+            value_lower = value.lower()
+            for name, val in cls.__dict__.items():
+                if not name.startswith("_") and (
+                    name.lower() == value_lower or str(val).lower() == value_lower
+                ):
+                    return val
+
+        # Fallback to default
+        return default

spotifywebapi/models/o_auth_token.py

@@ -0,0 +1,113 @@
+"""spotifywebapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: E501
+from spotifywebapi.api_helper import APIHelper
+
+
+class OAuthToken(object):
+    """Implementation of the 'OAuthToken' model.
+
+    OAuth 2 Authorization endpoint response
+
+    Attributes:
+        access_token (str): Access token
+        token_type (str): Type of access token
+        expires_in (int): Time in seconds before the access token expires
+        scope (str): List of scopes granted This is a space-delimited list of strings.
+        expiry (int): Time of token expiry as unix timestamp (UTC)
+        refresh_token (str): Refresh token Used to get a new access token when it
+            expires.
+
+    """
+
+    # Create a mapping from Model property names to API property names
+    _names = {
+        "access_token": "access_token",
+        "token_type": "token_type",
+        "expires_in": "expires_in",
+        "scope": "scope",
+        "expiry": "expiry",
+        "refresh_token": "refresh_token",
+    }
+
+    _optionals = [
+        "expires_in",
+        "scope",
+        "expiry",
+        "refresh_token",
+    ]
+
+    def __init__(
+        self,
+        access_token=None,
+        token_type=None,
+        expires_in=APIHelper.SKIP,
+        scope=APIHelper.SKIP,
+        expiry=APIHelper.SKIP,
+        refresh_token=APIHelper.SKIP):
+        """Initialize a OAuthToken instance."""
+        # Initialize members of the class
+        self.access_token = access_token
+        self.token_type = token_type
+        if expires_in is not APIHelper.SKIP:
+            self.expires_in = expires_in
+        if scope is not APIHelper.SKIP:
+            self.scope = scope
+        if expiry is not APIHelper.SKIP:
+            self.expiry = expiry
+        if refresh_token is not APIHelper.SKIP:
+            self.refresh_token = refresh_token
+
+    @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
+        access_token =\
+            dictionary.get("access_token")\
+            if dictionary.get("access_token")\
+                else None
+        token_type =\
+            dictionary.get("token_type")\
+            if dictionary.get("token_type")\
+                else None
+        expires_in =\
+            dictionary.get("expires_in")\
+            if dictionary.get("expires_in")\
+                else APIHelper.SKIP
+        scope =\
+            dictionary.get("scope")\
+            if dictionary.get("scope")\
+                else APIHelper.SKIP
+        expiry =\
+            dictionary.get("expiry")\
+            if dictionary.get("expiry")\
+                else APIHelper.SKIP
+        refresh_token =\
+            dictionary.get("refresh_token")\
+            if dictionary.get("refresh_token")\
+                else APIHelper.SKIP
+
+        # Return an object of this model
+        return cls(access_token,
+                   token_type,
+                   expires_in,
+                   scope,
+                   expiry,
+                   refresh_token)

spotifywebapi/models/paged_albums.py

@@ -0,0 +1,75 @@
+"""spotifywebapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: E501
+from spotifywebapi.models.paging_simplified_album_object import (
+    PagingSimplifiedAlbumObject,
+)
+
+
+class PagedAlbums(object):
+    """Implementation of the 'PagedAlbums' model.
+
+    Attributes:
+        albums (PagingSimplifiedAlbumObject): The model property of type
+            PagingSimplifiedAlbumObject.
+
+    """
+
+    # Create a mapping from Model property names to API property names
+    _names = {
+        "albums": "albums",
+    }
+
+    def __init__(
+        self,
+        albums=None):
+        """Initialize a PagedAlbums instance."""
+        # Initialize members of the class
+        self.albums = albums
+
+    @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
+        albums =\
+            PagingSimplifiedAlbumObject.from_dictionary(
+                dictionary.get("albums"))\
+                if dictionary.get("albums") else None
+
+        # Return an object of this model
+        return cls(albums)
+
+    def __repr__(self):
+        """Return a unambiguous string representation."""
+        _albums=self.albums
+        return (
+            f"{self.__class__.__name__}("
+            f"albums={_albums!r}, "
+            f")"
+        )
+
+    def __str__(self):
+        """Return a human-readable string representation."""
+        _albums=self.albums
+        return (
+            f"{self.__class__.__name__}("
+            f"albums={_albums!s}, "
+            f")"
+        )

spotifywebapi/models/paged_categories.py

@@ -0,0 +1,74 @@
+"""spotifywebapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: E501
+from spotifywebapi.models.categories import (
+    Categories,
+)
+
+
+class PagedCategories(object):
+    """Implementation of the 'PagedCategories' model.
+
+    Attributes:
+        categories (Categories): The model property of type Categories.
+
+    """
+
+    # Create a mapping from Model property names to API property names
+    _names = {
+        "categories": "categories",
+    }
+
+    def __init__(
+        self,
+        categories=None):
+        """Initialize a PagedCategories instance."""
+        # Initialize members of the class
+        self.categories = categories
+
+    @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
+        categories =\
+            Categories.from_dictionary(
+                dictionary.get("categories"))\
+                if dictionary.get("categories") else None
+
+        # Return an object of this model
+        return cls(categories)
+
+    def __repr__(self):
+        """Return a unambiguous string representation."""
+        _categories=self.categories
+        return (
+            f"{self.__class__.__name__}("
+            f"categories={_categories!r}, "
+            f")"
+        )
+
+    def __str__(self):
+        """Return a human-readable string representation."""
+        _categories=self.categories
+        return (
+            f"{self.__class__.__name__}("
+            f"categories={_categories!s}, "
+            f")"
+        )

spotifywebapi/models/paging_artist_discography_album_object.py

@@ -0,0 +1,163 @@
+"""spotifywebapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: E501
+from spotifywebapi.models.artist_discography_album_object import (
+    ArtistDiscographyAlbumObject,
+)
+
+
+class PagingArtistDiscographyAlbumObject(object):
+    """Implementation of the 'PagingArtistDiscographyAlbumObject' 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[ArtistDiscographyAlbumObject]): The model property of type
+            List[ArtistDiscographyAlbumObject].
+
+    """
+
+    # 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 PagingArtistDiscographyAlbumObject 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 = [
+                ArtistDiscographyAlbumObject.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")"
+        )