wxc_sdk.person_settings.selective_reject module

class wxc_sdk.person_settings.selective_reject.SelectiveRejectCriteria(*, 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[str] | 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 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.selective_reject.SelectiveReject(*, enabled: bool | None = None, criteria: list[SelectiveCrit] | None = None, **extra_data: Any)[source]

Bases: ApiModel

enabled: bool | None

true if the Selective Reject feature is enabled.

criteria: list[SelectiveCrit] | None

A list of criteria specifying conditions when selective reject is in effect.

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

Bases: PersonSettingsApiChild

API for selective reject settings

For now only used for workspaces

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

Retrieve Selective Reject Criteria for an entity

Retrieve Selective Reject Criteria Settings for an entity.

With the Selective Reject feature, you can reject calls at specific times from specific callers. This setting takes precedence over Selectively Accept Calls. Schedules can also be set up for this feature 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:

SelectiveRejectCriteria

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

Modify Selective Reject Criteria for an entity

Modify Selective Reject Criteria Settings for an entity.

With the Selective Reject feature, you can reject calls at specific times from specific callers. This setting takes precedence over Selectively Accept Calls. Schedules can also be set up for this feature 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 (SelectiveRejectCriteria) – 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)[source]

Delete Selective Reject Criteria for an entity

Delete Selective Reject criteria Settings for an entity.

With the Selective Reject feature, you can reject calls at specific times from specific callers. This setting takes precedence over Selectively Accept Calls. Schedules can also be set up for this feature 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: SelectiveRejectCriteria, org_id: str | None = None) → str[source]

Create Selective Reject Criteria for an entity

Create Selective Reject Criteria Settings for an entity.

With the Selective Reject feature, you can reject calls at specific times from specific callers. This setting takes precedence over Selectively Accept Calls. Schedules can also be set up for this feature 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.

  • settings (SelectiveRejectCriteria) – 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) → SelectiveReject[source]

Retrieve Selective Reject Settings for an entity.

With the Selective Reject feature, you can reject calls at specific times from specific callers. This setting takes precedence over Selectively Accept Calls. Schedules can also be set up for this feature 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.

  • 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:

SelectiveReject

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

Modify Selective Reject Settings for an entity.

With the Selective Reject feature, you can reject calls at specific times from specific callers. This setting takes precedence over Selectively Accept Calls. Schedules can also be set up for this feature 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.

  • settings (SelectiveReject) – 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

base = ''