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

spotifywebapi/models/track_restriction_object.py

@@ -0,0 +1,112 @@
+"""spotifywebapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: E501
+from spotifywebapi.api_helper import APIHelper
+
+
+class TrackRestrictionObject(object):
+    """Implementation of the 'TrackRestrictionObject' model.
+
+    Attributes:
+        reason (str): The reason for the restriction. Supported values: - `market` -
+            The content item is not available in the given market. - `product` - The
+            content item is not available for the user's subscription type. -
+            `explicit` - The content item is explicit and the user's account is set
+            to not play explicit content.  Additional reasons may be added in the
+            future. **Note**: If you use this field, make sure that your application
+            safely handles unknown values.
+
+    """
+
+    # Create a mapping from Model property names to API property names
+    _names = {
+        "reason": "reason",
+    }
+
+    _optionals = [
+        "reason",
+    ]
+
+    def __init__(
+        self,
+        reason=APIHelper.SKIP):
+        """Initialize a TrackRestrictionObject instance."""
+        # Initialize members of the class
+        if reason is not APIHelper.SKIP:
+            self.reason = reason
+
+    @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
+        reason =\
+            dictionary.get("reason")\
+            if dictionary.get("reason")\
+                else APIHelper.SKIP
+
+        # Return an object of this model
+        return cls(reason)
+
+    @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."""
+        _reason=(
+            self.reason
+            if hasattr(self, "reason")
+            else None
+        )
+        return (
+            f"{self.__class__.__name__}("
+            f"reason={_reason!r}, "
+            f")"
+        )
+
+    def __str__(self):
+        """Return a human-readable string representation."""
+        _reason=(
+            self.reason
+            if hasattr(self, "reason")
+            else None
+        )
+        return (
+            f"{self.__class__.__name__}("
+            f"reason={_reason!s}, "
+            f")"
+        )

spotifywebapi/models/type_2_enum.py

@@ -0,0 +1,56 @@
+"""spotifywebapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: E501
+
+class Type2Enum(object):
+    """Implementation of the 'Type2' enum.
+
+    The object type.
+
+    Attributes:
+        ALBUM: The enum member of type str.
+
+    """
+
+    _all_values = ["album"]
+    ALBUM = "album"
+
+    @classmethod
+    def validate(cls, value):
+        """Validate value contains in enum
+
+        Args:
+            value: the value to be validated
+
+        Returns:
+            boolean : if value is valid enum values.
+
+        """
+        return value in cls._all_values
+
+    @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/type_3_enum.py

@@ -0,0 +1,56 @@
+"""spotifywebapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: E501
+
+class Type3Enum(object):
+    """Implementation of the 'Type3' enum.
+
+    The object type: "track".
+
+    Attributes:
+        TRACK: The enum member of type str.
+
+    """
+
+    _all_values = ["track"]
+    TRACK = "track"
+
+    @classmethod
+    def validate(cls, value):
+        """Validate value contains in enum
+
+        Args:
+            value: the value to be validated
+
+        Returns:
+            boolean : if value is valid enum values.
+
+        """
+        return value in cls._all_values
+
+    @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/type_4_enum.py

@@ -0,0 +1,56 @@
+"""spotifywebapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: E501
+
+class Type4Enum(object):
+    """Implementation of the 'Type4' enum.
+
+    The object type.
+
+    Attributes:
+        USER: The enum member of type str.
+
+    """
+
+    _all_values = ["user"]
+    USER = "user"
+
+    @classmethod
+    def validate(cls, value):
+        """Validate value contains in enum
+
+        Args:
+            value: the value to be validated
+
+        Returns:
+            boolean : if value is valid enum values.
+
+        """
+        return value in cls._all_values
+
+    @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/type_5_enum.py

@@ -0,0 +1,56 @@
+"""spotifywebapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: E501
+
+class Type5Enum(object):
+    """Implementation of the 'Type5' enum.
+
+    The object type.
+
+    Attributes:
+        EPISODE: The enum member of type str.
+
+    """
+
+    _all_values = ["episode"]
+    EPISODE = "episode"
+
+    @classmethod
+    def validate(cls, value):
+        """Validate value contains in enum
+
+        Args:
+            value: the value to be validated
+
+        Returns:
+            boolean : if value is valid enum values.
+
+        """
+        return value in cls._all_values
+
+    @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/type_6_enum.py

@@ -0,0 +1,56 @@
+"""spotifywebapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: E501
+
+class Type6Enum(object):
+    """Implementation of the 'Type6' enum.
+
+    The object type.
+
+    Attributes:
+        SHOW: The enum member of type str.
+
+    """
+
+    _all_values = ["show"]
+    SHOW = "show"
+
+    @classmethod
+    def validate(cls, value):
+        """Validate value contains in enum
+
+        Args:
+            value: the value to be validated
+
+        Returns:
+            boolean : if value is valid enum values.
+
+        """
+        return value in cls._all_values
+
+    @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/type_8_enum.py

@@ -0,0 +1,42 @@
+"""spotifywebapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: E501
+
+class Type8Enum(object):
+    """Implementation of the 'Type8' enum.
+
+    The object type.
+
+    Attributes:
+        AUDIO_FEATURES: The enum member of type str.
+
+    """
+
+    AUDIO_FEATURES = "audio_features"
+
+    @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/type_9_enum.py

