wxc_sdk.person_settings.sim_ring module

class wxc_sdk.person_settings.sim_ring.SimRingCriteria(*, 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)

Bases: SelectiveCriteria

model_post_init(context: Any, /) → None

This function is meant to behave like a BaseModel method to initialise 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.sim_ring.SimRingNumber(*, phoneNumber: Annotated[str, BeforeValidator(func=e164, json_schema_input_type=PydanticUndefined)] | None = None, answerConfirmationRequiredEnabled: bool | None = None, **extra_data: Any)

Bases: ApiModel

phone_number: Annotated[str, BeforeValidator(func=e164, json_schema_input_type=PydanticUndefined)] | None

Phone number set as the sequential number.

answer_confirmation_required_enabled: bool | None

When set to true the called party is required to press 1 on the keypad to receive the call.

class wxc_sdk.person_settings.sim_ring.SimRing(*, enabled: bool | None = None, doNotRingIfOnCallEnabled: bool | None = None, phoneNumbers: list[SimRingNumber] | None = None, criteria: list[SelectiveCrit] | None = None, criteriasEnabled: bool | None = None, **extra_data: Any)

Bases: ApiModel

enabled: bool | None

Simultaneous Ring is enabled or not.

do_not_ring_if_on_call_enabled: bool | None

When set to true, the configured phone numbers won’t ring when on a call.

phone_numbers: list[SimRingNumber] | None

Enter up to 10 phone numbers to ring simultaneously when workspace phone receives an incoming call.

criteria: list[SelectiveCrit] | None

A list of criteria specifying conditions when simultaneous ring is in effect.

criterias_enabled: bool | None

When true, enables the selected schedule for simultaneous ring.

update() → dict

Data for update

:meta private

class wxc_sdk.person_settings.sim_ring.SimRingApi(*, session: RestSession, selector: ApiSelector = ApiSelector.person)

Bases: PersonSettingsApiChild

API for simultaneous ring settings

For now only used for workspaces

feature = 'simultaneousRing'

read_criteria(entity_id: str, id: str, org_id: str | None = None) → SimRingCriteria

Retrieve Simultaneous Ring Criteria for an entity

Retrieve Simultaneous Ring Criteria Settings for an entity.

The Simultaneous Ring feature allows you to configure your office phone and other phones of your choice to ring simultaneously. Simultaneous Ring Criteria (Schedules) can also be set up to ring these phones during certain times of the day or days of the week.

This API requires a full, read-only or location administrator auth token with a scope of spark-admin:workspaces_read or a user auth token with a scope of spark:workspaces_read to read workspace settings.

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:

SimRingCriteria

configure_criteria(entity_id: str, id: str, settings: SimRingCriteria, org_id: str | None = None)

Modify Simultaneous Ring Criteria for an entity

Modify Simultaneous Ring Criteria Settings for an entity.

The Simultaneous Ring feature allows you to configure your office phone and other phones of your choice to ring simultaneously. Simultaneous Ring Criteria (Schedules) can also be set up to ring these phones during certain times of the day or days of the week.

This API requires a full, user or location administrator auth token with the spark-admin:workspaces_write scope or a user auth token with a scope of spark:workspaces_write to update workspace settings.

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 (SimRingCriteria) – 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 = None)

Delete Simultaneous Ring Criteria for an entity

Delete simultaneous ring criteria Settings for an entity.

The Simultaneous Ring feature allows you to configure your office phone and other phones of your choice to ring simultaneously. Simultaneous Ring Criteria (Schedules) can also be set up to ring these phones during certain times of the day or days of the week.

This API requires a full, user or location administrator auth token with the spark-admin:workspaces_write scope or a user auth token with a scope of spark:workspaces_write to update workspace settings.

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: SimRingCriteria, org_id: str | None = None) → str

Create Simultaneous Ring Criteria for an entity

Create Simultaneous Ring Criteria Settings for an entity.

The Simultaneous Ring feature allows you to configure your office phone and other phones of your choice to ring simultaneously. Simultaneous Ring Criteria (Schedules) can also be set up to ring these phones during certain times of the day or days of the week.

This API requires a full, user or location administrator auth token with the spark-admin:workspaces_write scope or a user auth token with a scope of spark:workspaces_write to update workspace settings.

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

Parameters:

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

• settings (SimRingCriteria) – 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 = None) → SimRing

Retrieve Simultaneous Ring Settings for an entity.

The Simultaneous Ring feature allows you to configure your office phone and other phones of your choice to ring simultaneously. Schedules can also be set up to ring these phones during certain times of the day or days of the week.

This API requires a full, read-only or location administrator auth token with a scope of spark-admin:workspaces_read or a user auth token with a scope of spark:workspaces_read to read workspace settings.

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:

SimRing

configure(entity_id: str, settings: SimRing, org_id: str | None = None)

Modify Simultaneous Ring Settings for an entity.

The Simultaneous Ring feature allows you to configure the workspace phones of your choice to ring simultaneously. Schedules can also be set up to ring these phones during certain times of the day or days of the week.

This API requires a full, user or location administrator auth token with the spark-admin:workspaces_write scope or a user auth token with a scope of spark:workspaces_write to update workspace settings.

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

Parameters:

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

• settings (SimRing) – 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 = ''