Source code for contentful_management.environment_resource_proxy

"""
contentful_management.environment_resource_proxy
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

This module implements the EnvironmentResourceProxy class.

:copyright: (c) 2018 by Contentful GmbH.
:license: MIT, see LICENSE for more details.
"""



[docs]class EnvironmentResourceProxy(object):
    """
    Base class for environment related resource proxies.
    """

    def __init__(self, client, space_id, environment_id):
        self.proxy = self._resource_proxy_class()(client, space_id, environment_id=environment_id)

    def __repr__(self):
        return "<{0} space_id='{1}' environment_id='{2}'>".format(
            self.__class__.__name__,
            self.proxy.space_id,
            self.proxy.environment_id
        )

    def _resource_proxy_class(self):
        raise Exception("Must implement")


[docs]    def all(self, query=None):
        """
        Gets all resources related to the current space.
        """

        return self.proxy.all(query)



[docs]    def find(self, resource_id, query=None):
        """
        Finds a single resource by ID related to the current space.
        """

        return self.proxy.find(resource_id, query=query)



[docs]    def create(self, resource_id=None, attributes=None):
        """
        Creates a resource with a given ID (optional) and attributes for the current space.
        """

        return self.proxy.create(resource_id=resource_id, attributes=attributes)



[docs]    def delete(self, resource_id):
        """
        Deletes a resource by ID.
        """

        return self.proxy.delete(resource_id)