:py:mod:`vendor_fabric.google.workspace`
========================================

.. py:module:: vendor_fabric.google.workspace

.. autodoc2-docstring:: vendor_fabric.google.workspace
   :parser: myst
   :allowtitles:

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

Classes
~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`GoogleWorkspaceMixin <vendor_fabric.google.workspace.GoogleWorkspaceMixin>`
     - .. autodoc2-docstring:: vendor_fabric.google.workspace.GoogleWorkspaceMixin
          :parser: myst
          :summary:

API
~~~

.. py:class:: GoogleWorkspaceMixin
   :canonical: vendor_fabric.google.workspace.GoogleWorkspaceMixin

   .. autodoc2-docstring:: vendor_fabric.google.workspace.GoogleWorkspaceMixin
      :parser: myst

   .. py:method:: list_workspace_users(domain: str | None = None, max_results: int = 500, unhump_users: bool = False, subject: str | None = None) -> extended_data.containers.ExtendedList[extended_data.containers.ExtendedDict]
      :canonical: vendor_fabric.google.workspace.GoogleWorkspaceMixin.list_workspace_users

      .. autodoc2-docstring:: vendor_fabric.google.workspace.GoogleWorkspaceMixin.list_workspace_users
         :parser: myst

   .. py:method:: get_user(user_key: str, subject: str | None = None) -> extended_data.containers.ExtendedDict | None
      :canonical: vendor_fabric.google.workspace.GoogleWorkspaceMixin.get_user

      .. autodoc2-docstring:: vendor_fabric.google.workspace.GoogleWorkspaceMixin.get_user
         :parser: myst

   .. py:method:: create_user(primary_email: str, given_name: str, family_name: str, password: str | None = None, change_password_at_next_login: bool = True, org_unit_path: str = '/', subject: str | None = None, **additional_fields: typing.Any) -> extended_data.containers.ExtendedDict
      :canonical: vendor_fabric.google.workspace.GoogleWorkspaceMixin.create_user

      .. autodoc2-docstring:: vendor_fabric.google.workspace.GoogleWorkspaceMixin.create_user
         :parser: myst

   .. py:method:: update_user(user_key: str, subject: str | None = None, **fields: typing.Any) -> extended_data.containers.ExtendedDict
      :canonical: vendor_fabric.google.workspace.GoogleWorkspaceMixin.update_user

      .. autodoc2-docstring:: vendor_fabric.google.workspace.GoogleWorkspaceMixin.update_user
         :parser: myst

   .. py:method:: delete_user(user_key: str, subject: str | None = None) -> None
      :canonical: vendor_fabric.google.workspace.GoogleWorkspaceMixin.delete_user

      .. autodoc2-docstring:: vendor_fabric.google.workspace.GoogleWorkspaceMixin.delete_user
         :parser: myst

   .. py:method:: list_workspace_groups(domain: str | None = None, max_results: int = 200, unhump_groups: bool = False, subject: str | None = None) -> extended_data.containers.ExtendedList[extended_data.containers.ExtendedDict]
      :canonical: vendor_fabric.google.workspace.GoogleWorkspaceMixin.list_workspace_groups

      .. autodoc2-docstring:: vendor_fabric.google.workspace.GoogleWorkspaceMixin.list_workspace_groups
         :parser: myst

   .. py:method:: get_group(group_key: str, subject: str | None = None) -> extended_data.containers.ExtendedDict | None
      :canonical: vendor_fabric.google.workspace.GoogleWorkspaceMixin.get_group

      .. autodoc2-docstring:: vendor_fabric.google.workspace.GoogleWorkspaceMixin.get_group
         :parser: myst

   .. py:method:: create_group(email: str, name: str, description: str = '', subject: str | None = None) -> extended_data.containers.ExtendedDict
      :canonical: vendor_fabric.google.workspace.GoogleWorkspaceMixin.create_group

      .. autodoc2-docstring:: vendor_fabric.google.workspace.GoogleWorkspaceMixin.create_group
         :parser: myst

   .. py:method:: delete_group(group_key: str, subject: str | None = None) -> None
      :canonical: vendor_fabric.google.workspace.GoogleWorkspaceMixin.delete_group

      .. autodoc2-docstring:: vendor_fabric.google.workspace.GoogleWorkspaceMixin.delete_group
         :parser: myst

   .. py:method:: list_group_members(group_key: str, roles: list[str] | None = None, unhump_members: bool = False, subject: str | None = None) -> extended_data.containers.ExtendedList[extended_data.containers.ExtendedDict]
      :canonical: vendor_fabric.google.workspace.GoogleWorkspaceMixin.list_group_members

      .. autodoc2-docstring:: vendor_fabric.google.workspace.GoogleWorkspaceMixin.list_group_members
         :parser: myst

   .. py:method:: add_group_member(group_key: str, email: str, role: str = 'MEMBER', subject: str | None = None) -> extended_data.containers.ExtendedDict
      :canonical: vendor_fabric.google.workspace.GoogleWorkspaceMixin.add_group_member

      .. autodoc2-docstring:: vendor_fabric.google.workspace.GoogleWorkspaceMixin.add_group_member
         :parser: myst

   .. py:method:: remove_group_member(group_key: str, member_key: str, subject: str | None = None) -> None
      :canonical: vendor_fabric.google.workspace.GoogleWorkspaceMixin.remove_group_member

      .. autodoc2-docstring:: vendor_fabric.google.workspace.GoogleWorkspaceMixin.remove_group_member
         :parser: myst

   .. py:method:: list_org_units(org_unit_path: str = '/', org_unit_type: str = 'all', subject: str | None = None) -> extended_data.containers.ExtendedList[extended_data.containers.ExtendedDict]
      :canonical: vendor_fabric.google.workspace.GoogleWorkspaceMixin.list_org_units

      .. autodoc2-docstring:: vendor_fabric.google.workspace.GoogleWorkspaceMixin.list_org_units
         :parser: myst

   .. py:method:: create_or_update_user(primary_email: str, given_name: str, family_name: str, password: str | None = None, update_if_exists: bool = False, change_password_at_next_login: bool = True, org_unit_path: str = '/', subject: str | None = None, **additional_fields: typing.Any) -> extended_data.containers.ExtendedDict
      :canonical: vendor_fabric.google.workspace.GoogleWorkspaceMixin.create_or_update_user

      .. autodoc2-docstring:: vendor_fabric.google.workspace.GoogleWorkspaceMixin.create_or_update_user
         :parser: myst

   .. py:method:: create_or_update_group(email: str, name: str, description: str = '', update_if_exists: bool = False, subject: str | None = None, **additional_fields: typing.Any) -> extended_data.containers.ExtendedDict
      :canonical: vendor_fabric.google.workspace.GoogleWorkspaceMixin.create_or_update_group

      .. autodoc2-docstring:: vendor_fabric.google.workspace.GoogleWorkspaceMixin.create_or_update_group
         :parser: myst

   .. py:method:: list_available_licenses(customer_id: str = 'my_customer', product_id: str | None = None, subject: str | None = None) -> extended_data.containers.ExtendedList[extended_data.containers.ExtendedDict]
      :canonical: vendor_fabric.google.workspace.GoogleWorkspaceMixin.list_available_licenses

      .. autodoc2-docstring:: vendor_fabric.google.workspace.GoogleWorkspaceMixin.list_available_licenses
         :parser: myst

   .. py:method:: get_license_summary(customer_id: str = 'my_customer', subject: str | None = None) -> extended_data.containers.ExtendedDict
      :canonical: vendor_fabric.google.workspace.GoogleWorkspaceMixin.get_license_summary

      .. autodoc2-docstring:: vendor_fabric.google.workspace.GoogleWorkspaceMixin.get_license_summary
         :parser: myst