Source code for boxsdk.object.enterprise

# coding: utf-8
from __future__ import unicode_literals, absolute_import

import json

from .base_object import BaseObject
from ..util.api_call_decorator import api_call

[docs]class Enterprise(BaseObject): """Represents a Box file version retention.""" _item_type = 'enterprise'
[docs] @api_call def invite_user(self, user_email): """ Invites an existing user to an Enterprise. The user must already have a Box account. :param user_email: The login email address of the user that will receive the invitation. :type user_email: `unicode` :returns: The invitation record for the user :rtype: :class:`Invite` """ url = self._session.get_url('invites') body = { 'enterprise': { 'id': self.object_id, }, 'actionable_by': { 'login': user_email, }, } response =, data=json.dumps(body)).json() return self.translator.translate( session=self._session, response_object=response, )