abacusai.organization_group
===========================

.. py:module:: abacusai.organization_group


Classes
-------

.. autoapisummary::

   abacusai.organization_group.OrganizationGroup


Module Contents
---------------

.. py:class:: OrganizationGroup(client, organizationGroupId=None, permissions=None, groupName=None, defaultGroup=None, admin=None, createdAt=None)

   Bases: :py:obj:`abacusai.return_class.AbstractApiClass`


   An Organization Group. Defines the permissions available to the users who are members of the group.

   :param client: An authenticated API Client instance
   :type client: ApiClient
   :param organizationGroupId: The unique identifier of the Organization Group.
   :type organizationGroupId: str
   :param permissions: The list of permissions (VIEW, MODIFY, ADMIN, BILLING, API_KEY, INVITE_USER) the group has.
   :type permissions: list of enum string
   :param groupName: The name of the Organization Group.
   :type groupName: str
   :param defaultGroup: If true, all new users will be added to this group automatically.
   :type defaultGroup: bool
   :param admin: If true, this group contains all permissions available to the organization and cannot be modified or deleted.
   :type admin: bool
   :param createdAt: When the Organization Group was created.
   :type createdAt: str


   .. py:attribute:: organization_group_id
      :value: None



   .. py:attribute:: permissions
      :value: None



   .. py:attribute:: group_name
      :value: None



   .. py:attribute:: default_group
      :value: None



   .. py:attribute:: admin
      :value: None



   .. py:attribute:: created_at
      :value: None



   .. py:attribute:: deprecated_keys


   .. py:method:: __repr__()


   .. py:method:: to_dict()

      Get a dict representation of the parameters in this class

      :returns: The dict value representation of the class parameters
      :rtype: dict



   .. py:method:: refresh()

      Calls describe and refreshes the current object's fields

      :returns: The current object
      :rtype: OrganizationGroup



   .. py:method:: describe()

      Returns the specific organization group passed in by the user.

      :param organization_group_id: The unique identifier of the organization group to be described.
      :type organization_group_id: str

      :returns: Information about a specific organization group.
      :rtype: OrganizationGroup



   .. py:method:: add_permission(permission)

      Adds a permission to the specified Organization Group.

      :param permission: Permission to add to the Organization Group.
      :type permission: str



   .. py:method:: remove_permission(permission)

      Removes a permission from the specified Organization Group.

      :param permission: The permission to remove from the Organization Group.
      :type permission: str



   .. py:method:: delete()

      Deletes the specified Organization Group

      :param organization_group_id: Unique string identifier of the organization group.
      :type organization_group_id: str



   .. py:method:: add_user_to(email)

      Adds a user to the specified Organization Group.

      :param email: Email of the user to be added to the group.
      :type email: str



   .. py:method:: remove_user_from(email)

      Removes a user from an Organization Group.

      :param email: Email of the user to remove.
      :type email: str



   .. py:method:: set_default()

      Sets the default Organization Group to which all new users joining an organization are automatically added.

      :param organization_group_id: Unique string identifier of the Organization Group.
      :type organization_group_id: str