Collections

Bases: TMDB

Collections functionality.

See: https://developers.themoviedb.org/3/collections

Source code in src/tmdb_client_py/movies.py

class Collections(TMDB):
    """
    Collections functionality.

    See: https://developers.themoviedb.org/3/collections
    """

    BASE_PATH = "collection"
    URLS = {
        "info": "/{id}",
        "images": "/{id}/images",
        "translations": "/{id}/translations",
    }

    def __init__(self, id):
        super().__init__()
        self.id = id

    def info(self, **kwargs):
        """
        Get collection details by id.

        Args:
            language: (optional) ISO 639-1 code.

        Returns:
            A dict representation of the JSON returned from the API.
        """
        path = self._get_id_path("info")

        response = self._GET(path, kwargs)
        self._set_attrs_to_values(response)
        return response

    def images(self, **kwargs):
        """
        Get the images for a collection by id.

        Args:
            language: (optional) ISO 639-1 code.

        Returns:
            A dict representation of the JSON returned from the API.
        """
        path = self._get_id_path("images")

        response = self._GET(path, kwargs)
        self._set_attrs_to_values(response)
        return response

    def translations(self, **kwargs):
        """
        Get a list of the translations for a collection by id.

        Args:
            language: (optional) ISO 639-1 code.

        Returns:
            A dict representation of the JSON returned from the API.
        """
        path = self._get_id_path("translations")

        response = self._GET(path, kwargs)
        self._set_attrs_to_values(response)
        return response

images(**kwargs)

Get the images for a collection by id.

Parameters:

Name	Type	Description	Default
language		(optional) ISO 639-1 code.	required

Returns:

Type	Description
	A dict representation of the JSON returned from the API.

Source code in src/tmdb_client_py/movies.py

def images(self, **kwargs):
    """
    Get the images for a collection by id.

    Args:
        language: (optional) ISO 639-1 code.

    Returns:
        A dict representation of the JSON returned from the API.
    """
    path = self._get_id_path("images")

    response = self._GET(path, kwargs)
    self._set_attrs_to_values(response)
    return response

info(**kwargs)

Get collection details by id.

Parameters:

Name	Type	Description	Default
language		(optional) ISO 639-1 code.	required

Returns:

Type	Description
	A dict representation of the JSON returned from the API.

Source code in src/tmdb_client_py/movies.py

def info(self, **kwargs):
    """
    Get collection details by id.

    Args:
        language: (optional) ISO 639-1 code.

    Returns:
        A dict representation of the JSON returned from the API.
    """
    path = self._get_id_path("info")

    response = self._GET(path, kwargs)
    self._set_attrs_to_values(response)
    return response

translations(**kwargs)

Get a list of the translations for a collection by id.

Parameters:

Name	Type	Description	Default
language		(optional) ISO 639-1 code.	required

Returns:

Type	Description
	A dict representation of the JSON returned from the API.

Source code in src/tmdb_client_py/movies.py

def translations(self, **kwargs):
    """
    Get a list of the translations for a collection by id.

    Args:
        language: (optional) ISO 639-1 code.

    Returns:
        A dict representation of the JSON returned from the API.
    """
    path = self._get_id_path("translations")

    response = self._GET(path, kwargs)
    self._set_attrs_to_values(response)
    return response