wxc_sdk.common package

Common date types and APIs

class wxc_sdk.common.UserType(value)[source]

Bases: str, Enum

An enumeration.

people = 'PEOPLE'
place = 'PLACE'
class wxc_sdk.common.UserBase(*, firstName: str = None, lastName: str = None, type: UserType = None)[source]

Bases: ApiModel

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

first_name: Optional[str]
last_name: Optional[str]
user_type: Optional[UserType]
class wxc_sdk.common.RingPattern(value)[source]

Bases: str, Enum

Ring Pattern

normal = 'NORMAL'

Normal incoming ring pattern.

long_long = 'LONG_LONG'

Incoming ring pattern of two long rings.

short_short_long = 'SHORT_SHORT_LONG'

Incoming ring pattern of two short rings, followed by a short ring.

short_long_short = 'SHORT_LONG_SHORT'

Incoming ring pattern of a short ring, followed by a long ring, followed by a short ring.

class wxc_sdk.common.AlternateNumber(*, phoneNumber: str = None, ringPattern: RingPattern = None, tollFreeNumber: bool = None)[source]

Bases: ApiModel

Hunt group or call queue alternate number

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

phone_number: Optional[str]

Alternate phone number for the hunt group or call queue

ring_pattern: Optional[RingPattern]

Ring pattern for when this alternate number is called. Only available when distinctiveRing is enabled for the hunt group.

toll_free_number: Optional[bool]

phone_number is a toll free number

Type

Flag

class wxc_sdk.common.Greeting(value)[source]

Bases: str, Enum

DEFAULT indicates that a system default message will be placed when incoming calls are intercepted.

custom = 'CUSTOM'

A custom will be placed when incoming calls are intercepted.

default = 'DEFAULT'

A System default message will be placed when incoming calls are intercepted.

class wxc_sdk.common.UserNumber(*, external: str = None, extension: str = None, primary: bool = None)[source]

Bases: ApiModel

phone number of the person or workspace.

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

external: Optional[str]

Phone number of person or workspace. Either phoneNumber or extension is mandatory

extension: Optional[str]

Extension of person or workspace. Either phoneNumber or extension is mandatory.

primary: Optional[bool]

Flag to indicate primary phone.

class wxc_sdk.common.PersonPlaceAgent(*, firstName: str = None, lastName: str = None, type: UserType = None, id: str, displayName: str = None, email: str = None, numbers: list[wxc_sdk.common.UserNumber] = None)[source]

Bases: UserBase

Agent (person or place)

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

agent_id: str

ID of person or workspace.

display_name: Optional[str]

Display name of person or workspace.

email: Optional[str]

Email of the person or workspace.

numbers: Optional[list[wxc_sdk.common.UserNumber]]

List of phone numbers of the person or workspace.

class wxc_sdk.common.MonitoredMember(*, id: str = None, lastName: str = None, firstName: str = None, displayName: str = None, type: UserType = None, email: str = None, numbers: list[wxc_sdk.common.UserNumber] = None)[source]

Bases: ApiModel

a monitored user or place

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

member_id: Optional[str]

The identifier of the monitored person.

last_name: Optional[str]

The last name of the monitored person or place.

first_name: Optional[str]

The first name of the monitored person or place.

display_name: Optional[str]

The display name of the monitored person or place.

member_type: Optional[UserType]

Indicates whether type is PEOPLE or PLACE.

email: Optional[str]

The email address of the monitored person or place.

numbers: Optional[list[wxc_sdk.common.UserNumber]]

The list of phone numbers of the monitored person or place.

property ci_member_id: Optional[str]
class wxc_sdk.common.CallParkExtension(*, id: str = None, name: str = None, extension: str = None, locationName: str = None, locationId: str = None)[source]

Bases: ApiModel

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

cpe_id: Optional[str]

The identifier of the call park extension.

name: Optional[str]

The name to describe the call park extension.

extension: Optional[str]

The extension number for this call park extension.

location_name: Optional[str]

The location name where the call park extension is.

location_id: Optional[str]

The location Id for the location.

property ci_cpe_id: Optional[str]

call park extension ID as UUID

class wxc_sdk.common.AuthCode(*, code: str, description: str)[source]

Bases: ApiModel

authorization codea and description.

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

code: str

Indicates an authorization code.

description: str

Indicates the description of the authorization code.

Submodules