wxc_sdk.common package
Common date types and APIs
- class wxc_sdk.common.UserType(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]
Bases:
str
,SafeEnum
An enumeration.
- people = 'PEOPLE'
- place = 'PLACE'
- virtual_line = 'VIRTUAL_LINE'
- class wxc_sdk.common.UserBase(*, firstName: str | None = None, lastName: str | None = None, type: UserType | None = None)[source]
Bases:
ApiModel
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.
__init__ uses __pydantic_self__ instead of the more common self for the first arg to allow self as a field name.
- first_name: str | None
- last_name: str | None
- model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'extra': 'forbid', 'populate_by_name': True, 'use_enum_values': True}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'first_name': FieldInfo(annotation=Union[str, NoneType], required=False, alias='firstName', alias_priority=1), 'last_name': FieldInfo(annotation=Union[str, NoneType], required=False, alias='lastName', alias_priority=1), 'user_type': FieldInfo(annotation=Union[UserType, NoneType], required=False, alias='type', alias_priority=2)}
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- class wxc_sdk.common.RingPattern(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]
Bases:
str
,SafeEnum
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 = None, ringPattern: RingPattern | None = None, tollFreeNumber: bool | None = 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][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.
__init__ uses __pydantic_self__ instead of the more common self for the first arg to allow self as a field name.
- phone_number: str | None
Alternate phone number for the hunt group or call queue
- ring_pattern: RingPattern | None
Ring pattern for when this alternate number is called. Only available when distinctiveRing is enabled for the hunt group.
- toll_free_number: bool | None
phone_number is a toll free number
- Type:
Flag
- model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'extra': 'forbid', 'populate_by_name': True, 'use_enum_values': True}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'phone_number': FieldInfo(annotation=Union[str, NoneType], required=False, alias='phoneNumber', alias_priority=1), 'ring_pattern': FieldInfo(annotation=Union[RingPattern, NoneType], required=False, alias='ringPattern', alias_priority=1), 'toll_free_number': FieldInfo(annotation=Union[bool, NoneType], required=False, alias='tollFreeNumber', alias_priority=1)}
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- class wxc_sdk.common.Greeting(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]
Bases:
str
,SafeEnum
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 = None, extension: str | None = None, primary: bool | None = 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][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.
__init__ uses __pydantic_self__ instead of the more common self for the first arg to allow self as a field name.
- external: str | None
Phone number of person or workspace. Either phoneNumber or extension is mandatory
- extension: str | None
Extension of person or workspace. Either phoneNumber or extension is mandatory.
- primary: bool | None
Flag to indicate primary phone.
- model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'extra': 'forbid', 'populate_by_name': True, 'use_enum_values': True}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'extension': FieldInfo(annotation=Union[str, NoneType], required=False, alias='extension', alias_priority=1), 'external': FieldInfo(annotation=Union[str, NoneType], required=False, alias='external', alias_priority=1), 'primary': FieldInfo(annotation=Union[bool, NoneType], required=False, alias='primary', alias_priority=1)}
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- class wxc_sdk.common.PersonPlaceAgent(*, firstName: str | None = None, lastName: str | None = None, type: UserType | None = None, id: str, displayName: str | None = None, email: str | None = None, numbers: list[UserNumber] | None = None, location: IdAndName | None = None)[source]
Bases:
UserBase
Agent (person or place)
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.
__init__ uses __pydantic_self__ instead of the more common self for the first arg to allow self as a field name.
- agent_id: str
ID of person or workspace.
- display_name: str | None
Display name of person or workspace.
- email: str | None
Email of the person or workspace.
- numbers: list[UserNumber] | None
List of phone numbers of the person or workspace.
- model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'extra': 'forbid', 'populate_by_name': True, 'use_enum_values': True}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'agent_id': FieldInfo(annotation=str, required=True, alias='id', alias_priority=2), 'display_name': FieldInfo(annotation=Union[str, NoneType], required=False, alias='displayName', alias_priority=1), 'email': FieldInfo(annotation=Union[str, NoneType], required=False, alias='email', alias_priority=1), 'first_name': FieldInfo(annotation=Union[str, NoneType], required=False, alias='firstName', alias_priority=1), 'last_name': FieldInfo(annotation=Union[str, NoneType], required=False, alias='lastName', alias_priority=1), 'location': FieldInfo(annotation=Union[IdAndName, NoneType], required=False, alias='location', alias_priority=1), 'numbers': FieldInfo(annotation=Union[list[UserNumber], NoneType], required=False, alias='numbers', alias_priority=1), 'user_type': FieldInfo(annotation=Union[UserType, NoneType], required=False, alias='type', alias_priority=2)}
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- class wxc_sdk.common.MonitoredMember(*, id: str | None = None, lastName: str | None = None, firstName: str | None = None, displayName: str | None = None, type: UserType | None = None, email: str | None = None, numbers: list[UserNumber] | None = None, location: str | IdAndName | None = None)[source]
Bases:
ApiModel
a monitored user or place
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.
__init__ uses __pydantic_self__ instead of the more common self for the first arg to allow self as a field name.
- member_id: str | None
The identifier of the monitored person.
- last_name: str | None
The last name of the monitored person or place.
- first_name: str | None
The first name of the monitored person or place.
- display_name: str | None
The display name of the monitored person or place.
- email: str | None
The email address of the monitored person or place.
- numbers: list[UserNumber] | None
The list of phone numbers of the monitored person or place.
- property ci_member_id: str | None
- property location_name: str
Apparently location attribute is either the location name or an IdAndName instance
- model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'extra': 'forbid', 'populate_by_name': True, 'use_enum_values': True}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'display_name': FieldInfo(annotation=Union[str, NoneType], required=False, alias='displayName', alias_priority=1), 'email': FieldInfo(annotation=Union[str, NoneType], required=False, alias='email', alias_priority=1), 'first_name': FieldInfo(annotation=Union[str, NoneType], required=False, alias='firstName', alias_priority=1), 'last_name': FieldInfo(annotation=Union[str, NoneType], required=False, alias='lastName', alias_priority=1), 'location': FieldInfo(annotation=Union[str, IdAndName, NoneType], required=False, alias='location', alias_priority=1), 'member_id': FieldInfo(annotation=Union[str, NoneType], required=False, alias='id', alias_priority=2), 'member_type': FieldInfo(annotation=Union[UserType, NoneType], required=False, alias='type', alias_priority=2), 'numbers': FieldInfo(annotation=Union[list[UserNumber], NoneType], required=False, alias='numbers', alias_priority=1)}
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- class wxc_sdk.common.CallParkExtension(*, id: str | None = None, name: str | None = None, extension: str | None = None, locationName: str | None = None, locationId: str | None = None)[source]
Bases:
ApiModel
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.
__init__ uses __pydantic_self__ instead of the more common self for the first arg to allow self as a field name.
- cpe_id: str | None
The identifier of the call park extension.
- name: str | None
The name to describe the call park extension.
- extension: str | None
The extension number for this call park extension.
- location_name: str | None
The location name where the call park extension is.
- location_id: str | None
The location ID for the location.
- property ci_cpe_id: str | None
call park extension ID as UUID
- model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'extra': 'forbid', 'populate_by_name': True, 'use_enum_values': True}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'cpe_id': FieldInfo(annotation=Union[str, NoneType], required=False, alias='id', alias_priority=2), 'extension': FieldInfo(annotation=Union[str, NoneType], required=False, alias='extension', alias_priority=1), 'location_id': FieldInfo(annotation=Union[str, NoneType], required=False, alias='locationId', alias_priority=1), 'location_name': FieldInfo(annotation=Union[str, NoneType], required=False, alias='locationName', alias_priority=1), 'name': FieldInfo(annotation=Union[str, NoneType], required=False, alias='name', alias_priority=1)}
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- class wxc_sdk.common.AuthCode(*, code: str, description: str)[source]
Bases:
ApiModel
authorization code and description.
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.
__init__ uses __pydantic_self__ instead of the more common self for the first arg to allow self as a field name.
- code: str
Indicates an authorization code.
- description: str
Indicates the description of the authorization code.
- model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'extra': 'forbid', 'populate_by_name': True, 'use_enum_values': True}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'code': FieldInfo(annotation=str, required=True, alias='code', alias_priority=1), 'description': FieldInfo(annotation=str, required=True, alias='description', alias_priority=1)}
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- class wxc_sdk.common.RouteType(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]
Bases:
str
,SafeEnum
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)[source]
Bases:
ApiModel
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.
__init__ uses __pydantic_self__ instead of the more common self for the first arg to allow self as a field name.
- dial_pattern: str
input dial pattern that is being validate
- pattern_status: DialPatternStatus
validation status.
- message: str
failure details.
- model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'extra': 'forbid', 'populate_by_name': True, 'use_enum_values': True}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'dial_pattern': FieldInfo(annotation=str, required=True, alias='dialPattern', alias_priority=1), 'message': FieldInfo(annotation=str, required=True, alias='message', alias_priority=1), 'pattern_status': FieldInfo(annotation=DialPatternStatus, required=True, alias='patternStatus', alias_priority=1)}
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- class wxc_sdk.common.DialPatternStatus(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]
Bases:
str
,SafeEnum
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 = None, type: RouteType)[source]
Bases:
ApiModel
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.
__init__ uses __pydantic_self__ instead of the more common self for the first arg to allow self as a field name.
- route_id: str
- name: str | None
- model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'extra': 'forbid', 'populate_by_name': True, 'use_enum_values': True}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'name': FieldInfo(annotation=Union[str, NoneType], required=False, alias='name', alias_priority=1), 'route_id': FieldInfo(annotation=str, required=True, alias='id', alias_priority=2), 'route_type': FieldInfo(annotation=RouteType, required=True, alias='type', alias_priority=2)}
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- class wxc_sdk.common.Customer(*, id: str, name: str)[source]
Bases:
ApiModel
Customer information.
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.
__init__ uses __pydantic_self__ instead of the more common self for the first arg to allow self as a field name.
- customer_id: str
ID of the customer/organization.
- name: str
Name of the customer/organization.
- model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'extra': 'forbid', 'populate_by_name': True, 'use_enum_values': True}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'customer_id': FieldInfo(annotation=str, required=True, alias='id', alias_priority=2), 'name': FieldInfo(annotation=str, required=True, alias='name', alias_priority=1)}
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- class wxc_sdk.common.IdOnly(*, id: str)[source]
Bases:
ApiModel
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.
__init__ uses __pydantic_self__ instead of the more common self for the first arg to allow self as a field name.
- id: str
- model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'extra': 'forbid', 'populate_by_name': True, 'use_enum_values': True}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'id': FieldInfo(annotation=str, required=True, alias='id', alias_priority=1)}
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- class wxc_sdk.common.IdAndName(*, id: str, name: str)[source]
Bases:
IdOnly
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.
__init__ uses __pydantic_self__ instead of the more common self for the first arg to allow self as a field name.
- name: str
- model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'extra': 'forbid', 'populate_by_name': True, 'use_enum_values': True}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'id': FieldInfo(annotation=str, required=True, alias='id', alias_priority=1), 'name': FieldInfo(annotation=str, required=True, alias='name', alias_priority=1)}
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- class wxc_sdk.common.PatternAction(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]
Bases:
str
,SafeEnum
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=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]
Bases:
str
,SafeEnum
An enumeration.
- active = 'ACTIVE'
- inactive = 'INACTIVE'
- class wxc_sdk.common.ValidationStatus(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]
Bases:
str
,SafeEnum
An enumeration.
- ok = 'OK'
- errors = 'ERRORS'
- class wxc_sdk.common.ValidateExtensionStatusState(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]
Bases:
str
,SafeEnum
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 = None, message: str | None = None)[source]
Bases:
ApiModel
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.
__init__ uses __pydantic_self__ instead of the more common self for the first arg to allow self as a field name.
- extension: str
Indicates the extension id for which the status is about .
- state: ValidateExtensionStatusState
Indicate the status for the given extension id .
- error_code: int | None
Error Code .
- message: str | None
- property ok
- model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'extra': 'forbid', 'populate_by_name': True, 'use_enum_values': True}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'error_code': FieldInfo(annotation=Union[int, NoneType], required=False, alias='errorCode', alias_priority=1), 'extension': FieldInfo(annotation=str, required=True, alias='extension', alias_priority=1), 'message': FieldInfo(annotation=Union[str, NoneType], required=False, alias='message', alias_priority=1), 'state': FieldInfo(annotation=ValidateExtensionStatusState, required=True, alias='state', alias_priority=1)}
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- class wxc_sdk.common.ValidateExtensionsResponse(*, status: ValidationStatus, extensionStatus: list[ValidateExtensionStatus] | None = None)[source]
Bases:
ApiModel
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.
__init__ uses __pydantic_self__ instead of the more common self for the first arg to allow self as a field name.
- status: ValidationStatus
- extension_status: list[ValidateExtensionStatus] | None
- property ok: bool
- model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'extra': 'forbid', 'populate_by_name': True, 'use_enum_values': True}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'extension_status': FieldInfo(annotation=Union[list[ValidateExtensionStatus], NoneType], required=False, alias='extensionStatus', alias_priority=1), 'status': FieldInfo(annotation=ValidationStatus, required=True, alias='status', alias_priority=1)}
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- class wxc_sdk.common.ValidatePhoneNumberStatusState(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]
Bases:
str
,SafeEnum
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.
This phone number is unavailable and cannot be used.
- class wxc_sdk.common.ValidatePhoneNumberStatus(*, phoneNumber: str, state: ValidatePhoneNumberStatusState, tollFreeNumber: bool, detail: list[str] = None)[source]
Bases:
ApiModel
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.
__init__ uses __pydantic_self__ instead of the more common self for the first arg to allow self as a field name.
- 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
- model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'extra': 'forbid', 'populate_by_name': True, 'use_enum_values': True}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'detail': FieldInfo(annotation=list[str], required=False, default_factory=list, alias='detail', alias_priority=1), 'phone_number': FieldInfo(annotation=str, required=True, alias='phoneNumber', alias_priority=1), 'state': FieldInfo(annotation=ValidatePhoneNumberStatusState, required=True, alias='state', alias_priority=1), 'toll_free_number': FieldInfo(annotation=bool, required=True, alias='tollFreeNumber', alias_priority=1)}
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- class wxc_sdk.common.ValidatePhoneNumbersResponse(*, status: ValidationStatus, phoneNumbers: list[ValidatePhoneNumberStatus] | None = None)[source]
Bases:
ApiModel
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.
__init__ uses __pydantic_self__ instead of the more common self for the first arg to allow self as a field name.
- status: ValidationStatus
This indicates the status of the numbers.
- phone_numbers: list[ValidatePhoneNumberStatus] | None
This is an array of number objects with number details.
- property ok: bool
- model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'extra': 'forbid', 'populate_by_name': True, 'use_enum_values': True}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'phone_numbers': FieldInfo(annotation=Union[list[ValidatePhoneNumberStatus], NoneType], required=False, alias='phoneNumbers', alias_priority=1), 'status': FieldInfo(annotation=ValidationStatus, required=True, alias='status', alias_priority=1)}
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- class wxc_sdk.common.StorageType(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]
Bases:
str
,SafeEnum
Designates which type of voicemail message storage is used.
- internal = 'INTERNAL'
For message access via phone or the Calling User Portal.
- external = 'EXTERNAL'
For sending all messages to the person’s email.
- class wxc_sdk.common.VoicemailMessageStorage(*, mwiEnabled: bool | None = None, storageType: StorageType | None = None, externalEmail: str | None = None)[source]
Bases:
ApiModel
Settings for message storage
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.
__init__ uses __pydantic_self__ instead of the more common self for the first arg to allow self as a field name.
- mwi_enabled: bool | None
When true desktop phone will indicate there are new voicemails.
- storage_type: StorageType | None
Designates which type of voicemail message storage is used.
- external_email: str | None
- model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'extra': 'forbid', 'populate_by_name': True, 'use_enum_values': True}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'external_email': FieldInfo(annotation=Union[str, NoneType], required=False, alias='externalEmail', alias_priority=1), 'mwi_enabled': FieldInfo(annotation=Union[bool, NoneType], required=False, alias='mwiEnabled', alias_priority=1), 'storage_type': FieldInfo(annotation=Union[StorageType, NoneType], required=False, alias='storageType', alias_priority=1)}
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- class wxc_sdk.common.VoicemailEnabled(*, enabled: bool)[source]
Bases:
ApiModel
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.
__init__ uses __pydantic_self__ instead of the more common self for the first arg to allow self as a field name.
- enabled: bool
- model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'extra': 'forbid', 'populate_by_name': True, 'use_enum_values': True}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'enabled': FieldInfo(annotation=bool, required=True, alias='enabled', alias_priority=1)}
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- class wxc_sdk.common.VoicemailNotifications(*, enabled: bool, destination: str | None = None)[source]
Bases:
VoicemailEnabled
Settings for notifications when there are any new voicemails.
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.
__init__ uses __pydantic_self__ instead of the more common self for the first arg to allow self as a field name.
- destination: str | None
Email address to which the notification will be sent. For text messages, use an email to text message gateway like 2025551212@txt.att.net.
- model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'extra': 'forbid', 'populate_by_name': True, 'use_enum_values': True}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'destination': FieldInfo(annotation=Union[str, NoneType], required=False, alias='destination', alias_priority=1), 'enabled': FieldInfo(annotation=bool, required=True, alias='enabled', alias_priority=1)}
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- class wxc_sdk.common.VoicemailFax(*, enabled: bool, extension: str | None = None, phoneNumber: str | None = None)[source]
Bases:
VoicemailEnabled
Fax message settings
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.
__init__ uses __pydantic_self__ instead of the more common self for the first arg to allow self as a field name.
- extension: str | None
Designates optional extension for fax.
- phone_number: str | None
Designates phone number for fax. A value for this field must be provided in the request if faxMessage enabled field is given as true in the request.
- model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'extra': 'forbid', 'populate_by_name': True, 'use_enum_values': True}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'enabled': FieldInfo(annotation=bool, required=True, alias='enabled', alias_priority=1), 'extension': FieldInfo(annotation=Union[str, NoneType], required=False, alias='extension', alias_priority=1), 'phone_number': FieldInfo(annotation=Union[str, NoneType], required=False, alias='phoneNumber', alias_priority=1)}
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- class wxc_sdk.common.VoicemailTransferToNumber(*, enabled: bool, destination: str | None = None)[source]
Bases:
VoicemailEnabled
Settings for voicemail caller to transfer to a different number by pressing zero (0).
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.
__init__ uses __pydantic_self__ instead of the more common self for the first arg to allow self as a field name.
- destination: str | None
Number voicemail caller will be transferred to when they press zero (0).
- model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'extra': 'forbid', 'populate_by_name': True, 'use_enum_values': True}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'destination': FieldInfo(annotation=Union[str, NoneType], required=False, alias='destination', alias_priority=1), 'enabled': FieldInfo(annotation=bool, required=True, alias='enabled', alias_priority=1)}
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- class wxc_sdk.common.VoicemailCopyOfMessage(*, enabled: bool, emailId: str | None = None)[source]
Bases:
VoicemailEnabled
Settings for sending a copy of new voicemail message audio via email.
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.
__init__ uses __pydantic_self__ instead of the more common self for the first arg to allow self as a field name.
- email_id: str | None
Email address to which the new voicemail audio will be sent.
- model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'extra': 'forbid', 'populate_by_name': True, 'use_enum_values': True}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'email_id': FieldInfo(annotation=Union[str, NoneType], required=False, alias='emailId', alias_priority=1), 'enabled': FieldInfo(annotation=bool, required=True, alias='enabled', alias_priority=1)}
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- class wxc_sdk.common.AudioCodecPriority(*, selection: str, primary: str | None = None, secondary: str | None = None, tertiary: str | None = None)[source]
Bases:
ApiModel
Choose up to three predefined codec priority options available for your region.
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.
__init__ uses __pydantic_self__ instead of the more common self for the first arg to allow self as a field name.
- selection: str
Indicates the selection of an Audio Code Priority Object.
- primary: str | None
Indicates the primary Audio Codec.
- secondary: str | None
Indicates the secondary Audio Codec.
- tertiary: str | None
Indicates the tertiary Audio Codec.
- model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'extra': 'forbid', 'populate_by_name': True, 'use_enum_values': True}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'primary': FieldInfo(annotation=Union[str, NoneType], required=False, alias='primary', alias_priority=1), 'secondary': FieldInfo(annotation=Union[str, NoneType], required=False, alias='secondary', alias_priority=1), 'selection': FieldInfo(annotation=str, required=True, alias='selection', alias_priority=1), 'tertiary': FieldInfo(annotation=Union[str, NoneType], required=False, alias='tertiary', alias_priority=1)}
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- class wxc_sdk.common.AtaDtmfMode(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]
Bases:
str
,SafeEnum
DTMF Detection Tx Mode selection for Cisco ATA devices.
- strict = 'STRICT'
It means a) DTMF digit requires an extra hold time after detection and b) DTMF level threshold is raised to -20 dBm.
- normal = 'NORMAL'
It means normal threshold mode.
- class wxc_sdk.common.AtaDtmfMethod(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]
Bases:
str
,SafeEnum
Method for transmitting DTMF signals to the far end.
- inband = 'INBAND'
Sends DTMF by using the audio path.
- avt = 'AVT'
Audio video transport. Sends DTMF as AVT events.
- auto = 'AUTO'
- class wxc_sdk.common.VlanSetting(*, enabled: bool, value: int, pcPort: int | None = None)[source]
Bases:
ApiModel
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.
__init__ uses __pydantic_self__ instead of the more common self for the first arg to allow self as a field name.
- enabled: bool
Denotes whether the VLAN object is enabled
- value: int
The value of the VLAN Object
- pc_port: int | None
Indicates the PC port value of a VLAN object for an MPP object
- model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'extra': 'forbid', 'populate_by_name': True, 'use_enum_values': True}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'enabled': FieldInfo(annotation=bool, required=True, alias='enabled', alias_priority=1), 'pc_port': FieldInfo(annotation=Union[int, NoneType], required=False, alias='pcPort', alias_priority=1), 'value': FieldInfo(annotation=int, required=True, alias='value', alias_priority=1)}
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- class wxc_sdk.common.AtaCustomization(*, audioCodecPriority: AudioCodecPriority, cdpEnabled: bool, lldpEnabled: bool, qosEnabled: bool, vlan: VlanSetting, nightlyResyncEnabled: bool | None = None, ataDtmfMode: AtaDtmfMode, ataDtmfMethod: AtaDtmfMethod, snmp: dict, webAccessEnabled: bool)[source]
Bases:
CommonDeviceCustomization
settings that are applicable to ATA devices.
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.
__init__ uses __pydantic_self__ instead of the more common self for the first arg to allow self as a field name.
- ata_dtmf_mode: AtaDtmfMode
DTMF Detection Tx Mode selection for Cisco ATA devices.
- ata_dtmf_method: AtaDtmfMethod
Method for transmitting DTMF signals to the far end.
- snmp: dict
- web_access_enabled: bool
Enable/disable user level web access to the local device.
- model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'extra': 'forbid', 'populate_by_name': True, 'use_enum_values': True}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'ata_dtmf_method': FieldInfo(annotation=AtaDtmfMethod, required=True, alias='ataDtmfMethod', alias_priority=1), 'ata_dtmf_mode': FieldInfo(annotation=AtaDtmfMode, required=True, alias='ataDtmfMode', alias_priority=1), 'audio_codec_priority': FieldInfo(annotation=AudioCodecPriority, required=True, alias='audioCodecPriority', alias_priority=1), 'cdp_enabled': FieldInfo(annotation=bool, required=True, alias='cdpEnabled', alias_priority=1), 'lldp_enabled': FieldInfo(annotation=bool, required=True, alias='lldpEnabled', alias_priority=1), 'nightly_resync_enabled': FieldInfo(annotation=Union[bool, NoneType], required=False, alias='nightlyResyncEnabled', alias_priority=1), 'qos_enabled': FieldInfo(annotation=bool, required=True, alias='qosEnabled', alias_priority=1), 'snmp': FieldInfo(annotation=dict, required=True, alias='snmp', alias_priority=1), 'vlan': FieldInfo(annotation=VlanSetting, required=True, alias='vlan', alias_priority=1), 'web_access_enabled': FieldInfo(annotation=bool, required=True, alias='webAccessEnabled', alias_priority=1)}
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- class wxc_sdk.common.DeviceCustomizations(*, ata: AtaCustomization | None = None, dect: DectCustomization | None = None, mpp: MppCustomization | None = None, wifi: WifiCustomization | None = None)[source]
Bases:
ApiModel
Customization object of the device settings.
At the device level only one of ata, dect, and mpp is set. At location and org level all three customizations are set.
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.
__init__ uses __pydantic_self__ instead of the more common self for the first arg to allow self as a field name.
- ata: AtaCustomization | None
- dect: DectCustomization | None
- mpp: MppCustomization | None
- wifi: WifiCustomization | None
- model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'extra': 'forbid', 'populate_by_name': True, 'use_enum_values': True}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'ata': FieldInfo(annotation=Union[AtaCustomization, NoneType], required=False, alias='ata', alias_priority=1), 'dect': FieldInfo(annotation=Union[DectCustomization, NoneType], required=False, alias='dect', alias_priority=1), 'mpp': FieldInfo(annotation=Union[MppCustomization, NoneType], required=False, alias='mpp', alias_priority=1), 'wifi': FieldInfo(annotation=Union[WifiCustomization, NoneType], required=False, alias='wifi', alias_priority=1)}
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- class wxc_sdk.common.DeviceCustomization(*, customizations: DeviceCustomizations, customEnabled: bool | None = None, updateInProgress: bool | None = None, deviceCount: int | None = None, lastUpdateTime: datetime | None = None)[source]
Bases:
ApiModel
Device customization
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.
__init__ uses __pydantic_self__ instead of the more common self for the first arg to allow self as a field name.
- customizations: DeviceCustomizations
customization object of the device settings.
- custom_enabled: bool | None
Indicates if customization is allowed at repective (location or device) level. If true - customized at this level. If false - not customized, using higher level config (location or org). Only present in location and device level customization response
- update_in_progress: bool | None
Indicates the progress of the device update. Not present at device level
- device_count: int | None
Indicates the device count. Not present at device level
- last_update_time: datetime | None
Indicates the last updated time.
- model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'extra': 'forbid', 'populate_by_name': True, 'use_enum_values': True}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'custom_enabled': FieldInfo(annotation=Union[bool, NoneType], required=False, alias='customEnabled', alias_priority=1), 'customizations': FieldInfo(annotation=DeviceCustomizations, required=True, alias='customizations', alias_priority=1), 'device_count': FieldInfo(annotation=Union[int, NoneType], required=False, alias='deviceCount', alias_priority=1), 'last_update_time': FieldInfo(annotation=Union[datetime, NoneType], required=False, alias='lastUpdateTime', alias_priority=1), 'update_in_progress': FieldInfo(annotation=Union[bool, NoneType], required=False, alias='updateInProgress', alias_priority=1)}
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- class wxc_sdk.common.CommonDeviceCustomization(*, audioCodecPriority: AudioCodecPriority, cdpEnabled: bool, lldpEnabled: bool, qosEnabled: bool, vlan: VlanSetting, nightlyResyncEnabled: bool | None = None)[source]
Bases:
ApiModel
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.
__init__ uses __pydantic_self__ instead of the more common self for the first arg to allow self as a field name.
- audio_codec_priority: AudioCodecPriority
Choose up to three predefined codec priority options available for your region.
- cdp_enabled: bool
Enable/disable Cisco Discovery Protocol for local devices.
- lldp_enabled: bool
Enable/disable Link Layer Discovery Protocol for local devices.
- qos_enabled: bool
Enable/disable quality of service tagging of packets from the local device to the Webex Calling platform.
- vlan: VlanSetting
Specify a numeric Virtual LAN ID for devices.
- nightly_resync_enabled: bool | None
Enable/disable automatic nightly configuration resync of the device.
- model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'extra': 'forbid', 'populate_by_name': True, 'use_enum_values': True}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'audio_codec_priority': FieldInfo(annotation=AudioCodecPriority, required=True, alias='audioCodecPriority', alias_priority=1), 'cdp_enabled': FieldInfo(annotation=bool, required=True, alias='cdpEnabled', alias_priority=1), 'lldp_enabled': FieldInfo(annotation=bool, required=True, alias='lldpEnabled', alias_priority=1), 'nightly_resync_enabled': FieldInfo(annotation=Union[bool, NoneType], required=False, alias='nightlyResyncEnabled', alias_priority=1), 'qos_enabled': FieldInfo(annotation=bool, required=True, alias='qosEnabled', alias_priority=1), 'vlan': FieldInfo(annotation=VlanSetting, required=True, alias='vlan', alias_priority=1)}
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- class wxc_sdk.common.BacklightTimer(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]
Bases:
str
,SafeEnum
An enumeration.
- one_min = 'ONE_MIN'
- five_min = 'FIVE_MIN'
- thirty_min = 'THIRTY_MIN'
- always_on = 'ALWAYS_ON'
- class wxc_sdk.common.Background(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]
Bases:
str
,SafeEnum
An enumeration.
- no_background = 'NONE'
Indicates that there will be no background image set for the devices.
- dark_blue = 'DARK_BLUE'
Indicates that dark blue background image will be set for the devices.
- cisco_dark_blue = 'CISCO_DARK_BLUE'
Indicates that Cisco themed dark blue background image will be set for the devices.
- webex_dark_blue = 'WEBEX_DARK_BLUE'
Indicates that Cisco webex dark blue background image will be set for the devices.
- custom_background = 'CUSTOM_BACKGROUND'
Indicates that a custom background image will be set for the devices.
- class wxc_sdk.common.BackgroundSelection(*, image: Background, customUrl: str | None = None)[source]
Bases:
ApiModel
Background selection for MPP devices
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.
__init__ uses __pydantic_self__ instead of the more common self for the first arg to allow self as a field name.
- image: Background
- custom_url: str | None
- model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'extra': 'forbid', 'populate_by_name': True, 'use_enum_values': True}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'custom_url': FieldInfo(annotation=Union[str, NoneType], required=False, alias='customUrl', alias_priority=1), 'image': FieldInfo(annotation=Background, required=True, alias='image', alias_priority=1)}
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- class wxc_sdk.common.DisplayNameSelection(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]
Bases:
str
,SafeEnum
An enumeration.
- person_number = 'PERSON_NUMBER'
Indicates that devices will display the person’s phone number, or if a person doesn’t have a phone number, the location number will be displayed.
- person_first_then_last_name = 'PERSON_FIRST_THEN_LAST_NAME'
Indicates that devices will display the name in first name then last name format.
- person_last_then_first_name = 'PERSON_LAST_THEN_FIRST_NAME'
Indicates that devices will display the name in last name then first name format.
- class wxc_sdk.common.LoggingLevel(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]
Bases:
str
,SafeEnum
An enumeration.
- standard = 'STANDARD'
Enables standard logging.
- debugging = 'DEBUGGING'
Enables detailed debugging logging.
- class wxc_sdk.common.DisplayCallqueueAgentSoftkey(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]
Bases:
str
,SafeEnum
Chooses the location of the Call Queue Agent Login/Logout softkey on Multi-Platform Phones.
- front_page = 'FRONT_PAGE'
- last_page = 'LAST_PAGE'
- class wxc_sdk.common.AcdCustomization(*, enabled: bool, displayCallqueueAgentSoftkeys: str)[source]
Bases:
ApiModel
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.
__init__ uses __pydantic_self__ instead of the more common self for the first arg to allow self as a field name.
- enabled: bool
Indicates whether the ACD object is enabled.
- display_callqueue_agent_softkeys: str
Indicates the call queue agent soft key value of an ACD object.
- model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'extra': 'forbid', 'populate_by_name': True, 'use_enum_values': True}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'display_callqueue_agent_softkeys': FieldInfo(annotation=str, required=True, alias='displayCallqueueAgentSoftkeys', alias_priority=1), 'enabled': FieldInfo(annotation=bool, required=True, alias='enabled', alias_priority=1)}
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- class wxc_sdk.common.LineKeyLabelSelection(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]
Bases:
str
,SafeEnum
Line key labels define the format of what’s shown next to line keys.
- person_extension = 'PERSON_EXTENSION'
This will display the person extension, or if a person doesn’t have an extension, the person’s first name will be displayed.
- person_first_then_last_name = 'PERSON_FIRST_THEN_LAST_NAME'
Indicates that devices will display the name in first name then last name format.
- person_last_then_first_name = 'PERSON_LAST_THEN_FIRST_NAME'
Indicates that devices will display the name in last name then first name format.
- class wxc_sdk.common.LineKeyLedPattern(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]
Bases:
str
,SafeEnum
An enumeration.
- default = 'DEFAULT'
- preset_1 = 'PRESET_1'
- class wxc_sdk.common.PhoneLanguage(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]
Bases:
str
,SafeEnum
An enumeration.
- person = 'PERSON_LANGUAGE'
Indicates a person’s announcement language.
- arabic = 'ARABIC'
- bulgarian = 'BULGARIAN'
- catalan = 'CATALAN'
- chinese_simplified = 'CHINESE_SIMPLIFIED'
- chinese_traditional = 'CHINESE_TRADITIONAL'
- croatian = 'CROATIAN'
- czech = 'CZECH'
- danish = 'DANISH'
- dutch = 'DUTCH'
- english_united_states = 'ENGLISH_UNITED_STATES'
- english_united_kingdom = 'ENGLISH_UNITED_KINGDOM'
- finnish = 'FINNISH'
- french_canada = 'FRENCH_CANADA'
- french_france = 'FRENCH_FRANCE'
- german = 'GERMAN'
- greek = 'GREEK'
- hebrew = 'HEBREW'
- hungarian = 'HUNGARIAN'
- italian = 'ITALIAN'
- japanese = 'JAPANESE'
- korean = 'KOREAN'
- norwegian = 'NORWEGIAN'
- polish = 'POLISH'
- portuguese_portugal = 'PORTUGUESE_PORTUGAL'
- russian = 'RUSSIAN'
- spanish_colombia = 'SPANISH_COLOMBIA'
- spanish_spain = 'SPANISH_SPAIN'
- slovak = 'SLOVAK'
- swedish = 'SWEDISH'
- slovenian = 'SLOVENIAN'
- turkish = 'TURKISH'
- ukraine = 'UKRAINE'
- class wxc_sdk.common.EnabledAndValue(*, enabled: bool, value: int)[source]
Bases:
ApiModel
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.
__init__ uses __pydantic_self__ instead of the more common self for the first arg to allow self as a field name.
- enabled: bool
- value: int
- model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'extra': 'forbid', 'populate_by_name': True, 'use_enum_values': True}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'enabled': FieldInfo(annotation=bool, required=True, alias='enabled', alias_priority=1), 'value': FieldInfo(annotation=int, required=True, alias='value', alias_priority=1)}
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- class wxc_sdk.common.WifiNetwork(*, enabled: bool, authenticationMethod: str, ssidName: str | None = None, userId: str | None = None)[source]
Bases:
ApiModel
Specify the Wi-Fi SSID and password for wireless-enabled MPP phones.
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.
__init__ uses __pydantic_self__ instead of the more common self for the first arg to allow self as a field name.
- enabled: bool
Indicates whether the wifi network is enabled.
- authentication_method: str
Authentication method of wifi network.
- ssid_name: str | None
SSID name of the wifi network.
- user_id: str | None
User ID of the wifi network.
- model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'extra': 'forbid', 'populate_by_name': True, 'use_enum_values': True}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'authentication_method': FieldInfo(annotation=str, required=True, alias='authenticationMethod', alias_priority=1), 'enabled': FieldInfo(annotation=bool, required=True, alias='enabled', alias_priority=1), 'ssid_name': FieldInfo(annotation=Union[str, NoneType], required=False, alias='ssidName', alias_priority=1), 'user_id': FieldInfo(annotation=Union[str, NoneType], required=False, alias='userId', alias_priority=1)}
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- class wxc_sdk.common.MppCustomization(*, audioCodecPriority: AudioCodecPriority, cdpEnabled: bool, lldpEnabled: bool, qosEnabled: bool, vlan: MppVlanDevice | None = None, nightlyResyncEnabled: bool | None = None, pnacEnabled: bool, backlightTimer: BacklightTimer, background: BackgroundSelection, displayNameFormat: DisplayNameSelection, defaultLoggingLevel: LoggingLevel, dndServicesEnabled: bool, displayCallqueueAgentSoftkeys: DisplayCallqueueAgentSoftkey | None = None, hotelingGuestAssociationTimer: int | None = None, acd: AcdCustomization, shortInterdigitTimer: int, longInterdigitTimer: int, lineKeyLabelFormat: LineKeyLabelSelection, lineKeyLEDPattern: LineKeyLedPattern, mppUserWebAccessEnabled: bool, multicast: list[str] | None = None, offHookTimer: int, phoneLanguage: PhoneLanguage, poeMode: str, screenTimeout: EnabledAndValue, usbPortsEnabled: bool | None = None, usbPorts: UsbPortsObject | None = None, wifiNetwork: WifiNetwork | None = None, migrationUrl: str | None = None, callHistory: CallHistoryMethod | None = None, contacts: DirectoryMethod | None = None, webexMeetingsEnabled: bool | None = None, volumeSettings: VolumeSettings | None = None, cfExpandedSoftKey: CallForwardExpandedSoftKey | None = None, httpProxy: HttpProxy | None = None, bluetooth: BluetoothSetting | None = None, passThroughPortEnabled: bool | None = None, userPasswordOverrideEnabled: bool | None = None, activeCallFocusEnabled: bool | None = None, peerFirmwareEnabled: bool | None = None, noiseCancellation: NoiseCancellation | None = None, voiceFeedbackAccessibilityEnabled: bool | None = None, dialAssistEnabled: bool | None = None, callsPerLine: int | None = None, missedCallNotificationEnabled: bool | None = None, softKeyLayout: SoftKeyLayout | None = None, backgroundImage8875: BackgroundImageColor | None = None, backlightTimer68XX78XX: BacklightTimer68XX78XX | None = None)[source]
Bases:
CommonDeviceCustomization
settings that are applicable to MPP devices.
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.
__init__ uses __pydantic_self__ instead of the more common self for the first arg to allow self as a field name.
- pnac_enabled: bool
Indicates whether PNAC of MPP object is enabled or not
- backlight_timer: BacklightTimer
Choose the length of time (in minutes) for the phone’s backlight to remain on.
- background: BackgroundSelection
Holds the background object of MPP Object.
- display_name_format: DisplayNameSelection
The display name that appears on the phone screen.
- default_logging_level: LoggingLevel
Choose the desired logging level for an MPP devices
- dnd_services_enabled: bool
Enable/disable Do-Not-Disturb capabilities for Multi-Platform Phones.
- display_callqueue_agent_softkeys: DisplayCallqueueAgentSoftkey | None
Chooses the location of the Call Queue Agent Login/Logout softkey on Multi-Platform Phones.
- hoteling_guest_association_timer: int | None
Choose the duration (in hours) of Hoteling guest login.
- acd: AcdCustomization
Holds the Acd object value.
- short_interdigit_timer: int
Indicates the short inter digit timer value.
- long_interdigit_timer: int
Indicates the long inter digit timer value.
- line_key_label_format: LineKeyLabelSelection
Line key labels define the format of what’s shown next to line keys.
- line_key_led_pattern: LineKeyLedPattern
LED patterns define lighting schemes for the line keys on the MPP devices. Note – This parameter is not supported on the MPP 8875
- mpp_user_web_access_enabled: bool
Enable/disable user-level access to the web interface of Multi-Platform Phones.
- multicast: list[str] | None
Select up to 10 Multicast Group URLs (each with a unique Listening Port).
- off_hook_timer: int
Specify the amount of time (in seconds) that a phone can remain off-hook.
- phone_language: PhoneLanguage
Select the language for your MPP phone. Setting this overrides the default language setting in place for your provisioned location.
- poe_mode: str
Enable/disable the Power-Over-Ethernet mode for Multi-Platform Phones.
- screen_timeout: EnabledAndValue
Specify the amount of inactive time needed (in seconds) before the phone’s screen saver activates.
- usb_ports_enabled: bool | None
Enable/disable the use of the USB ports on Multi-Platform phones.
- usb_ports: UsbPortsObject | None
By default the Side USB port is enabled to support KEMs and other peripheral devices. Use the option to disable use of this port.
- vlan: MppVlanDevice | None
Specify a numeric Virtual LAN ID for devices.
- wifi_network: WifiNetwork | None
Specify the Wi-Fi SSID and password for wireless-enabled MPP phones.
- migration_url: str | None
- call_history: CallHistoryMethod | None
Specify the call history information to use. Only applies to user devices.
- contacts: DirectoryMethod | None
Specify the directory services to use.
- webex_meetings_enabled: bool | None
Enable/disable the availability of the webex meetings functionality from the phone.
- volume_settings: VolumeSettings | None
Specify all volume level values on the phone.
- cf_expanded_soft_key: CallForwardExpandedSoftKey | None
Specify the call forward expanded soft key behavior.
- bluetooth: BluetoothSetting | None
Enable/disable the visibility of the bluetooth menu on the MPP device.
- pass_through_port_enabled: bool | None
Enable/disable the use of the PC passthrough ethernet port on supported phone models.
- user_password_override_enabled: bool | None
Enable/disable the ability for an end user to set a local password on the phone to restrict local access to the device.
- active_call_focus_enabled: bool | None
Enable/disable the default screen behavior when inbound calls are received.
- peer_firmware_enabled: bool | None
Enable/disable peer firmware sharing.
- noise_cancellation: NoiseCancellation | None
Enable/disable local noise cancellation on active calls from the device.
- voice_feedback_accessibility_enabled: bool | None
Enable/disable visibility of the Accessibility Voice Feedback menu on the MPP device.
- dial_assist_enabled: bool | None
Enable/disable availability of dial assist feature on the phone.
- calls_per_line: int | None
Specify the number of calls per unique line appearance on the phone.
- missed_call_notification_enabled: bool | None
Enable/disable the visual indication of missed calls.
- soft_key_layout: SoftKeyLayout | None
Specify the softkey layout per phone menu state.
- background_image8875: BackgroundImageColor | None
Specify the image option for the MPP 8875 phone background.
- backlight_timer_68xx78xx: BacklightTimer68XX78XX | None
Specify the use of the backlight feature on 6800 nad 7800 series devices.
- model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'extra': 'forbid', 'populate_by_name': True, 'use_enum_values': True}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'acd': FieldInfo(annotation=AcdCustomization, required=True, alias='acd', alias_priority=1), 'active_call_focus_enabled': FieldInfo(annotation=Union[bool, NoneType], required=False, alias='activeCallFocusEnabled', alias_priority=1), 'audio_codec_priority': FieldInfo(annotation=AudioCodecPriority, required=True, alias='audioCodecPriority', alias_priority=1), 'background': FieldInfo(annotation=BackgroundSelection, required=True, alias='background', alias_priority=1), 'background_image8875': FieldInfo(annotation=Union[BackgroundImageColor, NoneType], required=False, alias='backgroundImage8875', alias_priority=1), 'backlight_timer': FieldInfo(annotation=BacklightTimer, required=True, alias='backlightTimer', alias_priority=1), 'backlight_timer_68xx78xx': FieldInfo(annotation=Union[BacklightTimer68XX78XX, NoneType], required=False, alias='backlightTimer68XX78XX', alias_priority=2), 'bluetooth': FieldInfo(annotation=Union[BluetoothSetting, NoneType], required=False, alias='bluetooth', alias_priority=1), 'call_history': FieldInfo(annotation=Union[CallHistoryMethod, NoneType], required=False, alias='callHistory', alias_priority=1), 'calls_per_line': FieldInfo(annotation=Union[int, NoneType], required=False, alias='callsPerLine', alias_priority=1), 'cdp_enabled': FieldInfo(annotation=bool, required=True, alias='cdpEnabled', alias_priority=1), 'cf_expanded_soft_key': FieldInfo(annotation=Union[CallForwardExpandedSoftKey, NoneType], required=False, alias='cfExpandedSoftKey', alias_priority=1), 'contacts': FieldInfo(annotation=Union[DirectoryMethod, NoneType], required=False, alias='contacts', alias_priority=1), 'default_logging_level': FieldInfo(annotation=LoggingLevel, required=True, alias='defaultLoggingLevel', alias_priority=1), 'dial_assist_enabled': FieldInfo(annotation=Union[bool, NoneType], required=False, alias='dialAssistEnabled', alias_priority=1), 'display_callqueue_agent_softkeys': FieldInfo(annotation=Union[DisplayCallqueueAgentSoftkey, NoneType], required=False, alias='displayCallqueueAgentSoftkeys', alias_priority=1), 'display_name_format': FieldInfo(annotation=DisplayNameSelection, required=True, alias='displayNameFormat', alias_priority=1), 'dnd_services_enabled': FieldInfo(annotation=bool, required=True, alias='dndServicesEnabled', alias_priority=1), 'hoteling_guest_association_timer': FieldInfo(annotation=Union[int, NoneType], required=False, alias='hotelingGuestAssociationTimer', alias_priority=1), 'http_proxy': FieldInfo(annotation=Union[HttpProxy, NoneType], required=False, alias='httpProxy', alias_priority=1), 'line_key_label_format': FieldInfo(annotation=LineKeyLabelSelection, required=True, alias='lineKeyLabelFormat', alias_priority=1), 'line_key_led_pattern': FieldInfo(annotation=LineKeyLedPattern, required=True, alias='lineKeyLEDPattern', alias_priority=2), 'lldp_enabled': FieldInfo(annotation=bool, required=True, alias='lldpEnabled', alias_priority=1), 'long_interdigit_timer': FieldInfo(annotation=int, required=True, alias='longInterdigitTimer', alias_priority=1), 'migration_url': FieldInfo(annotation=Union[str, NoneType], required=False, alias='migrationUrl', alias_priority=1), 'missed_call_notification_enabled': FieldInfo(annotation=Union[bool, NoneType], required=False, alias='missedCallNotificationEnabled', alias_priority=1), 'mpp_user_web_access_enabled': FieldInfo(annotation=bool, required=True, alias='mppUserWebAccessEnabled', alias_priority=1), 'multicast': FieldInfo(annotation=Union[list[str], NoneType], required=False, alias='multicast', alias_priority=1), 'nightly_resync_enabled': FieldInfo(annotation=Union[bool, NoneType], required=False, alias='nightlyResyncEnabled', alias_priority=1), 'noise_cancellation': FieldInfo(annotation=Union[NoiseCancellation, NoneType], required=False, alias='noiseCancellation', alias_priority=1), 'off_hook_timer': FieldInfo(annotation=int, required=True, alias='offHookTimer', alias_priority=1), 'pass_through_port_enabled': FieldInfo(annotation=Union[bool, NoneType], required=False, alias='passThroughPortEnabled', alias_priority=1), 'peer_firmware_enabled': FieldInfo(annotation=Union[bool, NoneType], required=False, alias='peerFirmwareEnabled', alias_priority=1), 'phone_language': FieldInfo(annotation=PhoneLanguage, required=True, alias='phoneLanguage', alias_priority=1), 'pnac_enabled': FieldInfo(annotation=bool, required=True, alias='pnacEnabled', alias_priority=1), 'poe_mode': FieldInfo(annotation=str, required=True, alias='poeMode', alias_priority=1), 'qos_enabled': FieldInfo(annotation=bool, required=True, alias='qosEnabled', alias_priority=1), 'screen_timeout': FieldInfo(annotation=EnabledAndValue, required=True, alias='screenTimeout', alias_priority=1), 'short_interdigit_timer': FieldInfo(annotation=int, required=True, alias='shortInterdigitTimer', alias_priority=1), 'soft_key_layout': FieldInfo(annotation=Union[SoftKeyLayout, NoneType], required=False, alias='softKeyLayout', alias_priority=1), 'usb_ports': FieldInfo(annotation=Union[UsbPortsObject, NoneType], required=False, alias='usbPorts', alias_priority=1), 'usb_ports_enabled': FieldInfo(annotation=Union[bool, NoneType], required=False, alias='usbPortsEnabled', alias_priority=1), 'user_password_override_enabled': FieldInfo(annotation=Union[bool, NoneType], required=False, alias='userPasswordOverrideEnabled', alias_priority=1), 'vlan': FieldInfo(annotation=Union[MppVlanDevice, NoneType], required=False, alias='vlan', alias_priority=1), 'voice_feedback_accessibility_enabled': FieldInfo(annotation=Union[bool, NoneType], required=False, alias='voiceFeedbackAccessibilityEnabled', alias_priority=1), 'volume_settings': FieldInfo(annotation=Union[VolumeSettings, NoneType], required=False, alias='volumeSettings', alias_priority=1), 'webex_meetings_enabled': FieldInfo(annotation=Union[bool, NoneType], required=False, alias='webexMeetingsEnabled', alias_priority=1), 'wifi_network': FieldInfo(annotation=Union[WifiNetwork, NoneType], required=False, alias='wifiNetwork', alias_priority=1)}
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
Bases:
str
,SafeEnum
An enumeration.
This indicates a Primary line for the member
This indicates a Shared line for the member. Shared line appearance allows users to receive and place calls to and from another user’s extension, using their device.
- class wxc_sdk.common.MediaFileType(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]
Bases:
str
,SafeEnum
Media Type of the audio file.
- wma = 'WMA'
WMA File Extension.
- wav = 'WAV'
WAV File Extension.
- three_gp = '3GP'
3GP File Extension.
- class wxc_sdk.common.AnnAudioFile(*, id: str | None = None, fileName: str | None = None, mediaFileType: MediaFileType | None = None, level: AnnouncementLevel | None = None)[source]
Bases:
ApiModel
Announcement Audio Files
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.
__init__ uses __pydantic_self__ instead of the more common self for the first arg to allow self as a field name.
- id: str | None
A unique identifier for the announcement. name, mediaFileType, level are mandatory if id is not provided for uploading an announcement.
- file_name: str | None
Name of the file.
- media_file_type: MediaFileType | None
Media Type of the audio file.
- level: AnnouncementLevel | None
Audio announcement file type location.
- model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'extra': 'forbid', 'populate_by_name': True, 'use_enum_values': True}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'file_name': FieldInfo(annotation=Union[str, NoneType], required=False, alias='fileName', alias_priority=1), 'id': FieldInfo(annotation=Union[str, NoneType], required=False, alias='id', alias_priority=1), 'level': FieldInfo(annotation=Union[AnnouncementLevel, NoneType], required=False, alias='level', alias_priority=1), 'media_file_type': FieldInfo(annotation=Union[MediaFileType, NoneType], required=False, alias='mediaFileType', alias_priority=1)}
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- class wxc_sdk.common.WifiCustomization(*, audioCodecPriority: AudioCodecPriority, ldap: Any, webAccess: Any)[source]
Bases:
ApiModel
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.
__init__ uses __pydantic_self__ instead of the more common self for the first arg to allow self as a field name.
- audio_codec_priority: AudioCodecPriority
Choose up to three predefined codec priority options available for your region.
- ldap: Any
- web_access: Any
- model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'extra': 'forbid', 'populate_by_name': True, 'use_enum_values': True}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'audio_codec_priority': FieldInfo(annotation=AudioCodecPriority, required=True, alias='audioCodecPriority', alias_priority=1), 'ldap': FieldInfo(annotation=Any, required=True, alias='ldap', alias_priority=1), 'web_access': FieldInfo(annotation=Any, required=True, alias='webAccess', alias_priority=1)}
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- class wxc_sdk.common.RoomType(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]
Bases:
str
,SafeEnum
An enumeration.
- direct = 'direct'
1 room.
- Type:
1
- group = 'group'
Group room.
- class wxc_sdk.common.LinkRelation(*, rel: str | None = None, href: str | None = None, method: str | None = None)[source]
Bases:
ApiModel
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.
__init__ uses __pydantic_self__ instead of the more common self for the first arg to allow self as a field name.
- rel: str | None
Link relation describing how the target resource is related to the current context (conforming with RFC5998).
- href: str | None
Target resource URI (conforming with RFC5998).
- method: str | None
Target resource method (conforming with RFC5998).
- model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'extra': 'forbid', 'populate_by_name': True, 'use_enum_values': True}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'href': FieldInfo(annotation=Union[str, NoneType], required=False, alias='href', alias_priority=1), 'method': FieldInfo(annotation=Union[str, NoneType], required=False, alias='method', alias_priority=1), 'rel': FieldInfo(annotation=Union[str, NoneType], required=False, alias='rel', alias_priority=1)}
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- class wxc_sdk.common.AnnouncementLevel(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]
Bases:
SafeEnum
An enumeration.
- organization = 'ORGANIZATION'
Specifies this audio file is configured across organisation.
- location = 'LOCATION'
Specifies this audio file is configured across location.
- entity = 'ENTITY'
Specifies this audio file is configured on instance level.
- class wxc_sdk.common.UsbPortsObject(*, enabled: bool | None = None, sideUsbEnabled: bool | None = None, rearUsbEnabled: bool | None = None)[source]
Bases:
ApiModel
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.
__init__ uses __pydantic_self__ instead of the more common self for the first arg to allow self as a field name.
- enabled: bool | None
New Control to Enable/Disable the side USB port.
- side_usb_enabled: bool | None
Enable/disable use of the side USB port on the MPP device. Enabled by default.
- rear_usb_enabled: bool | None
Enable/disable use of the rear USB port on the MPP device.
- model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'extra': 'forbid', 'populate_by_name': True, 'use_enum_values': True}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'enabled': FieldInfo(annotation=Union[bool, NoneType], required=False, alias='enabled', alias_priority=1), 'rear_usb_enabled': FieldInfo(annotation=Union[bool, NoneType], required=False, alias='rearUsbEnabled', alias_priority=1), 'side_usb_enabled': FieldInfo(annotation=Union[bool, NoneType], required=False, alias='sideUsbEnabled', alias_priority=1)}
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- class wxc_sdk.common.WifiAuthenticationMethod(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]
Bases:
str
,SafeEnum
An enumeration.
- none = 'NONE'
No authentication.
- eap_fast = 'EAP_FAST'
Extensible Authentication Protocol-Flexible Authentication via Secure Tunneling. Requires username and password authentication.
- peap_gtc = 'PEAP_GTC'
Protected Extensible Authentication Protocol - Generic Token Card. Requires username and password authentication.
- peap_mschapv2 = 'PEAP_MSCHAPV2'
Protected Extensible Authentication Protocol - Microsoft Challenge Handshake Authentication Protocol version 2. Requires username and password authentication.
- psk = 'PSK'
Pre-Shared Key. Requires shared passphrase for authentication.
- wep = 'WEP'
Wired Equivalent Privacy. Requires encryption key for authentication.
- class wxc_sdk.common.DirectoryMethod(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]
Bases:
str
,SafeEnum
An enumeration.
- xsi_directory = 'XSI_DIRECTORY'
Set directory services to use standard XSI query method from the device.
- webex_directory = 'WEBEX_DIRECTORY'
Set directory services to use the Webex Enterprise directory.
- class wxc_sdk.common.CallHistoryMethod(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]
Bases:
str
,SafeEnum
An enumeration.
- unified = 'WEBEX_UNIFIED_CALL_HISTORY'
Set call history to use the unified call history from all of the end user’s devices.
- local = 'LOCAL_CALL_HISTORY'
Set call history to use local device information only.
- class wxc_sdk.common.MppVlanDevice(*, enabled: bool, value: int, pcPort: int | None = None)[source]
Bases:
EnabledAndValue
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.
__init__ uses __pydantic_self__ instead of the more common self for the first arg to allow self as a field name.
- pc_port: int | None
Indicates the PC port value of a VLAN object for an MPP object.
- model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'extra': 'forbid', 'populate_by_name': True, 'use_enum_values': True}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'enabled': FieldInfo(annotation=bool, required=True, alias='enabled', alias_priority=1), 'pc_port': FieldInfo(annotation=Union[int, NoneType], required=False, alias='pcPort', alias_priority=1), 'value': FieldInfo(annotation=int, required=True, alias='value', alias_priority=1)}
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- class wxc_sdk.common.VolumeSettings(*, ringerVolume: int | None = None, speakerVolume: int | None = None, handsetVolume: int | None = None, headsetVolume: int | None = None, eHookEnabled: bool | None = None, allowEndUserOverrideEnabled: bool | None = None)[source]
Bases:
ApiModel
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.
__init__ uses __pydantic_self__ instead of the more common self for the first arg to allow self as a field name.
- ringer_volume: int | None
Specify a ringer volume level through a numeric value between 0 and 15.
- speaker_volume: int | None
Specify a speaker volume level through a numeric value between 0 and 15.
- handset_volume: int | None
Specify a handset volume level through a numeric value between 0 and 15.
- headset_volume: int | None
Specify a headset volume level through a numeric value between 0 and 15.
- e_hook_enabled: bool | None
Enable/disable the wireless headset hookswitch control.
- allow_end_user_override_enabled: bool | None
Enable/disable to preserve the existing values on the phone and not the values defined for the device settings.
- model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'extra': 'forbid', 'populate_by_name': True, 'use_enum_values': True}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'allow_end_user_override_enabled': FieldInfo(annotation=Union[bool, NoneType], required=False, alias='allowEndUserOverrideEnabled', alias_priority=1), 'e_hook_enabled': FieldInfo(annotation=Union[bool, NoneType], required=False, alias='eHookEnabled', alias_priority=1), 'handset_volume': FieldInfo(annotation=Union[int, NoneType], required=False, alias='handsetVolume', alias_priority=1), 'headset_volume': FieldInfo(annotation=Union[int, NoneType], required=False, alias='headsetVolume', alias_priority=1), 'ringer_volume': FieldInfo(annotation=Union[int, NoneType], required=False, alias='ringerVolume', alias_priority=1), 'speaker_volume': FieldInfo(annotation=Union[int, NoneType], required=False, alias='speakerVolume', alias_priority=1)}
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- class wxc_sdk.common.CallForwardExpandedSoftKey(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]
Bases:
str
,SafeEnum
An enumeration.
- only_the_call_forward_all = 'ONLY_THE_CALL_FORWARD_ALL'
Set the default call forward expanded soft key behavior to single option.
- all_call_forwards = 'ALL_CALL_FORWARDS'
Set the default call forward expanded soft key behavior to multiple menu option.
- class wxc_sdk.common.HttpProxy(*, mode: HttpProxyMode | None = None, autoDiscoveryEnabled: bool | None = None, host: str | None = None, port: str | None = None, packUrl: str | None = None, authSettingsEnabled: bool | None = None, username: str | None = None, password: str | None = None)[source]
Bases:
ApiModel
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.
__init__ uses __pydantic_self__ instead of the more common self for the first arg to allow self as a field name.
- mode: HttpProxyMode | None
Mode of the HTTP proxy.
- auto_discovery_enabled: bool | None
Enable/disable auto discovery of the URL.
- host: str | None
Specify the host URL if the HTTP mode is set to MANUAL.
- port: str | None
Specify the port if the HTTP mode is set to MANUAL.
- pack_url: str | None
Specify PAC URL if auto discovery is disabled.
- auth_settings_enabled: bool | None
Enable/disable authentication settings.
- username: str | None
Specify a username if authentication settings are enabled.
- password: str | None
Specify a password if authentication settings are enabled.
- model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'extra': 'forbid', 'populate_by_name': True, 'use_enum_values': True}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'auth_settings_enabled': FieldInfo(annotation=Union[bool, NoneType], required=False, alias='authSettingsEnabled', alias_priority=1), 'auto_discovery_enabled': FieldInfo(annotation=Union[bool, NoneType], required=False, alias='autoDiscoveryEnabled', alias_priority=1), 'host': FieldInfo(annotation=Union[str, NoneType], required=False, alias='host', alias_priority=1), 'mode': FieldInfo(annotation=Union[HttpProxyMode, NoneType], required=False, alias='mode', alias_priority=1), 'pack_url': FieldInfo(annotation=Union[str, NoneType], required=False, alias='packUrl', alias_priority=1), 'password': FieldInfo(annotation=Union[str, NoneType], required=False, alias='password', alias_priority=1), 'port': FieldInfo(annotation=Union[str, NoneType], required=False, alias='port', alias_priority=1), 'username': FieldInfo(annotation=Union[str, NoneType], required=False, alias='username', alias_priority=1)}
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- class wxc_sdk.common.HttpProxyMode(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]
Bases:
str
,SafeEnum
An enumeration.
- off = 'OFF'
- auto = 'AUTO'
- manual = 'MANUAL'
- class wxc_sdk.common.BluetoothMode(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]
Bases:
str
,SafeEnum
An enumeration.
- phone = 'PHONE'
- hands_free = 'HANDS_FREE'
- both = 'BOTH'
- class wxc_sdk.common.BluetoothSetting(*, enabled: bool | None = None, mode: BluetoothMode | None = None)[source]
Bases:
ApiModel
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.
__init__ uses __pydantic_self__ instead of the more common self for the first arg to allow self as a field name.
- enabled: bool | None
Enable/disable Bluetooth.
- mode: BluetoothMode | None
Select a Bluetooth mode.
- model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'extra': 'forbid', 'populate_by_name': True, 'use_enum_values': True}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'enabled': FieldInfo(annotation=Union[bool, NoneType], required=False, alias='enabled', alias_priority=1), 'mode': FieldInfo(annotation=Union[BluetoothMode, NoneType], required=False, alias='mode', alias_priority=1)}
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- class wxc_sdk.common.NoiseCancellation(*, enabled: bool | None = None, allowEndUserOverrideEnabled: bool | None = None)[source]
Bases:
ApiModel
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.
__init__ uses __pydantic_self__ instead of the more common self for the first arg to allow self as a field name.
- enabled: bool | None
Enable/disable the Noise Cancellation.
- allow_end_user_override_enabled: bool | None
Enable/disable to preserve the existing values on the phone and not the value defined for the device setting.
- model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'extra': 'forbid', 'populate_by_name': True, 'use_enum_values': True}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'allow_end_user_override_enabled': FieldInfo(annotation=Union[bool, NoneType], required=False, alias='allowEndUserOverrideEnabled', alias_priority=1), 'enabled': FieldInfo(annotation=Union[bool, NoneType], required=False, alias='enabled', alias_priority=1)}
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- class wxc_sdk.common.SoftKeyLayout(*, softKeyMenu: SoftKeyMenu | None = None, psk: PskObject | None = None, softKeyMenuDefaults: SoftKeyMenu | None = None, pskDefaults: PskObject | None = None)[source]
Bases:
ApiModel
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.
__init__ uses __pydantic_self__ instead of the more common self for the first arg to allow self as a field name.
Customize SoftKey menu settings.
Default SoftKey menu settings.
- model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'extra': 'forbid', 'populate_by_name': True, 'use_enum_values': True}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'psk': FieldInfo(annotation=Union[PskObject, NoneType], required=False, alias='psk', alias_priority=1), 'psk_defaults': FieldInfo(annotation=Union[PskObject, NoneType], required=False, alias='pskDefaults', alias_priority=1), 'soft_key_menu': FieldInfo(annotation=Union[SoftKeyMenu, NoneType], required=False, alias='softKeyMenu', alias_priority=1), 'soft_key_menu_defaults': FieldInfo(annotation=Union[SoftKeyMenu, NoneType], required=False, alias='softKeyMenuDefaults', alias_priority=1)}
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- class wxc_sdk.common.SoftKeyMenu(*, idleKeyList: str | None = None, offHookKeyList: str | None = None, dialingInputKeyList: str | None = None, progressingKeyList: str | None = None, connectedKeyList: str | None = None, connectedVideoKeyList: str | None = None, startTransferKeyList: str | None = None, startConferenceKeyList: str | None = None, conferencingKeyList: str | None = None, releasingKeyList: str | None = None, holdKeyList: str | None = None, ringingKeyList: str | None = None, sharedActiveKeyList: str | None = None, sharedHeldKeyList: str | None = None)[source]
Bases:
ApiModel
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.
__init__ uses __pydantic_self__ instead of the more common self for the first arg to allow self as a field name.
- idle_key_list: str | None
Specify the idle key list.
- off_hook_key_list: str | None
Specify the off hook key list.
- dialing_input_key_list: str | None
Specify the dialing input key list.
- progressing_key_list: str | None
Specify the progressing key list.
- connected_key_list: str | None
Specify the connected key list.
- connected_video_key_list: str | None
Specify the connected video key list.
- start_transfer_key_list: str | None
Start the transfer key list.
- start_conference_key_list: str | None
Start the conference key list.
- conferencing_key_list: str | None
Specify the conferencing key list.
- releasing_key_list: str | None
Specify the releasing key list.
- hold_key_list: str | None
Specify the hold key list.
- ringing_key_list: str | None
Specify the ringing key list.
Specify the shared active key list.
Specify the shared held key list.
- model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'extra': 'forbid', 'populate_by_name': True, 'use_enum_values': True}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'conferencing_key_list': FieldInfo(annotation=Union[str, NoneType], required=False, alias='conferencingKeyList', alias_priority=1), 'connected_key_list': FieldInfo(annotation=Union[str, NoneType], required=False, alias='connectedKeyList', alias_priority=1), 'connected_video_key_list': FieldInfo(annotation=Union[str, NoneType], required=False, alias='connectedVideoKeyList', alias_priority=1), 'dialing_input_key_list': FieldInfo(annotation=Union[str, NoneType], required=False, alias='dialingInputKeyList', alias_priority=1), 'hold_key_list': FieldInfo(annotation=Union[str, NoneType], required=False, alias='holdKeyList', alias_priority=1), 'idle_key_list': FieldInfo(annotation=Union[str, NoneType], required=False, alias='idleKeyList', alias_priority=1), 'off_hook_key_list': FieldInfo(annotation=Union[str, NoneType], required=False, alias='offHookKeyList', alias_priority=1), 'progressing_key_list': FieldInfo(annotation=Union[str, NoneType], required=False, alias='progressingKeyList', alias_priority=1), 'releasing_key_list': FieldInfo(annotation=Union[str, NoneType], required=False, alias='releasingKeyList', alias_priority=1), 'ringing_key_list': FieldInfo(annotation=Union[str, NoneType], required=False, alias='ringingKeyList', alias_priority=1), 'shared_active_key_list': FieldInfo(annotation=Union[str, NoneType], required=False, alias='sharedActiveKeyList', alias_priority=1), 'shared_held_key_list': FieldInfo(annotation=Union[str, NoneType], required=False, alias='sharedHeldKeyList', alias_priority=1), 'start_conference_key_list': FieldInfo(annotation=Union[str, NoneType], required=False, alias='startConferenceKeyList', alias_priority=1), 'start_transfer_key_list': FieldInfo(annotation=Union[str, NoneType], required=False, alias='startTransferKeyList', alias_priority=1)}
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- class wxc_sdk.common.PskObject(*, psk1: str | None = None, psk2: str | None = None, psk3: str | None = None, psk4: str | None = None, psk5: str | None = None, psk6: str | None = None, psk7: str | None = None, psk8: str | None = None, psk9: str | None = None, psk10: str | None = None, psk11: str | None = None, psk12: str | None = None, psk13: str | None = None, psk14: str | None = None, psk15: str | None = None, psk16: str | None = None)[source]
Bases:
ApiModel
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.
__init__ uses __pydantic_self__ instead of the more common self for the first arg to allow self as a field name.
- psk1: str | None
Specify PSK1.
- psk2: str | None
Specify PSK2.
- psk3: str | None
Specify PSK3.
- psk4: str | None
Specify PSK4.
- psk5: str | None
Specify PSK5.
- psk6: str | None
Specify PSK6.
- psk7: str | None
Specify PSK7.
- psk8: str | None
Specify PSK8.
- psk9: str | None
Specify PSK9.
- psk10: str | None
Specify PSK10.
- psk11: str | None
Specify PSK11.
- psk12: str | None
Specify PSK12.
- psk13: str | None
Specify PSK13.
- psk14: str | None
Specify PSK14.
- psk15: str | None
Specify PSK15.
- psk16: str | None
Specify PSK16.
- model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'extra': 'forbid', 'populate_by_name': True, 'use_enum_values': True}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'psk1': FieldInfo(annotation=Union[str, NoneType], required=False, alias='psk1', alias_priority=1), 'psk10': FieldInfo(annotation=Union[str, NoneType], required=False, alias='psk10', alias_priority=1), 'psk11': FieldInfo(annotation=Union[str, NoneType], required=False, alias='psk11', alias_priority=1), 'psk12': FieldInfo(annotation=Union[str, NoneType], required=False, alias='psk12', alias_priority=1), 'psk13': FieldInfo(annotation=Union[str, NoneType], required=False, alias='psk13', alias_priority=1), 'psk14': FieldInfo(annotation=Union[str, NoneType], required=False, alias='psk14', alias_priority=1), 'psk15': FieldInfo(annotation=Union[str, NoneType], required=False, alias='psk15', alias_priority=1), 'psk16': FieldInfo(annotation=Union[str, NoneType], required=False, alias='psk16', alias_priority=1), 'psk2': FieldInfo(annotation=Union[str, NoneType], required=False, alias='psk2', alias_priority=1), 'psk3': FieldInfo(annotation=Union[str, NoneType], required=False, alias='psk3', alias_priority=1), 'psk4': FieldInfo(annotation=Union[str, NoneType], required=False, alias='psk4', alias_priority=1), 'psk5': FieldInfo(annotation=Union[str, NoneType], required=False, alias='psk5', alias_priority=1), 'psk6': FieldInfo(annotation=Union[str, NoneType], required=False, alias='psk6', alias_priority=1), 'psk7': FieldInfo(annotation=Union[str, NoneType], required=False, alias='psk7', alias_priority=1), 'psk8': FieldInfo(annotation=Union[str, NoneType], required=False, alias='psk8', alias_priority=1), 'psk9': FieldInfo(annotation=Union[str, NoneType], required=False, alias='psk9', alias_priority=1)}
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- class wxc_sdk.common.BackgroundImageColor(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]
Bases:
str
,SafeEnum
An enumeration.
- cyan_dark = 'CYAN_DARK'
Indicates that dark cyan background image will be set for the devices.
- purple_dark = 'PURPLE_DARK'
Indicates the dark purple background image will be set for the devices.
- blue_dark = 'BLUE_DARK'
Indicates the dark blue background image will be set for the devices.
- violet_dark = 'VIOLET_DARK'
Indicates the dark violet background image will be set for the devices.
- blue_light = 'BLUE_LIGHT'
Indicates the light blue background image will be set for the devices.
- violet_light = 'VIOLET_LIGHT'
Indicates the light violet background image will be set for the devices.
- class wxc_sdk.common.BacklightTimer68XX78XX(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]
Bases:
str
,SafeEnum
An enumeration.
- always_on = 'ALWAYS_ON'
Keep the phone’s backlight always on.
- ten_sec = 'TEN_SEC'
Set the phone’s backlight to be on for ten seconds.
- twenty_sec = 'TWENTY_SEC'
Set the phone’s backlight to be on for twenty seconds.
- thirty_sec = 'THIRTY_SEC'
Set the phone’s backlight to be on for thirty seconds.
- off = 'OFF'
Keep the phone’s backlight off.
- class wxc_sdk.common.DectCustomization(*, audioCodecPriority: AudioCodecPriority, cdpEnabled: bool, lldpEnabled: bool, qosEnabled: bool, vlan: VlanSetting, nightlyResyncEnabled: bool | None = None, webAccessEnabled: bool)[source]
Bases:
CommonDeviceCustomization
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.
__init__ uses __pydantic_self__ instead of the more common self for the first arg to allow self as a field name.
- web_access_enabled: bool
Enable/disable user level web access to the local device.
- model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'extra': 'forbid', 'populate_by_name': True, 'use_enum_values': True}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'audio_codec_priority': FieldInfo(annotation=AudioCodecPriority, required=True, alias='audioCodecPriority', alias_priority=1), 'cdp_enabled': FieldInfo(annotation=bool, required=True, alias='cdpEnabled', alias_priority=1), 'lldp_enabled': FieldInfo(annotation=bool, required=True, alias='lldpEnabled', alias_priority=1), 'nightly_resync_enabled': FieldInfo(annotation=Union[bool, NoneType], required=False, alias='nightlyResyncEnabled', alias_priority=1), 'qos_enabled': FieldInfo(annotation=bool, required=True, alias='qosEnabled', alias_priority=1), 'vlan': FieldInfo(annotation=VlanSetting, required=True, alias='vlan', alias_priority=1), 'web_access_enabled': FieldInfo(annotation=bool, required=True, alias='webAccessEnabled', alias_priority=1)}
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.