@@ -0,0 +1,42 @@
+"""spotifywebapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: E501
+
+class Type9Enum(object):
+    """Implementation of the 'Type9' enum.
+
+    The object type.
+
+    Attributes:
+        AUDIOBOOK: The enum member of type str.
+
+    """
+
+    AUDIOBOOK = "audiobook"
+
+    @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/type_enum.py

@@ -0,0 +1,56 @@
+"""spotifywebapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: E501
+
+class TypeEnum(object):
+    """Implementation of the 'Type' enum.
+
+    The object type.
+
+    Attributes:
+        ARTIST: The enum member of type str.
+
+    """
+
+    _all_values = ["artist"]
+    ARTIST = "artist"
+
+    @classmethod
+    def validate(cls, value):
+        """Validate value contains in enum
+
+        Args:
+            value: the value to be validated
+
+        Returns:
+            boolean : if value is valid enum values.
+
+        """
+        return value in cls._all_values
+
+    @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/users_playlists_request.py

@@ -0,0 +1,154 @@
+"""spotifywebapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: E501
+from spotifywebapi.api_helper import APIHelper
+
+
+class UsersPlaylistsRequest(object):
+    """Implementation of the 'Users Playlists Request' model.
+
+    Attributes:
+        name (str): The name for the new playlist, for example `"Your Coolest
+            Playlist"`. This name does not need to be unique; a user may have several
+            playlists with the same name.
+        public (bool): Defaults to `true`. If `true` the playlist will be public, if
+            `false` it will be private. To be able to create private playlists, the
+            user must have granted the `playlist-modify-private`
+            [scope](/documentation/web-api/concepts/scopes/#list-of-scopes)
+        collaborative (bool): Defaults to `false`. If `true` the playlist will be
+            collaborative. _**Note**: to create a collaborative playlist you must
+            also set `public` to `false`. To create collaborative playlists you must
+            have granted `playlist-modify-private` and `playlist-modify-public`
+            [scopes](/documentation/web-api/concepts/scopes/#list-of-scopes)._
+        description (str): value for playlist description as displayed in Spotify
+            Clients and in the Web API.
+
+    """
+
+    # Create a mapping from Model property names to API property names
+    _names = {
+        "name": "name",
+        "public": "public",
+        "collaborative": "collaborative",
+        "description": "description",
+    }
+
+    _optionals = [
+        "public",
+        "collaborative",
+        "description",
+    ]
+
+    def __init__(
+        self,
+        name=None,
+        public=APIHelper.SKIP,
+        collaborative=APIHelper.SKIP,
+        description=APIHelper.SKIP):
+        """Initialize a UsersPlaylistsRequest instance."""
+        # Initialize members of the class
+        self.name = name
+        if public is not APIHelper.SKIP:
+            self.public = public
+        if collaborative is not APIHelper.SKIP:
+            self.collaborative = collaborative
+        if description is not APIHelper.SKIP:
+            self.description = description
+
+    @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 None
+        public =\
+            dictionary.get("public")\
+            if "public" in dictionary.keys()\
+                else APIHelper.SKIP
+        collaborative =\
+            dictionary.get("collaborative")\
+            if "collaborative" in dictionary.keys()\
+                else APIHelper.SKIP
+        description =\
+            dictionary.get("description")\
+            if dictionary.get("description")\
+                else APIHelper.SKIP
+
+        # Return an object of this model
+        return cls(name,
+                   public,
+                   collaborative,
+                   description)
+
+    def __repr__(self):
+        """Return a unambiguous string representation."""
+        _name=self.name
+        _public=(
+            self.public
+            if hasattr(self, "public")
+            else None
+        )
+        _collaborative=(
+            self.collaborative
+            if hasattr(self, "collaborative")
+            else None
+        )
+        _description=(
+            self.description
+            if hasattr(self, "description")
+            else None
+        )
+        return (
+            f"{self.__class__.__name__}("
+            f"name={_name!r}, "
+            f"public={_public!r}, "
+            f"collaborative={_collaborative!r}, "
+            f"description={_description!r}, "
+            f")"
+        )
+
+    def __str__(self):
+        """Return a human-readable string representation."""
+        _name=self.name
+        _public=(
+            self.public
+            if hasattr(self, "public")
+            else None
+        )
+        _collaborative=(
+            self.collaborative
+            if hasattr(self, "collaborative")
+            else None
+        )
+        _description=(
+            self.description
+            if hasattr(self, "description")
+            else None
+        )
+        return (
+            f"{self.__class__.__name__}("
+            f"name={_name!s}, "
+            f"public={_public!s}, "
+            f"collaborative={_collaborative!s}, "
+            f"description={_description!s}, "
+            f")"
+        )