wxc_sdk.person_settings.priority_alert module

class wxc_sdk.person_settings.priority_alert.PriorityAlertCriteria(*, id: str | None = None, scheduleName: str | None = None, scheduleType: ScheduleType | None = None, scheduleLevel: SelectiveScheduleLevel | None = None, callsFrom: SelectiveFrom | None = None, anonymousCallersEnabled: bool | None = None, unavailableCallersEnabled: bool | None = None, phoneNumbers: list[Annotated[str, BeforeValidator(func=e164, json_schema_input_type=PydanticUndefined)]] | None = None, enabled: bool | None = None, **extra_data: Any)[source]

Bases: SelectiveCriteria

model_post_init(context: Any, /) → None

This function is meant to behave like a BaseModel method to initialize private attributes.

It takes context as an argument since that’s what pydantic-core passes when calling it.

Parameters:

  • self – The BaseModel instance.

  • context – The context.

class wxc_sdk.person_settings.priority_alert.PriorityAlert(*, enabled: bool | None = None, criteria: list[SelectiveCrit] | None = None, **extra_data: Any)[source]

Bases: ApiModel

enabled: bool | None

true if the Priority Alert feature is enabled.

criteria: list[SelectiveCrit] | None

A list of criteria specifying conditions when priority alert is in effect.

update() → dict[source]

Data for update

:meta private

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

Bases: PersonSettingsApiChild

API for priority alert settings

For now only used for workspaces

feature: str | None = 'priorityAlert'
read_criteria(entity_id: str, id: str, org_id: str = None) → PriorityAlertCriteria[source]

Retrieve Priority Alert Criteria for a Workspace

Retrieve Priority Alert Criteria Settings for a Workspace.

The priority alert feature enables administrators to configure priority alert settings for a professional workspace.

Priority Alert Criteria (Schedules) can also be set up to alert these phones during certain times of the day or days of the week.

NOTE: This API is only available for professional licensed workspaces.

Parameters:

  • entity_id (str) – Unique identifier for the entity.

  • id (str) – Unique identifier for the criteria.

  • org_id (str) – ID of the organization within which the entity resides. 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.

Return type:

PriorityAlertCriteria

configure_criteria(entity_id: str, id: str, settings: PriorityAlertCriteria, org_id: str = None)[source]

Modify Priority Alert Criteria for a Workspace

Modify Priority Alert Criteria Settings for a Workspace.

The priority alert feature enables administrators to configure priority alert settings for a professional workspace.

Priority Alert Criteria (Schedules) can also be set up to alert these phones during certain times of the day or days of the week.

NOTE: This API is only available for professional licensed workspaces.

Parameters:

  • entity_id (str) – Unique identifier for the entity.

  • id (str) – Unique identifier for the criteria.

  • settings (PriorityAlertCriteria) – new settings to be applied.

  • org_id (str) – ID of the organization within which the entity resides. 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.

Return type:

None

delete_criteria(entity_id: str, id: str, org_id: str = None)[source]

Delete Priority Alert Criteria for a Workspace

Delete Priority Alert criteria Settings for a workspace.

The priority alert feature enables administrators to configure priority alert settings for a professional workspace.

Priority Alert Criteria (Schedules) can also be set up to alert these phones during certain times of the day or days of the week.

NOTE: This API is only available for professional licensed workspaces.

Parameters:

  • entity_id (str) – Unique identifier for the entity.

  • id (str) – Unique identifier for the criteria.

  • org_id (str) – ID of the organization within which the entity resides. 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.

Return type:

None

create_criteria(entity_id: str, settings: PriorityAlertCriteria, org_id: str = None) → str[source]

Create Priority Alert Criteria for a Workspace

Create Priority Alert Criteria Settings for a Workspace.

The priority alert feature enables administrators to configure priority alert settings for a professional workspace.

Priority Alert Criteria (Schedules) can also be set up to alert these phones during certain times of the day or days of the week.

Parameters:

  • entity_id (str) – Unique identifier for the entity.

  • settings (PriorityAlertCriteria) – new settings to be applied.

  • org_id (str) – ID of the organization within which the entity resides. 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.

Return type:

str

read(entity_id: str, org_id: str = None) → PriorityAlert[source]

Retrieve Priority Alert Settings for a Workspace.

The priority alert feature enables administrators to configure priority alert settings for a professional workspace.

NOTE: This API is only available for professional licensed workspaces.

Parameters:

  • entity_id (str) – Unique identifier for the entity.

  • org_id (str) – ID of the organization within which the entity resides. 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.

Return type:

PriorityAlert

configure(entity_id: str, settings: PriorityAlert, org_id: str = None)[source]

Configure Priority Alert Settings for a Workspace

Configure a workspace Priority Alert Settings.

The priority alert feature enables administrator to configure priority alert settings for a professional workspace.

NOTE: This API is only available for professional licensed workspaces.

Parameters:

  • entity_id (str) – Unique identifier for the entity.

  • settings (PriorityAlert) – Settings for new criteria

  • org_id (str) – ID of the organization within which the entity resides. 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.

Return type:

None

base = ''