wxc_sdk.common package

Common date types and APIs

class wxc_sdk.common.UserType(value)

Bases: str, Enum

An enumeration.

people = 'PEOPLE'

place = 'PLACE'

class wxc_sdk.common.UserBase(*, firstName: str = None, lastName: str = None, type: UserType = None)

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)

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)

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)

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)

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)

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)

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)

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)

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.

class wxc_sdk.common.RouteType(value)

Bases: str, Enum

An enumeration.

route_group = 'ROUTE_GROUP'

Route group must include at least one trunk with a maximum of 10 trunks per route group.

trunk = 'TRUNK'

class wxc_sdk.common.DialPatternValidate(*, dialPattern: str, patternStatus: DialPatternStatus, message: str)

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.

dial_pattern: str

input dial pattern that is being validate

pattern_status: DialPatternStatus

validation status.

message: str

failure details.

class wxc_sdk.common.DialPatternStatus(value)

Bases: str, Enum

validation status.

invalid = 'INVALID'

invalid pattern

duplicate = 'DUPLICATE'

duplicate pattern

duplicate_in_list = 'DUPLICATE_IN_LIST'

duplicate in input

class wxc_sdk.common.RouteIdentity(*, id: str, name: str = None, type: RouteType)

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.

route_id: str

name: Optional[str]

route_type: RouteType

class wxc_sdk.common.Customer(*, id: str, name: str)

Bases: ApiModel

Customer information.

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.

customer_id: str

Id of the customer/organization.

name: str

Name of the customer/organization.

class wxc_sdk.common.IdAndName(*, id: str, name: str)

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.

id: str

name: str

class wxc_sdk.common.PatternAction(value)

Bases: str, Enum

An enumeration.

add = 'ADD'

add action, when adding a new dial pattern

delete = 'DELETE'

delete action, when deleting an existing dial pattern

class wxc_sdk.common.NumberState(value)

Bases: str, Enum

An enumeration.

active = 'ACTIVE'

inactive = 'INACTIVE'

class wxc_sdk.common.ValidateExtensionResponseStatus(value)

Bases: str, Enum

An enumeration.

ok = 'OK'

errors = 'ERRORS'

class wxc_sdk.common.ValidateExtensionStatusState(value)

Bases: str, Enum

An enumeration.

valid = 'VALID'

duplicate = 'DUPLICATE'

duplicate_in_list = 'DUPLICATE_IN_LIST'

invalid = 'INVALID'

class wxc_sdk.common.ValidateExtensionStatus(*, extension: str, state: ValidateExtensionStatusState, errorCode: int = None, message: str = None)

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.

extension: str

Indicates the extention Id for which the status is about .

state: ValidateExtensionStatusState

Indicate the status for the given extention id .

error_code: Optional[int]

Error Code .

message: Optional[str]

property ok

class wxc_sdk.common.ValidateExtensionsResponse(*, status: ValidateExtensionResponseStatus, extensionStatus: list[wxc_sdk.common.ValidateExtensionStatus] = None)

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.

status: ValidateExtensionResponseStatus

extension_status: Optional[list[wxc_sdk.common.ValidateExtensionStatus]]

property ok: bool

class wxc_sdk.common.ValidatePhoneNumberStatusState(value)

Bases: str, Enum

An enumeration.

available = 'Available'

This means the phone number is available.

duplicate = 'Duplicate'

This means it’s a duplicate phone number.

duplicate_in_list = 'Duplicate In List'

This means it’s a duplicate phone number in the list.

invalid = 'Invalid'

The phone number is invalid.

unavailable = 'Unavailable'

This phone number is unavailable and cannot be used.

class wxc_sdk.common.ValidatePhoneNumberStatus(*, phoneNumber: str, state: ValidatePhoneNumberStatusState, tollFreeNumber: bool, detail: list[str] = None)

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.

phone_number: str

Phone number that need to be validated.

state: ValidatePhoneNumberStatusState

This indicates the state of the number.

toll_free_number: bool

This indicated whether it’s a toll-free number

detail: list[str]

This field has the details if error if the number is unavailable.

property ok

class wxc_sdk.common.ValidatePhoneNumbersResponse(*, status: ValidateExtensionResponseStatus, phoneNumbers: list[wxc_sdk.common.ValidatePhoneNumberStatus] = None)

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.

status: ValidateExtensionResponseStatus

This indicates the status of the numbers.

phone_numbers: Optional[list[wxc_sdk.common.ValidatePhoneNumberStatus]]

This is an array of number objects with number details.

property ok: bool

Submodules

• wxc_sdk.common.schedules module