Source code for contentful_management.organization

from .resource import Resource
from .space_periodic_usages_proxy import SpacePeriodicUsagesProxy
from .organization_periodic_usages_proxy import OrganizationPeriodicUsagesProxy
from .organization_users_proxy import OrganizationUsersProxy


"""
contentful_management.organization
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

This module implements the Organization class.

API reference: https://www.contentful.com/developers/docs/references/content-management-api/#/reference/organizations

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


[docs]class Organization(Resource): """ API reference: https://www.contentful.com/developers/docs/references/content-management-api/#/reference/organizations """ def __init__(self, item, **kwargs): super(Organization, self).__init__(item, **kwargs) self.name = item.get('name', '')
[docs] @classmethod def base_url(klass, *args, **kwargs): """ Returns the URI for the organization. """ return "organizations"
[docs] def periodic_usages(self): """ Provides access to organization periodic usages management methods. API reference: https://www.contentful.com/developers/docs/references/content-management-api/#/reference/usage :return: :class:`OrganizationPeriodicUsagesProxy <contentful_management.organization_periodic_usages_proxy.OrganizationPeriodicUsagesProxy>` object. :rtype: contentful.organization_periodic_usages_proxy.OrganizationPeriodicUsagesProxy Usage: >>> organization_periodic_usages_proxy = organization.usage_periods() <OrganizationPeriodicUsagesProxy organization_id="cfexampleapi"> """ return OrganizationPeriodicUsagesProxy(self._client, self.id)
[docs] def space_periodic_usages(self): """ Provides access to organization periodic usages grouped by space management methods. API reference: https://www.contentful.com/developers/docs/references/content-management-api/#/reference/usage :return: :class:`SpacePeriodicUsagesProxy<contentful_management.space_periodic_usages_proxy.SpacePeriodicUsagesProxy>` object. :rtype: contentful.space_periodic_usages_proxy.SpacePeriodicUsagesProxy Usage: >>> space_periodic_usages_proxy = organization.space_usage_periods() <SpacePeriodicUsagesProxyorganization_id="cfexampleapi"> """ return SpacePeriodicUsagesProxy(self._client, self.id)
[docs] def users(self): """ Provides access to organization users management methods. API reference: https://www.contentful.com/developers/docs/references/user-management-api/#/reference/users :return: :class:`OrganizationUsersProxy <contentful_management.organization_users_proxy.OrganizationUsersProxy>` object. :rtype: contentful.organization_users_proxy.OrganizationUsersProxy Usage: >>> organization_users_proxy = organization.users() <OrganizationUsersProxy organization_id="cfexampleapi"> """ return OrganizationUsersProxy(self._client, self.id)
def __repr__(self): return "<Organization[{0}] id='{1}'>".format( self.name, self.id )