wxc_sdk.person_settings.exec_assistant module

exec assistant settings API

class wxc_sdk.person_settings.exec_assistant.ExecAssistantApi(*, session: RestSession, selector: ApiSelector = ApiSelector.person)[source]

Bases: PersonSettingsApiChild

API for person’s exec assistant settings

feature = 'executiveAssistant'
read(person_id: str, org_id: str | None = None) → ExecAssistantType[source]

Retrieve Executive Assistant Settings for a Person

Retrieve the executive assistant settings for the specified personId.

People with the executive service enabled, can select from a pool of assistants who have been assigned the executive assistant service and who can answer or place calls on their behalf. Executive assistants can set the call forward destination and join or leave an executive’s pool.

This API requires a full, user, or read-only administrator auth token with a scope of spark-admin:people_read.

Parameters:

  • person_id (str) – Unique identifier for the person.

  • org_id (str) – Person is in this organization. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.

Returns:

exec assistant setting

Return type:

ExecAssistantType

configure(person_id: str, setting: ExecAssistantType, org_id: str | None = None)[source]

Modify Executive Assistant Settings for a Person

Modify the executive assistant settings for the specified personId.

People with the executive service enabled, can select from a pool of assistants who have been assigned the executive assistant service and who can answer or place calls on their behalf. Executive assistants can set the call forward destination and join or leave an executive’s pool.

This API requires a full or user administrator auth token with the spark-admin:people_write scope.

Parameters:

  • person_id (str) – Unique identifier for the person.

  • setting (ExecAssistantType) – New exex assistant settings

  • org_id (str) – Person is in this organization. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.

base = ''
class wxc_sdk.person_settings.exec_assistant.ExecAssistantType(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, SafeEnum

Indicates the Executive Assistant type.

unassigned = 'UNASSIGNED'

Indicates the feature is not enabled.

executive = 'EXECUTIVE'

Indicates the feature is enabled and the person is an Executive

executive_assistant = 'EXECUTIVE_ASSISTANT'

Indicates the feature is enabled and the person is an Executive Assistant.