From faf3b1b90cc19d902b9b9623946e92ca16f5401d Mon Sep 17 00:00:00 2001 From: Nigel Metheringham Date: Tue, 29 Mar 2022 09:33:22 +0100 Subject: [PATCH] fix: regenerate broadworks classes --- broadworks_ocip/requests.py | 24736 ++++++++++++++--------------- broadworks_ocip/responses.py | 80 +- broadworks_ocip/types.py | 28056 +++++++++++++++++---------------- docs/api/requests.md | 8268 +++++----- docs/api/responses.md | 40 +- docs/api/types.md | 11416 +++++++------- 6 files changed, 36300 insertions(+), 36296 deletions(-) diff --git a/broadworks_ocip/requests.py b/broadworks_ocip/requests.py index 678e1b1..e4efeae 100644 --- a/broadworks_ocip/requests.py +++ b/broadworks_ocip/requests.py @@ -1,7 +1,7 @@ """Broadworks OCI-P Interface Request Classes""" # Autogenerated from the Broadworks XML Schemas. # Do not edit as changes will be overwritten. -# Generated on 2022-03-12T10:21:34.210441 +# Generated on 2022-03-29T09:12:43.402519 from typing import List from typing import Tuple @@ -79685,140 +79685,6 @@ def _elements(cls) -> Tuple[E, ...]: return () -class EnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAvailablePagedSortedListRequest( - OCIRequest, -): - """ - Request a list of available Mobile Subscriber Directory Numbers not yet assigned to - any user. - - If the responsePagingControl element is not provided, the paging startIndex will be - set to 1 by default, and the responsePageSize will be set to the maximum - ResponsePageSize by default. If no sortOrder is included the response is sorted by - Mobile Number ascending by default. Multiple search criteria are logically ANDed - together unless the searchCriteriaModeOr option is included. Then the search criteria - are logically ORed together. - - The response is either - `EnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAvailablePagedSortedListResponse()` - or `ErrorResponse()`. Replaced by: - `EnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAvailablePagedSortedListRequest22()` - - Attributes: - service_provider_id (str): serviceProviderId - response_paging_control (OCI.responsePagingControl): responsePagingControl - *Optional* - sort_by_mobile_directory_number (OCI.sortByMobileDirectoryNumber): - sortByMobileDirectoryNumber *Optional* - search_criteria_mobile_subscriber_directory_number - (List[OCI.searchCriteriaMobileSubscriberDirectoryNumber]): - searchCriteriaMobileSubscriberDirectoryNumber *Optional* - search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* - """ - - __slots__: List[str] = [ - "service_provider_id", - "response_paging_control", - "sort_by_mobile_directory_number", - "search_criteria_mobile_subscriber_directory_number", - "search_criteria_mode_or", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("service_provider_id", "serviceProviderId", str, is_required=True), - E( - "response_paging_control", - "responsePagingControl", - OCI.ResponsePagingControl, - is_complex=True, - ), - E( - "sort_by_mobile_directory_number", - "sortByMobileDirectoryNumber", - OCI.SortByMobileDirectoryNumber, - is_complex=True, - ), - E( - "search_criteria_mobile_subscriber_directory_number", - "searchCriteriaMobileSubscriberDirectoryNumber", - OCI.SearchCriteriaMobileSubscriberDirectoryNumber, - is_complex=True, - is_array=True, - ), - E("search_criteria_mode_or", "searchCriteriaModeOr", bool), - ) - - -class EnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAvailablePagedSortedListRequest22( - OCIRequest, -): - """ - Request a list of available Mobile Subscriber Directory Numbers not yet assigned to - any user. - - If the responsePagingControl element is not provided, the paging startIndex will be - set to 1 by default, and the responsePageSize will be set to the maximum - ResponsePageSize by default. If no sortOrder is included the response is sorted by - Mobile Number ascending by default. Multiple search criteria are logically ANDed - together unless the searchCriteriaModeOr option is included. Then the search criteria - are logically ORed together. - - The response is either - `EnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAvailablePagedSortedListResponse22()` - or `ErrorResponse()`. - - Attributes: - service_provider_id (str): serviceProviderId - include_total_number_of_rows (bool): includeTotalNumberOfRows *Optional* - response_paging_control (OCI.responsePagingControl): responsePagingControl - *Optional* - sort_by_mobile_directory_number (OCI.sortByMobileDirectoryNumber): - sortByMobileDirectoryNumber *Optional* - search_criteria_mobile_subscriber_directory_number - (List[OCI.searchCriteriaMobileSubscriberDirectoryNumber]): - searchCriteriaMobileSubscriberDirectoryNumber *Optional* - search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* - """ - - __slots__: List[str] = [ - "service_provider_id", - "include_total_number_of_rows", - "response_paging_control", - "sort_by_mobile_directory_number", - "search_criteria_mobile_subscriber_directory_number", - "search_criteria_mode_or", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("service_provider_id", "serviceProviderId", str, is_required=True), - E("include_total_number_of_rows", "includeTotalNumberOfRows", bool), - E( - "response_paging_control", - "responsePagingControl", - OCI.ResponsePagingControl, - is_complex=True, - ), - E( - "sort_by_mobile_directory_number", - "sortByMobileDirectoryNumber", - OCI.SortByMobileDirectoryNumber, - is_complex=True, - ), - E( - "search_criteria_mobile_subscriber_directory_number", - "searchCriteriaMobileSubscriberDirectoryNumber", - OCI.SearchCriteriaMobileSubscriberDirectoryNumber, - is_complex=True, - is_array=True, - ), - E("search_criteria_mode_or", "searchCriteriaModeOr", bool), - ) - - class EnterpriseCallCenterAgentThresholdProfileModifyRequest(OCIRequest): """ Modifies an existing Call Center Agent Threshold Profile in the Enterprise. @@ -80071,139 +79937,6 @@ def _elements(cls) -> Tuple[E, ...]: ) -class EnterpriseCallCenterCurrentAndPastAgentGetListRequest(OCIRequest): - """ - Request to all the current and past agents in the enterprise. - - The searchCriteriaExactUserGroup does not apply to past agents. - - The response is either `EnterpriseCallCenterCurrentAndPastAgentGetListResponse()` or - `ErrorResponse()`. - - Attributes: - service_provider_id (str): serviceProviderId - response_size_limit (int): responseSizeLimit *Optional* - search_criteria_user_last_name (List[OCI.searchCriteriaUserLastName]): - searchCriteriaUserLastName *Optional* - search_criteria_user_first_name (List[OCI.searchCriteriaUserFirstName]): - searchCriteriaUserFirstName *Optional* - search_criteria_exact_user_group (OCI.searchCriteriaExactUserGroup): - searchCriteriaExactUserGroup *Optional* - search_criteria_user_id (List[OCI.searchCriteriaUserId]): searchCriteriaUserId - *Optional* - search_criteria_dn (List[OCI.searchCriteriaDn]): searchCriteriaDn *Optional* - search_criteria_extension (List[OCI.searchCriteriaExtension]): - searchCriteriaExtension *Optional* - """ - - __slots__: List[str] = [ - "service_provider_id", - "response_size_limit", - "search_criteria_user_last_name", - "search_criteria_user_first_name", - "search_criteria_exact_user_group", - "search_criteria_user_id", - "search_criteria_dn", - "search_criteria_extension", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("service_provider_id", "serviceProviderId", str, is_required=True), - E("response_size_limit", "responseSizeLimit", int), - E( - "search_criteria_user_last_name", - "searchCriteriaUserLastName", - OCI.SearchCriteriaUserLastName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_first_name", - "searchCriteriaUserFirstName", - OCI.SearchCriteriaUserFirstName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_exact_user_group", - "searchCriteriaExactUserGroup", - OCI.SearchCriteriaExactUserGroup, - is_complex=True, - ), - E( - "search_criteria_user_id", - "searchCriteriaUserId", - OCI.SearchCriteriaUserId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_dn", - "searchCriteriaDn", - OCI.SearchCriteriaDn, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_extension", - "searchCriteriaExtension", - OCI.SearchCriteriaExtension, - is_complex=True, - is_array=True, - ), - ) - - -class EnterpriseCallCenterCurrentAndPastCallCenterGetListRequest(OCIRequest): - """ - Request to get all the current and past call centers for the enterprise. - - The searchCriteriaExactUserGroup does not apply to past call centers. - - The response is either `EnterpriseCallCenterCurrentAndPastCallCenterGetListResponse()` - or `ErrorResponse()`. - - Attributes: - service_provider_id (str): serviceProviderId - is_premium_only (bool): isPremiumOnly *Optional* - response_size_limit (int): responseSizeLimit *Optional* - search_criteria_exact_user_group (OCI.searchCriteriaExactUserGroup): - searchCriteriaExactUserGroup *Optional* - search_criteria_call_center_name (OCI.searchCriteriaCallCenterName): - searchCriteriaCallCenterName *Optional* - """ - - __slots__: List[str] = [ - "service_provider_id", - "is_premium_only", - "response_size_limit", - "search_criteria_exact_user_group", - "search_criteria_call_center_name", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("service_provider_id", "serviceProviderId", str, is_required=True), - E("is_premium_only", "isPremiumOnly", bool), - E("response_size_limit", "responseSizeLimit", int), - E( - "search_criteria_exact_user_group", - "searchCriteriaExactUserGroup", - OCI.SearchCriteriaExactUserGroup, - is_complex=True, - ), - E( - "search_criteria_call_center_name", - "searchCriteriaCallCenterName", - OCI.SearchCriteriaCallCenterName, - is_complex=True, - ), - ) - - class EnterpriseCallCenterEnhancedReportingBrandingModifyRequest(OCIRequest): """ Request to modify the enterprise branding configuration. @@ -80452,62 +80185,6 @@ def _elements(cls) -> Tuple[E, ...]: ) -class EnterpriseCommonPhoneListGetListRequest(OCIRequest): - """ - Get an enterprise's common phone list. - - The response is either a `EnterpriseCommonPhoneListGetListResponse()` or an - `ErrorResponse()`. The search can be done using multiple criterion. If the - searchCriteriaModeOr is present, any result matching any one criteria is included in - the results. Otherwise, only results matching all the search criterion are included - in the results. If no search criteria is specified, all results are returned. - Specifying searchCriteriaModeOr without any search criteria results in an - `ErrorResponse()`. In all cases, if a responseSizeLimit is specified and the number of - matching results is more than this limit, then an `ErrorResponse()` is returned. - - Attributes: - service_provider_id (str): serviceProviderId - response_size_limit (int): responseSizeLimit *Optional* - search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* - search_criteria_enterprise_common_phone_list_name - (List[OCI.searchCriteriaEnterpriseCommonPhoneListName]): - searchCriteriaEnterpriseCommonPhoneListName *Optional* - search_criteria_enterprise_common_phone_list_number - (List[OCI.searchCriteriaEnterpriseCommonPhoneListNumber]): - searchCriteriaEnterpriseCommonPhoneListNumber *Optional* - """ - - __slots__: List[str] = [ - "service_provider_id", - "response_size_limit", - "search_criteria_mode_or", - "search_criteria_enterprise_common_phone_list_name", - "search_criteria_enterprise_common_phone_list_number", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("service_provider_id", "serviceProviderId", str, is_required=True), - E("response_size_limit", "responseSizeLimit", int), - E("search_criteria_mode_or", "searchCriteriaModeOr", bool), - E( - "search_criteria_enterprise_common_phone_list_name", - "searchCriteriaEnterpriseCommonPhoneListName", - OCI.SearchCriteriaEnterpriseCommonPhoneListName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_enterprise_common_phone_list_number", - "searchCriteriaEnterpriseCommonPhoneListNumber", - OCI.SearchCriteriaEnterpriseCommonPhoneListNumber, - is_complex=True, - is_array=True, - ), - ) - - class EnterpriseCommunicationBarringAuthorizationCodeAddListRequest(OCIRequest): """ Add a list of Communication Barring Authorization codes to an enterprise. @@ -80539,416 +80216,6 @@ def _elements(cls) -> Tuple[E, ...]: ) -class EnterpriseCommunicationBarringAuthorizationCodeGetListRequest(OCIRequest): - """ - Get a list of Communication Barring Authorization Codes in an enterprise. - - The response is either - `EnterpriseCommunicationBarringAuthorizationCodeGetListResponse()` or - `ErrorResponse()`. - - Attributes: - service_provider_id (str): serviceProviderId - response_size_limit (int): responseSizeLimit *Optional* - search_criteria_communication_barring_authorization_code - (List[OCI.searchCriteriaCommunicationBarringAuthorizationCode]): - searchCriteriaCommunicationBarringAuthorizationCode *Optional* - search_criteria_communication_barring_authorization_code_description - (List[OCI.searchCriteriaCommunicationBarringAuthorizationCodeDescription]): - searchCriteriaCommunicationBarringAuthorizationCodeDescription *Optional* - search_criteria_network_class_of_service_name - (List[OCI.searchCriteriaNetworkClassOfServiceName]): - searchCriteriaNetworkClassOfServiceName *Optional* - """ - - __slots__: List[str] = [ - "service_provider_id", - "response_size_limit", - "search_criteria_communication_barring_authorization_code", - "search_criteria_communication_barring_authorization_code_description", - "search_criteria_network_class_of_service_name", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("service_provider_id", "serviceProviderId", str, is_required=True), - E("response_size_limit", "responseSizeLimit", int), - E( - "search_criteria_communication_barring_authorization_code", - "searchCriteriaCommunicationBarringAuthorizationCode", - OCI.SearchCriteriaCommunicationBarringAuthorizationCode, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_communication_barring_authorization_code_description", - "searchCriteriaCommunicationBarringAuthorizationCodeDescription", - OCI.SearchCriteriaCommunicationBarringAuthorizationCodeDescription, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_network_class_of_service_name", - "searchCriteriaNetworkClassOfServiceName", - OCI.SearchCriteriaNetworkClassOfServiceName, - is_complex=True, - is_array=True, - ), - ) - - -class EnterpriseDepartmentAddRequest(OCIRequest): - """ - Add a department to enterprise. - - The response is either a `SuccessResponse()` or an `ErrorResponse()`. - - Attributes: - enterprise_id (str): enterpriseId - department_name (str): departmentName - parent_department_key (OCI.parentDepartmentKey): parentDepartmentKey *Optional* - """ - - __slots__: List[str] = [ - "enterprise_id", - "department_name", - "parent_department_key", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("enterprise_id", "enterpriseId", str, is_required=True), - E("department_name", "departmentName", str, is_required=True), - E( - "parent_department_key", - "parentDepartmentKey", - OCI.EnterpriseDepartmentKey, - is_complex=True, - ), - ) - - -class EnterpriseDepartmentModifyRequest(OCIRequest): - """ - Modify a department of an enterprise. - - The response is either a `SuccessResponse()` or an `ErrorResponse()`. - - Attributes: - enterprise_id (str): enterpriseId - department_name (str): departmentName - new_department_name (str): newDepartmentName *Optional* - new_parent_department_key (OCI.newParentDepartmentKey): newParentDepartmentKey - *Optional* - """ - - __slots__: List[str] = [ - "enterprise_id", - "department_name", - "new_department_name", - "new_parent_department_key", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("enterprise_id", "enterpriseId", str, is_required=True), - E("department_name", "departmentName", str, is_required=True), - E("new_department_name", "newDepartmentName", str), - E( - "new_parent_department_key", - "newParentDepartmentKey", - OCI.EnterpriseDepartmentKey, - is_complex=True, - ), - ) - - -class EnterpriseEnterpriseTrunkGetAvailableTrunkGroupListRequest(OCIRequest): - """ - Request to get the list of all available trunk groups defined in an enterprise. - - It is possible to search by various criteria to restrict the number of rows returned. - Multiple search criteria are logically ANDed together. - - The response is either a - `EnterpriseEnterpriseTrunkGetAvailableTrunkGroupListResponse()` or an - `ErrorResponse()`. - - Attributes: - service_provider_id (str): serviceProviderId - response_size_limit (int): responseSizeLimit *Optional* - search_criteria_trunk_group_name (List[OCI.searchCriteriaTrunkGroupName]): - searchCriteriaTrunkGroupName *Optional* - search_criteria_group_id (List[OCI.searchCriteriaGroupId]): searchCriteriaGroupId - *Optional* - """ - - __slots__: List[str] = [ - "service_provider_id", - "response_size_limit", - "search_criteria_trunk_group_name", - "search_criteria_group_id", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("service_provider_id", "serviceProviderId", str, is_required=True), - E("response_size_limit", "responseSizeLimit", int), - E( - "search_criteria_trunk_group_name", - "searchCriteriaTrunkGroupName", - OCI.SearchCriteriaTrunkGroupName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_group_id", - "searchCriteriaGroupId", - OCI.SearchCriteriaGroupId, - is_complex=True, - is_array=True, - ), - ) - - -class EnterpriseLocalGatewayGetPagedSortedListRequest(OCIRequest): - """ - Get a list of local gateways defined within an enterprise. - - Only the local gateways having device associated are returned. If the - responsePagingControl element is not provided, the paging startIndex will be set to 1 - by default, and the responsePageSize will be set to the maximum ResponsePageSize by - default. If no sortOrder is included the response is sorted by Trunk group name - ascending by default. Multiple search criteria are logically ANDed together unless - the searchCriteriaModeOr option is included. Then the search criteria are logically - ORed together. - - The response is either a `EnterpriseLocalGatewayGetPagedSortedListResponse()` or an - `ErrorResponse()`. - - Attributes: - service_provider_id (str): serviceProviderId - response_paging_control (OCI.responsePagingControl): responsePagingControl - *Optional* - sort_by_trunk_group_name (OCI.sortByTrunkGroupName): sortByTrunkGroupName - *Optional* - search_criteria_trunk_group_name (List[OCI.searchCriteriaTrunkGroupName]): - searchCriteriaTrunkGroupName *Optional* - search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* - """ - - __slots__: List[str] = [ - "service_provider_id", - "response_paging_control", - "sort_by_trunk_group_name", - "search_criteria_trunk_group_name", - "search_criteria_mode_or", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("service_provider_id", "serviceProviderId", str, is_required=True), - E( - "response_paging_control", - "responsePagingControl", - OCI.ResponsePagingControl, - is_complex=True, - ), - E( - "sort_by_trunk_group_name", - "sortByTrunkGroupName", - OCI.SortByTrunkGroupName, - is_complex=True, - ), - E( - "search_criteria_trunk_group_name", - "searchCriteriaTrunkGroupName", - OCI.SearchCriteriaTrunkGroupName, - is_complex=True, - is_array=True, - ), - E("search_criteria_mode_or", "searchCriteriaModeOr", bool), - ) - - -class EnterpriseSessionAdmissionControlGetAvailableDeviceListRequest(OCIRequest): - """ - Request to get the list of devices can be assigned to session admission control group - for the enterprise. - - The response is either an - `EnterpriseSessionAdmissionControlGetAvailableDeviceListResponse()` or an - `ErrorResponse()`. - - Attributes: - service_provider_id (str): serviceProviderId - response_size_limit (int): responseSizeLimit *Optional* - search_criteria_device_name (List[OCI.searchCriteriaDeviceName]): - searchCriteriaDeviceName *Optional* - search_criteria_device_mac_address (List[OCI.searchCriteriaDeviceMACAddress]): - searchCriteriaDeviceMACAddress *Optional* - search_criteria_device_net_address (List[OCI.searchCriteriaDeviceNetAddress]): - searchCriteriaDeviceNetAddress *Optional* - search_criteria_group_id (List[OCI.searchCriteriaGroupId]): searchCriteriaGroupId - *Optional* - search_criteria_exact_device_type (OCI.searchCriteriaExactDeviceType): - searchCriteriaExactDeviceType *Optional* - search_criteria_exact_device_level (OCI.searchCriteriaExactDeviceLevel): - searchCriteriaExactDeviceLevel *Optional* - """ - - __slots__: List[str] = [ - "service_provider_id", - "response_size_limit", - "search_criteria_device_name", - "search_criteria_device_mac_address", - "search_criteria_device_net_address", - "search_criteria_group_id", - "search_criteria_exact_device_type", - "search_criteria_exact_device_level", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("service_provider_id", "serviceProviderId", str, is_required=True), - E("response_size_limit", "responseSizeLimit", int), - E( - "search_criteria_device_name", - "searchCriteriaDeviceName", - OCI.SearchCriteriaDeviceName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_device_mac_address", - "searchCriteriaDeviceMACAddress", - OCI.SearchCriteriaDeviceMACAddress, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_device_net_address", - "searchCriteriaDeviceNetAddress", - OCI.SearchCriteriaDeviceNetAddress, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_group_id", - "searchCriteriaGroupId", - OCI.SearchCriteriaGroupId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_exact_device_type", - "searchCriteriaExactDeviceType", - OCI.SearchCriteriaExactDeviceType, - is_complex=True, - ), - E( - "search_criteria_exact_device_level", - "searchCriteriaExactDeviceLevel", - OCI.SearchCriteriaExactDeviceLevel, - is_complex=True, - ), - ) - - -class EnterpriseVirtualOnNetEnterpriseExtensionsGetUserListRequest(OCIRequest): - """ - Request the list of Virtual On-Net users in an Enterprise. - - It is possible to search by various criteria to restrict the number of rows returned. - Multiple search criteria are logically ANDed together. - - The response is either a - `EnterpriseVirtualOnNetEnterpriseExtensionsGetUserListResponse()` or an - `ErrorResponse()`. - - Attributes: - service_provider_id (str): serviceProviderId - response_size_limit (int): responseSizeLimit *Optional* - search_criteria_user_last_name (List[OCI.searchCriteriaUserLastName]): - searchCriteriaUserLastName *Optional* - search_criteria_user_first_name (List[OCI.searchCriteriaUserFirstName]): - searchCriteriaUserFirstName *Optional* - search_criteria_dn (List[OCI.searchCriteriaDn]): searchCriteriaDn *Optional* - search_criteria_group_location_code (List[OCI.searchCriteriaGroupLocationCode]): - searchCriteriaGroupLocationCode *Optional* - search_criteria_extension (List[OCI.searchCriteriaExtension]): - searchCriteriaExtension *Optional* - search_criteria_exact_virtual_on_net_call_type_name - (OCI.searchCriteriaExactVirtualOnNetCallTypeName): - searchCriteriaExactVirtualOnNetCallTypeName *Optional* - """ - - __slots__: List[str] = [ - "service_provider_id", - "response_size_limit", - "search_criteria_user_last_name", - "search_criteria_user_first_name", - "search_criteria_dn", - "search_criteria_group_location_code", - "search_criteria_extension", - "search_criteria_exact_virtual_on_net_call_type_name", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("service_provider_id", "serviceProviderId", str, is_required=True), - E("response_size_limit", "responseSizeLimit", int), - E( - "search_criteria_user_last_name", - "searchCriteriaUserLastName", - OCI.SearchCriteriaUserLastName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_first_name", - "searchCriteriaUserFirstName", - OCI.SearchCriteriaUserFirstName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_dn", - "searchCriteriaDn", - OCI.SearchCriteriaDn, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_group_location_code", - "searchCriteriaGroupLocationCode", - OCI.SearchCriteriaGroupLocationCode, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_extension", - "searchCriteriaExtension", - OCI.SearchCriteriaExtension, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_exact_virtual_on_net_call_type_name", - "searchCriteriaExactVirtualOnNetCallTypeName", - OCI.SearchCriteriaExactVirtualOnNetCallTypeName, - is_complex=True, - ), - ) - - class EnterpriseVoiceVPNAddPolicyRequest(OCIRequest): """ Add the enterprise level data associated with a Voice VPN location code. @@ -81000,53 +80267,6 @@ def _elements(cls) -> Tuple[E, ...]: ) -class EnterpriseVoiceVPNGetPolicyListRequest(OCIRequest): - """ - Request the list of Voice VPN locations. - - It is possible to search by various criteria to restrict the number of rows returned. - Multiple search criteria are logically ANDed together. - - The response is either a `EnterpriseVoiceVPNGetPolicyListResponse()` or an - `ErrorResponse()`. - - Attributes: - service_provider_id (str): serviceProviderId - response_size_limit (int): responseSizeLimit *Optional* - search_criteria_group_location_code (List[OCI.searchCriteriaGroupLocationCode]): - searchCriteriaGroupLocationCode *Optional* - search_criteria_exact_policy_selection (OCI.searchCriteriaExactPolicySelection): - searchCriteriaExactPolicySelection *Optional* - """ - - __slots__: List[str] = [ - "service_provider_id", - "response_size_limit", - "search_criteria_group_location_code", - "search_criteria_exact_policy_selection", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("service_provider_id", "serviceProviderId", str, is_required=True), - E("response_size_limit", "responseSizeLimit", int), - E( - "search_criteria_group_location_code", - "searchCriteriaGroupLocationCode", - OCI.SearchCriteriaGroupLocationCode, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_exact_policy_selection", - "searchCriteriaExactPolicySelection", - OCI.SearchCriteriaExactPolicySelection, - is_complex=True, - ), - ) - - class EnterpriseVoiceVPNModifyPolicyRequest(OCIRequest): """ Modify the enterprise level data associated with a Voice VPN location code. @@ -81578,231 +80798,6 @@ def _elements(cls) -> Tuple[E, ...]: ) -class GroupAccessDeviceGetListRequest(OCIRequest): - """ - Requests the list of access devices in a group. - - The following elements are only used in AS data mode and ignored in XS data mode: - groupExternalId - - The response is either `GroupAccessDeviceGetListResponse()` or `ErrorResponse()`. - - Attributes: - service_provider_id (str): serviceProviderId *Optional* - group_id (str): groupId *Optional* - group_external_id (str): groupExternalId *Optional* - response_size_limit (int): responseSizeLimit *Optional* - search_criteria_device_name (List[OCI.searchCriteriaDeviceName]): - searchCriteriaDeviceName *Optional* - search_criteria_device_mac_address (List[OCI.searchCriteriaDeviceMACAddress]): - searchCriteriaDeviceMACAddress *Optional* - search_criteria_device_net_address (List[OCI.searchCriteriaDeviceNetAddress]): - searchCriteriaDeviceNetAddress *Optional* - search_criteria_exact_device_type (OCI.searchCriteriaExactDeviceType): - searchCriteriaExactDeviceType *Optional* - search_criteria_access_device_version - (List[OCI.searchCriteriaAccessDeviceVersion]): - searchCriteriaAccessDeviceVersion *Optional* - """ - - __slots__: List[str] = [ - "service_provider_id", - "group_id", - "group_external_id", - "response_size_limit", - "search_criteria_device_name", - "search_criteria_device_mac_address", - "search_criteria_device_net_address", - "search_criteria_exact_device_type", - "search_criteria_access_device_version", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("service_provider_id", "serviceProviderId", str), - E("group_id", "groupId", str), - E("group_external_id", "groupExternalId", str), - E("response_size_limit", "responseSizeLimit", int), - E( - "search_criteria_device_name", - "searchCriteriaDeviceName", - OCI.SearchCriteriaDeviceName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_device_mac_address", - "searchCriteriaDeviceMACAddress", - OCI.SearchCriteriaDeviceMACAddress, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_device_net_address", - "searchCriteriaDeviceNetAddress", - OCI.SearchCriteriaDeviceNetAddress, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_exact_device_type", - "searchCriteriaExactDeviceType", - OCI.SearchCriteriaExactDeviceType, - is_complex=True, - ), - E( - "search_criteria_access_device_version", - "searchCriteriaAccessDeviceVersion", - OCI.SearchCriteriaAccessDeviceVersion, - is_complex=True, - is_array=True, - ), - ) - - -class GroupAccessDeviceGetPagedSortedListRequest(OCIRequest): - """ - Requests the list of access devices in a group. - - The response is either `GroupAccessDeviceGetPagedSortedListResponse()` or - `ErrorResponse()`. If no sortOrder is included, the response is sorted by Device Name - ascending by default. If the responsePagingControl element is not provided, the - paging startIndex will be set to 1 by default, and the responsePageSize will be set to - the maximum responsePageSize by default. Multiple search criteria are logically ANDed - together unless the searchCriteriaModeOr option is included. Then the search criteria - are logically ORed together. The getVisualDeviceManagementAPIDevicesOnly element can - only be set when CloudPBX is licenced. If the getVisualDeviceManagementAPIDevicesOnly - element is not set, all devices are returned with Visual Device Management API flag - set to empty. If the getVisualDeviceManagementAPIDevicesOnly element is set to true, - only SIP devices supporting Visual Device Management API are returned. If the - getVisualDeviceManagementAPIDevicesOnly element is set to false, all SIP devices are - returned with their current Visual Device Management API flag value. Replaced by - `GroupAccessDeviceGetPagedSortedListRequest22()`. - - Attributes: - service_provider_id (str): serviceProviderId - group_id (str): groupId - response_paging_control (OCI.responsePagingControl): responsePagingControl - *Optional* - sort_by_device_name (OCI.sortByDeviceName): sortByDeviceName *Optional* - sort_by_device_type (OCI.sortByDeviceType): sortByDeviceType *Optional* - sort_by_device_net_address (OCI.sortByDeviceNetAddress): sortByDeviceNetAddress - *Optional* - sort_by_device_mac_address (OCI.sortByDeviceMACAddress): sortByDeviceMACAddress - *Optional* - search_criteria_device_name (List[OCI.searchCriteriaDeviceName]): - searchCriteriaDeviceName *Optional* - search_criteria_device_mac_address (List[OCI.searchCriteriaDeviceMACAddress]): - searchCriteriaDeviceMACAddress *Optional* - search_criteria_device_net_address (List[OCI.searchCriteriaDeviceNetAddress]): - searchCriteriaDeviceNetAddress *Optional* - search_criteria_exact_device_type (List[OCI.searchCriteriaExactDeviceType]): - searchCriteriaExactDeviceType *Optional* - search_criteria_access_device_version - (List[OCI.searchCriteriaAccessDeviceVersion]): - searchCriteriaAccessDeviceVersion *Optional* - search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* - get_visual_device_management_api_devices_only (bool): - getVisualDeviceManagementAPIDevicesOnly *Optional* - """ - - __slots__: List[str] = [ - "service_provider_id", - "group_id", - "response_paging_control", - "sort_by_device_name", - "sort_by_device_type", - "sort_by_device_net_address", - "sort_by_device_mac_address", - "search_criteria_device_name", - "search_criteria_device_mac_address", - "search_criteria_device_net_address", - "search_criteria_exact_device_type", - "search_criteria_access_device_version", - "search_criteria_mode_or", - "get_visual_device_management_api_devices_only", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("service_provider_id", "serviceProviderId", str, is_required=True), - E("group_id", "groupId", str, is_required=True), - E( - "response_paging_control", - "responsePagingControl", - OCI.ResponsePagingControl, - is_complex=True, - ), - E( - "sort_by_device_name", - "sortByDeviceName", - OCI.SortByDeviceName, - is_complex=True, - ), - E( - "sort_by_device_type", - "sortByDeviceType", - OCI.SortByDeviceType, - is_complex=True, - ), - E( - "sort_by_device_net_address", - "sortByDeviceNetAddress", - OCI.SortByDeviceNetAddress, - is_complex=True, - ), - E( - "sort_by_device_mac_address", - "sortByDeviceMACAddress", - OCI.SortByDeviceMACAddress, - is_complex=True, - ), - E( - "search_criteria_device_name", - "searchCriteriaDeviceName", - OCI.SearchCriteriaDeviceName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_device_mac_address", - "searchCriteriaDeviceMACAddress", - OCI.SearchCriteriaDeviceMACAddress, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_device_net_address", - "searchCriteriaDeviceNetAddress", - OCI.SearchCriteriaDeviceNetAddress, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_exact_device_type", - "searchCriteriaExactDeviceType", - OCI.SearchCriteriaExactDeviceType, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_access_device_version", - "searchCriteriaAccessDeviceVersion", - OCI.SearchCriteriaAccessDeviceVersion, - is_complex=True, - is_array=True, - ), - E("search_criteria_mode_or", "searchCriteriaModeOr", bool), - E( - "get_visual_device_management_api_devices_only", - "getVisualDeviceManagementAPIDevicesOnly", - bool, - ), - ) - - class GroupAccessDeviceLinkDeviceListRequest(OCIRequest): """ Request to link one or more leaf devices to a group level tree device. @@ -82357,166 +81352,12 @@ def _elements(cls) -> Tuple[E, ...]: ) -class GroupAnnouncementFileGetListRequest(OCIRequest): +class GroupAnnouncementFileGetRequest(OCIRequest): """ - Get the list of available announcement files for a Group. - - The following elements are only used in AS data mode and ignored in XS data mode: - groupExternalId + Request to get the announcement repository file information. - The response is either a `GroupAnnouncementFileGetListResponse()` or an - `ErrorResponse()`. - - Attributes: - service_provider_id (str): serviceProviderId *Optional* - group_id (str): groupId *Optional* - group_external_id (str): groupExternalId *Optional* - announcement_file_type (str): announcementFileType *Optional* - include_announcement_table (bool): includeAnnouncementTable - response_size_limit (int): responseSizeLimit *Optional* - search_criteria_announcement_file_name - (List[OCI.searchCriteriaAnnouncementFileName]): - searchCriteriaAnnouncementFileName *Optional* - """ - - __slots__: List[str] = [ - "service_provider_id", - "group_id", - "group_external_id", - "announcement_file_type", - "include_announcement_table", - "response_size_limit", - "search_criteria_announcement_file_name", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("service_provider_id", "serviceProviderId", str), - E("group_id", "groupId", str), - E("group_external_id", "groupExternalId", str), - E("announcement_file_type", "announcementFileType", str), - E( - "include_announcement_table", - "includeAnnouncementTable", - bool, - is_required=True, - ), - E("response_size_limit", "responseSizeLimit", int), - E( - "search_criteria_announcement_file_name", - "searchCriteriaAnnouncementFileName", - OCI.SearchCriteriaAnnouncementFileName, - is_complex=True, - is_array=True, - ), - ) - - -class GroupAnnouncementFileGetPagedSortedListRequest(OCIRequest): - """ - Get the list of available announcement files for a Group. - - If the responsePagingControl element is not provided, the paging startIndex will be - set to 1 by default, and the responsePageSize will be set to the maximum - responsePageSize by default. If no sortOrder is included, the response is sorted by - Name ascending by default. Multiple search criteria are logically ANDed together - unless the searchCriteriaModeOr option is included. Then the search criteria are - logically ORed together. The following elements are only used in AS data mode and - ignored in XS data mode: groupExternalId - - The response is either a `GroupAnnouncementFileGetPagedSortedListResponse()` or an - `ErrorResponse()`. - - Attributes: - service_provider_id (str): serviceProviderId *Optional* - group_id (str): groupId *Optional* - group_external_id (str): groupExternalId *Optional* - response_paging_control (OCI.responsePagingControl): responsePagingControl - *Optional* - sort_by_announcement_file_name (OCI.sortByAnnouncementFileName): - sortByAnnouncementFileName *Optional* - sort_by_announcement_file_size (OCI.sortByAnnouncementFileSize): - sortByAnnouncementFileSize *Optional* - search_criteria_announcement_file_name - (List[OCI.searchCriteriaAnnouncementFileName]): - searchCriteriaAnnouncementFileName *Optional* - search_criteria_exact_announcement_file_type - (OCI.searchCriteriaExactAnnouncementFileType): - searchCriteriaExactAnnouncementFileType *Optional* - search_criteria_exact_media_file_type - (List[OCI.searchCriteriaExactMediaFileType]): searchCriteriaExactMediaFileType - *Optional* - search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* - """ - - __slots__: List[str] = [ - "service_provider_id", - "group_id", - "group_external_id", - "response_paging_control", - "sort_by_announcement_file_name", - "sort_by_announcement_file_size", - "search_criteria_announcement_file_name", - "search_criteria_exact_announcement_file_type", - "search_criteria_exact_media_file_type", - "search_criteria_mode_or", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("service_provider_id", "serviceProviderId", str), - E("group_id", "groupId", str), - E("group_external_id", "groupExternalId", str), - E( - "response_paging_control", - "responsePagingControl", - OCI.ResponsePagingControl, - is_complex=True, - ), - E( - "sort_by_announcement_file_name", - "sortByAnnouncementFileName", - OCI.SortByAnnouncementFileName, - is_complex=True, - ), - E( - "sort_by_announcement_file_size", - "sortByAnnouncementFileSize", - OCI.SortByAnnouncementFileSize, - is_complex=True, - ), - E( - "search_criteria_announcement_file_name", - "searchCriteriaAnnouncementFileName", - OCI.SearchCriteriaAnnouncementFileName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_exact_announcement_file_type", - "searchCriteriaExactAnnouncementFileType", - OCI.SearchCriteriaExactAnnouncementFileType, - is_complex=True, - ), - E( - "search_criteria_exact_media_file_type", - "searchCriteriaExactMediaFileType", - OCI.SearchCriteriaExactMediaFileType, - is_complex=True, - is_array=True, - ), - E("search_criteria_mode_or", "searchCriteriaModeOr", bool), - ) - - -class GroupAnnouncementFileGetRequest(OCIRequest): - """ - Request to get the announcement repository file information. - - The response is either `GroupAnnouncementFileGetResponse()` or `ErrorResponse()`. - Replaced by: `GroupAnnouncementFileGetRequest22()`. + The response is either `GroupAnnouncementFileGetResponse()` or `ErrorResponse()`. + Replaced by: `GroupAnnouncementFileGetRequest22()`. Attributes: service_provider_id (str): serviceProviderId @@ -83227,123 +82068,6 @@ def _elements(cls) -> Tuple[E, ...]: ) -class GroupCallCenterCurrentAndPastAgentGetListRequest(OCIRequest): - """ - Request to get all the current and past agents for the group. - - The response is either `GroupCallCenterCurrentAndPastAgentGetListResponse()` or - `ErrorResponse()`. - - Attributes: - service_provider_id (str): serviceProviderId - group_id (str): groupId - response_size_limit (int): responseSizeLimit *Optional* - search_criteria_user_last_name (List[OCI.searchCriteriaUserLastName]): - searchCriteriaUserLastName *Optional* - search_criteria_user_first_name (List[OCI.searchCriteriaUserFirstName]): - searchCriteriaUserFirstName *Optional* - search_criteria_user_id (List[OCI.searchCriteriaUserId]): searchCriteriaUserId - *Optional* - search_criteria_dn (List[OCI.searchCriteriaDn]): searchCriteriaDn *Optional* - search_criteria_extension (List[OCI.searchCriteriaExtension]): - searchCriteriaExtension *Optional* - """ - - __slots__: List[str] = [ - "service_provider_id", - "group_id", - "response_size_limit", - "search_criteria_user_last_name", - "search_criteria_user_first_name", - "search_criteria_user_id", - "search_criteria_dn", - "search_criteria_extension", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("service_provider_id", "serviceProviderId", str, is_required=True), - E("group_id", "groupId", str, is_required=True), - E("response_size_limit", "responseSizeLimit", int), - E( - "search_criteria_user_last_name", - "searchCriteriaUserLastName", - OCI.SearchCriteriaUserLastName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_first_name", - "searchCriteriaUserFirstName", - OCI.SearchCriteriaUserFirstName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_id", - "searchCriteriaUserId", - OCI.SearchCriteriaUserId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_dn", - "searchCriteriaDn", - OCI.SearchCriteriaDn, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_extension", - "searchCriteriaExtension", - OCI.SearchCriteriaExtension, - is_complex=True, - is_array=True, - ), - ) - - -class GroupCallCenterCurrentAndPastCallCenterGetListRequest(OCIRequest): - """ - Request to get all the current and past call centers for the group. - - The response is either `GroupCallCenterCurrentAndPastCallCenterGetListResponse()` or - `ErrorResponse()`. - - Attributes: - service_provider_id (str): serviceProviderId - is_premium_only (bool): isPremiumOnly *Optional* - group_id (str): groupId - response_size_limit (int): responseSizeLimit *Optional* - search_criteria_call_center_name (OCI.searchCriteriaCallCenterName): - searchCriteriaCallCenterName *Optional* - """ - - __slots__: List[str] = [ - "service_provider_id", - "is_premium_only", - "group_id", - "response_size_limit", - "search_criteria_call_center_name", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("service_provider_id", "serviceProviderId", str, is_required=True), - E("is_premium_only", "isPremiumOnly", bool), - E("group_id", "groupId", str, is_required=True), - E("response_size_limit", "responseSizeLimit", int), - E( - "search_criteria_call_center_name", - "searchCriteriaCallCenterName", - OCI.SearchCriteriaCallCenterName, - is_complex=True, - ), - ) - - class GroupCallCenterDeleteDNISRequest(OCIRequest): """ Delete a call center's DNIS. @@ -83557,139 +82281,6 @@ def _elements(cls) -> Tuple[E, ...]: ) -class GroupCallCenterGetAgentPagedSortedListRequest(OCIRequest): - """ - Get a list of agents assigned to a call center. - - If the responsePagingControl element is not provided, the paging startIndex will be - set to 1 by default, and the responsePageSize will be set to the maximum - ResponsePageSize by default. It is possible to search by various criteria to restrict - the number of rows returned. Multiple search criteria are logically ANDed together - unless the searchCriteriaModeOr option is included. Then the search criteria are - logically ORed together. `ErrorResponse()` is returned if - searchCriteriaExactUserGroup or searchCriteriaExactSkillLevel have multiple entries - and searchCriteriaModeOr is not included. Sorting is done on either a priority basis - or a skill basis depending on the type of call center. - - The response is either a `GroupCallCenterGetAgentPagedSortedListResponse()` or an - `ErrorResponse()`. - - Attributes: - service_user_id (str): serviceUserId - response_paging_control (OCI.responsePagingControl): responsePagingControl - *Optional* - search_criteria_user_id (List[OCI.searchCriteriaUserId]): searchCriteriaUserId - *Optional* - search_criteria_user_last_name (List[OCI.searchCriteriaUserLastName]): - searchCriteriaUserLastName *Optional* - search_criteria_user_first_name (List[OCI.searchCriteriaUserFirstName]): - searchCriteriaUserFirstName *Optional* - search_criteria_dn (List[OCI.searchCriteriaDn]): searchCriteriaDn *Optional* - search_criteria_extension (List[OCI.searchCriteriaExtension]): - searchCriteriaExtension *Optional* - search_criteria_department_name (List[OCI.searchCriteriaDepartmentName]): - searchCriteriaDepartmentName *Optional* - search_criteria_email_address (List[OCI.searchCriteriaEmailAddress]): - searchCriteriaEmailAddress *Optional* - search_criteria_exact_skill_level (List[OCI.searchCriteriaExactSkillLevel]): - searchCriteriaExactSkillLevel *Optional* - search_criteria_exact_user_group (List[OCI.searchCriteriaExactUserGroup]): - searchCriteriaExactUserGroup *Optional* - search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* - """ - - __slots__: List[str] = [ - "service_user_id", - "response_paging_control", - "search_criteria_user_id", - "search_criteria_user_last_name", - "search_criteria_user_first_name", - "search_criteria_dn", - "search_criteria_extension", - "search_criteria_department_name", - "search_criteria_email_address", - "search_criteria_exact_skill_level", - "search_criteria_exact_user_group", - "search_criteria_mode_or", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("service_user_id", "serviceUserId", str, is_required=True), - E( - "response_paging_control", - "responsePagingControl", - OCI.ResponsePagingControl, - is_complex=True, - ), - E( - "search_criteria_user_id", - "searchCriteriaUserId", - OCI.SearchCriteriaUserId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_last_name", - "searchCriteriaUserLastName", - OCI.SearchCriteriaUserLastName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_first_name", - "searchCriteriaUserFirstName", - OCI.SearchCriteriaUserFirstName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_dn", - "searchCriteriaDn", - OCI.SearchCriteriaDn, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_extension", - "searchCriteriaExtension", - OCI.SearchCriteriaExtension, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_department_name", - "searchCriteriaDepartmentName", - OCI.SearchCriteriaDepartmentName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_email_address", - "searchCriteriaEmailAddress", - OCI.SearchCriteriaEmailAddress, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_exact_skill_level", - "searchCriteriaExactSkillLevel", - OCI.SearchCriteriaExactSkillLevel, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_exact_user_group", - "searchCriteriaExactUserGroup", - OCI.SearchCriteriaExactUserGroup, - is_complex=True, - is_array=True, - ), - E("search_criteria_mode_or", "searchCriteriaModeOr", bool), - ) - - class GroupCallCenterGetDNISAgentListRequest(OCIRequest): """ Get a list of agent who selected the DNIS as the outgoing call. @@ -84482,185 +83073,6 @@ def _elements(cls) -> Tuple[E, ...]: ) -class GroupCallParkGetInstancePagedSortedListRequest(OCIRequest): - """ - Request to get a list of Call Park group instances within a group. - - If the responsePagingControl element is not provided, the paging startIndex will be - set to 1 by default, and the responsePageSize will be set to the maximum - ResponsePageSize by default. It is possible to search by various criteria to restrict - the number of rows returned. Multiple search criteria are logically ANDed together - unless the searchCriteriaModeOr option is included. Then the search criteria are - logically ORed together. - - The response is either `GroupCallParkGetInstancePagedSortedListResponse()` or - `ErrorResponse()`. - - Attributes: - service_provider_id (str): serviceProviderId - group_id (str): groupId - response_paging_control (OCI.responsePagingControl): responsePagingControl - *Optional* - sort_by_call_park_name (OCI.sortByCallParkName): sortByCallParkName *Optional* - search_criteria_call_park_name (List[OCI.searchCriteriaCallParkName]): - searchCriteriaCallParkName *Optional* - search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* - """ - - __slots__: List[str] = [ - "service_provider_id", - "group_id", - "response_paging_control", - "sort_by_call_park_name", - "search_criteria_call_park_name", - "search_criteria_mode_or", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("service_provider_id", "serviceProviderId", str, is_required=True), - E("group_id", "groupId", str, is_required=True), - E( - "response_paging_control", - "responsePagingControl", - OCI.ResponsePagingControl, - is_complex=True, - ), - E( - "sort_by_call_park_name", - "sortByCallParkName", - OCI.SortByCallParkName, - is_complex=True, - ), - E( - "search_criteria_call_park_name", - "searchCriteriaCallParkName", - OCI.SearchCriteriaCallParkName, - is_complex=True, - is_array=True, - ), - E("search_criteria_mode_or", "searchCriteriaModeOr", bool), - ) - - -class GroupCallParkGetInstancePagedSortedRequest(OCIRequest): - """ - Gets a Call Park group. - - If the responsePagingControl element is not provided, the paging startIndex will be - set to 1 by default, and the responsePageSize will be set to the maximum - ResponsePageSize by default. It is possible to search by various criteria to restrict - the number of rows returned. The sort order is based on the user order provided when - creating or modifying the call park instance. Multiple search criteria are logically - ANDed together unless the searchCriteriaModeOr option is included. Then the search - criteria are logically ORed together. - - The response is either `GroupCallParkGetInstancePagedSortedResponse()` or - `ErrorResponse()`. - - Attributes: - service_provider_id (str): serviceProviderId - group_id (str): groupId - name (str): name - response_paging_control (OCI.responsePagingControl): responsePagingControl - *Optional* - search_criteria_user_id (List[OCI.searchCriteriaUserId]): searchCriteriaUserId - *Optional* - search_criteria_user_last_name (List[OCI.searchCriteriaUserLastName]): - searchCriteriaUserLastName *Optional* - search_criteria_user_first_name (List[OCI.searchCriteriaUserFirstName]): - searchCriteriaUserFirstName *Optional* - search_criteria_dn (List[OCI.searchCriteriaDn]): searchCriteriaDn *Optional* - search_criteria_extension (List[OCI.searchCriteriaExtension]): - searchCriteriaExtension *Optional* - search_criteria_department_name (List[OCI.searchCriteriaDepartmentName]): - searchCriteriaDepartmentName *Optional* - search_criteria_email_address (List[OCI.searchCriteriaEmailAddress]): - searchCriteriaEmailAddress *Optional* - search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* - """ - - __slots__: List[str] = [ - "service_provider_id", - "group_id", - "name", - "response_paging_control", - "search_criteria_user_id", - "search_criteria_user_last_name", - "search_criteria_user_first_name", - "search_criteria_dn", - "search_criteria_extension", - "search_criteria_department_name", - "search_criteria_email_address", - "search_criteria_mode_or", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("service_provider_id", "serviceProviderId", str, is_required=True), - E("group_id", "groupId", str, is_required=True), - E("name", "name", str, is_required=True), - E( - "response_paging_control", - "responsePagingControl", - OCI.ResponsePagingControl, - is_complex=True, - ), - E( - "search_criteria_user_id", - "searchCriteriaUserId", - OCI.SearchCriteriaUserId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_last_name", - "searchCriteriaUserLastName", - OCI.SearchCriteriaUserLastName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_first_name", - "searchCriteriaUserFirstName", - OCI.SearchCriteriaUserFirstName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_dn", - "searchCriteriaDn", - OCI.SearchCriteriaDn, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_extension", - "searchCriteriaExtension", - OCI.SearchCriteriaExtension, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_department_name", - "searchCriteriaDepartmentName", - OCI.SearchCriteriaDepartmentName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_email_address", - "searchCriteriaEmailAddress", - OCI.SearchCriteriaEmailAddress, - is_complex=True, - is_array=True, - ), - E("search_criteria_mode_or", "searchCriteriaModeOr", bool), - ) - - class GroupCallParkModifyInstanceRequest(OCIRequest): """ Modifies a Call Park group. @@ -84703,69 +83115,6 @@ def _elements(cls) -> Tuple[E, ...]: ) -class GroupCallPickupGetInstancePagedSortedListRequest(OCIRequest): - """ - Request to get a list of Call Pickup instances within a group. - - If the responsePagingControl element is not provided, the paging startIndex will be - set to 1 by default, and the responsePageSize will be set to the maximum - ResponsePageSize by default. It is possible to search by various criteria to restrict - the number of rows returned. Multiple search criteria are logically ANDed together - unless the searchCriteriaModeOr option is included. Then the search criteria are - logically ORed together. - - The response is either `GroupCallPickupGetInstancePagedSortedListResponse()` or - `ErrorResponse()`. - - Attributes: - service_provider_id (str): serviceProviderId - group_id (str): groupId - response_paging_control (OCI.responsePagingControl): responsePagingControl - *Optional* - sort_by_call_pickup_name (OCI.sortByCallPickupName): sortByCallPickupName - *Optional* - search_criteria_call_pickup_name (List[OCI.searchCriteriaCallPickupName]): - searchCriteriaCallPickupName *Optional* - search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* - """ - - __slots__: List[str] = [ - "service_provider_id", - "group_id", - "response_paging_control", - "sort_by_call_pickup_name", - "search_criteria_call_pickup_name", - "search_criteria_mode_or", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("service_provider_id", "serviceProviderId", str, is_required=True), - E("group_id", "groupId", str, is_required=True), - E( - "response_paging_control", - "responsePagingControl", - OCI.ResponsePagingControl, - is_complex=True, - ), - E( - "sort_by_call_pickup_name", - "sortByCallPickupName", - OCI.SortByCallPickupName, - is_complex=True, - ), - E( - "search_criteria_call_pickup_name", - "searchCriteriaCallPickupName", - OCI.SearchCriteriaCallPickupName, - is_complex=True, - is_array=True, - ), - E("search_criteria_mode_or", "searchCriteriaModeOr", bool), - ) - - class GroupCallPickupModifyInstanceRequest(OCIRequest): """ Modifies a Call Pickup group. @@ -84835,65 +83184,6 @@ def _elements(cls) -> Tuple[E, ...]: ) -class GroupCommonPhoneListGetListRequest(OCIRequest): - """ - Get a group's common phone list. - - The response is either a `GroupCommonPhoneListGetListResponse()` or an - `ErrorResponse()`. The search can be done using multiple criterion. If the - searchCriteriaModeOr is present, any result matching any one criteria is included in - the results. Otherwise, only results matching all the search criterion are included - in the results. If no search criteria is specified, all results are returned. - Specifying searchCriteriaModeOr without any search criteria results in an - `ErrorResponse()`. In all cases, if a responseSizeLimit is specified and the number of - matching results is more than this limit, then an `ErrorResponse()` is returned. - - Attributes: - service_provider_id (str): serviceProviderId - group_id (str): groupId - response_size_limit (int): responseSizeLimit *Optional* - search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* - search_criteria_group_common_phone_list_name - (List[OCI.searchCriteriaGroupCommonPhoneListName]): - searchCriteriaGroupCommonPhoneListName *Optional* - search_criteria_group_common_phone_list_number - (List[OCI.searchCriteriaGroupCommonPhoneListNumber]): - searchCriteriaGroupCommonPhoneListNumber *Optional* - """ - - __slots__: List[str] = [ - "service_provider_id", - "group_id", - "response_size_limit", - "search_criteria_mode_or", - "search_criteria_group_common_phone_list_name", - "search_criteria_group_common_phone_list_number", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("service_provider_id", "serviceProviderId", str, is_required=True), - E("group_id", "groupId", str, is_required=True), - E("response_size_limit", "responseSizeLimit", int), - E("search_criteria_mode_or", "searchCriteriaModeOr", bool), - E( - "search_criteria_group_common_phone_list_name", - "searchCriteriaGroupCommonPhoneListName", - OCI.SearchCriteriaGroupCommonPhoneListName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_group_common_phone_list_number", - "searchCriteriaGroupCommonPhoneListNumber", - OCI.SearchCriteriaGroupCommonPhoneListNumber, - is_complex=True, - is_array=True, - ), - ) - - class GroupCommunicationBarringAuthorizationCodeAddListRequest(OCIRequest): """ Add a list of Communication Barring Authorization codes to a group. @@ -84963,68 +83253,6 @@ def _elements(cls) -> Tuple[E, ...]: ) -class GroupCommunicationBarringAuthorizationCodeGetListRequest21sp1(OCIRequest): - """ - Get a list of Communication Barring Authorization Codes for a group. - - The response is either - `GroupCommunicationBarringAuthorizationCodeGetListResponse21sp1()` or - `ErrorResponse()`. - - Attributes: - service_provider_id (str): serviceProviderId - group_id (str): groupId - response_size_limit (int): responseSizeLimit *Optional* - search_criteria_communication_barring_authorization_code - (List[OCI.searchCriteriaCommunicationBarringAuthorizationCode]): - searchCriteriaCommunicationBarringAuthorizationCode *Optional* - search_criteria_communication_barring_authorization_code_description - (List[OCI.searchCriteriaCommunicationBarringAuthorizationCodeDescription]): - searchCriteriaCommunicationBarringAuthorizationCodeDescription *Optional* - search_criteria_network_class_of_service_name - (List[OCI.searchCriteriaNetworkClassOfServiceName]): - searchCriteriaNetworkClassOfServiceName *Optional* - """ - - __slots__: List[str] = [ - "service_provider_id", - "group_id", - "response_size_limit", - "search_criteria_communication_barring_authorization_code", - "search_criteria_communication_barring_authorization_code_description", - "search_criteria_network_class_of_service_name", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("service_provider_id", "serviceProviderId", str, is_required=True), - E("group_id", "groupId", str, is_required=True), - E("response_size_limit", "responseSizeLimit", int), - E( - "search_criteria_communication_barring_authorization_code", - "searchCriteriaCommunicationBarringAuthorizationCode", - OCI.SearchCriteriaCommunicationBarringAuthorizationCode, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_communication_barring_authorization_code_description", - "searchCriteriaCommunicationBarringAuthorizationCodeDescription", - OCI.SearchCriteriaCommunicationBarringAuthorizationCodeDescription, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_network_class_of_service_name", - "searchCriteriaNetworkClassOfServiceName", - OCI.SearchCriteriaNetworkClassOfServiceName, - is_complex=True, - is_array=True, - ), - ) - - class GroupCommunicationBarringProfileModifyListRequest(OCIRequest): """ Assign a replacement list of Communication Barring Profiles to a group. @@ -85217,76 +83445,6 @@ def _elements(cls) -> Tuple[E, ...]: ) -class GroupDepartmentAdminAddRequest(OCIRequest): - """ - Add a department administrator to a group department. - - The response is either a `SuccessResponse()` or an `ErrorResponse()`. - - Attributes: - department_key (OCI.departmentKey): departmentKey - user_id (str): userId - first_name (str): firstName *Optional* - last_name (str): lastName *Optional* - password (str): password *Optional* - language (str): language *Optional* - """ - - __slots__: List[str] = [ - "department_key", - "user_id", - "first_name", - "last_name", - "password", - "language", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E( - "department_key", - "departmentKey", - OCI.GroupDepartmentKey, - is_complex=True, - is_required=True, - ), - E("user_id", "userId", str, is_required=True), - E("first_name", "firstName", str), - E("last_name", "lastName", str), - E("password", "password", str), - E("language", "language", str), - ) - - -class GroupDepartmentAdminGetListRequest(OCIRequest): - """ - Get a list of department administrators for the department. - - The response is either a `GroupDepartmentAdminGetListResponse()` or an - `ErrorResponse()`. - - Attributes: - department_key (OCI.departmentKey): departmentKey - """ - - __slots__: List[str] = [ - "department_key", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E( - "department_key", - "departmentKey", - OCI.GroupDepartmentKey, - is_complex=True, - is_required=True, - ), - ) - - class GroupDepartmentModifyRequest(OCIRequest): """ Modify a department of a group. @@ -85333,218 +83491,6 @@ def _elements(cls) -> Tuple[E, ...]: ) -class GroupDeviceManagementEventGetListRequest(OCIRequest): - """ - Request device management's events for a specific queue. - - It is possible to restrict the number of rows returned using responseSizeLimit. If - eventQueueType is not specified, the events from all the event queues are returned. - - The response is either a `GroupDeviceManagementEventGetListResponse()` or an - `ErrorResponse()`. - - Attributes: - service_provider_id (str): serviceProviderId - group_id (str): groupId - event_queue_type (str): eventQueueType *Optional* - response_size_limit (int): responseSizeLimit *Optional* - search_criteria_exact_device_management_event_status_in_progress_or_pending - (OCI.searchCriteriaExactDeviceManagementEventStatusInProgressOrPending): - searchCriteriaExactDeviceManagementEventStatusInProgressOrPending *Optional* - search_criteria_exact_device_management_event_status_completed - (OCI.searchCriteriaExactDeviceManagementEventStatusCompleted): - searchCriteriaExactDeviceManagementEventStatusCompleted *Optional* - search_criteria_exact_device_management_event_action - (OCI.searchCriteriaExactDeviceManagementEventAction): - searchCriteriaExactDeviceManagementEventAction *Optional* - search_criteria_exact_device_management_event_level - (OCI.searchCriteriaExactDeviceManagementEventLevel): - searchCriteriaExactDeviceManagementEventLevel *Optional* - search_criteria_exact_device_management_event_type - (OCI.searchCriteriaExactDeviceManagementEventType): - searchCriteriaExactDeviceManagementEventType *Optional* - search_criteria_device_management_event_additional_info - (List[OCI.searchCriteriaDeviceManagementEventAdditionalInfo]): - searchCriteriaDeviceManagementEventAdditionalInfo *Optional* - search_criteria_device_management_event_login_id - (List[OCI.searchCriteriaDeviceManagementEventLoginId]): - searchCriteriaDeviceManagementEventLoginId *Optional* - """ - - __slots__: List[str] = [ - "service_provider_id", - "group_id", - "event_queue_type", - "response_size_limit", - "search_criteria_exact_device_management_event_status_in_progress_or_pending", - "search_criteria_exact_device_management_event_status_completed", - "search_criteria_exact_device_management_event_action", - "search_criteria_exact_device_management_event_level", - "search_criteria_exact_device_management_event_type", - "search_criteria_device_management_event_additional_info", - "search_criteria_device_management_event_login_id", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("service_provider_id", "serviceProviderId", str, is_required=True), - E("group_id", "groupId", str, is_required=True), - E("event_queue_type", "eventQueueType", str), - E("response_size_limit", "responseSizeLimit", int), - E( - "search_criteria_exact_device_management_event_status_in_progress_or_pending", - "searchCriteriaExactDeviceManagementEventStatusInProgressOrPending", - OCI.SearchCriteriaExactDeviceManagementEventStatusInProgressOrPending, - is_complex=True, - ), - E( - "search_criteria_exact_device_management_event_status_completed", - "searchCriteriaExactDeviceManagementEventStatusCompleted", - OCI.SearchCriteriaExactDeviceManagementEventStatusCompleted, - is_complex=True, - ), - E( - "search_criteria_exact_device_management_event_action", - "searchCriteriaExactDeviceManagementEventAction", - OCI.SearchCriteriaExactDeviceManagementEventAction, - is_complex=True, - ), - E( - "search_criteria_exact_device_management_event_level", - "searchCriteriaExactDeviceManagementEventLevel", - OCI.SearchCriteriaExactDeviceManagementEventLevel, - is_complex=True, - ), - E( - "search_criteria_exact_device_management_event_type", - "searchCriteriaExactDeviceManagementEventType", - OCI.SearchCriteriaExactDeviceManagementEventType, - is_complex=True, - ), - E( - "search_criteria_device_management_event_additional_info", - "searchCriteriaDeviceManagementEventAdditionalInfo", - OCI.SearchCriteriaDeviceManagementEventAdditionalInfo, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_device_management_event_login_id", - "searchCriteriaDeviceManagementEventLoginId", - OCI.SearchCriteriaDeviceManagementEventLoginId, - is_complex=True, - is_array=True, - ), - ) - - -class GroupDeviceManagementEventGetListRequest22(OCIRequest): - """ - Request device management's events for a specific queue. - - It is possible to restrict the number of rows returned using responseSizeLimit. If - eventQueueType is not specified, the events from all the event queues are returned. - - The response is either a `GroupDeviceManagementEventGetListResponse22()` or an - `ErrorResponse()`. - - Attributes: - service_provider_id (str): serviceProviderId - group_id (str): groupId - event_queue_type (str): eventQueueType *Optional* - response_size_limit (int): responseSizeLimit *Optional* - search_criteria_exact_device_management_event_status_in_progress_or_pending - (OCI.searchCriteriaExactDeviceManagementEventStatusInProgressOrPending): - searchCriteriaExactDeviceManagementEventStatusInProgressOrPending *Optional* - search_criteria_exact_device_management_event_status_completed - (OCI.searchCriteriaExactDeviceManagementEventStatusCompleted): - searchCriteriaExactDeviceManagementEventStatusCompleted *Optional* - search_criteria_exact_device_management_event_action - (OCI.searchCriteriaExactDeviceManagementEventAction): - searchCriteriaExactDeviceManagementEventAction *Optional* - search_criteria_exact_device_management_event_level - (OCI.searchCriteriaExactDeviceManagementEventLevel): - searchCriteriaExactDeviceManagementEventLevel *Optional* - search_criteria_exact_device_management_event_type - (OCI.searchCriteriaExactDeviceManagementEventType): - searchCriteriaExactDeviceManagementEventType *Optional* - search_criteria_device_management_event_additional_info - (List[OCI.searchCriteriaDeviceManagementEventAdditionalInfo]): - searchCriteriaDeviceManagementEventAdditionalInfo *Optional* - search_criteria_device_management_event_login_id - (List[OCI.searchCriteriaDeviceManagementEventLoginId]): - searchCriteriaDeviceManagementEventLoginId *Optional* - """ - - __slots__: List[str] = [ - "service_provider_id", - "group_id", - "event_queue_type", - "response_size_limit", - "search_criteria_exact_device_management_event_status_in_progress_or_pending", - "search_criteria_exact_device_management_event_status_completed", - "search_criteria_exact_device_management_event_action", - "search_criteria_exact_device_management_event_level", - "search_criteria_exact_device_management_event_type", - "search_criteria_device_management_event_additional_info", - "search_criteria_device_management_event_login_id", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("service_provider_id", "serviceProviderId", str, is_required=True), - E("group_id", "groupId", str, is_required=True), - E("event_queue_type", "eventQueueType", str), - E("response_size_limit", "responseSizeLimit", int), - E( - "search_criteria_exact_device_management_event_status_in_progress_or_pending", - "searchCriteriaExactDeviceManagementEventStatusInProgressOrPending", - OCI.SearchCriteriaExactDeviceManagementEventStatusInProgressOrPending, - is_complex=True, - ), - E( - "search_criteria_exact_device_management_event_status_completed", - "searchCriteriaExactDeviceManagementEventStatusCompleted", - OCI.SearchCriteriaExactDeviceManagementEventStatusCompleted, - is_complex=True, - ), - E( - "search_criteria_exact_device_management_event_action", - "searchCriteriaExactDeviceManagementEventAction", - OCI.SearchCriteriaExactDeviceManagementEventAction, - is_complex=True, - ), - E( - "search_criteria_exact_device_management_event_level", - "searchCriteriaExactDeviceManagementEventLevel", - OCI.SearchCriteriaExactDeviceManagementEventLevel, - is_complex=True, - ), - E( - "search_criteria_exact_device_management_event_type", - "searchCriteriaExactDeviceManagementEventType", - OCI.SearchCriteriaExactDeviceManagementEventType, - is_complex=True, - ), - E( - "search_criteria_device_management_event_additional_info", - "searchCriteriaDeviceManagementEventAdditionalInfo", - OCI.SearchCriteriaDeviceManagementEventAdditionalInfo, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_device_management_event_login_id", - "searchCriteriaDeviceManagementEventLoginId", - OCI.SearchCriteriaDeviceManagementEventLoginId, - is_complex=True, - is_array=True, - ), - ) - - class GroupDeviceTypeFileModifyRequest(OCIRequest): """ Request to modify a specified device type file for a group. @@ -86025,47 +83971,6 @@ def _elements(cls) -> Tuple[E, ...]: ) -class GroupEnterpriseTrunkGetAvailableTrunkGroupListRequest(OCIRequest): - """ - Request to get the list of all available trunk groups defined in a group. - - It is possible to search by various criteria to restrict the number of rows returned. - Multiple search criteria are logically ANDed together. - - The response is either a `GroupEnterpriseTrunkGetAvailableTrunkGroupListResponse()` or - an `ErrorResponse()`. - - Attributes: - service_provider_id (str): serviceProviderId - group_id (str): groupId - response_size_limit (int): responseSizeLimit *Optional* - search_criteria_trunk_group_name (List[OCI.searchCriteriaTrunkGroupName]): - searchCriteriaTrunkGroupName *Optional* - """ - - __slots__: List[str] = [ - "service_provider_id", - "group_id", - "response_size_limit", - "search_criteria_trunk_group_name", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("service_provider_id", "serviceProviderId", str, is_required=True), - E("group_id", "groupId", str, is_required=True), - E("response_size_limit", "responseSizeLimit", int), - E( - "search_criteria_trunk_group_name", - "searchCriteriaTrunkGroupName", - OCI.SearchCriteriaTrunkGroupName, - is_complex=True, - is_array=True, - ), - ) - - class GroupExchangeIntegrationModifyRequest(OCIRequest): """ Modify the group level configuration for Exchange Integration. @@ -86444,130 +84349,6 @@ def _elements(cls) -> Tuple[E, ...]: ) -class GroupGetListInServiceProviderRequest(OCIRequest): - """ - Request the list of groups in a service provider or enterprise. - - It is possible to search by various criteria to restrict the number of rows returned. - Multiple search criteria are logically ANDed together. - - The response is either a `GroupGetListInServiceProviderResponse()` or an - `ErrorResponse()`. - - Attributes: - service_provider_id (str): serviceProviderId - response_size_limit (int): responseSizeLimit *Optional* - search_criteria_group_id (List[OCI.searchCriteriaGroupId]): searchCriteriaGroupId - *Optional* - search_criteria_group_name (List[OCI.searchCriteriaGroupName]): - searchCriteriaGroupName *Optional* - """ - - __slots__: List[str] = [ - "service_provider_id", - "response_size_limit", - "search_criteria_group_id", - "search_criteria_group_name", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("service_provider_id", "serviceProviderId", str, is_required=True), - E("response_size_limit", "responseSizeLimit", int), - E( - "search_criteria_group_id", - "searchCriteriaGroupId", - OCI.SearchCriteriaGroupId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_group_name", - "searchCriteriaGroupName", - OCI.SearchCriteriaGroupName, - is_complex=True, - is_array=True, - ), - ) - - -class GroupGetListInSystemRequest(OCIRequest): - """ - Request the list of groups in the system. - - It is possible to search by various criteria to restrict the number of rows returned. - Multiple search criteria are logically ANDed together. If reseller administrator - sends the request, searchCriteriaResellerId is ignored. All the groups in the - administrator's reseller meeting the search criteria are returned. - - The response is either a `GroupGetListInSystemResponse()` or an `ErrorResponse()`. The - following data elements are only used in AS data mode: searchCriteriaResellerId - - Attributes: - response_size_limit (int): responseSizeLimit *Optional* - search_criteria_group_id (List[OCI.searchCriteriaGroupId]): searchCriteriaGroupId - *Optional* - search_criteria_group_name (List[OCI.searchCriteriaGroupName]): - searchCriteriaGroupName *Optional* - search_criteria_exact_service_provider (OCI.searchCriteriaExactServiceProvider): - searchCriteriaExactServiceProvider *Optional* - search_criteria_service_provider_id (List[OCI.searchCriteriaServiceProviderId]): - searchCriteriaServiceProviderId *Optional* - search_criteria_reseller_id (List[OCI.searchCriteriaResellerId]): - searchCriteriaResellerId *Optional* - """ - - __slots__: List[str] = [ - "response_size_limit", - "search_criteria_group_id", - "search_criteria_group_name", - "search_criteria_exact_service_provider", - "search_criteria_service_provider_id", - "search_criteria_reseller_id", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("response_size_limit", "responseSizeLimit", int), - E( - "search_criteria_group_id", - "searchCriteriaGroupId", - OCI.SearchCriteriaGroupId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_group_name", - "searchCriteriaGroupName", - OCI.SearchCriteriaGroupName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_exact_service_provider", - "searchCriteriaExactServiceProvider", - OCI.SearchCriteriaExactServiceProvider, - is_complex=True, - ), - E( - "search_criteria_service_provider_id", - "searchCriteriaServiceProviderId", - OCI.SearchCriteriaServiceProviderId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_reseller_id", - "searchCriteriaResellerId", - OCI.SearchCriteriaResellerId, - is_complex=True, - is_array=True, - ), - ) - - class GroupGroupNightForwardingModifyRequest(OCIRequest): """ Request to modify the Group Night Forwarding group parameters. @@ -88901,49 +86682,6 @@ def _elements(cls) -> Tuple[E, ...]: ) -class GroupRoutePointExternalSystemGetAssignedRoutePointListRequest(OCIRequest): - """ - Request a list of route points within in a group that have a given external system - assigned. - - The response is either - `GroupRoutePointExternalSystemGetAssignedRoutePointListResponse()` or - `ErrorResponse()`. - - Attributes: - service_provider_id (str): serviceProviderId - group_id (str): groupId - external_system (str): externalSystem - response_size_limit (int): responseSizeLimit *Optional* - search_criteria_route_point_name (List[OCI.searchCriteriaRoutePointName]): - searchCriteriaRoutePointName *Optional* - """ - - __slots__: List[str] = [ - "service_provider_id", - "group_id", - "external_system", - "response_size_limit", - "search_criteria_route_point_name", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("service_provider_id", "serviceProviderId", str, is_required=True), - E("group_id", "groupId", str, is_required=True), - E("external_system", "externalSystem", str, is_required=True), - E("response_size_limit", "responseSizeLimit", int), - E( - "search_criteria_route_point_name", - "searchCriteriaRoutePointName", - OCI.SearchCriteriaRoutePointName, - is_complex=True, - is_array=True, - ), - ) - - class GroupRoutePointGetDNISAgentListRequest(OCIRequest): """ Get a list of agent who selected the DNIS as the outgoing call. @@ -89073,49 +86811,6 @@ def _elements(cls) -> Tuple[E, ...]: ) -class GroupRoutePointGetInstanceListRequest(OCIRequest): - """ - Get a list of Route Point instances within a group. - - It is possible to search by various criteria to restrict the number of rows returned. - - The response is either `GroupRoutePointGetInstanceListResponse()` or - `ErrorResponse()`. It is possible to get the instances within a specified department. - - Attributes: - service_provider_id (str): serviceProviderId - group_id (str): groupId - group_department_name (str): groupDepartmentName *Optional* - response_size_limit (int): responseSizeLimit *Optional* - search_criteria_route_point_name (List[OCI.searchCriteriaRoutePointName]): - searchCriteriaRoutePointName *Optional* - """ - - __slots__: List[str] = [ - "service_provider_id", - "group_id", - "group_department_name", - "response_size_limit", - "search_criteria_route_point_name", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("service_provider_id", "serviceProviderId", str, is_required=True), - E("group_id", "groupId", str, is_required=True), - E("group_department_name", "groupDepartmentName", str), - E("response_size_limit", "responseSizeLimit", int), - E( - "search_criteria_route_point_name", - "searchCriteriaRoutePointName", - OCI.SearchCriteriaRoutePointName, - is_complex=True, - is_array=True, - ), - ) - - class GroupRoutePointModifyActiveInstanceListRequest(OCIRequest): """ Request to set the active status of Route Point instances. @@ -89482,86 +87177,6 @@ def _elements(cls) -> Tuple[E, ...]: ) -class GroupScheduleGetPagedSortedListRequest(OCIRequest): - """ - Get the list of schedules viewable by a group. - - The response is either a `GroupScheduleGetPagedSortedListResponse()` or an - `ErrorResponse()`. If no sortOrder is included, the response is sorted by Name - ascending by default. If the responsePagingControl element is not provided, the - paging startIndex will be set to 1 by default, and the responsePageSize will be set to - the maximum responsePageSize by default. Multiple search criteria are logically ANDed - together unless the searchCriteriaModeOr option is included. Then the search criteria - are logically ORed together. - - Attributes: - service_provider_id (str): serviceProviderId - group_id (str): groupId - response_paging_control (OCI.responsePagingControl): responsePagingControl - *Optional* - sort_by_schedule_name (OCI.sortByScheduleName): sortByScheduleName *Optional* - search_criteria_schedule_name (List[OCI.searchCriteriaScheduleName]): - searchCriteriaScheduleName *Optional* - search_criteria_exact_schedule_type (List[OCI.searchCriteriaExactScheduleType]): - searchCriteriaExactScheduleType *Optional* - search_criteria_exact_schedule_level (List[OCI.searchCriteriaExactScheduleLevel]): - searchCriteriaExactScheduleLevel *Optional* - search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* - """ - - __slots__: List[str] = [ - "service_provider_id", - "group_id", - "response_paging_control", - "sort_by_schedule_name", - "search_criteria_schedule_name", - "search_criteria_exact_schedule_type", - "search_criteria_exact_schedule_level", - "search_criteria_mode_or", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("service_provider_id", "serviceProviderId", str, is_required=True), - E("group_id", "groupId", str, is_required=True), - E( - "response_paging_control", - "responsePagingControl", - OCI.ResponsePagingControl, - is_complex=True, - ), - E( - "sort_by_schedule_name", - "sortByScheduleName", - OCI.SortByScheduleName, - is_complex=True, - ), - E( - "search_criteria_schedule_name", - "searchCriteriaScheduleName", - OCI.SearchCriteriaScheduleName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_exact_schedule_type", - "searchCriteriaExactScheduleType", - OCI.SearchCriteriaExactScheduleType, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_exact_schedule_level", - "searchCriteriaExactScheduleLevel", - OCI.SearchCriteriaExactScheduleLevel, - is_complex=True, - is_array=True, - ), - E("search_criteria_mode_or", "searchCriteriaModeOr", bool), - ) - - class GroupScheduleModifyEventRequest(OCIRequest): """ Modify an event of a group schedule. @@ -89726,84 +87341,6 @@ def _elements(cls) -> Tuple[E, ...]: ) -class GroupSessionAdmissionControlGetAvailableDeviceListRequest(OCIRequest): - """ - Request to get the list of devices can be assigned to session admission control group - for the group. - - The response is either an - `GroupSessionAdmissionControlGetAvailableDeviceListResponse()` or an - `ErrorResponse()`. - - Attributes: - service_provider_id (str): serviceProviderId - group_id (str): groupId - response_size_limit (int): responseSizeLimit *Optional* - search_criteria_device_name (List[OCI.searchCriteriaDeviceName]): - searchCriteriaDeviceName *Optional* - search_criteria_device_mac_address (List[OCI.searchCriteriaDeviceMACAddress]): - searchCriteriaDeviceMACAddress *Optional* - search_criteria_device_net_address (List[OCI.searchCriteriaDeviceNetAddress]): - searchCriteriaDeviceNetAddress *Optional* - search_criteria_exact_device_type (OCI.searchCriteriaExactDeviceType): - searchCriteriaExactDeviceType *Optional* - search_criteria_exact_device_level (OCI.searchCriteriaExactDeviceLevel): - searchCriteriaExactDeviceLevel *Optional* - """ - - __slots__: List[str] = [ - "service_provider_id", - "group_id", - "response_size_limit", - "search_criteria_device_name", - "search_criteria_device_mac_address", - "search_criteria_device_net_address", - "search_criteria_exact_device_type", - "search_criteria_exact_device_level", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("service_provider_id", "serviceProviderId", str, is_required=True), - E("group_id", "groupId", str, is_required=True), - E("response_size_limit", "responseSizeLimit", int), - E( - "search_criteria_device_name", - "searchCriteriaDeviceName", - OCI.SearchCriteriaDeviceName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_device_mac_address", - "searchCriteriaDeviceMACAddress", - OCI.SearchCriteriaDeviceMACAddress, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_device_net_address", - "searchCriteriaDeviceNetAddress", - OCI.SearchCriteriaDeviceNetAddress, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_exact_device_type", - "searchCriteriaExactDeviceType", - OCI.SearchCriteriaExactDeviceType, - is_complex=True, - ), - E( - "search_criteria_exact_device_level", - "searchCriteriaExactDeviceLevel", - OCI.SearchCriteriaExactDeviceLevel, - is_complex=True, - ), - ) - - class GroupSessionAdmissionControlGroupAddDeviceListRequest(OCIRequest): """ Request to add one ore more devices to a group level session admission control group. @@ -92418,86 +89955,6 @@ def _elements(cls) -> Tuple[E, ...]: ) -class GroupVirtualOnNetEnterpriseExtensionsGetUserListRequest(OCIRequest): - """ - Request the list of Virtual On-Net users in a Group. - - It is possible to search by various criteria to restrict the number of rows returned. - Multiple search criteria are logically ANDed together. - - The response is either a `GroupVirtualOnNetEnterpriseExtensionsGetUserListResponse()` - or an `ErrorResponse()`. - - Attributes: - service_provider_id (str): serviceProviderId - group_id (str): groupId - response_size_limit (int): responseSizeLimit *Optional* - search_criteria_user_last_name (List[OCI.searchCriteriaUserLastName]): - searchCriteriaUserLastName *Optional* - search_criteria_user_first_name (List[OCI.searchCriteriaUserFirstName]): - searchCriteriaUserFirstName *Optional* - search_criteria_dn (List[OCI.searchCriteriaDn]): searchCriteriaDn *Optional* - search_criteria_extension (List[OCI.searchCriteriaExtension]): - searchCriteriaExtension *Optional* - search_criteria_exact_virtual_on_net_call_type_name - (OCI.searchCriteriaExactVirtualOnNetCallTypeName): - searchCriteriaExactVirtualOnNetCallTypeName *Optional* - """ - - __slots__: List[str] = [ - "service_provider_id", - "group_id", - "response_size_limit", - "search_criteria_user_last_name", - "search_criteria_user_first_name", - "search_criteria_dn", - "search_criteria_extension", - "search_criteria_exact_virtual_on_net_call_type_name", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("service_provider_id", "serviceProviderId", str, is_required=True), - E("group_id", "groupId", str, is_required=True), - E("response_size_limit", "responseSizeLimit", int), - E( - "search_criteria_user_last_name", - "searchCriteriaUserLastName", - OCI.SearchCriteriaUserLastName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_first_name", - "searchCriteriaUserFirstName", - OCI.SearchCriteriaUserFirstName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_dn", - "searchCriteriaDn", - OCI.SearchCriteriaDn, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_extension", - "searchCriteriaExtension", - OCI.SearchCriteriaExtension, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_exact_virtual_on_net_call_type_name", - "searchCriteriaExactVirtualOnNetCallTypeName", - OCI.SearchCriteriaExactVirtualOnNetCallTypeName, - is_complex=True, - ), - ) - - class GroupVoiceMessagingGroupModifyVoicePortalBrandingRequest(OCIRequest): """ Modify the group's voice portal branding settings. @@ -92724,92 +90181,6 @@ def _elements(cls) -> Tuple[E, ...]: ) -class GroupXsiPolicyProfileGetAssignedUserListRequest(OCIRequest): - """ - Get a list of user within a group that have a given user Xsi policy profile assigned. - - The response is either a `GroupXsiPolicyProfileGetAssignedUserListResponse()` or an - `ErrorResponse()`. - - Attributes: - service_provider_id (str): serviceProviderId - group_id (str): groupId - xsi_policy_profile (OCI.xsiPolicyProfile): xsiPolicyProfile - response_size_limit (int): responseSizeLimit *Optional* - search_criteria_user_id (List[OCI.searchCriteriaUserId]): searchCriteriaUserId - *Optional* - search_criteria_user_last_name (List[OCI.searchCriteriaUserLastName]): - searchCriteriaUserLastName *Optional* - search_criteria_user_first_name (List[OCI.searchCriteriaUserFirstName]): - searchCriteriaUserFirstName *Optional* - search_criteria_dn (List[OCI.searchCriteriaDn]): searchCriteriaDn *Optional* - search_criteria_extension (List[OCI.searchCriteriaExtension]): - searchCriteriaExtension *Optional* - """ - - __slots__: List[str] = [ - "service_provider_id", - "group_id", - "xsi_policy_profile", - "response_size_limit", - "search_criteria_user_id", - "search_criteria_user_last_name", - "search_criteria_user_first_name", - "search_criteria_dn", - "search_criteria_extension", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("service_provider_id", "serviceProviderId", str, is_required=True), - E("group_id", "groupId", str, is_required=True), - E( - "xsi_policy_profile", - "xsiPolicyProfile", - OCI.XsiPolicyProfileKey, - is_complex=True, - is_required=True, - ), - E("response_size_limit", "responseSizeLimit", int), - E( - "search_criteria_user_id", - "searchCriteriaUserId", - OCI.SearchCriteriaUserId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_last_name", - "searchCriteriaUserLastName", - OCI.SearchCriteriaUserLastName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_first_name", - "searchCriteriaUserFirstName", - OCI.SearchCriteriaUserFirstName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_dn", - "searchCriteriaDn", - OCI.SearchCriteriaDn, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_extension", - "searchCriteriaExtension", - OCI.SearchCriteriaExtension, - is_complex=True, - is_array=True, - ), - ) - - class GroupXsiPolicyProfileUnassignListRequest(OCIRequest): """ Unassign a list of Xsi policy profile. @@ -92912,50 +90283,6 @@ def _elements(cls) -> Tuple[E, ...]: ) -class ResellerGetListRequest(OCIRequest): - """ - Request a list of resellers in the system. - - It is possible to search by various criteria to restrict the number of rows returned. - Multiple search criteria are logically ANDed together. - - The response is either a `ResellerGetListResponse()` or an `ErrorResponse()`. - - Attributes: - response_size_limit (int): responseSizeLimit *Optional* - search_criteria_reseller_id (List[OCI.searchCriteriaResellerId]): - searchCriteriaResellerId *Optional* - search_criteria_reseller_name (List[OCI.searchCriteriaResellerName]): - searchCriteriaResellerName *Optional* - """ - - __slots__: List[str] = [ - "response_size_limit", - "search_criteria_reseller_id", - "search_criteria_reseller_name", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("response_size_limit", "responseSizeLimit", int), - E( - "search_criteria_reseller_id", - "searchCriteriaResellerId", - OCI.SearchCriteriaResellerId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_reseller_name", - "searchCriteriaResellerName", - OCI.SearchCriteriaResellerName, - is_complex=True, - is_array=True, - ), - ) - - class ResellerNetworkClassOfServiceAssignListRequest(OCIRequest): """ Assign a list of Network Classes of Service to a reseller. @@ -92991,62 +90318,6 @@ def _elements(cls) -> Tuple[E, ...]: ) -class ResellerNetworkClassOfServiceGetAssignedServiceProviderListRequest(OCIRequest): - """ - Get a list of service provider/enterprises within a reseller that have a given Network - Class of Service assigned. - - The response is either a - `ResellerNetworkClassOfServiceGetAssignedServiceProviderListResponse()` or an - `ErorResponse()`. - - Attributes: - reseller_id (str): resellerId - network_class_of_service (str): networkClassOfService - response_size_limit (int): responseSizeLimit *Optional* - search_criteria_service_provider_id (List[OCI.searchCriteriaServiceProviderId]): - searchCriteriaServiceProviderId *Optional* - search_criteria_service_provider_name - (List[OCI.searchCriteriaServiceProviderName]): - searchCriteriaServiceProviderName *Optional* - """ - - __slots__: List[str] = [ - "reseller_id", - "network_class_of_service", - "response_size_limit", - "search_criteria_service_provider_id", - "search_criteria_service_provider_name", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("reseller_id", "resellerId", str, is_required=True), - E( - "network_class_of_service", - "networkClassOfService", - str, - is_required=True, - ), - E("response_size_limit", "responseSizeLimit", int), - E( - "search_criteria_service_provider_id", - "searchCriteriaServiceProviderId", - OCI.SearchCriteriaServiceProviderId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_service_provider_name", - "searchCriteriaServiceProviderName", - OCI.SearchCriteriaServiceProviderName, - is_complex=True, - is_array=True, - ), - ) - - class ResellerNetworkClassOfServiceUnassignListRequest(OCIRequest): """ Unassign a list of Network Classes of Service from a reseller. @@ -93154,72 +90425,6 @@ def _elements(cls) -> Tuple[E, ...]: ) -class ResellerXsiPolicyProfileGetAssignedServiceProviderListRequest(OCIRequest): - """ - Get a list of service provider/enterprises within a reseller that have a given Service - provider Xsi policy profile assigned. - - The response is either a - `ResellerXsiPolichProfileGetAssignedServiceProviderListResponse()` or an - `ErrorResponse()`. - - Attributes: - reseller_id (str): resellerId - xsi_policy_profile (OCI.xsiPolicyProfile): xsiPolicyProfile - response_size_limit (int): responseSizeLimit *Optional* - search_criteria_service_provider_id (List[OCI.searchCriteriaServiceProviderId]): - searchCriteriaServiceProviderId *Optional* - search_criteria_service_provider_name - (List[OCI.searchCriteriaServiceProviderName]): - searchCriteriaServiceProviderName *Optional* - search_criteria_exact_organization_type (OCI.searchCriteriaExactOrganizationType): - searchCriteriaExactOrganizationType *Optional* - """ - - __slots__: List[str] = [ - "reseller_id", - "xsi_policy_profile", - "response_size_limit", - "search_criteria_service_provider_id", - "search_criteria_service_provider_name", - "search_criteria_exact_organization_type", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("reseller_id", "resellerId", str, is_required=True), - E( - "xsi_policy_profile", - "xsiPolicyProfile", - OCI.XsiPolicyProfileKey, - is_complex=True, - is_required=True, - ), - E("response_size_limit", "responseSizeLimit", int), - E( - "search_criteria_service_provider_id", - "searchCriteriaServiceProviderId", - OCI.SearchCriteriaServiceProviderId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_service_provider_name", - "searchCriteriaServiceProviderName", - OCI.SearchCriteriaServiceProviderName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_exact_organization_type", - "searchCriteriaExactOrganizationType", - OCI.SearchCriteriaExactOrganizationType, - is_complex=True, - ), - ) - - class ResellerXsiPolicyProfileUnassignListRequest(OCIRequest): """ Unassign a list of Xsi policy profile. @@ -93694,225 +90899,6 @@ def _elements(cls) -> Tuple[E, ...]: ) -class ServiceProviderAccessDeviceGetListRequest(OCIRequest): - """ - Requests the list of access devices in a service provider. - - The following elements are only used in AS data mode and ignored in XS data mode: - serviceProviderExternalId - - The response is either `ServiceProviderAccessDeviceGetListResponse()` or - `ErrorResponse()`. - - Attributes: - service_provider_id (str): serviceProviderId *Optional* - service_provider_external_id (str): serviceProviderExternalId *Optional* - response_size_limit (int): responseSizeLimit *Optional* - search_criteria_device_name (List[OCI.searchCriteriaDeviceName]): - searchCriteriaDeviceName *Optional* - search_criteria_device_mac_address (List[OCI.searchCriteriaDeviceMACAddress]): - searchCriteriaDeviceMACAddress *Optional* - search_criteria_device_net_address (List[OCI.searchCriteriaDeviceNetAddress]): - searchCriteriaDeviceNetAddress *Optional* - search_criteria_exact_device_type (OCI.searchCriteriaExactDeviceType): - searchCriteriaExactDeviceType *Optional* - search_criteria_access_device_version - (List[OCI.searchCriteriaAccessDeviceVersion]): - searchCriteriaAccessDeviceVersion *Optional* - """ - - __slots__: List[str] = [ - "service_provider_id", - "service_provider_external_id", - "response_size_limit", - "search_criteria_device_name", - "search_criteria_device_mac_address", - "search_criteria_device_net_address", - "search_criteria_exact_device_type", - "search_criteria_access_device_version", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("service_provider_id", "serviceProviderId", str), - E("service_provider_external_id", "serviceProviderExternalId", str), - E("response_size_limit", "responseSizeLimit", int), - E( - "search_criteria_device_name", - "searchCriteriaDeviceName", - OCI.SearchCriteriaDeviceName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_device_mac_address", - "searchCriteriaDeviceMACAddress", - OCI.SearchCriteriaDeviceMACAddress, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_device_net_address", - "searchCriteriaDeviceNetAddress", - OCI.SearchCriteriaDeviceNetAddress, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_exact_device_type", - "searchCriteriaExactDeviceType", - OCI.SearchCriteriaExactDeviceType, - is_complex=True, - ), - E( - "search_criteria_access_device_version", - "searchCriteriaAccessDeviceVersion", - OCI.SearchCriteriaAccessDeviceVersion, - is_complex=True, - is_array=True, - ), - ) - - -class ServiceProviderAccessDeviceGetPagedSortedListRequest(OCIRequest): - """ - Requests the list of service provider level access devices. - - The response is either `ServiceProviderAccessDeviceGetPagedSortedListResponse()` or - `ErrorResponse()`. If no sortOrder is included, the response is sorted by Device Name - ascending by default. If the responsePagingControl element is not provided, the - paging startIndex will be set to 1 by default, and the responsePageSize will be set to - the maximum responsePageSize by default. Multiple search criteria are logically ANDed - together unless the searchCriteriaModeOr option is included. Then the search criteria - are logically ORed together. The getVisualDeviceManagementAPIDevicesOnly element can - only be set when CloudPBX is licenced. If the getVisualDeviceManagementAPIDevicesOnly - element is not set, all devices are returned with Visual Device Management API flag - set to empty. If the getVisualDeviceManagementAPIDevicesOnly element is set to true, - only SIP devices supporting Visual Device Management API are returned. If the - getVisualDeviceManagementAPIDevicesOnly element is set to false, all SIP devices are - returned with their current Visual Device Management API flag value. - - Attributes: - service_provider_id (str): serviceProviderId - response_paging_control (OCI.responsePagingControl): responsePagingControl - *Optional* - sort_by_device_name (OCI.sortByDeviceName): sortByDeviceName *Optional* - sort_by_device_type (OCI.sortByDeviceType): sortByDeviceType *Optional* - sort_by_device_net_address (OCI.sortByDeviceNetAddress): sortByDeviceNetAddress - *Optional* - sort_by_device_mac_address (OCI.sortByDeviceMACAddress): sortByDeviceMACAddress - *Optional* - search_criteria_device_name (List[OCI.searchCriteriaDeviceName]): - searchCriteriaDeviceName *Optional* - search_criteria_device_mac_address (List[OCI.searchCriteriaDeviceMACAddress]): - searchCriteriaDeviceMACAddress *Optional* - search_criteria_device_net_address (List[OCI.searchCriteriaDeviceNetAddress]): - searchCriteriaDeviceNetAddress *Optional* - search_criteria_exact_device_type (List[OCI.searchCriteriaExactDeviceType]): - searchCriteriaExactDeviceType *Optional* - search_criteria_access_device_version - (List[OCI.searchCriteriaAccessDeviceVersion]): - searchCriteriaAccessDeviceVersion *Optional* - search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* - get_visual_device_management_api_devices_only (bool): - getVisualDeviceManagementAPIDevicesOnly *Optional* - """ - - __slots__: List[str] = [ - "service_provider_id", - "response_paging_control", - "sort_by_device_name", - "sort_by_device_type", - "sort_by_device_net_address", - "sort_by_device_mac_address", - "search_criteria_device_name", - "search_criteria_device_mac_address", - "search_criteria_device_net_address", - "search_criteria_exact_device_type", - "search_criteria_access_device_version", - "search_criteria_mode_or", - "get_visual_device_management_api_devices_only", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("service_provider_id", "serviceProviderId", str, is_required=True), - E( - "response_paging_control", - "responsePagingControl", - OCI.ResponsePagingControl, - is_complex=True, - ), - E( - "sort_by_device_name", - "sortByDeviceName", - OCI.SortByDeviceName, - is_complex=True, - ), - E( - "sort_by_device_type", - "sortByDeviceType", - OCI.SortByDeviceType, - is_complex=True, - ), - E( - "sort_by_device_net_address", - "sortByDeviceNetAddress", - OCI.SortByDeviceNetAddress, - is_complex=True, - ), - E( - "sort_by_device_mac_address", - "sortByDeviceMACAddress", - OCI.SortByDeviceMACAddress, - is_complex=True, - ), - E( - "search_criteria_device_name", - "searchCriteriaDeviceName", - OCI.SearchCriteriaDeviceName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_device_mac_address", - "searchCriteriaDeviceMACAddress", - OCI.SearchCriteriaDeviceMACAddress, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_device_net_address", - "searchCriteriaDeviceNetAddress", - OCI.SearchCriteriaDeviceNetAddress, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_exact_device_type", - "searchCriteriaExactDeviceType", - OCI.SearchCriteriaExactDeviceType, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_access_device_version", - "searchCriteriaAccessDeviceVersion", - OCI.SearchCriteriaAccessDeviceVersion, - is_complex=True, - is_array=True, - ), - E("search_criteria_mode_or", "searchCriteriaModeOr", bool), - E( - "get_visual_device_management_api_devices_only", - "getVisualDeviceManagementAPIDevicesOnly", - bool, - ), - ) - - class ServiceProviderAccessDeviceLinkDeviceListRequest(OCIRequest): """ Request to link one or more leaf devices to a service provider level tree device. @@ -94324,67 +91310,6 @@ def _elements(cls) -> Tuple[E, ...]: ) -class ServiceProviderBroadWorksMobilityMobileSubscriberDirectoryNumberGetSummaryListRequest( - OCIRequest, -): - """ - Request a summary table of all Mobile Subscriber Directory Numbers in a service - provider. - - This command is applicable only for service providers and will fail for enterprises. - - The response is either - `ServiceProviderBroadWorksMobilityMobileSubscriberDirectoryNumberGetSummaryListResponse()` - or `ErrorResponse()`. - - Attributes: - service_provider_id (str): serviceProviderId - response_size_limit (int): responseSizeLimit *Optional* - search_criteria_mobile_subscriber_directory_number - (List[OCI.searchCriteriaMobileSubscriberDirectoryNumber]): - searchCriteriaMobileSubscriberDirectoryNumber *Optional* - search_criteria_group_id (List[OCI.searchCriteriaGroupId]): searchCriteriaGroupId - *Optional* - search_criteria_exact_mobile_network (OCI.searchCriteriaExactMobileNetwork): - searchCriteriaExactMobileNetwork *Optional* - """ - - __slots__: List[str] = [ - "service_provider_id", - "response_size_limit", - "search_criteria_mobile_subscriber_directory_number", - "search_criteria_group_id", - "search_criteria_exact_mobile_network", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("service_provider_id", "serviceProviderId", str, is_required=True), - E("response_size_limit", "responseSizeLimit", int), - E( - "search_criteria_mobile_subscriber_directory_number", - "searchCriteriaMobileSubscriberDirectoryNumber", - OCI.SearchCriteriaMobileSubscriberDirectoryNumber, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_group_id", - "searchCriteriaGroupId", - OCI.SearchCriteriaGroupId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_exact_mobile_network", - "searchCriteriaExactMobileNetwork", - OCI.SearchCriteriaExactMobileNetwork, - is_complex=True, - ), - ) - - class ServiceProviderCPEConfigSetConfigFileRequest(OCIRequest): """ Request to set a new service provider default configuration file for a device type. @@ -94419,47 +91344,6 @@ def _elements(cls) -> Tuple[E, ...]: ) -class ServiceProviderCommunicationBarringDigitPatternCriteriaGetPatternListRequest( - OCIRequest, -): - """ - Get an existing Digit Pattern Criteria. - - The response is either a - `ServiceProviderCommunicationBarringDigitPatternCriteriaGetPatternListResponse()` or - an `ErrorResponse()`. - - Attributes: - service_provider_id (str): serviceProviderId - name (str): name - response_size_limit (int): responseSizeLimit *Optional* - search_criteria_digit_pattern (List[OCI.searchCriteriaDigitPattern]): - searchCriteriaDigitPattern *Optional* - """ - - __slots__: List[str] = [ - "service_provider_id", - "name", - "response_size_limit", - "search_criteria_digit_pattern", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("service_provider_id", "serviceProviderId", str, is_required=True), - E("name", "name", str, is_required=True), - E("response_size_limit", "responseSizeLimit", int), - E( - "search_criteria_digit_pattern", - "searchCriteriaDigitPattern", - OCI.SearchCriteriaDigitPattern, - is_complex=True, - is_array=True, - ), - ) - - class ServiceProviderCommunicationBarringProfileAddRequest(OCIRequest): """ Add a new Communication Barring Profile. @@ -94829,263 +91713,6 @@ def _elements(cls) -> Tuple[E, ...]: ) -class ServiceProviderCommunicationBarringProfileGetAssignedGroupListRequest(OCIRequest): - """ - Get a list of groups within a service provider that have a given Communication Barring - Profile assigned. - - The response is either a - `ServiceProviderCommunicationBarringProfileGetAssignedGroupListResponse()` or an - `ErorResponse()`. - - Attributes: - service_provider_id (str): serviceProviderId - profile (str): profile - response_size_limit (int): responseSizeLimit *Optional* - search_criteria_group_id (List[OCI.searchCriteriaGroupId]): searchCriteriaGroupId - *Optional* - search_criteria_group_name (List[OCI.searchCriteriaGroupName]): - searchCriteriaGroupName *Optional* - """ - - __slots__: List[str] = [ - "service_provider_id", - "profile", - "response_size_limit", - "search_criteria_group_id", - "search_criteria_group_name", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("service_provider_id", "serviceProviderId", str, is_required=True), - E("profile", "profile", str, is_required=True), - E("response_size_limit", "responseSizeLimit", int), - E( - "search_criteria_group_id", - "searchCriteriaGroupId", - OCI.SearchCriteriaGroupId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_group_name", - "searchCriteriaGroupName", - OCI.SearchCriteriaGroupName, - is_complex=True, - is_array=True, - ), - ) - - -class ServiceProviderDeviceManagementEventGetListRequest(OCIRequest): - """ - Request device management's events for a specific queue. - - It is possible to restrict the number of rows returned using responseSizeLimit. If - eventQueueType is not specified, the events from all the event queues are returned. - - The response is either a `ServiceProviderDeviceManagementEventGetListResponse()` or an - `ErrorResponse()`. Deprecated by: - `ServiceProviderDeviceManagementEventGetListRequest22()`. - - Attributes: - service_provider_id (str): serviceProviderId - event_queue_type (str): eventQueueType *Optional* - response_size_limit (int): responseSizeLimit *Optional* - search_criteria_exact_device_management_event_status_in_progress_or_pending - (OCI.searchCriteriaExactDeviceManagementEventStatusInProgressOrPending): - searchCriteriaExactDeviceManagementEventStatusInProgressOrPending *Optional* - search_criteria_exact_device_management_event_status_completed - (OCI.searchCriteriaExactDeviceManagementEventStatusCompleted): - searchCriteriaExactDeviceManagementEventStatusCompleted *Optional* - search_criteria_exact_device_management_event_action - (OCI.searchCriteriaExactDeviceManagementEventAction): - searchCriteriaExactDeviceManagementEventAction *Optional* - search_criteria_exact_device_management_event_level - (OCI.searchCriteriaExactDeviceManagementEventLevel): - searchCriteriaExactDeviceManagementEventLevel *Optional* - search_criteria_exact_device_management_event_type - (OCI.searchCriteriaExactDeviceManagementEventType): - searchCriteriaExactDeviceManagementEventType *Optional* - search_criteria_device_management_event_additional_info - (List[OCI.searchCriteriaDeviceManagementEventAdditionalInfo]): - searchCriteriaDeviceManagementEventAdditionalInfo *Optional* - search_criteria_device_management_event_login_id - (List[OCI.searchCriteriaDeviceManagementEventLoginId]): - searchCriteriaDeviceManagementEventLoginId *Optional* - """ - - __slots__: List[str] = [ - "service_provider_id", - "event_queue_type", - "response_size_limit", - "search_criteria_exact_device_management_event_status_in_progress_or_pending", - "search_criteria_exact_device_management_event_status_completed", - "search_criteria_exact_device_management_event_action", - "search_criteria_exact_device_management_event_level", - "search_criteria_exact_device_management_event_type", - "search_criteria_device_management_event_additional_info", - "search_criteria_device_management_event_login_id", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("service_provider_id", "serviceProviderId", str, is_required=True), - E("event_queue_type", "eventQueueType", str), - E("response_size_limit", "responseSizeLimit", int), - E( - "search_criteria_exact_device_management_event_status_in_progress_or_pending", - "searchCriteriaExactDeviceManagementEventStatusInProgressOrPending", - OCI.SearchCriteriaExactDeviceManagementEventStatusInProgressOrPending, - is_complex=True, - ), - E( - "search_criteria_exact_device_management_event_status_completed", - "searchCriteriaExactDeviceManagementEventStatusCompleted", - OCI.SearchCriteriaExactDeviceManagementEventStatusCompleted, - is_complex=True, - ), - E( - "search_criteria_exact_device_management_event_action", - "searchCriteriaExactDeviceManagementEventAction", - OCI.SearchCriteriaExactDeviceManagementEventAction, - is_complex=True, - ), - E( - "search_criteria_exact_device_management_event_level", - "searchCriteriaExactDeviceManagementEventLevel", - OCI.SearchCriteriaExactDeviceManagementEventLevel, - is_complex=True, - ), - E( - "search_criteria_exact_device_management_event_type", - "searchCriteriaExactDeviceManagementEventType", - OCI.SearchCriteriaExactDeviceManagementEventType, - is_complex=True, - ), - E( - "search_criteria_device_management_event_additional_info", - "searchCriteriaDeviceManagementEventAdditionalInfo", - OCI.SearchCriteriaDeviceManagementEventAdditionalInfo, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_device_management_event_login_id", - "searchCriteriaDeviceManagementEventLoginId", - OCI.SearchCriteriaDeviceManagementEventLoginId, - is_complex=True, - is_array=True, - ), - ) - - -class ServiceProviderDeviceManagementEventGetListRequest22(OCIRequest): - """ - Request device management's events for a specific queue. - - It is possible to restrict the number of rows returned using responseSizeLimit. If - eventQueueType is not specified, the events from all the event queues are returned. - - The response is either a `ServiceProviderDeviceManagementEventGetListResponse22()` or - an `ErrorResponse()`. - - Attributes: - service_provider_id (str): serviceProviderId - event_queue_type (str): eventQueueType *Optional* - response_size_limit (int): responseSizeLimit *Optional* - search_criteria_exact_device_management_event_status_in_progress_or_pending - (OCI.searchCriteriaExactDeviceManagementEventStatusInProgressOrPending): - searchCriteriaExactDeviceManagementEventStatusInProgressOrPending *Optional* - search_criteria_exact_device_management_event_status_completed - (OCI.searchCriteriaExactDeviceManagementEventStatusCompleted): - searchCriteriaExactDeviceManagementEventStatusCompleted *Optional* - search_criteria_exact_device_management_event_action - (OCI.searchCriteriaExactDeviceManagementEventAction): - searchCriteriaExactDeviceManagementEventAction *Optional* - search_criteria_exact_device_management_event_level - (OCI.searchCriteriaExactDeviceManagementEventLevel): - searchCriteriaExactDeviceManagementEventLevel *Optional* - search_criteria_exact_device_management_event_type - (OCI.searchCriteriaExactDeviceManagementEventType): - searchCriteriaExactDeviceManagementEventType *Optional* - search_criteria_device_management_event_additional_info - (List[OCI.searchCriteriaDeviceManagementEventAdditionalInfo]): - searchCriteriaDeviceManagementEventAdditionalInfo *Optional* - search_criteria_device_management_event_login_id - (List[OCI.searchCriteriaDeviceManagementEventLoginId]): - searchCriteriaDeviceManagementEventLoginId *Optional* - """ - - __slots__: List[str] = [ - "service_provider_id", - "event_queue_type", - "response_size_limit", - "search_criteria_exact_device_management_event_status_in_progress_or_pending", - "search_criteria_exact_device_management_event_status_completed", - "search_criteria_exact_device_management_event_action", - "search_criteria_exact_device_management_event_level", - "search_criteria_exact_device_management_event_type", - "search_criteria_device_management_event_additional_info", - "search_criteria_device_management_event_login_id", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("service_provider_id", "serviceProviderId", str, is_required=True), - E("event_queue_type", "eventQueueType", str), - E("response_size_limit", "responseSizeLimit", int), - E( - "search_criteria_exact_device_management_event_status_in_progress_or_pending", - "searchCriteriaExactDeviceManagementEventStatusInProgressOrPending", - OCI.SearchCriteriaExactDeviceManagementEventStatusInProgressOrPending, - is_complex=True, - ), - E( - "search_criteria_exact_device_management_event_status_completed", - "searchCriteriaExactDeviceManagementEventStatusCompleted", - OCI.SearchCriteriaExactDeviceManagementEventStatusCompleted, - is_complex=True, - ), - E( - "search_criteria_exact_device_management_event_action", - "searchCriteriaExactDeviceManagementEventAction", - OCI.SearchCriteriaExactDeviceManagementEventAction, - is_complex=True, - ), - E( - "search_criteria_exact_device_management_event_level", - "searchCriteriaExactDeviceManagementEventLevel", - OCI.SearchCriteriaExactDeviceManagementEventLevel, - is_complex=True, - ), - E( - "search_criteria_exact_device_management_event_type", - "searchCriteriaExactDeviceManagementEventType", - OCI.SearchCriteriaExactDeviceManagementEventType, - is_complex=True, - ), - E( - "search_criteria_device_management_event_additional_info", - "searchCriteriaDeviceManagementEventAdditionalInfo", - OCI.SearchCriteriaDeviceManagementEventAdditionalInfo, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_device_management_event_login_id", - "searchCriteriaDeviceManagementEventLoginId", - OCI.SearchCriteriaDeviceManagementEventLoginId, - is_complex=True, - is_array=True, - ), - ) - - class ServiceProviderDeviceTypeFileModifyRequest(OCIRequest): """ Request to modify a specified device type file for a service provider. @@ -95290,149 +91917,6 @@ def _elements(cls) -> Tuple[E, ...]: ) -class ServiceProviderDnGetSummaryListRequest(OCIRequest): - """ - Request a summary table of all DNs in a service provider. - - Dns assigned to the IMRN pool are not listed in the response. The search can be done - using multiple criteria. Only results matching all the search criteria are included - in the results. - - The response is either `ServiceProviderDnGetSummaryListResponse()` or - `ErrorResponse()`. The following elements are only used in XS data mode and ignored in - AS data mode: searchCriteriaDn, searchCriteriaGroupId - - Attributes: - service_provider_id (str): serviceProviderId - search_criteria_group_id (List[OCI.searchCriteriaGroupId]): searchCriteriaGroupId - *Optional* - search_criteria_dn (List[OCI.searchCriteriaDn]): searchCriteriaDn *Optional* - """ - - __slots__: List[str] = [ - "service_provider_id", - "search_criteria_group_id", - "search_criteria_dn", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("service_provider_id", "serviceProviderId", str, is_required=True), - E( - "search_criteria_group_id", - "searchCriteriaGroupId", - OCI.SearchCriteriaGroupId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_dn", - "searchCriteriaDn", - OCI.SearchCriteriaDn, - is_complex=True, - is_array=True, - ), - ) - - -class ServiceProviderDomainGetAssignedGroupListRequest(OCIRequest): - """ - Requests a list of groups within a service provider that have a given domain assigned. - - It is possible to search by various criteria to restrict the number of rows returned. - Multiple search criteria are logically ANDed together. - - The response is either a `ServiceProviderDomainGetAssignedGroupListResponse()` or an - `ErrorResponse()`. - - Attributes: - service_provider_id (str): serviceProviderId - domain (str): domain - response_size_limit (int): responseSizeLimit *Optional* - search_criteria_group_id (List[OCI.searchCriteriaGroupId]): searchCriteriaGroupId - *Optional* - search_criteria_group_name (List[OCI.searchCriteriaGroupName]): - searchCriteriaGroupName *Optional* - """ - - __slots__: List[str] = [ - "service_provider_id", - "domain", - "response_size_limit", - "search_criteria_group_id", - "search_criteria_group_name", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("service_provider_id", "serviceProviderId", str, is_required=True), - E("domain", "domain", str, is_required=True), - E("response_size_limit", "responseSizeLimit", int), - E( - "search_criteria_group_id", - "searchCriteriaGroupId", - OCI.SearchCriteriaGroupId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_group_name", - "searchCriteriaGroupName", - OCI.SearchCriteriaGroupName, - is_complex=True, - is_array=True, - ), - ) - - -class ServiceProviderDomainGetAssignedListRequest22(OCIRequest): - """ - Requests the list of all matching domains assigned to a service provider . - - The response is either `ServiceProviderDomainGetAssignedListResponse22()` or - `ErrorResponse()`. The following elements are only used in AS data mode and will be - ignored in XS data mode: responseSizeLimit searchCriteriaDomainName - searchCriteriaExactDomainLevel - - Attributes: - service_provider_id (str): serviceProviderId - response_size_limit (int): responseSizeLimit *Optional* - search_criteria_domain_name (List[OCI.searchCriteriaDomainName]): - searchCriteriaDomainName *Optional* - search_criteria_exact_domain_level (OCI.searchCriteriaExactDomainLevel): - searchCriteriaExactDomainLevel *Optional* - """ - - __slots__: List[str] = [ - "service_provider_id", - "response_size_limit", - "search_criteria_domain_name", - "search_criteria_exact_domain_level", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("service_provider_id", "serviceProviderId", str, is_required=True), - E("response_size_limit", "responseSizeLimit", int), - E( - "search_criteria_domain_name", - "searchCriteriaDomainName", - OCI.SearchCriteriaDomainName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_exact_domain_level", - "searchCriteriaExactDomainLevel", - OCI.SearchCriteriaExactDomainLevel, - is_complex=True, - ), - ) - - class ServiceProviderFeatureAccessCodeModifyListRequest(OCIRequest): """ Modify a list of feature access codes for a service provider or enterprise. @@ -95528,67 +92012,6 @@ def _elements(cls) -> Tuple[E, ...]: ) -class ServiceProviderGetListRequest(OCIRequest): - """ - Request a list of service providers and/or enterprises in the system. - - It is possible to search by various criteria to restrict the number of rows returned. - Multiple search criteria are logically ANDed together. If reseller administrator - sends the request, searchCriteriaResellerId is ignored. Service providers/enterprise - within the administrator's reseller meeting the search criteria are returned. - - The response is either a `ServiceProviderGetListResponse()` or an `ErrorResponse()`. - The following data elements are only used in AS data mode: searchCriteriaResellerId - - Attributes: - is_enterprise (bool): isEnterprise *Optional* - response_size_limit (int): responseSizeLimit *Optional* - search_criteria_service_provider_id (List[OCI.searchCriteriaServiceProviderId]): - searchCriteriaServiceProviderId *Optional* - search_criteria_service_provider_name - (List[OCI.searchCriteriaServiceProviderName]): - searchCriteriaServiceProviderName *Optional* - search_criteria_reseller_id (List[OCI.searchCriteriaResellerId]): - searchCriteriaResellerId *Optional* - """ - - __slots__: List[str] = [ - "is_enterprise", - "response_size_limit", - "search_criteria_service_provider_id", - "search_criteria_service_provider_name", - "search_criteria_reseller_id", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("is_enterprise", "isEnterprise", bool), - E("response_size_limit", "responseSizeLimit", int), - E( - "search_criteria_service_provider_id", - "searchCriteriaServiceProviderId", - OCI.SearchCriteriaServiceProviderId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_service_provider_name", - "searchCriteriaServiceProviderName", - OCI.SearchCriteriaServiceProviderName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_reseller_id", - "searchCriteriaResellerId", - OCI.SearchCriteriaResellerId, - is_complex=True, - is_array=True, - ), - ) - - class ServiceProviderIMRNAssignListRequest(OCIRequest): """ Assign a list of service provider DNs to the IMRN pool. @@ -95833,61 +92256,6 @@ def _elements(cls) -> Tuple[E, ...]: ) -class ServiceProviderNetworkClassOfServiceGetAssignedGroupListRequest(OCIRequest): - """ - Get a list of groups within a service provider that have a given Network Class of - Service assigned. - - The response is either a - `ServiceProviderNetworkClassOfServiceGetAssignedGroupListResponse()` or an - `ErorResponse()`. - - Attributes: - service_provider_id (str): serviceProviderId - network_class_of_service (str): networkClassOfService - response_size_limit (int): responseSizeLimit *Optional* - search_criteria_group_id (List[OCI.searchCriteriaGroupId]): searchCriteriaGroupId - *Optional* - search_criteria_group_name (List[OCI.searchCriteriaGroupName]): - searchCriteriaGroupName *Optional* - """ - - __slots__: List[str] = [ - "service_provider_id", - "network_class_of_service", - "response_size_limit", - "search_criteria_group_id", - "search_criteria_group_name", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("service_provider_id", "serviceProviderId", str, is_required=True), - E( - "network_class_of_service", - "networkClassOfService", - str, - is_required=True, - ), - E("response_size_limit", "responseSizeLimit", int), - E( - "search_criteria_group_id", - "searchCriteriaGroupId", - OCI.SearchCriteriaGroupId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_group_name", - "searchCriteriaGroupName", - OCI.SearchCriteriaGroupName, - is_complex=True, - is_array=True, - ), - ) - - class ServiceProviderNetworkClassOfServiceUnassignListRequest21(OCIRequest): """ Unassign a list of Network Classes of Service from a service provider. @@ -95926,94 +92294,6 @@ def _elements(cls) -> Tuple[E, ...]: ) -class ServiceProviderNumberPortabilityQueryGetRequest(OCIRequest): - """ - Request to get the Service Provider Number Portability Query Digit Pattern Trigger - List information. - - The response is either a `ServiceProviderNumberPortabilityQueryGetResponse()` or an - `ErrorResponse()`. - - Attributes: - service_provider_id (str): serviceProviderId - include_digit_patterns (bool): includeDigitPatterns - search_criteria_service_provider_number_portability_query_digit_pattern - (List[OCI.searchCriteriaServiceProviderNumberPortabilityQueryDigitPattern]): - searchCriteriaServiceProviderNumberPortabilityQueryDigitPattern *Optional* - response_size_limit (int): responseSizeLimit *Optional* - """ - - __slots__: List[str] = [ - "service_provider_id", - "include_digit_patterns", - "search_criteria_service_provider_number_portability_query_digit_pattern", - "response_size_limit", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("service_provider_id", "serviceProviderId", str, is_required=True), - E("include_digit_patterns", "includeDigitPatterns", bool, is_required=True), - E( - "search_criteria_service_provider_number_portability_query_digit_pattern", - "searchCriteriaServiceProviderNumberPortabilityQueryDigitPattern", - OCI.SearchCriteriaServiceProviderNumberPortabilityQueryDigitPattern, - is_complex=True, - is_array=True, - ), - E("response_size_limit", "responseSizeLimit", int), - ) - - -class ServiceProviderOfficeZoneGetAssignedGroupListRequest(OCIRequest): - """ - Get a list of groups within a service provider that have a given Office Zone assigned. - - The response is either a `ServiceProviderOfficeZoneGetAssignedGroupListResponse()` or - an `ErrorResponse()`. - - Attributes: - service_provider_id (str): serviceProviderId - office_zone_name (str): officeZoneName - response_size_limit (int): responseSizeLimit *Optional* - search_criteria_group_id (List[OCI.searchCriteriaGroupId]): searchCriteriaGroupId - *Optional* - search_criteria_group_name (List[OCI.searchCriteriaGroupName]): - searchCriteriaGroupName *Optional* - """ - - __slots__: List[str] = [ - "service_provider_id", - "office_zone_name", - "response_size_limit", - "search_criteria_group_id", - "search_criteria_group_name", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("service_provider_id", "serviceProviderId", str, is_required=True), - E("office_zone_name", "officeZoneName", str, is_required=True), - E("response_size_limit", "responseSizeLimit", int), - E( - "search_criteria_group_id", - "searchCriteriaGroupId", - OCI.SearchCriteriaGroupId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_group_name", - "searchCriteriaGroupName", - OCI.SearchCriteriaGroupName, - is_complex=True, - is_array=True, - ), - ) - - class ServiceProviderRouteListEnterpriseTrunkNumberRangeAddListRequest(OCIRequest): """ Add number ranges to a service provider. @@ -96074,59 +92354,6 @@ def _elements(cls) -> Tuple[E, ...]: ) -class ServiceProviderRoutePointExternalSystemGetAssignedGroupListRequest(OCIRequest): - """ - Requests a list of groups within a service provider that have a given external system - assigned. - - It is possible to search by various criteria to restrict the number of rows returned. - Multiple search criteria are logically ANDed together. - - The response is either a - `ServiceProviderRoutePointExternalSystemGetAssignedGroupListResponse()` or an - `ErrorResponse()`. - - Attributes: - service_provider_id (str): serviceProviderId - external_system (str): externalSystem - response_size_limit (int): responseSizeLimit *Optional* - search_criteria_group_id (List[OCI.searchCriteriaGroupId]): searchCriteriaGroupId - *Optional* - search_criteria_group_name (List[OCI.searchCriteriaGroupName]): - searchCriteriaGroupName *Optional* - """ - - __slots__: List[str] = [ - "service_provider_id", - "external_system", - "response_size_limit", - "search_criteria_group_id", - "search_criteria_group_name", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("service_provider_id", "serviceProviderId", str, is_required=True), - E("external_system", "externalSystem", str, is_required=True), - E("response_size_limit", "responseSizeLimit", int), - E( - "search_criteria_group_id", - "searchCriteriaGroupId", - OCI.SearchCriteriaGroupId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_group_name", - "searchCriteriaGroupName", - OCI.SearchCriteriaGroupName, - is_complex=True, - is_array=True, - ), - ) - - class ServiceProviderScheduleAddEventRequest(OCIRequest): """ Add an event to service provider schedule. @@ -96473,52 +92700,6 @@ def _elements(cls) -> Tuple[E, ...]: ) -class ServiceProviderServicePackMigrationTaskGetAvailableGroupListRequest(OCIRequest): - """ - Requests a list of groups to migrate. - - The response is either - `ServiceProviderServicePackMigrationTaskGetAvailabeGroupListResponse()` or - `ErrorResponse()`. - - Attributes: - service_provider_id (str): serviceProviderId - response_size_limit (int): responseSizeLimit *Optional* - search_criteria_group_id (List[OCI.searchCriteriaGroupId]): searchCriteriaGroupId - *Optional* - search_criteria_group_name (List[OCI.searchCriteriaGroupName]): - searchCriteriaGroupName *Optional* - """ - - __slots__: List[str] = [ - "service_provider_id", - "response_size_limit", - "search_criteria_group_id", - "search_criteria_group_name", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("service_provider_id", "serviceProviderId", str, is_required=True), - E("response_size_limit", "responseSizeLimit", int), - E( - "search_criteria_group_id", - "searchCriteriaGroupId", - OCI.SearchCriteriaGroupId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_group_name", - "searchCriteriaGroupName", - OCI.SearchCriteriaGroupName, - is_complex=True, - is_array=True, - ), - ) - - class ServiceProviderServicePackMigrationTaskModifyAssignmentListRequest(OCIRequest): """ Replace the list of services and packs to be assigned to users during the service pack @@ -96886,62 +93067,6 @@ def _elements(cls) -> Tuple[E, ...]: ) -class ServiceProviderXsiPolicyProfileGetAssignedGroupListRequest(OCIRequest): - """ - Get a list of group within a service provider that have a given group Xsi policy - profile assigned. - - The response is either a - `ServiceProviderXsiPolicyProfileGetAssignedGroupListResponse()` or an - `ErrorResponse()`. - - Attributes: - service_provider_id (str): serviceProviderId - xsi_policy_profile (OCI.xsiPolicyProfile): xsiPolicyProfile - response_size_limit (int): responseSizeLimit *Optional* - search_criteria_group_id (List[OCI.searchCriteriaGroupId]): searchCriteriaGroupId - *Optional* - search_criteria_group_name (List[OCI.searchCriteriaGroupName]): - searchCriteriaGroupName *Optional* - """ - - __slots__: List[str] = [ - "service_provider_id", - "xsi_policy_profile", - "response_size_limit", - "search_criteria_group_id", - "search_criteria_group_name", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("service_provider_id", "serviceProviderId", str, is_required=True), - E( - "xsi_policy_profile", - "xsiPolicyProfile", - OCI.XsiPolicyProfileKey, - is_complex=True, - is_required=True, - ), - E("response_size_limit", "responseSizeLimit", int), - E( - "search_criteria_group_id", - "searchCriteriaGroupId", - OCI.SearchCriteriaGroupId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_group_name", - "searchCriteriaGroupName", - OCI.SearchCriteriaGroupName, - is_complex=True, - is_array=True, - ), - ) - - class ServiceProviderXsiPolicyProfileUnassignListRequest(OCIRequest): """ Unassign a list of Xsi policy profile. @@ -97520,656 +93645,6 @@ def _elements(cls) -> Tuple[E, ...]: ) -class SystemAccessDeviceGetAllRequest(OCIRequest): - """ - Requests the list of all access devices in the entire system. - - Prior to release 14, this functionality was provided with the - `SystemAccessDeviceGetListRequest14()`. If reseller administrator sends the request, - searchCriteriaResellerId is ignored. All the device profiles in the administrator's - reseller meeting the search criteria are returned. - - The response is either `SystemAccessDeviceGetAllResponse()` or `ErrorResponse()`. The - following data elements are only used in AS data mode: searchCriteriaResellerId - - Attributes: - response_size_limit (int): responseSizeLimit *Optional* - search_criteria_device_name (List[OCI.searchCriteriaDeviceName]): - searchCriteriaDeviceName *Optional* - search_criteria_device_mac_address (List[OCI.searchCriteriaDeviceMACAddress]): - searchCriteriaDeviceMACAddress *Optional* - search_criteria_device_net_address (List[OCI.searchCriteriaDeviceNetAddress]): - searchCriteriaDeviceNetAddress *Optional* - search_criteria_group_id (List[OCI.searchCriteriaGroupId]): searchCriteriaGroupId - *Optional* - search_criteria_exact_device_type (OCI.searchCriteriaExactDeviceType): - searchCriteriaExactDeviceType *Optional* - search_criteria_exact_device_service_provider - (OCI.searchCriteriaExactDeviceServiceProvider): - searchCriteriaExactDeviceServiceProvider *Optional* - search_criteria_service_provider_id (List[OCI.searchCriteriaServiceProviderId]): - searchCriteriaServiceProviderId *Optional* - search_criteria_reseller_id (List[OCI.searchCriteriaResellerId]): - searchCriteriaResellerId *Optional* - """ - - __slots__: List[str] = [ - "response_size_limit", - "search_criteria_device_name", - "search_criteria_device_mac_address", - "search_criteria_device_net_address", - "search_criteria_group_id", - "search_criteria_exact_device_type", - "search_criteria_exact_device_service_provider", - "search_criteria_service_provider_id", - "search_criteria_reseller_id", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("response_size_limit", "responseSizeLimit", int), - E( - "search_criteria_device_name", - "searchCriteriaDeviceName", - OCI.SearchCriteriaDeviceName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_device_mac_address", - "searchCriteriaDeviceMACAddress", - OCI.SearchCriteriaDeviceMACAddress, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_device_net_address", - "searchCriteriaDeviceNetAddress", - OCI.SearchCriteriaDeviceNetAddress, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_group_id", - "searchCriteriaGroupId", - OCI.SearchCriteriaGroupId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_exact_device_type", - "searchCriteriaExactDeviceType", - OCI.SearchCriteriaExactDeviceType, - is_complex=True, - ), - E( - "search_criteria_exact_device_service_provider", - "searchCriteriaExactDeviceServiceProvider", - OCI.SearchCriteriaExactDeviceServiceProvider, - is_complex=True, - ), - E( - "search_criteria_service_provider_id", - "searchCriteriaServiceProviderId", - OCI.SearchCriteriaServiceProviderId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_reseller_id", - "searchCriteriaResellerId", - OCI.SearchCriteriaResellerId, - is_complex=True, - is_array=True, - ), - ) - - -class SystemAccessDeviceGetListRequest14(OCIRequest): - """ - Requests the list of access devices defined at the System-level. - - Prior to release 14, this command requested a list of all devices in the entire - system. That functionality is now moved to the `SystemAccessDeviceGetAllRequest()`. - - The response is either `SystemAccessDeviceGetListResponse14()` or `ErrorResponse()`. - - Attributes: - response_size_limit (int): responseSizeLimit *Optional* - search_criteria_device_name (List[OCI.searchCriteriaDeviceName]): - searchCriteriaDeviceName *Optional* - search_criteria_device_mac_address (List[OCI.searchCriteriaDeviceMACAddress]): - searchCriteriaDeviceMACAddress *Optional* - search_criteria_device_net_address (List[OCI.searchCriteriaDeviceNetAddress]): - searchCriteriaDeviceNetAddress *Optional* - search_criteria_exact_device_type (OCI.searchCriteriaExactDeviceType): - searchCriteriaExactDeviceType *Optional* - search_criteria_access_device_version - (List[OCI.searchCriteriaAccessDeviceVersion]): - searchCriteriaAccessDeviceVersion *Optional* - """ - - __slots__: List[str] = [ - "response_size_limit", - "search_criteria_device_name", - "search_criteria_device_mac_address", - "search_criteria_device_net_address", - "search_criteria_exact_device_type", - "search_criteria_access_device_version", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("response_size_limit", "responseSizeLimit", int), - E( - "search_criteria_device_name", - "searchCriteriaDeviceName", - OCI.SearchCriteriaDeviceName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_device_mac_address", - "searchCriteriaDeviceMACAddress", - OCI.SearchCriteriaDeviceMACAddress, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_device_net_address", - "searchCriteriaDeviceNetAddress", - OCI.SearchCriteriaDeviceNetAddress, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_exact_device_type", - "searchCriteriaExactDeviceType", - OCI.SearchCriteriaExactDeviceType, - is_complex=True, - ), - E( - "search_criteria_access_device_version", - "searchCriteriaAccessDeviceVersion", - OCI.SearchCriteriaAccessDeviceVersion, - is_complex=True, - is_array=True, - ), - ) - - -class SystemAccessDeviceGetPagedSortedListRequest(OCIRequest): - """ - Requests the list of system-level access devices. - - The response is either `SystemAccessDeviceGetPagedSortedListResponse()` or - `ErrorResponse()`. If no sortOrder is included, the response is sorted by Device Name - ascending by default. If the responsePagingControl element is not provided, the - paging startIndex will be set to 1 by default, and the responsePageSize will be set to - the maximum responsePageSize by default. Multiple search criteria are logically ANDed - together unless the searchCriteriaModeOr option is included. Then the search criteria - are logically ORed together. The getVisualDeviceManagementAPIDevicesOnly element can - only be set when CloudPBX is licenced. If the getVisualDeviceManagementAPIDevicesOnly - element is not set, all devices are returned with Visual Device Management API flag - set to empty. If the getVisualDeviceManagementAPIDevicesOnly element is set to true, - only SIP devices supporting Visual Device Management API are returned. If the - getVisualDeviceManagementAPIDevicesOnly element is set to false, all SIP devices are - returned with their current Visual Device Management API flag value. - - Attributes: - response_paging_control (OCI.responsePagingControl): responsePagingControl - *Optional* - sort_by_device_name (OCI.sortByDeviceName): sortByDeviceName *Optional* - sort_by_device_type (OCI.sortByDeviceType): sortByDeviceType *Optional* - sort_by_device_net_address (OCI.sortByDeviceNetAddress): sortByDeviceNetAddress - *Optional* - sort_by_device_mac_address (OCI.sortByDeviceMACAddress): sortByDeviceMACAddress - *Optional* - search_criteria_device_name (List[OCI.searchCriteriaDeviceName]): - searchCriteriaDeviceName *Optional* - search_criteria_device_mac_address (List[OCI.searchCriteriaDeviceMACAddress]): - searchCriteriaDeviceMACAddress *Optional* - search_criteria_device_net_address (List[OCI.searchCriteriaDeviceNetAddress]): - searchCriteriaDeviceNetAddress *Optional* - search_criteria_exact_device_type (List[OCI.searchCriteriaExactDeviceType]): - searchCriteriaExactDeviceType *Optional* - search_criteria_access_device_version - (List[OCI.searchCriteriaAccessDeviceVersion]): - searchCriteriaAccessDeviceVersion *Optional* - search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* - get_visual_device_management_api_devices_only (bool): - getVisualDeviceManagementAPIDevicesOnly *Optional* - """ - - __slots__: List[str] = [ - "response_paging_control", - "sort_by_device_name", - "sort_by_device_type", - "sort_by_device_net_address", - "sort_by_device_mac_address", - "search_criteria_device_name", - "search_criteria_device_mac_address", - "search_criteria_device_net_address", - "search_criteria_exact_device_type", - "search_criteria_access_device_version", - "search_criteria_mode_or", - "get_visual_device_management_api_devices_only", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E( - "response_paging_control", - "responsePagingControl", - OCI.ResponsePagingControl, - is_complex=True, - ), - E( - "sort_by_device_name", - "sortByDeviceName", - OCI.SortByDeviceName, - is_complex=True, - ), - E( - "sort_by_device_type", - "sortByDeviceType", - OCI.SortByDeviceType, - is_complex=True, - ), - E( - "sort_by_device_net_address", - "sortByDeviceNetAddress", - OCI.SortByDeviceNetAddress, - is_complex=True, - ), - E( - "sort_by_device_mac_address", - "sortByDeviceMACAddress", - OCI.SortByDeviceMACAddress, - is_complex=True, - ), - E( - "search_criteria_device_name", - "searchCriteriaDeviceName", - OCI.SearchCriteriaDeviceName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_device_mac_address", - "searchCriteriaDeviceMACAddress", - OCI.SearchCriteriaDeviceMACAddress, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_device_net_address", - "searchCriteriaDeviceNetAddress", - OCI.SearchCriteriaDeviceNetAddress, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_exact_device_type", - "searchCriteriaExactDeviceType", - OCI.SearchCriteriaExactDeviceType, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_access_device_version", - "searchCriteriaAccessDeviceVersion", - OCI.SearchCriteriaAccessDeviceVersion, - is_complex=True, - is_array=True, - ), - E("search_criteria_mode_or", "searchCriteriaModeOr", bool), - E( - "get_visual_device_management_api_devices_only", - "getVisualDeviceManagementAPIDevicesOnly", - bool, - ), - ) - - -class SystemAccessDeviceGetUserListRequest(OCIRequest): - """ - Requests the users associated with a specified system access device. - - The response is either `SystemAccessDeviceGetUserListResponse()` or `ErrorResponse()`. - The following elements are only used in XS data mode and ignored in AS data mode: - searchCriteriaAccessDeviceEndpointPrivateIdentity Replaced by: - `SystemAccessDeviceGetUserListRequest21sp1()` in AS data mode. - - Attributes: - device_name (str): deviceName - response_size_limit (int): responseSizeLimit *Optional* - search_criteria_line_port_user_part (List[OCI.searchCriteriaLinePortUserPart]): - searchCriteriaLinePortUserPart *Optional* - search_criteria_line_port_domain (List[OCI.searchCriteriaLinePortDomain]): - searchCriteriaLinePortDomain *Optional* - search_criteria_user_last_name (List[OCI.searchCriteriaUserLastName]): - searchCriteriaUserLastName *Optional* - search_criteria_user_first_name (List[OCI.searchCriteriaUserFirstName]): - searchCriteriaUserFirstName *Optional* - search_criteria_dn (List[OCI.searchCriteriaDn]): searchCriteriaDn *Optional* - search_criteria_user_id (List[OCI.searchCriteriaUserId]): searchCriteriaUserId - *Optional* - search_criteria_group_id (List[OCI.searchCriteriaGroupId]): searchCriteriaGroupId - *Optional* - search_criteria_exact_service_provider (OCI.searchCriteriaExactServiceProvider): - searchCriteriaExactServiceProvider *Optional* - search_criteria_service_provider_id (List[OCI.searchCriteriaServiceProviderId]): - searchCriteriaServiceProviderId *Optional* - search_criteria_exact_endpoint_type (OCI.searchCriteriaExactEndpointType): - searchCriteriaExactEndpointType *Optional* - search_criteria_exact_user_type (OCI.searchCriteriaExactUserType): - searchCriteriaExactUserType *Optional* - search_criteria_extension (List[OCI.searchCriteriaExtension]): - searchCriteriaExtension *Optional* - search_criteria_exact_port_number (OCI.searchCriteriaExactPortNumber): - searchCriteriaExactPortNumber *Optional* - search_criteria_access_device_endpoint_private_identity - (List[OCI.searchCriteriaAccessDeviceEndpointPrivateIdentity]): - searchCriteriaAccessDeviceEndpointPrivateIdentity *Optional* - """ - - __slots__: List[str] = [ - "device_name", - "response_size_limit", - "search_criteria_line_port_user_part", - "search_criteria_line_port_domain", - "search_criteria_user_last_name", - "search_criteria_user_first_name", - "search_criteria_dn", - "search_criteria_user_id", - "search_criteria_group_id", - "search_criteria_exact_service_provider", - "search_criteria_service_provider_id", - "search_criteria_exact_endpoint_type", - "search_criteria_exact_user_type", - "search_criteria_extension", - "search_criteria_exact_port_number", - "search_criteria_access_device_endpoint_private_identity", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("device_name", "deviceName", str, is_required=True), - E("response_size_limit", "responseSizeLimit", int), - E( - "search_criteria_line_port_user_part", - "searchCriteriaLinePortUserPart", - OCI.SearchCriteriaLinePortUserPart, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_line_port_domain", - "searchCriteriaLinePortDomain", - OCI.SearchCriteriaLinePortDomain, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_last_name", - "searchCriteriaUserLastName", - OCI.SearchCriteriaUserLastName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_first_name", - "searchCriteriaUserFirstName", - OCI.SearchCriteriaUserFirstName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_dn", - "searchCriteriaDn", - OCI.SearchCriteriaDn, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_id", - "searchCriteriaUserId", - OCI.SearchCriteriaUserId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_group_id", - "searchCriteriaGroupId", - OCI.SearchCriteriaGroupId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_exact_service_provider", - "searchCriteriaExactServiceProvider", - OCI.SearchCriteriaExactServiceProvider, - is_complex=True, - ), - E( - "search_criteria_service_provider_id", - "searchCriteriaServiceProviderId", - OCI.SearchCriteriaServiceProviderId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_exact_endpoint_type", - "searchCriteriaExactEndpointType", - OCI.SearchCriteriaExactEndpointType, - is_complex=True, - ), - E( - "search_criteria_exact_user_type", - "searchCriteriaExactUserType", - OCI.SearchCriteriaExactUserType, - is_complex=True, - ), - E( - "search_criteria_extension", - "searchCriteriaExtension", - OCI.SearchCriteriaExtension, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_exact_port_number", - "searchCriteriaExactPortNumber", - OCI.SearchCriteriaExactPortNumber, - is_complex=True, - ), - E( - "search_criteria_access_device_endpoint_private_identity", - "searchCriteriaAccessDeviceEndpointPrivateIdentity", - OCI.SearchCriteriaAccessDeviceEndpointPrivateIdentity, - is_complex=True, - is_array=True, - ), - ) - - -class SystemAccessDeviceGetUserListRequest21sp1(OCIRequest): - """ - Requests the users associated with a specified system access device. - - The response is either `SystemAccessDeviceGetUserListResponse21sp1()` or - `ErrorResponse()`. The following elements are only used in XS data mode and ignored in - AS data mode: searchCriteriaAccessDeviceEndpointPrivateIdentity - - Attributes: - device_name (str): deviceName - response_size_limit (int): responseSizeLimit *Optional* - search_criteria_line_port_user_part (List[OCI.searchCriteriaLinePortUserPart]): - searchCriteriaLinePortUserPart *Optional* - search_criteria_line_port_domain (List[OCI.searchCriteriaLinePortDomain]): - searchCriteriaLinePortDomain *Optional* - search_criteria_user_last_name (List[OCI.searchCriteriaUserLastName]): - searchCriteriaUserLastName *Optional* - search_criteria_user_first_name (List[OCI.searchCriteriaUserFirstName]): - searchCriteriaUserFirstName *Optional* - search_criteria_dn (List[OCI.searchCriteriaDn]): searchCriteriaDn *Optional* - search_criteria_user_id (List[OCI.searchCriteriaUserId]): searchCriteriaUserId - *Optional* - search_criteria_group_id (List[OCI.searchCriteriaGroupId]): searchCriteriaGroupId - *Optional* - search_criteria_exact_service_provider (OCI.searchCriteriaExactServiceProvider): - searchCriteriaExactServiceProvider *Optional* - search_criteria_service_provider_id (List[OCI.searchCriteriaServiceProviderId]): - searchCriteriaServiceProviderId *Optional* - search_criteria_exact_endpoint_type (OCI.searchCriteriaExactEndpointType): - searchCriteriaExactEndpointType *Optional* - search_criteria_exact_user_type (OCI.searchCriteriaExactUserType): - searchCriteriaExactUserType *Optional* - search_criteria_extension (List[OCI.searchCriteriaExtension]): - searchCriteriaExtension *Optional* - search_criteria_exact_port_number (OCI.searchCriteriaExactPortNumber): - searchCriteriaExactPortNumber *Optional* - search_criteria_access_device_endpoint_private_identity - (List[OCI.searchCriteriaAccessDeviceEndpointPrivateIdentity]): - searchCriteriaAccessDeviceEndpointPrivateIdentity *Optional* - search_criteria_user_hotline_contact (List[OCI.searchCriteriaUserHotlineContact]): - searchCriteriaUserHotlineContact *Optional* - """ - - __slots__: List[str] = [ - "device_name", - "response_size_limit", - "search_criteria_line_port_user_part", - "search_criteria_line_port_domain", - "search_criteria_user_last_name", - "search_criteria_user_first_name", - "search_criteria_dn", - "search_criteria_user_id", - "search_criteria_group_id", - "search_criteria_exact_service_provider", - "search_criteria_service_provider_id", - "search_criteria_exact_endpoint_type", - "search_criteria_exact_user_type", - "search_criteria_extension", - "search_criteria_exact_port_number", - "search_criteria_access_device_endpoint_private_identity", - "search_criteria_user_hotline_contact", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("device_name", "deviceName", str, is_required=True), - E("response_size_limit", "responseSizeLimit", int), - E( - "search_criteria_line_port_user_part", - "searchCriteriaLinePortUserPart", - OCI.SearchCriteriaLinePortUserPart, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_line_port_domain", - "searchCriteriaLinePortDomain", - OCI.SearchCriteriaLinePortDomain, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_last_name", - "searchCriteriaUserLastName", - OCI.SearchCriteriaUserLastName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_first_name", - "searchCriteriaUserFirstName", - OCI.SearchCriteriaUserFirstName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_dn", - "searchCriteriaDn", - OCI.SearchCriteriaDn, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_id", - "searchCriteriaUserId", - OCI.SearchCriteriaUserId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_group_id", - "searchCriteriaGroupId", - OCI.SearchCriteriaGroupId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_exact_service_provider", - "searchCriteriaExactServiceProvider", - OCI.SearchCriteriaExactServiceProvider, - is_complex=True, - ), - E( - "search_criteria_service_provider_id", - "searchCriteriaServiceProviderId", - OCI.SearchCriteriaServiceProviderId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_exact_endpoint_type", - "searchCriteriaExactEndpointType", - OCI.SearchCriteriaExactEndpointType21sp1, - is_complex=True, - ), - E( - "search_criteria_exact_user_type", - "searchCriteriaExactUserType", - OCI.SearchCriteriaExactUserType, - is_complex=True, - ), - E( - "search_criteria_extension", - "searchCriteriaExtension", - OCI.SearchCriteriaExtension, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_exact_port_number", - "searchCriteriaExactPortNumber", - OCI.SearchCriteriaExactPortNumber, - is_complex=True, - ), - E( - "search_criteria_access_device_endpoint_private_identity", - "searchCriteriaAccessDeviceEndpointPrivateIdentity", - OCI.SearchCriteriaAccessDeviceEndpointPrivateIdentity, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_hotline_contact", - "searchCriteriaUserHotlineContact", - OCI.SearchCriteriaUserHotlineContact, - is_complex=True, - is_array=True, - ), - ) - - class SystemAccessDeviceLinkDeviceListRequest(OCIRequest): """ Request to link one or more leaf devices to a system level tree device. @@ -98440,82 +93915,6 @@ def _elements(cls) -> Tuple[E, ...]: ) -class SystemAlternateUserIdGetListRequest(OCIRequest): - """ - Request to get the list of alternate user ids. - - If reseller administrator sends the request, searchCriteriaResellerId is ignored. All - the alternate user ids in the administrator's reseller meeting the search criteria are - returned. - - The response is either `SystemAlternateUserIdGetListResponse()` or `ErrorResponse()`. - The following data elements are only used in AS data mode: searchCriteriaResellerId - - Attributes: - response_size_limit (int): responseSizeLimit *Optional* - search_criteria_alternate_user_id (List[OCI.searchCriteriaAlternateUserId]): - searchCriteriaAlternateUserId *Optional* - search_criteria_user_id (List[OCI.searchCriteriaUserId]): searchCriteriaUserId - *Optional* - search_criteria_group_id (List[OCI.searchCriteriaGroupId]): searchCriteriaGroupId - *Optional* - search_criteria_service_provider_id (List[OCI.searchCriteriaServiceProviderId]): - searchCriteriaServiceProviderId *Optional* - search_criteria_reseller_id (List[OCI.searchCriteriaResellerId]): - searchCriteriaResellerId *Optional* - """ - - __slots__: List[str] = [ - "response_size_limit", - "search_criteria_alternate_user_id", - "search_criteria_user_id", - "search_criteria_group_id", - "search_criteria_service_provider_id", - "search_criteria_reseller_id", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("response_size_limit", "responseSizeLimit", int), - E( - "search_criteria_alternate_user_id", - "searchCriteriaAlternateUserId", - OCI.SearchCriteriaAlternateUserId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_id", - "searchCriteriaUserId", - OCI.SearchCriteriaUserId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_group_id", - "searchCriteriaGroupId", - OCI.SearchCriteriaGroupId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_service_provider_id", - "searchCriteriaServiceProviderId", - OCI.SearchCriteriaServiceProviderId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_reseller_id", - "searchCriteriaResellerId", - OCI.SearchCriteriaResellerId, - is_complex=True, - is_array=True, - ), - ) - - class SystemAutomaticCollectCallPrefixDigitsAddListRequest(OCIRequest): """ Add a system automatic collect call prefix digits entry. @@ -98677,235 +94076,6 @@ def _elements(cls) -> Tuple[E, ...]: ) -class SystemBroadWorksMobilityGeographicalPoolIMRNGetListRequest(OCIRequest): - """ - Get a list of BroadWorks Mobility IMRN numbers from a geographical pool. - - The response is either a - `SystemBroadWorksMobilityGeographicalPoolIMRNGetListResponse()` or an - `ErrorResponse()`. - - Attributes: - geographical_pool_name (str): geographicalPoolName - search_criteria_imrn (List[OCI.searchCriteriaIMRN]): searchCriteriaIMRN *Optional* - """ - - __slots__: List[str] = [ - "geographical_pool_name", - "search_criteria_imrn", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("geographical_pool_name", "geographicalPoolName", str, is_required=True), - E( - "search_criteria_imrn", - "searchCriteriaIMRN", - OCI.SearchCriteriaIMRN, - is_complex=True, - is_array=True, - ), - ) - - -class SystemBroadWorksMobilityGetIMRNListRequest(OCIRequest): - """ - Request to get the list of BroadWorks Mobility IMRN numbers defined in the system. - - The response is either a `SystemBroadWorksMobilityGetIMRNListResponse()` or an - `ErrorResponse()`. - - Attributes: - search_criteria_imrn (List[OCI.searchCriteriaIMRN]): searchCriteriaIMRN *Optional* - """ - - __slots__: List[str] = [ - "search_criteria_imrn", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E( - "search_criteria_imrn", - "searchCriteriaIMRN", - OCI.SearchCriteriaIMRN, - is_complex=True, - is_array=True, - ), - ) - - -class SystemBroadWorksMobilityGetMobileNetworkIMRNListRequest(OCIRequest): - """ - Get a list of BroadWorks Mobility IMRN numbers from a Mobile Network. - - The response is either a `SystemBroadWorksMobilityGetMobileNetworkIMRNListResponse()` - or an `ErrorResponse()`. - - Attributes: - mobile_network_name (str): mobileNetworkName - search_criteria_imrn (List[OCI.searchCriteriaIMRN]): searchCriteriaIMRN *Optional* - """ - - __slots__: List[str] = [ - "mobile_network_name", - "search_criteria_imrn", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("mobile_network_name", "mobileNetworkName", str, is_required=True), - E( - "search_criteria_imrn", - "searchCriteriaIMRN", - OCI.SearchCriteriaIMRN, - is_complex=True, - is_array=True, - ), - ) - - -class SystemBroadWorksMobilityMobileSubscriberDirectoryNumberGetSummaryListRequest( - OCIRequest, -): - """ - Request a summary table of all Mobile Subscriber Directory Numbers in a system. - - If reseller administrator sends the request, searchCriteriaResellerId is ignored. All - the mobile subscriber directory numbers in the administrator's reseller meeting the - search criteria are returned. - - The response is either - `SystemBroadWorksMobilityMobileSubscriberDirectoryNumberGetSummaryListResponse()` or - `ErrorResponse()`. The following data elements are only used in AS data mode: - searchCriteriaResellerId - - Attributes: - response_size_limit (int): responseSizeLimit *Optional* - search_criteria_mobile_subscriber_directory_number - (List[OCI.searchCriteriaMobileSubscriberDirectoryNumber]): - searchCriteriaMobileSubscriberDirectoryNumber *Optional* - search_criteria_exact_mobile_network (OCI.searchCriteriaExactMobileNetwork): - searchCriteriaExactMobileNetwork *Optional* - search_criteria_service_provider_id (List[OCI.searchCriteriaServiceProviderId]): - searchCriteriaServiceProviderId *Optional* - search_criteria_exact_organization_type (OCI.searchCriteriaExactOrganizationType): - searchCriteriaExactOrganizationType *Optional* - search_criteria_group_id (List[OCI.searchCriteriaGroupId]): searchCriteriaGroupId - *Optional* - search_criteria_user_id (List[OCI.searchCriteriaUserId]): searchCriteriaUserId - *Optional* - search_criteria_user_last_name (List[OCI.searchCriteriaUserLastName]): - searchCriteriaUserLastName *Optional* - search_criteria_user_first_name (List[OCI.searchCriteriaUserFirstName]): - searchCriteriaUserFirstName *Optional* - search_criteria_dn (List[OCI.searchCriteriaDn]): searchCriteriaDn *Optional* - search_criteria_extension (List[OCI.searchCriteriaExtension]): - searchCriteriaExtension *Optional* - search_criteria_reseller_id (List[OCI.searchCriteriaResellerId]): - searchCriteriaResellerId *Optional* - """ - - __slots__: List[str] = [ - "response_size_limit", - "search_criteria_mobile_subscriber_directory_number", - "search_criteria_exact_mobile_network", - "search_criteria_service_provider_id", - "search_criteria_exact_organization_type", - "search_criteria_group_id", - "search_criteria_user_id", - "search_criteria_user_last_name", - "search_criteria_user_first_name", - "search_criteria_dn", - "search_criteria_extension", - "search_criteria_reseller_id", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("response_size_limit", "responseSizeLimit", int), - E( - "search_criteria_mobile_subscriber_directory_number", - "searchCriteriaMobileSubscriberDirectoryNumber", - OCI.SearchCriteriaMobileSubscriberDirectoryNumber, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_exact_mobile_network", - "searchCriteriaExactMobileNetwork", - OCI.SearchCriteriaExactMobileNetwork, - is_complex=True, - ), - E( - "search_criteria_service_provider_id", - "searchCriteriaServiceProviderId", - OCI.SearchCriteriaServiceProviderId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_exact_organization_type", - "searchCriteriaExactOrganizationType", - OCI.SearchCriteriaExactOrganizationType, - is_complex=True, - ), - E( - "search_criteria_group_id", - "searchCriteriaGroupId", - OCI.SearchCriteriaGroupId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_id", - "searchCriteriaUserId", - OCI.SearchCriteriaUserId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_last_name", - "searchCriteriaUserLastName", - OCI.SearchCriteriaUserLastName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_first_name", - "searchCriteriaUserFirstName", - OCI.SearchCriteriaUserFirstName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_dn", - "searchCriteriaDn", - OCI.SearchCriteriaDn, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_extension", - "searchCriteriaExtension", - OCI.SearchCriteriaExtension, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_reseller_id", - "searchCriteriaResellerId", - OCI.SearchCriteriaResellerId, - is_complex=True, - is_array=True, - ), - ) - - class SystemCallCenterEnhancedReportingBrandingModifyRequest(OCIRequest): """ Request to modify the system branding configuration. @@ -99080,271 +94250,12 @@ def _elements(cls) -> Tuple[E, ...]: ) -class SystemCallCenterEnhancedReportingScheduledReportGetActiveListRequest(OCIRequest): +class SystemCallProcessingPolicyProfileModifyRequest(OCIRequest): """ - Request to get the list of all active call center reporting scheduled reports in the - system. + Modify a call processing policy profile in system. - The response is either a - `SystemCallCenterEnhancedReportingScheduledReportGetActiveListResponse()` or an - `ErrorResponse()`. - - Attributes: - response_size_limit (int): responseSizeLimit *Optional* - search_criteria_call_center_scheduled_report_name - (List[OCI.searchCriteriaCallCenterScheduledReportName]): - searchCriteriaCallCenterScheduledReportName *Optional* - search_criteria_group_id (List[OCI.searchCriteriaGroupId]): searchCriteriaGroupId - *Optional* - search_criteria_exact_call_center_scheduled_report_service_provider - (OCI.searchCriteriaExactCallCenterScheduledReportServiceProvider): - searchCriteriaExactCallCenterScheduledReportServiceProvider *Optional* - search_criteria_service_provider_id (List[OCI.searchCriteriaServiceProviderId]): - searchCriteriaServiceProviderId *Optional* - search_criteria_exact_call_center_scheduled_report_created_by_supervisor - (OCI.searchCriteriaExactCallCenterScheduledReportCreatedBySupervisor): - searchCriteriaExactCallCenterScheduledReportCreatedBySupervisor *Optional* - search_criteria_call_center_report_template_name - (List[OCI.searchCriteriaCallCenterReportTemplateName]): - searchCriteriaCallCenterReportTemplateName *Optional* - """ - - __slots__: List[str] = [ - "response_size_limit", - "search_criteria_call_center_scheduled_report_name", - "search_criteria_group_id", - "search_criteria_exact_call_center_scheduled_report_service_provider", - "search_criteria_service_provider_id", - "search_criteria_exact_call_center_scheduled_report_created_by_supervisor", - "search_criteria_call_center_report_template_name", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("response_size_limit", "responseSizeLimit", int), - E( - "search_criteria_call_center_scheduled_report_name", - "searchCriteriaCallCenterScheduledReportName", - OCI.SearchCriteriaCallCenterScheduledReportName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_group_id", - "searchCriteriaGroupId", - OCI.SearchCriteriaGroupId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_exact_call_center_scheduled_report_service_provider", - "searchCriteriaExactCallCenterScheduledReportServiceProvider", - OCI.SearchCriteriaExactCallCenterScheduledReportServiceProvider, - is_complex=True, - ), - E( - "search_criteria_service_provider_id", - "searchCriteriaServiceProviderId", - OCI.SearchCriteriaServiceProviderId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_exact_call_center_scheduled_report_created_by_supervisor", - "searchCriteriaExactCallCenterScheduledReportCreatedBySupervisor", - OCI.SearchCriteriaExactCallCenterScheduledReportCreatedBySupervisor, - is_complex=True, - ), - E( - "search_criteria_call_center_report_template_name", - "searchCriteriaCallCenterReportTemplateName", - OCI.SearchCriteriaCallCenterReportTemplateName, - is_complex=True, - is_array=True, - ), - ) - - -class SystemCallCenterEnhancedReportingScheduledReportGetCompletedListRequest( - OCIRequest, -): - """ - Request to get the list of all completed call center reporting scheduled reports in - the system. - - The response is either a - `SystemCallCenterEnhancedReportingScheduledReportGetCompletedListResponse()` or an - `ErrorResponse()`. - - Attributes: - response_size_limit (int): responseSizeLimit *Optional* - search_criteria_call_center_scheduled_report_name - (List[OCI.searchCriteriaCallCenterScheduledReportName]): - searchCriteriaCallCenterScheduledReportName *Optional* - search_criteria_group_id (List[OCI.searchCriteriaGroupId]): searchCriteriaGroupId - *Optional* - search_criteria_exact_call_center_scheduled_report_service_provider - (OCI.searchCriteriaExactCallCenterScheduledReportServiceProvider): - searchCriteriaExactCallCenterScheduledReportServiceProvider *Optional* - search_criteria_service_provider_id (List[OCI.searchCriteriaServiceProviderId]): - searchCriteriaServiceProviderId *Optional* - search_criteria_exact_call_center_scheduled_report_created_by_supervisor - (OCI.searchCriteriaExactCallCenterScheduledReportCreatedBySupervisor): - searchCriteriaExactCallCenterScheduledReportCreatedBySupervisor *Optional* - search_criteria_call_center_report_template_name - (List[OCI.searchCriteriaCallCenterReportTemplateName]): - searchCriteriaCallCenterReportTemplateName *Optional* - """ - - __slots__: List[str] = [ - "response_size_limit", - "search_criteria_call_center_scheduled_report_name", - "search_criteria_group_id", - "search_criteria_exact_call_center_scheduled_report_service_provider", - "search_criteria_service_provider_id", - "search_criteria_exact_call_center_scheduled_report_created_by_supervisor", - "search_criteria_call_center_report_template_name", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("response_size_limit", "responseSizeLimit", int), - E( - "search_criteria_call_center_scheduled_report_name", - "searchCriteriaCallCenterScheduledReportName", - OCI.SearchCriteriaCallCenterScheduledReportName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_group_id", - "searchCriteriaGroupId", - OCI.SearchCriteriaGroupId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_exact_call_center_scheduled_report_service_provider", - "searchCriteriaExactCallCenterScheduledReportServiceProvider", - OCI.SearchCriteriaExactCallCenterScheduledReportServiceProvider, - is_complex=True, - ), - E( - "search_criteria_service_provider_id", - "searchCriteriaServiceProviderId", - OCI.SearchCriteriaServiceProviderId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_exact_call_center_scheduled_report_created_by_supervisor", - "searchCriteriaExactCallCenterScheduledReportCreatedBySupervisor", - OCI.SearchCriteriaExactCallCenterScheduledReportCreatedBySupervisor, - is_complex=True, - ), - E( - "search_criteria_call_center_report_template_name", - "searchCriteriaCallCenterReportTemplateName", - OCI.SearchCriteriaCallCenterReportTemplateName, - is_complex=True, - is_array=True, - ), - ) - - -class SystemCallCenterEnhancedReportingScheduledReportGetListRequest(OCIRequest): - """ - Request to get the list of all call center reporting scheduled reports in the system. - - The response is either an - `SystemCallCenterEnhancedReportingScheduledReportGetListResponse()` or an - `ErrorResponse()`. - - Attributes: - response_size_limit (int): responseSizeLimit *Optional* - search_criteria_call_center_scheduled_report_name - (List[OCI.searchCriteriaCallCenterScheduledReportName]): - searchCriteriaCallCenterScheduledReportName *Optional* - search_criteria_group_id (List[OCI.searchCriteriaGroupId]): searchCriteriaGroupId - *Optional* - search_criteria_exact_call_center_scheduled_report_service_provider - (OCI.searchCriteriaExactCallCenterScheduledReportServiceProvider): - searchCriteriaExactCallCenterScheduledReportServiceProvider *Optional* - search_criteria_service_provider_id (List[OCI.searchCriteriaServiceProviderId]): - searchCriteriaServiceProviderId *Optional* - search_criteria_exact_call_center_scheduled_report_created_by_supervisor - (OCI.searchCriteriaExactCallCenterScheduledReportCreatedBySupervisor): - searchCriteriaExactCallCenterScheduledReportCreatedBySupervisor *Optional* - search_criteria_call_center_report_template_name - (List[OCI.searchCriteriaCallCenterReportTemplateName]): - searchCriteriaCallCenterReportTemplateName *Optional* - """ - - __slots__: List[str] = [ - "response_size_limit", - "search_criteria_call_center_scheduled_report_name", - "search_criteria_group_id", - "search_criteria_exact_call_center_scheduled_report_service_provider", - "search_criteria_service_provider_id", - "search_criteria_exact_call_center_scheduled_report_created_by_supervisor", - "search_criteria_call_center_report_template_name", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("response_size_limit", "responseSizeLimit", int), - E( - "search_criteria_call_center_scheduled_report_name", - "searchCriteriaCallCenterScheduledReportName", - OCI.SearchCriteriaCallCenterScheduledReportName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_group_id", - "searchCriteriaGroupId", - OCI.SearchCriteriaGroupId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_exact_call_center_scheduled_report_service_provider", - "searchCriteriaExactCallCenterScheduledReportServiceProvider", - OCI.SearchCriteriaExactCallCenterScheduledReportServiceProvider, - is_complex=True, - ), - E( - "search_criteria_service_provider_id", - "searchCriteriaServiceProviderId", - OCI.SearchCriteriaServiceProviderId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_exact_call_center_scheduled_report_created_by_supervisor", - "searchCriteriaExactCallCenterScheduledReportCreatedBySupervisor", - OCI.SearchCriteriaExactCallCenterScheduledReportCreatedBySupervisor, - is_complex=True, - ), - E( - "search_criteria_call_center_report_template_name", - "searchCriteriaCallCenterReportTemplateName", - OCI.SearchCriteriaCallCenterReportTemplateName, - is_complex=True, - is_array=True, - ), - ) - - -class SystemCallProcessingPolicyProfileModifyRequest(OCIRequest): - """ - Modify a call processing policy profile in system. - - The response is either a `SuccessResponse()` or an `ErrorResponse()`. Replaced by - `SystemCallProcessingPolicyProfileModifyRequest20()`. + The response is either a `SuccessResponse()` or an `ErrorResponse()`. Replaced by + `SystemCallProcessingPolicyProfileModifyRequest20()`. Attributes: name (str): name @@ -99448,113 +94359,6 @@ def _elements(cls) -> Tuple[E, ...]: ) -class SystemClassmarkGetUtilizationListRequest(OCIRequest): - """ - Get the list of all users associated with a Class Mark in system. - - It is possible to search by various criteria. Multiple search criteria are logically - ANDed together. - - The response is either a `SystemClassmarkGetUtilizationListResponse()` or an - `ErrorResponse()`. - - Attributes: - classmark (str): classmark - response_size_limit (int): responseSizeLimit *Optional* - search_criteria_group_id (List[OCI.searchCriteriaGroupId]): searchCriteriaGroupId - *Optional* - search_criteria_exact_service_provider_id - (OCI.searchCriteriaExactServiceProviderId): - searchCriteriaExactServiceProviderId *Optional* - search_criteria_service_provider_id (List[OCI.searchCriteriaServiceProviderId]): - searchCriteriaServiceProviderId *Optional* - search_criteria_user_first_name (List[OCI.searchCriteriaUserFirstName]): - searchCriteriaUserFirstName *Optional* - search_criteria_user_last_name (List[OCI.searchCriteriaUserLastName]): - searchCriteriaUserLastName *Optional* - search_criteria_dn (List[OCI.searchCriteriaDn]): searchCriteriaDn *Optional* - search_criteria_user_id (List[OCI.searchCriteriaUserId]): searchCriteriaUserId - *Optional* - search_criteria_extension (List[OCI.searchCriteriaExtension]): - searchCriteriaExtension *Optional* - """ - - __slots__: List[str] = [ - "classmark", - "response_size_limit", - "search_criteria_group_id", - "search_criteria_exact_service_provider_id", - "search_criteria_service_provider_id", - "search_criteria_user_first_name", - "search_criteria_user_last_name", - "search_criteria_dn", - "search_criteria_user_id", - "search_criteria_extension", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("classmark", "classmark", str, is_required=True), - E("response_size_limit", "responseSizeLimit", int), - E( - "search_criteria_group_id", - "searchCriteriaGroupId", - OCI.SearchCriteriaGroupId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_exact_service_provider_id", - "searchCriteriaExactServiceProviderId", - OCI.SearchCriteriaExactServiceProvider, - is_complex=True, - ), - E( - "search_criteria_service_provider_id", - "searchCriteriaServiceProviderId", - OCI.SearchCriteriaServiceProviderId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_first_name", - "searchCriteriaUserFirstName", - OCI.SearchCriteriaUserFirstName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_last_name", - "searchCriteriaUserLastName", - OCI.SearchCriteriaUserLastName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_dn", - "searchCriteriaDn", - OCI.SearchCriteriaDn, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_id", - "searchCriteriaUserId", - OCI.SearchCriteriaUserId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_extension", - "searchCriteriaExtension", - OCI.SearchCriteriaExtension, - is_complex=True, - is_array=True, - ), - ) - - class SystemCollaborateModifyRequest(OCIRequest): """ Modify the system level data associated with collaborate services. @@ -99890,42 +94694,6 @@ def _elements(cls) -> Tuple[E, ...]: ) -class SystemCommunicationBarringDigitPatternCriteriaGetPatternListRequest(OCIRequest): - """ - Get an existing Digit Pattern Criteria. - - The response is either a - `SystemCommunicationBarringDigitPatternCriteriaGetPatternListResponse()` or an - `ErrorResponse()`. - - Attributes: - name (str): name - response_size_limit (int): responseSizeLimit *Optional* - search_criteria_digit_pattern (List[OCI.searchCriteriaDigitPattern]): - searchCriteriaDigitPattern *Optional* - """ - - __slots__: List[str] = [ - "name", - "response_size_limit", - "search_criteria_digit_pattern", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("name", "name", str, is_required=True), - E("response_size_limit", "responseSizeLimit", int), - E( - "search_criteria_digit_pattern", - "searchCriteriaDigitPattern", - OCI.SearchCriteriaDigitPattern, - is_complex=True, - is_array=True, - ), - ) - - class SystemCommunicationBarringIncomingCriteriaModifyRequest(OCIRequest): """ Modify an existing Communication Barring Incoming Criteria. @@ -100397,43 +95165,6 @@ def _elements(cls) -> Tuple[E, ...]: ) -class SystemDeviceFamilyGetListRequest(OCIRequest): - """ - Request to get the list of device family managed by the Device Management System. - - If includeSystemLevel is specified, all system level device families and the reseller - device families matching search criteria are returned even when - searchCriteriaResellerId is specified. If reseller administrator sends the request, - searchCriteriaResellerId is ignored and automatically set to the administrator's - reseller. - - The response is either `SystemDeviceFamilyGetListResponse()` or `ErrorResponse()`. - - Attributes: - include_system_level (bool): includeSystemLevel *Optional* - search_criteria_reseller_id (List[OCI.searchCriteriaResellerId]): - searchCriteriaResellerId *Optional* - """ - - __slots__: List[str] = [ - "include_system_level", - "search_criteria_reseller_id", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("include_system_level", "includeSystemLevel", bool), - E( - "search_criteria_reseller_id", - "searchCriteriaResellerId", - OCI.SearchCriteriaResellerId, - is_complex=True, - is_array=True, - ), - ) - - class SystemDeviceFamilyModifyRequest(OCIRequest): """ Request to modify a device family. @@ -100499,206 +95230,6 @@ def _elements(cls) -> Tuple[E, ...]: ) -class SystemDeviceManagementEventGetListRequest(OCIRequest): - """ - Request device management's events for a specific queue. - - It is possible to restrict the number of rows returned using responseSizeLimit. If - eventQueueType is not specified, the events from all the event queues are returned. - - The response is either a `SystemDeviceManagementEventGetListResponse()` or an - `ErrorResponse()`. Deprecated by: `SystemDeviceManagementEventGetListRequest22()`. - - Attributes: - event_queue_type (str): eventQueueType *Optional* - response_size_limit (int): responseSizeLimit *Optional* - search_criteria_exact_device_management_event_status_in_progress_or_pending - (OCI.searchCriteriaExactDeviceManagementEventStatusInProgressOrPending): - searchCriteriaExactDeviceManagementEventStatusInProgressOrPending *Optional* - search_criteria_exact_device_management_event_status_completed - (OCI.searchCriteriaExactDeviceManagementEventStatusCompleted): - searchCriteriaExactDeviceManagementEventStatusCompleted *Optional* - search_criteria_exact_device_management_event_action - (OCI.searchCriteriaExactDeviceManagementEventAction): - searchCriteriaExactDeviceManagementEventAction *Optional* - search_criteria_exact_device_management_event_level - (OCI.searchCriteriaExactDeviceManagementEventLevel): - searchCriteriaExactDeviceManagementEventLevel *Optional* - search_criteria_exact_device_management_event_type - (OCI.searchCriteriaExactDeviceManagementEventType): - searchCriteriaExactDeviceManagementEventType *Optional* - search_criteria_device_management_event_additional_info - (List[OCI.searchCriteriaDeviceManagementEventAdditionalInfo]): - searchCriteriaDeviceManagementEventAdditionalInfo *Optional* - search_criteria_device_management_event_login_id - (List[OCI.searchCriteriaDeviceManagementEventLoginId]): - searchCriteriaDeviceManagementEventLoginId *Optional* - """ - - __slots__: List[str] = [ - "event_queue_type", - "response_size_limit", - "search_criteria_exact_device_management_event_status_in_progress_or_pending", - "search_criteria_exact_device_management_event_status_completed", - "search_criteria_exact_device_management_event_action", - "search_criteria_exact_device_management_event_level", - "search_criteria_exact_device_management_event_type", - "search_criteria_device_management_event_additional_info", - "search_criteria_device_management_event_login_id", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("event_queue_type", "eventQueueType", str), - E("response_size_limit", "responseSizeLimit", int), - E( - "search_criteria_exact_device_management_event_status_in_progress_or_pending", - "searchCriteriaExactDeviceManagementEventStatusInProgressOrPending", - OCI.SearchCriteriaExactDeviceManagementEventStatusInProgressOrPending, - is_complex=True, - ), - E( - "search_criteria_exact_device_management_event_status_completed", - "searchCriteriaExactDeviceManagementEventStatusCompleted", - OCI.SearchCriteriaExactDeviceManagementEventStatusCompleted, - is_complex=True, - ), - E( - "search_criteria_exact_device_management_event_action", - "searchCriteriaExactDeviceManagementEventAction", - OCI.SearchCriteriaExactDeviceManagementEventAction, - is_complex=True, - ), - E( - "search_criteria_exact_device_management_event_level", - "searchCriteriaExactDeviceManagementEventLevel", - OCI.SearchCriteriaExactDeviceManagementEventLevel, - is_complex=True, - ), - E( - "search_criteria_exact_device_management_event_type", - "searchCriteriaExactDeviceManagementEventType", - OCI.SearchCriteriaExactDeviceManagementEventType, - is_complex=True, - ), - E( - "search_criteria_device_management_event_additional_info", - "searchCriteriaDeviceManagementEventAdditionalInfo", - OCI.SearchCriteriaDeviceManagementEventAdditionalInfo, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_device_management_event_login_id", - "searchCriteriaDeviceManagementEventLoginId", - OCI.SearchCriteriaDeviceManagementEventLoginId, - is_complex=True, - is_array=True, - ), - ) - - -class SystemDeviceManagementEventGetListRequest22(OCIRequest): - """ - Request device management's events for a specific queue. - - It is possible to restrict the number of rows returned using responseSizeLimit. If - eventQueueType is not specified, the events from all the event queues are returned. - - The response is either a `SystemDeviceManagementEventGetListResponse22()` or an - `ErrorResponse()`. - - Attributes: - event_queue_type (str): eventQueueType *Optional* - response_size_limit (int): responseSizeLimit *Optional* - search_criteria_exact_device_management_event_status_in_progress_or_pending - (OCI.searchCriteriaExactDeviceManagementEventStatusInProgressOrPending): - searchCriteriaExactDeviceManagementEventStatusInProgressOrPending *Optional* - search_criteria_exact_device_management_event_status_completed - (OCI.searchCriteriaExactDeviceManagementEventStatusCompleted): - searchCriteriaExactDeviceManagementEventStatusCompleted *Optional* - search_criteria_exact_device_management_event_action - (OCI.searchCriteriaExactDeviceManagementEventAction): - searchCriteriaExactDeviceManagementEventAction *Optional* - search_criteria_exact_device_management_event_level - (OCI.searchCriteriaExactDeviceManagementEventLevel): - searchCriteriaExactDeviceManagementEventLevel *Optional* - search_criteria_exact_device_management_event_type - (OCI.searchCriteriaExactDeviceManagementEventType): - searchCriteriaExactDeviceManagementEventType *Optional* - search_criteria_device_management_event_additional_info - (List[OCI.searchCriteriaDeviceManagementEventAdditionalInfo]): - searchCriteriaDeviceManagementEventAdditionalInfo *Optional* - search_criteria_device_management_event_login_id - (List[OCI.searchCriteriaDeviceManagementEventLoginId]): - searchCriteriaDeviceManagementEventLoginId *Optional* - """ - - __slots__: List[str] = [ - "event_queue_type", - "response_size_limit", - "search_criteria_exact_device_management_event_status_in_progress_or_pending", - "search_criteria_exact_device_management_event_status_completed", - "search_criteria_exact_device_management_event_action", - "search_criteria_exact_device_management_event_level", - "search_criteria_exact_device_management_event_type", - "search_criteria_device_management_event_additional_info", - "search_criteria_device_management_event_login_id", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("event_queue_type", "eventQueueType", str), - E("response_size_limit", "responseSizeLimit", int), - E( - "search_criteria_exact_device_management_event_status_in_progress_or_pending", - "searchCriteriaExactDeviceManagementEventStatusInProgressOrPending", - OCI.SearchCriteriaExactDeviceManagementEventStatusInProgressOrPending, - is_complex=True, - ), - E( - "search_criteria_exact_device_management_event_status_completed", - "searchCriteriaExactDeviceManagementEventStatusCompleted", - OCI.SearchCriteriaExactDeviceManagementEventStatusCompleted, - is_complex=True, - ), - E( - "search_criteria_exact_device_management_event_action", - "searchCriteriaExactDeviceManagementEventAction", - OCI.SearchCriteriaExactDeviceManagementEventAction, - is_complex=True, - ), - E( - "search_criteria_exact_device_management_event_level", - "searchCriteriaExactDeviceManagementEventLevel", - OCI.SearchCriteriaExactDeviceManagementEventLevel, - is_complex=True, - ), - E( - "search_criteria_exact_device_management_event_type", - "searchCriteriaExactDeviceManagementEventType", - OCI.SearchCriteriaExactDeviceManagementEventType, - is_complex=True, - ), - E( - "search_criteria_device_management_event_additional_info", - "searchCriteriaDeviceManagementEventAdditionalInfo", - OCI.SearchCriteriaDeviceManagementEventAdditionalInfo, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_device_management_event_login_id", - "searchCriteriaDeviceManagementEventLoginId", - OCI.SearchCriteriaDeviceManagementEventLoginId, - is_complex=True, - is_array=True, - ), - ) - - class SystemDeviceManagementTagSetImportDryRunRequest(OCIRequest): """ Request to perform a dry run for the import of a Tag Set Archive File (TSAF) as a new @@ -100849,76 +95380,6 @@ def _elements(cls) -> Tuple[E, ...]: ) -class SystemDeviceProfileAuthenticationLockoutGetRequest(OCIRequest): - """ - Request to get device password authentication lockout data in the system. - - The response is either a `SystemDeviceProfileAuthenticationLockoutGetResponse()` or an - `ErrorResponse()`. - - Attributes: - response_size_limit (int): responseSizeLimit *Optional* - search_criteria_service_provider_id (List[OCI.searchCriteriaServiceProviderId]): - searchCriteriaServiceProviderId *Optional* - search_criteria_exact_organization_type (OCI.searchCriteriaExactOrganizationType): - searchCriteriaExactOrganizationType *Optional* - search_criteria_group_id (List[OCI.searchCriteriaGroupId]): searchCriteriaGroupId - *Optional* - search_criteria_device_name (List[OCI.searchCriteriaDeviceName]): - searchCriteriaDeviceName *Optional* - search_criteria_exact_device_type (OCI.searchCriteriaExactDeviceType): - searchCriteriaExactDeviceType *Optional* - """ - - __slots__: List[str] = [ - "response_size_limit", - "search_criteria_service_provider_id", - "search_criteria_exact_organization_type", - "search_criteria_group_id", - "search_criteria_device_name", - "search_criteria_exact_device_type", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("response_size_limit", "responseSizeLimit", int), - E( - "search_criteria_service_provider_id", - "searchCriteriaServiceProviderId", - OCI.SearchCriteriaServiceProviderId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_exact_organization_type", - "searchCriteriaExactOrganizationType", - OCI.SearchCriteriaExactOrganizationType, - is_complex=True, - ), - E( - "search_criteria_group_id", - "searchCriteriaGroupId", - OCI.SearchCriteriaGroupId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_device_name", - "searchCriteriaDeviceName", - OCI.SearchCriteriaDeviceName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_exact_device_type", - "searchCriteriaExactDeviceType", - OCI.SearchCriteriaExactDeviceType, - is_complex=True, - ), - ) - - class SystemDeviceTypeImportDryRunRequest(OCIRequest): """ Request to perform a dry run for the import of a Device Type Archive File (DTAF) as a @@ -101109,302 +95570,6 @@ def _elements(cls) -> Tuple[E, ...]: ) -class SystemDnGetSummaryListRequest(OCIRequest): - """ - Request a summary table of all DNs in the system. - - If resellerId is specified, the DNs assigned to the enterprises/service providers - within the reseller are returned. If reseller administrator sends the request and - resellerId is not specified, the administrator's resellerId is used. The search can - be done using multiple criteria. Only results matching all the search criteria are - included in the results. - - The response is either `SystemDnGetSummaryListResponse()` or `ErrorResponse()`. The - following data elements are only used in AS data mode: resellerId The following - elements are only used in XS data mode and ignored in AS data mode: searchCriteriaDn, - searchCriteriaServiceProviderId, searchCriteriaExactOrganizationType - - Attributes: - reseller_id (str): resellerId *Optional* - search_criteria_dn (List[OCI.searchCriteriaDn]): searchCriteriaDn *Optional* - search_criteria_service_provider_id (List[OCI.searchCriteriaServiceProviderId]): - searchCriteriaServiceProviderId *Optional* - search_criteria_exact_organization_type (OCI.searchCriteriaExactOrganizationType): - searchCriteriaExactOrganizationType *Optional* - """ - - __slots__: List[str] = [ - "reseller_id", - "search_criteria_dn", - "search_criteria_service_provider_id", - "search_criteria_exact_organization_type", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("reseller_id", "resellerId", str), - E( - "search_criteria_dn", - "searchCriteriaDn", - OCI.SearchCriteriaDn, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_service_provider_id", - "searchCriteriaServiceProviderId", - OCI.SearchCriteriaServiceProviderId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_exact_organization_type", - "searchCriteriaExactOrganizationType", - OCI.SearchCriteriaExactOrganizationType, - is_complex=True, - ), - ) - - -class SystemDomainGetListRequest22V2(OCIRequest): - """ - Requests the list of all matching system-level domains and all matching reseller level - domains. - - If excludeReseller is specified, returns all matching system-level domain names only. - If resellerId is specified, returns all matching system-level domain names and the - given reseller's domains. If reseller administrator sends the request and resellerId - is not specified, the administrator's resellerId is used. - - The response is either `SystemDomainGetListResponse22V2()` or `ErrorResponse()`. The - following elements are only used in AS data mode and will be ingored in XS data mode: - includeReseller resellerId responseSizeLimit searchCriteriaDomainName - searchCriteriaResellerId searchCriteriaExactDomainLevel - - Attributes: - exclude_reseller (bool): excludeReseller *Optional* - reseller_id (str): resellerId *Optional* - response_size_limit (int): responseSizeLimit *Optional* - search_criteria_domain_name (List[OCI.searchCriteriaDomainName]): - searchCriteriaDomainName *Optional* - search_criteria_reseller_id (List[OCI.searchCriteriaResellerId]): - searchCriteriaResellerId *Optional* - search_criteria_exact_domain_level (OCI.searchCriteriaExactDomainLevel): - searchCriteriaExactDomainLevel *Optional* - """ - - __slots__: List[str] = [ - "exclude_reseller", - "reseller_id", - "response_size_limit", - "search_criteria_domain_name", - "search_criteria_reseller_id", - "search_criteria_exact_domain_level", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("exclude_reseller", "excludeReseller", bool), - E("reseller_id", "resellerId", str), - E("response_size_limit", "responseSizeLimit", int), - E( - "search_criteria_domain_name", - "searchCriteriaDomainName", - OCI.SearchCriteriaDomainName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_reseller_id", - "searchCriteriaResellerId", - OCI.SearchCriteriaResellerId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_exact_domain_level", - "searchCriteriaExactDomainLevel", - OCI.SearchCriteriaExactDomainLevel, - is_complex=True, - ), - ) - - -class SystemEndpointGetListRequest(OCIRequest): - """ - Request to search endpoints in the system. - - If reseller administrator sends the request, searchCriteriaResellerId is ignored. All - endpoints in the administrator's reseller meeting the search criteria are returned. - - The response is either `SystemEndpointGetListResponse()` or `ErrorResponse()`. The - following data elements are only used in AS data mode: searchCriteriaResellerId - - Attributes: - response_size_limit (int): responseSizeLimit *Optional* - search_criteria_service_provider_id (List[OCI.searchCriteriaServiceProviderId]): - searchCriteriaServiceProviderId *Optional* - search_criteria_exact_organization_type (OCI.searchCriteriaExactOrganizationType): - searchCriteriaExactOrganizationType *Optional* - search_criteria_group_id (List[OCI.searchCriteriaGroupId]): searchCriteriaGroupId - *Optional* - search_criteria_line_port_user_part (List[OCI.searchCriteriaLinePortUserPart]): - searchCriteriaLinePortUserPart *Optional* - search_criteria_line_port_domain (List[OCI.searchCriteriaLinePortDomain]): - searchCriteriaLinePortDomain *Optional* - search_criteria_user_last_name (List[OCI.searchCriteriaUserLastName]): - searchCriteriaUserLastName *Optional* - search_criteria_user_first_name (List[OCI.searchCriteriaUserFirstName]): - searchCriteriaUserFirstName *Optional* - search_criteria_user_id (List[OCI.searchCriteriaUserId]): searchCriteriaUserId - *Optional* - search_criteria_dn (List[OCI.searchCriteriaDn]): searchCriteriaDn *Optional* - search_criteria_extension (List[OCI.searchCriteriaExtension]): - searchCriteriaExtension *Optional* - search_criteria_device_type (List[OCI.searchCriteriaDeviceType]): - searchCriteriaDeviceType *Optional* - search_criteria_device_name (List[OCI.searchCriteriaDeviceName]): - searchCriteriaDeviceName *Optional* - search_criteria_device_mac_address (List[OCI.searchCriteriaDeviceMACAddress]): - searchCriteriaDeviceMACAddress *Optional* - search_criteria_device_net_address (List[OCI.searchCriteriaDeviceNetAddress]): - searchCriteriaDeviceNetAddress *Optional* - search_criteria_reseller_id (List[OCI.searchCriteriaResellerId]): - searchCriteriaResellerId *Optional* - """ - - __slots__: List[str] = [ - "response_size_limit", - "search_criteria_service_provider_id", - "search_criteria_exact_organization_type", - "search_criteria_group_id", - "search_criteria_line_port_user_part", - "search_criteria_line_port_domain", - "search_criteria_user_last_name", - "search_criteria_user_first_name", - "search_criteria_user_id", - "search_criteria_dn", - "search_criteria_extension", - "search_criteria_device_type", - "search_criteria_device_name", - "search_criteria_device_mac_address", - "search_criteria_device_net_address", - "search_criteria_reseller_id", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("response_size_limit", "responseSizeLimit", int), - E( - "search_criteria_service_provider_id", - "searchCriteriaServiceProviderId", - OCI.SearchCriteriaServiceProviderId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_exact_organization_type", - "searchCriteriaExactOrganizationType", - OCI.SearchCriteriaExactOrganizationType, - is_complex=True, - ), - E( - "search_criteria_group_id", - "searchCriteriaGroupId", - OCI.SearchCriteriaGroupId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_line_port_user_part", - "searchCriteriaLinePortUserPart", - OCI.SearchCriteriaLinePortUserPart, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_line_port_domain", - "searchCriteriaLinePortDomain", - OCI.SearchCriteriaLinePortDomain, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_last_name", - "searchCriteriaUserLastName", - OCI.SearchCriteriaUserLastName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_first_name", - "searchCriteriaUserFirstName", - OCI.SearchCriteriaUserFirstName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_id", - "searchCriteriaUserId", - OCI.SearchCriteriaUserId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_dn", - "searchCriteriaDn", - OCI.SearchCriteriaDn, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_extension", - "searchCriteriaExtension", - OCI.SearchCriteriaExtension, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_device_type", - "searchCriteriaDeviceType", - OCI.SearchCriteriaDeviceType, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_device_name", - "searchCriteriaDeviceName", - OCI.SearchCriteriaDeviceName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_device_mac_address", - "searchCriteriaDeviceMACAddress", - OCI.SearchCriteriaDeviceMACAddress, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_device_net_address", - "searchCriteriaDeviceNetAddress", - OCI.SearchCriteriaDeviceNetAddress, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_reseller_id", - "searchCriteriaResellerId", - OCI.SearchCriteriaResellerId, - is_complex=True, - is_array=True, - ), - ) - - class SystemFeatureAccessCodeModifyListRequest(OCIRequest): """ Modify default Feature Access Codes. @@ -101637,181 +95802,6 @@ def _elements(cls) -> Tuple[E, ...]: ) -class SystemGetRegistrationContactListRequest(OCIRequest): - """ - Get the list of registration contacts. - - This request handles all levels of administration privileges. The content of the - response will only contain items within the scope of the requester's login id. At the - system level any of the choice parameters may be specified to filter the registrations - listed. At the reseller level, the resellerId must be specified. ResellerId is not - valid at service provider, group or user level. At the service provider level the - serviceProviderId must be specified for the service provider and group options. When - using the userId or linePort options the specified value must be valid for that - service provider login. At the group level the servicProviderId and the groupId must - be specified for the group option. When using the userId or linePort options the - specified value must be valid for that group login. The serviceProviderId option is - not valid at the group level. At the user level when using the userId or linePort - options the specified value must be valid for that user login. The serviceProviderId - and groupId options are not valid at the user level. - - The response is either `SystemGetRegistrationContactListResponse()` or - `ErrorResponse()`. The following elements are only used in AS data mode: resellerId - - Attributes: - reseller_id (str): resellerId *Optional* - service_provider_id (str): serviceProviderId *Optional* - svc_provider_id (str): svcProviderId *Optional* - group_id (str): groupId *Optional* - user_id (str): userId *Optional* - line_port (str): linePort *Optional* - device_level (str): deviceLevel *Optional* - device_name (str): deviceName *Optional* - device_type (str): deviceType *Optional* - search_criteria_registration_uri (List[OCI.searchCriteriaRegistrationURI]): - searchCriteriaRegistrationURI *Optional* - search_criteria_sip_contact (List[OCI.searchCriteriaSIPContact]): - searchCriteriaSIPContact *Optional* - endpoint_type (str): endpointType *Optional* - expired (bool): expired *Optional* - """ - - __slots__: List[str] = [ - "reseller_id", - "service_provider_id", - "svc_provider_id", - "group_id", - "user_id", - "line_port", - "device_level", - "device_name", - "device_type", - "search_criteria_registration_uri", - "search_criteria_sip_contact", - "endpoint_type", - "expired", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("reseller_id", "resellerId", str), - E("service_provider_id", "serviceProviderId", str), - E("svc_provider_id", "svcProviderId", str), - E("group_id", "groupId", str), - E("user_id", "userId", str), - E("line_port", "linePort", str), - E("device_level", "deviceLevel", str), - E("device_name", "deviceName", str), - E("device_type", "deviceType", str), - E( - "search_criteria_registration_uri", - "searchCriteriaRegistrationURI", - OCI.SearchCriteriaRegistrationURI, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_sip_contact", - "searchCriteriaSIPContact", - OCI.SearchCriteriaSIPContact, - is_complex=True, - is_array=True, - ), - E("endpoint_type", "endpointType", str), - E("expired", "expired", bool), - ) - - -class SystemGetRegistrationContactListRequest21sp1(OCIRequest): - """ - Get the list of registration contacts. - - This request handles all levels of administration privileges. The content of the - response will only contain items within the scope of the requester's login id. At the - system level any of the choice parameters may be specified to filter the registrations - listed. At the reseller level, the resellerId must be specified. ResellerId is not - valid at service provider, group or user level. At the service provider level the - serviceProviderId must be specified for the service provider and group options. When - using the userId or linePort options the specified value must be valid for that - service provider login. At the group level the servicProviderId and the groupId must - be specified for the group option. When using the userId or linePort options the - specified value must be valid for that group login. The serviceProviderId option is - not valid at the group level. At the user level when using the userId or linePort - options the specified value must be valid for that user login. The serviceProviderId - and groupId options are not valid at the user level. - - The response is either `SystemGetRegistrationContactListResponse21sp1()` or - `ErrorResponse()`. The RegistrationEndpointType21sp1 is sent in response The Endpoint - Type column contains one of the enumerated RegistrationEndpointType21sp1 values. The - value Mobility in Endpoint Type column is only applicable in AS data mode. The - following elements are only used in AS data mode: resellerId - - Attributes: - reseller_id (str): resellerId *Optional* - service_provider_id (str): serviceProviderId *Optional* - svc_provider_id (str): svcProviderId *Optional* - group_id (str): groupId *Optional* - user_id (str): userId *Optional* - line_port (str): linePort *Optional* - device_level (str): deviceLevel *Optional* - device_name (str): deviceName *Optional* - device_type (str): deviceType *Optional* - search_criteria_registration_uri (List[OCI.searchCriteriaRegistrationURI]): - searchCriteriaRegistrationURI *Optional* - search_criteria_sip_contact (List[OCI.searchCriteriaSIPContact]): - searchCriteriaSIPContact *Optional* - endpoint_type (str): endpointType *Optional* - expired (bool): expired *Optional* - """ - - __slots__: List[str] = [ - "reseller_id", - "service_provider_id", - "svc_provider_id", - "group_id", - "user_id", - "line_port", - "device_level", - "device_name", - "device_type", - "search_criteria_registration_uri", - "search_criteria_sip_contact", - "endpoint_type", - "expired", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("reseller_id", "resellerId", str), - E("service_provider_id", "serviceProviderId", str), - E("svc_provider_id", "svcProviderId", str), - E("group_id", "groupId", str), - E("user_id", "userId", str), - E("line_port", "linePort", str), - E("device_level", "deviceLevel", str), - E("device_name", "deviceName", str), - E("device_type", "deviceType", str), - E( - "search_criteria_registration_uri", - "searchCriteriaRegistrationURI", - OCI.SearchCriteriaRegistrationURI, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_sip_contact", - "searchCriteriaSIPContact", - OCI.SearchCriteriaSIPContact, - is_complex=True, - is_array=True, - ), - E("endpoint_type", "endpointType", str), - E("expired", "expired", bool), - ) - - class SystemHolidayScheduleAddRequest(OCIRequest): """ Add a system holiday schedule. @@ -101977,37 +95967,6 @@ def _elements(cls) -> Tuple[E, ...]: ) -class SystemHomeNetworkGetListRequest(OCIRequest): - """ - Get the list of all Home Networks. - - The response is either a `SystemHomeNetworkGetListResponse()` or an `ErrorResponse()`. - - Attributes: - response_size_limit (int): responseSizeLimit *Optional* - search_criteria_home_msc_address (List[OCI.searchCriteriaHomeMscAddress]): - searchCriteriaHomeMscAddress *Optional* - """ - - __slots__: List[str] = [ - "response_size_limit", - "search_criteria_home_msc_address", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("response_size_limit", "responseSizeLimit", int), - E( - "search_criteria_home_msc_address", - "searchCriteriaHomeMscAddress", - OCI.SearchCriteriaHomeMscAddress, - is_complex=True, - is_array=True, - ), - ) - - class SystemInterceptUserAddDnListRequest(OCIRequest): """ Request to add an Intercept User number(s) to the system. @@ -102431,50 +96390,6 @@ def _elements(cls) -> Tuple[E, ...]: ) -class SystemNumberPortabilityQueryDigitPatternGetListRequest(OCIRequest): - """ - Request to get the System Number Portability Query Digit Pattern List information. - - The response is either a `SystemNumberPortabilityQueryDigitPatternGetListResponse()` - or an `ErrorResponse()`. - - Attributes: - search_criteria_number_portability_query_digit_pattern - (List[OCI.searchCriteriaNumberPortabilityQueryDigitPattern]): - searchCriteriaNumberPortabilityQueryDigitPattern *Optional* - search_criteria_number_portability_status - (List[OCI.searchCriteriaNumberPortabilityStatus]): - searchCriteriaNumberPortabilityStatus *Optional* - response_size_limit (int): responseSizeLimit *Optional* - """ - - __slots__: List[str] = [ - "search_criteria_number_portability_query_digit_pattern", - "search_criteria_number_portability_status", - "response_size_limit", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E( - "search_criteria_number_portability_query_digit_pattern", - "searchCriteriaNumberPortabilityQueryDigitPattern", - OCI.SearchCriteriaNumberPortabilityQueryDigitPattern, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_number_portability_status", - "searchCriteriaNumberPortabilityStatus", - OCI.SearchCriteriaNumberPortabilityStatus, - is_complex=True, - is_array=True, - ), - E("response_size_limit", "responseSizeLimit", int), - ) - - class SystemOfficeZoneModifyRequest(OCIRequest): """ Modify an existing Office Zone. @@ -102513,436 +96428,88 @@ def _elements(cls) -> Tuple[E, ...]: ) -class SystemPreferredCarrierGetGroupListRequest(OCIRequest): +class SystemSIPAuthenticationEndpointLockoutClearRequest(OCIRequest): """ - Requests a list of groups using the specified carrier. - - It is possible to restrict the number of rows returned by specifying various search - criteria. Multiple search criteria are logically ANDed together. + Request to clear sip authentication endpoint lockouts in the system. - The response is either a `SystemPreferredCarrierGetGroupListResponse()` or an - `ErrorResponse()`. + The response is either a `SuccessResponse()` or an `ErrorResponse()`. Attributes: - carrier (str): carrier - response_size_limit (int): responseSizeLimit *Optional* - search_criteria_group_id (List[OCI.searchCriteriaGroupId]): searchCriteriaGroupId - *Optional* - search_criteria_group_name (List[OCI.searchCriteriaGroupName]): - searchCriteriaGroupName *Optional* - search_criteria_exact_service_provider (OCI.searchCriteriaExactServiceProvider): - searchCriteriaExactServiceProvider *Optional* - search_criteria_service_provider_id (List[OCI.searchCriteriaServiceProviderId]): - searchCriteriaServiceProviderId *Optional* + user_endpoint_key (List[OCI.userEndpointKey]): userEndpointKey """ __slots__: List[str] = [ - "carrier", - "response_size_limit", - "search_criteria_group_id", - "search_criteria_group_name", - "search_criteria_exact_service_provider", - "search_criteria_service_provider_id", + "user_endpoint_key", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("carrier", "carrier", str, is_required=True), - E("response_size_limit", "responseSizeLimit", int), - E( - "search_criteria_group_id", - "searchCriteriaGroupId", - OCI.SearchCriteriaGroupId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_group_name", - "searchCriteriaGroupName", - OCI.SearchCriteriaGroupName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_exact_service_provider", - "searchCriteriaExactServiceProvider", - OCI.SearchCriteriaExactServiceProvider, - is_complex=True, - ), E( - "search_criteria_service_provider_id", - "searchCriteriaServiceProviderId", - OCI.SearchCriteriaServiceProviderId, + "user_endpoint_key", + "userEndpointKey", + OCI.UserEndpointKey, is_complex=True, + is_required=True, is_array=True, ), ) -class SystemPreferredCarrierGetUserListRequest(OCIRequest): +class SystemSIPAuthenticationTrunkGroupLockoutClearRequest(OCIRequest): """ - Requests a list of users using the specified carrier. - - It is possible to restrict the number of rows returned by specifying various search - criteria. Multiple search criteria are logically ANDed together. + Request to clear sip authentication trunk group lockouts in the system. - The response is either a `SystemPreferreredCarrierGetUserListResponse()` or an - `ErrorResponse()`. + The response is either a `SuccessResponse()` or an `ErrorResponse()`. Attributes: - carrier (str): carrier - response_size_limit (int): responseSizeLimit *Optional* - search_criteria_user_last_name (List[OCI.searchCriteriaUserLastName]): - searchCriteriaUserLastName *Optional* - search_criteria_user_first_name (List[OCI.searchCriteriaUserFirstName]): - searchCriteriaUserFirstName *Optional* - search_criteria_dn (List[OCI.searchCriteriaDn]): searchCriteriaDn *Optional* - search_criteria_email_address (List[OCI.searchCriteriaEmailAddress]): - searchCriteriaEmailAddress *Optional* - search_criteria_user_id (List[OCI.searchCriteriaUserId]): searchCriteriaUserId - *Optional* - search_criteria_extension (List[OCI.searchCriteriaExtension]): - searchCriteriaExtension *Optional* + trunk_groupkey (List[OCI.trunkGroupkey]): trunkGroupkey """ __slots__: List[str] = [ - "carrier", - "response_size_limit", - "search_criteria_user_last_name", - "search_criteria_user_first_name", - "search_criteria_dn", - "search_criteria_email_address", - "search_criteria_user_id", - "search_criteria_extension", + "trunk_groupkey", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("carrier", "carrier", str, is_required=True), - E("response_size_limit", "responseSizeLimit", int), - E( - "search_criteria_user_last_name", - "searchCriteriaUserLastName", - OCI.SearchCriteriaUserLastName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_first_name", - "searchCriteriaUserFirstName", - OCI.SearchCriteriaUserFirstName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_dn", - "searchCriteriaDn", - OCI.SearchCriteriaDn, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_email_address", - "searchCriteriaEmailAddress", - OCI.SearchCriteriaEmailAddress, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_id", - "searchCriteriaUserId", - OCI.SearchCriteriaUserId, - is_complex=True, - is_array=True, - ), E( - "search_criteria_extension", - "searchCriteriaExtension", - OCI.SearchCriteriaExtension, + "trunk_groupkey", + "trunkGroupkey", + OCI.TrunkGroupKey, is_complex=True, + is_required=True, is_array=True, ), ) -class SystemRoamingNetworkGetListRequest(OCIRequest): +class SystemSIPDeviceTypeAddRequest(OCIRequest): """ - Get the list of all Roaming Networks. + Request to add a sip device type. - The response is either a `SystemRoamingNetworkGetListResponse()` or an - `ErrorResponse()`. + The response is either `SuccessResponse()` or `ErrorResponse()`. Attributes: - response_size_limit (int): responseSizeLimit *Optional* - search_criteria_roaming_msc_address (List[OCI.searchCriteriaRoamingMscAddress]): - searchCriteriaRoamingMscAddress *Optional* - """ - - __slots__: List[str] = [ - "response_size_limit", - "search_criteria_roaming_msc_address", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("response_size_limit", "responseSizeLimit", int), - E( - "search_criteria_roaming_msc_address", - "searchCriteriaRoamingMscAddress", - OCI.SearchCriteriaRoamingMscAddress, - is_complex=True, - is_array=True, - ), - ) - - -class SystemSIPAuthenticationEndpointLockoutClearRequest(OCIRequest): - """ - Request to clear sip authentication endpoint lockouts in the system. - - The response is either a `SuccessResponse()` or an `ErrorResponse()`. - - Attributes: - user_endpoint_key (List[OCI.userEndpointKey]): userEndpointKey - """ - - __slots__: List[str] = [ - "user_endpoint_key", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E( - "user_endpoint_key", - "userEndpointKey", - OCI.UserEndpointKey, - is_complex=True, - is_required=True, - is_array=True, - ), - ) - - -class SystemSIPAuthenticationEndpointLockoutGetRequest(OCIRequest): - """ - Request to get sip authentication endpoint lockout data in the system. - - The response is either a `SystemSIPAuthenticationEndpointLockoutGetResponse()` or an - `ErrorResponse()`. - - Attributes: - response_size_limit (int): responseSizeLimit *Optional* - search_criteria_service_provider_id (List[OCI.searchCriteriaServiceProviderId]): - searchCriteriaServiceProviderId *Optional* - search_criteria_exact_organization_type (OCI.searchCriteriaExactOrganizationType): - searchCriteriaExactOrganizationType *Optional* - search_criteria_group_id (List[OCI.searchCriteriaGroupId]): searchCriteriaGroupId - *Optional* - search_criteria_line_port_user_part (List[OCI.searchCriteriaLinePortUserPart]): - searchCriteriaLinePortUserPart *Optional* - search_criteria_line_port_domain (List[OCI.searchCriteriaLinePortDomain]): - searchCriteriaLinePortDomain *Optional* - search_criteria_user_last_name (List[OCI.searchCriteriaUserLastName]): - searchCriteriaUserLastName *Optional* - search_criteria_user_first_name (List[OCI.searchCriteriaUserFirstName]): - searchCriteriaUserFirstName *Optional* - search_criteria_user_id (List[OCI.searchCriteriaUserId]): searchCriteriaUserId - *Optional* - """ - - __slots__: List[str] = [ - "response_size_limit", - "search_criteria_service_provider_id", - "search_criteria_exact_organization_type", - "search_criteria_group_id", - "search_criteria_line_port_user_part", - "search_criteria_line_port_domain", - "search_criteria_user_last_name", - "search_criteria_user_first_name", - "search_criteria_user_id", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("response_size_limit", "responseSizeLimit", int), - E( - "search_criteria_service_provider_id", - "searchCriteriaServiceProviderId", - OCI.SearchCriteriaServiceProviderId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_exact_organization_type", - "searchCriteriaExactOrganizationType", - OCI.SearchCriteriaExactOrganizationType, - is_complex=True, - ), - E( - "search_criteria_group_id", - "searchCriteriaGroupId", - OCI.SearchCriteriaGroupId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_line_port_user_part", - "searchCriteriaLinePortUserPart", - OCI.SearchCriteriaLinePortUserPart, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_line_port_domain", - "searchCriteriaLinePortDomain", - OCI.SearchCriteriaLinePortDomain, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_last_name", - "searchCriteriaUserLastName", - OCI.SearchCriteriaUserLastName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_first_name", - "searchCriteriaUserFirstName", - OCI.SearchCriteriaUserFirstName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_id", - "searchCriteriaUserId", - OCI.SearchCriteriaUserId, - is_complex=True, - is_array=True, - ), - ) - - -class SystemSIPAuthenticationTrunkGroupLockoutClearRequest(OCIRequest): - """ - Request to clear sip authentication trunk group lockouts in the system. - - The response is either a `SuccessResponse()` or an `ErrorResponse()`. - - Attributes: - trunk_groupkey (List[OCI.trunkGroupkey]): trunkGroupkey - """ - - __slots__: List[str] = [ - "trunk_groupkey", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E( - "trunk_groupkey", - "trunkGroupkey", - OCI.TrunkGroupKey, - is_complex=True, - is_required=True, - is_array=True, - ), - ) - - -class SystemSIPAuthenticationTrunkGroupLockoutGetRequest(OCIRequest): - """ - Request to get sip authentication trunk group lockout data in the system. - - The response is either a `SystemSIPAuthenticationTrunkGroupLockoutGetResponse()` or an - `ErrorResponse()`. - - Attributes: - response_size_limit (int): responseSizeLimit *Optional* - search_criteria_service_provider_id (List[OCI.searchCriteriaServiceProviderId]): - searchCriteriaServiceProviderId *Optional* - search_criteria_exact_organization_type (OCI.searchCriteriaExactOrganizationType): - searchCriteriaExactOrganizationType *Optional* - search_criteria_group_id (List[OCI.searchCriteriaGroupId]): searchCriteriaGroupId - *Optional* - search_criteria_trunk_group_name (List[OCI.searchCriteriaTrunkGroupName]): - searchCriteriaTrunkGroupName *Optional* - """ - - __slots__: List[str] = [ - "response_size_limit", - "search_criteria_service_provider_id", - "search_criteria_exact_organization_type", - "search_criteria_group_id", - "search_criteria_trunk_group_name", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("response_size_limit", "responseSizeLimit", int), - E( - "search_criteria_service_provider_id", - "searchCriteriaServiceProviderId", - OCI.SearchCriteriaServiceProviderId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_exact_organization_type", - "searchCriteriaExactOrganizationType", - OCI.SearchCriteriaExactOrganizationType, - is_complex=True, - ), - E( - "search_criteria_group_id", - "searchCriteriaGroupId", - OCI.SearchCriteriaGroupId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_trunk_group_name", - "searchCriteriaTrunkGroupName", - OCI.SearchCriteriaTrunkGroupName, - is_complex=True, - is_array=True, - ), - ) - - -class SystemSIPDeviceTypeAddRequest(OCIRequest): - """ - Request to add a sip device type. - - The response is either `SuccessResponse()` or `ErrorResponse()`. - - Attributes: - device_type (str): deviceType - number_of_ports (OCI.numberOfPorts): numberOfPorts - profile (str): profile - registration_capable (bool): registrationCapable - is_conference_device (bool): isConferenceDevice - is_music_on_hold_device (bool): isMusicOnHoldDevice - authentication_override (bool): authenticationOverride - rfc3264_hold (bool): RFC3264Hold - is_trusted (bool): isTrusted - e164_capable (bool): E164Capable - route_advance (bool): routeAdvance - forwarding_override (bool): forwardingOverride - wireless_integration (bool): wirelessIntegration - web_based_config_url (str): webBasedConfigURL *Optional* - is_video_capable (bool): isVideoCapable - pbx_integration (bool): PBXIntegration - use_business_trunking_contact (bool): useBusinessTrunkingContact - static_registration_capable (bool): staticRegistrationCapable - cpe_device_options (OCI.cpeDeviceOptions): cpeDeviceOptions *Optional* + device_type (str): deviceType + number_of_ports (OCI.numberOfPorts): numberOfPorts + profile (str): profile + registration_capable (bool): registrationCapable + is_conference_device (bool): isConferenceDevice + is_music_on_hold_device (bool): isMusicOnHoldDevice + authentication_override (bool): authenticationOverride + rfc3264_hold (bool): RFC3264Hold + is_trusted (bool): isTrusted + e164_capable (bool): E164Capable + route_advance (bool): routeAdvance + forwarding_override (bool): forwardingOverride + wireless_integration (bool): wirelessIntegration + web_based_config_url (str): webBasedConfigURL *Optional* + is_video_capable (bool): isVideoCapable + pbx_integration (bool): PBXIntegration + use_business_trunking_contact (bool): useBusinessTrunkingContact + static_registration_capable (bool): staticRegistrationCapable + cpe_device_options (OCI.cpeDeviceOptions): cpeDeviceOptions *Optional* """ __slots__: List[str] = [ @@ -104256,81 +97823,6 @@ def _elements(cls) -> Tuple[E, ...]: ) -class SystemSIPDeviceTypeGetListRequest(OCIRequest): - """ - Request to get the list of sip device types in the system. - - If includeSystemLevel is specified, all system level device types and the reseller - device types matching search criteria are returned even when searchCriteriaResellerId - is specified. If reseller administrator sends the request, searchCriteriaResellerId - is ignored. All system level device types and the device types in the administrator's - reseller meeting the search criteria are returned. See Also: - `SystemDeviceTypeGetAvailableListRequest22()` in AS data mode, - `SystemDeviceTypeGetAvailableListRequest19()` in XS data mode. - - The response is either `SystemSIPDeviceTypeGetListResponse()` or `ErrorResponse()`. - The following data elements are only used in AS data mode and ignored in XS data mode: - searchCriteriaExactDeviceTypeConfigurationOptionType - - Attributes: - response_size_limit (int): responseSizeLimit *Optional* - search_criteria_device_type (List[OCI.searchCriteriaDeviceType]): - searchCriteriaDeviceType *Optional* - search_criteria_exact_signaling_address_type - (OCI.searchCriteriaExactSignalingAddressType): - searchCriteriaExactSignalingAddressType *Optional* - search_criteria_reseller_id (List[OCI.searchCriteriaResellerId]): - searchCriteriaResellerId *Optional* - search_criteria_device_configuration_options - (List[OCI.searchCriteriaDeviceConfigurationOptions]): - searchCriteriaDeviceConfigurationOptions *Optional* - include_system_level (bool): includeSystemLevel *Optional* - """ - - __slots__: List[str] = [ - "response_size_limit", - "search_criteria_device_type", - "search_criteria_exact_signaling_address_type", - "search_criteria_reseller_id", - "search_criteria_device_configuration_options", - "include_system_level", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("response_size_limit", "responseSizeLimit", int), - E( - "search_criteria_device_type", - "searchCriteriaDeviceType", - OCI.SearchCriteriaDeviceType, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_exact_signaling_address_type", - "searchCriteriaExactSignalingAddressType", - OCI.SearchCriteriaExactSignalingAddressType, - is_complex=True, - ), - E( - "search_criteria_reseller_id", - "searchCriteriaResellerId", - OCI.SearchCriteriaResellerId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_device_configuration_options", - "searchCriteriaDeviceConfigurationOptions", - OCI.SearchCriteriaExactDeviceTypeConfigurationOptionType, - is_complex=True, - is_array=True, - ), - E("include_system_level", "includeSystemLevel", bool), - ) - - class SystemSIPDeviceTypeLanguageMappingModifyRequest(OCIRequest): """ Request to modify the device language name that is mapped to a BroadWorks language @@ -104649,160 +98141,6 @@ def _elements(cls) -> Tuple[E, ...]: ) -class SystemSecurityClassificationGetClassificationTrunkGroupUsageListRequest( - OCIRequest, -): - """ - Get a list of users that currently have the specified Security Classification - assigned. - - The response is either - `SystemSecurityClassificationGetClassificationTrunkGroupUsageListResponse()` or - `ErrorResponse()`. - - Attributes: - security_classification (str): securityClassification - response_size_limit (int): responseSizeLimit *Optional* - search_criteria_trunk_group_name (List[OCI.searchCriteriaTrunkGroupName]): - searchCriteriaTrunkGroupName *Optional* - search_criteria_group_id (List[OCI.searchCriteriaGroupId]): searchCriteriaGroupId - *Optional* - search_criteria_service_provider_id (List[OCI.searchCriteriaServiceProviderId]): - searchCriteriaServiceProviderId *Optional* - search_criteria_exact_organization_type (OCI.searchCriteriaExactOrganizationType): - searchCriteriaExactOrganizationType *Optional* - """ - - __slots__: List[str] = [ - "security_classification", - "response_size_limit", - "search_criteria_trunk_group_name", - "search_criteria_group_id", - "search_criteria_service_provider_id", - "search_criteria_exact_organization_type", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E( - "security_classification", - "securityClassification", - str, - is_required=True, - ), - E("response_size_limit", "responseSizeLimit", int), - E( - "search_criteria_trunk_group_name", - "searchCriteriaTrunkGroupName", - OCI.SearchCriteriaTrunkGroupName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_group_id", - "searchCriteriaGroupId", - OCI.SearchCriteriaGroupId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_service_provider_id", - "searchCriteriaServiceProviderId", - OCI.SearchCriteriaServiceProviderId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_exact_organization_type", - "searchCriteriaExactOrganizationType", - OCI.SearchCriteriaExactOrganizationType, - is_complex=True, - ), - ) - - -class SystemSecurityClassificationGetClassificationUserUsageListRequest(OCIRequest): - """ - Get a list of users that currently have the specified Security Classification - assigned. - - The response is either - `SystemSecurityClassificationGetClassificationUserUsageListResponse()` or - `ErrorResponse()`. - - Attributes: - security_classification (str): securityClassification - response_size_limit (int): responseSizeLimit *Optional* - search_criteria_user_id (List[OCI.searchCriteriaUserId]): searchCriteriaUserId - *Optional* - search_criteria_user_last_name (List[OCI.searchCriteriaUserLastName]): - searchCriteriaUserLastName *Optional* - search_criteria_user_first_name (List[OCI.searchCriteriaUserFirstName]): - searchCriteriaUserFirstName *Optional* - search_criteria_dn (List[OCI.searchCriteriaDn]): searchCriteriaDn *Optional* - search_criteria_extension (List[OCI.searchCriteriaExtension]): - searchCriteriaExtension *Optional* - """ - - __slots__: List[str] = [ - "security_classification", - "response_size_limit", - "search_criteria_user_id", - "search_criteria_user_last_name", - "search_criteria_user_first_name", - "search_criteria_dn", - "search_criteria_extension", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E( - "security_classification", - "securityClassification", - str, - is_required=True, - ), - E("response_size_limit", "responseSizeLimit", int), - E( - "search_criteria_user_id", - "searchCriteriaUserId", - OCI.SearchCriteriaUserId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_last_name", - "searchCriteriaUserLastName", - OCI.SearchCriteriaUserLastName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_first_name", - "searchCriteriaUserFirstName", - OCI.SearchCriteriaUserFirstName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_dn", - "searchCriteriaDn", - OCI.SearchCriteriaDn, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_extension", - "searchCriteriaExtension", - OCI.SearchCriteriaExtension, - is_complex=True, - is_array=True, - ), - ) - - class SystemSecurityClassificationModifyClassificationRequest(OCIRequest): """ Modify a Security Classification The response is either a `SuccessResponse()` or an @@ -104867,51 +98205,6 @@ def _elements(cls) -> Tuple[E, ...]: ) -class SystemServiceCodeGetListRequest(OCIRequest): - """ - Request to get all service codes that have been defined in the system. - - It is possible to search by various criteria to restrict the number of rows returned. - Multiple search criteria are logically ANDed together. - - The response is either `SystemServiceCodeGetListResponse()` or `ErrorResponse()`. - - Attributes: - response_size_limit (int): responseSizeLimit *Optional* - search_criteria_service_code (List[OCI.searchCriteriaServiceCode]): - searchCriteriaServiceCode *Optional* - search_criteria_service_code_description - (List[OCI.searchCriteriaServiceCodeDescription]): - searchCriteriaServiceCodeDescription *Optional* - """ - - __slots__: List[str] = [ - "response_size_limit", - "search_criteria_service_code", - "search_criteria_service_code_description", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("response_size_limit", "responseSizeLimit", int), - E( - "search_criteria_service_code", - "searchCriteriaServiceCode", - OCI.SearchCriteriaServiceCode, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_service_code_description", - "searchCriteriaServiceCodeDescription", - OCI.SearchCriteriaServiceCodeDescription, - is_complex=True, - is_array=True, - ), - ) - - class SystemSystemServiceDnAddListRequest(OCIRequest): """ Adds system service Dns. @@ -105268,38 +98561,6 @@ def _elements(cls) -> Tuple[E, ...]: ) -class SystemThirdPartyVoiceMailSupportGetDnListRequest(OCIRequest): - """ - Request to get a list of ThirdPartyVoiceMailSupport User DN's defined in the system. - - The response is either a `SystemThirdPartyVoiceMailSupportGetDnListResponse()` or an - `ErrorResponse()`. The search can be done using multiple criterion. - - Attributes: - response_size_limit (int): responseSizeLimit *Optional* - search_criteria_system_service_dn (List[OCI.searchCriteriaSystemServiceDn]): - searchCriteriaSystemServiceDn *Optional* - """ - - __slots__: List[str] = [ - "response_size_limit", - "search_criteria_system_service_dn", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("response_size_limit", "responseSizeLimit", int), - E( - "search_criteria_system_service_dn", - "searchCriteriaSystemServiceDn", - OCI.SearchCriteriaSystemServiceDn, - is_complex=True, - is_array=True, - ), - ) - - class SystemTimeScheduleAddRequest(OCIRequest): """ Add a system time schedule. @@ -105465,38 +98726,6 @@ def _elements(cls) -> Tuple[E, ...]: ) -class SystemTwoStageDialingGetDnListRequest(OCIRequest): - """ - Request to get a list of Two Stage Dialing dns defined in the system. - - The response is either a `SystemTwoStageDialingGetDnListResponse()` or an - `ErrorResponse()`. - - Attributes: - response_size_limit (int): responseSizeLimit *Optional* - search_criteria_system_service_dn (List[OCI.searchCriteriaSystemServiceDn]): - searchCriteriaSystemServiceDn *Optional* - """ - - __slots__: List[str] = [ - "response_size_limit", - "search_criteria_system_service_dn", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("response_size_limit", "responseSizeLimit", int), - E( - "search_criteria_system_service_dn", - "searchCriteriaSystemServiceDn", - OCI.SearchCriteriaSystemServiceDn, - is_complex=True, - is_array=True, - ), - ) - - class SystemXsiApplicationIdAddListRequest(OCIRequest): """ Add the system Xsi application Id entries. @@ -105552,78 +98781,6 @@ def _elements(cls) -> Tuple[E, ...]: ) -class SystemXsiPolicyProfileGetAssignedServiceProviderListRequest(OCIRequest): - """ - Get usage of specific policy profile. - - The response is either a - `SystemXsiPolicyProfileGetAssignedServiceProviderListResponse()` or an - `ErrorResponse()`. - - Attributes: - xsi_policy_profile (OCI.xsiPolicyProfile): xsiPolicyProfile - response_size_limit (int): responseSizeLimit *Optional* - search_criteria_service_provider_id (List[OCI.searchCriteriaServiceProviderId]): - searchCriteriaServiceProviderId *Optional* - search_criteria_service_provider_name - (List[OCI.searchCriteriaServiceProviderName]): - searchCriteriaServiceProviderName *Optional* - search_criteria_exact_organization_type (OCI.searchCriteriaExactOrganizationType): - searchCriteriaExactOrganizationType *Optional* - search_criteria_reseller_id (List[OCI.searchCriteriaResellerId]): - searchCriteriaResellerId *Optional* - """ - - __slots__: List[str] = [ - "xsi_policy_profile", - "response_size_limit", - "search_criteria_service_provider_id", - "search_criteria_service_provider_name", - "search_criteria_exact_organization_type", - "search_criteria_reseller_id", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E( - "xsi_policy_profile", - "xsiPolicyProfile", - OCI.XsiPolicyProfileKey, - is_complex=True, - is_required=True, - ), - E("response_size_limit", "responseSizeLimit", int), - E( - "search_criteria_service_provider_id", - "searchCriteriaServiceProviderId", - OCI.SearchCriteriaServiceProviderId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_service_provider_name", - "searchCriteriaServiceProviderName", - OCI.SearchCriteriaServiceProviderName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_exact_organization_type", - "searchCriteriaExactOrganizationType", - OCI.SearchCriteriaExactOrganizationType, - is_complex=True, - ), - E( - "search_criteria_reseller_id", - "searchCriteriaResellerId", - OCI.SearchCriteriaResellerId, - is_complex=True, - is_array=True, - ), - ) - - class SystemXsiPolicyProfileGetRequest(OCIRequest): """ Get an existing Xsi policy profile. @@ -105801,286 +98958,182 @@ def _elements(cls) -> Tuple[E, ...]: ) -class SystemZoneCallingRestrictionsNetAddressGetListRequest(OCIRequest): +class SystemZoneNetAddressAddListRequest(OCIRequest): """ - Gets a list of IP Addresses and/or Ranges assigned to a zone Response is - `SystemZoneCallingRestrictionsNetAddressGetListResponse()`. + Adds a list of IP addresses to a zone The response is `SuccessResponse()` or an + `ErrorResponse()`. - Replaced by: `SystemZoneNetAddressGetListRequest()` Attributes: zone_name (str): zoneName - response_size_limit (int): responseSizeLimit *Optional* - search_criteria_zone_ip_address (List[OCI.searchCriteriaZoneIPAddress]): - searchCriteriaZoneIPAddress *Optional* + net_address (List[str]): netAddress *Optional* + net_address_range (List[OCI.netAddressRange]): netAddressRange *Optional* """ __slots__: List[str] = [ "zone_name", - "response_size_limit", - "search_criteria_zone_ip_address", + "net_address", + "net_address_range", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( E("zone_name", "zoneName", str, is_required=True), - E("response_size_limit", "responseSizeLimit", int), + E("net_address", "netAddress", str, is_array=True), E( - "search_criteria_zone_ip_address", - "searchCriteriaZoneIPAddress", - OCI.SearchCriteriaZoneIPAddress, + "net_address_range", + "netAddressRange", + OCI.IPAddressRange, is_complex=True, is_array=True, ), ) -class SystemZoneLocationBasedPhysicalLocationGetListRequest(OCIRequest): +class SystemZoneNetAddressDeleteListRequest(OCIRequest): """ - Gets a list of physical locations assigned to a zone. - - Response is `SystemZoneLocationBasedPhysicalLocationGetListResponse()` or an + Deletes a list of IP addresses from a zone The response is `SuccessResponse()` or an `ErrorResponse()`. + Attributes: zone_name (str): zoneName - response_size_limit (int): responseSizeLimit *Optional* - search_criteria_physical_location (List[OCI.searchCriteriaPhysicalLocation]): - searchCriteriaPhysicalLocation *Optional* + net_address (List[str]): netAddress *Optional* + net_address_range (List[OCI.netAddressRange]): netAddressRange *Optional* """ __slots__: List[str] = [ "zone_name", - "response_size_limit", - "search_criteria_physical_location", + "net_address", + "net_address_range", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( E("zone_name", "zoneName", str, is_required=True), - E("response_size_limit", "responseSizeLimit", int), + E("net_address", "netAddress", str, is_array=True), E( - "search_criteria_physical_location", - "searchCriteriaPhysicalLocation", - OCI.SearchCriteriaPhysicalLocation, + "net_address_range", + "netAddressRange", + OCI.IPAddressRange, is_complex=True, is_array=True, ), ) -class SystemZoneNetAddressAddListRequest(OCIRequest): +class UserAccessDeviceFileGetListRequest(OCIRequest): """ - Adds a list of IP addresses to a zone The response is `SuccessResponse()` or an - `ErrorResponse()`. + Request to get the list of Device Management user modifiable files. + The response is either `UserAccessDeviceFileGetListResponse()` or `ErrorResponse()`. Attributes: - zone_name (str): zoneName - net_address (List[str]): netAddress *Optional* - net_address_range (List[OCI.netAddressRange]): netAddressRange *Optional* + user_id (str): userId + access_device (OCI.accessDevice): accessDevice """ __slots__: List[str] = [ - "zone_name", - "net_address", - "net_address_range", + "user_id", + "access_device", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("zone_name", "zoneName", str, is_required=True), - E("net_address", "netAddress", str, is_array=True), + E("user_id", "userId", str, is_required=True), E( - "net_address_range", - "netAddressRange", - OCI.IPAddressRange, + "access_device", + "accessDevice", + OCI.AccessDevice, is_complex=True, - is_array=True, + is_required=True, ), ) -class SystemZoneNetAddressDeleteListRequest(OCIRequest): +class UserAccessDeviceFileGetRequest(OCIRequest): """ - Deletes a list of IP addresses from a zone The response is `SuccessResponse()` or an - `ErrorResponse()`. + Request to get a user modifiable file. + The response is either `UserAccessDeviceFileGetResponse()` or `ErrorResponse()`. Attributes: - zone_name (str): zoneName - net_address (List[str]): netAddress *Optional* - net_address_range (List[OCI.netAddressRange]): netAddressRange *Optional* + user_id (str): userId + access_device (OCI.accessDevice): accessDevice + file_format (str): fileFormat """ __slots__: List[str] = [ - "zone_name", - "net_address", - "net_address_range", + "user_id", + "access_device", + "file_format", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("zone_name", "zoneName", str, is_required=True), - E("net_address", "netAddress", str, is_array=True), + E("user_id", "userId", str, is_required=True), E( - "net_address_range", - "netAddressRange", - OCI.IPAddressRange, + "access_device", + "accessDevice", + OCI.AccessDevice, is_complex=True, - is_array=True, + is_required=True, ), + E("file_format", "fileFormat", str, is_required=True), ) -class SystemZoneNetAddressGetListRequest(OCIRequest): +class UserAccessDeviceFileModifyRequest(OCIRequest): """ - Gets a list of IP Addresses and/or Ranges assigned to a zone. + Request to modify a user modifiable access device file. - Response is `SystemZoneNetAddressGetListResponse()` or an `ErrorResponse()`. + The response is either a `SuccessResponse()` or an `ErrorResponse()`. Attributes: - zone_name (str): zoneName - response_size_limit (int): responseSizeLimit *Optional* - search_criteria_zone_ip_address (List[OCI.searchCriteriaZoneIPAddress]): - searchCriteriaZoneIPAddress *Optional* + user_id (str): userId + access_device (OCI.accessDevice): accessDevice + file_format (str): fileFormat + upload_file (OCI.uploadFile): uploadFile """ __slots__: List[str] = [ - "zone_name", - "response_size_limit", - "search_criteria_zone_ip_address", + "user_id", + "access_device", + "file_format", + "upload_file", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("zone_name", "zoneName", str, is_required=True), - E("response_size_limit", "responseSizeLimit", int), + E("user_id", "userId", str, is_required=True), E( - "search_criteria_zone_ip_address", - "searchCriteriaZoneIPAddress", - OCI.SearchCriteriaZoneIPAddress, + "access_device", + "accessDevice", + OCI.AccessDevice, is_complex=True, - is_array=True, + is_required=True, + ), + E("file_format", "fileFormat", str, is_required=True), + E( + "upload_file", + "uploadFile", + OCI.FileResource, + is_complex=True, + is_required=True, ), ) -class UserAccessDeviceFileGetListRequest(OCIRequest): +class UserAccessDeviceResetRequest(OCIRequest): """ - Request to get the list of Device Management user modifiable files. + Reset a specific user SIP device that supports the reset operation. - The response is either `UserAccessDeviceFileGetListResponse()` or `ErrorResponse()`. - - Attributes: - user_id (str): userId - access_device (OCI.accessDevice): accessDevice - """ - - __slots__: List[str] = [ - "user_id", - "access_device", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("user_id", "userId", str, is_required=True), - E( - "access_device", - "accessDevice", - OCI.AccessDevice, - is_complex=True, - is_required=True, - ), - ) - - -class UserAccessDeviceFileGetRequest(OCIRequest): - """ - Request to get a user modifiable file. - - The response is either `UserAccessDeviceFileGetResponse()` or `ErrorResponse()`. - - Attributes: - user_id (str): userId - access_device (OCI.accessDevice): accessDevice - file_format (str): fileFormat - """ - - __slots__: List[str] = [ - "user_id", - "access_device", - "file_format", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("user_id", "userId", str, is_required=True), - E( - "access_device", - "accessDevice", - OCI.AccessDevice, - is_complex=True, - is_required=True, - ), - E("file_format", "fileFormat", str, is_required=True), - ) - - -class UserAccessDeviceFileModifyRequest(OCIRequest): - """ - Request to modify a user modifiable access device file. - - The response is either a `SuccessResponse()` or an `ErrorResponse()`. - - Attributes: - user_id (str): userId - access_device (OCI.accessDevice): accessDevice - file_format (str): fileFormat - upload_file (OCI.uploadFile): uploadFile - """ - - __slots__: List[str] = [ - "user_id", - "access_device", - "file_format", - "upload_file", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("user_id", "userId", str, is_required=True), - E( - "access_device", - "accessDevice", - OCI.AccessDevice, - is_complex=True, - is_required=True, - ), - E("file_format", "fileFormat", str, is_required=True), - E( - "upload_file", - "uploadFile", - OCI.FileResource, - is_complex=True, - is_required=True, - ), - ) - - -class UserAccessDeviceResetRequest(OCIRequest): - """ - Reset a specific user SIP device that supports the reset operation. - - The response is either a `SuccessResponse()` or an `ErrorResponse()`. + The response is either a `SuccessResponse()` or an `ErrorResponse()`. Attributes: user_id (str): userId @@ -106323,144 +99376,6 @@ def _elements(cls) -> Tuple[E, ...]: ) -class UserAnnouncementFileGetListRequest(OCIRequest): - """ - Get the list of announcement names with associated media type and filesize for a User - and given Announcement Repository Type The response is either a - `UserAnnouncementFileGetListResponse()` or an `ErrorResponse()`. - - - Attributes: - user_id (str): userId - announcement_file_type (str): announcementFileType *Optional* - include_announcement_table (bool): includeAnnouncementTable - response_size_limit (int): responseSizeLimit *Optional* - search_criteria_announcement_file_name - (List[OCI.searchCriteriaAnnouncementFileName]): - searchCriteriaAnnouncementFileName *Optional* - """ - - __slots__: List[str] = [ - "user_id", - "announcement_file_type", - "include_announcement_table", - "response_size_limit", - "search_criteria_announcement_file_name", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("user_id", "userId", str, is_required=True), - E("announcement_file_type", "announcementFileType", str), - E( - "include_announcement_table", - "includeAnnouncementTable", - bool, - is_required=True, - ), - E("response_size_limit", "responseSizeLimit", int), - E( - "search_criteria_announcement_file_name", - "searchCriteriaAnnouncementFileName", - OCI.SearchCriteriaAnnouncementFileName, - is_complex=True, - is_array=True, - ), - ) - - -class UserAnnouncementFileGetPagedSortedListRequest(OCIRequest): - """ - Get the list of announcement files for a user. - - If the responsePagingControl element is not provided, the paging startIndex will be - set to 1 by default, and the responsePageSize will be set to the maximum - responsePageSize by default. If no sortOrder is provided, the response is sorted by - Name ascending by default. Multiple search criteria are logically ANDed together - unless the searchCriteriaModeOr option is included. Then the search criteria are - logically ORed together. - - The response is either a `UserAnnouncementFileGetPagedSortedListResponse()` or an - `ErrorResponse()`. - - Attributes: - user_id (str): userId - response_paging_control (OCI.responsePagingControl): responsePagingControl - *Optional* - sort_by_announcement_file_name (OCI.sortByAnnouncementFileName): - sortByAnnouncementFileName *Optional* - sort_by_announcement_file_size (OCI.sortByAnnouncementFileSize): - sortByAnnouncementFileSize *Optional* - search_criteria_announcement_file_name - (List[OCI.searchCriteriaAnnouncementFileName]): - searchCriteriaAnnouncementFileName *Optional* - search_criteria_exact_announcement_file_type - (OCI.searchCriteriaExactAnnouncementFileType): - searchCriteriaExactAnnouncementFileType *Optional* - search_criteria_exact_media_file_type - (List[OCI.searchCriteriaExactMediaFileType]): searchCriteriaExactMediaFileType - *Optional* - search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* - """ - - __slots__: List[str] = [ - "user_id", - "response_paging_control", - "sort_by_announcement_file_name", - "sort_by_announcement_file_size", - "search_criteria_announcement_file_name", - "search_criteria_exact_announcement_file_type", - "search_criteria_exact_media_file_type", - "search_criteria_mode_or", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("user_id", "userId", str, is_required=True), - E( - "response_paging_control", - "responsePagingControl", - OCI.ResponsePagingControl, - is_complex=True, - ), - E( - "sort_by_announcement_file_name", - "sortByAnnouncementFileName", - OCI.SortByAnnouncementFileName, - is_complex=True, - ), - E( - "sort_by_announcement_file_size", - "sortByAnnouncementFileSize", - OCI.SortByAnnouncementFileSize, - is_complex=True, - ), - E( - "search_criteria_announcement_file_name", - "searchCriteriaAnnouncementFileName", - OCI.SearchCriteriaAnnouncementFileName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_exact_announcement_file_type", - "searchCriteriaExactAnnouncementFileType", - OCI.SearchCriteriaExactAnnouncementFileType, - is_complex=True, - ), - E( - "search_criteria_exact_media_file_type", - "searchCriteriaExactMediaFileType", - OCI.SearchCriteriaExactMediaFileType, - is_complex=True, - is_array=True, - ), - E("search_criteria_mode_or", "searchCriteriaModeOr", bool), - ) - - class UserAnnouncementFileGetRequest(OCIRequest): """ Request to get the announcement repository file information. @@ -106677,71 +99592,6 @@ def _elements(cls) -> Tuple[E, ...]: ) -class UserBroadWorksAnywhereGetPhoneNumberPagedSortedListRequest(OCIRequest): - """ - Get the list of all the BroadWorks Anywhere phone numbers for the user. - - If no sortOrder is included the response is sorted by Phone Number ascending by - default. - - The response is either a - `UserBroadWorksAnywhereGetPhoneNumberPagedSortedListResponse()` or an - `ErrorResponse()`. - - Attributes: - user_id (str): userId - response_paging_control (OCI.responsePagingControl): responsePagingControl - *Optional* - sort_by_location (OCI.sortByLocation): sortByLocation *Optional* - sort_by_enabled (OCI.sortByEnabled): sortByEnabled *Optional* - search_criteria_location (List[OCI.searchCriteriaLocation]): - searchCriteriaLocation *Optional* - search_criteria_exact_location_enabled (OCI.searchCriteriaExactLocationEnabled): - searchCriteriaExactLocationEnabled *Optional* - """ - - __slots__: List[str] = [ - "user_id", - "response_paging_control", - "sort_by_location", - "sort_by_enabled", - "search_criteria_location", - "search_criteria_exact_location_enabled", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("user_id", "userId", str, is_required=True), - E( - "response_paging_control", - "responsePagingControl", - OCI.ResponsePagingControl, - is_complex=True, - ), - E( - "sort_by_location", - "sortByLocation", - OCI.SortByLocation, - is_complex=True, - ), - E("sort_by_enabled", "sortByEnabled", OCI.SortByEnabled, is_complex=True), - E( - "search_criteria_location", - "searchCriteriaLocation", - OCI.SearchCriteriaLocation, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_exact_location_enabled", - "searchCriteriaExactLocationEnabled", - OCI.SearchCriteriaExactLocationEnabled, - is_complex=True, - ), - ) - - class UserBroadWorksAnywhereModifyPhoneNumberRequest(OCIRequest): """ Modify a BroadWorks Anywhere phone number The response is either a `SuccessResponse()` @@ -107063,64 +99913,6 @@ def _elements(cls) -> Tuple[E, ...]: ) -class UserCallCenterGetAvailableCallCenterPagedSortedListRequest(OCIRequest): - """ - This request gets a list of all call centers which the user can be assigned to as an - agent. - - Some of the call centers may already have the user as an agent. It is the clients - responsibility to discard the call centers that the user is already an agent of. If - the responsePagingControl element is not provided, the paging startIndex will be set - to 1 by default, and the responsePageSize will be set to the maximum ResponsePageSize - by default. It is possible to search by various criteria to restrict the number of - rows returned. Multiple search criteria are logically ANDed together unless the - searchCriteriaModeOr option is included. Then the search criteria are logically ORed - together. - - The response is either a - `UserCallCenterGetAvailableCallCenterPagedSortedListResponse()` or an - `ErrorResponse()`. - - Attributes: - user_id (str): userId - response_paging_control (OCI.responsePagingControl): responsePagingControl - *Optional* - sort_by_user_id (OCI.sortByUserId): sortByUserId *Optional* - search_criteria_user_id (List[OCI.searchCriteriaUserId]): searchCriteriaUserId - *Optional* - search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* - """ - - __slots__: List[str] = [ - "user_id", - "response_paging_control", - "sort_by_user_id", - "search_criteria_user_id", - "search_criteria_mode_or", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("user_id", "userId", str, is_required=True), - E( - "response_paging_control", - "responsePagingControl", - OCI.ResponsePagingControl, - is_complex=True, - ), - E("sort_by_user_id", "sortByUserId", OCI.SortByUserId, is_complex=True), - E( - "search_criteria_user_id", - "searchCriteriaUserId", - OCI.SearchCriteriaUserId, - is_complex=True, - is_array=True, - ), - E("search_criteria_mode_or", "searchCriteriaModeOr", bool), - ) - - class UserCallCenterModifyAvailabilityListRequest(OCIRequest): """ Request for an agent to login or logout of one or more Call Centers. @@ -108225,100 +101017,6 @@ def _elements(cls) -> Tuple[E, ...]: ) -class UserEnterpriseCommonPhoneListGetPagedSortedListRequest(OCIRequest): - """ - Get an enterprise's common phone list for a user. - - The response is either a `UserEnterpriseCommonPhoneListGetPagedSortedListResponse()` - or an `ErrorResponse()`. The search can be done using multiple criterion. If the - searchCriteriaModeOr is present, any result matching any one criteria is included in - the results. Otherwise, only results matching all the search criterion are included - in the results. If no search criteria is specified, all results are returned. - Specifying searchCriteriaModeOr without any search criteria results in an - `ErrorResponse()`. The sort can be done on the name or the number in the common phone - list. The following elements are only used in AS data mode and ignored in XS data - mode: searchCriteriaEnterpriseCommonMultiPartPhoneListName - - Attributes: - user_id (str): userId - response_paging_control (OCI.responsePagingControl): responsePagingControl - sort_by_enterprise_common_phone_list_number - (OCI.sortByEnterpriseCommonPhoneListNumber): - sortByEnterpriseCommonPhoneListNumber *Optional* - sort_by_enterprise_common_phone_list_name - (OCI.sortByEnterpriseCommonPhoneListName): sortByEnterpriseCommonPhoneListName - *Optional* - search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* - search_criteria_enterprise_common_phone_list_name - (List[OCI.searchCriteriaEnterpriseCommonPhoneListName]): - searchCriteriaEnterpriseCommonPhoneListName *Optional* - search_criteria_enterprise_common_phone_list_number - (List[OCI.searchCriteriaEnterpriseCommonPhoneListNumber]): - searchCriteriaEnterpriseCommonPhoneListNumber *Optional* - search_criteria_enterprise_common_multi_part_phone_list_name - (List[OCI.searchCriteriaEnterpriseCommonMultiPartPhoneListName]): - searchCriteriaEnterpriseCommonMultiPartPhoneListName *Optional* - """ - - __slots__: List[str] = [ - "user_id", - "response_paging_control", - "sort_by_enterprise_common_phone_list_number", - "sort_by_enterprise_common_phone_list_name", - "search_criteria_mode_or", - "search_criteria_enterprise_common_phone_list_name", - "search_criteria_enterprise_common_phone_list_number", - "search_criteria_enterprise_common_multi_part_phone_list_name", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("user_id", "userId", str, is_required=True), - E( - "response_paging_control", - "responsePagingControl", - OCI.ResponsePagingControl, - is_complex=True, - is_required=True, - ), - E( - "sort_by_enterprise_common_phone_list_number", - "sortByEnterpriseCommonPhoneListNumber", - OCI.SortByEnterpriseCommonPhoneListNumber, - is_complex=True, - ), - E( - "sort_by_enterprise_common_phone_list_name", - "sortByEnterpriseCommonPhoneListName", - OCI.SortByEnterpriseCommonPhoneListName, - is_complex=True, - ), - E("search_criteria_mode_or", "searchCriteriaModeOr", bool), - E( - "search_criteria_enterprise_common_phone_list_name", - "searchCriteriaEnterpriseCommonPhoneListName", - OCI.SearchCriteriaEnterpriseCommonPhoneListName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_enterprise_common_phone_list_number", - "searchCriteriaEnterpriseCommonPhoneListNumber", - OCI.SearchCriteriaEnterpriseCommonPhoneListNumber, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_enterprise_common_multi_part_phone_list_name", - "searchCriteriaEnterpriseCommonMultiPartPhoneListName", - OCI.SearchCriteriaEnterpriseCommonMultiPartPhoneListName, - is_complex=True, - is_array=True, - ), - ) - - class UserExecutiveAddFilteringSelectiveCriteriaRequest(OCIRequest): """ Add a filtering criteria to an executive user. @@ -108557,535 +101255,6 @@ def _elements(cls) -> Tuple[E, ...]: ) -class UserGetListInSystemRequest(OCIRequest): - """ - Request the list of users in the system. - - It is possible to search by various criteria to restrict the number of rows returned. - Multiple search criteria are logically ANDed together. If reseller administrator - sends the request, searchCriteriaResellerId is ignored. All the users in the - administrator's reseller meeting the search criteria are returned. - - The response is either a `UserGetListInSystemResponse()` or an `ErrorResponse()`. The - following data elements are only used in AS data mode: searchCriteriaResellerId - - Attributes: - response_size_limit (int): responseSizeLimit *Optional* - search_criteria_user_last_name (List[OCI.searchCriteriaUserLastName]): - searchCriteriaUserLastName *Optional* - search_criteria_user_first_name (List[OCI.searchCriteriaUserFirstName]): - searchCriteriaUserFirstName *Optional* - search_criteria_dn (List[OCI.searchCriteriaDn]): searchCriteriaDn *Optional* - search_criteria_email_address (List[OCI.searchCriteriaEmailAddress]): - searchCriteriaEmailAddress *Optional* - search_criteria_group_id (List[OCI.searchCriteriaGroupId]): searchCriteriaGroupId - *Optional* - search_criteria_exact_service_provider (OCI.searchCriteriaExactServiceProvider): - searchCriteriaExactServiceProvider *Optional* - search_criteria_service_provider_id (List[OCI.searchCriteriaServiceProviderId]): - searchCriteriaServiceProviderId *Optional* - search_criteria_exact_user_in_trunk_group - (OCI.searchCriteriaExactUserInTrunkGroup): searchCriteriaExactUserInTrunkGroup - *Optional* - search_criteria_exact_user_network_class_of_service - (OCI.searchCriteriaExactUserNetworkClassOfService): - searchCriteriaExactUserNetworkClassOfService *Optional* - search_criteria_user_id (List[OCI.searchCriteriaUserId]): searchCriteriaUserId - *Optional* - search_criteria_extension (List[OCI.searchCriteriaExtension]): - searchCriteriaExtension *Optional* - search_criteria_reseller_id (List[OCI.searchCriteriaResellerId]): - searchCriteriaResellerId *Optional* - """ - - __slots__: List[str] = [ - "response_size_limit", - "search_criteria_user_last_name", - "search_criteria_user_first_name", - "search_criteria_dn", - "search_criteria_email_address", - "search_criteria_group_id", - "search_criteria_exact_service_provider", - "search_criteria_service_provider_id", - "search_criteria_exact_user_in_trunk_group", - "search_criteria_exact_user_network_class_of_service", - "search_criteria_user_id", - "search_criteria_extension", - "search_criteria_reseller_id", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("response_size_limit", "responseSizeLimit", int), - E( - "search_criteria_user_last_name", - "searchCriteriaUserLastName", - OCI.SearchCriteriaUserLastName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_first_name", - "searchCriteriaUserFirstName", - OCI.SearchCriteriaUserFirstName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_dn", - "searchCriteriaDn", - OCI.SearchCriteriaDn, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_email_address", - "searchCriteriaEmailAddress", - OCI.SearchCriteriaEmailAddress, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_group_id", - "searchCriteriaGroupId", - OCI.SearchCriteriaGroupId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_exact_service_provider", - "searchCriteriaExactServiceProvider", - OCI.SearchCriteriaExactServiceProvider, - is_complex=True, - ), - E( - "search_criteria_service_provider_id", - "searchCriteriaServiceProviderId", - OCI.SearchCriteriaServiceProviderId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_exact_user_in_trunk_group", - "searchCriteriaExactUserInTrunkGroup", - OCI.SearchCriteriaExactUserInTrunkGroup, - is_complex=True, - ), - E( - "search_criteria_exact_user_network_class_of_service", - "searchCriteriaExactUserNetworkClassOfService", - OCI.SearchCriteriaExactUserNetworkClassOfService, - is_complex=True, - ), - E( - "search_criteria_user_id", - "searchCriteriaUserId", - OCI.SearchCriteriaUserId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_extension", - "searchCriteriaExtension", - OCI.SearchCriteriaExtension, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_reseller_id", - "searchCriteriaResellerId", - OCI.SearchCriteriaResellerId, - is_complex=True, - is_array=True, - ), - ) - - -class UserGetServiceInstanceListInSystemRequest(OCIRequest): - """ - Request the list of Service Instances in the system. - - It is possible to search by various criteria to restrict the number of rows returned. - Multiple search criteria are logically ANDed together. If reseller administrator - sends the request, searchCriteriaResellerId is ignored. All the service instances in - the administrator's reseller meeting the search criteria are returned. - - The response is either a `UserGetServiceInstanceListInSystemResponse()` or an - `ErrorResponse()`. The following data elements are only used in AS data mode: - searchCriteriaResellerId - - Attributes: - response_size_limit (int): responseSizeLimit *Optional* - search_criteria_exact_service_type (OCI.searchCriteriaExactServiceType): - searchCriteriaExactServiceType *Optional* - search_criteria_user_id (List[OCI.searchCriteriaUserId]): searchCriteriaUserId - *Optional* - search_criteria_user_last_name (List[OCI.searchCriteriaUserLastName]): - searchCriteriaUserLastName *Optional* - search_criteria_dn (List[OCI.searchCriteriaDn]): searchCriteriaDn *Optional* - search_criteria_extension (List[OCI.searchCriteriaExtension]): - searchCriteriaExtension *Optional* - search_criteria_group_id (List[OCI.searchCriteriaGroupId]): searchCriteriaGroupId - *Optional* - search_criteria_exact_service_provider (OCI.searchCriteriaExactServiceProvider): - searchCriteriaExactServiceProvider *Optional* - search_criteria_service_provider_id (List[OCI.searchCriteriaServiceProviderId]): - searchCriteriaServiceProviderId *Optional* - search_criteria_reseller_id (List[OCI.searchCriteriaResellerId]): - searchCriteriaResellerId *Optional* - """ - - __slots__: List[str] = [ - "response_size_limit", - "search_criteria_exact_service_type", - "search_criteria_user_id", - "search_criteria_user_last_name", - "search_criteria_dn", - "search_criteria_extension", - "search_criteria_group_id", - "search_criteria_exact_service_provider", - "search_criteria_service_provider_id", - "search_criteria_reseller_id", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("response_size_limit", "responseSizeLimit", int), - E( - "search_criteria_exact_service_type", - "searchCriteriaExactServiceType", - OCI.SearchCriteriaExactServiceType, - is_complex=True, - ), - E( - "search_criteria_user_id", - "searchCriteriaUserId", - OCI.SearchCriteriaUserId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_last_name", - "searchCriteriaUserLastName", - OCI.SearchCriteriaUserLastName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_dn", - "searchCriteriaDn", - OCI.SearchCriteriaDn, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_extension", - "searchCriteriaExtension", - OCI.SearchCriteriaExtension, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_group_id", - "searchCriteriaGroupId", - OCI.SearchCriteriaGroupId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_exact_service_provider", - "searchCriteriaExactServiceProvider", - OCI.SearchCriteriaExactServiceProvider, - is_complex=True, - ), - E( - "search_criteria_service_provider_id", - "searchCriteriaServiceProviderId", - OCI.SearchCriteriaServiceProviderId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_reseller_id", - "searchCriteriaResellerId", - OCI.SearchCriteriaResellerId, - is_complex=True, - is_array=True, - ), - ) - - -class UserGroupCommonPhoneListGetPagedSortedListRequest(OCIRequest): - """ - Get a user's group's common phone list. - - The response is either a `UserGroupCommonPhoneListGetPagedSortedListResponse()` or an - `ErrorResponse()`. The search can be done using multiple criterion. If the - searchCriteriaModeOr is present, any result matching any one criteria is included in - the results. Otherwise, only results matching all the search criterion are included - in the results. If no search criteria is specified, all results are returned. - Specifying searchCriteriaModeOr without any search criteria results in an - `ErrorResponse()`. The sort can be done on the name or the number in the common phone - list. The following elements are only used in AS data mode and ignored in XS data - mode: searchCriteriaGroupCommonMultiPartPhoneListName - - Attributes: - user_id (str): userId - response_paging_control (OCI.responsePagingControl): responsePagingControl - sort_by_group_common_phone_list_number (OCI.sortByGroupCommonPhoneListNumber): - sortByGroupCommonPhoneListNumber *Optional* - sort_by_group_common_phone_list_name (OCI.sortByGroupCommonPhoneListName): - sortByGroupCommonPhoneListName *Optional* - search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* - search_criteria_group_common_phone_list_name - (List[OCI.searchCriteriaGroupCommonPhoneListName]): - searchCriteriaGroupCommonPhoneListName *Optional* - search_criteria_group_common_phone_list_number - (List[OCI.searchCriteriaGroupCommonPhoneListNumber]): - searchCriteriaGroupCommonPhoneListNumber *Optional* - search_criteria_group_common_multi_part_phone_list_name - (List[OCI.searchCriteriaGroupCommonMultiPartPhoneListName]): - searchCriteriaGroupCommonMultiPartPhoneListName *Optional* - """ - - __slots__: List[str] = [ - "user_id", - "response_paging_control", - "sort_by_group_common_phone_list_number", - "sort_by_group_common_phone_list_name", - "search_criteria_mode_or", - "search_criteria_group_common_phone_list_name", - "search_criteria_group_common_phone_list_number", - "search_criteria_group_common_multi_part_phone_list_name", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("user_id", "userId", str, is_required=True), - E( - "response_paging_control", - "responsePagingControl", - OCI.ResponsePagingControl, - is_complex=True, - is_required=True, - ), - E( - "sort_by_group_common_phone_list_number", - "sortByGroupCommonPhoneListNumber", - OCI.SortByGroupCommonPhoneListNumber, - is_complex=True, - ), - E( - "sort_by_group_common_phone_list_name", - "sortByGroupCommonPhoneListName", - OCI.SortByGroupCommonPhoneListName, - is_complex=True, - ), - E("search_criteria_mode_or", "searchCriteriaModeOr", bool), - E( - "search_criteria_group_common_phone_list_name", - "searchCriteriaGroupCommonPhoneListName", - OCI.SearchCriteriaGroupCommonPhoneListName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_group_common_phone_list_number", - "searchCriteriaGroupCommonPhoneListNumber", - OCI.SearchCriteriaGroupCommonPhoneListNumber, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_group_common_multi_part_phone_list_name", - "searchCriteriaGroupCommonMultiPartPhoneListName", - OCI.SearchCriteriaGroupCommonMultiPartPhoneListName, - is_complex=True, - is_array=True, - ), - ) - - -class UserGroupCustomContactDirectoryGetPagedSortedListRequest(OCIRequest): - """ - Gets a Custom Contact Directory in a group. - - The response is either `UserGroupCustomContactDirectoryGetPagedSortedListResponse()` - or `ErrorResponse()`. The search can be done using multiple criterion. If the - searchCriteriaModeOr is present, any result matching any one criteria is included in - the results. Otherwise, only results matching all the search criterion are included - in the results. If no search criteria is specified, all results are returned. - Specifying searchCriteriaModeOr without any search criteria results in an - `ErrorResponse()`. The sort can be done on the user last name, first name, department, - or contact notes. The Receptionist Note column is only populated, if the user sending - the request is a the owner of this Receptionist Note and a Note exists. - - Attributes: - user_id (str): userId - name (str): name - response_paging_control (OCI.responsePagingControl): responsePagingControl - sort_by_user_last_name (OCI.sortByUserLastName): sortByUserLastName *Optional* - sort_by_user_first_name (OCI.sortByUserFirstName): sortByUserFirstName *Optional* - sort_by_user_department (OCI.sortByUserDepartment): sortByUserDepartment - *Optional* - sort_by_receptionist_note (OCI.sortByReceptionistNote): sortByReceptionistNote - *Optional* - search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* - search_criteria_user_last_name (List[OCI.searchCriteriaUserLastName]): - searchCriteriaUserLastName *Optional* - search_criteria_user_first_name (List[OCI.searchCriteriaUserFirstName]): - searchCriteriaUserFirstName *Optional* - search_criteria_dn (List[OCI.searchCriteriaDn]): searchCriteriaDn *Optional* - search_criteria_extension (List[OCI.searchCriteriaExtension]): - searchCriteriaExtension *Optional* - search_criteria_mobile_phone_number (List[OCI.searchCriteriaMobilePhoneNumber]): - searchCriteriaMobilePhoneNumber *Optional* - search_criteria_user_id (List[OCI.searchCriteriaUserId]): searchCriteriaUserId - *Optional* - search_criteria_department_name (List[OCI.searchCriteriaDepartmentName]): - searchCriteriaDepartmentName *Optional* - search_criteria_imp_id (List[OCI.searchCriteriaImpId]): searchCriteriaImpId - *Optional* - search_criteria_title (List[OCI.searchCriteriaTitle]): searchCriteriaTitle - *Optional* - search_criteria_receptionist_note (List[OCI.searchCriteriaReceptionistNote]): - searchCriteriaReceptionistNote *Optional* - """ - - __slots__: List[str] = [ - "user_id", - "name", - "response_paging_control", - "sort_by_user_last_name", - "sort_by_user_first_name", - "sort_by_user_department", - "sort_by_receptionist_note", - "search_criteria_mode_or", - "search_criteria_user_last_name", - "search_criteria_user_first_name", - "search_criteria_dn", - "search_criteria_extension", - "search_criteria_mobile_phone_number", - "search_criteria_user_id", - "search_criteria_department_name", - "search_criteria_imp_id", - "search_criteria_title", - "search_criteria_receptionist_note", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("user_id", "userId", str, is_required=True), - E("name", "name", str, is_required=True), - E( - "response_paging_control", - "responsePagingControl", - OCI.ResponsePagingControl, - is_complex=True, - is_required=True, - ), - E( - "sort_by_user_last_name", - "sortByUserLastName", - OCI.SortByUserLastName, - is_complex=True, - ), - E( - "sort_by_user_first_name", - "sortByUserFirstName", - OCI.SortByUserFirstName, - is_complex=True, - ), - E( - "sort_by_user_department", - "sortByUserDepartment", - OCI.SortByUserDepartment, - is_complex=True, - ), - E( - "sort_by_receptionist_note", - "sortByReceptionistNote", - OCI.SortByReceptionistNote, - is_complex=True, - ), - E("search_criteria_mode_or", "searchCriteriaModeOr", bool), - E( - "search_criteria_user_last_name", - "searchCriteriaUserLastName", - OCI.SearchCriteriaUserLastName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_first_name", - "searchCriteriaUserFirstName", - OCI.SearchCriteriaUserFirstName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_dn", - "searchCriteriaDn", - OCI.SearchCriteriaDn, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_extension", - "searchCriteriaExtension", - OCI.SearchCriteriaExtension, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_mobile_phone_number", - "searchCriteriaMobilePhoneNumber", - OCI.SearchCriteriaMobilePhoneNumber, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_id", - "searchCriteriaUserId", - OCI.SearchCriteriaUserId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_department_name", - "searchCriteriaDepartmentName", - OCI.SearchCriteriaDepartmentName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_imp_id", - "searchCriteriaImpId", - OCI.SearchCriteriaImpId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_title", - "searchCriteriaTitle", - OCI.SearchCriteriaTitle, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_receptionist_note", - "searchCriteriaReceptionistNote", - OCI.SearchCriteriaReceptionistNote, - is_complex=True, - is_array=True, - ), - ) - - class UserHolidayScheduleAddRequest(OCIRequest): """ Add a holiday schedule to a user. @@ -110864,53 +103033,6 @@ def _elements(cls) -> Tuple[E, ...]: ) -class UserPersonalAssistantExclusionNumberGetListRequest(OCIRequest): - """ - Request to get the User Personal Assistant Exclusion Number List information. - - The response is either a userPersonalAssistantExclusionNumberGetListResponse or an - `ErrorResponse()`. - - Attributes: - user_id (str): userId - search_criteria_personal_assistant_exclusion_number - (List[OCI.searchCriteriaPersonalAssistantExclusionNumber]): - searchCriteriaPersonalAssistantExclusionNumber *Optional* - search_criteria_personal_assistant_exclusion_number_description - (List[OCI.searchCriteriaPersonalAssistantExclusionNumberDescription]): - searchCriteriaPersonalAssistantExclusionNumberDescription *Optional* - response_size_limit (int): responseSizeLimit *Optional* - """ - - __slots__: List[str] = [ - "user_id", - "search_criteria_personal_assistant_exclusion_number", - "search_criteria_personal_assistant_exclusion_number_description", - "response_size_limit", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("user_id", "userId", str, is_required=True), - E( - "search_criteria_personal_assistant_exclusion_number", - "searchCriteriaPersonalAssistantExclusionNumber", - OCI.SearchCriteriaPersonalAssistantExclusionNumber, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_personal_assistant_exclusion_number_description", - "searchCriteriaPersonalAssistantExclusionNumberDescription", - OCI.SearchCriteriaPersonalAssistantExclusionNumberDescription, - is_complex=True, - is_array=True, - ), - E("response_size_limit", "responseSizeLimit", int), - ) - - class UserPersonalPhoneListAddListRequest(OCIRequest): """ Add one or more entries to a user's personal phone list. @@ -110942,401 +103064,6 @@ def _elements(cls) -> Tuple[E, ...]: ) -class UserPersonalPhoneListGetListRequest(OCIRequest): - """ - Get a user's personal phone list. - - The response is either a `UserPersonalPhoneListGetListResponse()` or an - `ErrorResponse()`. The search can be done using multiple criterion. If the - searchCriteriaModeOr is present, any result matching any one criteria is included in - the results. Otherwise, only results matching all the search criterion are included - in the results. If no search criteria is specified, all results are returned. - Specifying searchCriteriaModeOr without any search criteria results in an - `ErrorResponse()`. In all cases, if a responseSizeLimit is specified and the number of - matching results is more than this limit, then an `ErrorResponse()` is returned. - - Attributes: - user_id (str): userId - response_size_limit (int): responseSizeLimit *Optional* - search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* - search_criteria_user_personal_phone_list_name - (List[OCI.searchCriteriaUserPersonalPhoneListName]): - searchCriteriaUserPersonalPhoneListName *Optional* - search_criteria_user_personal_phone_list_number - (List[OCI.searchCriteriaUserPersonalPhoneListNumber]): - searchCriteriaUserPersonalPhoneListNumber *Optional* - """ - - __slots__: List[str] = [ - "user_id", - "response_size_limit", - "search_criteria_mode_or", - "search_criteria_user_personal_phone_list_name", - "search_criteria_user_personal_phone_list_number", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("user_id", "userId", str, is_required=True), - E("response_size_limit", "responseSizeLimit", int), - E("search_criteria_mode_or", "searchCriteriaModeOr", bool), - E( - "search_criteria_user_personal_phone_list_name", - "searchCriteriaUserPersonalPhoneListName", - OCI.SearchCriteriaUserPersonalPhoneListName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_personal_phone_list_number", - "searchCriteriaUserPersonalPhoneListNumber", - OCI.SearchCriteriaUserPersonalPhoneListNumber, - is_complex=True, - is_array=True, - ), - ) - - -class UserPersonalPhoneListGetPagedSortedListRequest(OCIRequest): - """ - Get a user's personal phone list. - - The response is either a `UserPersonalPhoneListGetPagedSortedListResponse()` or an - `ErrorResponse()`. The search can be done using multiple criterion. If the - searchCriteriaModeOr is present, any result matching any one criteria is included in - the results. Otherwise, only results matching all the search criterion are included - in the results. If no search criteria is specified, all results are returned. - Specifying searchCriteriaModeOr without any search criteria results in an - `ErrorResponse()`. The sort can done by the personal phone list number or name. The - following elements are only used in AS data mode and ignored in XS data mode: - searchCriteriaUserPersonalMultiPartPhoneListName - - Attributes: - user_id (str): userId - response_paging_control (OCI.responsePagingControl): responsePagingControl - sort_by_user_personal_phone_list_number (OCI.sortByUserPersonalPhoneListNumber): - sortByUserPersonalPhoneListNumber *Optional* - sort_by_user_personal_phone_list_name (OCI.sortByUserPersonalPhoneListName): - sortByUserPersonalPhoneListName *Optional* - search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* - search_criteria_user_personal_phone_list_name - (List[OCI.searchCriteriaUserPersonalPhoneListName]): - searchCriteriaUserPersonalPhoneListName *Optional* - search_criteria_user_personal_phone_list_number - (List[OCI.searchCriteriaUserPersonalPhoneListNumber]): - searchCriteriaUserPersonalPhoneListNumber *Optional* - search_criteria_user_personal_multi_part_phone_list_name - (List[OCI.searchCriteriaUserPersonalMultiPartPhoneListName]): - searchCriteriaUserPersonalMultiPartPhoneListName *Optional* - """ - - __slots__: List[str] = [ - "user_id", - "response_paging_control", - "sort_by_user_personal_phone_list_number", - "sort_by_user_personal_phone_list_name", - "search_criteria_mode_or", - "search_criteria_user_personal_phone_list_name", - "search_criteria_user_personal_phone_list_number", - "search_criteria_user_personal_multi_part_phone_list_name", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("user_id", "userId", str, is_required=True), - E( - "response_paging_control", - "responsePagingControl", - OCI.ResponsePagingControl, - is_complex=True, - is_required=True, - ), - E( - "sort_by_user_personal_phone_list_number", - "sortByUserPersonalPhoneListNumber", - OCI.SortByUserPersonalPhoneListNumber, - is_complex=True, - ), - E( - "sort_by_user_personal_phone_list_name", - "sortByUserPersonalPhoneListName", - OCI.SortByUserPersonalPhoneListName, - is_complex=True, - ), - E("search_criteria_mode_or", "searchCriteriaModeOr", bool), - E( - "search_criteria_user_personal_phone_list_name", - "searchCriteriaUserPersonalPhoneListName", - OCI.SearchCriteriaUserPersonalPhoneListName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_personal_phone_list_number", - "searchCriteriaUserPersonalPhoneListNumber", - OCI.SearchCriteriaUserPersonalPhoneListNumber, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_personal_multi_part_phone_list_name", - "searchCriteriaUserPersonalMultiPartPhoneListName", - OCI.SearchCriteriaUserPersonalMultiPartPhoneListName, - is_complex=True, - is_array=True, - ), - ) - - -class UserPhoneDirectoryGetPagedSortedListRequest(OCIRequest): - """ - Request a table containing the phone directory for a user. - - Setting isEnterpriseRequested to true will return enterprise directory members in the - response if the user is in an enterprise. Otherwise, just the group directory members - for a user are returned in the response. - - The response is either `UserPhoneDirectoryGetPagedSortedListResponse()` or - `ErrorResponse()`. The search can be done using multiple criteria. If the - searchCriteriaModeOr is present, any result matching any one criteria is included in - the results. Otherwise, only results matching all the search criteria are included in - the results. If no search criteria is specified, all results are returned. - Specifying searchCriteriaModeOr without any search criteria results in an - `ErrorResponse()`. The sort can be performed on user last name, first name, - department, or receptionist note. The Receptionist Note column is only populated, if - the user sending the request is the owner of the Receptionist Note and a Note exists. - The following elements are only used in AS data mode and ignored in XS data mode: - searchCriteriaMultiPartName - - Attributes: - user_id (str): userId - is_enterprise_info_requested (bool): isEnterpriseInfoRequested - response_paging_control (OCI.responsePagingControl): responsePagingControl - sort_by_user_last_name (OCI.sortByUserLastName): sortByUserLastName *Optional* - sort_by_user_first_name (OCI.sortByUserFirstName): sortByUserFirstName *Optional* - sort_by_user_department (OCI.sortByUserDepartment): sortByUserDepartment - *Optional* - sort_by_receptionist_note (OCI.sortByReceptionistNote): sortByReceptionistNote - *Optional* - search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* - search_criteria_user_last_name (List[OCI.searchCriteriaUserLastName]): - searchCriteriaUserLastName *Optional* - search_criteria_user_first_name (List[OCI.searchCriteriaUserFirstName]): - searchCriteriaUserFirstName *Optional* - search_criteria_user_name (List[OCI.searchCriteriaUserName]): - searchCriteriaUserName *Optional* - search_criteria_dn (List[OCI.searchCriteriaDn]): searchCriteriaDn *Optional* - search_criteria_group_location_code (List[OCI.searchCriteriaGroupLocationCode]): - searchCriteriaGroupLocationCode *Optional* - search_criteria_extension (List[OCI.searchCriteriaExtension]): - searchCriteriaExtension *Optional* - search_criteria_mobile_phone_number (List[OCI.searchCriteriaMobilePhoneNumber]): - searchCriteriaMobilePhoneNumber *Optional* - search_criteria_email_address (List[OCI.searchCriteriaEmailAddress]): - searchCriteriaEmailAddress *Optional* - search_criteria_yahoo_id (List[OCI.searchCriteriaYahooId]): searchCriteriaYahooId - *Optional* - search_criteria_exact_user_group (OCI.searchCriteriaExactUserGroup): - searchCriteriaExactUserGroup *Optional* - search_criteria_department_name (List[OCI.searchCriteriaDepartmentName]): - searchCriteriaDepartmentName *Optional* - search_criteria_user_id (List[OCI.searchCriteriaUserId]): searchCriteriaUserId - *Optional* - search_criteria_imp_id (List[OCI.searchCriteriaImpId]): searchCriteriaImpId - *Optional* - search_criteria_title (List[OCI.searchCriteriaTitle]): searchCriteriaTitle - *Optional* - search_criteria_receptionist_note (List[OCI.searchCriteriaReceptionistNote]): - searchCriteriaReceptionistNote *Optional* - search_criteria_multi_part_name (List[OCI.searchCriteriaMultiPartName]): - searchCriteriaMultiPartName *Optional* - """ - - __slots__: List[str] = [ - "user_id", - "is_enterprise_info_requested", - "response_paging_control", - "sort_by_user_last_name", - "sort_by_user_first_name", - "sort_by_user_department", - "sort_by_receptionist_note", - "search_criteria_mode_or", - "search_criteria_user_last_name", - "search_criteria_user_first_name", - "search_criteria_user_name", - "search_criteria_dn", - "search_criteria_group_location_code", - "search_criteria_extension", - "search_criteria_mobile_phone_number", - "search_criteria_email_address", - "search_criteria_yahoo_id", - "search_criteria_exact_user_group", - "search_criteria_department_name", - "search_criteria_user_id", - "search_criteria_imp_id", - "search_criteria_title", - "search_criteria_receptionist_note", - "search_criteria_multi_part_name", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("user_id", "userId", str, is_required=True), - E( - "is_enterprise_info_requested", - "isEnterpriseInfoRequested", - bool, - is_required=True, - ), - E( - "response_paging_control", - "responsePagingControl", - OCI.ResponsePagingControl, - is_complex=True, - is_required=True, - ), - E( - "sort_by_user_last_name", - "sortByUserLastName", - OCI.SortByUserLastName, - is_complex=True, - ), - E( - "sort_by_user_first_name", - "sortByUserFirstName", - OCI.SortByUserFirstName, - is_complex=True, - ), - E( - "sort_by_user_department", - "sortByUserDepartment", - OCI.SortByUserDepartment, - is_complex=True, - ), - E( - "sort_by_receptionist_note", - "sortByReceptionistNote", - OCI.SortByReceptionistNote, - is_complex=True, - ), - E("search_criteria_mode_or", "searchCriteriaModeOr", bool), - E( - "search_criteria_user_last_name", - "searchCriteriaUserLastName", - OCI.SearchCriteriaUserLastName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_first_name", - "searchCriteriaUserFirstName", - OCI.SearchCriteriaUserFirstName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_name", - "searchCriteriaUserName", - OCI.SearchCriteriaUserName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_dn", - "searchCriteriaDn", - OCI.SearchCriteriaDn, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_group_location_code", - "searchCriteriaGroupLocationCode", - OCI.SearchCriteriaGroupLocationCode, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_extension", - "searchCriteriaExtension", - OCI.SearchCriteriaExtension, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_mobile_phone_number", - "searchCriteriaMobilePhoneNumber", - OCI.SearchCriteriaMobilePhoneNumber, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_email_address", - "searchCriteriaEmailAddress", - OCI.SearchCriteriaEmailAddress, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_yahoo_id", - "searchCriteriaYahooId", - OCI.SearchCriteriaYahooId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_exact_user_group", - "searchCriteriaExactUserGroup", - OCI.SearchCriteriaExactUserGroup, - is_complex=True, - ), - E( - "search_criteria_department_name", - "searchCriteriaDepartmentName", - OCI.SearchCriteriaDepartmentName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_id", - "searchCriteriaUserId", - OCI.SearchCriteriaUserId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_imp_id", - "searchCriteriaImpId", - OCI.SearchCriteriaImpId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_title", - "searchCriteriaTitle", - OCI.SearchCriteriaTitle, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_receptionist_note", - "searchCriteriaReceptionistNote", - OCI.SearchCriteriaReceptionistNote, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_multi_part_name", - "searchCriteriaMultiPartName", - OCI.SearchCriteriaMultiPartUserName, - is_complex=True, - is_array=True, - ), - ) - - class UserPolycomPhoneServicesGetRequest(OCIRequest): """ Request the user's Polycom Phone Services attributes. @@ -112023,86 +103750,6 @@ def _elements(cls) -> Tuple[E, ...]: ) -class UserScheduleGetPagedSortedListRequest(OCIRequest): - """ - Get the list of schedules viewable by a User. - - The list can be filtered by schedule name, schedule type, and schedule level. - - The response is either a `UserScheduleGetPagedSortedListResponse()` or an - `ErrorResponse()`. This command is authorized to user who is Executive-Assistant of - the Executive. If no sortOrder is included, the response is sorted by Name ascending - by default. If the responsePagingControl element is not provided, the paging - startIndex will be set to 1 by default, and the responsePageSize will be set to the - maximum responsePageSize by default. Multiple search criteria are logically ANDed - together unless the searchCriteriaModeOr option is included. Then the search criteria - are logically ORed together. - - Attributes: - user_id (str): userId - response_paging_control (OCI.responsePagingControl): responsePagingControl - *Optional* - sort_by_schedule_name (OCI.sortByScheduleName): sortByScheduleName *Optional* - search_criteria_schedule_name (List[OCI.searchCriteriaScheduleName]): - searchCriteriaScheduleName *Optional* - search_criteria_exact_schedule_type (List[OCI.searchCriteriaExactScheduleType]): - searchCriteriaExactScheduleType *Optional* - search_criteria_exact_schedule_level (List[OCI.searchCriteriaExactScheduleLevel]): - searchCriteriaExactScheduleLevel *Optional* - search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* - """ - - __slots__: List[str] = [ - "user_id", - "response_paging_control", - "sort_by_schedule_name", - "search_criteria_schedule_name", - "search_criteria_exact_schedule_type", - "search_criteria_exact_schedule_level", - "search_criteria_mode_or", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("user_id", "userId", str, is_required=True), - E( - "response_paging_control", - "responsePagingControl", - OCI.ResponsePagingControl, - is_complex=True, - ), - E( - "sort_by_schedule_name", - "sortByScheduleName", - OCI.SortByScheduleName, - is_complex=True, - ), - E( - "search_criteria_schedule_name", - "searchCriteriaScheduleName", - OCI.SearchCriteriaScheduleName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_exact_schedule_type", - "searchCriteriaExactScheduleType", - OCI.SearchCriteriaExactScheduleType, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_exact_schedule_level", - "searchCriteriaExactScheduleLevel", - OCI.SearchCriteriaExactScheduleLevel, - is_complex=True, - is_array=True, - ), - E("search_criteria_mode_or", "searchCriteriaModeOr", bool), - ) - - class UserScheduleModifyEventRequest(OCIRequest): """ Modify an event of a user schedule. @@ -113492,68 +105139,42 @@ def _elements(cls) -> Tuple[E, ...]: ) -class EnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAssignmentPagedSortedListRequest( +class EnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAvailablePagedSortedListRequest( OCIRequest, ): """ - Request a summary table of all Mobile Subscriber Directory Numbers in an enterprise. + Request a list of available Mobile Subscriber Directory Numbers not yet assigned to + any user. If the responsePagingControl element is not provided, the paging startIndex will be set to 1 by default, and the responsePageSize will be set to the maximum ResponsePageSize by default. If no sortOrder is included the response is sorted by Mobile Number ascending by default. Multiple search criteria are logically ANDed together unless the searchCriteriaModeOr option is included. Then the search criteria - are logically ORed together. The department in both the search criteria and sort by - fields refer to the department of the user. + are logically ORed together. The response is either - `EnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAssignmentPagedSortedListResponse()` + `EnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAvailablePagedSortedListResponse()` or `ErrorResponse()`. Replaced by: - `EnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAssignmentPagedSortedListRequest22()` + `EnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAvailablePagedSortedListRequest22()` Attributes: service_provider_id (str): serviceProviderId response_paging_control (OCI.responsePagingControl): responsePagingControl *Optional* - sort_order (List[OCI.sortOrder]): sortOrder *Optional* + sort_by_mobile_directory_number (OCI.sortByMobileDirectoryNumber): + sortByMobileDirectoryNumber *Optional* search_criteria_mobile_subscriber_directory_number (List[OCI.searchCriteriaMobileSubscriberDirectoryNumber]): searchCriteriaMobileSubscriberDirectoryNumber *Optional* - search_criteria_group_id (List[OCI.searchCriteriaGroupId]): searchCriteriaGroupId - *Optional* - search_criteria_user_id (List[OCI.searchCriteriaUserId]): searchCriteriaUserId - *Optional* - search_criteria_user_last_name (List[OCI.searchCriteriaUserLastName]): - searchCriteriaUserLastName *Optional* - search_criteria_user_first_name (List[OCI.searchCriteriaUserFirstName]): - searchCriteriaUserFirstName *Optional* - search_criteria_dn (List[OCI.searchCriteriaDn]): searchCriteriaDn *Optional* - search_criteria_extension (List[OCI.searchCriteriaExtension]): - searchCriteriaExtension *Optional* - search_criteria_department_name (List[OCI.searchCriteriaDepartmentName]): - searchCriteriaDepartmentName *Optional* - search_criteria_exact_mobile_network (List[OCI.searchCriteriaExactMobileNetwork]): - searchCriteriaExactMobileNetwork *Optional* - search_criteria_exact_mobile_dn_availability - (OCI.searchCriteriaExactMobileDnAvailability): - searchCriteriaExactMobileDnAvailability *Optional* search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* """ __slots__: List[str] = [ "service_provider_id", "response_paging_control", - "sort_order", + "sort_by_mobile_directory_number", "search_criteria_mobile_subscriber_directory_number", - "search_criteria_group_id", - "search_criteria_user_id", - "search_criteria_user_last_name", - "search_criteria_user_first_name", - "search_criteria_dn", - "search_criteria_extension", - "search_criteria_department_name", - "search_criteria_exact_mobile_network", - "search_criteria_exact_mobile_dn_availability", "search_criteria_mode_or", ] @@ -113568,11 +105189,10 @@ def _elements(cls) -> Tuple[E, ...]: is_complex=True, ), E( - "sort_order", - "sortOrder", - OCI.SortOrderEnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAssignmentPagedSortedList, + "sort_by_mobile_directory_number", + "sortByMobileDirectoryNumber", + OCI.SortByMobileDirectoryNumber, is_complex=True, - is_array=True, ), E( "search_criteria_mobile_subscriber_directory_number", @@ -113581,88 +105201,26 @@ def _elements(cls) -> Tuple[E, ...]: is_complex=True, is_array=True, ), - E( - "search_criteria_group_id", - "searchCriteriaGroupId", - OCI.SearchCriteriaGroupId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_id", - "searchCriteriaUserId", - OCI.SearchCriteriaUserId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_last_name", - "searchCriteriaUserLastName", - OCI.SearchCriteriaUserLastName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_first_name", - "searchCriteriaUserFirstName", - OCI.SearchCriteriaUserFirstName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_dn", - "searchCriteriaDn", - OCI.SearchCriteriaDn, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_extension", - "searchCriteriaExtension", - OCI.SearchCriteriaExtension, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_department_name", - "searchCriteriaDepartmentName", - OCI.SearchCriteriaDepartmentName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_exact_mobile_network", - "searchCriteriaExactMobileNetwork", - OCI.SearchCriteriaExactMobileNetwork, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_exact_mobile_dn_availability", - "searchCriteriaExactMobileDnAvailability", - OCI.SearchCriteriaExactMobileDnAvailability, - is_complex=True, - ), E("search_criteria_mode_or", "searchCriteriaModeOr", bool), ) -class EnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAssignmentPagedSortedListRequest22( +class EnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAvailablePagedSortedListRequest22( OCIRequest, ): """ - Request a summary table of all Mobile Subscriber Directory Numbers in an enterprise. + Request a list of available Mobile Subscriber Directory Numbers not yet assigned to + any user. If the responsePagingControl element is not provided, the paging startIndex will be set to 1 by default, and the responsePageSize will be set to the maximum ResponsePageSize by default. If no sortOrder is included the response is sorted by Mobile Number ascending by default. Multiple search criteria are logically ANDed together unless the searchCriteriaModeOr option is included. Then the search criteria - are logically ORed together. The department in both the search criteria and sort by - fields refer to the department of the user. + are logically ORed together. The response is either - `EnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAssignmentPagedSortedListResponse22()` + `EnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAvailablePagedSortedListResponse22()` or `ErrorResponse()`. Attributes: @@ -113670,28 +105228,11 @@ class EnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAssignmentPa include_total_number_of_rows (bool): includeTotalNumberOfRows *Optional* response_paging_control (OCI.responsePagingControl): responsePagingControl *Optional* - sort_order (List[OCI.sortOrder]): sortOrder *Optional* + sort_by_mobile_directory_number (OCI.sortByMobileDirectoryNumber): + sortByMobileDirectoryNumber *Optional* search_criteria_mobile_subscriber_directory_number (List[OCI.searchCriteriaMobileSubscriberDirectoryNumber]): searchCriteriaMobileSubscriberDirectoryNumber *Optional* - search_criteria_group_id (List[OCI.searchCriteriaGroupId]): searchCriteriaGroupId - *Optional* - search_criteria_user_id (List[OCI.searchCriteriaUserId]): searchCriteriaUserId - *Optional* - search_criteria_user_last_name (List[OCI.searchCriteriaUserLastName]): - searchCriteriaUserLastName *Optional* - search_criteria_user_first_name (List[OCI.searchCriteriaUserFirstName]): - searchCriteriaUserFirstName *Optional* - search_criteria_dn (List[OCI.searchCriteriaDn]): searchCriteriaDn *Optional* - search_criteria_extension (List[OCI.searchCriteriaExtension]): - searchCriteriaExtension *Optional* - search_criteria_department_name (List[OCI.searchCriteriaDepartmentName]): - searchCriteriaDepartmentName *Optional* - search_criteria_exact_mobile_network (List[OCI.searchCriteriaExactMobileNetwork]): - searchCriteriaExactMobileNetwork *Optional* - search_criteria_exact_mobile_dn_availability - (OCI.searchCriteriaExactMobileDnAvailability): - searchCriteriaExactMobileDnAvailability *Optional* search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* """ @@ -113699,17 +105240,8 @@ class EnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAssignmentPa "service_provider_id", "include_total_number_of_rows", "response_paging_control", - "sort_order", + "sort_by_mobile_directory_number", "search_criteria_mobile_subscriber_directory_number", - "search_criteria_group_id", - "search_criteria_user_id", - "search_criteria_user_last_name", - "search_criteria_user_first_name", - "search_criteria_dn", - "search_criteria_extension", - "search_criteria_department_name", - "search_criteria_exact_mobile_network", - "search_criteria_exact_mobile_dn_availability", "search_criteria_mode_or", ] @@ -113725,11 +105257,10 @@ def _elements(cls) -> Tuple[E, ...]: is_complex=True, ), E( - "sort_order", - "sortOrder", - OCI.SortOrderEnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAssignmentPagedSortedList, + "sort_by_mobile_directory_number", + "sortByMobileDirectoryNumber", + OCI.SortByMobileDirectoryNumber, is_complex=True, - is_array=True, ), E( "search_criteria_mobile_subscriber_directory_number", @@ -113738,68 +105269,6 @@ def _elements(cls) -> Tuple[E, ...]: is_complex=True, is_array=True, ), - E( - "search_criteria_group_id", - "searchCriteriaGroupId", - OCI.SearchCriteriaGroupId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_id", - "searchCriteriaUserId", - OCI.SearchCriteriaUserId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_last_name", - "searchCriteriaUserLastName", - OCI.SearchCriteriaUserLastName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_first_name", - "searchCriteriaUserFirstName", - OCI.SearchCriteriaUserFirstName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_dn", - "searchCriteriaDn", - OCI.SearchCriteriaDn, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_extension", - "searchCriteriaExtension", - OCI.SearchCriteriaExtension, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_department_name", - "searchCriteriaDepartmentName", - OCI.SearchCriteriaDepartmentName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_exact_mobile_network", - "searchCriteriaExactMobileNetwork", - OCI.SearchCriteriaExactMobileNetwork, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_exact_mobile_dn_availability", - "searchCriteriaExactMobileDnAvailability", - OCI.SearchCriteriaExactMobileDnAvailability, - is_complex=True, - ), E("search_criteria_mode_or", "searchCriteriaModeOr", bool), ) @@ -114025,108 +105494,47 @@ def _elements(cls) -> Tuple[E, ...]: ) -class EnterpriseCallCenterAgentThresholdProfileGetAvailableAgentPagedSortedListRequest( - OCIRequest, -): +class EnterpriseCallCenterCurrentAndPastAgentGetListRequest(OCIRequest): """ - Get the list of all Agents in the Enterprise that can be assigned to a given Call - Center Agent Threshold Profile in an Enterprise. + Request to all the current and past agents in the enterprise. - An agent is available to be assigned to a given Agent Threshold Profile if it is a - Call Center Standard or Call Center Premium agent and the agent is not yet assigned to - the profile. If the responsePagingControl element is not provided, the paging - startIndex will be set to 1 by default, and the responsePageSize will be set to the - maximum ResponsePageSize by default. It is possible to search by various criteria to - restrict the number of rows returned. The available agent list for a new Call Center - Agent Threshold profile can be obtained by not setting the - excludeAgentsAssignedToProfileName. When the excludeAgentsAssignedToProfileName is - specified, all agents already assigned to the specified profile are not included in - the response, even if the search criterion element searchCriteriaAgentThresholdProfile - is specified using the same profile name. If no sortOrder is included the response is - sorted by User Id ascending by default. Multiple search criteria are logically ANDed - together unless the searchCriteriaModeOr option is included. Then the search criteria - are logically ORed together. `ErrorResponse()` is returned if - searchCriteriaExactUserGroup has multiple entries and searchCriteriaModeOr is not - included. + The searchCriteriaExactUserGroup does not apply to past agents. - The response is either a - `EnterpriseCallCenterAgentThresholdProfileGetAvailableAgentPagedSortedListResponse()` - or an `ErrorResponse()`. + The response is either `EnterpriseCallCenterCurrentAndPastAgentGetListResponse()` or + `ErrorResponse()`. Attributes: service_provider_id (str): serviceProviderId - exclude_agents_assigned_to_profile_name (str): excludeAgentsAssignedToProfileName - *Optional* - response_paging_control (OCI.responsePagingControl): responsePagingControl - *Optional* - sort_order (List[OCI.sortOrder]): sortOrder *Optional* - search_criteria_user_id (List[OCI.searchCriteriaUserId]): searchCriteriaUserId - *Optional* + response_size_limit (int): responseSizeLimit *Optional* search_criteria_user_last_name (List[OCI.searchCriteriaUserLastName]): searchCriteriaUserLastName *Optional* search_criteria_user_first_name (List[OCI.searchCriteriaUserFirstName]): searchCriteriaUserFirstName *Optional* + search_criteria_exact_user_group (OCI.searchCriteriaExactUserGroup): + searchCriteriaExactUserGroup *Optional* + search_criteria_user_id (List[OCI.searchCriteriaUserId]): searchCriteriaUserId + *Optional* search_criteria_dn (List[OCI.searchCriteriaDn]): searchCriteriaDn *Optional* search_criteria_extension (List[OCI.searchCriteriaExtension]): searchCriteriaExtension *Optional* - search_criteria_department_name (List[OCI.searchCriteriaDepartmentName]): - searchCriteriaDepartmentName *Optional* - search_criteria_email_address (List[OCI.searchCriteriaEmailAddress]): - searchCriteriaEmailAddress *Optional* - search_criteria_agent_threshold_profile - (List[OCI.searchCriteriaAgentThresholdProfile]): - searchCriteriaAgentThresholdProfile *Optional* - search_criteria_exact_user_group (List[OCI.searchCriteriaExactUserGroup]): - searchCriteriaExactUserGroup *Optional* - search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* """ __slots__: List[str] = [ "service_provider_id", - "exclude_agents_assigned_to_profile_name", - "response_paging_control", - "sort_order", - "search_criteria_user_id", + "response_size_limit", "search_criteria_user_last_name", "search_criteria_user_first_name", + "search_criteria_exact_user_group", + "search_criteria_user_id", "search_criteria_dn", "search_criteria_extension", - "search_criteria_department_name", - "search_criteria_email_address", - "search_criteria_agent_threshold_profile", - "search_criteria_exact_user_group", - "search_criteria_mode_or", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( E("service_provider_id", "serviceProviderId", str, is_required=True), - E( - "exclude_agents_assigned_to_profile_name", - "excludeAgentsAssignedToProfileName", - str, - ), - E( - "response_paging_control", - "responsePagingControl", - OCI.ResponsePagingControl, - is_complex=True, - ), - E( - "sort_order", - "sortOrder", - OCI.SortOrderEnterpriseCallCenterAgentThresholdProfileGetAvailableAgentPagedSortedList, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_id", - "searchCriteriaUserId", - OCI.SearchCriteriaUserId, - is_complex=True, - is_array=True, - ), + E("response_size_limit", "responseSizeLimit", int), E( "search_criteria_user_last_name", "searchCriteriaUserLastName", @@ -114142,194 +105550,80 @@ def _elements(cls) -> Tuple[E, ...]: is_array=True, ), E( - "search_criteria_dn", - "searchCriteriaDn", - OCI.SearchCriteriaDn, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_extension", - "searchCriteriaExtension", - OCI.SearchCriteriaExtension, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_department_name", - "searchCriteriaDepartmentName", - OCI.SearchCriteriaDepartmentName, + "search_criteria_exact_user_group", + "searchCriteriaExactUserGroup", + OCI.SearchCriteriaExactUserGroup, is_complex=True, - is_array=True, ), E( - "search_criteria_email_address", - "searchCriteriaEmailAddress", - OCI.SearchCriteriaEmailAddress, + "search_criteria_user_id", + "searchCriteriaUserId", + OCI.SearchCriteriaUserId, is_complex=True, is_array=True, ), E( - "search_criteria_agent_threshold_profile", - "searchCriteriaAgentThresholdProfile", - OCI.SearchCriteriaAgentThresholdProfile, + "search_criteria_dn", + "searchCriteriaDn", + OCI.SearchCriteriaDn, is_complex=True, is_array=True, ), E( - "search_criteria_exact_user_group", - "searchCriteriaExactUserGroup", - OCI.SearchCriteriaExactUserGroup, + "search_criteria_extension", + "searchCriteriaExtension", + OCI.SearchCriteriaExtension, is_complex=True, is_array=True, ), - E("search_criteria_mode_or", "searchCriteriaModeOr", bool), ) -class EnterpriseCallCenterAgentThresholdProfileGetPagedSortedRequest(OCIRequest): +class EnterpriseCallCenterCurrentAndPastCallCenterGetListRequest(OCIRequest): """ - Gets an existing specified Call Center Agent Threshold Profile in an Enterprise. + Request to get all the current and past call centers for the enterprise. - The agentTable is what the search, sort, and pagination fields apply to. If the - responsePagingControl element is not provided, the paging startIndex will be set to 1 - by default, and the responsePageSize will be set to the maximum ResponsePageSize by - default. It is possible to search by various criteria to restrict the number of rows - returned. If no sortOrder is included the response is sorted by User Id ascending by - default. Multiple search criteria are logically ANDed together unless the - searchCriteriaModeOr option is included. Then the search criteria are logically ORed - together. `ErrorResponse()` is returned if searchCriteriaExactUserGroup has multiple - entries and searchCriteriaModeOr is not included. + The searchCriteriaExactUserGroup does not apply to past call centers. - The response is either a - `EnterpriseCallCenterAgentThresholdProfileGetPagedSortedResponse()` or an - `ErrorResponse()`. + The response is either `EnterpriseCallCenterCurrentAndPastCallCenterGetListResponse()` + or `ErrorResponse()`. Attributes: service_provider_id (str): serviceProviderId - profile_name (str): profileName - response_paging_control (OCI.responsePagingControl): responsePagingControl - *Optional* - sort_order (List[OCI.sortOrder]): sortOrder *Optional* - search_criteria_user_id (List[OCI.searchCriteriaUserId]): searchCriteriaUserId - *Optional* - search_criteria_user_last_name (List[OCI.searchCriteriaUserLastName]): - searchCriteriaUserLastName *Optional* - search_criteria_user_first_name (List[OCI.searchCriteriaUserFirstName]): - searchCriteriaUserFirstName *Optional* - search_criteria_dn (List[OCI.searchCriteriaDn]): searchCriteriaDn *Optional* - search_criteria_extension (List[OCI.searchCriteriaExtension]): - searchCriteriaExtension *Optional* - search_criteria_department_name (List[OCI.searchCriteriaDepartmentName]): - searchCriteriaDepartmentName *Optional* - search_criteria_exact_user_group (List[OCI.searchCriteriaExactUserGroup]): + is_premium_only (bool): isPremiumOnly *Optional* + response_size_limit (int): responseSizeLimit *Optional* + search_criteria_exact_user_group (OCI.searchCriteriaExactUserGroup): searchCriteriaExactUserGroup *Optional* - search_criteria_group_name (List[OCI.searchCriteriaGroupName]): - searchCriteriaGroupName *Optional* - search_criteria_email_address (List[OCI.searchCriteriaEmailAddress]): - searchCriteriaEmailAddress *Optional* - search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* + search_criteria_call_center_name (OCI.searchCriteriaCallCenterName): + searchCriteriaCallCenterName *Optional* """ __slots__: List[str] = [ "service_provider_id", - "profile_name", - "response_paging_control", - "sort_order", - "search_criteria_user_id", - "search_criteria_user_last_name", - "search_criteria_user_first_name", - "search_criteria_dn", - "search_criteria_extension", - "search_criteria_department_name", + "is_premium_only", + "response_size_limit", "search_criteria_exact_user_group", - "search_criteria_group_name", - "search_criteria_email_address", - "search_criteria_mode_or", + "search_criteria_call_center_name", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( E("service_provider_id", "serviceProviderId", str, is_required=True), - E("profile_name", "profileName", str, is_required=True), - E( - "response_paging_control", - "responsePagingControl", - OCI.ResponsePagingControl, - is_complex=True, - ), - E( - "sort_order", - "sortOrder", - OCI.SortOrderEnterpriseCallCenterAgentThresholdProfileGetPagedSorted, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_id", - "searchCriteriaUserId", - OCI.SearchCriteriaUserId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_last_name", - "searchCriteriaUserLastName", - OCI.SearchCriteriaUserLastName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_first_name", - "searchCriteriaUserFirstName", - OCI.SearchCriteriaUserFirstName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_dn", - "searchCriteriaDn", - OCI.SearchCriteriaDn, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_extension", - "searchCriteriaExtension", - OCI.SearchCriteriaExtension, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_department_name", - "searchCriteriaDepartmentName", - OCI.SearchCriteriaDepartmentName, - is_complex=True, - is_array=True, - ), + E("is_premium_only", "isPremiumOnly", bool), + E("response_size_limit", "responseSizeLimit", int), E( "search_criteria_exact_user_group", "searchCriteriaExactUserGroup", OCI.SearchCriteriaExactUserGroup, is_complex=True, - is_array=True, - ), - E( - "search_criteria_group_name", - "searchCriteriaGroupName", - OCI.SearchCriteriaGroupName, - is_complex=True, - is_array=True, ), E( - "search_criteria_email_address", - "searchCriteriaEmailAddress", - OCI.SearchCriteriaEmailAddress, + "search_criteria_call_center_name", + "searchCriteriaCallCenterName", + OCI.SearchCriteriaCallCenterName, is_complex=True, - is_array=True, ), - E("search_criteria_mode_or", "searchCriteriaModeOr", bool), ) @@ -114510,6 +105804,238 @@ def _elements(cls) -> Tuple[E, ...]: ) +class EnterpriseCommonPhoneListGetListRequest(OCIRequest): + """ + Get an enterprise's common phone list. + + The response is either a `EnterpriseCommonPhoneListGetListResponse()` or an + `ErrorResponse()`. The search can be done using multiple criterion. If the + searchCriteriaModeOr is present, any result matching any one criteria is included in + the results. Otherwise, only results matching all the search criterion are included + in the results. If no search criteria is specified, all results are returned. + Specifying searchCriteriaModeOr without any search criteria results in an + `ErrorResponse()`. In all cases, if a responseSizeLimit is specified and the number of + matching results is more than this limit, then an `ErrorResponse()` is returned. + + Attributes: + service_provider_id (str): serviceProviderId + response_size_limit (int): responseSizeLimit *Optional* + search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* + search_criteria_enterprise_common_phone_list_name + (List[OCI.searchCriteriaEnterpriseCommonPhoneListName]): + searchCriteriaEnterpriseCommonPhoneListName *Optional* + search_criteria_enterprise_common_phone_list_number + (List[OCI.searchCriteriaEnterpriseCommonPhoneListNumber]): + searchCriteriaEnterpriseCommonPhoneListNumber *Optional* + """ + + __slots__: List[str] = [ + "service_provider_id", + "response_size_limit", + "search_criteria_mode_or", + "search_criteria_enterprise_common_phone_list_name", + "search_criteria_enterprise_common_phone_list_number", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("service_provider_id", "serviceProviderId", str, is_required=True), + E("response_size_limit", "responseSizeLimit", int), + E("search_criteria_mode_or", "searchCriteriaModeOr", bool), + E( + "search_criteria_enterprise_common_phone_list_name", + "searchCriteriaEnterpriseCommonPhoneListName", + OCI.SearchCriteriaEnterpriseCommonPhoneListName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_enterprise_common_phone_list_number", + "searchCriteriaEnterpriseCommonPhoneListNumber", + OCI.SearchCriteriaEnterpriseCommonPhoneListNumber, + is_complex=True, + is_array=True, + ), + ) + + +class EnterpriseCommunicationBarringAuthorizationCodeGetListRequest(OCIRequest): + """ + Get a list of Communication Barring Authorization Codes in an enterprise. + + The response is either + `EnterpriseCommunicationBarringAuthorizationCodeGetListResponse()` or + `ErrorResponse()`. + + Attributes: + service_provider_id (str): serviceProviderId + response_size_limit (int): responseSizeLimit *Optional* + search_criteria_communication_barring_authorization_code + (List[OCI.searchCriteriaCommunicationBarringAuthorizationCode]): + searchCriteriaCommunicationBarringAuthorizationCode *Optional* + search_criteria_communication_barring_authorization_code_description + (List[OCI.searchCriteriaCommunicationBarringAuthorizationCodeDescription]): + searchCriteriaCommunicationBarringAuthorizationCodeDescription *Optional* + search_criteria_network_class_of_service_name + (List[OCI.searchCriteriaNetworkClassOfServiceName]): + searchCriteriaNetworkClassOfServiceName *Optional* + """ + + __slots__: List[str] = [ + "service_provider_id", + "response_size_limit", + "search_criteria_communication_barring_authorization_code", + "search_criteria_communication_barring_authorization_code_description", + "search_criteria_network_class_of_service_name", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("service_provider_id", "serviceProviderId", str, is_required=True), + E("response_size_limit", "responseSizeLimit", int), + E( + "search_criteria_communication_barring_authorization_code", + "searchCriteriaCommunicationBarringAuthorizationCode", + OCI.SearchCriteriaCommunicationBarringAuthorizationCode, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_communication_barring_authorization_code_description", + "searchCriteriaCommunicationBarringAuthorizationCodeDescription", + OCI.SearchCriteriaCommunicationBarringAuthorizationCodeDescription, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_network_class_of_service_name", + "searchCriteriaNetworkClassOfServiceName", + OCI.SearchCriteriaNetworkClassOfServiceName, + is_complex=True, + is_array=True, + ), + ) + + +class EnterpriseDepartmentAddRequest(OCIRequest): + """ + Add a department to enterprise. + + The response is either a `SuccessResponse()` or an `ErrorResponse()`. + + Attributes: + enterprise_id (str): enterpriseId + department_name (str): departmentName + parent_department_key (OCI.parentDepartmentKey): parentDepartmentKey *Optional* + """ + + __slots__: List[str] = [ + "enterprise_id", + "department_name", + "parent_department_key", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("enterprise_id", "enterpriseId", str, is_required=True), + E("department_name", "departmentName", str, is_required=True), + E( + "parent_department_key", + "parentDepartmentKey", + OCI.EnterpriseDepartmentKey, + is_complex=True, + ), + ) + + +class EnterpriseDepartmentModifyRequest(OCIRequest): + """ + Modify a department of an enterprise. + + The response is either a `SuccessResponse()` or an `ErrorResponse()`. + + Attributes: + enterprise_id (str): enterpriseId + department_name (str): departmentName + new_department_name (str): newDepartmentName *Optional* + new_parent_department_key (OCI.newParentDepartmentKey): newParentDepartmentKey + *Optional* + """ + + __slots__: List[str] = [ + "enterprise_id", + "department_name", + "new_department_name", + "new_parent_department_key", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("enterprise_id", "enterpriseId", str, is_required=True), + E("department_name", "departmentName", str, is_required=True), + E("new_department_name", "newDepartmentName", str), + E( + "new_parent_department_key", + "newParentDepartmentKey", + OCI.EnterpriseDepartmentKey, + is_complex=True, + ), + ) + + +class EnterpriseEnterpriseTrunkGetAvailableTrunkGroupListRequest(OCIRequest): + """ + Request to get the list of all available trunk groups defined in an enterprise. + + It is possible to search by various criteria to restrict the number of rows returned. + Multiple search criteria are logically ANDed together. + + The response is either a + `EnterpriseEnterpriseTrunkGetAvailableTrunkGroupListResponse()` or an + `ErrorResponse()`. + + Attributes: + service_provider_id (str): serviceProviderId + response_size_limit (int): responseSizeLimit *Optional* + search_criteria_trunk_group_name (List[OCI.searchCriteriaTrunkGroupName]): + searchCriteriaTrunkGroupName *Optional* + search_criteria_group_id (List[OCI.searchCriteriaGroupId]): searchCriteriaGroupId + *Optional* + """ + + __slots__: List[str] = [ + "service_provider_id", + "response_size_limit", + "search_criteria_trunk_group_name", + "search_criteria_group_id", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("service_provider_id", "serviceProviderId", str, is_required=True), + E("response_size_limit", "responseSizeLimit", int), + E( + "search_criteria_trunk_group_name", + "searchCriteriaTrunkGroupName", + OCI.SearchCriteriaTrunkGroupName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_group_id", + "searchCriteriaGroupId", + OCI.SearchCriteriaGroupId, + is_complex=True, + is_array=True, + ), + ) + + class EnterpriseEnterpriseTrunkGetAvailableUserListRequest(OCIRequest): """ Request the list of users that are available to be added to an enterprise trunk. @@ -114761,6 +106287,67 @@ def _elements(cls) -> Tuple[E, ...]: ) +class EnterpriseLocalGatewayGetPagedSortedListRequest(OCIRequest): + """ + Get a list of local gateways defined within an enterprise. + + Only the local gateways having device associated are returned. If the + responsePagingControl element is not provided, the paging startIndex will be set to 1 + by default, and the responsePageSize will be set to the maximum ResponsePageSize by + default. If no sortOrder is included the response is sorted by Trunk group name + ascending by default. Multiple search criteria are logically ANDed together unless + the searchCriteriaModeOr option is included. Then the search criteria are logically + ORed together. + + The response is either a `EnterpriseLocalGatewayGetPagedSortedListResponse()` or an + `ErrorResponse()`. + + Attributes: + service_provider_id (str): serviceProviderId + response_paging_control (OCI.responsePagingControl): responsePagingControl + *Optional* + sort_by_trunk_group_name (OCI.sortByTrunkGroupName): sortByTrunkGroupName + *Optional* + search_criteria_trunk_group_name (List[OCI.searchCriteriaTrunkGroupName]): + searchCriteriaTrunkGroupName *Optional* + search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* + """ + + __slots__: List[str] = [ + "service_provider_id", + "response_paging_control", + "sort_by_trunk_group_name", + "search_criteria_trunk_group_name", + "search_criteria_mode_or", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("service_provider_id", "serviceProviderId", str, is_required=True), + E( + "response_paging_control", + "responsePagingControl", + OCI.ResponsePagingControl, + is_complex=True, + ), + E( + "sort_by_trunk_group_name", + "sortByTrunkGroupName", + OCI.SortByTrunkGroupName, + is_complex=True, + ), + E( + "search_criteria_trunk_group_name", + "searchCriteriaTrunkGroupName", + OCI.SearchCriteriaTrunkGroupName, + is_complex=True, + is_array=True, + ), + E("search_criteria_mode_or", "searchCriteriaModeOr", bool), + ) + + class EnterprisePhoneDirectoryGetListRequest(OCIRequest): """ Request a table containing the phone directory for an enterprise. @@ -115491,207 +107078,6 @@ def _elements(cls) -> Tuple[E, ...]: ) -class EnterprisePhoneDirectoryGetPagedSortedListRequest(OCIRequest): - """ - Request a table containing the phone directory for an enterprise. - - The directory includes all users in the enterprise and all entries in the enterprise - common phone list. If the responsePagingControl element is not provided, the paging - startIndex will be set to 1 by default, and the responsePageSize will be set to the - maximum ResponsePageSize by default. It is possible to search by various criteria to - restrict the number of rows returned. If no sortOrder is included the response is - sorted by User Id ascending with a secondary sort by User Last Name ascending by - default. Multiple search criteria are logically ANDed together unless the - searchCriteriaModeOr option is included. Then the search criteria are logically ORed - together. `ErrorResponse()` is returned if searchCriteriaExactUserGroup or - searchCriteriaExactUserDepartment have multiple entries and searchCriteriaModeOr is - not included The following elements are only used in AS data mode and ignored in - Amplify and XS data mode: "sortByImpId" "searchCriteriaImpId" - - The response is either `EnterprisePhoneDirectoryGetPagedSortedListResponse()` or - `ErrorResponse()`. - - Attributes: - enterprise_id (str): enterpriseId - is_extended_info_requested (bool): isExtendedInfoRequested - response_paging_control (OCI.responsePagingControl): responsePagingControl - *Optional* - sort_order (List[OCI.sortOrder]): sortOrder *Optional* - search_criteria_user_last_name (List[OCI.searchCriteriaUserLastName]): - searchCriteriaUserLastName *Optional* - search_criteria_user_first_name (List[OCI.searchCriteriaUserFirstName]): - searchCriteriaUserFirstName *Optional* - search_criteria_dn (List[OCI.searchCriteriaDn]): searchCriteriaDn *Optional* - search_criteria_group_location_code (List[OCI.searchCriteriaGroupLocationCode]): - searchCriteriaGroupLocationCode *Optional* - search_criteria_extension (List[OCI.searchCriteriaExtension]): - searchCriteriaExtension *Optional* - search_criteria_mobile_phone_number (List[OCI.searchCriteriaMobilePhoneNumber]): - searchCriteriaMobilePhoneNumber *Optional* - search_criteria_email_address (List[OCI.searchCriteriaEmailAddress]): - searchCriteriaEmailAddress *Optional* - search_criteria_exact_user_department (OCI.searchCriteriaExactUserDepartment): - searchCriteriaExactUserDepartment *Optional* - search_criteria_department_name (List[OCI.searchCriteriaDepartmentName]): - searchCriteriaDepartmentName *Optional* - search_criteria_exact_user_group (OCI.searchCriteriaExactUserGroup): - searchCriteriaExactUserGroup *Optional* - search_criteria_group_name (List[OCI.searchCriteriaGroupName]): - searchCriteriaGroupName *Optional* - search_criteria_yahoo_id (List[OCI.searchCriteriaYahooId]): searchCriteriaYahooId - *Optional* - search_criteria_user_id (List[OCI.searchCriteriaUserId]): searchCriteriaUserId - *Optional* - search_criteria_imp_id (List[OCI.searchCriteriaImpId]): searchCriteriaImpId - *Optional* - search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* - """ - - __slots__: List[str] = [ - "enterprise_id", - "is_extended_info_requested", - "response_paging_control", - "sort_order", - "search_criteria_user_last_name", - "search_criteria_user_first_name", - "search_criteria_dn", - "search_criteria_group_location_code", - "search_criteria_extension", - "search_criteria_mobile_phone_number", - "search_criteria_email_address", - "search_criteria_exact_user_department", - "search_criteria_department_name", - "search_criteria_exact_user_group", - "search_criteria_group_name", - "search_criteria_yahoo_id", - "search_criteria_user_id", - "search_criteria_imp_id", - "search_criteria_mode_or", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("enterprise_id", "enterpriseId", str, is_required=True), - E( - "is_extended_info_requested", - "isExtendedInfoRequested", - bool, - is_required=True, - ), - E( - "response_paging_control", - "responsePagingControl", - OCI.ResponsePagingControl, - is_complex=True, - ), - E( - "sort_order", - "sortOrder", - OCI.SortOrderEnterprisePhoneDirectoryGetPagedSortedList, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_last_name", - "searchCriteriaUserLastName", - OCI.SearchCriteriaUserLastName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_first_name", - "searchCriteriaUserFirstName", - OCI.SearchCriteriaUserFirstName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_dn", - "searchCriteriaDn", - OCI.SearchCriteriaDn, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_group_location_code", - "searchCriteriaGroupLocationCode", - OCI.SearchCriteriaGroupLocationCode, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_extension", - "searchCriteriaExtension", - OCI.SearchCriteriaExtension, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_mobile_phone_number", - "searchCriteriaMobilePhoneNumber", - OCI.SearchCriteriaMobilePhoneNumber, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_email_address", - "searchCriteriaEmailAddress", - OCI.SearchCriteriaEmailAddress, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_exact_user_department", - "searchCriteriaExactUserDepartment", - OCI.SearchCriteriaExactUserDepartment, - is_complex=True, - ), - E( - "search_criteria_department_name", - "searchCriteriaDepartmentName", - OCI.SearchCriteriaDepartmentName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_exact_user_group", - "searchCriteriaExactUserGroup", - OCI.SearchCriteriaExactUserGroup, - is_complex=True, - ), - E( - "search_criteria_group_name", - "searchCriteriaGroupName", - OCI.SearchCriteriaGroupName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_yahoo_id", - "searchCriteriaYahooId", - OCI.SearchCriteriaYahooId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_id", - "searchCriteriaUserId", - OCI.SearchCriteriaUserId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_imp_id", - "searchCriteriaImpId", - OCI.SearchCriteriaImpId, - is_complex=True, - is_array=True, - ), - E("search_criteria_mode_or", "searchCriteriaModeOr", bool), - ) - - class EnterprisePreAlertingAnnouncementModifyRequest(OCIRequest): """ Modify the enterprise level pre-alerting service settings. @@ -115741,6 +107127,91 @@ def _elements(cls) -> Tuple[E, ...]: ) +class EnterpriseSessionAdmissionControlGetAvailableDeviceListRequest(OCIRequest): + """ + Request to get the list of devices can be assigned to session admission control group + for the enterprise. + + The response is either an + `EnterpriseSessionAdmissionControlGetAvailableDeviceListResponse()` or an + `ErrorResponse()`. + + Attributes: + service_provider_id (str): serviceProviderId + response_size_limit (int): responseSizeLimit *Optional* + search_criteria_device_name (List[OCI.searchCriteriaDeviceName]): + searchCriteriaDeviceName *Optional* + search_criteria_device_mac_address (List[OCI.searchCriteriaDeviceMACAddress]): + searchCriteriaDeviceMACAddress *Optional* + search_criteria_device_net_address (List[OCI.searchCriteriaDeviceNetAddress]): + searchCriteriaDeviceNetAddress *Optional* + search_criteria_group_id (List[OCI.searchCriteriaGroupId]): searchCriteriaGroupId + *Optional* + search_criteria_exact_device_type (OCI.searchCriteriaExactDeviceType): + searchCriteriaExactDeviceType *Optional* + search_criteria_exact_device_level (OCI.searchCriteriaExactDeviceLevel): + searchCriteriaExactDeviceLevel *Optional* + """ + + __slots__: List[str] = [ + "service_provider_id", + "response_size_limit", + "search_criteria_device_name", + "search_criteria_device_mac_address", + "search_criteria_device_net_address", + "search_criteria_group_id", + "search_criteria_exact_device_type", + "search_criteria_exact_device_level", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("service_provider_id", "serviceProviderId", str, is_required=True), + E("response_size_limit", "responseSizeLimit", int), + E( + "search_criteria_device_name", + "searchCriteriaDeviceName", + OCI.SearchCriteriaDeviceName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_device_mac_address", + "searchCriteriaDeviceMACAddress", + OCI.SearchCriteriaDeviceMACAddress, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_device_net_address", + "searchCriteriaDeviceNetAddress", + OCI.SearchCriteriaDeviceNetAddress, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_group_id", + "searchCriteriaGroupId", + OCI.SearchCriteriaGroupId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_exact_device_type", + "searchCriteriaExactDeviceType", + OCI.SearchCriteriaExactDeviceType, + is_complex=True, + ), + E( + "search_criteria_exact_device_level", + "searchCriteriaExactDeviceLevel", + OCI.SearchCriteriaExactDeviceLevel, + is_complex=True, + ), + ) + + class EnterpriseSessionAdmissionControlGroupAddDeviceListRequest(OCIRequest): """ Request to add one or more devices to an enterprise level session admission control @@ -116655,7 +108126,225 @@ def _elements(cls) -> Tuple[E, ...]: ) -class GroupAccessDeviceGetPagedSortedListRequest22(OCIRequest): +class EnterpriseVirtualOnNetEnterpriseExtensionsGetUserListRequest(OCIRequest): + """ + Request the list of Virtual On-Net users in an Enterprise. + + It is possible to search by various criteria to restrict the number of rows returned. + Multiple search criteria are logically ANDed together. + + The response is either a + `EnterpriseVirtualOnNetEnterpriseExtensionsGetUserListResponse()` or an + `ErrorResponse()`. + + Attributes: + service_provider_id (str): serviceProviderId + response_size_limit (int): responseSizeLimit *Optional* + search_criteria_user_last_name (List[OCI.searchCriteriaUserLastName]): + searchCriteriaUserLastName *Optional* + search_criteria_user_first_name (List[OCI.searchCriteriaUserFirstName]): + searchCriteriaUserFirstName *Optional* + search_criteria_dn (List[OCI.searchCriteriaDn]): searchCriteriaDn *Optional* + search_criteria_group_location_code (List[OCI.searchCriteriaGroupLocationCode]): + searchCriteriaGroupLocationCode *Optional* + search_criteria_extension (List[OCI.searchCriteriaExtension]): + searchCriteriaExtension *Optional* + search_criteria_exact_virtual_on_net_call_type_name + (OCI.searchCriteriaExactVirtualOnNetCallTypeName): + searchCriteriaExactVirtualOnNetCallTypeName *Optional* + """ + + __slots__: List[str] = [ + "service_provider_id", + "response_size_limit", + "search_criteria_user_last_name", + "search_criteria_user_first_name", + "search_criteria_dn", + "search_criteria_group_location_code", + "search_criteria_extension", + "search_criteria_exact_virtual_on_net_call_type_name", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("service_provider_id", "serviceProviderId", str, is_required=True), + E("response_size_limit", "responseSizeLimit", int), + E( + "search_criteria_user_last_name", + "searchCriteriaUserLastName", + OCI.SearchCriteriaUserLastName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_first_name", + "searchCriteriaUserFirstName", + OCI.SearchCriteriaUserFirstName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_dn", + "searchCriteriaDn", + OCI.SearchCriteriaDn, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_group_location_code", + "searchCriteriaGroupLocationCode", + OCI.SearchCriteriaGroupLocationCode, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_extension", + "searchCriteriaExtension", + OCI.SearchCriteriaExtension, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_exact_virtual_on_net_call_type_name", + "searchCriteriaExactVirtualOnNetCallTypeName", + OCI.SearchCriteriaExactVirtualOnNetCallTypeName, + is_complex=True, + ), + ) + + +class EnterpriseVoiceVPNGetPolicyListRequest(OCIRequest): + """ + Request the list of Voice VPN locations. + + It is possible to search by various criteria to restrict the number of rows returned. + Multiple search criteria are logically ANDed together. + + The response is either a `EnterpriseVoiceVPNGetPolicyListResponse()` or an + `ErrorResponse()`. + + Attributes: + service_provider_id (str): serviceProviderId + response_size_limit (int): responseSizeLimit *Optional* + search_criteria_group_location_code (List[OCI.searchCriteriaGroupLocationCode]): + searchCriteriaGroupLocationCode *Optional* + search_criteria_exact_policy_selection (OCI.searchCriteriaExactPolicySelection): + searchCriteriaExactPolicySelection *Optional* + """ + + __slots__: List[str] = [ + "service_provider_id", + "response_size_limit", + "search_criteria_group_location_code", + "search_criteria_exact_policy_selection", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("service_provider_id", "serviceProviderId", str, is_required=True), + E("response_size_limit", "responseSizeLimit", int), + E( + "search_criteria_group_location_code", + "searchCriteriaGroupLocationCode", + OCI.SearchCriteriaGroupLocationCode, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_exact_policy_selection", + "searchCriteriaExactPolicySelection", + OCI.SearchCriteriaExactPolicySelection, + is_complex=True, + ), + ) + + +class GroupAccessDeviceGetListRequest(OCIRequest): + """ + Requests the list of access devices in a group. + + The following elements are only used in AS data mode and ignored in XS data mode: + groupExternalId + + The response is either `GroupAccessDeviceGetListResponse()` or `ErrorResponse()`. + + Attributes: + service_provider_id (str): serviceProviderId *Optional* + group_id (str): groupId *Optional* + group_external_id (str): groupExternalId *Optional* + response_size_limit (int): responseSizeLimit *Optional* + search_criteria_device_name (List[OCI.searchCriteriaDeviceName]): + searchCriteriaDeviceName *Optional* + search_criteria_device_mac_address (List[OCI.searchCriteriaDeviceMACAddress]): + searchCriteriaDeviceMACAddress *Optional* + search_criteria_device_net_address (List[OCI.searchCriteriaDeviceNetAddress]): + searchCriteriaDeviceNetAddress *Optional* + search_criteria_exact_device_type (OCI.searchCriteriaExactDeviceType): + searchCriteriaExactDeviceType *Optional* + search_criteria_access_device_version + (List[OCI.searchCriteriaAccessDeviceVersion]): + searchCriteriaAccessDeviceVersion *Optional* + """ + + __slots__: List[str] = [ + "service_provider_id", + "group_id", + "group_external_id", + "response_size_limit", + "search_criteria_device_name", + "search_criteria_device_mac_address", + "search_criteria_device_net_address", + "search_criteria_exact_device_type", + "search_criteria_access_device_version", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("service_provider_id", "serviceProviderId", str), + E("group_id", "groupId", str), + E("group_external_id", "groupExternalId", str), + E("response_size_limit", "responseSizeLimit", int), + E( + "search_criteria_device_name", + "searchCriteriaDeviceName", + OCI.SearchCriteriaDeviceName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_device_mac_address", + "searchCriteriaDeviceMACAddress", + OCI.SearchCriteriaDeviceMACAddress, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_device_net_address", + "searchCriteriaDeviceNetAddress", + OCI.SearchCriteriaDeviceNetAddress, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_exact_device_type", + "searchCriteriaExactDeviceType", + OCI.SearchCriteriaExactDeviceType, + is_complex=True, + ), + E( + "search_criteria_access_device_version", + "searchCriteriaAccessDeviceVersion", + OCI.SearchCriteriaAccessDeviceVersion, + is_complex=True, + is_array=True, + ), + ) + + +class GroupAccessDeviceGetPagedSortedListRequest(OCIRequest): """ Requests the list of access devices in a group. @@ -116671,15 +108360,20 @@ class GroupAccessDeviceGetPagedSortedListRequest22(OCIRequest): set to empty. If the getVisualDeviceManagementAPIDevicesOnly element is set to true, only SIP devices supporting Visual Device Management API are returned. If the getVisualDeviceManagementAPIDevicesOnly element is set to false, all SIP devices are - returned with their current Visual Device Management API flag value. + returned with their current Visual Device Management API flag value. Replaced by + `GroupAccessDeviceGetPagedSortedListRequest22()`. Attributes: service_provider_id (str): serviceProviderId group_id (str): groupId - include_total_number_of_rows (bool): includeTotalNumberOfRows *Optional* response_paging_control (OCI.responsePagingControl): responsePagingControl *Optional* - sort_order (List[OCI.sortOrder]): sortOrder *Optional* + sort_by_device_name (OCI.sortByDeviceName): sortByDeviceName *Optional* + sort_by_device_type (OCI.sortByDeviceType): sortByDeviceType *Optional* + sort_by_device_net_address (OCI.sortByDeviceNetAddress): sortByDeviceNetAddress + *Optional* + sort_by_device_mac_address (OCI.sortByDeviceMACAddress): sortByDeviceMACAddress + *Optional* search_criteria_device_name (List[OCI.searchCriteriaDeviceName]): searchCriteriaDeviceName *Optional* search_criteria_device_mac_address (List[OCI.searchCriteriaDeviceMACAddress]): @@ -116699,9 +108393,11 @@ class GroupAccessDeviceGetPagedSortedListRequest22(OCIRequest): __slots__: List[str] = [ "service_provider_id", "group_id", - "include_total_number_of_rows", "response_paging_control", - "sort_order", + "sort_by_device_name", + "sort_by_device_type", + "sort_by_device_net_address", + "sort_by_device_mac_address", "search_criteria_device_name", "search_criteria_device_mac_address", "search_criteria_device_net_address", @@ -116716,7 +108412,6 @@ def _elements(cls) -> Tuple[E, ...]: return ( E("service_provider_id", "serviceProviderId", str, is_required=True), E("group_id", "groupId", str, is_required=True), - E("include_total_number_of_rows", "includeTotalNumberOfRows", bool), E( "response_paging_control", "responsePagingControl", @@ -116724,11 +108419,28 @@ def _elements(cls) -> Tuple[E, ...]: is_complex=True, ), E( - "sort_order", - "sortOrder", - OCI.SortOrderGroupAccessDeviceGetPagedSortedList, + "sort_by_device_name", + "sortByDeviceName", + OCI.SortByDeviceName, + is_complex=True, + ), + E( + "sort_by_device_type", + "sortByDeviceType", + OCI.SortByDeviceType, + is_complex=True, + ), + E( + "sort_by_device_net_address", + "sortByDeviceNetAddress", + OCI.SortByDeviceNetAddress, + is_complex=True, + ), + E( + "sort_by_device_mac_address", + "sortByDeviceMACAddress", + OCI.SortByDeviceMACAddress, is_complex=True, - is_array=True, ), E( "search_criteria_device_name", @@ -117167,176 +108879,118 @@ def _elements(cls) -> Tuple[E, ...]: ) -class GroupAdminGetPagedSortedListRequest(OCIRequest): +class GroupAnnouncementFileGetListRequest(OCIRequest): """ - Get a list of group and department administrators within the group. + Get the list of available announcement files for a Group. - The response is either a `GroupAdminGetPagedSortedListResponse()` or an - `ErrorResponse()`. If no sort criterion is included, the response is sorted by - administrator id ascending by default. If the responsePagingControl element is not - provided, the paging startIndex will be set to 1 by default, and the responsePageSize - will be set to the maximum responsePageSize by default. Multiple search criteria are - logically ANDed together unless the searchCriteriaModeOr option is included. Then the - search criteria are logically ORed together. + The following elements are only used in AS data mode and ignored in XS data mode: + groupExternalId + + The response is either a `GroupAnnouncementFileGetListResponse()` or an + `ErrorResponse()`. Attributes: - service_provider_id (str): serviceProviderId - group_id (str): groupId - response_paging_control (OCI.responsePagingControl): responsePagingControl - *Optional* - sort_order (List[OCI.sortOrder]): sortOrder *Optional* - search_criteria_admin_id (List[OCI.searchCriteriaAdminId]): searchCriteriaAdminId - *Optional* - search_criteria_admin_last_name (List[OCI.searchCriteriaAdminLastName]): - searchCriteriaAdminLastName *Optional* - search_criteria_admin_first_name (List[OCI.searchCriteriaAdminFirstName]): - searchCriteriaAdminFirstName *Optional* - search_criteria_exact_group_admin_type - (List[OCI.searchCriteriaExactGroupAdminType]): - searchCriteriaExactGroupAdminType *Optional* - search_criteria_language (List[OCI.searchCriteriaLanguage]): - searchCriteriaLanguage *Optional* - search_criteria_department_name (List[OCI.searchCriteriaDepartmentName]): - searchCriteriaDepartmentName *Optional* - search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* + service_provider_id (str): serviceProviderId *Optional* + group_id (str): groupId *Optional* + group_external_id (str): groupExternalId *Optional* + announcement_file_type (str): announcementFileType *Optional* + include_announcement_table (bool): includeAnnouncementTable + response_size_limit (int): responseSizeLimit *Optional* + search_criteria_announcement_file_name + (List[OCI.searchCriteriaAnnouncementFileName]): + searchCriteriaAnnouncementFileName *Optional* """ __slots__: List[str] = [ "service_provider_id", "group_id", - "response_paging_control", - "sort_order", - "search_criteria_admin_id", - "search_criteria_admin_last_name", - "search_criteria_admin_first_name", - "search_criteria_exact_group_admin_type", - "search_criteria_language", - "search_criteria_department_name", - "search_criteria_mode_or", + "group_external_id", + "announcement_file_type", + "include_announcement_table", + "response_size_limit", + "search_criteria_announcement_file_name", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("service_provider_id", "serviceProviderId", str, is_required=True), - E("group_id", "groupId", str, is_required=True), - E( - "response_paging_control", - "responsePagingControl", - OCI.ResponsePagingControl, - is_complex=True, - ), - E( - "sort_order", - "sortOrder", - OCI.SortOrderGroupAdminGetPagedSortedList, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_admin_id", - "searchCriteriaAdminId", - OCI.SearchCriteriaAdminId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_admin_last_name", - "searchCriteriaAdminLastName", - OCI.SearchCriteriaAdminLastName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_admin_first_name", - "searchCriteriaAdminFirstName", - OCI.SearchCriteriaAdminFirstName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_exact_group_admin_type", - "searchCriteriaExactGroupAdminType", - OCI.SearchCriteriaExactGroupAdminType, - is_complex=True, - is_array=True, - ), + E("service_provider_id", "serviceProviderId", str), + E("group_id", "groupId", str), + E("group_external_id", "groupExternalId", str), + E("announcement_file_type", "announcementFileType", str), E( - "search_criteria_language", - "searchCriteriaLanguage", - OCI.SearchCriteriaLanguage, - is_complex=True, - is_array=True, + "include_announcement_table", + "includeAnnouncementTable", + bool, + is_required=True, ), + E("response_size_limit", "responseSizeLimit", int), E( - "search_criteria_department_name", - "searchCriteriaDepartmentName", - OCI.SearchCriteriaDepartmentName, + "search_criteria_announcement_file_name", + "searchCriteriaAnnouncementFileName", + OCI.SearchCriteriaAnnouncementFileName, is_complex=True, is_array=True, ), - E("search_criteria_mode_or", "searchCriteriaModeOr", bool), ) -class GroupAutoAttendantGetInstancePagedSortedListRequest(OCIRequest): +class GroupAnnouncementFileGetPagedSortedListRequest(OCIRequest): """ - Get a list of Auto Attendant instances within a group. + Get the list of available announcement files for a Group. - The response is either `GroupAutoAttendantGetInstancePagedSortedListResponse()` or - `ErrorResponse()`. If no sortOrder is included the response is sorted by Name - ascending by default. A limitation to the search by DN activation exists when the - Number Activation mode is set to Off. In this case DNs not assigned to users are - never returned by queries with the "dnActivationSearchCriteria" included. If the - responsePagingControl element is not provided, the paging startIndex will be set to 1 - by default, and the responsePageSize will be set to the maximum responsePageSize by - default. Multiple search criteria are logically ANDed together unless the - searchCriteriaModeOr option is included. Then the search criteria are logically ORed - together. + If the responsePagingControl element is not provided, the paging startIndex will be + set to 1 by default, and the responsePageSize will be set to the maximum + responsePageSize by default. If no sortOrder is included, the response is sorted by + Name ascending by default. Multiple search criteria are logically ANDed together + unless the searchCriteriaModeOr option is included. Then the search criteria are + logically ORed together. The following elements are only used in AS data mode and + ignored in XS data mode: groupExternalId + + The response is either a `GroupAnnouncementFileGetPagedSortedListResponse()` or an + `ErrorResponse()`. Attributes: - service_provider_id (str): serviceProviderId - group_id (str): groupId + service_provider_id (str): serviceProviderId *Optional* + group_id (str): groupId *Optional* + group_external_id (str): groupExternalId *Optional* response_paging_control (OCI.responsePagingControl): responsePagingControl *Optional* - sort_order (List[OCI.sortOrder]): sortOrder *Optional* - search_criteria_user_id (List[OCI.searchCriteriaUserId]): searchCriteriaUserId + sort_by_announcement_file_name (OCI.sortByAnnouncementFileName): + sortByAnnouncementFileName *Optional* + sort_by_announcement_file_size (OCI.sortByAnnouncementFileSize): + sortByAnnouncementFileSize *Optional* + search_criteria_announcement_file_name + (List[OCI.searchCriteriaAnnouncementFileName]): + searchCriteriaAnnouncementFileName *Optional* + search_criteria_exact_announcement_file_type + (OCI.searchCriteriaExactAnnouncementFileType): + searchCriteriaExactAnnouncementFileType *Optional* + search_criteria_exact_media_file_type + (List[OCI.searchCriteriaExactMediaFileType]): searchCriteriaExactMediaFileType *Optional* - search_criteria_user_last_name (List[OCI.searchCriteriaUserLastName]): - searchCriteriaUserLastName *Optional* - search_criteria_dn (List[OCI.searchCriteriaDn]): searchCriteriaDn *Optional* - search_criteria_extension (List[OCI.searchCriteriaExtension]): - searchCriteriaExtension *Optional* - search_criteria_exact_dn_activation (OCI.searchCriteriaExactDnActivation): - searchCriteriaExactDnActivation *Optional* - search_criteria_service_status (OCI.searchCriteriaServiceStatus): - searchCriteriaServiceStatus *Optional* - search_criteria_exact_auto_attendant_type - (OCI.searchCriteriaExactAutoAttendantType): - searchCriteriaExactAutoAttendantType *Optional* search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* """ __slots__: List[str] = [ "service_provider_id", "group_id", + "group_external_id", "response_paging_control", - "sort_order", - "search_criteria_user_id", - "search_criteria_user_last_name", - "search_criteria_dn", - "search_criteria_extension", - "search_criteria_exact_dn_activation", - "search_criteria_service_status", - "search_criteria_exact_auto_attendant_type", + "sort_by_announcement_file_name", + "sort_by_announcement_file_size", + "search_criteria_announcement_file_name", + "search_criteria_exact_announcement_file_type", + "search_criteria_exact_media_file_type", "search_criteria_mode_or", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("service_provider_id", "serviceProviderId", str, is_required=True), - E("group_id", "groupId", str, is_required=True), + E("service_provider_id", "serviceProviderId", str), + E("group_id", "groupId", str), + E("group_external_id", "groupExternalId", str), E( "response_paging_control", "responsePagingControl", @@ -117344,58 +108998,37 @@ def _elements(cls) -> Tuple[E, ...]: is_complex=True, ), E( - "sort_order", - "sortOrder", - OCI.SortOrderGroupAutoAttendantGetInstancePagedSortedList, + "sort_by_announcement_file_name", + "sortByAnnouncementFileName", + OCI.SortByAnnouncementFileName, is_complex=True, - is_array=True, ), E( - "search_criteria_user_id", - "searchCriteriaUserId", - OCI.SearchCriteriaUserId, + "sort_by_announcement_file_size", + "sortByAnnouncementFileSize", + OCI.SortByAnnouncementFileSize, is_complex=True, - is_array=True, ), E( - "search_criteria_user_last_name", - "searchCriteriaUserLastName", - OCI.SearchCriteriaUserLastName, + "search_criteria_announcement_file_name", + "searchCriteriaAnnouncementFileName", + OCI.SearchCriteriaAnnouncementFileName, is_complex=True, is_array=True, ), E( - "search_criteria_dn", - "searchCriteriaDn", - OCI.SearchCriteriaDn, + "search_criteria_exact_announcement_file_type", + "searchCriteriaExactAnnouncementFileType", + OCI.SearchCriteriaExactAnnouncementFileType, is_complex=True, - is_array=True, ), E( - "search_criteria_extension", - "searchCriteriaExtension", - OCI.SearchCriteriaExtension, + "search_criteria_exact_media_file_type", + "searchCriteriaExactMediaFileType", + OCI.SearchCriteriaExactMediaFileType, is_complex=True, is_array=True, ), - E( - "search_criteria_exact_dn_activation", - "searchCriteriaExactDnActivation", - OCI.SearchCriteriaExactDnActivation, - is_complex=True, - ), - E( - "search_criteria_service_status", - "searchCriteriaServiceStatus", - OCI.SearchCriteriaServiceStatus, - is_complex=True, - ), - E( - "search_criteria_exact_auto_attendant_type", - "searchCriteriaExactAutoAttendantType", - OCI.SearchCriteriaExactAutoAttendantType, - is_complex=True, - ), E("search_criteria_mode_or", "searchCriteriaModeOr", bool), ) @@ -119104,286 +110737,6 @@ def _elements(cls) -> Tuple[E, ...]: ) -class GroupCallCenterAgentThresholdProfileGetAvailableAgentPagedSortedListRequest( - OCIRequest, -): - """ - Get the list of all Agents in the Group that can be assigned to a given Call Center - Agent Threshold Profile in a Group. - - An agent is available to be assigned to a given Agent Threshold Profile if it is a - Call Center Standard or Call Center Premium agent and the agent is not yet assigned to - the profile. If the responsePagingControl element is not provided, the paging - startIndex will be set to 1 by default, and the responsePageSize will be set to the - maximum ResponsePageSize by default. It is possible to search by various criteria to - restrict the number of rows returned. The available agent list for a new Call Center - Agent Threshold profile can be obtained by not setting the - excludeAgentsAssignedToProfileName. When the excludeAgentsAssignedToProfileName is - specified, all agents already assigned to the specified profile are not included in - the response, even if the search criterion element searchCriteriaAgentThresholdProfile - is specified using the same profile name. If no sortOrder is included the response is - sorted by User Id ascending by default. Multiple search criteria are logically ANDed - together unless the searchCriteriaModeOr option is included. Then the search criteria - are logically ORed together. - - The response is either a - `GroupCallCenterAgentThresholdProfileGetAvailableAgentPagedSortedListResponse()` or an - `ErrorResponse()`. - - Attributes: - service_provider_id (str): serviceProviderId - group_id (str): groupId - exclude_agents_assigned_to_profile_name (str): excludeAgentsAssignedToProfileName - *Optional* - response_paging_control (OCI.responsePagingControl): responsePagingControl - *Optional* - sort_order (List[OCI.sortOrder]): sortOrder *Optional* - search_criteria_user_id (List[OCI.searchCriteriaUserId]): searchCriteriaUserId - *Optional* - search_criteria_user_last_name (List[OCI.searchCriteriaUserLastName]): - searchCriteriaUserLastName *Optional* - search_criteria_user_first_name (List[OCI.searchCriteriaUserFirstName]): - searchCriteriaUserFirstName *Optional* - search_criteria_dn (List[OCI.searchCriteriaDn]): searchCriteriaDn *Optional* - search_criteria_extension (List[OCI.searchCriteriaExtension]): - searchCriteriaExtension *Optional* - search_criteria_department_name (List[OCI.searchCriteriaDepartmentName]): - searchCriteriaDepartmentName *Optional* - search_criteria_email_address (List[OCI.searchCriteriaEmailAddress]): - searchCriteriaEmailAddress *Optional* - search_criteria_agent_threshold_profile - (List[OCI.searchCriteriaAgentThresholdProfile]): - searchCriteriaAgentThresholdProfile *Optional* - search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* - """ - - __slots__: List[str] = [ - "service_provider_id", - "group_id", - "exclude_agents_assigned_to_profile_name", - "response_paging_control", - "sort_order", - "search_criteria_user_id", - "search_criteria_user_last_name", - "search_criteria_user_first_name", - "search_criteria_dn", - "search_criteria_extension", - "search_criteria_department_name", - "search_criteria_email_address", - "search_criteria_agent_threshold_profile", - "search_criteria_mode_or", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("service_provider_id", "serviceProviderId", str, is_required=True), - E("group_id", "groupId", str, is_required=True), - E( - "exclude_agents_assigned_to_profile_name", - "excludeAgentsAssignedToProfileName", - str, - ), - E( - "response_paging_control", - "responsePagingControl", - OCI.ResponsePagingControl, - is_complex=True, - ), - E( - "sort_order", - "sortOrder", - OCI.SortOrderGroupCallCenterAgentThresholdProfileGetAvailableAgentPagedSortedList, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_id", - "searchCriteriaUserId", - OCI.SearchCriteriaUserId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_last_name", - "searchCriteriaUserLastName", - OCI.SearchCriteriaUserLastName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_first_name", - "searchCriteriaUserFirstName", - OCI.SearchCriteriaUserFirstName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_dn", - "searchCriteriaDn", - OCI.SearchCriteriaDn, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_extension", - "searchCriteriaExtension", - OCI.SearchCriteriaExtension, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_department_name", - "searchCriteriaDepartmentName", - OCI.SearchCriteriaDepartmentName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_email_address", - "searchCriteriaEmailAddress", - OCI.SearchCriteriaEmailAddress, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_agent_threshold_profile", - "searchCriteriaAgentThresholdProfile", - OCI.SearchCriteriaAgentThresholdProfile, - is_complex=True, - is_array=True, - ), - E("search_criteria_mode_or", "searchCriteriaModeOr", bool), - ) - - -class GroupCallCenterAgentThresholdProfileGetPagedSortedRequest(OCIRequest): - """ - Gets an existing non-default Call Center Agent Threshold Profile in a Group. - - If the responsePagingControl element is not provided, the paging startIndex will be - set to 1 by default, and the responsePageSize will be set to the maximum - ResponsePageSize by default. It is possible to search by various criteria to restrict - the number of rows returned. If no sortOrder is included the response is sorted by - User Id ascending by default. Multiple search criteria are logically ANDed together - unless the searchCriteriaModeOr option is included. Then the search criteria are - logically ORed together. - - The response is either a - `GroupCallCenterAgentThresholdProfileGetPagedSortedResponse()` or an - `ErrorResponse()`. - - Attributes: - service_provider_id (str): serviceProviderId - group_id (str): groupId - profile_name (str): profileName - response_paging_control (OCI.responsePagingControl): responsePagingControl - *Optional* - sort_order (List[OCI.sortOrder]): sortOrder *Optional* - search_criteria_user_id (List[OCI.searchCriteriaUserId]): searchCriteriaUserId - *Optional* - search_criteria_user_last_name (List[OCI.searchCriteriaUserLastName]): - searchCriteriaUserLastName *Optional* - search_criteria_user_first_name (List[OCI.searchCriteriaUserFirstName]): - searchCriteriaUserFirstName *Optional* - search_criteria_dn (List[OCI.searchCriteriaDn]): searchCriteriaDn *Optional* - search_criteria_extension (List[OCI.searchCriteriaExtension]): - searchCriteriaExtension *Optional* - search_criteria_department_name (List[OCI.searchCriteriaDepartmentName]): - searchCriteriaDepartmentName *Optional* - search_criteria_email_address (List[OCI.searchCriteriaEmailAddress]): - searchCriteriaEmailAddress *Optional* - search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* - """ - - __slots__: List[str] = [ - "service_provider_id", - "group_id", - "profile_name", - "response_paging_control", - "sort_order", - "search_criteria_user_id", - "search_criteria_user_last_name", - "search_criteria_user_first_name", - "search_criteria_dn", - "search_criteria_extension", - "search_criteria_department_name", - "search_criteria_email_address", - "search_criteria_mode_or", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("service_provider_id", "serviceProviderId", str, is_required=True), - E("group_id", "groupId", str, is_required=True), - E("profile_name", "profileName", str, is_required=True), - E( - "response_paging_control", - "responsePagingControl", - OCI.ResponsePagingControl, - is_complex=True, - ), - E( - "sort_order", - "sortOrder", - OCI.SortOrderGroupCallCenterAgentThresholdProfileGetPagedSorted, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_id", - "searchCriteriaUserId", - OCI.SearchCriteriaUserId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_last_name", - "searchCriteriaUserLastName", - OCI.SearchCriteriaUserLastName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_first_name", - "searchCriteriaUserFirstName", - OCI.SearchCriteriaUserFirstName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_dn", - "searchCriteriaDn", - OCI.SearchCriteriaDn, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_extension", - "searchCriteriaExtension", - OCI.SearchCriteriaExtension, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_department_name", - "searchCriteriaDepartmentName", - OCI.SearchCriteriaDepartmentName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_email_address", - "searchCriteriaEmailAddress", - OCI.SearchCriteriaEmailAddress, - is_complex=True, - is_array=True, - ), - E("search_criteria_mode_or", "searchCriteriaModeOr", bool), - ) - - class GroupCallCenterComfortMessageBypassModifyRequest(OCIRequest): """ Modify a call center's comfort message bypass settings. @@ -119611,6 +110964,123 @@ def _elements(cls) -> Tuple[E, ...]: ) +class GroupCallCenterCurrentAndPastAgentGetListRequest(OCIRequest): + """ + Request to get all the current and past agents for the group. + + The response is either `GroupCallCenterCurrentAndPastAgentGetListResponse()` or + `ErrorResponse()`. + + Attributes: + service_provider_id (str): serviceProviderId + group_id (str): groupId + response_size_limit (int): responseSizeLimit *Optional* + search_criteria_user_last_name (List[OCI.searchCriteriaUserLastName]): + searchCriteriaUserLastName *Optional* + search_criteria_user_first_name (List[OCI.searchCriteriaUserFirstName]): + searchCriteriaUserFirstName *Optional* + search_criteria_user_id (List[OCI.searchCriteriaUserId]): searchCriteriaUserId + *Optional* + search_criteria_dn (List[OCI.searchCriteriaDn]): searchCriteriaDn *Optional* + search_criteria_extension (List[OCI.searchCriteriaExtension]): + searchCriteriaExtension *Optional* + """ + + __slots__: List[str] = [ + "service_provider_id", + "group_id", + "response_size_limit", + "search_criteria_user_last_name", + "search_criteria_user_first_name", + "search_criteria_user_id", + "search_criteria_dn", + "search_criteria_extension", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("service_provider_id", "serviceProviderId", str, is_required=True), + E("group_id", "groupId", str, is_required=True), + E("response_size_limit", "responseSizeLimit", int), + E( + "search_criteria_user_last_name", + "searchCriteriaUserLastName", + OCI.SearchCriteriaUserLastName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_first_name", + "searchCriteriaUserFirstName", + OCI.SearchCriteriaUserFirstName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_id", + "searchCriteriaUserId", + OCI.SearchCriteriaUserId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_dn", + "searchCriteriaDn", + OCI.SearchCriteriaDn, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_extension", + "searchCriteriaExtension", + OCI.SearchCriteriaExtension, + is_complex=True, + is_array=True, + ), + ) + + +class GroupCallCenterCurrentAndPastCallCenterGetListRequest(OCIRequest): + """ + Request to get all the current and past call centers for the group. + + The response is either `GroupCallCenterCurrentAndPastCallCenterGetListResponse()` or + `ErrorResponse()`. + + Attributes: + service_provider_id (str): serviceProviderId + is_premium_only (bool): isPremiumOnly *Optional* + group_id (str): groupId + response_size_limit (int): responseSizeLimit *Optional* + search_criteria_call_center_name (OCI.searchCriteriaCallCenterName): + searchCriteriaCallCenterName *Optional* + """ + + __slots__: List[str] = [ + "service_provider_id", + "is_premium_only", + "group_id", + "response_size_limit", + "search_criteria_call_center_name", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("service_provider_id", "serviceProviderId", str, is_required=True), + E("is_premium_only", "isPremiumOnly", bool), + E("group_id", "groupId", str, is_required=True), + E("response_size_limit", "responseSizeLimit", int), + E( + "search_criteria_call_center_name", + "searchCriteriaCallCenterName", + OCI.SearchCriteriaCallCenterName, + is_complex=True, + ), + ) + + class GroupCallCenterEnhancedReportingScheduledReportGetActiveListRequest(OCIRequest): """ Request to get a list of active group level call center reporting scheduled reports. @@ -120108,132 +111578,27 @@ def _elements(cls) -> Tuple[E, ...]: ) -class GroupCallCenterGetAvailableAgentListRequest(OCIRequest): - """ - Get a list of users that can be assigned as agents to a given type of Call Center. - - Searching for users by group only makes sense when the call center is part of an - Enterprise. - - The response is either `GroupCallCenterGetAvailableAgentListResponse()` or - `ErrorResponse()`. - - Attributes: - service_provider_id (str): serviceProviderId - group_id (str): groupId - call_center_type (str): callCenterType - response_size_limit (int): responseSizeLimit *Optional* - search_criteria_user_last_name (List[OCI.searchCriteriaUserLastName]): - searchCriteriaUserLastName *Optional* - search_criteria_user_first_name (List[OCI.searchCriteriaUserFirstName]): - searchCriteriaUserFirstName *Optional* - search_criteria_exact_user_department (OCI.searchCriteriaExactUserDepartment): - searchCriteriaExactUserDepartment *Optional* - search_criteria_exact_user_group (OCI.searchCriteriaExactUserGroup): - searchCriteriaExactUserGroup *Optional* - search_criteria_user_id (List[OCI.searchCriteriaUserId]): searchCriteriaUserId - *Optional* - search_criteria_dn (List[OCI.searchCriteriaDn]): searchCriteriaDn *Optional* - search_criteria_extension (List[OCI.searchCriteriaExtension]): - searchCriteriaExtension *Optional* - """ - - __slots__: List[str] = [ - "service_provider_id", - "group_id", - "call_center_type", - "response_size_limit", - "search_criteria_user_last_name", - "search_criteria_user_first_name", - "search_criteria_exact_user_department", - "search_criteria_exact_user_group", - "search_criteria_user_id", - "search_criteria_dn", - "search_criteria_extension", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("service_provider_id", "serviceProviderId", str, is_required=True), - E("group_id", "groupId", str, is_required=True), - E("call_center_type", "callCenterType", str, is_required=True), - E("response_size_limit", "responseSizeLimit", int), - E( - "search_criteria_user_last_name", - "searchCriteriaUserLastName", - OCI.SearchCriteriaUserLastName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_first_name", - "searchCriteriaUserFirstName", - OCI.SearchCriteriaUserFirstName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_exact_user_department", - "searchCriteriaExactUserDepartment", - OCI.SearchCriteriaExactUserDepartment, - is_complex=True, - ), - E( - "search_criteria_exact_user_group", - "searchCriteriaExactUserGroup", - OCI.SearchCriteriaExactUserGroup, - is_complex=True, - ), - E( - "search_criteria_user_id", - "searchCriteriaUserId", - OCI.SearchCriteriaUserId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_dn", - "searchCriteriaDn", - OCI.SearchCriteriaDn, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_extension", - "searchCriteriaExtension", - OCI.SearchCriteriaExtension, - is_complex=True, - is_array=True, - ), - ) - - -class GroupCallCenterGetAvailableAgentPagedSortedListRequest(OCIRequest): +class GroupCallCenterGetAgentPagedSortedListRequest(OCIRequest): """ - Get a list of users that can be assigned as agents to a given type of Call Center. + Get a list of agents assigned to a call center. - Searching for users by group only makes sense when the call center is part of an - Enterprise. If the responsePagingControl element is not provided, the paging - startIndex will be set to 1 by default, and the responsePageSize will be set to the - maximum ResponsePageSize by default. It is possible to search by various criteria to - restrict the number of rows returned. If no sortOrder is included the response is - sorted by User Id ascending by default. Multiple search criteria are logically ANDed - together unless the searchCriteriaModeOr option is included. Then the search criteria - are logically ORed together. `ErrorResponse()` is returned if - searchCriteriaExactUserGroup has multiple entries and searchCriteriaModeOr is not - included. + If the responsePagingControl element is not provided, the paging startIndex will be + set to 1 by default, and the responsePageSize will be set to the maximum + ResponsePageSize by default. It is possible to search by various criteria to restrict + the number of rows returned. Multiple search criteria are logically ANDed together + unless the searchCriteriaModeOr option is included. Then the search criteria are + logically ORed together. `ErrorResponse()` is returned if + searchCriteriaExactUserGroup or searchCriteriaExactSkillLevel have multiple entries + and searchCriteriaModeOr is not included. Sorting is done on either a priority basis + or a skill basis depending on the type of call center. - The response is either `GroupCallCenterGetAvailableAgentPagedSortedListResponse()` or + The response is either a `GroupCallCenterGetAgentPagedSortedListResponse()` or an `ErrorResponse()`. Attributes: - service_provider_id (str): serviceProviderId - group_id (str): groupId - call_center_type (str): callCenterType + service_user_id (str): serviceUserId response_paging_control (OCI.responsePagingControl): responsePagingControl *Optional* - sort_order (List[OCI.sortOrder]): sortOrder *Optional* search_criteria_user_id (List[OCI.searchCriteriaUserId]): searchCriteriaUserId *Optional* search_criteria_user_last_name (List[OCI.searchCriteriaUserLastName]): @@ -120247,17 +111612,16 @@ class GroupCallCenterGetAvailableAgentPagedSortedListRequest(OCIRequest): searchCriteriaDepartmentName *Optional* search_criteria_email_address (List[OCI.searchCriteriaEmailAddress]): searchCriteriaEmailAddress *Optional* + search_criteria_exact_skill_level (List[OCI.searchCriteriaExactSkillLevel]): + searchCriteriaExactSkillLevel *Optional* search_criteria_exact_user_group (List[OCI.searchCriteriaExactUserGroup]): searchCriteriaExactUserGroup *Optional* search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* """ __slots__: List[str] = [ - "service_provider_id", - "group_id", - "call_center_type", + "service_user_id", "response_paging_control", - "sort_order", "search_criteria_user_id", "search_criteria_user_last_name", "search_criteria_user_first_name", @@ -120265,6 +111629,7 @@ class GroupCallCenterGetAvailableAgentPagedSortedListRequest(OCIRequest): "search_criteria_extension", "search_criteria_department_name", "search_criteria_email_address", + "search_criteria_exact_skill_level", "search_criteria_exact_user_group", "search_criteria_mode_or", ] @@ -120272,22 +111637,13 @@ class GroupCallCenterGetAvailableAgentPagedSortedListRequest(OCIRequest): @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("service_provider_id", "serviceProviderId", str, is_required=True), - E("group_id", "groupId", str, is_required=True), - E("call_center_type", "callCenterType", str, is_required=True), + E("service_user_id", "serviceUserId", str, is_required=True), E( "response_paging_control", "responsePagingControl", OCI.ResponsePagingControl, is_complex=True, ), - E( - "sort_order", - "sortOrder", - OCI.SortOrderGroupCallCenterGetAvailableAgentPagedSortedList, - is_complex=True, - is_array=True, - ), E( "search_criteria_user_id", "searchCriteriaUserId", @@ -120337,6 +111693,13 @@ def _elements(cls) -> Tuple[E, ...]: is_complex=True, is_array=True, ), + E( + "search_criteria_exact_skill_level", + "searchCriteriaExactSkillLevel", + OCI.SearchCriteriaExactSkillLevel, + is_complex=True, + is_array=True, + ), E( "search_criteria_exact_user_group", "searchCriteriaExactUserGroup", @@ -120348,19 +111711,20 @@ def _elements(cls) -> Tuple[E, ...]: ) -class GroupCallCenterGetAvailableSupervisorListRequest(OCIRequest): +class GroupCallCenterGetAvailableAgentListRequest(OCIRequest): """ - Get a list of users that can be assigned as supervisors to a Call Center. + Get a list of users that can be assigned as agents to a given type of Call Center. Searching for users by group only makes sense when the call center is part of an Enterprise. - The response is either `GroupCallCenterGetAvailableSupervisorListResponse()` or + The response is either `GroupCallCenterGetAvailableAgentListResponse()` or `ErrorResponse()`. Attributes: service_provider_id (str): serviceProviderId group_id (str): groupId + call_center_type (str): callCenterType response_size_limit (int): responseSizeLimit *Optional* search_criteria_user_last_name (List[OCI.searchCriteriaUserLastName]): searchCriteriaUserLastName *Optional* @@ -120380,6 +111744,7 @@ class GroupCallCenterGetAvailableSupervisorListRequest(OCIRequest): __slots__: List[str] = [ "service_provider_id", "group_id", + "call_center_type", "response_size_limit", "search_criteria_user_last_name", "search_criteria_user_first_name", @@ -120395,6 +111760,7 @@ def _elements(cls) -> Tuple[E, ...]: return ( E("service_provider_id", "serviceProviderId", str, is_required=True), E("group_id", "groupId", str, is_required=True), + E("call_center_type", "callCenterType", str, is_required=True), E("response_size_limit", "responseSizeLimit", int), E( "search_criteria_user_last_name", @@ -120446,19 +111812,16 @@ def _elements(cls) -> Tuple[E, ...]: ) -class GroupCallCenterGetAvailableUserListRequest(OCIRequest): +class GroupCallCenterGetAvailableSupervisorListRequest(OCIRequest): """ - Get a list of users that can be assigned to a Call Center group. + Get a list of users that can be assigned as supervisors to a Call Center. Searching for users by group only makes sense when the call center is part of an Enterprise. - The response is either `GroupCallCenterGetAvailableUserListResponse()` or + The response is either `GroupCallCenterGetAvailableSupervisorListResponse()` or `ErrorResponse()`. - Replaced By: `GroupCallCenterGetAvailableAgentListRequest()` and - `GroupCallCenterGetAvailableSupervisorListRequest()` - Attributes: service_provider_id (str): serviceProviderId group_id (str): groupId @@ -120471,6 +111834,11 @@ class GroupCallCenterGetAvailableUserListRequest(OCIRequest): searchCriteriaExactUserDepartment *Optional* search_criteria_exact_user_group (OCI.searchCriteriaExactUserGroup): searchCriteriaExactUserGroup *Optional* + search_criteria_user_id (List[OCI.searchCriteriaUserId]): searchCriteriaUserId + *Optional* + search_criteria_dn (List[OCI.searchCriteriaDn]): searchCriteriaDn *Optional* + search_criteria_extension (List[OCI.searchCriteriaExtension]): + searchCriteriaExtension *Optional* """ __slots__: List[str] = [ @@ -120481,6 +111849,9 @@ class GroupCallCenterGetAvailableUserListRequest(OCIRequest): "search_criteria_user_first_name", "search_criteria_exact_user_department", "search_criteria_exact_user_group", + "search_criteria_user_id", + "search_criteria_dn", + "search_criteria_extension", ] @classmethod @@ -120515,64 +111886,65 @@ def _elements(cls) -> Tuple[E, ...]: OCI.SearchCriteriaExactUserGroup, is_complex=True, ), + E( + "search_criteria_user_id", + "searchCriteriaUserId", + OCI.SearchCriteriaUserId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_dn", + "searchCriteriaDn", + OCI.SearchCriteriaDn, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_extension", + "searchCriteriaExtension", + OCI.SearchCriteriaExtension, + is_complex=True, + is_array=True, + ), ) -class GroupCallCenterGetInstancePagedSortedListRequest(OCIRequest): +class GroupCallCenterGetAvailableUserListRequest(OCIRequest): """ - Get a list of Call Center instances within a group. + Get a list of users that can be assigned to a Call Center group. - The response is either `GroupCallCenterGetInstancePagedSortedListResponse()` or - `ErrorResponse()`. It is possible to get the instances within a specified department. - If the responsePagingControl element is not provided, the paging startIndex will be - set to 1 by default, and the responsePageSize will be set to the maximum - ResponsePageSize by default. It is possible to search by various criteria to restrict - the number of rows returned. If no sortOrder is included the response is sorted by - User Id ascending by default. Multiple search criteria are logically ANDed together - unless the searchCriteriaModeOr option is included. Then the search criteria are - logically ORed together. `ErrorResponse()` is returned if - searchCriteriaExactHuntPolicy or searchCriteriaExactCallCenterType have multiple - entries and searchCriteriaModeOr is not include. + Searching for users by group only makes sense when the call center is part of an + Enterprise. + + The response is either `GroupCallCenterGetAvailableUserListResponse()` or + `ErrorResponse()`. + + Replaced By: `GroupCallCenterGetAvailableAgentListRequest()` and + `GroupCallCenterGetAvailableSupervisorListRequest()` Attributes: service_provider_id (str): serviceProviderId group_id (str): groupId - response_paging_control (OCI.responsePagingControl): responsePagingControl - *Optional* - sort_order (List[OCI.sortOrder]): sortOrder *Optional* - search_criteria_user_id (List[OCI.searchCriteriaUserId]): searchCriteriaUserId - *Optional* - search_criteria_call_center_name (List[OCI.searchCriteriaCallCenterName]): - searchCriteriaCallCenterName *Optional* - search_criteria_dn (List[OCI.searchCriteriaDn]): searchCriteriaDn *Optional* - search_criteria_extension (List[OCI.searchCriteriaExtension]): - searchCriteriaExtension *Optional* - search_criteria_department_name (List[OCI.searchCriteriaDepartmentName]): - searchCriteriaDepartmentName *Optional* - search_criteria_service_status (OCI.searchCriteriaServiceStatus): - searchCriteriaServiceStatus *Optional* - search_criteria_exact_hunt_policy (List[OCI.searchCriteriaExactHuntPolicy]): - searchCriteriaExactHuntPolicy *Optional* - search_criteria_exact_call_center_type - (List[OCI.searchCriteriaExactCallCenterType]): - searchCriteriaExactCallCenterType *Optional* - search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* + response_size_limit (int): responseSizeLimit *Optional* + search_criteria_user_last_name (List[OCI.searchCriteriaUserLastName]): + searchCriteriaUserLastName *Optional* + search_criteria_user_first_name (List[OCI.searchCriteriaUserFirstName]): + searchCriteriaUserFirstName *Optional* + search_criteria_exact_user_department (OCI.searchCriteriaExactUserDepartment): + searchCriteriaExactUserDepartment *Optional* + search_criteria_exact_user_group (OCI.searchCriteriaExactUserGroup): + searchCriteriaExactUserGroup *Optional* """ __slots__: List[str] = [ "service_provider_id", "group_id", - "response_paging_control", - "sort_order", - "search_criteria_user_id", - "search_criteria_call_center_name", - "search_criteria_dn", - "search_criteria_extension", - "search_criteria_department_name", - "search_criteria_service_status", - "search_criteria_exact_hunt_policy", - "search_criteria_exact_call_center_type", - "search_criteria_mode_or", + "response_size_limit", + "search_criteria_user_last_name", + "search_criteria_user_first_name", + "search_criteria_exact_user_department", + "search_criteria_exact_user_group", ] @classmethod @@ -120580,75 +111952,33 @@ def _elements(cls) -> Tuple[E, ...]: return ( E("service_provider_id", "serviceProviderId", str, is_required=True), E("group_id", "groupId", str, is_required=True), + E("response_size_limit", "responseSizeLimit", int), E( - "response_paging_control", - "responsePagingControl", - OCI.ResponsePagingControl, - is_complex=True, - ), - E( - "sort_order", - "sortOrder", - OCI.SortOrderGroupCallCenterGetInstancePagedSortedList, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_id", - "searchCriteriaUserId", - OCI.SearchCriteriaUserId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_call_center_name", - "searchCriteriaCallCenterName", - OCI.SearchCriteriaCallCenterName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_dn", - "searchCriteriaDn", - OCI.SearchCriteriaDn, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_extension", - "searchCriteriaExtension", - OCI.SearchCriteriaExtension, + "search_criteria_user_last_name", + "searchCriteriaUserLastName", + OCI.SearchCriteriaUserLastName, is_complex=True, is_array=True, ), E( - "search_criteria_department_name", - "searchCriteriaDepartmentName", - OCI.SearchCriteriaDepartmentName, + "search_criteria_user_first_name", + "searchCriteriaUserFirstName", + OCI.SearchCriteriaUserFirstName, is_complex=True, is_array=True, ), E( - "search_criteria_service_status", - "searchCriteriaServiceStatus", - OCI.SearchCriteriaServiceStatus, - is_complex=True, - ), - E( - "search_criteria_exact_hunt_policy", - "searchCriteriaExactHuntPolicy", - OCI.SearchCriteriaExactHuntPolicy, + "search_criteria_exact_user_department", + "searchCriteriaExactUserDepartment", + OCI.SearchCriteriaExactUserDepartment, is_complex=True, - is_array=True, ), E( - "search_criteria_exact_call_center_type", - "searchCriteriaExactCallCenterType", - OCI.SearchCriteriaExactCallCenterType, + "search_criteria_exact_user_group", + "searchCriteriaExactUserGroup", + OCI.SearchCriteriaExactUserGroup, is_complex=True, - is_array=True, ), - E("search_criteria_mode_or", "searchCriteriaModeOr", bool), ) @@ -122598,54 +113928,45 @@ def _elements(cls) -> Tuple[E, ...]: ) -class GroupCallParkGetAvailableAlternateRecallUserPagedSortedListRequest(OCIRequest): +class GroupCallParkGetAvailableUserListRequest(OCIRequest): """ - Get a list of hunt groups that are available to select as an alternate recall user. + Get a list of users that can be assigned to a Call Park group. - If the responsePagingControl element is not provided, the paging startIndex will be - set to 1 by default, and the responsePageSize will be set to the maximum - ResponsePageSize by default. It is possible to search by various criteria to restrict - the number of rows returned. If no sortOrder is included the response is sorted by - User Id ascending by default. Multiple search criteria are logically ANDed together - unless the searchCriteriaModeOr option is included. Then the search criteria are - logically ORed together. + The available user list for a new Call Park group can be obtained by not setting the + name. - The response is either - `GroupCallParkGetAvailableAlternateRecallUserPagedSortedListResponse()` or + The response is either `GroupCallParkGetAvailableUserListResponse()` or `ErrorResponse()`. Attributes: service_provider_id (str): serviceProviderId group_id (str): groupId - response_paging_control (OCI.responsePagingControl): responsePagingControl - *Optional* - sort_order (List[OCI.sortOrder]): sortOrder *Optional* - search_criteria_user_id (List[OCI.searchCriteriaUserId]): searchCriteriaUserId - *Optional* + name (str): name *Optional* + response_size_limit (int): responseSizeLimit *Optional* search_criteria_user_last_name (List[OCI.searchCriteriaUserLastName]): searchCriteriaUserLastName *Optional* search_criteria_user_first_name (List[OCI.searchCriteriaUserFirstName]): searchCriteriaUserFirstName *Optional* + search_criteria_exact_user_department (OCI.searchCriteriaExactUserDepartment): + searchCriteriaExactUserDepartment *Optional* + search_criteria_user_id (List[OCI.searchCriteriaUserId]): searchCriteriaUserId + *Optional* search_criteria_dn (List[OCI.searchCriteriaDn]): searchCriteriaDn *Optional* search_criteria_extension (List[OCI.searchCriteriaExtension]): searchCriteriaExtension *Optional* - search_criteria_department_name (List[OCI.searchCriteriaDepartmentName]): - searchCriteriaDepartmentName *Optional* - search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* """ __slots__: List[str] = [ "service_provider_id", "group_id", - "response_paging_control", - "sort_order", - "search_criteria_user_id", + "name", + "response_size_limit", "search_criteria_user_last_name", "search_criteria_user_first_name", + "search_criteria_exact_user_department", + "search_criteria_user_id", "search_criteria_dn", "search_criteria_extension", - "search_criteria_department_name", - "search_criteria_mode_or", ] @classmethod @@ -122653,37 +113974,32 @@ def _elements(cls) -> Tuple[E, ...]: return ( E("service_provider_id", "serviceProviderId", str, is_required=True), E("group_id", "groupId", str, is_required=True), + E("name", "name", str), + E("response_size_limit", "responseSizeLimit", int), E( - "response_paging_control", - "responsePagingControl", - OCI.ResponsePagingControl, - is_complex=True, - ), - E( - "sort_order", - "sortOrder", - OCI.SortOrderGroupCallParkGetAvailableAlternateRecallUserPagedSortedList, + "search_criteria_user_last_name", + "searchCriteriaUserLastName", + OCI.SearchCriteriaUserLastName, is_complex=True, is_array=True, ), E( - "search_criteria_user_id", - "searchCriteriaUserId", - OCI.SearchCriteriaUserId, + "search_criteria_user_first_name", + "searchCriteriaUserFirstName", + OCI.SearchCriteriaUserFirstName, is_complex=True, is_array=True, ), E( - "search_criteria_user_last_name", - "searchCriteriaUserLastName", - OCI.SearchCriteriaUserLastName, + "search_criteria_exact_user_department", + "searchCriteriaExactUserDepartment", + OCI.SearchCriteriaExactUserDepartment, is_complex=True, - is_array=True, ), E( - "search_criteria_user_first_name", - "searchCriteriaUserFirstName", - OCI.SearchCriteriaUserFirstName, + "search_criteria_user_id", + "searchCriteriaUserId", + OCI.SearchCriteriaUserId, is_complex=True, is_array=True, ), @@ -122701,56 +114017,41 @@ def _elements(cls) -> Tuple[E, ...]: is_complex=True, is_array=True, ), - E( - "search_criteria_department_name", - "searchCriteriaDepartmentName", - OCI.SearchCriteriaDepartmentName, - is_complex=True, - is_array=True, - ), - E("search_criteria_mode_or", "searchCriteriaModeOr", bool), ) -class GroupCallParkGetAvailableUserListRequest(OCIRequest): +class GroupCallParkGetInstancePagedSortedListRequest(OCIRequest): """ - Get a list of users that can be assigned to a Call Park group. + Request to get a list of Call Park group instances within a group. - The available user list for a new Call Park group can be obtained by not setting the - name. + If the responsePagingControl element is not provided, the paging startIndex will be + set to 1 by default, and the responsePageSize will be set to the maximum + ResponsePageSize by default. It is possible to search by various criteria to restrict + the number of rows returned. Multiple search criteria are logically ANDed together + unless the searchCriteriaModeOr option is included. Then the search criteria are + logically ORed together. - The response is either `GroupCallParkGetAvailableUserListResponse()` or + The response is either `GroupCallParkGetInstancePagedSortedListResponse()` or `ErrorResponse()`. Attributes: service_provider_id (str): serviceProviderId group_id (str): groupId - name (str): name *Optional* - response_size_limit (int): responseSizeLimit *Optional* - search_criteria_user_last_name (List[OCI.searchCriteriaUserLastName]): - searchCriteriaUserLastName *Optional* - search_criteria_user_first_name (List[OCI.searchCriteriaUserFirstName]): - searchCriteriaUserFirstName *Optional* - search_criteria_exact_user_department (OCI.searchCriteriaExactUserDepartment): - searchCriteriaExactUserDepartment *Optional* - search_criteria_user_id (List[OCI.searchCriteriaUserId]): searchCriteriaUserId + response_paging_control (OCI.responsePagingControl): responsePagingControl *Optional* - search_criteria_dn (List[OCI.searchCriteriaDn]): searchCriteriaDn *Optional* - search_criteria_extension (List[OCI.searchCriteriaExtension]): - searchCriteriaExtension *Optional* + sort_by_call_park_name (OCI.sortByCallParkName): sortByCallParkName *Optional* + search_criteria_call_park_name (List[OCI.searchCriteriaCallParkName]): + searchCriteriaCallParkName *Optional* + search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* """ __slots__: List[str] = [ "service_provider_id", "group_id", - "name", - "response_size_limit", - "search_criteria_user_last_name", - "search_criteria_user_first_name", - "search_criteria_exact_user_department", - "search_criteria_user_id", - "search_criteria_dn", - "search_criteria_extension", + "response_paging_control", + "sort_by_call_park_name", + "search_criteria_call_park_name", + "search_criteria_mode_or", ] @classmethod @@ -122758,75 +114059,50 @@ def _elements(cls) -> Tuple[E, ...]: return ( E("service_provider_id", "serviceProviderId", str, is_required=True), E("group_id", "groupId", str, is_required=True), - E("name", "name", str), - E("response_size_limit", "responseSizeLimit", int), - E( - "search_criteria_user_last_name", - "searchCriteriaUserLastName", - OCI.SearchCriteriaUserLastName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_first_name", - "searchCriteriaUserFirstName", - OCI.SearchCriteriaUserFirstName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_exact_user_department", - "searchCriteriaExactUserDepartment", - OCI.SearchCriteriaExactUserDepartment, - is_complex=True, - ), E( - "search_criteria_user_id", - "searchCriteriaUserId", - OCI.SearchCriteriaUserId, + "response_paging_control", + "responsePagingControl", + OCI.ResponsePagingControl, is_complex=True, - is_array=True, ), E( - "search_criteria_dn", - "searchCriteriaDn", - OCI.SearchCriteriaDn, + "sort_by_call_park_name", + "sortByCallParkName", + OCI.SortByCallParkName, is_complex=True, - is_array=True, ), E( - "search_criteria_extension", - "searchCriteriaExtension", - OCI.SearchCriteriaExtension, + "search_criteria_call_park_name", + "searchCriteriaCallParkName", + OCI.SearchCriteriaCallParkName, is_complex=True, is_array=True, ), + E("search_criteria_mode_or", "searchCriteriaModeOr", bool), ) -class GroupCallParkGetAvailableUserPagedSortedListRequest(OCIRequest): +class GroupCallParkGetInstancePagedSortedRequest(OCIRequest): """ - Get a list of users that can be assigned to a Call Park group. + Gets a Call Park group. - The available user list for a new Call Park group can be obtained by not setting the - name. If the responsePagingControl element is not provided, the paging startIndex - will be set to 1 by default, and the responsePageSize will be set to the maximum + If the responsePagingControl element is not provided, the paging startIndex will be + set to 1 by default, and the responsePageSize will be set to the maximum ResponsePageSize by default. It is possible to search by various criteria to restrict - the number of rows returned. If no sortOrder is included the response is sorted by - User Id ascending by default. Multiple search criteria are logically ANDed together - unless the searchCriteriaModeOr option is included. Then the search criteria are - logically ORed together. + the number of rows returned. The sort order is based on the user order provided when + creating or modifying the call park instance. Multiple search criteria are logically + ANDed together unless the searchCriteriaModeOr option is included. Then the search + criteria are logically ORed together. - The response is either `GroupCallParkGetAvailableUserPagedSortedListResponse()` or + The response is either `GroupCallParkGetInstancePagedSortedResponse()` or `ErrorResponse()`. Attributes: service_provider_id (str): serviceProviderId group_id (str): groupId - name (str): name *Optional* + name (str): name response_paging_control (OCI.responsePagingControl): responsePagingControl *Optional* - sort_order (List[OCI.sortOrder]): sortOrder *Optional* search_criteria_user_id (List[OCI.searchCriteriaUserId]): searchCriteriaUserId *Optional* search_criteria_user_last_name (List[OCI.searchCriteriaUserLastName]): @@ -122848,7 +114124,6 @@ class GroupCallParkGetAvailableUserPagedSortedListRequest(OCIRequest): "group_id", "name", "response_paging_control", - "sort_order", "search_criteria_user_id", "search_criteria_user_last_name", "search_criteria_user_first_name", @@ -122864,20 +114139,13 @@ def _elements(cls) -> Tuple[E, ...]: return ( E("service_provider_id", "serviceProviderId", str, is_required=True), E("group_id", "groupId", str, is_required=True), - E("name", "name", str), + E("name", "name", str, is_required=True), E( "response_paging_control", "responsePagingControl", OCI.ResponsePagingControl, is_complex=True, ), - E( - "sort_order", - "sortOrder", - OCI.SortOrderGroupCallParkGetAvailableUserPagedSortedList, - is_complex=True, - is_array=True, - ), E( "search_criteria_user_id", "searchCriteriaUserId", @@ -123023,184 +114291,38 @@ def _elements(cls) -> Tuple[E, ...]: ) -class GroupCallPickupGetAvailableUserPagedSortedListRequest(OCIRequest): - """ - Get a list of users that can be assigned to a Call Pickup group. - - The available user list for a new Call Pickup group can be obtained by not setting the - name. If the responsePagingControl element is not provided, the paging startIndex - will be set to 1 by default, and the responsePageSize will be set to the maximum - ResponsePageSize by default. It is possible to search by various criteria to restrict - the number of rows returned. If no sortOrder is included the response is sorted by - User Id ascending by default. Multiple search criteria are logically ANDed together - unless the searchCriteriaModeOr option is included. Then the search criteria are - logically ORed together. - - The response is either `GroupCallPickupGetAvailableUserPagedSortedListResponse()` or - `ErrorResponse()`. - - Attributes: - service_provider_id (str): serviceProviderId - group_id (str): groupId - name (str): name *Optional* - response_paging_control (OCI.responsePagingControl): responsePagingControl - *Optional* - sort_order (List[OCI.sortOrder]): sortOrder *Optional* - search_criteria_user_id (List[OCI.searchCriteriaUserId]): searchCriteriaUserId - *Optional* - search_criteria_user_last_name (List[OCI.searchCriteriaUserLastName]): - searchCriteriaUserLastName *Optional* - search_criteria_user_first_name (List[OCI.searchCriteriaUserFirstName]): - searchCriteriaUserFirstName *Optional* - search_criteria_dn (List[OCI.searchCriteriaDn]): searchCriteriaDn *Optional* - search_criteria_extension (List[OCI.searchCriteriaExtension]): - searchCriteriaExtension *Optional* - search_criteria_department_name (List[OCI.searchCriteriaDepartmentName]): - searchCriteriaDepartmentName *Optional* - search_criteria_email_address (List[OCI.searchCriteriaEmailAddress]): - searchCriteriaEmailAddress *Optional* - search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* - """ - - __slots__: List[str] = [ - "service_provider_id", - "group_id", - "name", - "response_paging_control", - "sort_order", - "search_criteria_user_id", - "search_criteria_user_last_name", - "search_criteria_user_first_name", - "search_criteria_dn", - "search_criteria_extension", - "search_criteria_department_name", - "search_criteria_email_address", - "search_criteria_mode_or", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("service_provider_id", "serviceProviderId", str, is_required=True), - E("group_id", "groupId", str, is_required=True), - E("name", "name", str), - E( - "response_paging_control", - "responsePagingControl", - OCI.ResponsePagingControl, - is_complex=True, - ), - E( - "sort_order", - "sortOrder", - OCI.SortOrderGroupCallPickupGetAvailableUserPagedSortedList, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_id", - "searchCriteriaUserId", - OCI.SearchCriteriaUserId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_last_name", - "searchCriteriaUserLastName", - OCI.SearchCriteriaUserLastName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_first_name", - "searchCriteriaUserFirstName", - OCI.SearchCriteriaUserFirstName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_dn", - "searchCriteriaDn", - OCI.SearchCriteriaDn, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_extension", - "searchCriteriaExtension", - OCI.SearchCriteriaExtension, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_department_name", - "searchCriteriaDepartmentName", - OCI.SearchCriteriaDepartmentName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_email_address", - "searchCriteriaEmailAddress", - OCI.SearchCriteriaEmailAddress, - is_complex=True, - is_array=True, - ), - E("search_criteria_mode_or", "searchCriteriaModeOr", bool), - ) - - -class GroupCallPickupGetInstancePagedSortedRequest(OCIRequest): +class GroupCallPickupGetInstancePagedSortedListRequest(OCIRequest): """ - Gets a Call Pickup group. + Request to get a list of Call Pickup instances within a group. If the responsePagingControl element is not provided, the paging startIndex will be set to 1 by default, and the responsePageSize will be set to the maximum ResponsePageSize by default. It is possible to search by various criteria to restrict the number of rows returned. Multiple search criteria are logically ANDed together unless the searchCriteriaModeOr option is included. Then the search criteria are - logically ORed together. If no sortOrder is included the response is sorted by User - Id ascending by default. + logically ORed together. - The response is either `GroupCallPickupGetInstancePagedSortedResponse()` or + The response is either `GroupCallPickupGetInstancePagedSortedListResponse()` or `ErrorResponse()`. Attributes: service_provider_id (str): serviceProviderId group_id (str): groupId - name (str): name response_paging_control (OCI.responsePagingControl): responsePagingControl *Optional* - sort_order (List[OCI.sortOrder]): sortOrder *Optional* - search_criteria_user_id (List[OCI.searchCriteriaUserId]): searchCriteriaUserId + sort_by_call_pickup_name (OCI.sortByCallPickupName): sortByCallPickupName *Optional* - search_criteria_user_last_name (List[OCI.searchCriteriaUserLastName]): - searchCriteriaUserLastName *Optional* - search_criteria_user_first_name (List[OCI.searchCriteriaUserFirstName]): - searchCriteriaUserFirstName *Optional* - search_criteria_dn (List[OCI.searchCriteriaDn]): searchCriteriaDn *Optional* - search_criteria_extension (List[OCI.searchCriteriaExtension]): - searchCriteriaExtension *Optional* - search_criteria_department_name (List[OCI.searchCriteriaDepartmentName]): - searchCriteriaDepartmentName *Optional* - search_criteria_email_address (List[OCI.searchCriteriaEmailAddress]): - searchCriteriaEmailAddress *Optional* + search_criteria_call_pickup_name (List[OCI.searchCriteriaCallPickupName]): + searchCriteriaCallPickupName *Optional* search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* """ __slots__: List[str] = [ "service_provider_id", "group_id", - "name", "response_paging_control", - "sort_order", - "search_criteria_user_id", - "search_criteria_user_last_name", - "search_criteria_user_first_name", - "search_criteria_dn", - "search_criteria_extension", - "search_criteria_department_name", - "search_criteria_email_address", + "sort_by_call_pickup_name", + "search_criteria_call_pickup_name", "search_criteria_mode_or", ] @@ -123209,7 +114331,6 @@ def _elements(cls) -> Tuple[E, ...]: return ( E("service_provider_id", "serviceProviderId", str, is_required=True), E("group_id", "groupId", str, is_required=True), - E("name", "name", str, is_required=True), E( "response_paging_control", "responsePagingControl", @@ -123217,58 +114338,15 @@ def _elements(cls) -> Tuple[E, ...]: is_complex=True, ), E( - "sort_order", - "sortOrder", - OCI.SortOrderGroupCallPickupGetInstancePagedSorted, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_id", - "searchCriteriaUserId", - OCI.SearchCriteriaUserId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_last_name", - "searchCriteriaUserLastName", - OCI.SearchCriteriaUserLastName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_first_name", - "searchCriteriaUserFirstName", - OCI.SearchCriteriaUserFirstName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_dn", - "searchCriteriaDn", - OCI.SearchCriteriaDn, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_extension", - "searchCriteriaExtension", - OCI.SearchCriteriaExtension, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_department_name", - "searchCriteriaDepartmentName", - OCI.SearchCriteriaDepartmentName, + "sort_by_call_pickup_name", + "sortByCallPickupName", + OCI.SortByCallPickupName, is_complex=True, - is_array=True, ), E( - "search_criteria_email_address", - "searchCriteriaEmailAddress", - OCI.SearchCriteriaEmailAddress, + "search_criteria_call_pickup_name", + "searchCriteriaCallPickupName", + OCI.SearchCriteriaCallPickupName, is_complex=True, is_array=True, ), @@ -123605,250 +114683,6 @@ def _elements(cls) -> Tuple[E, ...]: ) -class GroupCollaborateBridgeGetAvailableUserPagedSortedListRequest(OCIRequest): - """ - Get a list of users with the Collaborate – Audio service assigned that can be assigned - to a collaborate bridge. - - For an Enterprise Group this will include all users in the group’s enterprise. The - searchCriteriaGroupId parameter is only applicable for enterprise groups. If no - sortOrder is included the response is sorted by Last Name ascending by default. A - limitation to the search by DN activation exists when the Number Activation mode is - set to Off. In this case DNs not assigned to users are never returned by queries with - the "dnActivationSearchCriteria" included. Multiple search criteria are logically - ANDed together unless the searchCriteriaModeOr option is included. Then the search - criteria are logically ORed together. - - The response is either - `GroupCollaborateBridgeGetAvailableUserPagedSortedListResponse()` or - `ErrorResponse()`. - - Attributes: - service_provider_id (str): serviceProviderId - group_id (str): groupId - response_paging_control (OCI.responsePagingControl): responsePagingControl - *Optional* - sort_order (List[OCI.sortOrder]): sortOrder *Optional* - search_criteria_user_last_name (List[OCI.searchCriteriaUserLastName]): - searchCriteriaUserLastName *Optional* - search_criteria_user_first_name (List[OCI.searchCriteriaUserFirstName]): - searchCriteriaUserFirstName *Optional* - search_criteria_department_name (List[OCI.searchCriteriaDepartmentName]): - searchCriteriaDepartmentName *Optional* - search_criteria_group_id (List[OCI.searchCriteriaGroupId]): searchCriteriaGroupId - *Optional* - search_criteria_user_id (List[OCI.searchCriteriaUserId]): searchCriteriaUserId - *Optional* - search_criteria_dn (List[OCI.searchCriteriaDn]): searchCriteriaDn *Optional* - search_criteria_extension (List[OCI.searchCriteriaExtension]): - searchCriteriaExtension *Optional* - search_criteria_exact_dn_activation (OCI.searchCriteriaExactDnActivation): - searchCriteriaExactDnActivation *Optional* - search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* - """ - - __slots__: List[str] = [ - "service_provider_id", - "group_id", - "response_paging_control", - "sort_order", - "search_criteria_user_last_name", - "search_criteria_user_first_name", - "search_criteria_department_name", - "search_criteria_group_id", - "search_criteria_user_id", - "search_criteria_dn", - "search_criteria_extension", - "search_criteria_exact_dn_activation", - "search_criteria_mode_or", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("service_provider_id", "serviceProviderId", str, is_required=True), - E("group_id", "groupId", str, is_required=True), - E( - "response_paging_control", - "responsePagingControl", - OCI.ResponsePagingControl, - is_complex=True, - ), - E( - "sort_order", - "sortOrder", - OCI.SortOrderGroupCollaborateBridgeGetAvailableUserPagedSortedList, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_last_name", - "searchCriteriaUserLastName", - OCI.SearchCriteriaUserLastName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_first_name", - "searchCriteriaUserFirstName", - OCI.SearchCriteriaUserFirstName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_department_name", - "searchCriteriaDepartmentName", - OCI.SearchCriteriaDepartmentName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_group_id", - "searchCriteriaGroupId", - OCI.SearchCriteriaGroupId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_id", - "searchCriteriaUserId", - OCI.SearchCriteriaUserId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_dn", - "searchCriteriaDn", - OCI.SearchCriteriaDn, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_extension", - "searchCriteriaExtension", - OCI.SearchCriteriaExtension, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_exact_dn_activation", - "searchCriteriaExactDnActivation", - OCI.SearchCriteriaExactDnActivation, - is_complex=True, - ), - E("search_criteria_mode_or", "searchCriteriaModeOr", bool), - ) - - -class GroupCollaborateBridgeGetInstancePagedSortedListRequest(OCIRequest): - """ - Get a list of collaborate bridges within a group. - - The response is either `GroupCollaborateBridgeGetInstancePagedSortedListResponse()` or - `ErrorResponse()`. If the responsePagingControl element is not provided, the paging - startIndex will be set to 1 by default, and the responsePageSize will be set to the - maximum responsePageSize by default. If no sortOrder is included the response is - sorted by Name ascending by default. . Multiple search criteria are logically ANDed - together unless the searchCriteriaModeOr option is included. Then the search criteria - are logically ORed together. - - Attributes: - service_provider_id (str): serviceProviderId - group_id (str): groupId - response_paging_control (OCI.responsePagingControl): responsePagingControl - *Optional* - sort_order (List[OCI.sortOrder]): sortOrder *Optional* - search_criteria_user_last_name (List[OCI.searchCriteriaUserLastName]): - searchCriteriaUserLastName *Optional* - search_criteria_department_name (List[OCI.searchCriteriaDepartmentName]): - searchCriteriaDepartmentName *Optional* - search_criteria_user_id (List[OCI.searchCriteriaUserId]): searchCriteriaUserId - *Optional* - search_criteria_dn (List[OCI.searchCriteriaDn]): searchCriteriaDn *Optional* - search_criteria_extension (List[OCI.searchCriteriaExtension]): - searchCriteriaExtension *Optional* - search_criteria_exact_dn_activation (OCI.searchCriteriaExactDnActivation): - searchCriteriaExactDnActivation *Optional* - search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* - """ - - __slots__: List[str] = [ - "service_provider_id", - "group_id", - "response_paging_control", - "sort_order", - "search_criteria_user_last_name", - "search_criteria_department_name", - "search_criteria_user_id", - "search_criteria_dn", - "search_criteria_extension", - "search_criteria_exact_dn_activation", - "search_criteria_mode_or", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("service_provider_id", "serviceProviderId", str, is_required=True), - E("group_id", "groupId", str, is_required=True), - E( - "response_paging_control", - "responsePagingControl", - OCI.ResponsePagingControl, - is_complex=True, - ), - E( - "sort_order", - "sortOrder", - OCI.SortOrderGroupCollaborateBridgeGetInstancePagedSortedList, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_last_name", - "searchCriteriaUserLastName", - OCI.SearchCriteriaUserLastName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_department_name", - "searchCriteriaDepartmentName", - OCI.SearchCriteriaDepartmentName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_id", - "searchCriteriaUserId", - OCI.SearchCriteriaUserId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_dn", - "searchCriteriaDn", - OCI.SearchCriteriaDn, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_extension", - "searchCriteriaExtension", - OCI.SearchCriteriaExtension, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_exact_dn_activation", - "searchCriteriaExactDnActivation", - OCI.SearchCriteriaExactDnActivation, - is_complex=True, - ), - E("search_criteria_mode_or", "searchCriteriaModeOr", bool), - ) - - class GroupCollaborateBridgeModifyInstanceRequest(OCIRequest): """ Request to modify a Collaborate bridge. @@ -123980,6 +114814,127 @@ def _elements(cls) -> Tuple[E, ...]: ) +class GroupCommonPhoneListGetListRequest(OCIRequest): + """ + Get a group's common phone list. + + The response is either a `GroupCommonPhoneListGetListResponse()` or an + `ErrorResponse()`. The search can be done using multiple criterion. If the + searchCriteriaModeOr is present, any result matching any one criteria is included in + the results. Otherwise, only results matching all the search criterion are included + in the results. If no search criteria is specified, all results are returned. + Specifying searchCriteriaModeOr without any search criteria results in an + `ErrorResponse()`. In all cases, if a responseSizeLimit is specified and the number of + matching results is more than this limit, then an `ErrorResponse()` is returned. + + Attributes: + service_provider_id (str): serviceProviderId + group_id (str): groupId + response_size_limit (int): responseSizeLimit *Optional* + search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* + search_criteria_group_common_phone_list_name + (List[OCI.searchCriteriaGroupCommonPhoneListName]): + searchCriteriaGroupCommonPhoneListName *Optional* + search_criteria_group_common_phone_list_number + (List[OCI.searchCriteriaGroupCommonPhoneListNumber]): + searchCriteriaGroupCommonPhoneListNumber *Optional* + """ + + __slots__: List[str] = [ + "service_provider_id", + "group_id", + "response_size_limit", + "search_criteria_mode_or", + "search_criteria_group_common_phone_list_name", + "search_criteria_group_common_phone_list_number", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("service_provider_id", "serviceProviderId", str, is_required=True), + E("group_id", "groupId", str, is_required=True), + E("response_size_limit", "responseSizeLimit", int), + E("search_criteria_mode_or", "searchCriteriaModeOr", bool), + E( + "search_criteria_group_common_phone_list_name", + "searchCriteriaGroupCommonPhoneListName", + OCI.SearchCriteriaGroupCommonPhoneListName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_group_common_phone_list_number", + "searchCriteriaGroupCommonPhoneListNumber", + OCI.SearchCriteriaGroupCommonPhoneListNumber, + is_complex=True, + is_array=True, + ), + ) + + +class GroupCommunicationBarringAuthorizationCodeGetListRequest21sp1(OCIRequest): + """ + Get a list of Communication Barring Authorization Codes for a group. + + The response is either + `GroupCommunicationBarringAuthorizationCodeGetListResponse21sp1()` or + `ErrorResponse()`. + + Attributes: + service_provider_id (str): serviceProviderId + group_id (str): groupId + response_size_limit (int): responseSizeLimit *Optional* + search_criteria_communication_barring_authorization_code + (List[OCI.searchCriteriaCommunicationBarringAuthorizationCode]): + searchCriteriaCommunicationBarringAuthorizationCode *Optional* + search_criteria_communication_barring_authorization_code_description + (List[OCI.searchCriteriaCommunicationBarringAuthorizationCodeDescription]): + searchCriteriaCommunicationBarringAuthorizationCodeDescription *Optional* + search_criteria_network_class_of_service_name + (List[OCI.searchCriteriaNetworkClassOfServiceName]): + searchCriteriaNetworkClassOfServiceName *Optional* + """ + + __slots__: List[str] = [ + "service_provider_id", + "group_id", + "response_size_limit", + "search_criteria_communication_barring_authorization_code", + "search_criteria_communication_barring_authorization_code_description", + "search_criteria_network_class_of_service_name", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("service_provider_id", "serviceProviderId", str, is_required=True), + E("group_id", "groupId", str, is_required=True), + E("response_size_limit", "responseSizeLimit", int), + E( + "search_criteria_communication_barring_authorization_code", + "searchCriteriaCommunicationBarringAuthorizationCode", + OCI.SearchCriteriaCommunicationBarringAuthorizationCode, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_communication_barring_authorization_code_description", + "searchCriteriaCommunicationBarringAuthorizationCodeDescription", + OCI.SearchCriteriaCommunicationBarringAuthorizationCodeDescription, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_network_class_of_service_name", + "searchCriteriaNetworkClassOfServiceName", + OCI.SearchCriteriaNetworkClassOfServiceName, + is_complex=True, + is_array=True, + ), + ) + + class GroupConsolidatedAddRequest(OCIRequest): """ Add a group. @@ -124848,40 +115803,126 @@ def _elements(cls) -> Tuple[E, ...]: ) -class GroupDnGetAssignmentListRequest(OCIRequest): +class GroupDepartmentAdminAddRequest(OCIRequest): """ - Get the list of assigned and unassigned DNs in a group. + Add a department administrator to a group department. - Each DN can be assigned to a user and/or department. Ranges of DNs with identical - assignment and activation properties are coalesced to a single table row entry. + The response is either a `SuccessResponse()` or an `ErrorResponse()`. + + Attributes: + department_key (OCI.departmentKey): departmentKey + user_id (str): userId + first_name (str): firstName *Optional* + last_name (str): lastName *Optional* + password (str): password *Optional* + language (str): language *Optional* + """ + + __slots__: List[str] = [ + "department_key", + "user_id", + "first_name", + "last_name", + "password", + "language", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E( + "department_key", + "departmentKey", + OCI.GroupDepartmentKey, + is_complex=True, + is_required=True, + ), + E("user_id", "userId", str, is_required=True), + E("first_name", "firstName", str), + E("last_name", "lastName", str), + E("password", "password", str), + E("language", "language", str), + ) - The response is either a `GroupDnGetAssignmentListResponse()` or an `ErrorResponse()`. - Replaced by: `GroupDnGetAssignmentListRequest18()` + +class GroupDepartmentAdminGetListRequest(OCIRequest): + """ + Get a list of department administrators for the department. + + The response is either a `GroupDepartmentAdminGetListResponse()` or an + `ErrorResponse()`. + + Attributes: + department_key (OCI.departmentKey): departmentKey + """ + + __slots__: List[str] = [ + "department_key", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E( + "department_key", + "departmentKey", + OCI.GroupDepartmentKey, + is_complex=True, + is_required=True, + ), + ) + + +class GroupDeviceManagementEventGetListRequest(OCIRequest): + """ + Request device management's events for a specific queue. + + It is possible to restrict the number of rows returned using responseSizeLimit. If + eventQueueType is not specified, the events from all the event queues are returned. + + The response is either a `GroupDeviceManagementEventGetListResponse()` or an + `ErrorResponse()`. Attributes: service_provider_id (str): serviceProviderId group_id (str): groupId + event_queue_type (str): eventQueueType *Optional* response_size_limit (int): responseSizeLimit *Optional* - search_criteria_dn (List[OCI.searchCriteriaDn]): searchCriteriaDn *Optional* - search_criteria_user_first_name (List[OCI.searchCriteriaUserFirstName]): - searchCriteriaUserFirstName *Optional* - search_criteria_user_last_name (List[OCI.searchCriteriaUserLastName]): - searchCriteriaUserLastName *Optional* - search_criteria_exact_dn_department (OCI.searchCriteriaExactDnDepartment): - searchCriteriaExactDnDepartment *Optional* - search_criteria_exact_dn_activation (OCI.searchCriteriaExactDnActivation): - searchCriteriaExactDnActivation *Optional* + search_criteria_exact_device_management_event_status_in_progress_or_pending + (OCI.searchCriteriaExactDeviceManagementEventStatusInProgressOrPending): + searchCriteriaExactDeviceManagementEventStatusInProgressOrPending *Optional* + search_criteria_exact_device_management_event_status_completed + (OCI.searchCriteriaExactDeviceManagementEventStatusCompleted): + searchCriteriaExactDeviceManagementEventStatusCompleted *Optional* + search_criteria_exact_device_management_event_action + (OCI.searchCriteriaExactDeviceManagementEventAction): + searchCriteriaExactDeviceManagementEventAction *Optional* + search_criteria_exact_device_management_event_level + (OCI.searchCriteriaExactDeviceManagementEventLevel): + searchCriteriaExactDeviceManagementEventLevel *Optional* + search_criteria_exact_device_management_event_type + (OCI.searchCriteriaExactDeviceManagementEventType): + searchCriteriaExactDeviceManagementEventType *Optional* + search_criteria_device_management_event_additional_info + (List[OCI.searchCriteriaDeviceManagementEventAdditionalInfo]): + searchCriteriaDeviceManagementEventAdditionalInfo *Optional* + search_criteria_device_management_event_login_id + (List[OCI.searchCriteriaDeviceManagementEventLoginId]): + searchCriteriaDeviceManagementEventLoginId *Optional* """ __slots__: List[str] = [ "service_provider_id", "group_id", + "event_queue_type", "response_size_limit", - "search_criteria_dn", - "search_criteria_user_first_name", - "search_criteria_user_last_name", - "search_criteria_exact_dn_department", - "search_criteria_exact_dn_activation", + "search_criteria_exact_device_management_event_status_in_progress_or_pending", + "search_criteria_exact_device_management_event_status_completed", + "search_criteria_exact_device_management_event_action", + "search_criteria_exact_device_management_event_level", + "search_criteria_exact_device_management_event_type", + "search_criteria_device_management_event_additional_info", + "search_criteria_device_management_event_login_id", ] @classmethod @@ -124889,53 +115930,170 @@ def _elements(cls) -> Tuple[E, ...]: return ( E("service_provider_id", "serviceProviderId", str, is_required=True), E("group_id", "groupId", str, is_required=True), + E("event_queue_type", "eventQueueType", str), E("response_size_limit", "responseSizeLimit", int), E( - "search_criteria_dn", - "searchCriteriaDn", - OCI.SearchCriteriaDn, + "search_criteria_exact_device_management_event_status_in_progress_or_pending", + "searchCriteriaExactDeviceManagementEventStatusInProgressOrPending", + OCI.SearchCriteriaExactDeviceManagementEventStatusInProgressOrPending, is_complex=True, - is_array=True, ), E( - "search_criteria_user_first_name", - "searchCriteriaUserFirstName", - OCI.SearchCriteriaUserFirstName, + "search_criteria_exact_device_management_event_status_completed", + "searchCriteriaExactDeviceManagementEventStatusCompleted", + OCI.SearchCriteriaExactDeviceManagementEventStatusCompleted, + is_complex=True, + ), + E( + "search_criteria_exact_device_management_event_action", + "searchCriteriaExactDeviceManagementEventAction", + OCI.SearchCriteriaExactDeviceManagementEventAction, + is_complex=True, + ), + E( + "search_criteria_exact_device_management_event_level", + "searchCriteriaExactDeviceManagementEventLevel", + OCI.SearchCriteriaExactDeviceManagementEventLevel, + is_complex=True, + ), + E( + "search_criteria_exact_device_management_event_type", + "searchCriteriaExactDeviceManagementEventType", + OCI.SearchCriteriaExactDeviceManagementEventType, + is_complex=True, + ), + E( + "search_criteria_device_management_event_additional_info", + "searchCriteriaDeviceManagementEventAdditionalInfo", + OCI.SearchCriteriaDeviceManagementEventAdditionalInfo, is_complex=True, is_array=True, ), E( - "search_criteria_user_last_name", - "searchCriteriaUserLastName", - OCI.SearchCriteriaUserLastName, + "search_criteria_device_management_event_login_id", + "searchCriteriaDeviceManagementEventLoginId", + OCI.SearchCriteriaDeviceManagementEventLoginId, is_complex=True, is_array=True, ), + ) + + +class GroupDeviceManagementEventGetListRequest22(OCIRequest): + """ + Request device management's events for a specific queue. + + It is possible to restrict the number of rows returned using responseSizeLimit. If + eventQueueType is not specified, the events from all the event queues are returned. + + The response is either a `GroupDeviceManagementEventGetListResponse22()` or an + `ErrorResponse()`. + + Attributes: + service_provider_id (str): serviceProviderId + group_id (str): groupId + event_queue_type (str): eventQueueType *Optional* + response_size_limit (int): responseSizeLimit *Optional* + search_criteria_exact_device_management_event_status_in_progress_or_pending + (OCI.searchCriteriaExactDeviceManagementEventStatusInProgressOrPending): + searchCriteriaExactDeviceManagementEventStatusInProgressOrPending *Optional* + search_criteria_exact_device_management_event_status_completed + (OCI.searchCriteriaExactDeviceManagementEventStatusCompleted): + searchCriteriaExactDeviceManagementEventStatusCompleted *Optional* + search_criteria_exact_device_management_event_action + (OCI.searchCriteriaExactDeviceManagementEventAction): + searchCriteriaExactDeviceManagementEventAction *Optional* + search_criteria_exact_device_management_event_level + (OCI.searchCriteriaExactDeviceManagementEventLevel): + searchCriteriaExactDeviceManagementEventLevel *Optional* + search_criteria_exact_device_management_event_type + (OCI.searchCriteriaExactDeviceManagementEventType): + searchCriteriaExactDeviceManagementEventType *Optional* + search_criteria_device_management_event_additional_info + (List[OCI.searchCriteriaDeviceManagementEventAdditionalInfo]): + searchCriteriaDeviceManagementEventAdditionalInfo *Optional* + search_criteria_device_management_event_login_id + (List[OCI.searchCriteriaDeviceManagementEventLoginId]): + searchCriteriaDeviceManagementEventLoginId *Optional* + """ + + __slots__: List[str] = [ + "service_provider_id", + "group_id", + "event_queue_type", + "response_size_limit", + "search_criteria_exact_device_management_event_status_in_progress_or_pending", + "search_criteria_exact_device_management_event_status_completed", + "search_criteria_exact_device_management_event_action", + "search_criteria_exact_device_management_event_level", + "search_criteria_exact_device_management_event_type", + "search_criteria_device_management_event_additional_info", + "search_criteria_device_management_event_login_id", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("service_provider_id", "serviceProviderId", str, is_required=True), + E("group_id", "groupId", str, is_required=True), + E("event_queue_type", "eventQueueType", str), + E("response_size_limit", "responseSizeLimit", int), E( - "search_criteria_exact_dn_department", - "searchCriteriaExactDnDepartment", - OCI.SearchCriteriaExactDnDepartment, + "search_criteria_exact_device_management_event_status_in_progress_or_pending", + "searchCriteriaExactDeviceManagementEventStatusInProgressOrPending", + OCI.SearchCriteriaExactDeviceManagementEventStatusInProgressOrPending, is_complex=True, ), E( - "search_criteria_exact_dn_activation", - "searchCriteriaExactDnActivation", - OCI.SearchCriteriaExactDnActivation, + "search_criteria_exact_device_management_event_status_completed", + "searchCriteriaExactDeviceManagementEventStatusCompleted", + OCI.SearchCriteriaExactDeviceManagementEventStatusCompleted, + is_complex=True, + ), + E( + "search_criteria_exact_device_management_event_action", + "searchCriteriaExactDeviceManagementEventAction", + OCI.SearchCriteriaExactDeviceManagementEventAction, + is_complex=True, + ), + E( + "search_criteria_exact_device_management_event_level", + "searchCriteriaExactDeviceManagementEventLevel", + OCI.SearchCriteriaExactDeviceManagementEventLevel, + is_complex=True, + ), + E( + "search_criteria_exact_device_management_event_type", + "searchCriteriaExactDeviceManagementEventType", + OCI.SearchCriteriaExactDeviceManagementEventType, is_complex=True, ), + E( + "search_criteria_device_management_event_additional_info", + "searchCriteriaDeviceManagementEventAdditionalInfo", + OCI.SearchCriteriaDeviceManagementEventAdditionalInfo, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_device_management_event_login_id", + "searchCriteriaDeviceManagementEventLoginId", + OCI.SearchCriteriaDeviceManagementEventLoginId, + is_complex=True, + is_array=True, + ), ) -class GroupDnGetAssignmentListRequest18(OCIRequest): +class GroupDnGetAssignmentListRequest(OCIRequest): """ Get the list of assigned and unassigned DNs in a group. Each DN can be assigned to a user and/or department. Ranges of DNs with identical - assignment and activation properties are coalesced to a single table row entry. Dns - assigned to the IMRN pool are not listed in the response. + assignment and activation properties are coalesced to a single table row entry. - The response is either a `GroupDnGetAssignmentListResponse18()` or an - `ErrorResponse()`. + The response is either a `GroupDnGetAssignmentListResponse()` or an `ErrorResponse()`. + Replaced by: `GroupDnGetAssignmentListRequest18()` Attributes: service_provider_id (str): serviceProviderId @@ -124950,10 +116108,6 @@ class GroupDnGetAssignmentListRequest18(OCIRequest): searchCriteriaExactDnDepartment *Optional* search_criteria_exact_dn_activation (OCI.searchCriteriaExactDnActivation): searchCriteriaExactDnActivation *Optional* - search_criteria_user_id (List[OCI.searchCriteriaUserId]): searchCriteriaUserId - *Optional* - search_criteria_extension (List[OCI.searchCriteriaExtension]): - searchCriteriaExtension *Optional* """ __slots__: List[str] = [ @@ -124965,8 +116119,6 @@ class GroupDnGetAssignmentListRequest18(OCIRequest): "search_criteria_user_last_name", "search_criteria_exact_dn_department", "search_criteria_exact_dn_activation", - "search_criteria_user_id", - "search_criteria_extension", ] @classmethod @@ -125008,87 +116160,50 @@ def _elements(cls) -> Tuple[E, ...]: OCI.SearchCriteriaExactDnActivation, is_complex=True, ), - E( - "search_criteria_user_id", - "searchCriteriaUserId", - OCI.SearchCriteriaUserId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_extension", - "searchCriteriaExtension", - OCI.SearchCriteriaExtension, - is_complex=True, - is_array=True, - ), ) -class GroupDnGetAssignmentPagedSortedListRequest(OCIRequest): +class GroupDnGetAssignmentListRequest18(OCIRequest): """ Get the list of assigned and unassigned DNs in a group. Each DN can be assigned to a user and/or department. Ranges of DNs with identical assignment and activation properties are coalesced to a single table row entry. Dns - assigned to the IMRN pool are not listed in the response. If the - responsePagingControl element is not provided, the paging startIndex will be set to 1 - by default, and the responsePageSize will be set to the maximum ResponsePageSize by - default. If no sortOrder is included the response is sorted by Phone Number by - default. Multiple search criteria are logically ANDed together unless the - searchCriteriaModeOr option is included. Then the search criterion are logically ORed - together. The department in both the search criteria and sort by fields refer to the - department to which the dn belongs. A limitation to the search by DN activation - exists when the Number Activation mode is set to Off. In this case DNs not assigned - to users are never returned by queries with the "dnActivationSearchCriteria" included. + assigned to the IMRN pool are not listed in the response. - The response is either a `GroupDnGetAssignmentPagedSortedListResponse()` or an + The response is either a `GroupDnGetAssignmentListResponse18()` or an `ErrorResponse()`. Attributes: service_provider_id (str): serviceProviderId group_id (str): groupId - response_paging_control (OCI.responsePagingControl): responsePagingControl - *Optional* - sort_order (List[OCI.sortOrder]): sortOrder *Optional* + response_size_limit (int): responseSizeLimit *Optional* search_criteria_dn (List[OCI.searchCriteriaDn]): searchCriteriaDn *Optional* - search_criteria_department_name (List[OCI.searchCriteriaDepartmentName]): - searchCriteriaDepartmentName *Optional* - search_criteria_exact_dn_activation (OCI.searchCriteriaExactDnActivation): - searchCriteriaExactDnActivation *Optional* - search_criteria_exact_dn_availability (OCI.searchCriteriaExactDnAvailability): - searchCriteriaExactDnAvailability *Optional* - search_criteria_user_id (List[OCI.searchCriteriaUserId]): searchCriteriaUserId - *Optional* search_criteria_user_first_name (List[OCI.searchCriteriaUserFirstName]): searchCriteriaUserFirstName *Optional* search_criteria_user_last_name (List[OCI.searchCriteriaUserLastName]): searchCriteriaUserLastName *Optional* - search_criteria_exact_user_type (List[OCI.searchCriteriaExactUserType]): - searchCriteriaExactUserType *Optional* + search_criteria_exact_dn_department (OCI.searchCriteriaExactDnDepartment): + searchCriteriaExactDnDepartment *Optional* + search_criteria_exact_dn_activation (OCI.searchCriteriaExactDnActivation): + searchCriteriaExactDnActivation *Optional* + search_criteria_user_id (List[OCI.searchCriteriaUserId]): searchCriteriaUserId + *Optional* search_criteria_extension (List[OCI.searchCriteriaExtension]): searchCriteriaExtension *Optional* - search_criteria_email_address (List[OCI.searchCriteriaEmailAddress]): - searchCriteriaEmailAddress *Optional* - search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* """ __slots__: List[str] = [ "service_provider_id", "group_id", - "response_paging_control", - "sort_order", + "response_size_limit", "search_criteria_dn", - "search_criteria_department_name", - "search_criteria_exact_dn_activation", - "search_criteria_exact_dn_availability", - "search_criteria_user_id", "search_criteria_user_first_name", "search_criteria_user_last_name", - "search_criteria_exact_user_type", + "search_criteria_exact_dn_department", + "search_criteria_exact_dn_activation", + "search_criteria_user_id", "search_criteria_extension", - "search_criteria_email_address", - "search_criteria_mode_or", ] @classmethod @@ -125096,32 +116211,33 @@ def _elements(cls) -> Tuple[E, ...]: return ( E("service_provider_id", "serviceProviderId", str, is_required=True), E("group_id", "groupId", str, is_required=True), + E("response_size_limit", "responseSizeLimit", int), E( - "response_paging_control", - "responsePagingControl", - OCI.ResponsePagingControl, + "search_criteria_dn", + "searchCriteriaDn", + OCI.SearchCriteriaDn, is_complex=True, + is_array=True, ), E( - "sort_order", - "sortOrder", - OCI.SortOrderGroupDnGetAssignmentPagedSortedList, + "search_criteria_user_first_name", + "searchCriteriaUserFirstName", + OCI.SearchCriteriaUserFirstName, is_complex=True, is_array=True, ), E( - "search_criteria_dn", - "searchCriteriaDn", - OCI.SearchCriteriaDn, + "search_criteria_user_last_name", + "searchCriteriaUserLastName", + OCI.SearchCriteriaUserLastName, is_complex=True, is_array=True, ), E( - "search_criteria_department_name", - "searchCriteriaDepartmentName", - OCI.SearchCriteriaDepartmentName, + "search_criteria_exact_dn_department", + "searchCriteriaExactDnDepartment", + OCI.SearchCriteriaExactDnDepartment, is_complex=True, - is_array=True, ), E( "search_criteria_exact_dn_activation", @@ -125129,12 +116245,6 @@ def _elements(cls) -> Tuple[E, ...]: OCI.SearchCriteriaExactDnActivation, is_complex=True, ), - E( - "search_criteria_exact_dn_availability", - "searchCriteriaExactDnAvailability", - OCI.SearchCriteriaExactDnAvailability, - is_complex=True, - ), E( "search_criteria_user_id", "searchCriteriaUserId", @@ -125142,27 +116252,6 @@ def _elements(cls) -> Tuple[E, ...]: is_complex=True, is_array=True, ), - E( - "search_criteria_user_first_name", - "searchCriteriaUserFirstName", - OCI.SearchCriteriaUserFirstName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_last_name", - "searchCriteriaUserLastName", - OCI.SearchCriteriaUserLastName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_exact_user_type", - "searchCriteriaExactUserType", - OCI.SearchCriteriaExactUserType, - is_complex=True, - is_array=True, - ), E( "search_criteria_extension", "searchCriteriaExtension", @@ -125170,14 +116259,6 @@ def _elements(cls) -> Tuple[E, ...]: is_complex=True, is_array=True, ), - E( - "search_criteria_email_address", - "searchCriteriaEmailAddress", - OCI.SearchCriteriaEmailAddress, - is_complex=True, - is_array=True, - ), - E("search_criteria_mode_or", "searchCriteriaModeOr", bool), ) @@ -125425,6 +116506,47 @@ def _elements(cls) -> Tuple[E, ...]: ) +class GroupEnterpriseTrunkGetAvailableTrunkGroupListRequest(OCIRequest): + """ + Request to get the list of all available trunk groups defined in a group. + + It is possible to search by various criteria to restrict the number of rows returned. + Multiple search criteria are logically ANDed together. + + The response is either a `GroupEnterpriseTrunkGetAvailableTrunkGroupListResponse()` or + an `ErrorResponse()`. + + Attributes: + service_provider_id (str): serviceProviderId + group_id (str): groupId + response_size_limit (int): responseSizeLimit *Optional* + search_criteria_trunk_group_name (List[OCI.searchCriteriaTrunkGroupName]): + searchCriteriaTrunkGroupName *Optional* + """ + + __slots__: List[str] = [ + "service_provider_id", + "group_id", + "response_size_limit", + "search_criteria_trunk_group_name", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("service_provider_id", "serviceProviderId", str, is_required=True), + E("group_id", "groupId", str, is_required=True), + E("response_size_limit", "responseSizeLimit", int), + E( + "search_criteria_trunk_group_name", + "searchCriteriaTrunkGroupName", + OCI.SearchCriteriaTrunkGroupName, + is_complex=True, + is_array=True, + ), + ) + + class GroupEnterpriseTrunkGetAvailableUserListRequest(OCIRequest): """ Request the list of users that are available to be added to an enterprise trunk. @@ -126116,57 +117238,93 @@ def _elements(cls) -> Tuple[E, ...]: ) -class GroupGetListInServiceProviderPagedSortedListRequest(OCIRequest): +class GroupGetListInServiceProviderRequest(OCIRequest): """ Request the list of groups in a service provider or enterprise. - If no sortOrder is included, the response is sorted by Group Id ascending by default. + It is possible to search by various criteria to restrict the number of rows returned. + Multiple search criteria are logically ANDed together. - The response is either a `GroupGetListInServiceProviderPagedSortedListResponse()` or - an `ErrorResponse()`. If the responsePagingControl element is not provided, the paging - startIndex will be set to 1 by default, and the responsePageSize will be set to the - maximum responsePageSize by default. Multiple search criteria are logically ANDed - together unless the searchCriteriaModeOr option is included. Then the search criteria - are logically ORed together. + The response is either a `GroupGetListInServiceProviderResponse()` or an + `ErrorResponse()`. Attributes: service_provider_id (str): serviceProviderId - response_paging_control (OCI.responsePagingControl): responsePagingControl - *Optional* - sort_order (List[OCI.sortOrder]): sortOrder *Optional* + response_size_limit (int): responseSizeLimit *Optional* search_criteria_group_id (List[OCI.searchCriteriaGroupId]): searchCriteriaGroupId *Optional* search_criteria_group_name (List[OCI.searchCriteriaGroupName]): searchCriteriaGroupName *Optional* - search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* """ __slots__: List[str] = [ "service_provider_id", - "response_paging_control", - "sort_order", + "response_size_limit", "search_criteria_group_id", "search_criteria_group_name", - "search_criteria_mode_or", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( E("service_provider_id", "serviceProviderId", str, is_required=True), + E("response_size_limit", "responseSizeLimit", int), E( - "response_paging_control", - "responsePagingControl", - OCI.ResponsePagingControl, + "search_criteria_group_id", + "searchCriteriaGroupId", + OCI.SearchCriteriaGroupId, is_complex=True, + is_array=True, ), E( - "sort_order", - "sortOrder", - OCI.SortOrderGroupGetListInServiceProviderPagedSortedList, + "search_criteria_group_name", + "searchCriteriaGroupName", + OCI.SearchCriteriaGroupName, is_complex=True, is_array=True, ), + ) + + +class GroupGetListInSystemRequest(OCIRequest): + """ + Request the list of groups in the system. + + It is possible to search by various criteria to restrict the number of rows returned. + Multiple search criteria are logically ANDed together. If reseller administrator + sends the request, searchCriteriaResellerId is ignored. All the groups in the + administrator's reseller meeting the search criteria are returned. + + The response is either a `GroupGetListInSystemResponse()` or an `ErrorResponse()`. The + following data elements are only used in AS data mode: searchCriteriaResellerId + + Attributes: + response_size_limit (int): responseSizeLimit *Optional* + search_criteria_group_id (List[OCI.searchCriteriaGroupId]): searchCriteriaGroupId + *Optional* + search_criteria_group_name (List[OCI.searchCriteriaGroupName]): + searchCriteriaGroupName *Optional* + search_criteria_exact_service_provider (OCI.searchCriteriaExactServiceProvider): + searchCriteriaExactServiceProvider *Optional* + search_criteria_service_provider_id (List[OCI.searchCriteriaServiceProviderId]): + searchCriteriaServiceProviderId *Optional* + search_criteria_reseller_id (List[OCI.searchCriteriaResellerId]): + searchCriteriaResellerId *Optional* + """ + + __slots__: List[str] = [ + "response_size_limit", + "search_criteria_group_id", + "search_criteria_group_name", + "search_criteria_exact_service_provider", + "search_criteria_service_provider_id", + "search_criteria_reseller_id", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("response_size_limit", "responseSizeLimit", int), E( "search_criteria_group_id", "searchCriteriaGroupId", @@ -126181,7 +117339,26 @@ def _elements(cls) -> Tuple[E, ...]: is_complex=True, is_array=True, ), - E("search_criteria_mode_or", "searchCriteriaModeOr", bool), + E( + "search_criteria_exact_service_provider", + "searchCriteriaExactServiceProvider", + OCI.SearchCriteriaExactServiceProvider, + is_complex=True, + ), + E( + "search_criteria_service_provider_id", + "searchCriteriaServiceProviderId", + OCI.SearchCriteriaServiceProviderId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_reseller_id", + "searchCriteriaResellerId", + OCI.SearchCriteriaResellerId, + is_complex=True, + is_array=True, + ), ) @@ -127348,260 +118525,6 @@ def _elements(cls) -> Tuple[E, ...]: ) -class GroupHuntGroupGetAvailableUserPagedSortedListRequest(OCIRequest): - """ - Get a list of users that can be assigned to a Hunt Group group. - - Searching for users by group only makes sense when the hunt group is part of an - Enterprise. A limitation to the search by DN activation exists when the Number - Activation mode is set to Off. In this case DNs not assigned to users are never - returned by queries with the "dnActivationSearchCriteria" included. - - The response is either `GroupHuntGroupGetAvailableUserPagedSortedListResponse()` or - `ErrorResponse()`. If no sortOrder is included, the response is sorted by User Id - ascending by default. If the responsePagingControl element is not provided, the - paging startIndex will be set to 1 by default, and the responsePageSize will be set to - the maximum responsePageSize by default. Multiple search criteria are logically ANDed - together unless the searchCriteriaModeOr option is included. Then the search criteria - are logically ORed together. - - Attributes: - service_provider_id (str): serviceProviderId - group_id (str): groupId - response_paging_control (OCI.responsePagingControl): responsePagingControl - *Optional* - sort_order (List[OCI.sortOrder]): sortOrder *Optional* - search_criteria_user_last_name (List[OCI.searchCriteriaUserLastName]): - searchCriteriaUserLastName *Optional* - search_criteria_user_first_name (List[OCI.searchCriteriaUserFirstName]): - searchCriteriaUserFirstName *Optional* - search_criteria_department_name (List[OCI.searchCriteriaDepartmentName]): - searchCriteriaDepartmentName *Optional* - search_criteria_group_id (List[OCI.searchCriteriaGroupId]): searchCriteriaGroupId - *Optional* - search_criteria_user_id (List[OCI.searchCriteriaUserId]): searchCriteriaUserId - *Optional* - search_criteria_dn (List[OCI.searchCriteriaDn]): searchCriteriaDn *Optional* - search_criteria_extension (List[OCI.searchCriteriaExtension]): - searchCriteriaExtension *Optional* - search_criteria_exact_dn_activation (OCI.searchCriteriaExactDnActivation): - searchCriteriaExactDnActivation *Optional* - search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* - """ - - __slots__: List[str] = [ - "service_provider_id", - "group_id", - "response_paging_control", - "sort_order", - "search_criteria_user_last_name", - "search_criteria_user_first_name", - "search_criteria_department_name", - "search_criteria_group_id", - "search_criteria_user_id", - "search_criteria_dn", - "search_criteria_extension", - "search_criteria_exact_dn_activation", - "search_criteria_mode_or", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("service_provider_id", "serviceProviderId", str, is_required=True), - E("group_id", "groupId", str, is_required=True), - E( - "response_paging_control", - "responsePagingControl", - OCI.ResponsePagingControl, - is_complex=True, - ), - E( - "sort_order", - "sortOrder", - OCI.SortOrderGroupHuntGroupGetAvailableUserPagedSortedList, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_last_name", - "searchCriteriaUserLastName", - OCI.SearchCriteriaUserLastName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_first_name", - "searchCriteriaUserFirstName", - OCI.SearchCriteriaUserFirstName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_department_name", - "searchCriteriaDepartmentName", - OCI.SearchCriteriaDepartmentName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_group_id", - "searchCriteriaGroupId", - OCI.SearchCriteriaGroupId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_id", - "searchCriteriaUserId", - OCI.SearchCriteriaUserId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_dn", - "searchCriteriaDn", - OCI.SearchCriteriaDn, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_extension", - "searchCriteriaExtension", - OCI.SearchCriteriaExtension, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_exact_dn_activation", - "searchCriteriaExactDnActivation", - OCI.SearchCriteriaExactDnActivation, - is_complex=True, - ), - E("search_criteria_mode_or", "searchCriteriaModeOr", bool), - ) - - -class GroupHuntGroupGetInstancePagedSortedListRequest(OCIRequest): - """ - Get a list of Hunt Group instances within a group. - - The response is either `GroupHuntGroupGetInstancePagedSortedListResponse()` or - `ErrorResponse()`. It is possible to get the instances within a specified department. - The department in both the search criteria and sort by fields refer to the department - to which the dn belongs. If no sortOrder is included, the response is sorted by User - Id ascending by default. If the responsePagingControl element is not provided, the - paging startIndex will be set to 1 by default, and the responsePageSize will be set to - the maximum responsePageSize by default. Multiple search criteria are logically ANDed - together unless the searchCriteriaModeOr option is included. Then the search criteria - are logically ORed together. - - Attributes: - service_provider_id (str): serviceProviderId - group_id (str): groupId - response_paging_control (OCI.responsePagingControl): responsePagingControl - *Optional* - sort_order (List[OCI.sortOrder]): sortOrder *Optional* - search_criteria_user_last_name (List[OCI.searchCriteriaUserLastName]): - searchCriteriaUserLastName *Optional* - search_criteria_department_name (List[OCI.searchCriteriaDepartmentName]): - searchCriteriaDepartmentName *Optional* - search_criteria_user_id (List[OCI.searchCriteriaUserId]): searchCriteriaUserId - *Optional* - search_criteria_dn (List[OCI.searchCriteriaDn]): searchCriteriaDn *Optional* - search_criteria_extension (List[OCI.searchCriteriaExtension]): - searchCriteriaExtension *Optional* - search_criteria_exact_dn_activation (OCI.searchCriteriaExactDnActivation): - searchCriteriaExactDnActivation *Optional* - search_criteria_service_status (OCI.searchCriteriaServiceStatus): - searchCriteriaServiceStatus *Optional* - search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* - """ - - __slots__: List[str] = [ - "service_provider_id", - "group_id", - "response_paging_control", - "sort_order", - "search_criteria_user_last_name", - "search_criteria_department_name", - "search_criteria_user_id", - "search_criteria_dn", - "search_criteria_extension", - "search_criteria_exact_dn_activation", - "search_criteria_service_status", - "search_criteria_mode_or", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("service_provider_id", "serviceProviderId", str, is_required=True), - E("group_id", "groupId", str, is_required=True), - E( - "response_paging_control", - "responsePagingControl", - OCI.ResponsePagingControl, - is_complex=True, - ), - E( - "sort_order", - "sortOrder", - OCI.SortOrderGroupHuntGroupGetInstancePagedSortedList, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_last_name", - "searchCriteriaUserLastName", - OCI.SearchCriteriaUserLastName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_department_name", - "searchCriteriaDepartmentName", - OCI.SearchCriteriaDepartmentName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_id", - "searchCriteriaUserId", - OCI.SearchCriteriaUserId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_dn", - "searchCriteriaDn", - OCI.SearchCriteriaDn, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_extension", - "searchCriteriaExtension", - OCI.SearchCriteriaExtension, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_exact_dn_activation", - "searchCriteriaExactDnActivation", - OCI.SearchCriteriaExactDnActivation, - is_complex=True, - ), - E( - "search_criteria_service_status", - "searchCriteriaServiceStatus", - OCI.SearchCriteriaServiceStatus, - is_complex=True, - ), - E("search_criteria_mode_or", "searchCriteriaModeOr", bool), - ) - - class GroupHuntGroupModifyInstanceRequest(OCIRequest): """ Request to modify a Hunt Group instance. @@ -129871,204 +120794,6 @@ def _elements(cls) -> Tuple[E, ...]: ) -class GroupPhoneDirectoryGetPagedSortedListRequest(OCIRequest): - """ - Request a table containing the phone directory for a group. - - The directory includes all users in the group and all entries in the group common - phone list. If the specified group is part of an enterprise, the directory includes - all users in the enterprise and all entries in the enterprise common phone list and - the common phone list of the specified group. If the specified group is part of a - service provider, the directory includes all users in the group and all entries in the - common phone list of the specified group. If the responsePagingControl element is not - provided, the paging startIndex will be set to 1 by default, and the responsePageSize - will be set to the maximum ResponsePageSize by default. It is possible to search by - various criteria to restrict the number of rows returned. If no sortOrder is included - the response is sorted by User Id ascending with a secondary sort by User Last Name - ascending by default. Multiple search criteria are logically ANDed together unless - the searchCriteriaModeOr option is included. Then the search criteria are logically - ORed together. `ErrorResponse()` is returned if searchCriteriaExactUserGroup or - searchCriteriaExactUserDepartment have multiple entries and searchCriteriaModeOr is - not included. The following elements are only used in AS data mode and ignored in - Amplify and XS data mode: "sortByImpId" "searchCriteriaImpId" - - The response is either `GroupPhoneDirectoryGetPagedSortedListResponse()` or - `ErrorResponse()`. - - Attributes: - service_provider_id (str): serviceProviderId - group_id (str): groupId - is_extended_info_requested (bool): isExtendedInfoRequested - response_paging_control (OCI.responsePagingControl): responsePagingControl - *Optional* - sort_order (List[OCI.sortOrder]): sortOrder *Optional* - search_criteria_user_last_name (List[OCI.searchCriteriaUserLastName]): - searchCriteriaUserLastName *Optional* - search_criteria_user_first_name (List[OCI.searchCriteriaUserFirstName]): - searchCriteriaUserFirstName *Optional* - search_criteria_dn (List[OCI.searchCriteriaDn]): searchCriteriaDn *Optional* - search_criteria_group_location_code (List[OCI.searchCriteriaGroupLocationCode]): - searchCriteriaGroupLocationCode *Optional* - search_criteria_extension (List[OCI.searchCriteriaExtension]): - searchCriteriaExtension *Optional* - search_criteria_mobile_phone_number (List[OCI.searchCriteriaMobilePhoneNumber]): - searchCriteriaMobilePhoneNumber *Optional* - search_criteria_email_address (List[OCI.searchCriteriaEmailAddress]): - searchCriteriaEmailAddress *Optional* - search_criteria_exact_user_department (OCI.searchCriteriaExactUserDepartment): - searchCriteriaExactUserDepartment *Optional* - search_criteria_department_name (List[OCI.searchCriteriaDepartmentName]): - searchCriteriaDepartmentName *Optional* - search_criteria_exact_user_group (OCI.searchCriteriaExactUserGroup): - searchCriteriaExactUserGroup *Optional* - search_criteria_yahoo_id (List[OCI.searchCriteriaYahooId]): searchCriteriaYahooId - *Optional* - search_criteria_user_id (List[OCI.searchCriteriaUserId]): searchCriteriaUserId - *Optional* - search_criteria_imp_id (List[OCI.searchCriteriaImpId]): searchCriteriaImpId - *Optional* - search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* - """ - - __slots__: List[str] = [ - "service_provider_id", - "group_id", - "is_extended_info_requested", - "response_paging_control", - "sort_order", - "search_criteria_user_last_name", - "search_criteria_user_first_name", - "search_criteria_dn", - "search_criteria_group_location_code", - "search_criteria_extension", - "search_criteria_mobile_phone_number", - "search_criteria_email_address", - "search_criteria_exact_user_department", - "search_criteria_department_name", - "search_criteria_exact_user_group", - "search_criteria_yahoo_id", - "search_criteria_user_id", - "search_criteria_imp_id", - "search_criteria_mode_or", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("service_provider_id", "serviceProviderId", str, is_required=True), - E("group_id", "groupId", str, is_required=True), - E( - "is_extended_info_requested", - "isExtendedInfoRequested", - bool, - is_required=True, - ), - E( - "response_paging_control", - "responsePagingControl", - OCI.ResponsePagingControl, - is_complex=True, - ), - E( - "sort_order", - "sortOrder", - OCI.SortOrderGroupPhoneDirectoryGetPagedSortedList, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_last_name", - "searchCriteriaUserLastName", - OCI.SearchCriteriaUserLastName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_first_name", - "searchCriteriaUserFirstName", - OCI.SearchCriteriaUserFirstName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_dn", - "searchCriteriaDn", - OCI.SearchCriteriaDn, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_group_location_code", - "searchCriteriaGroupLocationCode", - OCI.SearchCriteriaGroupLocationCode, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_extension", - "searchCriteriaExtension", - OCI.SearchCriteriaExtension, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_mobile_phone_number", - "searchCriteriaMobilePhoneNumber", - OCI.SearchCriteriaMobilePhoneNumber, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_email_address", - "searchCriteriaEmailAddress", - OCI.SearchCriteriaEmailAddress, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_exact_user_department", - "searchCriteriaExactUserDepartment", - OCI.SearchCriteriaExactUserDepartment, - is_complex=True, - ), - E( - "search_criteria_department_name", - "searchCriteriaDepartmentName", - OCI.SearchCriteriaDepartmentName, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_exact_user_group", - "searchCriteriaExactUserGroup", - OCI.SearchCriteriaExactUserGroup, - is_complex=True, - ), - E( - "search_criteria_yahoo_id", - "searchCriteriaYahooId", - OCI.SearchCriteriaYahooId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_user_id", - "searchCriteriaUserId", - OCI.SearchCriteriaUserId, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_imp_id", - "searchCriteriaImpId", - OCI.SearchCriteriaImpId, - is_complex=True, - is_array=True, - ), - E("search_criteria_mode_or", "searchCriteriaModeOr", bool), - ) - - class GroupPreAlertingAnnouncementModifyRequest(OCIRequest): """ Modify the group level pre-alerting service settings. @@ -130537,80 +121262,123 @@ def _elements(cls) -> Tuple[E, ...]: ) -class GroupRoutePointForcedForwardingModifyRequest(OCIRequest): +class GroupRoutePointExternalSystemGetAssignedRoutePointListRequest(OCIRequest): """ - Modify a route point's forced forwarding settings. + Request a list of route points within in a group that have a given external system + assigned. - The response is either a `SuccessResponse()` or an `ErrorResponse()`. + The response is either + `GroupRoutePointExternalSystemGetAssignedRoutePointListResponse()` or + `ErrorResponse()`. Attributes: - service_user_id (str): serviceUserId - is_active (bool): isActive *Optional* - forward_to_phone_number (str): forwardToPhoneNumber *Optional* - play_announcement_before_forwarding (bool): playAnnouncementBeforeForwarding - *Optional* - audio_message_selection (str): audioMessageSelection *Optional* - audio_url_list (OCI.audioUrlList): audioUrlList *Optional* - audio_file_list (OCI.audioFileList): audioFileList *Optional* - video_message_selection (str): videoMessageSelection *Optional* - video_url_list (OCI.videoUrlList): videoUrlList *Optional* - video_file_list (OCI.videoFileList): videoFileList *Optional* + service_provider_id (str): serviceProviderId + group_id (str): groupId + external_system (str): externalSystem + response_size_limit (int): responseSizeLimit *Optional* + search_criteria_route_point_name (List[OCI.searchCriteriaRoutePointName]): + searchCriteriaRoutePointName *Optional* """ __slots__: List[str] = [ - "service_user_id", - "is_active", - "forward_to_phone_number", - "play_announcement_before_forwarding", - "audio_message_selection", - "audio_url_list", - "audio_file_list", - "video_message_selection", - "video_url_list", - "video_file_list", + "service_provider_id", + "group_id", + "external_system", + "response_size_limit", + "search_criteria_route_point_name", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("service_user_id", "serviceUserId", str, is_required=True), - E("is_active", "isActive", bool), - E("forward_to_phone_number", "forwardToPhoneNumber", str), - E( - "play_announcement_before_forwarding", - "playAnnouncementBeforeForwarding", - bool, - ), - E("audio_message_selection", "audioMessageSelection", str), - E( - "audio_url_list", - "audioUrlList", - OCI.CallCenterAnnouncementURLListModify, - is_complex=True, - ), - E( - "audio_file_list", - "audioFileList", - OCI.CallCenterAnnouncementFileListModify, - is_complex=True, - ), - E("video_message_selection", "videoMessageSelection", str), - E( - "video_url_list", - "videoUrlList", - OCI.CallCenterAnnouncementURLListModify, - is_complex=True, - ), + E("service_provider_id", "serviceProviderId", str, is_required=True), + E("group_id", "groupId", str, is_required=True), + E("external_system", "externalSystem", str, is_required=True), + E("response_size_limit", "responseSizeLimit", int), E( - "video_file_list", - "videoFileList", - OCI.CallCenterAnnouncementFileListModify, + "search_criteria_route_point_name", + "searchCriteriaRoutePointName", + OCI.SearchCriteriaRoutePointName, is_complex=True, + is_array=True, ), ) -class GroupRoutePointForcedForwardingModifyRequest20(OCIRequest): +class GroupRoutePointForcedForwardingModifyRequest(OCIRequest): + """ + Modify a route point's forced forwarding settings. + + The response is either a `SuccessResponse()` or an `ErrorResponse()`. + + Attributes: + service_user_id (str): serviceUserId + is_active (bool): isActive *Optional* + forward_to_phone_number (str): forwardToPhoneNumber *Optional* + play_announcement_before_forwarding (bool): playAnnouncementBeforeForwarding + *Optional* + audio_message_selection (str): audioMessageSelection *Optional* + audio_url_list (OCI.audioUrlList): audioUrlList *Optional* + audio_file_list (OCI.audioFileList): audioFileList *Optional* + video_message_selection (str): videoMessageSelection *Optional* + video_url_list (OCI.videoUrlList): videoUrlList *Optional* + video_file_list (OCI.videoFileList): videoFileList *Optional* + """ + + __slots__: List[str] = [ + "service_user_id", + "is_active", + "forward_to_phone_number", + "play_announcement_before_forwarding", + "audio_message_selection", + "audio_url_list", + "audio_file_list", + "video_message_selection", + "video_url_list", + "video_file_list", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("service_user_id", "serviceUserId", str, is_required=True), + E("is_active", "isActive", bool), + E("forward_to_phone_number", "forwardToPhoneNumber", str), + E( + "play_announcement_before_forwarding", + "playAnnouncementBeforeForwarding", + bool, + ), + E("audio_message_selection", "audioMessageSelection", str), + E( + "audio_url_list", + "audioUrlList", + OCI.CallCenterAnnouncementURLListModify, + is_complex=True, + ), + E( + "audio_file_list", + "audioFileList", + OCI.CallCenterAnnouncementFileListModify, + is_complex=True, + ), + E("video_message_selection", "videoMessageSelection", str), + E( + "video_url_list", + "videoUrlList", + OCI.CallCenterAnnouncementURLListModify, + is_complex=True, + ), + E( + "video_file_list", + "videoFileList", + OCI.CallCenterAnnouncementFileListModify, + is_complex=True, + ), + ) + + +class GroupRoutePointForcedForwardingModifyRequest20(OCIRequest): """ Modify a route point's forced forwarding settings. @@ -130683,6 +121451,49 @@ def _elements(cls) -> Tuple[E, ...]: ) +class GroupRoutePointGetInstanceListRequest(OCIRequest): + """ + Get a list of Route Point instances within a group. + + It is possible to search by various criteria to restrict the number of rows returned. + + The response is either `GroupRoutePointGetInstanceListResponse()` or + `ErrorResponse()`. It is possible to get the instances within a specified department. + + Attributes: + service_provider_id (str): serviceProviderId + group_id (str): groupId + group_department_name (str): groupDepartmentName *Optional* + response_size_limit (int): responseSizeLimit *Optional* + search_criteria_route_point_name (List[OCI.searchCriteriaRoutePointName]): + searchCriteriaRoutePointName *Optional* + """ + + __slots__: List[str] = [ + "service_provider_id", + "group_id", + "group_department_name", + "response_size_limit", + "search_criteria_route_point_name", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("service_provider_id", "serviceProviderId", str, is_required=True), + E("group_id", "groupId", str, is_required=True), + E("group_department_name", "groupDepartmentName", str), + E("response_size_limit", "responseSizeLimit", int), + E( + "search_criteria_route_point_name", + "searchCriteriaRoutePointName", + OCI.SearchCriteriaRoutePointName, + is_complex=True, + is_array=True, + ), + ) + + class GroupRoutePointHolidayServiceModifyRequest(OCIRequest): """ Modify a route point's holiday service settings. @@ -131588,6 +122399,86 @@ def _elements(cls) -> Tuple[E, ...]: ) +class GroupScheduleGetPagedSortedListRequest(OCIRequest): + """ + Get the list of schedules viewable by a group. + + The response is either a `GroupScheduleGetPagedSortedListResponse()` or an + `ErrorResponse()`. If no sortOrder is included, the response is sorted by Name + ascending by default. If the responsePagingControl element is not provided, the + paging startIndex will be set to 1 by default, and the responsePageSize will be set to + the maximum responsePageSize by default. Multiple search criteria are logically ANDed + together unless the searchCriteriaModeOr option is included. Then the search criteria + are logically ORed together. + + Attributes: + service_provider_id (str): serviceProviderId + group_id (str): groupId + response_paging_control (OCI.responsePagingControl): responsePagingControl + *Optional* + sort_by_schedule_name (OCI.sortByScheduleName): sortByScheduleName *Optional* + search_criteria_schedule_name (List[OCI.searchCriteriaScheduleName]): + searchCriteriaScheduleName *Optional* + search_criteria_exact_schedule_type (List[OCI.searchCriteriaExactScheduleType]): + searchCriteriaExactScheduleType *Optional* + search_criteria_exact_schedule_level (List[OCI.searchCriteriaExactScheduleLevel]): + searchCriteriaExactScheduleLevel *Optional* + search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* + """ + + __slots__: List[str] = [ + "service_provider_id", + "group_id", + "response_paging_control", + "sort_by_schedule_name", + "search_criteria_schedule_name", + "search_criteria_exact_schedule_type", + "search_criteria_exact_schedule_level", + "search_criteria_mode_or", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("service_provider_id", "serviceProviderId", str, is_required=True), + E("group_id", "groupId", str, is_required=True), + E( + "response_paging_control", + "responsePagingControl", + OCI.ResponsePagingControl, + is_complex=True, + ), + E( + "sort_by_schedule_name", + "sortByScheduleName", + OCI.SortByScheduleName, + is_complex=True, + ), + E( + "search_criteria_schedule_name", + "searchCriteriaScheduleName", + OCI.SearchCriteriaScheduleName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_exact_schedule_type", + "searchCriteriaExactScheduleType", + OCI.SearchCriteriaExactScheduleType, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_exact_schedule_level", + "searchCriteriaExactScheduleLevel", + OCI.SearchCriteriaExactScheduleLevel, + is_complex=True, + is_array=True, + ), + E("search_criteria_mode_or", "searchCriteriaModeOr", bool), + ) + + class GroupSeriesCompletionGetAvailableUserListRequest(OCIRequest): """ Get a list of users that can be assigned to a Series Completion group. @@ -131736,6 +122627,84 @@ def _elements(cls) -> Tuple[E, ...]: ) +class GroupSessionAdmissionControlGetAvailableDeviceListRequest(OCIRequest): + """ + Request to get the list of devices can be assigned to session admission control group + for the group. + + The response is either an + `GroupSessionAdmissionControlGetAvailableDeviceListResponse()` or an + `ErrorResponse()`. + + Attributes: + service_provider_id (str): serviceProviderId + group_id (str): groupId + response_size_limit (int): responseSizeLimit *Optional* + search_criteria_device_name (List[OCI.searchCriteriaDeviceName]): + searchCriteriaDeviceName *Optional* + search_criteria_device_mac_address (List[OCI.searchCriteriaDeviceMACAddress]): + searchCriteriaDeviceMACAddress *Optional* + search_criteria_device_net_address (List[OCI.searchCriteriaDeviceNetAddress]): + searchCriteriaDeviceNetAddress *Optional* + search_criteria_exact_device_type (OCI.searchCriteriaExactDeviceType): + searchCriteriaExactDeviceType *Optional* + search_criteria_exact_device_level (OCI.searchCriteriaExactDeviceLevel): + searchCriteriaExactDeviceLevel *Optional* + """ + + __slots__: List[str] = [ + "service_provider_id", + "group_id", + "response_size_limit", + "search_criteria_device_name", + "search_criteria_device_mac_address", + "search_criteria_device_net_address", + "search_criteria_exact_device_type", + "search_criteria_exact_device_level", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("service_provider_id", "serviceProviderId", str, is_required=True), + E("group_id", "groupId", str, is_required=True), + E("response_size_limit", "responseSizeLimit", int), + E( + "search_criteria_device_name", + "searchCriteriaDeviceName", + OCI.SearchCriteriaDeviceName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_device_mac_address", + "searchCriteriaDeviceMACAddress", + OCI.SearchCriteriaDeviceMACAddress, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_device_net_address", + "searchCriteriaDeviceNetAddress", + OCI.SearchCriteriaDeviceNetAddress, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_exact_device_type", + "searchCriteriaExactDeviceType", + OCI.SearchCriteriaExactDeviceType, + is_complex=True, + ), + E( + "search_criteria_exact_device_level", + "searchCriteriaExactDeviceLevel", + OCI.SearchCriteriaExactDeviceLevel, + is_complex=True, + ), + ) + + class GroupSessionAdmissionControlGroupModifyRequest(OCIRequest): """ Request to modify a session admission control group for the group. @@ -136824,6 +127793,86 @@ def _elements(cls) -> Tuple[E, ...]: ) +class GroupVirtualOnNetEnterpriseExtensionsGetUserListRequest(OCIRequest): + """ + Request the list of Virtual On-Net users in a Group. + + It is possible to search by various criteria to restrict the number of rows returned. + Multiple search criteria are logically ANDed together. + + The response is either a `GroupVirtualOnNetEnterpriseExtensionsGetUserListResponse()` + or an `ErrorResponse()`. + + Attributes: + service_provider_id (str): serviceProviderId + group_id (str): groupId + response_size_limit (int): responseSizeLimit *Optional* + search_criteria_user_last_name (List[OCI.searchCriteriaUserLastName]): + searchCriteriaUserLastName *Optional* + search_criteria_user_first_name (List[OCI.searchCriteriaUserFirstName]): + searchCriteriaUserFirstName *Optional* + search_criteria_dn (List[OCI.searchCriteriaDn]): searchCriteriaDn *Optional* + search_criteria_extension (List[OCI.searchCriteriaExtension]): + searchCriteriaExtension *Optional* + search_criteria_exact_virtual_on_net_call_type_name + (OCI.searchCriteriaExactVirtualOnNetCallTypeName): + searchCriteriaExactVirtualOnNetCallTypeName *Optional* + """ + + __slots__: List[str] = [ + "service_provider_id", + "group_id", + "response_size_limit", + "search_criteria_user_last_name", + "search_criteria_user_first_name", + "search_criteria_dn", + "search_criteria_extension", + "search_criteria_exact_virtual_on_net_call_type_name", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("service_provider_id", "serviceProviderId", str, is_required=True), + E("group_id", "groupId", str, is_required=True), + E("response_size_limit", "responseSizeLimit", int), + E( + "search_criteria_user_last_name", + "searchCriteriaUserLastName", + OCI.SearchCriteriaUserLastName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_first_name", + "searchCriteriaUserFirstName", + OCI.SearchCriteriaUserFirstName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_dn", + "searchCriteriaDn", + OCI.SearchCriteriaDn, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_extension", + "searchCriteriaExtension", + OCI.SearchCriteriaExtension, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_exact_virtual_on_net_call_type_name", + "searchCriteriaExactVirtualOnNetCallTypeName", + OCI.SearchCriteriaExactVirtualOnNetCallTypeName, + is_complex=True, + ), + ) + + class GroupVoiceMessagingGroupConsolidatedModifyVoicePortalRequest(OCIRequest): """ Request to modify the group's voice messaging settings and voice portal branding @@ -137109,6 +128158,477 @@ def _elements(cls) -> Tuple[E, ...]: ) +class GroupXsiPolicyProfileGetAssignedUserListRequest(OCIRequest): + """ + Get a list of user within a group that have a given user Xsi policy profile assigned. + + The response is either a `GroupXsiPolicyProfileGetAssignedUserListResponse()` or an + `ErrorResponse()`. + + Attributes: + service_provider_id (str): serviceProviderId + group_id (str): groupId + xsi_policy_profile (OCI.xsiPolicyProfile): xsiPolicyProfile + response_size_limit (int): responseSizeLimit *Optional* + search_criteria_user_id (List[OCI.searchCriteriaUserId]): searchCriteriaUserId + *Optional* + search_criteria_user_last_name (List[OCI.searchCriteriaUserLastName]): + searchCriteriaUserLastName *Optional* + search_criteria_user_first_name (List[OCI.searchCriteriaUserFirstName]): + searchCriteriaUserFirstName *Optional* + search_criteria_dn (List[OCI.searchCriteriaDn]): searchCriteriaDn *Optional* + search_criteria_extension (List[OCI.searchCriteriaExtension]): + searchCriteriaExtension *Optional* + """ + + __slots__: List[str] = [ + "service_provider_id", + "group_id", + "xsi_policy_profile", + "response_size_limit", + "search_criteria_user_id", + "search_criteria_user_last_name", + "search_criteria_user_first_name", + "search_criteria_dn", + "search_criteria_extension", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("service_provider_id", "serviceProviderId", str, is_required=True), + E("group_id", "groupId", str, is_required=True), + E( + "xsi_policy_profile", + "xsiPolicyProfile", + OCI.XsiPolicyProfileKey, + is_complex=True, + is_required=True, + ), + E("response_size_limit", "responseSizeLimit", int), + E( + "search_criteria_user_id", + "searchCriteriaUserId", + OCI.SearchCriteriaUserId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_last_name", + "searchCriteriaUserLastName", + OCI.SearchCriteriaUserLastName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_first_name", + "searchCriteriaUserFirstName", + OCI.SearchCriteriaUserFirstName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_dn", + "searchCriteriaDn", + OCI.SearchCriteriaDn, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_extension", + "searchCriteriaExtension", + OCI.SearchCriteriaExtension, + is_complex=True, + is_array=True, + ), + ) + + +class ResellerGetListRequest(OCIRequest): + """ + Request a list of resellers in the system. + + It is possible to search by various criteria to restrict the number of rows returned. + Multiple search criteria are logically ANDed together. + + The response is either a `ResellerGetListResponse()` or an `ErrorResponse()`. + + Attributes: + response_size_limit (int): responseSizeLimit *Optional* + search_criteria_reseller_id (List[OCI.searchCriteriaResellerId]): + searchCriteriaResellerId *Optional* + search_criteria_reseller_name (List[OCI.searchCriteriaResellerName]): + searchCriteriaResellerName *Optional* + """ + + __slots__: List[str] = [ + "response_size_limit", + "search_criteria_reseller_id", + "search_criteria_reseller_name", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("response_size_limit", "responseSizeLimit", int), + E( + "search_criteria_reseller_id", + "searchCriteriaResellerId", + OCI.SearchCriteriaResellerId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_reseller_name", + "searchCriteriaResellerName", + OCI.SearchCriteriaResellerName, + is_complex=True, + is_array=True, + ), + ) + + +class ResellerNetworkClassOfServiceGetAssignedServiceProviderListRequest(OCIRequest): + """ + Get a list of service provider/enterprises within a reseller that have a given Network + Class of Service assigned. + + The response is either a + `ResellerNetworkClassOfServiceGetAssignedServiceProviderListResponse()` or an + `ErorResponse()`. + + Attributes: + reseller_id (str): resellerId + network_class_of_service (str): networkClassOfService + response_size_limit (int): responseSizeLimit *Optional* + search_criteria_service_provider_id (List[OCI.searchCriteriaServiceProviderId]): + searchCriteriaServiceProviderId *Optional* + search_criteria_service_provider_name + (List[OCI.searchCriteriaServiceProviderName]): + searchCriteriaServiceProviderName *Optional* + """ + + __slots__: List[str] = [ + "reseller_id", + "network_class_of_service", + "response_size_limit", + "search_criteria_service_provider_id", + "search_criteria_service_provider_name", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("reseller_id", "resellerId", str, is_required=True), + E( + "network_class_of_service", + "networkClassOfService", + str, + is_required=True, + ), + E("response_size_limit", "responseSizeLimit", int), + E( + "search_criteria_service_provider_id", + "searchCriteriaServiceProviderId", + OCI.SearchCriteriaServiceProviderId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_service_provider_name", + "searchCriteriaServiceProviderName", + OCI.SearchCriteriaServiceProviderName, + is_complex=True, + is_array=True, + ), + ) + + +class ResellerXsiPolicyProfileGetAssignedServiceProviderListRequest(OCIRequest): + """ + Get a list of service provider/enterprises within a reseller that have a given Service + provider Xsi policy profile assigned. + + The response is either a + `ResellerXsiPolichProfileGetAssignedServiceProviderListResponse()` or an + `ErrorResponse()`. + + Attributes: + reseller_id (str): resellerId + xsi_policy_profile (OCI.xsiPolicyProfile): xsiPolicyProfile + response_size_limit (int): responseSizeLimit *Optional* + search_criteria_service_provider_id (List[OCI.searchCriteriaServiceProviderId]): + searchCriteriaServiceProviderId *Optional* + search_criteria_service_provider_name + (List[OCI.searchCriteriaServiceProviderName]): + searchCriteriaServiceProviderName *Optional* + search_criteria_exact_organization_type (OCI.searchCriteriaExactOrganizationType): + searchCriteriaExactOrganizationType *Optional* + """ + + __slots__: List[str] = [ + "reseller_id", + "xsi_policy_profile", + "response_size_limit", + "search_criteria_service_provider_id", + "search_criteria_service_provider_name", + "search_criteria_exact_organization_type", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("reseller_id", "resellerId", str, is_required=True), + E( + "xsi_policy_profile", + "xsiPolicyProfile", + OCI.XsiPolicyProfileKey, + is_complex=True, + is_required=True, + ), + E("response_size_limit", "responseSizeLimit", int), + E( + "search_criteria_service_provider_id", + "searchCriteriaServiceProviderId", + OCI.SearchCriteriaServiceProviderId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_service_provider_name", + "searchCriteriaServiceProviderName", + OCI.SearchCriteriaServiceProviderName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_exact_organization_type", + "searchCriteriaExactOrganizationType", + OCI.SearchCriteriaExactOrganizationType, + is_complex=True, + ), + ) + + +class ServiceProviderAccessDeviceGetListRequest(OCIRequest): + """ + Requests the list of access devices in a service provider. + + The following elements are only used in AS data mode and ignored in XS data mode: + serviceProviderExternalId + + The response is either `ServiceProviderAccessDeviceGetListResponse()` or + `ErrorResponse()`. + + Attributes: + service_provider_id (str): serviceProviderId *Optional* + service_provider_external_id (str): serviceProviderExternalId *Optional* + response_size_limit (int): responseSizeLimit *Optional* + search_criteria_device_name (List[OCI.searchCriteriaDeviceName]): + searchCriteriaDeviceName *Optional* + search_criteria_device_mac_address (List[OCI.searchCriteriaDeviceMACAddress]): + searchCriteriaDeviceMACAddress *Optional* + search_criteria_device_net_address (List[OCI.searchCriteriaDeviceNetAddress]): + searchCriteriaDeviceNetAddress *Optional* + search_criteria_exact_device_type (OCI.searchCriteriaExactDeviceType): + searchCriteriaExactDeviceType *Optional* + search_criteria_access_device_version + (List[OCI.searchCriteriaAccessDeviceVersion]): + searchCriteriaAccessDeviceVersion *Optional* + """ + + __slots__: List[str] = [ + "service_provider_id", + "service_provider_external_id", + "response_size_limit", + "search_criteria_device_name", + "search_criteria_device_mac_address", + "search_criteria_device_net_address", + "search_criteria_exact_device_type", + "search_criteria_access_device_version", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("service_provider_id", "serviceProviderId", str), + E("service_provider_external_id", "serviceProviderExternalId", str), + E("response_size_limit", "responseSizeLimit", int), + E( + "search_criteria_device_name", + "searchCriteriaDeviceName", + OCI.SearchCriteriaDeviceName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_device_mac_address", + "searchCriteriaDeviceMACAddress", + OCI.SearchCriteriaDeviceMACAddress, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_device_net_address", + "searchCriteriaDeviceNetAddress", + OCI.SearchCriteriaDeviceNetAddress, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_exact_device_type", + "searchCriteriaExactDeviceType", + OCI.SearchCriteriaExactDeviceType, + is_complex=True, + ), + E( + "search_criteria_access_device_version", + "searchCriteriaAccessDeviceVersion", + OCI.SearchCriteriaAccessDeviceVersion, + is_complex=True, + is_array=True, + ), + ) + + +class ServiceProviderAccessDeviceGetPagedSortedListRequest(OCIRequest): + """ + Requests the list of service provider level access devices. + + The response is either `ServiceProviderAccessDeviceGetPagedSortedListResponse()` or + `ErrorResponse()`. If no sortOrder is included, the response is sorted by Device Name + ascending by default. If the responsePagingControl element is not provided, the + paging startIndex will be set to 1 by default, and the responsePageSize will be set to + the maximum responsePageSize by default. Multiple search criteria are logically ANDed + together unless the searchCriteriaModeOr option is included. Then the search criteria + are logically ORed together. The getVisualDeviceManagementAPIDevicesOnly element can + only be set when CloudPBX is licenced. If the getVisualDeviceManagementAPIDevicesOnly + element is not set, all devices are returned with Visual Device Management API flag + set to empty. If the getVisualDeviceManagementAPIDevicesOnly element is set to true, + only SIP devices supporting Visual Device Management API are returned. If the + getVisualDeviceManagementAPIDevicesOnly element is set to false, all SIP devices are + returned with their current Visual Device Management API flag value. + + Attributes: + service_provider_id (str): serviceProviderId + response_paging_control (OCI.responsePagingControl): responsePagingControl + *Optional* + sort_by_device_name (OCI.sortByDeviceName): sortByDeviceName *Optional* + sort_by_device_type (OCI.sortByDeviceType): sortByDeviceType *Optional* + sort_by_device_net_address (OCI.sortByDeviceNetAddress): sortByDeviceNetAddress + *Optional* + sort_by_device_mac_address (OCI.sortByDeviceMACAddress): sortByDeviceMACAddress + *Optional* + search_criteria_device_name (List[OCI.searchCriteriaDeviceName]): + searchCriteriaDeviceName *Optional* + search_criteria_device_mac_address (List[OCI.searchCriteriaDeviceMACAddress]): + searchCriteriaDeviceMACAddress *Optional* + search_criteria_device_net_address (List[OCI.searchCriteriaDeviceNetAddress]): + searchCriteriaDeviceNetAddress *Optional* + search_criteria_exact_device_type (List[OCI.searchCriteriaExactDeviceType]): + searchCriteriaExactDeviceType *Optional* + search_criteria_access_device_version + (List[OCI.searchCriteriaAccessDeviceVersion]): + searchCriteriaAccessDeviceVersion *Optional* + search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* + get_visual_device_management_api_devices_only (bool): + getVisualDeviceManagementAPIDevicesOnly *Optional* + """ + + __slots__: List[str] = [ + "service_provider_id", + "response_paging_control", + "sort_by_device_name", + "sort_by_device_type", + "sort_by_device_net_address", + "sort_by_device_mac_address", + "search_criteria_device_name", + "search_criteria_device_mac_address", + "search_criteria_device_net_address", + "search_criteria_exact_device_type", + "search_criteria_access_device_version", + "search_criteria_mode_or", + "get_visual_device_management_api_devices_only", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("service_provider_id", "serviceProviderId", str, is_required=True), + E( + "response_paging_control", + "responsePagingControl", + OCI.ResponsePagingControl, + is_complex=True, + ), + E( + "sort_by_device_name", + "sortByDeviceName", + OCI.SortByDeviceName, + is_complex=True, + ), + E( + "sort_by_device_type", + "sortByDeviceType", + OCI.SortByDeviceType, + is_complex=True, + ), + E( + "sort_by_device_net_address", + "sortByDeviceNetAddress", + OCI.SortByDeviceNetAddress, + is_complex=True, + ), + E( + "sort_by_device_mac_address", + "sortByDeviceMACAddress", + OCI.SortByDeviceMACAddress, + is_complex=True, + ), + E( + "search_criteria_device_name", + "searchCriteriaDeviceName", + OCI.SearchCriteriaDeviceName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_device_mac_address", + "searchCriteriaDeviceMACAddress", + OCI.SearchCriteriaDeviceMACAddress, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_device_net_address", + "searchCriteriaDeviceNetAddress", + OCI.SearchCriteriaDeviceNetAddress, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_exact_device_type", + "searchCriteriaExactDeviceType", + OCI.SearchCriteriaExactDeviceType, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_access_device_version", + "searchCriteriaAccessDeviceVersion", + OCI.SearchCriteriaAccessDeviceVersion, + is_complex=True, + is_array=True, + ), + E("search_criteria_mode_or", "searchCriteriaModeOr", bool), + E( + "get_visual_device_management_api_devices_only", + "getVisualDeviceManagementAPIDevicesOnly", + bool, + ), + ) + + class ServiceProviderAccessDeviceGetUserListRequest(OCIRequest): """ Requests the list of users on a specified device. @@ -137430,102 +128950,155 @@ def _elements(cls) -> Tuple[E, ...]: ) -class ServiceProviderAdminGetPagedSortedListRequest(OCIRequest): +class ServiceProviderBroadWorksMobilityMobileSubscriberDirectoryNumberGetSummaryListRequest( + OCIRequest, +): """ - Get a list of service provider administrators. + Request a summary table of all Mobile Subscriber Directory Numbers in a service + provider. - The response is either a `ServiceProviderAdminGetPagedSortedListResponse()` or an - `ErrorResponse()`. If no sortOrder is included, the response is sorted by - Administrator ID ascending by default. If the responsePagingControl element is not - provided, the paging startIndex will be set to 1 by default, and the responsePageSize - will be set to the maximum responsePageSize by default. Multiple search criteria are - logically ANDed together unless the searchCriteriaModeOr option is included. Then the - search criteria are logically ORed together. + This command is applicable only for service providers and will fail for enterprises. + + The response is either + `ServiceProviderBroadWorksMobilityMobileSubscriberDirectoryNumberGetSummaryListResponse()` + or `ErrorResponse()`. Attributes: service_provider_id (str): serviceProviderId - response_paging_control (OCI.responsePagingControl): responsePagingControl - *Optional* - sort_order (List[OCI.sortOrder]): sortOrder *Optional* - search_criteria_admin_id (List[OCI.searchCriteriaAdminId]): searchCriteriaAdminId + response_size_limit (int): responseSizeLimit *Optional* + search_criteria_mobile_subscriber_directory_number + (List[OCI.searchCriteriaMobileSubscriberDirectoryNumber]): + searchCriteriaMobileSubscriberDirectoryNumber *Optional* + search_criteria_group_id (List[OCI.searchCriteriaGroupId]): searchCriteriaGroupId *Optional* - search_criteria_admin_last_name (List[OCI.searchCriteriaAdminLastName]): - searchCriteriaAdminLastName *Optional* - search_criteria_admin_first_name (List[OCI.searchCriteriaAdminFirstName]): - searchCriteriaAdminFirstName *Optional* - search_criteria_exact_service_provider_admin_type - (List[OCI.searchCriteriaExactServiceProviderAdminType]): - searchCriteriaExactServiceProviderAdminType *Optional* - search_criteria_language (List[OCI.searchCriteriaLanguage]): - searchCriteriaLanguage *Optional* - search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* + search_criteria_exact_mobile_network (OCI.searchCriteriaExactMobileNetwork): + searchCriteriaExactMobileNetwork *Optional* """ __slots__: List[str] = [ "service_provider_id", - "response_paging_control", - "sort_order", - "search_criteria_admin_id", - "search_criteria_admin_last_name", - "search_criteria_admin_first_name", - "search_criteria_exact_service_provider_admin_type", - "search_criteria_language", - "search_criteria_mode_or", + "response_size_limit", + "search_criteria_mobile_subscriber_directory_number", + "search_criteria_group_id", + "search_criteria_exact_mobile_network", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( E("service_provider_id", "serviceProviderId", str, is_required=True), + E("response_size_limit", "responseSizeLimit", int), E( - "response_paging_control", - "responsePagingControl", - OCI.ResponsePagingControl, - is_complex=True, - ), - E( - "sort_order", - "sortOrder", - OCI.SortOrderServiceProviderAdminGetPagedSortedList, + "search_criteria_mobile_subscriber_directory_number", + "searchCriteriaMobileSubscriberDirectoryNumber", + OCI.SearchCriteriaMobileSubscriberDirectoryNumber, is_complex=True, is_array=True, ), E( - "search_criteria_admin_id", - "searchCriteriaAdminId", - OCI.SearchCriteriaAdminId, + "search_criteria_group_id", + "searchCriteriaGroupId", + OCI.SearchCriteriaGroupId, is_complex=True, is_array=True, ), E( - "search_criteria_admin_last_name", - "searchCriteriaAdminLastName", - OCI.SearchCriteriaAdminLastName, + "search_criteria_exact_mobile_network", + "searchCriteriaExactMobileNetwork", + OCI.SearchCriteriaExactMobileNetwork, is_complex=True, - is_array=True, ), + ) + + +class ServiceProviderCommunicationBarringDigitPatternCriteriaGetPatternListRequest( + OCIRequest, +): + """ + Get an existing Digit Pattern Criteria. + + The response is either a + `ServiceProviderCommunicationBarringDigitPatternCriteriaGetPatternListResponse()` or + an `ErrorResponse()`. + + Attributes: + service_provider_id (str): serviceProviderId + name (str): name + response_size_limit (int): responseSizeLimit *Optional* + search_criteria_digit_pattern (List[OCI.searchCriteriaDigitPattern]): + searchCriteriaDigitPattern *Optional* + """ + + __slots__: List[str] = [ + "service_provider_id", + "name", + "response_size_limit", + "search_criteria_digit_pattern", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("service_provider_id", "serviceProviderId", str, is_required=True), + E("name", "name", str, is_required=True), + E("response_size_limit", "responseSizeLimit", int), E( - "search_criteria_admin_first_name", - "searchCriteriaAdminFirstName", - OCI.SearchCriteriaAdminFirstName, + "search_criteria_digit_pattern", + "searchCriteriaDigitPattern", + OCI.SearchCriteriaDigitPattern, is_complex=True, is_array=True, ), + ) + + +class ServiceProviderCommunicationBarringProfileGetAssignedGroupListRequest(OCIRequest): + """ + Get a list of groups within a service provider that have a given Communication Barring + Profile assigned. + + The response is either a + `ServiceProviderCommunicationBarringProfileGetAssignedGroupListResponse()` or an + `ErorResponse()`. + + Attributes: + service_provider_id (str): serviceProviderId + profile (str): profile + response_size_limit (int): responseSizeLimit *Optional* + search_criteria_group_id (List[OCI.searchCriteriaGroupId]): searchCriteriaGroupId + *Optional* + search_criteria_group_name (List[OCI.searchCriteriaGroupName]): + searchCriteriaGroupName *Optional* + """ + + __slots__: List[str] = [ + "service_provider_id", + "profile", + "response_size_limit", + "search_criteria_group_id", + "search_criteria_group_name", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("service_provider_id", "serviceProviderId", str, is_required=True), + E("profile", "profile", str, is_required=True), + E("response_size_limit", "responseSizeLimit", int), E( - "search_criteria_exact_service_provider_admin_type", - "searchCriteriaExactServiceProviderAdminType", - OCI.SearchCriteriaExactServiceProviderAdminType, + "search_criteria_group_id", + "searchCriteriaGroupId", + OCI.SearchCriteriaGroupId, is_complex=True, is_array=True, ), E( - "search_criteria_language", - "searchCriteriaLanguage", - OCI.SearchCriteriaLanguage, + "search_criteria_group_name", + "searchCriteriaGroupName", + OCI.SearchCriteriaGroupName, is_complex=True, is_array=True, ), - E("search_criteria_mode_or", "searchCriteriaModeOr", bool), ) @@ -137821,560 +129394,4077 @@ def _elements(cls) -> Tuple[E, ...]: ) -class ServiceProviderEndpointGetListRequest(OCIRequest): +class ServiceProviderDeviceManagementEventGetListRequest(OCIRequest): """ - Request to search endpoints in the service provider/enterprise. + Request device management's events for a specific queue. - The response is either `ServiceProviderEndpointGetListResponse()` or - `ErrorResponse()`. + It is possible to restrict the number of rows returned using responseSizeLimit. If + eventQueueType is not specified, the events from all the event queues are returned. + + The response is either a `ServiceProviderDeviceManagementEventGetListResponse()` or an + `ErrorResponse()`. Deprecated by: + `ServiceProviderDeviceManagementEventGetListRequest22()`. Attributes: service_provider_id (str): serviceProviderId + event_queue_type (str): eventQueueType *Optional* response_size_limit (int): responseSizeLimit *Optional* - search_criteria_group_id (List[OCI.searchCriteriaGroupId]): searchCriteriaGroupId - *Optional* - search_criteria_line_port_user_part (List[OCI.searchCriteriaLinePortUserPart]): - searchCriteriaLinePortUserPart *Optional* - search_criteria_line_port_domain (List[OCI.searchCriteriaLinePortDomain]): - searchCriteriaLinePortDomain *Optional* - search_criteria_user_last_name (List[OCI.searchCriteriaUserLastName]): - searchCriteriaUserLastName *Optional* - search_criteria_user_first_name (List[OCI.searchCriteriaUserFirstName]): - searchCriteriaUserFirstName *Optional* - search_criteria_user_id (List[OCI.searchCriteriaUserId]): searchCriteriaUserId - *Optional* - search_criteria_dn (List[OCI.searchCriteriaDn]): searchCriteriaDn *Optional* - search_criteria_extension (List[OCI.searchCriteriaExtension]): - searchCriteriaExtension *Optional* - search_criteria_device_type (List[OCI.searchCriteriaDeviceType]): - searchCriteriaDeviceType *Optional* - search_criteria_device_name (List[OCI.searchCriteriaDeviceName]): - searchCriteriaDeviceName *Optional* - search_criteria_device_mac_address (List[OCI.searchCriteriaDeviceMACAddress]): - searchCriteriaDeviceMACAddress *Optional* - search_criteria_device_net_address (List[OCI.searchCriteriaDeviceNetAddress]): - searchCriteriaDeviceNetAddress *Optional* - search_criteria_exact_user_department (OCI.searchCriteriaExactUserDepartment): - searchCriteriaExactUserDepartment *Optional* + search_criteria_exact_device_management_event_status_in_progress_or_pending + (OCI.searchCriteriaExactDeviceManagementEventStatusInProgressOrPending): + searchCriteriaExactDeviceManagementEventStatusInProgressOrPending *Optional* + search_criteria_exact_device_management_event_status_completed + (OCI.searchCriteriaExactDeviceManagementEventStatusCompleted): + searchCriteriaExactDeviceManagementEventStatusCompleted *Optional* + search_criteria_exact_device_management_event_action + (OCI.searchCriteriaExactDeviceManagementEventAction): + searchCriteriaExactDeviceManagementEventAction *Optional* + search_criteria_exact_device_management_event_level + (OCI.searchCriteriaExactDeviceManagementEventLevel): + searchCriteriaExactDeviceManagementEventLevel *Optional* + search_criteria_exact_device_management_event_type + (OCI.searchCriteriaExactDeviceManagementEventType): + searchCriteriaExactDeviceManagementEventType *Optional* + search_criteria_device_management_event_additional_info + (List[OCI.searchCriteriaDeviceManagementEventAdditionalInfo]): + searchCriteriaDeviceManagementEventAdditionalInfo *Optional* + search_criteria_device_management_event_login_id + (List[OCI.searchCriteriaDeviceManagementEventLoginId]): + searchCriteriaDeviceManagementEventLoginId *Optional* """ __slots__: List[str] = [ "service_provider_id", + "event_queue_type", "response_size_limit", - "search_criteria_group_id", - "search_criteria_line_port_user_part", - "search_criteria_line_port_domain", - "search_criteria_user_last_name", - "search_criteria_user_first_name", - "search_criteria_user_id", - "search_criteria_dn", - "search_criteria_extension", - "search_criteria_device_type", - "search_criteria_device_name", - "search_criteria_device_mac_address", - "search_criteria_device_net_address", - "search_criteria_exact_user_department", + "search_criteria_exact_device_management_event_status_in_progress_or_pending", + "search_criteria_exact_device_management_event_status_completed", + "search_criteria_exact_device_management_event_action", + "search_criteria_exact_device_management_event_level", + "search_criteria_exact_device_management_event_type", + "search_criteria_device_management_event_additional_info", + "search_criteria_device_management_event_login_id", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( E("service_provider_id", "serviceProviderId", str, is_required=True), + E("event_queue_type", "eventQueueType", str), E("response_size_limit", "responseSizeLimit", int), E( - "search_criteria_group_id", - "searchCriteriaGroupId", - OCI.SearchCriteriaGroupId, + "search_criteria_exact_device_management_event_status_in_progress_or_pending", + "searchCriteriaExactDeviceManagementEventStatusInProgressOrPending", + OCI.SearchCriteriaExactDeviceManagementEventStatusInProgressOrPending, is_complex=True, - is_array=True, ), E( - "search_criteria_line_port_user_part", - "searchCriteriaLinePortUserPart", - OCI.SearchCriteriaLinePortUserPart, + "search_criteria_exact_device_management_event_status_completed", + "searchCriteriaExactDeviceManagementEventStatusCompleted", + OCI.SearchCriteriaExactDeviceManagementEventStatusCompleted, is_complex=True, - is_array=True, ), E( - "search_criteria_line_port_domain", - "searchCriteriaLinePortDomain", - OCI.SearchCriteriaLinePortDomain, + "search_criteria_exact_device_management_event_action", + "searchCriteriaExactDeviceManagementEventAction", + OCI.SearchCriteriaExactDeviceManagementEventAction, is_complex=True, - is_array=True, ), E( - "search_criteria_user_last_name", - "searchCriteriaUserLastName", - OCI.SearchCriteriaUserLastName, + "search_criteria_exact_device_management_event_level", + "searchCriteriaExactDeviceManagementEventLevel", + OCI.SearchCriteriaExactDeviceManagementEventLevel, is_complex=True, - is_array=True, ), E( - "search_criteria_user_first_name", - "searchCriteriaUserFirstName", - OCI.SearchCriteriaUserFirstName, + "search_criteria_exact_device_management_event_type", + "searchCriteriaExactDeviceManagementEventType", + OCI.SearchCriteriaExactDeviceManagementEventType, is_complex=True, - is_array=True, ), E( - "search_criteria_user_id", - "searchCriteriaUserId", - OCI.SearchCriteriaUserId, + "search_criteria_device_management_event_additional_info", + "searchCriteriaDeviceManagementEventAdditionalInfo", + OCI.SearchCriteriaDeviceManagementEventAdditionalInfo, is_complex=True, is_array=True, ), E( - "search_criteria_dn", - "searchCriteriaDn", - OCI.SearchCriteriaDn, + "search_criteria_device_management_event_login_id", + "searchCriteriaDeviceManagementEventLoginId", + OCI.SearchCriteriaDeviceManagementEventLoginId, is_complex=True, is_array=True, ), + ) + + +class ServiceProviderDeviceManagementEventGetListRequest22(OCIRequest): + """ + Request device management's events for a specific queue. + + It is possible to restrict the number of rows returned using responseSizeLimit. If + eventQueueType is not specified, the events from all the event queues are returned. + + The response is either a `ServiceProviderDeviceManagementEventGetListResponse22()` or + an `ErrorResponse()`. + + Attributes: + service_provider_id (str): serviceProviderId + event_queue_type (str): eventQueueType *Optional* + response_size_limit (int): responseSizeLimit *Optional* + search_criteria_exact_device_management_event_status_in_progress_or_pending + (OCI.searchCriteriaExactDeviceManagementEventStatusInProgressOrPending): + searchCriteriaExactDeviceManagementEventStatusInProgressOrPending *Optional* + search_criteria_exact_device_management_event_status_completed + (OCI.searchCriteriaExactDeviceManagementEventStatusCompleted): + searchCriteriaExactDeviceManagementEventStatusCompleted *Optional* + search_criteria_exact_device_management_event_action + (OCI.searchCriteriaExactDeviceManagementEventAction): + searchCriteriaExactDeviceManagementEventAction *Optional* + search_criteria_exact_device_management_event_level + (OCI.searchCriteriaExactDeviceManagementEventLevel): + searchCriteriaExactDeviceManagementEventLevel *Optional* + search_criteria_exact_device_management_event_type + (OCI.searchCriteriaExactDeviceManagementEventType): + searchCriteriaExactDeviceManagementEventType *Optional* + search_criteria_device_management_event_additional_info + (List[OCI.searchCriteriaDeviceManagementEventAdditionalInfo]): + searchCriteriaDeviceManagementEventAdditionalInfo *Optional* + search_criteria_device_management_event_login_id + (List[OCI.searchCriteriaDeviceManagementEventLoginId]): + searchCriteriaDeviceManagementEventLoginId *Optional* + """ + + __slots__: List[str] = [ + "service_provider_id", + "event_queue_type", + "response_size_limit", + "search_criteria_exact_device_management_event_status_in_progress_or_pending", + "search_criteria_exact_device_management_event_status_completed", + "search_criteria_exact_device_management_event_action", + "search_criteria_exact_device_management_event_level", + "search_criteria_exact_device_management_event_type", + "search_criteria_device_management_event_additional_info", + "search_criteria_device_management_event_login_id", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("service_provider_id", "serviceProviderId", str, is_required=True), + E("event_queue_type", "eventQueueType", str), + E("response_size_limit", "responseSizeLimit", int), + E( + "search_criteria_exact_device_management_event_status_in_progress_or_pending", + "searchCriteriaExactDeviceManagementEventStatusInProgressOrPending", + OCI.SearchCriteriaExactDeviceManagementEventStatusInProgressOrPending, + is_complex=True, + ), E( - "search_criteria_extension", - "searchCriteriaExtension", - OCI.SearchCriteriaExtension, + "search_criteria_exact_device_management_event_status_completed", + "searchCriteriaExactDeviceManagementEventStatusCompleted", + OCI.SearchCriteriaExactDeviceManagementEventStatusCompleted, is_complex=True, - is_array=True, ), E( - "search_criteria_device_type", - "searchCriteriaDeviceType", - OCI.SearchCriteriaDeviceType, + "search_criteria_exact_device_management_event_action", + "searchCriteriaExactDeviceManagementEventAction", + OCI.SearchCriteriaExactDeviceManagementEventAction, is_complex=True, - is_array=True, ), E( - "search_criteria_device_name", - "searchCriteriaDeviceName", - OCI.SearchCriteriaDeviceName, + "search_criteria_exact_device_management_event_level", + "searchCriteriaExactDeviceManagementEventLevel", + OCI.SearchCriteriaExactDeviceManagementEventLevel, is_complex=True, - is_array=True, ), E( - "search_criteria_device_mac_address", - "searchCriteriaDeviceMACAddress", - OCI.SearchCriteriaDeviceMACAddress, + "search_criteria_exact_device_management_event_type", + "searchCriteriaExactDeviceManagementEventType", + OCI.SearchCriteriaExactDeviceManagementEventType, is_complex=True, - is_array=True, ), E( - "search_criteria_device_net_address", - "searchCriteriaDeviceNetAddress", - OCI.SearchCriteriaDeviceNetAddress, + "search_criteria_device_management_event_additional_info", + "searchCriteriaDeviceManagementEventAdditionalInfo", + OCI.SearchCriteriaDeviceManagementEventAdditionalInfo, is_complex=True, is_array=True, ), E( - "search_criteria_exact_user_department", - "searchCriteriaExactUserDepartment", - OCI.SearchCriteriaExactUserDepartment, + "search_criteria_device_management_event_login_id", + "searchCriteriaDeviceManagementEventLoginId", + OCI.SearchCriteriaDeviceManagementEventLoginId, is_complex=True, + is_array=True, ), ) -class ServiceProviderGetPagedSortedListRequest(OCIRequest): +class ServiceProviderDnGetSummaryListRequest(OCIRequest): """ - Request a list of service providers and/or enterprises in the system. + Request a summary table of all DNs in a service provider. - The response is either a `ServiceProviderGetPagedSortedListResponse()` or an - `ErrorResponse()`. If reseller administrator sends the request, - searchCriteriaResellerId is ignored. Service providers/enterprise within the - administrator's reseller meeting the search criteria are returned. If the - responsePagingControl element is not provided, the paging startIndex will be set to 1 - by default, and the responsePageSize will be set to the maximum responsePageSize by - default. If no sortOrder is included, the response is sorted by Service Provider Id - ascending by default. Multiple search criteria are logically ANDed together unless - the searchCriteriaModeOr option is included. Then the search criteria are logically - ORed together. + Dns assigned to the IMRN pool are not listed in the response. The search can be done + using multiple criteria. Only results matching all the search criteria are included + in the results. + + The response is either `ServiceProviderDnGetSummaryListResponse()` or + `ErrorResponse()`. The following elements are only used in XS data mode and ignored in + AS data mode: searchCriteriaDn, searchCriteriaGroupId Attributes: - response_paging_control (OCI.responsePagingControl): responsePagingControl + service_provider_id (str): serviceProviderId + search_criteria_group_id (List[OCI.searchCriteriaGroupId]): searchCriteriaGroupId *Optional* - sort_order (List[OCI.sortOrder]): sortOrder *Optional* - search_criteria_service_provider_id (List[OCI.searchCriteriaServiceProviderId]): - searchCriteriaServiceProviderId *Optional* - search_criteria_service_provider_name - (List[OCI.searchCriteriaServiceProviderName]): - searchCriteriaServiceProviderName *Optional* - search_criteria_exact_organization_type (OCI.searchCriteriaExactOrganizationType): - searchCriteriaExactOrganizationType *Optional* - search_criteria_reseller_id (List[OCI.searchCriteriaResellerId]): - searchCriteriaResellerId *Optional* - search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* + search_criteria_dn (List[OCI.searchCriteriaDn]): searchCriteriaDn *Optional* """ __slots__: List[str] = [ - "response_paging_control", - "sort_order", - "search_criteria_service_provider_id", - "search_criteria_service_provider_name", - "search_criteria_exact_organization_type", - "search_criteria_reseller_id", - "search_criteria_mode_or", + "service_provider_id", + "search_criteria_group_id", + "search_criteria_dn", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( + E("service_provider_id", "serviceProviderId", str, is_required=True), E( - "response_paging_control", - "responsePagingControl", - OCI.ResponsePagingControl, - is_complex=True, - ), - E( - "sort_order", - "sortOrder", - OCI.SortOrderServiceProviderGetPagedSortedList, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_service_provider_id", - "searchCriteriaServiceProviderId", - OCI.SearchCriteriaServiceProviderId, + "search_criteria_group_id", + "searchCriteriaGroupId", + OCI.SearchCriteriaGroupId, is_complex=True, is_array=True, ), E( - "search_criteria_service_provider_name", - "searchCriteriaServiceProviderName", - OCI.SearchCriteriaServiceProviderName, + "search_criteria_dn", + "searchCriteriaDn", + OCI.SearchCriteriaDn, is_complex=True, is_array=True, ), + ) + + +class ServiceProviderDomainGetAssignedGroupListRequest(OCIRequest): + """ + Requests a list of groups within a service provider that have a given domain assigned. + + It is possible to search by various criteria to restrict the number of rows returned. + Multiple search criteria are logically ANDed together. + + The response is either a `ServiceProviderDomainGetAssignedGroupListResponse()` or an + `ErrorResponse()`. + + Attributes: + service_provider_id (str): serviceProviderId + domain (str): domain + response_size_limit (int): responseSizeLimit *Optional* + search_criteria_group_id (List[OCI.searchCriteriaGroupId]): searchCriteriaGroupId + *Optional* + search_criteria_group_name (List[OCI.searchCriteriaGroupName]): + searchCriteriaGroupName *Optional* + """ + + __slots__: List[str] = [ + "service_provider_id", + "domain", + "response_size_limit", + "search_criteria_group_id", + "search_criteria_group_name", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("service_provider_id", "serviceProviderId", str, is_required=True), + E("domain", "domain", str, is_required=True), + E("response_size_limit", "responseSizeLimit", int), + E( + "search_criteria_group_id", + "searchCriteriaGroupId", + OCI.SearchCriteriaGroupId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_group_name", + "searchCriteriaGroupName", + OCI.SearchCriteriaGroupName, + is_complex=True, + is_array=True, + ), + ) + + +class ServiceProviderDomainGetAssignedListRequest22(OCIRequest): + """ + Requests the list of all matching domains assigned to a service provider . + + The response is either `ServiceProviderDomainGetAssignedListResponse22()` or + `ErrorResponse()`. The following elements are only used in AS data mode and will be + ignored in XS data mode: responseSizeLimit searchCriteriaDomainName + searchCriteriaExactDomainLevel + + Attributes: + service_provider_id (str): serviceProviderId + response_size_limit (int): responseSizeLimit *Optional* + search_criteria_domain_name (List[OCI.searchCriteriaDomainName]): + searchCriteriaDomainName *Optional* + search_criteria_exact_domain_level (OCI.searchCriteriaExactDomainLevel): + searchCriteriaExactDomainLevel *Optional* + """ + + __slots__: List[str] = [ + "service_provider_id", + "response_size_limit", + "search_criteria_domain_name", + "search_criteria_exact_domain_level", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("service_provider_id", "serviceProviderId", str, is_required=True), + E("response_size_limit", "responseSizeLimit", int), + E( + "search_criteria_domain_name", + "searchCriteriaDomainName", + OCI.SearchCriteriaDomainName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_exact_domain_level", + "searchCriteriaExactDomainLevel", + OCI.SearchCriteriaExactDomainLevel, + is_complex=True, + ), + ) + + +class ServiceProviderEndpointGetListRequest(OCIRequest): + """ + Request to search endpoints in the service provider/enterprise. + + The response is either `ServiceProviderEndpointGetListResponse()` or + `ErrorResponse()`. + + Attributes: + service_provider_id (str): serviceProviderId + response_size_limit (int): responseSizeLimit *Optional* + search_criteria_group_id (List[OCI.searchCriteriaGroupId]): searchCriteriaGroupId + *Optional* + search_criteria_line_port_user_part (List[OCI.searchCriteriaLinePortUserPart]): + searchCriteriaLinePortUserPart *Optional* + search_criteria_line_port_domain (List[OCI.searchCriteriaLinePortDomain]): + searchCriteriaLinePortDomain *Optional* + search_criteria_user_last_name (List[OCI.searchCriteriaUserLastName]): + searchCriteriaUserLastName *Optional* + search_criteria_user_first_name (List[OCI.searchCriteriaUserFirstName]): + searchCriteriaUserFirstName *Optional* + search_criteria_user_id (List[OCI.searchCriteriaUserId]): searchCriteriaUserId + *Optional* + search_criteria_dn (List[OCI.searchCriteriaDn]): searchCriteriaDn *Optional* + search_criteria_extension (List[OCI.searchCriteriaExtension]): + searchCriteriaExtension *Optional* + search_criteria_device_type (List[OCI.searchCriteriaDeviceType]): + searchCriteriaDeviceType *Optional* + search_criteria_device_name (List[OCI.searchCriteriaDeviceName]): + searchCriteriaDeviceName *Optional* + search_criteria_device_mac_address (List[OCI.searchCriteriaDeviceMACAddress]): + searchCriteriaDeviceMACAddress *Optional* + search_criteria_device_net_address (List[OCI.searchCriteriaDeviceNetAddress]): + searchCriteriaDeviceNetAddress *Optional* + search_criteria_exact_user_department (OCI.searchCriteriaExactUserDepartment): + searchCriteriaExactUserDepartment *Optional* + """ + + __slots__: List[str] = [ + "service_provider_id", + "response_size_limit", + "search_criteria_group_id", + "search_criteria_line_port_user_part", + "search_criteria_line_port_domain", + "search_criteria_user_last_name", + "search_criteria_user_first_name", + "search_criteria_user_id", + "search_criteria_dn", + "search_criteria_extension", + "search_criteria_device_type", + "search_criteria_device_name", + "search_criteria_device_mac_address", + "search_criteria_device_net_address", + "search_criteria_exact_user_department", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("service_provider_id", "serviceProviderId", str, is_required=True), + E("response_size_limit", "responseSizeLimit", int), + E( + "search_criteria_group_id", + "searchCriteriaGroupId", + OCI.SearchCriteriaGroupId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_line_port_user_part", + "searchCriteriaLinePortUserPart", + OCI.SearchCriteriaLinePortUserPart, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_line_port_domain", + "searchCriteriaLinePortDomain", + OCI.SearchCriteriaLinePortDomain, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_last_name", + "searchCriteriaUserLastName", + OCI.SearchCriteriaUserLastName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_first_name", + "searchCriteriaUserFirstName", + OCI.SearchCriteriaUserFirstName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_id", + "searchCriteriaUserId", + OCI.SearchCriteriaUserId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_dn", + "searchCriteriaDn", + OCI.SearchCriteriaDn, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_extension", + "searchCriteriaExtension", + OCI.SearchCriteriaExtension, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_device_type", + "searchCriteriaDeviceType", + OCI.SearchCriteriaDeviceType, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_device_name", + "searchCriteriaDeviceName", + OCI.SearchCriteriaDeviceName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_device_mac_address", + "searchCriteriaDeviceMACAddress", + OCI.SearchCriteriaDeviceMACAddress, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_device_net_address", + "searchCriteriaDeviceNetAddress", + OCI.SearchCriteriaDeviceNetAddress, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_exact_user_department", + "searchCriteriaExactUserDepartment", + OCI.SearchCriteriaExactUserDepartment, + is_complex=True, + ), + ) + + +class ServiceProviderGetListRequest(OCIRequest): + """ + Request a list of service providers and/or enterprises in the system. + + It is possible to search by various criteria to restrict the number of rows returned. + Multiple search criteria are logically ANDed together. If reseller administrator + sends the request, searchCriteriaResellerId is ignored. Service providers/enterprise + within the administrator's reseller meeting the search criteria are returned. + + The response is either a `ServiceProviderGetListResponse()` or an `ErrorResponse()`. + The following data elements are only used in AS data mode: searchCriteriaResellerId + + Attributes: + is_enterprise (bool): isEnterprise *Optional* + response_size_limit (int): responseSizeLimit *Optional* + search_criteria_service_provider_id (List[OCI.searchCriteriaServiceProviderId]): + searchCriteriaServiceProviderId *Optional* + search_criteria_service_provider_name + (List[OCI.searchCriteriaServiceProviderName]): + searchCriteriaServiceProviderName *Optional* + search_criteria_reseller_id (List[OCI.searchCriteriaResellerId]): + searchCriteriaResellerId *Optional* + """ + + __slots__: List[str] = [ + "is_enterprise", + "response_size_limit", + "search_criteria_service_provider_id", + "search_criteria_service_provider_name", + "search_criteria_reseller_id", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("is_enterprise", "isEnterprise", bool), + E("response_size_limit", "responseSizeLimit", int), + E( + "search_criteria_service_provider_id", + "searchCriteriaServiceProviderId", + OCI.SearchCriteriaServiceProviderId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_service_provider_name", + "searchCriteriaServiceProviderName", + OCI.SearchCriteriaServiceProviderName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_reseller_id", + "searchCriteriaResellerId", + OCI.SearchCriteriaResellerId, + is_complex=True, + is_array=True, + ), + ) + + +class ServiceProviderMWIDeliveryToMobileEndpointCustomTemplateAddRequest(OCIRequest): + """ + Create a MWI Delivery to Mobile Endpoint Custom Template. + + The response is either a `SuccessResponse()` or an `ErrorResponse()`. + + Attributes: + service_provider_id (str): serviceProviderId + language (str): language + type (str): type + is_enabled (bool): isEnabled + template_body (OCI.templateBody): templateBody + """ + + __slots__: List[str] = [ + "service_provider_id", + "language", + "type", + "is_enabled", + "template_body", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("service_provider_id", "serviceProviderId", str, is_required=True), + E("language", "language", str, is_required=True), + E("type", "type", str, is_required=True), + E("is_enabled", "isEnabled", bool, is_required=True), + E( + "template_body", + "templateBody", + OCI.MWIDeliveryToMobileEndpointTemplateBody, + is_complex=True, + is_required=True, + ), + ) + + +class ServiceProviderMWIDeliveryToMobileEndpointCustomTemplateModifyRequest(OCIRequest): + """ + Modify a MWI Delivery to Mobile Endpoint Custom Template. + + The response is either a `SuccessResponse()` or an `ErrorResponse()`. + + Attributes: + service_provider_id (str): serviceProviderId + language (str): language + type (str): type + is_enabled (bool): isEnabled *Optional* + template_body (OCI.templateBody): templateBody *Optional* + """ + + __slots__: List[str] = [ + "service_provider_id", + "language", + "type", + "is_enabled", + "template_body", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("service_provider_id", "serviceProviderId", str, is_required=True), + E("language", "language", str, is_required=True), + E("type", "type", str, is_required=True), + E("is_enabled", "isEnabled", bool), + E( + "template_body", + "templateBody", + OCI.MWIDeliveryToMobileEndpointTemplateBody, + is_complex=True, + ), + ) + + +class ServiceProviderNetworkClassOfServiceGetAssignedGroupListRequest(OCIRequest): + """ + Get a list of groups within a service provider that have a given Network Class of + Service assigned. + + The response is either a + `ServiceProviderNetworkClassOfServiceGetAssignedGroupListResponse()` or an + `ErorResponse()`. + + Attributes: + service_provider_id (str): serviceProviderId + network_class_of_service (str): networkClassOfService + response_size_limit (int): responseSizeLimit *Optional* + search_criteria_group_id (List[OCI.searchCriteriaGroupId]): searchCriteriaGroupId + *Optional* + search_criteria_group_name (List[OCI.searchCriteriaGroupName]): + searchCriteriaGroupName *Optional* + """ + + __slots__: List[str] = [ + "service_provider_id", + "network_class_of_service", + "response_size_limit", + "search_criteria_group_id", + "search_criteria_group_name", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("service_provider_id", "serviceProviderId", str, is_required=True), + E( + "network_class_of_service", + "networkClassOfService", + str, + is_required=True, + ), + E("response_size_limit", "responseSizeLimit", int), + E( + "search_criteria_group_id", + "searchCriteriaGroupId", + OCI.SearchCriteriaGroupId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_group_name", + "searchCriteriaGroupName", + OCI.SearchCriteriaGroupName, + is_complex=True, + is_array=True, + ), + ) + + +class ServiceProviderNumberPortabilityQueryGetRequest(OCIRequest): + """ + Request to get the Service Provider Number Portability Query Digit Pattern Trigger + List information. + + The response is either a `ServiceProviderNumberPortabilityQueryGetResponse()` or an + `ErrorResponse()`. + + Attributes: + service_provider_id (str): serviceProviderId + include_digit_patterns (bool): includeDigitPatterns + search_criteria_service_provider_number_portability_query_digit_pattern + (List[OCI.searchCriteriaServiceProviderNumberPortabilityQueryDigitPattern]): + searchCriteriaServiceProviderNumberPortabilityQueryDigitPattern *Optional* + response_size_limit (int): responseSizeLimit *Optional* + """ + + __slots__: List[str] = [ + "service_provider_id", + "include_digit_patterns", + "search_criteria_service_provider_number_portability_query_digit_pattern", + "response_size_limit", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("service_provider_id", "serviceProviderId", str, is_required=True), + E("include_digit_patterns", "includeDigitPatterns", bool, is_required=True), + E( + "search_criteria_service_provider_number_portability_query_digit_pattern", + "searchCriteriaServiceProviderNumberPortabilityQueryDigitPattern", + OCI.SearchCriteriaServiceProviderNumberPortabilityQueryDigitPattern, + is_complex=True, + is_array=True, + ), + E("response_size_limit", "responseSizeLimit", int), + ) + + +class ServiceProviderOfficeZoneGetAssignedGroupListRequest(OCIRequest): + """ + Get a list of groups within a service provider that have a given Office Zone assigned. + + The response is either a `ServiceProviderOfficeZoneGetAssignedGroupListResponse()` or + an `ErrorResponse()`. + + Attributes: + service_provider_id (str): serviceProviderId + office_zone_name (str): officeZoneName + response_size_limit (int): responseSizeLimit *Optional* + search_criteria_group_id (List[OCI.searchCriteriaGroupId]): searchCriteriaGroupId + *Optional* + search_criteria_group_name (List[OCI.searchCriteriaGroupName]): + searchCriteriaGroupName *Optional* + """ + + __slots__: List[str] = [ + "service_provider_id", + "office_zone_name", + "response_size_limit", + "search_criteria_group_id", + "search_criteria_group_name", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("service_provider_id", "serviceProviderId", str, is_required=True), + E("office_zone_name", "officeZoneName", str, is_required=True), + E("response_size_limit", "responseSizeLimit", int), + E( + "search_criteria_group_id", + "searchCriteriaGroupId", + OCI.SearchCriteriaGroupId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_group_name", + "searchCriteriaGroupName", + OCI.SearchCriteriaGroupName, + is_complex=True, + is_array=True, + ), + ) + + +class ServiceProviderRouteListEnterpriseTrunkNumberPrefixAddListRequest22(OCIRequest): + """ + Add number prefixes to a service provider. + + The response is either `SuccessResponse()` or `ErrorResponse()`. + + Attributes: + service_provider_id (str): serviceProviderId + prefix (List[OCI.prefix]): prefix + """ + + __slots__: List[str] = [ + "service_provider_id", + "prefix", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("service_provider_id", "serviceProviderId", str, is_required=True), + E( + "prefix", + "prefix", + OCI.EnterpriseTrunkNumberPrefix22, + is_complex=True, + is_required=True, + is_array=True, + ), + ) + + +class ServiceProviderRouteListEnterpriseTrunkNumberPrefixModifyListRequest(OCIRequest): + """ + Modify a list of number prefixes in a service provider. + + The response is either `SuccessResponse()` or `ErrorResponse()`. + + Attributes: + service_provider_id (str): serviceProviderId + number_prefix (List[OCI.numberPrefix]): numberPrefix *Optional* + """ + + __slots__: List[str] = [ + "service_provider_id", + "number_prefix", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("service_provider_id", "serviceProviderId", str, is_required=True), + E( + "number_prefix", + "numberPrefix", + OCI.EnterpriseTrunkNumberPrefixModify, + is_complex=True, + is_array=True, + ), + ) + + +class ServiceProviderRouteListEnterpriseTrunkNumberRangeAddListRequest22(OCIRequest): + """ + Add number ranges to a service provider. + + The response is either `SuccessResponse()` or `ErrorResponse()`. + + Attributes: + service_provider_id (str): serviceProviderId + number_range (List[OCI.numberRange]): numberRange + """ + + __slots__: List[str] = [ + "service_provider_id", + "number_range", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("service_provider_id", "serviceProviderId", str, is_required=True), + E( + "number_range", + "numberRange", + OCI.EnterpriseTrunkNumberRange, + is_complex=True, + is_required=True, + is_array=True, + ), + ) + + +class ServiceProviderRoutePointExternalSystemGetAssignedGroupListRequest(OCIRequest): + """ + Requests a list of groups within a service provider that have a given external system + assigned. + + It is possible to search by various criteria to restrict the number of rows returned. + Multiple search criteria are logically ANDed together. + + The response is either a + `ServiceProviderRoutePointExternalSystemGetAssignedGroupListResponse()` or an + `ErrorResponse()`. + + Attributes: + service_provider_id (str): serviceProviderId + external_system (str): externalSystem + response_size_limit (int): responseSizeLimit *Optional* + search_criteria_group_id (List[OCI.searchCriteriaGroupId]): searchCriteriaGroupId + *Optional* + search_criteria_group_name (List[OCI.searchCriteriaGroupName]): + searchCriteriaGroupName *Optional* + """ + + __slots__: List[str] = [ + "service_provider_id", + "external_system", + "response_size_limit", + "search_criteria_group_id", + "search_criteria_group_name", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("service_provider_id", "serviceProviderId", str, is_required=True), + E("external_system", "externalSystem", str, is_required=True), + E("response_size_limit", "responseSizeLimit", int), + E( + "search_criteria_group_id", + "searchCriteriaGroupId", + OCI.SearchCriteriaGroupId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_group_name", + "searchCriteriaGroupName", + OCI.SearchCriteriaGroupName, + is_complex=True, + is_array=True, + ), + ) + + +class ServiceProviderServiceModifyAuthorizationListRequest(OCIRequest): + """ + Requests to change the service provider's service authorization status. + + The boolean flags are used to authorize or unauthorize services. + + The response is either `SuccessResponse()` or `ErrorResponse()`. + + Attributes: + service_provider_id (str): serviceProviderId + group_service_authorization (List[OCI.groupServiceAuthorization]): + groupServiceAuthorization *Optional* + user_service_authorization (List[OCI.userServiceAuthorization]): + userServiceAuthorization *Optional* + """ + + __slots__: List[str] = [ + "service_provider_id", + "group_service_authorization", + "user_service_authorization", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("service_provider_id", "serviceProviderId", str, is_required=True), + E( + "group_service_authorization", + "groupServiceAuthorization", + OCI.GroupServiceAuthorization, + is_complex=True, + is_array=True, + ), + E( + "user_service_authorization", + "userServiceAuthorization", + OCI.UserServiceAuthorization, + is_complex=True, + is_array=True, + ), + ) + + +class ServiceProviderServicePackMigrationTaskGetAvailableGroupListRequest(OCIRequest): + """ + Requests a list of groups to migrate. + + The response is either + `ServiceProviderServicePackMigrationTaskGetAvailabeGroupListResponse()` or + `ErrorResponse()`. + + Attributes: + service_provider_id (str): serviceProviderId + response_size_limit (int): responseSizeLimit *Optional* + search_criteria_group_id (List[OCI.searchCriteriaGroupId]): searchCriteriaGroupId + *Optional* + search_criteria_group_name (List[OCI.searchCriteriaGroupName]): + searchCriteriaGroupName *Optional* + """ + + __slots__: List[str] = [ + "service_provider_id", + "response_size_limit", + "search_criteria_group_id", + "search_criteria_group_name", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("service_provider_id", "serviceProviderId", str, is_required=True), + E("response_size_limit", "responseSizeLimit", int), + E( + "search_criteria_group_id", + "searchCriteriaGroupId", + OCI.SearchCriteriaGroupId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_group_name", + "searchCriteriaGroupName", + OCI.SearchCriteriaGroupName, + is_complex=True, + is_array=True, + ), + ) + + +class ServiceProviderXsiPolicyProfileGetAssignedGroupListRequest(OCIRequest): + """ + Get a list of group within a service provider that have a given group Xsi policy + profile assigned. + + The response is either a + `ServiceProviderXsiPolicyProfileGetAssignedGroupListResponse()` or an + `ErrorResponse()`. + + Attributes: + service_provider_id (str): serviceProviderId + xsi_policy_profile (OCI.xsiPolicyProfile): xsiPolicyProfile + response_size_limit (int): responseSizeLimit *Optional* + search_criteria_group_id (List[OCI.searchCriteriaGroupId]): searchCriteriaGroupId + *Optional* + search_criteria_group_name (List[OCI.searchCriteriaGroupName]): + searchCriteriaGroupName *Optional* + """ + + __slots__: List[str] = [ + "service_provider_id", + "xsi_policy_profile", + "response_size_limit", + "search_criteria_group_id", + "search_criteria_group_name", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("service_provider_id", "serviceProviderId", str, is_required=True), + E( + "xsi_policy_profile", + "xsiPolicyProfile", + OCI.XsiPolicyProfileKey, + is_complex=True, + is_required=True, + ), + E("response_size_limit", "responseSizeLimit", int), + E( + "search_criteria_group_id", + "searchCriteriaGroupId", + OCI.SearchCriteriaGroupId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_group_name", + "searchCriteriaGroupName", + OCI.SearchCriteriaGroupName, + is_complex=True, + is_array=True, + ), + ) + + +class SystemAccessDeviceGetAllRequest(OCIRequest): + """ + Requests the list of all access devices in the entire system. + + Prior to release 14, this functionality was provided with the + `SystemAccessDeviceGetListRequest14()`. If reseller administrator sends the request, + searchCriteriaResellerId is ignored. All the device profiles in the administrator's + reseller meeting the search criteria are returned. + + The response is either `SystemAccessDeviceGetAllResponse()` or `ErrorResponse()`. The + following data elements are only used in AS data mode: searchCriteriaResellerId + + Attributes: + response_size_limit (int): responseSizeLimit *Optional* + search_criteria_device_name (List[OCI.searchCriteriaDeviceName]): + searchCriteriaDeviceName *Optional* + search_criteria_device_mac_address (List[OCI.searchCriteriaDeviceMACAddress]): + searchCriteriaDeviceMACAddress *Optional* + search_criteria_device_net_address (List[OCI.searchCriteriaDeviceNetAddress]): + searchCriteriaDeviceNetAddress *Optional* + search_criteria_group_id (List[OCI.searchCriteriaGroupId]): searchCriteriaGroupId + *Optional* + search_criteria_exact_device_type (OCI.searchCriteriaExactDeviceType): + searchCriteriaExactDeviceType *Optional* + search_criteria_exact_device_service_provider + (OCI.searchCriteriaExactDeviceServiceProvider): + searchCriteriaExactDeviceServiceProvider *Optional* + search_criteria_service_provider_id (List[OCI.searchCriteriaServiceProviderId]): + searchCriteriaServiceProviderId *Optional* + search_criteria_reseller_id (List[OCI.searchCriteriaResellerId]): + searchCriteriaResellerId *Optional* + """ + + __slots__: List[str] = [ + "response_size_limit", + "search_criteria_device_name", + "search_criteria_device_mac_address", + "search_criteria_device_net_address", + "search_criteria_group_id", + "search_criteria_exact_device_type", + "search_criteria_exact_device_service_provider", + "search_criteria_service_provider_id", + "search_criteria_reseller_id", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("response_size_limit", "responseSizeLimit", int), + E( + "search_criteria_device_name", + "searchCriteriaDeviceName", + OCI.SearchCriteriaDeviceName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_device_mac_address", + "searchCriteriaDeviceMACAddress", + OCI.SearchCriteriaDeviceMACAddress, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_device_net_address", + "searchCriteriaDeviceNetAddress", + OCI.SearchCriteriaDeviceNetAddress, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_group_id", + "searchCriteriaGroupId", + OCI.SearchCriteriaGroupId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_exact_device_type", + "searchCriteriaExactDeviceType", + OCI.SearchCriteriaExactDeviceType, + is_complex=True, + ), + E( + "search_criteria_exact_device_service_provider", + "searchCriteriaExactDeviceServiceProvider", + OCI.SearchCriteriaExactDeviceServiceProvider, + is_complex=True, + ), + E( + "search_criteria_service_provider_id", + "searchCriteriaServiceProviderId", + OCI.SearchCriteriaServiceProviderId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_reseller_id", + "searchCriteriaResellerId", + OCI.SearchCriteriaResellerId, + is_complex=True, + is_array=True, + ), + ) + + +class SystemAccessDeviceGetListRequest14(OCIRequest): + """ + Requests the list of access devices defined at the System-level. + + Prior to release 14, this command requested a list of all devices in the entire + system. That functionality is now moved to the `SystemAccessDeviceGetAllRequest()`. + + The response is either `SystemAccessDeviceGetListResponse14()` or `ErrorResponse()`. + + Attributes: + response_size_limit (int): responseSizeLimit *Optional* + search_criteria_device_name (List[OCI.searchCriteriaDeviceName]): + searchCriteriaDeviceName *Optional* + search_criteria_device_mac_address (List[OCI.searchCriteriaDeviceMACAddress]): + searchCriteriaDeviceMACAddress *Optional* + search_criteria_device_net_address (List[OCI.searchCriteriaDeviceNetAddress]): + searchCriteriaDeviceNetAddress *Optional* + search_criteria_exact_device_type (OCI.searchCriteriaExactDeviceType): + searchCriteriaExactDeviceType *Optional* + search_criteria_access_device_version + (List[OCI.searchCriteriaAccessDeviceVersion]): + searchCriteriaAccessDeviceVersion *Optional* + """ + + __slots__: List[str] = [ + "response_size_limit", + "search_criteria_device_name", + "search_criteria_device_mac_address", + "search_criteria_device_net_address", + "search_criteria_exact_device_type", + "search_criteria_access_device_version", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("response_size_limit", "responseSizeLimit", int), + E( + "search_criteria_device_name", + "searchCriteriaDeviceName", + OCI.SearchCriteriaDeviceName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_device_mac_address", + "searchCriteriaDeviceMACAddress", + OCI.SearchCriteriaDeviceMACAddress, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_device_net_address", + "searchCriteriaDeviceNetAddress", + OCI.SearchCriteriaDeviceNetAddress, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_exact_device_type", + "searchCriteriaExactDeviceType", + OCI.SearchCriteriaExactDeviceType, + is_complex=True, + ), + E( + "search_criteria_access_device_version", + "searchCriteriaAccessDeviceVersion", + OCI.SearchCriteriaAccessDeviceVersion, + is_complex=True, + is_array=True, + ), + ) + + +class SystemAccessDeviceGetPagedSortedListRequest(OCIRequest): + """ + Requests the list of system-level access devices. + + The response is either `SystemAccessDeviceGetPagedSortedListResponse()` or + `ErrorResponse()`. If no sortOrder is included, the response is sorted by Device Name + ascending by default. If the responsePagingControl element is not provided, the + paging startIndex will be set to 1 by default, and the responsePageSize will be set to + the maximum responsePageSize by default. Multiple search criteria are logically ANDed + together unless the searchCriteriaModeOr option is included. Then the search criteria + are logically ORed together. The getVisualDeviceManagementAPIDevicesOnly element can + only be set when CloudPBX is licenced. If the getVisualDeviceManagementAPIDevicesOnly + element is not set, all devices are returned with Visual Device Management API flag + set to empty. If the getVisualDeviceManagementAPIDevicesOnly element is set to true, + only SIP devices supporting Visual Device Management API are returned. If the + getVisualDeviceManagementAPIDevicesOnly element is set to false, all SIP devices are + returned with their current Visual Device Management API flag value. + + Attributes: + response_paging_control (OCI.responsePagingControl): responsePagingControl + *Optional* + sort_by_device_name (OCI.sortByDeviceName): sortByDeviceName *Optional* + sort_by_device_type (OCI.sortByDeviceType): sortByDeviceType *Optional* + sort_by_device_net_address (OCI.sortByDeviceNetAddress): sortByDeviceNetAddress + *Optional* + sort_by_device_mac_address (OCI.sortByDeviceMACAddress): sortByDeviceMACAddress + *Optional* + search_criteria_device_name (List[OCI.searchCriteriaDeviceName]): + searchCriteriaDeviceName *Optional* + search_criteria_device_mac_address (List[OCI.searchCriteriaDeviceMACAddress]): + searchCriteriaDeviceMACAddress *Optional* + search_criteria_device_net_address (List[OCI.searchCriteriaDeviceNetAddress]): + searchCriteriaDeviceNetAddress *Optional* + search_criteria_exact_device_type (List[OCI.searchCriteriaExactDeviceType]): + searchCriteriaExactDeviceType *Optional* + search_criteria_access_device_version + (List[OCI.searchCriteriaAccessDeviceVersion]): + searchCriteriaAccessDeviceVersion *Optional* + search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* + get_visual_device_management_api_devices_only (bool): + getVisualDeviceManagementAPIDevicesOnly *Optional* + """ + + __slots__: List[str] = [ + "response_paging_control", + "sort_by_device_name", + "sort_by_device_type", + "sort_by_device_net_address", + "sort_by_device_mac_address", + "search_criteria_device_name", + "search_criteria_device_mac_address", + "search_criteria_device_net_address", + "search_criteria_exact_device_type", + "search_criteria_access_device_version", + "search_criteria_mode_or", + "get_visual_device_management_api_devices_only", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E( + "response_paging_control", + "responsePagingControl", + OCI.ResponsePagingControl, + is_complex=True, + ), + E( + "sort_by_device_name", + "sortByDeviceName", + OCI.SortByDeviceName, + is_complex=True, + ), + E( + "sort_by_device_type", + "sortByDeviceType", + OCI.SortByDeviceType, + is_complex=True, + ), + E( + "sort_by_device_net_address", + "sortByDeviceNetAddress", + OCI.SortByDeviceNetAddress, + is_complex=True, + ), + E( + "sort_by_device_mac_address", + "sortByDeviceMACAddress", + OCI.SortByDeviceMACAddress, + is_complex=True, + ), + E( + "search_criteria_device_name", + "searchCriteriaDeviceName", + OCI.SearchCriteriaDeviceName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_device_mac_address", + "searchCriteriaDeviceMACAddress", + OCI.SearchCriteriaDeviceMACAddress, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_device_net_address", + "searchCriteriaDeviceNetAddress", + OCI.SearchCriteriaDeviceNetAddress, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_exact_device_type", + "searchCriteriaExactDeviceType", + OCI.SearchCriteriaExactDeviceType, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_access_device_version", + "searchCriteriaAccessDeviceVersion", + OCI.SearchCriteriaAccessDeviceVersion, + is_complex=True, + is_array=True, + ), + E("search_criteria_mode_or", "searchCriteriaModeOr", bool), + E( + "get_visual_device_management_api_devices_only", + "getVisualDeviceManagementAPIDevicesOnly", + bool, + ), + ) + + +class SystemAccessDeviceGetUserListRequest(OCIRequest): + """ + Requests the users associated with a specified system access device. + + The response is either `SystemAccessDeviceGetUserListResponse()` or `ErrorResponse()`. + The following elements are only used in XS data mode and ignored in AS data mode: + searchCriteriaAccessDeviceEndpointPrivateIdentity Replaced by: + `SystemAccessDeviceGetUserListRequest21sp1()` in AS data mode. + + Attributes: + device_name (str): deviceName + response_size_limit (int): responseSizeLimit *Optional* + search_criteria_line_port_user_part (List[OCI.searchCriteriaLinePortUserPart]): + searchCriteriaLinePortUserPart *Optional* + search_criteria_line_port_domain (List[OCI.searchCriteriaLinePortDomain]): + searchCriteriaLinePortDomain *Optional* + search_criteria_user_last_name (List[OCI.searchCriteriaUserLastName]): + searchCriteriaUserLastName *Optional* + search_criteria_user_first_name (List[OCI.searchCriteriaUserFirstName]): + searchCriteriaUserFirstName *Optional* + search_criteria_dn (List[OCI.searchCriteriaDn]): searchCriteriaDn *Optional* + search_criteria_user_id (List[OCI.searchCriteriaUserId]): searchCriteriaUserId + *Optional* + search_criteria_group_id (List[OCI.searchCriteriaGroupId]): searchCriteriaGroupId + *Optional* + search_criteria_exact_service_provider (OCI.searchCriteriaExactServiceProvider): + searchCriteriaExactServiceProvider *Optional* + search_criteria_service_provider_id (List[OCI.searchCriteriaServiceProviderId]): + searchCriteriaServiceProviderId *Optional* + search_criteria_exact_endpoint_type (OCI.searchCriteriaExactEndpointType): + searchCriteriaExactEndpointType *Optional* + search_criteria_exact_user_type (OCI.searchCriteriaExactUserType): + searchCriteriaExactUserType *Optional* + search_criteria_extension (List[OCI.searchCriteriaExtension]): + searchCriteriaExtension *Optional* + search_criteria_exact_port_number (OCI.searchCriteriaExactPortNumber): + searchCriteriaExactPortNumber *Optional* + search_criteria_access_device_endpoint_private_identity + (List[OCI.searchCriteriaAccessDeviceEndpointPrivateIdentity]): + searchCriteriaAccessDeviceEndpointPrivateIdentity *Optional* + """ + + __slots__: List[str] = [ + "device_name", + "response_size_limit", + "search_criteria_line_port_user_part", + "search_criteria_line_port_domain", + "search_criteria_user_last_name", + "search_criteria_user_first_name", + "search_criteria_dn", + "search_criteria_user_id", + "search_criteria_group_id", + "search_criteria_exact_service_provider", + "search_criteria_service_provider_id", + "search_criteria_exact_endpoint_type", + "search_criteria_exact_user_type", + "search_criteria_extension", + "search_criteria_exact_port_number", + "search_criteria_access_device_endpoint_private_identity", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("device_name", "deviceName", str, is_required=True), + E("response_size_limit", "responseSizeLimit", int), + E( + "search_criteria_line_port_user_part", + "searchCriteriaLinePortUserPart", + OCI.SearchCriteriaLinePortUserPart, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_line_port_domain", + "searchCriteriaLinePortDomain", + OCI.SearchCriteriaLinePortDomain, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_last_name", + "searchCriteriaUserLastName", + OCI.SearchCriteriaUserLastName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_first_name", + "searchCriteriaUserFirstName", + OCI.SearchCriteriaUserFirstName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_dn", + "searchCriteriaDn", + OCI.SearchCriteriaDn, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_id", + "searchCriteriaUserId", + OCI.SearchCriteriaUserId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_group_id", + "searchCriteriaGroupId", + OCI.SearchCriteriaGroupId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_exact_service_provider", + "searchCriteriaExactServiceProvider", + OCI.SearchCriteriaExactServiceProvider, + is_complex=True, + ), + E( + "search_criteria_service_provider_id", + "searchCriteriaServiceProviderId", + OCI.SearchCriteriaServiceProviderId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_exact_endpoint_type", + "searchCriteriaExactEndpointType", + OCI.SearchCriteriaExactEndpointType, + is_complex=True, + ), + E( + "search_criteria_exact_user_type", + "searchCriteriaExactUserType", + OCI.SearchCriteriaExactUserType, + is_complex=True, + ), + E( + "search_criteria_extension", + "searchCriteriaExtension", + OCI.SearchCriteriaExtension, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_exact_port_number", + "searchCriteriaExactPortNumber", + OCI.SearchCriteriaExactPortNumber, + is_complex=True, + ), + E( + "search_criteria_access_device_endpoint_private_identity", + "searchCriteriaAccessDeviceEndpointPrivateIdentity", + OCI.SearchCriteriaAccessDeviceEndpointPrivateIdentity, + is_complex=True, + is_array=True, + ), + ) + + +class SystemAccessDeviceGetUserListRequest21sp1(OCIRequest): + """ + Requests the users associated with a specified system access device. + + The response is either `SystemAccessDeviceGetUserListResponse21sp1()` or + `ErrorResponse()`. The following elements are only used in XS data mode and ignored in + AS data mode: searchCriteriaAccessDeviceEndpointPrivateIdentity + + Attributes: + device_name (str): deviceName + response_size_limit (int): responseSizeLimit *Optional* + search_criteria_line_port_user_part (List[OCI.searchCriteriaLinePortUserPart]): + searchCriteriaLinePortUserPart *Optional* + search_criteria_line_port_domain (List[OCI.searchCriteriaLinePortDomain]): + searchCriteriaLinePortDomain *Optional* + search_criteria_user_last_name (List[OCI.searchCriteriaUserLastName]): + searchCriteriaUserLastName *Optional* + search_criteria_user_first_name (List[OCI.searchCriteriaUserFirstName]): + searchCriteriaUserFirstName *Optional* + search_criteria_dn (List[OCI.searchCriteriaDn]): searchCriteriaDn *Optional* + search_criteria_user_id (List[OCI.searchCriteriaUserId]): searchCriteriaUserId + *Optional* + search_criteria_group_id (List[OCI.searchCriteriaGroupId]): searchCriteriaGroupId + *Optional* + search_criteria_exact_service_provider (OCI.searchCriteriaExactServiceProvider): + searchCriteriaExactServiceProvider *Optional* + search_criteria_service_provider_id (List[OCI.searchCriteriaServiceProviderId]): + searchCriteriaServiceProviderId *Optional* + search_criteria_exact_endpoint_type (OCI.searchCriteriaExactEndpointType): + searchCriteriaExactEndpointType *Optional* + search_criteria_exact_user_type (OCI.searchCriteriaExactUserType): + searchCriteriaExactUserType *Optional* + search_criteria_extension (List[OCI.searchCriteriaExtension]): + searchCriteriaExtension *Optional* + search_criteria_exact_port_number (OCI.searchCriteriaExactPortNumber): + searchCriteriaExactPortNumber *Optional* + search_criteria_access_device_endpoint_private_identity + (List[OCI.searchCriteriaAccessDeviceEndpointPrivateIdentity]): + searchCriteriaAccessDeviceEndpointPrivateIdentity *Optional* + search_criteria_user_hotline_contact (List[OCI.searchCriteriaUserHotlineContact]): + searchCriteriaUserHotlineContact *Optional* + """ + + __slots__: List[str] = [ + "device_name", + "response_size_limit", + "search_criteria_line_port_user_part", + "search_criteria_line_port_domain", + "search_criteria_user_last_name", + "search_criteria_user_first_name", + "search_criteria_dn", + "search_criteria_user_id", + "search_criteria_group_id", + "search_criteria_exact_service_provider", + "search_criteria_service_provider_id", + "search_criteria_exact_endpoint_type", + "search_criteria_exact_user_type", + "search_criteria_extension", + "search_criteria_exact_port_number", + "search_criteria_access_device_endpoint_private_identity", + "search_criteria_user_hotline_contact", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("device_name", "deviceName", str, is_required=True), + E("response_size_limit", "responseSizeLimit", int), + E( + "search_criteria_line_port_user_part", + "searchCriteriaLinePortUserPart", + OCI.SearchCriteriaLinePortUserPart, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_line_port_domain", + "searchCriteriaLinePortDomain", + OCI.SearchCriteriaLinePortDomain, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_last_name", + "searchCriteriaUserLastName", + OCI.SearchCriteriaUserLastName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_first_name", + "searchCriteriaUserFirstName", + OCI.SearchCriteriaUserFirstName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_dn", + "searchCriteriaDn", + OCI.SearchCriteriaDn, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_id", + "searchCriteriaUserId", + OCI.SearchCriteriaUserId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_group_id", + "searchCriteriaGroupId", + OCI.SearchCriteriaGroupId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_exact_service_provider", + "searchCriteriaExactServiceProvider", + OCI.SearchCriteriaExactServiceProvider, + is_complex=True, + ), + E( + "search_criteria_service_provider_id", + "searchCriteriaServiceProviderId", + OCI.SearchCriteriaServiceProviderId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_exact_endpoint_type", + "searchCriteriaExactEndpointType", + OCI.SearchCriteriaExactEndpointType21sp1, + is_complex=True, + ), + E( + "search_criteria_exact_user_type", + "searchCriteriaExactUserType", + OCI.SearchCriteriaExactUserType, + is_complex=True, + ), + E( + "search_criteria_extension", + "searchCriteriaExtension", + OCI.SearchCriteriaExtension, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_exact_port_number", + "searchCriteriaExactPortNumber", + OCI.SearchCriteriaExactPortNumber, + is_complex=True, + ), + E( + "search_criteria_access_device_endpoint_private_identity", + "searchCriteriaAccessDeviceEndpointPrivateIdentity", + OCI.SearchCriteriaAccessDeviceEndpointPrivateIdentity, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_hotline_contact", + "searchCriteriaUserHotlineContact", + OCI.SearchCriteriaUserHotlineContact, + is_complex=True, + is_array=True, + ), + ) + + +class SystemAlternateUserIdGetListRequest(OCIRequest): + """ + Request to get the list of alternate user ids. + + If reseller administrator sends the request, searchCriteriaResellerId is ignored. All + the alternate user ids in the administrator's reseller meeting the search criteria are + returned. + + The response is either `SystemAlternateUserIdGetListResponse()` or `ErrorResponse()`. + The following data elements are only used in AS data mode: searchCriteriaResellerId + + Attributes: + response_size_limit (int): responseSizeLimit *Optional* + search_criteria_alternate_user_id (List[OCI.searchCriteriaAlternateUserId]): + searchCriteriaAlternateUserId *Optional* + search_criteria_user_id (List[OCI.searchCriteriaUserId]): searchCriteriaUserId + *Optional* + search_criteria_group_id (List[OCI.searchCriteriaGroupId]): searchCriteriaGroupId + *Optional* + search_criteria_service_provider_id (List[OCI.searchCriteriaServiceProviderId]): + searchCriteriaServiceProviderId *Optional* + search_criteria_reseller_id (List[OCI.searchCriteriaResellerId]): + searchCriteriaResellerId *Optional* + """ + + __slots__: List[str] = [ + "response_size_limit", + "search_criteria_alternate_user_id", + "search_criteria_user_id", + "search_criteria_group_id", + "search_criteria_service_provider_id", + "search_criteria_reseller_id", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("response_size_limit", "responseSizeLimit", int), + E( + "search_criteria_alternate_user_id", + "searchCriteriaAlternateUserId", + OCI.SearchCriteriaAlternateUserId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_id", + "searchCriteriaUserId", + OCI.SearchCriteriaUserId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_group_id", + "searchCriteriaGroupId", + OCI.SearchCriteriaGroupId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_service_provider_id", + "searchCriteriaServiceProviderId", + OCI.SearchCriteriaServiceProviderId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_reseller_id", + "searchCriteriaResellerId", + OCI.SearchCriteriaResellerId, + is_complex=True, + is_array=True, + ), + ) + + +class SystemBroadWorksMobilityGeographicalPoolIMRNGetListRequest(OCIRequest): + """ + Get a list of BroadWorks Mobility IMRN numbers from a geographical pool. + + The response is either a + `SystemBroadWorksMobilityGeographicalPoolIMRNGetListResponse()` or an + `ErrorResponse()`. + + Attributes: + geographical_pool_name (str): geographicalPoolName + search_criteria_imrn (List[OCI.searchCriteriaIMRN]): searchCriteriaIMRN *Optional* + """ + + __slots__: List[str] = [ + "geographical_pool_name", + "search_criteria_imrn", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("geographical_pool_name", "geographicalPoolName", str, is_required=True), + E( + "search_criteria_imrn", + "searchCriteriaIMRN", + OCI.SearchCriteriaIMRN, + is_complex=True, + is_array=True, + ), + ) + + +class SystemBroadWorksMobilityGetIMRNListRequest(OCIRequest): + """ + Request to get the list of BroadWorks Mobility IMRN numbers defined in the system. + + The response is either a `SystemBroadWorksMobilityGetIMRNListResponse()` or an + `ErrorResponse()`. + + Attributes: + search_criteria_imrn (List[OCI.searchCriteriaIMRN]): searchCriteriaIMRN *Optional* + """ + + __slots__: List[str] = [ + "search_criteria_imrn", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E( + "search_criteria_imrn", + "searchCriteriaIMRN", + OCI.SearchCriteriaIMRN, + is_complex=True, + is_array=True, + ), + ) + + +class SystemBroadWorksMobilityGetMobileNetworkIMRNListRequest(OCIRequest): + """ + Get a list of BroadWorks Mobility IMRN numbers from a Mobile Network. + + The response is either a `SystemBroadWorksMobilityGetMobileNetworkIMRNListResponse()` + or an `ErrorResponse()`. + + Attributes: + mobile_network_name (str): mobileNetworkName + search_criteria_imrn (List[OCI.searchCriteriaIMRN]): searchCriteriaIMRN *Optional* + """ + + __slots__: List[str] = [ + "mobile_network_name", + "search_criteria_imrn", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("mobile_network_name", "mobileNetworkName", str, is_required=True), + E( + "search_criteria_imrn", + "searchCriteriaIMRN", + OCI.SearchCriteriaIMRN, + is_complex=True, + is_array=True, + ), + ) + + +class SystemBroadWorksMobilityMobileSubscriberDirectoryNumberGetSummaryListRequest( + OCIRequest, +): + """ + Request a summary table of all Mobile Subscriber Directory Numbers in a system. + + If reseller administrator sends the request, searchCriteriaResellerId is ignored. All + the mobile subscriber directory numbers in the administrator's reseller meeting the + search criteria are returned. + + The response is either + `SystemBroadWorksMobilityMobileSubscriberDirectoryNumberGetSummaryListResponse()` or + `ErrorResponse()`. The following data elements are only used in AS data mode: + searchCriteriaResellerId + + Attributes: + response_size_limit (int): responseSizeLimit *Optional* + search_criteria_mobile_subscriber_directory_number + (List[OCI.searchCriteriaMobileSubscriberDirectoryNumber]): + searchCriteriaMobileSubscriberDirectoryNumber *Optional* + search_criteria_exact_mobile_network (OCI.searchCriteriaExactMobileNetwork): + searchCriteriaExactMobileNetwork *Optional* + search_criteria_service_provider_id (List[OCI.searchCriteriaServiceProviderId]): + searchCriteriaServiceProviderId *Optional* + search_criteria_exact_organization_type (OCI.searchCriteriaExactOrganizationType): + searchCriteriaExactOrganizationType *Optional* + search_criteria_group_id (List[OCI.searchCriteriaGroupId]): searchCriteriaGroupId + *Optional* + search_criteria_user_id (List[OCI.searchCriteriaUserId]): searchCriteriaUserId + *Optional* + search_criteria_user_last_name (List[OCI.searchCriteriaUserLastName]): + searchCriteriaUserLastName *Optional* + search_criteria_user_first_name (List[OCI.searchCriteriaUserFirstName]): + searchCriteriaUserFirstName *Optional* + search_criteria_dn (List[OCI.searchCriteriaDn]): searchCriteriaDn *Optional* + search_criteria_extension (List[OCI.searchCriteriaExtension]): + searchCriteriaExtension *Optional* + search_criteria_reseller_id (List[OCI.searchCriteriaResellerId]): + searchCriteriaResellerId *Optional* + """ + + __slots__: List[str] = [ + "response_size_limit", + "search_criteria_mobile_subscriber_directory_number", + "search_criteria_exact_mobile_network", + "search_criteria_service_provider_id", + "search_criteria_exact_organization_type", + "search_criteria_group_id", + "search_criteria_user_id", + "search_criteria_user_last_name", + "search_criteria_user_first_name", + "search_criteria_dn", + "search_criteria_extension", + "search_criteria_reseller_id", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("response_size_limit", "responseSizeLimit", int), + E( + "search_criteria_mobile_subscriber_directory_number", + "searchCriteriaMobileSubscriberDirectoryNumber", + OCI.SearchCriteriaMobileSubscriberDirectoryNumber, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_exact_mobile_network", + "searchCriteriaExactMobileNetwork", + OCI.SearchCriteriaExactMobileNetwork, + is_complex=True, + ), + E( + "search_criteria_service_provider_id", + "searchCriteriaServiceProviderId", + OCI.SearchCriteriaServiceProviderId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_exact_organization_type", + "searchCriteriaExactOrganizationType", + OCI.SearchCriteriaExactOrganizationType, + is_complex=True, + ), + E( + "search_criteria_group_id", + "searchCriteriaGroupId", + OCI.SearchCriteriaGroupId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_id", + "searchCriteriaUserId", + OCI.SearchCriteriaUserId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_last_name", + "searchCriteriaUserLastName", + OCI.SearchCriteriaUserLastName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_first_name", + "searchCriteriaUserFirstName", + OCI.SearchCriteriaUserFirstName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_dn", + "searchCriteriaDn", + OCI.SearchCriteriaDn, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_extension", + "searchCriteriaExtension", + OCI.SearchCriteriaExtension, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_reseller_id", + "searchCriteriaResellerId", + OCI.SearchCriteriaResellerId, + is_complex=True, + is_array=True, + ), + ) + + +class SystemCallCenterEnhancedReportingScheduledReportGetActiveListRequest(OCIRequest): + """ + Request to get the list of all active call center reporting scheduled reports in the + system. + + The response is either a + `SystemCallCenterEnhancedReportingScheduledReportGetActiveListResponse()` or an + `ErrorResponse()`. + + Attributes: + response_size_limit (int): responseSizeLimit *Optional* + search_criteria_call_center_scheduled_report_name + (List[OCI.searchCriteriaCallCenterScheduledReportName]): + searchCriteriaCallCenterScheduledReportName *Optional* + search_criteria_group_id (List[OCI.searchCriteriaGroupId]): searchCriteriaGroupId + *Optional* + search_criteria_exact_call_center_scheduled_report_service_provider + (OCI.searchCriteriaExactCallCenterScheduledReportServiceProvider): + searchCriteriaExactCallCenterScheduledReportServiceProvider *Optional* + search_criteria_service_provider_id (List[OCI.searchCriteriaServiceProviderId]): + searchCriteriaServiceProviderId *Optional* + search_criteria_exact_call_center_scheduled_report_created_by_supervisor + (OCI.searchCriteriaExactCallCenterScheduledReportCreatedBySupervisor): + searchCriteriaExactCallCenterScheduledReportCreatedBySupervisor *Optional* + search_criteria_call_center_report_template_name + (List[OCI.searchCriteriaCallCenterReportTemplateName]): + searchCriteriaCallCenterReportTemplateName *Optional* + """ + + __slots__: List[str] = [ + "response_size_limit", + "search_criteria_call_center_scheduled_report_name", + "search_criteria_group_id", + "search_criteria_exact_call_center_scheduled_report_service_provider", + "search_criteria_service_provider_id", + "search_criteria_exact_call_center_scheduled_report_created_by_supervisor", + "search_criteria_call_center_report_template_name", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("response_size_limit", "responseSizeLimit", int), + E( + "search_criteria_call_center_scheduled_report_name", + "searchCriteriaCallCenterScheduledReportName", + OCI.SearchCriteriaCallCenterScheduledReportName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_group_id", + "searchCriteriaGroupId", + OCI.SearchCriteriaGroupId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_exact_call_center_scheduled_report_service_provider", + "searchCriteriaExactCallCenterScheduledReportServiceProvider", + OCI.SearchCriteriaExactCallCenterScheduledReportServiceProvider, + is_complex=True, + ), + E( + "search_criteria_service_provider_id", + "searchCriteriaServiceProviderId", + OCI.SearchCriteriaServiceProviderId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_exact_call_center_scheduled_report_created_by_supervisor", + "searchCriteriaExactCallCenterScheduledReportCreatedBySupervisor", + OCI.SearchCriteriaExactCallCenterScheduledReportCreatedBySupervisor, + is_complex=True, + ), + E( + "search_criteria_call_center_report_template_name", + "searchCriteriaCallCenterReportTemplateName", + OCI.SearchCriteriaCallCenterReportTemplateName, + is_complex=True, + is_array=True, + ), + ) + + +class SystemCallCenterEnhancedReportingScheduledReportGetCompletedListRequest( + OCIRequest, +): + """ + Request to get the list of all completed call center reporting scheduled reports in + the system. + + The response is either a + `SystemCallCenterEnhancedReportingScheduledReportGetCompletedListResponse()` or an + `ErrorResponse()`. + + Attributes: + response_size_limit (int): responseSizeLimit *Optional* + search_criteria_call_center_scheduled_report_name + (List[OCI.searchCriteriaCallCenterScheduledReportName]): + searchCriteriaCallCenterScheduledReportName *Optional* + search_criteria_group_id (List[OCI.searchCriteriaGroupId]): searchCriteriaGroupId + *Optional* + search_criteria_exact_call_center_scheduled_report_service_provider + (OCI.searchCriteriaExactCallCenterScheduledReportServiceProvider): + searchCriteriaExactCallCenterScheduledReportServiceProvider *Optional* + search_criteria_service_provider_id (List[OCI.searchCriteriaServiceProviderId]): + searchCriteriaServiceProviderId *Optional* + search_criteria_exact_call_center_scheduled_report_created_by_supervisor + (OCI.searchCriteriaExactCallCenterScheduledReportCreatedBySupervisor): + searchCriteriaExactCallCenterScheduledReportCreatedBySupervisor *Optional* + search_criteria_call_center_report_template_name + (List[OCI.searchCriteriaCallCenterReportTemplateName]): + searchCriteriaCallCenterReportTemplateName *Optional* + """ + + __slots__: List[str] = [ + "response_size_limit", + "search_criteria_call_center_scheduled_report_name", + "search_criteria_group_id", + "search_criteria_exact_call_center_scheduled_report_service_provider", + "search_criteria_service_provider_id", + "search_criteria_exact_call_center_scheduled_report_created_by_supervisor", + "search_criteria_call_center_report_template_name", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("response_size_limit", "responseSizeLimit", int), + E( + "search_criteria_call_center_scheduled_report_name", + "searchCriteriaCallCenterScheduledReportName", + OCI.SearchCriteriaCallCenterScheduledReportName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_group_id", + "searchCriteriaGroupId", + OCI.SearchCriteriaGroupId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_exact_call_center_scheduled_report_service_provider", + "searchCriteriaExactCallCenterScheduledReportServiceProvider", + OCI.SearchCriteriaExactCallCenterScheduledReportServiceProvider, + is_complex=True, + ), + E( + "search_criteria_service_provider_id", + "searchCriteriaServiceProviderId", + OCI.SearchCriteriaServiceProviderId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_exact_call_center_scheduled_report_created_by_supervisor", + "searchCriteriaExactCallCenterScheduledReportCreatedBySupervisor", + OCI.SearchCriteriaExactCallCenterScheduledReportCreatedBySupervisor, + is_complex=True, + ), + E( + "search_criteria_call_center_report_template_name", + "searchCriteriaCallCenterReportTemplateName", + OCI.SearchCriteriaCallCenterReportTemplateName, + is_complex=True, + is_array=True, + ), + ) + + +class SystemCallCenterEnhancedReportingScheduledReportGetListRequest(OCIRequest): + """ + Request to get the list of all call center reporting scheduled reports in the system. + + The response is either an + `SystemCallCenterEnhancedReportingScheduledReportGetListResponse()` or an + `ErrorResponse()`. + + Attributes: + response_size_limit (int): responseSizeLimit *Optional* + search_criteria_call_center_scheduled_report_name + (List[OCI.searchCriteriaCallCenterScheduledReportName]): + searchCriteriaCallCenterScheduledReportName *Optional* + search_criteria_group_id (List[OCI.searchCriteriaGroupId]): searchCriteriaGroupId + *Optional* + search_criteria_exact_call_center_scheduled_report_service_provider + (OCI.searchCriteriaExactCallCenterScheduledReportServiceProvider): + searchCriteriaExactCallCenterScheduledReportServiceProvider *Optional* + search_criteria_service_provider_id (List[OCI.searchCriteriaServiceProviderId]): + searchCriteriaServiceProviderId *Optional* + search_criteria_exact_call_center_scheduled_report_created_by_supervisor + (OCI.searchCriteriaExactCallCenterScheduledReportCreatedBySupervisor): + searchCriteriaExactCallCenterScheduledReportCreatedBySupervisor *Optional* + search_criteria_call_center_report_template_name + (List[OCI.searchCriteriaCallCenterReportTemplateName]): + searchCriteriaCallCenterReportTemplateName *Optional* + """ + + __slots__: List[str] = [ + "response_size_limit", + "search_criteria_call_center_scheduled_report_name", + "search_criteria_group_id", + "search_criteria_exact_call_center_scheduled_report_service_provider", + "search_criteria_service_provider_id", + "search_criteria_exact_call_center_scheduled_report_created_by_supervisor", + "search_criteria_call_center_report_template_name", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("response_size_limit", "responseSizeLimit", int), + E( + "search_criteria_call_center_scheduled_report_name", + "searchCriteriaCallCenterScheduledReportName", + OCI.SearchCriteriaCallCenterScheduledReportName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_group_id", + "searchCriteriaGroupId", + OCI.SearchCriteriaGroupId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_exact_call_center_scheduled_report_service_provider", + "searchCriteriaExactCallCenterScheduledReportServiceProvider", + OCI.SearchCriteriaExactCallCenterScheduledReportServiceProvider, + is_complex=True, + ), + E( + "search_criteria_service_provider_id", + "searchCriteriaServiceProviderId", + OCI.SearchCriteriaServiceProviderId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_exact_call_center_scheduled_report_created_by_supervisor", + "searchCriteriaExactCallCenterScheduledReportCreatedBySupervisor", + OCI.SearchCriteriaExactCallCenterScheduledReportCreatedBySupervisor, + is_complex=True, + ), + E( + "search_criteria_call_center_report_template_name", + "searchCriteriaCallCenterReportTemplateName", + OCI.SearchCriteriaCallCenterReportTemplateName, + is_complex=True, + is_array=True, + ), + ) + + +class SystemClassmarkGetUtilizationListRequest(OCIRequest): + """ + Get the list of all users associated with a Class Mark in system. + + It is possible to search by various criteria. Multiple search criteria are logically + ANDed together. + + The response is either a `SystemClassmarkGetUtilizationListResponse()` or an + `ErrorResponse()`. + + Attributes: + classmark (str): classmark + response_size_limit (int): responseSizeLimit *Optional* + search_criteria_group_id (List[OCI.searchCriteriaGroupId]): searchCriteriaGroupId + *Optional* + search_criteria_exact_service_provider_id + (OCI.searchCriteriaExactServiceProviderId): + searchCriteriaExactServiceProviderId *Optional* + search_criteria_service_provider_id (List[OCI.searchCriteriaServiceProviderId]): + searchCriteriaServiceProviderId *Optional* + search_criteria_user_first_name (List[OCI.searchCriteriaUserFirstName]): + searchCriteriaUserFirstName *Optional* + search_criteria_user_last_name (List[OCI.searchCriteriaUserLastName]): + searchCriteriaUserLastName *Optional* + search_criteria_dn (List[OCI.searchCriteriaDn]): searchCriteriaDn *Optional* + search_criteria_user_id (List[OCI.searchCriteriaUserId]): searchCriteriaUserId + *Optional* + search_criteria_extension (List[OCI.searchCriteriaExtension]): + searchCriteriaExtension *Optional* + """ + + __slots__: List[str] = [ + "classmark", + "response_size_limit", + "search_criteria_group_id", + "search_criteria_exact_service_provider_id", + "search_criteria_service_provider_id", + "search_criteria_user_first_name", + "search_criteria_user_last_name", + "search_criteria_dn", + "search_criteria_user_id", + "search_criteria_extension", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("classmark", "classmark", str, is_required=True), + E("response_size_limit", "responseSizeLimit", int), + E( + "search_criteria_group_id", + "searchCriteriaGroupId", + OCI.SearchCriteriaGroupId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_exact_service_provider_id", + "searchCriteriaExactServiceProviderId", + OCI.SearchCriteriaExactServiceProvider, + is_complex=True, + ), + E( + "search_criteria_service_provider_id", + "searchCriteriaServiceProviderId", + OCI.SearchCriteriaServiceProviderId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_first_name", + "searchCriteriaUserFirstName", + OCI.SearchCriteriaUserFirstName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_last_name", + "searchCriteriaUserLastName", + OCI.SearchCriteriaUserLastName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_dn", + "searchCriteriaDn", + OCI.SearchCriteriaDn, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_id", + "searchCriteriaUserId", + OCI.SearchCriteriaUserId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_extension", + "searchCriteriaExtension", + OCI.SearchCriteriaExtension, + is_complex=True, + is_array=True, + ), + ) + + +class SystemCommunicationBarringDigitPatternCriteriaGetPatternListRequest(OCIRequest): + """ + Get an existing Digit Pattern Criteria. + + The response is either a + `SystemCommunicationBarringDigitPatternCriteriaGetPatternListResponse()` or an + `ErrorResponse()`. + + Attributes: + name (str): name + response_size_limit (int): responseSizeLimit *Optional* + search_criteria_digit_pattern (List[OCI.searchCriteriaDigitPattern]): + searchCriteriaDigitPattern *Optional* + """ + + __slots__: List[str] = [ + "name", + "response_size_limit", + "search_criteria_digit_pattern", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("name", "name", str, is_required=True), + E("response_size_limit", "responseSizeLimit", int), + E( + "search_criteria_digit_pattern", + "searchCriteriaDigitPattern", + OCI.SearchCriteriaDigitPattern, + is_complex=True, + is_array=True, + ), + ) + + +class SystemCommunicationBarringProfileModifyRequest(OCIRequest): + """ + Modify an existing Communication Barring Profile. + + When the originatingDefaultAction is not Treatment, originatingDefaultTreatmentId will + be automatically cleared. Also when the action of originatingRule is not Treatment, + treatmentId will be automatically cleared for the rule. The priorities for + IncomingRules are requantized to consecutive integers as part of the modify. + + The response is either a `SuccessResponse()` or an `ErrorResponse()`. The following + elements are only used in AS data mode: callMeNowDefaultAction + callMeNowDefaultCallTimeout callMeNowRule applyToAttendedCallTransfers + + Attributes: + name (str): name + new_name (str): newName *Optional* + description (str): description *Optional* + originating_default_action (str): originatingDefaultAction *Optional* + originating_default_treatment_id (str): originatingDefaultTreatmentId *Optional* + originating_default_transfer_number (str): originatingDefaultTransferNumber + *Optional* + originating_default_call_timeout (int): originatingDefaultCallTimeout *Optional* + originating_rule (OCI.originatingRule): originatingRule *Optional* + redirecting_default_action (str): redirectingDefaultAction *Optional* + redirecting_default_call_timeout (int): redirectingDefaultCallTimeout *Optional* + redirecting_rule (OCI.redirectingRule): redirectingRule *Optional* + incoming_default_action (str): incomingDefaultAction *Optional* + incoming_default_call_timeout (int): incomingDefaultCallTimeout *Optional* + incoming_rule (OCI.incomingRule): incomingRule *Optional* + call_me_now_default_action (str): callMeNowDefaultAction *Optional* + call_me_now_default_call_timeout (int): callMeNowDefaultCallTimeout *Optional* + call_me_now_rule (OCI.callMeNowRule): callMeNowRule *Optional* + apply_to_attended_call_transfers (bool): applyToAttendedCallTransfers *Optional* + """ + + __slots__: List[str] = [ + "name", + "new_name", + "description", + "originating_default_action", + "originating_default_treatment_id", + "originating_default_transfer_number", + "originating_default_call_timeout", + "originating_rule", + "redirecting_default_action", + "redirecting_default_call_timeout", + "redirecting_rule", + "incoming_default_action", + "incoming_default_call_timeout", + "incoming_rule", + "call_me_now_default_action", + "call_me_now_default_call_timeout", + "call_me_now_rule", + "apply_to_attended_call_transfers", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("name", "name", str, is_required=True), + E("new_name", "newName", str), + E("description", "description", str), + E("originating_default_action", "originatingDefaultAction", str), + E("originating_default_treatment_id", "originatingDefaultTreatmentId", str), + E( + "originating_default_transfer_number", + "originatingDefaultTransferNumber", + str, + ), + E("originating_default_call_timeout", "originatingDefaultCallTimeout", int), + E( + "originating_rule", + "originatingRule", + OCI.ReplacementCommunicationBarringOriginatingRuleList, + is_complex=True, + ), + E("redirecting_default_action", "redirectingDefaultAction", str), + E("redirecting_default_call_timeout", "redirectingDefaultCallTimeout", int), + E( + "redirecting_rule", + "redirectingRule", + OCI.ReplacementCommunicationBarringRedirectingRuleList, + is_complex=True, + ), + E("incoming_default_action", "incomingDefaultAction", str), + E("incoming_default_call_timeout", "incomingDefaultCallTimeout", int), + E( + "incoming_rule", + "incomingRule", + OCI.ReplacementCommunicationBarringIncomingRuleList19sp1, + is_complex=True, + ), + E("call_me_now_default_action", "callMeNowDefaultAction", str), + E("call_me_now_default_call_timeout", "callMeNowDefaultCallTimeout", int), + E( + "call_me_now_rule", + "callMeNowRule", + OCI.ReplacementCommunicationBarringCallMeNowRuleList, + is_complex=True, + ), + E("apply_to_attended_call_transfers", "applyToAttendedCallTransfers", bool), + ) + + +class SystemDeviceFamilyGetListRequest(OCIRequest): + """ + Request to get the list of device family managed by the Device Management System. + + If includeSystemLevel is specified, all system level device families and the reseller + device families matching search criteria are returned even when + searchCriteriaResellerId is specified. If reseller administrator sends the request, + searchCriteriaResellerId is ignored and automatically set to the administrator's + reseller. + + The response is either `SystemDeviceFamilyGetListResponse()` or `ErrorResponse()`. + + Attributes: + include_system_level (bool): includeSystemLevel *Optional* + search_criteria_reseller_id (List[OCI.searchCriteriaResellerId]): + searchCriteriaResellerId *Optional* + """ + + __slots__: List[str] = [ + "include_system_level", + "search_criteria_reseller_id", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("include_system_level", "includeSystemLevel", bool), + E( + "search_criteria_reseller_id", + "searchCriteriaResellerId", + OCI.SearchCriteriaResellerId, + is_complex=True, + is_array=True, + ), + ) + + +class SystemDeviceManagementEventGetListRequest(OCIRequest): + """ + Request device management's events for a specific queue. + + It is possible to restrict the number of rows returned using responseSizeLimit. If + eventQueueType is not specified, the events from all the event queues are returned. + + The response is either a `SystemDeviceManagementEventGetListResponse()` or an + `ErrorResponse()`. Deprecated by: `SystemDeviceManagementEventGetListRequest22()`. + + Attributes: + event_queue_type (str): eventQueueType *Optional* + response_size_limit (int): responseSizeLimit *Optional* + search_criteria_exact_device_management_event_status_in_progress_or_pending + (OCI.searchCriteriaExactDeviceManagementEventStatusInProgressOrPending): + searchCriteriaExactDeviceManagementEventStatusInProgressOrPending *Optional* + search_criteria_exact_device_management_event_status_completed + (OCI.searchCriteriaExactDeviceManagementEventStatusCompleted): + searchCriteriaExactDeviceManagementEventStatusCompleted *Optional* + search_criteria_exact_device_management_event_action + (OCI.searchCriteriaExactDeviceManagementEventAction): + searchCriteriaExactDeviceManagementEventAction *Optional* + search_criteria_exact_device_management_event_level + (OCI.searchCriteriaExactDeviceManagementEventLevel): + searchCriteriaExactDeviceManagementEventLevel *Optional* + search_criteria_exact_device_management_event_type + (OCI.searchCriteriaExactDeviceManagementEventType): + searchCriteriaExactDeviceManagementEventType *Optional* + search_criteria_device_management_event_additional_info + (List[OCI.searchCriteriaDeviceManagementEventAdditionalInfo]): + searchCriteriaDeviceManagementEventAdditionalInfo *Optional* + search_criteria_device_management_event_login_id + (List[OCI.searchCriteriaDeviceManagementEventLoginId]): + searchCriteriaDeviceManagementEventLoginId *Optional* + """ + + __slots__: List[str] = [ + "event_queue_type", + "response_size_limit", + "search_criteria_exact_device_management_event_status_in_progress_or_pending", + "search_criteria_exact_device_management_event_status_completed", + "search_criteria_exact_device_management_event_action", + "search_criteria_exact_device_management_event_level", + "search_criteria_exact_device_management_event_type", + "search_criteria_device_management_event_additional_info", + "search_criteria_device_management_event_login_id", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("event_queue_type", "eventQueueType", str), + E("response_size_limit", "responseSizeLimit", int), + E( + "search_criteria_exact_device_management_event_status_in_progress_or_pending", + "searchCriteriaExactDeviceManagementEventStatusInProgressOrPending", + OCI.SearchCriteriaExactDeviceManagementEventStatusInProgressOrPending, + is_complex=True, + ), + E( + "search_criteria_exact_device_management_event_status_completed", + "searchCriteriaExactDeviceManagementEventStatusCompleted", + OCI.SearchCriteriaExactDeviceManagementEventStatusCompleted, + is_complex=True, + ), + E( + "search_criteria_exact_device_management_event_action", + "searchCriteriaExactDeviceManagementEventAction", + OCI.SearchCriteriaExactDeviceManagementEventAction, + is_complex=True, + ), + E( + "search_criteria_exact_device_management_event_level", + "searchCriteriaExactDeviceManagementEventLevel", + OCI.SearchCriteriaExactDeviceManagementEventLevel, + is_complex=True, + ), + E( + "search_criteria_exact_device_management_event_type", + "searchCriteriaExactDeviceManagementEventType", + OCI.SearchCriteriaExactDeviceManagementEventType, + is_complex=True, + ), + E( + "search_criteria_device_management_event_additional_info", + "searchCriteriaDeviceManagementEventAdditionalInfo", + OCI.SearchCriteriaDeviceManagementEventAdditionalInfo, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_device_management_event_login_id", + "searchCriteriaDeviceManagementEventLoginId", + OCI.SearchCriteriaDeviceManagementEventLoginId, + is_complex=True, + is_array=True, + ), + ) + + +class SystemDeviceManagementEventGetListRequest22(OCIRequest): + """ + Request device management's events for a specific queue. + + It is possible to restrict the number of rows returned using responseSizeLimit. If + eventQueueType is not specified, the events from all the event queues are returned. + + The response is either a `SystemDeviceManagementEventGetListResponse22()` or an + `ErrorResponse()`. + + Attributes: + event_queue_type (str): eventQueueType *Optional* + response_size_limit (int): responseSizeLimit *Optional* + search_criteria_exact_device_management_event_status_in_progress_or_pending + (OCI.searchCriteriaExactDeviceManagementEventStatusInProgressOrPending): + searchCriteriaExactDeviceManagementEventStatusInProgressOrPending *Optional* + search_criteria_exact_device_management_event_status_completed + (OCI.searchCriteriaExactDeviceManagementEventStatusCompleted): + searchCriteriaExactDeviceManagementEventStatusCompleted *Optional* + search_criteria_exact_device_management_event_action + (OCI.searchCriteriaExactDeviceManagementEventAction): + searchCriteriaExactDeviceManagementEventAction *Optional* + search_criteria_exact_device_management_event_level + (OCI.searchCriteriaExactDeviceManagementEventLevel): + searchCriteriaExactDeviceManagementEventLevel *Optional* + search_criteria_exact_device_management_event_type + (OCI.searchCriteriaExactDeviceManagementEventType): + searchCriteriaExactDeviceManagementEventType *Optional* + search_criteria_device_management_event_additional_info + (List[OCI.searchCriteriaDeviceManagementEventAdditionalInfo]): + searchCriteriaDeviceManagementEventAdditionalInfo *Optional* + search_criteria_device_management_event_login_id + (List[OCI.searchCriteriaDeviceManagementEventLoginId]): + searchCriteriaDeviceManagementEventLoginId *Optional* + """ + + __slots__: List[str] = [ + "event_queue_type", + "response_size_limit", + "search_criteria_exact_device_management_event_status_in_progress_or_pending", + "search_criteria_exact_device_management_event_status_completed", + "search_criteria_exact_device_management_event_action", + "search_criteria_exact_device_management_event_level", + "search_criteria_exact_device_management_event_type", + "search_criteria_device_management_event_additional_info", + "search_criteria_device_management_event_login_id", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("event_queue_type", "eventQueueType", str), + E("response_size_limit", "responseSizeLimit", int), + E( + "search_criteria_exact_device_management_event_status_in_progress_or_pending", + "searchCriteriaExactDeviceManagementEventStatusInProgressOrPending", + OCI.SearchCriteriaExactDeviceManagementEventStatusInProgressOrPending, + is_complex=True, + ), + E( + "search_criteria_exact_device_management_event_status_completed", + "searchCriteriaExactDeviceManagementEventStatusCompleted", + OCI.SearchCriteriaExactDeviceManagementEventStatusCompleted, + is_complex=True, + ), + E( + "search_criteria_exact_device_management_event_action", + "searchCriteriaExactDeviceManagementEventAction", + OCI.SearchCriteriaExactDeviceManagementEventAction, + is_complex=True, + ), + E( + "search_criteria_exact_device_management_event_level", + "searchCriteriaExactDeviceManagementEventLevel", + OCI.SearchCriteriaExactDeviceManagementEventLevel, + is_complex=True, + ), + E( + "search_criteria_exact_device_management_event_type", + "searchCriteriaExactDeviceManagementEventType", + OCI.SearchCriteriaExactDeviceManagementEventType, + is_complex=True, + ), + E( + "search_criteria_device_management_event_additional_info", + "searchCriteriaDeviceManagementEventAdditionalInfo", + OCI.SearchCriteriaDeviceManagementEventAdditionalInfo, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_device_management_event_login_id", + "searchCriteriaDeviceManagementEventLoginId", + OCI.SearchCriteriaDeviceManagementEventLoginId, + is_complex=True, + is_array=True, + ), + ) + + +class SystemDeviceProfileAuthenticationLockoutGetRequest(OCIRequest): + """ + Request to get device password authentication lockout data in the system. + + The response is either a `SystemDeviceProfileAuthenticationLockoutGetResponse()` or an + `ErrorResponse()`. + + Attributes: + response_size_limit (int): responseSizeLimit *Optional* + search_criteria_service_provider_id (List[OCI.searchCriteriaServiceProviderId]): + searchCriteriaServiceProviderId *Optional* + search_criteria_exact_organization_type (OCI.searchCriteriaExactOrganizationType): + searchCriteriaExactOrganizationType *Optional* + search_criteria_group_id (List[OCI.searchCriteriaGroupId]): searchCriteriaGroupId + *Optional* + search_criteria_device_name (List[OCI.searchCriteriaDeviceName]): + searchCriteriaDeviceName *Optional* + search_criteria_exact_device_type (OCI.searchCriteriaExactDeviceType): + searchCriteriaExactDeviceType *Optional* + """ + + __slots__: List[str] = [ + "response_size_limit", + "search_criteria_service_provider_id", + "search_criteria_exact_organization_type", + "search_criteria_group_id", + "search_criteria_device_name", + "search_criteria_exact_device_type", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("response_size_limit", "responseSizeLimit", int), + E( + "search_criteria_service_provider_id", + "searchCriteriaServiceProviderId", + OCI.SearchCriteriaServiceProviderId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_exact_organization_type", + "searchCriteriaExactOrganizationType", + OCI.SearchCriteriaExactOrganizationType, + is_complex=True, + ), + E( + "search_criteria_group_id", + "searchCriteriaGroupId", + OCI.SearchCriteriaGroupId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_device_name", + "searchCriteriaDeviceName", + OCI.SearchCriteriaDeviceName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_exact_device_type", + "searchCriteriaExactDeviceType", + OCI.SearchCriteriaExactDeviceType, + is_complex=True, + ), + ) + + +class SystemDnGetSummaryListRequest(OCIRequest): + """ + Request a summary table of all DNs in the system. + + If resellerId is specified, the DNs assigned to the enterprises/service providers + within the reseller are returned. If reseller administrator sends the request and + resellerId is not specified, the administrator's resellerId is used. The search can + be done using multiple criteria. Only results matching all the search criteria are + included in the results. + + The response is either `SystemDnGetSummaryListResponse()` or `ErrorResponse()`. The + following data elements are only used in AS data mode: resellerId The following + elements are only used in XS data mode and ignored in AS data mode: searchCriteriaDn, + searchCriteriaServiceProviderId, searchCriteriaExactOrganizationType + + Attributes: + reseller_id (str): resellerId *Optional* + search_criteria_dn (List[OCI.searchCriteriaDn]): searchCriteriaDn *Optional* + search_criteria_service_provider_id (List[OCI.searchCriteriaServiceProviderId]): + searchCriteriaServiceProviderId *Optional* + search_criteria_exact_organization_type (OCI.searchCriteriaExactOrganizationType): + searchCriteriaExactOrganizationType *Optional* + """ + + __slots__: List[str] = [ + "reseller_id", + "search_criteria_dn", + "search_criteria_service_provider_id", + "search_criteria_exact_organization_type", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("reseller_id", "resellerId", str), + E( + "search_criteria_dn", + "searchCriteriaDn", + OCI.SearchCriteriaDn, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_service_provider_id", + "searchCriteriaServiceProviderId", + OCI.SearchCriteriaServiceProviderId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_exact_organization_type", + "searchCriteriaExactOrganizationType", + OCI.SearchCriteriaExactOrganizationType, + is_complex=True, + ), + ) + + +class SystemDomainGetListRequest22V2(OCIRequest): + """ + Requests the list of all matching system-level domains and all matching reseller level + domains. + + If excludeReseller is specified, returns all matching system-level domain names only. + If resellerId is specified, returns all matching system-level domain names and the + given reseller's domains. If reseller administrator sends the request and resellerId + is not specified, the administrator's resellerId is used. + + The response is either `SystemDomainGetListResponse22V2()` or `ErrorResponse()`. The + following elements are only used in AS data mode and will be ingored in XS data mode: + includeReseller resellerId responseSizeLimit searchCriteriaDomainName + searchCriteriaResellerId searchCriteriaExactDomainLevel + + Attributes: + exclude_reseller (bool): excludeReseller *Optional* + reseller_id (str): resellerId *Optional* + response_size_limit (int): responseSizeLimit *Optional* + search_criteria_domain_name (List[OCI.searchCriteriaDomainName]): + searchCriteriaDomainName *Optional* + search_criteria_reseller_id (List[OCI.searchCriteriaResellerId]): + searchCriteriaResellerId *Optional* + search_criteria_exact_domain_level (OCI.searchCriteriaExactDomainLevel): + searchCriteriaExactDomainLevel *Optional* + """ + + __slots__: List[str] = [ + "exclude_reseller", + "reseller_id", + "response_size_limit", + "search_criteria_domain_name", + "search_criteria_reseller_id", + "search_criteria_exact_domain_level", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("exclude_reseller", "excludeReseller", bool), + E("reseller_id", "resellerId", str), + E("response_size_limit", "responseSizeLimit", int), + E( + "search_criteria_domain_name", + "searchCriteriaDomainName", + OCI.SearchCriteriaDomainName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_reseller_id", + "searchCriteriaResellerId", + OCI.SearchCriteriaResellerId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_exact_domain_level", + "searchCriteriaExactDomainLevel", + OCI.SearchCriteriaExactDomainLevel, + is_complex=True, + ), + ) + + +class SystemEndpointGetListRequest(OCIRequest): + """ + Request to search endpoints in the system. + + If reseller administrator sends the request, searchCriteriaResellerId is ignored. All + endpoints in the administrator's reseller meeting the search criteria are returned. + + The response is either `SystemEndpointGetListResponse()` or `ErrorResponse()`. The + following data elements are only used in AS data mode: searchCriteriaResellerId + + Attributes: + response_size_limit (int): responseSizeLimit *Optional* + search_criteria_service_provider_id (List[OCI.searchCriteriaServiceProviderId]): + searchCriteriaServiceProviderId *Optional* + search_criteria_exact_organization_type (OCI.searchCriteriaExactOrganizationType): + searchCriteriaExactOrganizationType *Optional* + search_criteria_group_id (List[OCI.searchCriteriaGroupId]): searchCriteriaGroupId + *Optional* + search_criteria_line_port_user_part (List[OCI.searchCriteriaLinePortUserPart]): + searchCriteriaLinePortUserPart *Optional* + search_criteria_line_port_domain (List[OCI.searchCriteriaLinePortDomain]): + searchCriteriaLinePortDomain *Optional* + search_criteria_user_last_name (List[OCI.searchCriteriaUserLastName]): + searchCriteriaUserLastName *Optional* + search_criteria_user_first_name (List[OCI.searchCriteriaUserFirstName]): + searchCriteriaUserFirstName *Optional* + search_criteria_user_id (List[OCI.searchCriteriaUserId]): searchCriteriaUserId + *Optional* + search_criteria_dn (List[OCI.searchCriteriaDn]): searchCriteriaDn *Optional* + search_criteria_extension (List[OCI.searchCriteriaExtension]): + searchCriteriaExtension *Optional* + search_criteria_device_type (List[OCI.searchCriteriaDeviceType]): + searchCriteriaDeviceType *Optional* + search_criteria_device_name (List[OCI.searchCriteriaDeviceName]): + searchCriteriaDeviceName *Optional* + search_criteria_device_mac_address (List[OCI.searchCriteriaDeviceMACAddress]): + searchCriteriaDeviceMACAddress *Optional* + search_criteria_device_net_address (List[OCI.searchCriteriaDeviceNetAddress]): + searchCriteriaDeviceNetAddress *Optional* + search_criteria_reseller_id (List[OCI.searchCriteriaResellerId]): + searchCriteriaResellerId *Optional* + """ + + __slots__: List[str] = [ + "response_size_limit", + "search_criteria_service_provider_id", + "search_criteria_exact_organization_type", + "search_criteria_group_id", + "search_criteria_line_port_user_part", + "search_criteria_line_port_domain", + "search_criteria_user_last_name", + "search_criteria_user_first_name", + "search_criteria_user_id", + "search_criteria_dn", + "search_criteria_extension", + "search_criteria_device_type", + "search_criteria_device_name", + "search_criteria_device_mac_address", + "search_criteria_device_net_address", + "search_criteria_reseller_id", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("response_size_limit", "responseSizeLimit", int), + E( + "search_criteria_service_provider_id", + "searchCriteriaServiceProviderId", + OCI.SearchCriteriaServiceProviderId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_exact_organization_type", + "searchCriteriaExactOrganizationType", + OCI.SearchCriteriaExactOrganizationType, + is_complex=True, + ), + E( + "search_criteria_group_id", + "searchCriteriaGroupId", + OCI.SearchCriteriaGroupId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_line_port_user_part", + "searchCriteriaLinePortUserPart", + OCI.SearchCriteriaLinePortUserPart, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_line_port_domain", + "searchCriteriaLinePortDomain", + OCI.SearchCriteriaLinePortDomain, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_last_name", + "searchCriteriaUserLastName", + OCI.SearchCriteriaUserLastName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_first_name", + "searchCriteriaUserFirstName", + OCI.SearchCriteriaUserFirstName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_id", + "searchCriteriaUserId", + OCI.SearchCriteriaUserId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_dn", + "searchCriteriaDn", + OCI.SearchCriteriaDn, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_extension", + "searchCriteriaExtension", + OCI.SearchCriteriaExtension, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_device_type", + "searchCriteriaDeviceType", + OCI.SearchCriteriaDeviceType, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_device_name", + "searchCriteriaDeviceName", + OCI.SearchCriteriaDeviceName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_device_mac_address", + "searchCriteriaDeviceMACAddress", + OCI.SearchCriteriaDeviceMACAddress, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_device_net_address", + "searchCriteriaDeviceNetAddress", + OCI.SearchCriteriaDeviceNetAddress, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_reseller_id", + "searchCriteriaResellerId", + OCI.SearchCriteriaResellerId, + is_complex=True, + is_array=True, + ), + ) + + +class SystemGetRegistrationContactListRequest(OCIRequest): + """ + Get the list of registration contacts. + + This request handles all levels of administration privileges. The content of the + response will only contain items within the scope of the requester's login id. At the + system level any of the choice parameters may be specified to filter the registrations + listed. At the reseller level, the resellerId must be specified. ResellerId is not + valid at service provider, group or user level. At the service provider level the + serviceProviderId must be specified for the service provider and group options. When + using the userId or linePort options the specified value must be valid for that + service provider login. At the group level the servicProviderId and the groupId must + be specified for the group option. When using the userId or linePort options the + specified value must be valid for that group login. The serviceProviderId option is + not valid at the group level. At the user level when using the userId or linePort + options the specified value must be valid for that user login. The serviceProviderId + and groupId options are not valid at the user level. + + The response is either `SystemGetRegistrationContactListResponse()` or + `ErrorResponse()`. The following elements are only used in AS data mode: resellerId + + Attributes: + reseller_id (str): resellerId *Optional* + service_provider_id (str): serviceProviderId *Optional* + svc_provider_id (str): svcProviderId *Optional* + group_id (str): groupId *Optional* + user_id (str): userId *Optional* + line_port (str): linePort *Optional* + device_level (str): deviceLevel *Optional* + device_name (str): deviceName *Optional* + device_type (str): deviceType *Optional* + search_criteria_registration_uri (List[OCI.searchCriteriaRegistrationURI]): + searchCriteriaRegistrationURI *Optional* + search_criteria_sip_contact (List[OCI.searchCriteriaSIPContact]): + searchCriteriaSIPContact *Optional* + endpoint_type (str): endpointType *Optional* + expired (bool): expired *Optional* + """ + + __slots__: List[str] = [ + "reseller_id", + "service_provider_id", + "svc_provider_id", + "group_id", + "user_id", + "line_port", + "device_level", + "device_name", + "device_type", + "search_criteria_registration_uri", + "search_criteria_sip_contact", + "endpoint_type", + "expired", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("reseller_id", "resellerId", str), + E("service_provider_id", "serviceProviderId", str), + E("svc_provider_id", "svcProviderId", str), + E("group_id", "groupId", str), + E("user_id", "userId", str), + E("line_port", "linePort", str), + E("device_level", "deviceLevel", str), + E("device_name", "deviceName", str), + E("device_type", "deviceType", str), + E( + "search_criteria_registration_uri", + "searchCriteriaRegistrationURI", + OCI.SearchCriteriaRegistrationURI, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_sip_contact", + "searchCriteriaSIPContact", + OCI.SearchCriteriaSIPContact, + is_complex=True, + is_array=True, + ), + E("endpoint_type", "endpointType", str), + E("expired", "expired", bool), + ) + + +class SystemGetRegistrationContactListRequest21sp1(OCIRequest): + """ + Get the list of registration contacts. + + This request handles all levels of administration privileges. The content of the + response will only contain items within the scope of the requester's login id. At the + system level any of the choice parameters may be specified to filter the registrations + listed. At the reseller level, the resellerId must be specified. ResellerId is not + valid at service provider, group or user level. At the service provider level the + serviceProviderId must be specified for the service provider and group options. When + using the userId or linePort options the specified value must be valid for that + service provider login. At the group level the servicProviderId and the groupId must + be specified for the group option. When using the userId or linePort options the + specified value must be valid for that group login. The serviceProviderId option is + not valid at the group level. At the user level when using the userId or linePort + options the specified value must be valid for that user login. The serviceProviderId + and groupId options are not valid at the user level. + + The response is either `SystemGetRegistrationContactListResponse21sp1()` or + `ErrorResponse()`. The RegistrationEndpointType21sp1 is sent in response The Endpoint + Type column contains one of the enumerated RegistrationEndpointType21sp1 values. The + value Mobility in Endpoint Type column is only applicable in AS data mode. The + following elements are only used in AS data mode: resellerId + + Attributes: + reseller_id (str): resellerId *Optional* + service_provider_id (str): serviceProviderId *Optional* + svc_provider_id (str): svcProviderId *Optional* + group_id (str): groupId *Optional* + user_id (str): userId *Optional* + line_port (str): linePort *Optional* + device_level (str): deviceLevel *Optional* + device_name (str): deviceName *Optional* + device_type (str): deviceType *Optional* + search_criteria_registration_uri (List[OCI.searchCriteriaRegistrationURI]): + searchCriteriaRegistrationURI *Optional* + search_criteria_sip_contact (List[OCI.searchCriteriaSIPContact]): + searchCriteriaSIPContact *Optional* + endpoint_type (str): endpointType *Optional* + expired (bool): expired *Optional* + """ + + __slots__: List[str] = [ + "reseller_id", + "service_provider_id", + "svc_provider_id", + "group_id", + "user_id", + "line_port", + "device_level", + "device_name", + "device_type", + "search_criteria_registration_uri", + "search_criteria_sip_contact", + "endpoint_type", + "expired", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("reseller_id", "resellerId", str), + E("service_provider_id", "serviceProviderId", str), + E("svc_provider_id", "svcProviderId", str), + E("group_id", "groupId", str), + E("user_id", "userId", str), + E("line_port", "linePort", str), + E("device_level", "deviceLevel", str), + E("device_name", "deviceName", str), + E("device_type", "deviceType", str), + E( + "search_criteria_registration_uri", + "searchCriteriaRegistrationURI", + OCI.SearchCriteriaRegistrationURI, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_sip_contact", + "searchCriteriaSIPContact", + OCI.SearchCriteriaSIPContact, + is_complex=True, + is_array=True, + ), + E("endpoint_type", "endpointType", str), + E("expired", "expired", bool), + ) + + +class SystemHomeNetworkGetListRequest(OCIRequest): + """ + Get the list of all Home Networks. + + The response is either a `SystemHomeNetworkGetListResponse()` or an `ErrorResponse()`. + + Attributes: + response_size_limit (int): responseSizeLimit *Optional* + search_criteria_home_msc_address (List[OCI.searchCriteriaHomeMscAddress]): + searchCriteriaHomeMscAddress *Optional* + """ + + __slots__: List[str] = [ + "response_size_limit", + "search_criteria_home_msc_address", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("response_size_limit", "responseSizeLimit", int), + E( + "search_criteria_home_msc_address", + "searchCriteriaHomeMscAddress", + OCI.SearchCriteriaHomeMscAddress, + is_complex=True, + is_array=True, + ), + ) + + +class SystemNumberPortabilityQueryDigitPatternGetListRequest(OCIRequest): + """ + Request to get the System Number Portability Query Digit Pattern List information. + + The response is either a `SystemNumberPortabilityQueryDigitPatternGetListResponse()` + or an `ErrorResponse()`. + + Attributes: + search_criteria_number_portability_query_digit_pattern + (List[OCI.searchCriteriaNumberPortabilityQueryDigitPattern]): + searchCriteriaNumberPortabilityQueryDigitPattern *Optional* + search_criteria_number_portability_status + (List[OCI.searchCriteriaNumberPortabilityStatus]): + searchCriteriaNumberPortabilityStatus *Optional* + response_size_limit (int): responseSizeLimit *Optional* + """ + + __slots__: List[str] = [ + "search_criteria_number_portability_query_digit_pattern", + "search_criteria_number_portability_status", + "response_size_limit", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E( + "search_criteria_number_portability_query_digit_pattern", + "searchCriteriaNumberPortabilityQueryDigitPattern", + OCI.SearchCriteriaNumberPortabilityQueryDigitPattern, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_number_portability_status", + "searchCriteriaNumberPortabilityStatus", + OCI.SearchCriteriaNumberPortabilityStatus, + is_complex=True, + is_array=True, + ), + E("response_size_limit", "responseSizeLimit", int), + ) + + +class SystemPreferredCarrierGetGroupListRequest(OCIRequest): + """ + Requests a list of groups using the specified carrier. + + It is possible to restrict the number of rows returned by specifying various search + criteria. Multiple search criteria are logically ANDed together. + + The response is either a `SystemPreferredCarrierGetGroupListResponse()` or an + `ErrorResponse()`. + + Attributes: + carrier (str): carrier + response_size_limit (int): responseSizeLimit *Optional* + search_criteria_group_id (List[OCI.searchCriteriaGroupId]): searchCriteriaGroupId + *Optional* + search_criteria_group_name (List[OCI.searchCriteriaGroupName]): + searchCriteriaGroupName *Optional* + search_criteria_exact_service_provider (OCI.searchCriteriaExactServiceProvider): + searchCriteriaExactServiceProvider *Optional* + search_criteria_service_provider_id (List[OCI.searchCriteriaServiceProviderId]): + searchCriteriaServiceProviderId *Optional* + """ + + __slots__: List[str] = [ + "carrier", + "response_size_limit", + "search_criteria_group_id", + "search_criteria_group_name", + "search_criteria_exact_service_provider", + "search_criteria_service_provider_id", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("carrier", "carrier", str, is_required=True), + E("response_size_limit", "responseSizeLimit", int), + E( + "search_criteria_group_id", + "searchCriteriaGroupId", + OCI.SearchCriteriaGroupId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_group_name", + "searchCriteriaGroupName", + OCI.SearchCriteriaGroupName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_exact_service_provider", + "searchCriteriaExactServiceProvider", + OCI.SearchCriteriaExactServiceProvider, + is_complex=True, + ), + E( + "search_criteria_service_provider_id", + "searchCriteriaServiceProviderId", + OCI.SearchCriteriaServiceProviderId, + is_complex=True, + is_array=True, + ), + ) + + +class SystemPreferredCarrierGetUserListRequest(OCIRequest): + """ + Requests a list of users using the specified carrier. + + It is possible to restrict the number of rows returned by specifying various search + criteria. Multiple search criteria are logically ANDed together. + + The response is either a `SystemPreferreredCarrierGetUserListResponse()` or an + `ErrorResponse()`. + + Attributes: + carrier (str): carrier + response_size_limit (int): responseSizeLimit *Optional* + search_criteria_user_last_name (List[OCI.searchCriteriaUserLastName]): + searchCriteriaUserLastName *Optional* + search_criteria_user_first_name (List[OCI.searchCriteriaUserFirstName]): + searchCriteriaUserFirstName *Optional* + search_criteria_dn (List[OCI.searchCriteriaDn]): searchCriteriaDn *Optional* + search_criteria_email_address (List[OCI.searchCriteriaEmailAddress]): + searchCriteriaEmailAddress *Optional* + search_criteria_user_id (List[OCI.searchCriteriaUserId]): searchCriteriaUserId + *Optional* + search_criteria_extension (List[OCI.searchCriteriaExtension]): + searchCriteriaExtension *Optional* + """ + + __slots__: List[str] = [ + "carrier", + "response_size_limit", + "search_criteria_user_last_name", + "search_criteria_user_first_name", + "search_criteria_dn", + "search_criteria_email_address", + "search_criteria_user_id", + "search_criteria_extension", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("carrier", "carrier", str, is_required=True), + E("response_size_limit", "responseSizeLimit", int), E( - "search_criteria_exact_organization_type", - "searchCriteriaExactOrganizationType", - OCI.SearchCriteriaExactOrganizationType, + "search_criteria_user_last_name", + "searchCriteriaUserLastName", + OCI.SearchCriteriaUserLastName, is_complex=True, + is_array=True, ), E( - "search_criteria_reseller_id", - "searchCriteriaResellerId", - OCI.SearchCriteriaResellerId, + "search_criteria_user_first_name", + "searchCriteriaUserFirstName", + OCI.SearchCriteriaUserFirstName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_dn", + "searchCriteriaDn", + OCI.SearchCriteriaDn, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_email_address", + "searchCriteriaEmailAddress", + OCI.SearchCriteriaEmailAddress, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_id", + "searchCriteriaUserId", + OCI.SearchCriteriaUserId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_extension", + "searchCriteriaExtension", + OCI.SearchCriteriaExtension, is_complex=True, is_array=True, ), - E("search_criteria_mode_or", "searchCriteriaModeOr", bool), ) -class ServiceProviderMWIDeliveryToMobileEndpointCustomTemplateAddRequest(OCIRequest): +class SystemRoamingNetworkGetListRequest(OCIRequest): """ - Create a MWI Delivery to Mobile Endpoint Custom Template. + Get the list of all Roaming Networks. - The response is either a `SuccessResponse()` or an `ErrorResponse()`. + The response is either a `SystemRoamingNetworkGetListResponse()` or an + `ErrorResponse()`. Attributes: - service_provider_id (str): serviceProviderId - language (str): language - type (str): type - is_enabled (bool): isEnabled - template_body (OCI.templateBody): templateBody + response_size_limit (int): responseSizeLimit *Optional* + search_criteria_roaming_msc_address (List[OCI.searchCriteriaRoamingMscAddress]): + searchCriteriaRoamingMscAddress *Optional* """ __slots__: List[str] = [ - "service_provider_id", - "language", - "type", - "is_enabled", - "template_body", + "response_size_limit", + "search_criteria_roaming_msc_address", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("service_provider_id", "serviceProviderId", str, is_required=True), - E("language", "language", str, is_required=True), - E("type", "type", str, is_required=True), - E("is_enabled", "isEnabled", bool, is_required=True), + E("response_size_limit", "responseSizeLimit", int), E( - "template_body", - "templateBody", - OCI.MWIDeliveryToMobileEndpointTemplateBody, + "search_criteria_roaming_msc_address", + "searchCriteriaRoamingMscAddress", + OCI.SearchCriteriaRoamingMscAddress, is_complex=True, - is_required=True, + is_array=True, ), ) -class ServiceProviderMWIDeliveryToMobileEndpointCustomTemplateModifyRequest(OCIRequest): +class SystemSIPAuthenticationEndpointLockoutGetRequest(OCIRequest): """ - Modify a MWI Delivery to Mobile Endpoint Custom Template. + Request to get sip authentication endpoint lockout data in the system. - The response is either a `SuccessResponse()` or an `ErrorResponse()`. + The response is either a `SystemSIPAuthenticationEndpointLockoutGetResponse()` or an + `ErrorResponse()`. Attributes: - service_provider_id (str): serviceProviderId - language (str): language - type (str): type - is_enabled (bool): isEnabled *Optional* - template_body (OCI.templateBody): templateBody *Optional* + response_size_limit (int): responseSizeLimit *Optional* + search_criteria_service_provider_id (List[OCI.searchCriteriaServiceProviderId]): + searchCriteriaServiceProviderId *Optional* + search_criteria_exact_organization_type (OCI.searchCriteriaExactOrganizationType): + searchCriteriaExactOrganizationType *Optional* + search_criteria_group_id (List[OCI.searchCriteriaGroupId]): searchCriteriaGroupId + *Optional* + search_criteria_line_port_user_part (List[OCI.searchCriteriaLinePortUserPart]): + searchCriteriaLinePortUserPart *Optional* + search_criteria_line_port_domain (List[OCI.searchCriteriaLinePortDomain]): + searchCriteriaLinePortDomain *Optional* + search_criteria_user_last_name (List[OCI.searchCriteriaUserLastName]): + searchCriteriaUserLastName *Optional* + search_criteria_user_first_name (List[OCI.searchCriteriaUserFirstName]): + searchCriteriaUserFirstName *Optional* + search_criteria_user_id (List[OCI.searchCriteriaUserId]): searchCriteriaUserId + *Optional* """ __slots__: List[str] = [ - "service_provider_id", - "language", - "type", - "is_enabled", - "template_body", + "response_size_limit", + "search_criteria_service_provider_id", + "search_criteria_exact_organization_type", + "search_criteria_group_id", + "search_criteria_line_port_user_part", + "search_criteria_line_port_domain", + "search_criteria_user_last_name", + "search_criteria_user_first_name", + "search_criteria_user_id", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("service_provider_id", "serviceProviderId", str, is_required=True), - E("language", "language", str, is_required=True), - E("type", "type", str, is_required=True), - E("is_enabled", "isEnabled", bool), + E("response_size_limit", "responseSizeLimit", int), E( - "template_body", - "templateBody", - OCI.MWIDeliveryToMobileEndpointTemplateBody, + "search_criteria_service_provider_id", + "searchCriteriaServiceProviderId", + OCI.SearchCriteriaServiceProviderId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_exact_organization_type", + "searchCriteriaExactOrganizationType", + OCI.SearchCriteriaExactOrganizationType, + is_complex=True, + ), + E( + "search_criteria_group_id", + "searchCriteriaGroupId", + OCI.SearchCriteriaGroupId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_line_port_user_part", + "searchCriteriaLinePortUserPart", + OCI.SearchCriteriaLinePortUserPart, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_line_port_domain", + "searchCriteriaLinePortDomain", + OCI.SearchCriteriaLinePortDomain, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_last_name", + "searchCriteriaUserLastName", + OCI.SearchCriteriaUserLastName, is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_first_name", + "searchCriteriaUserFirstName", + OCI.SearchCriteriaUserFirstName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_id", + "searchCriteriaUserId", + OCI.SearchCriteriaUserId, + is_complex=True, + is_array=True, ), ) -class ServiceProviderRouteListEnterpriseTrunkNumberPrefixAddListRequest22(OCIRequest): +class SystemSIPAuthenticationTrunkGroupLockoutGetRequest(OCIRequest): """ - Add number prefixes to a service provider. + Request to get sip authentication trunk group lockout data in the system. - The response is either `SuccessResponse()` or `ErrorResponse()`. + The response is either a `SystemSIPAuthenticationTrunkGroupLockoutGetResponse()` or an + `ErrorResponse()`. Attributes: - service_provider_id (str): serviceProviderId - prefix (List[OCI.prefix]): prefix + response_size_limit (int): responseSizeLimit *Optional* + search_criteria_service_provider_id (List[OCI.searchCriteriaServiceProviderId]): + searchCriteriaServiceProviderId *Optional* + search_criteria_exact_organization_type (OCI.searchCriteriaExactOrganizationType): + searchCriteriaExactOrganizationType *Optional* + search_criteria_group_id (List[OCI.searchCriteriaGroupId]): searchCriteriaGroupId + *Optional* + search_criteria_trunk_group_name (List[OCI.searchCriteriaTrunkGroupName]): + searchCriteriaTrunkGroupName *Optional* """ __slots__: List[str] = [ - "service_provider_id", - "prefix", + "response_size_limit", + "search_criteria_service_provider_id", + "search_criteria_exact_organization_type", + "search_criteria_group_id", + "search_criteria_trunk_group_name", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("service_provider_id", "serviceProviderId", str, is_required=True), + E("response_size_limit", "responseSizeLimit", int), E( - "prefix", - "prefix", - OCI.EnterpriseTrunkNumberPrefix22, + "search_criteria_service_provider_id", + "searchCriteriaServiceProviderId", + OCI.SearchCriteriaServiceProviderId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_exact_organization_type", + "searchCriteriaExactOrganizationType", + OCI.SearchCriteriaExactOrganizationType, + is_complex=True, + ), + E( + "search_criteria_group_id", + "searchCriteriaGroupId", + OCI.SearchCriteriaGroupId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_trunk_group_name", + "searchCriteriaTrunkGroupName", + OCI.SearchCriteriaTrunkGroupName, is_complex=True, - is_required=True, is_array=True, ), ) -class ServiceProviderRouteListEnterpriseTrunkNumberPrefixModifyListRequest(OCIRequest): +class SystemSIPDeviceTypeGetListRequest(OCIRequest): """ - Modify a list of number prefixes in a service provider. + Request to get the list of sip device types in the system. - The response is either `SuccessResponse()` or `ErrorResponse()`. + If includeSystemLevel is specified, all system level device types and the reseller + device types matching search criteria are returned even when searchCriteriaResellerId + is specified. If reseller administrator sends the request, searchCriteriaResellerId + is ignored. All system level device types and the device types in the administrator's + reseller meeting the search criteria are returned. See Also: + `SystemDeviceTypeGetAvailableListRequest22()` in AS data mode, + `SystemDeviceTypeGetAvailableListRequest19()` in XS data mode. + + The response is either `SystemSIPDeviceTypeGetListResponse()` or `ErrorResponse()`. + The following data elements are only used in AS data mode and ignored in XS data mode: + searchCriteriaExactDeviceTypeConfigurationOptionType Attributes: - service_provider_id (str): serviceProviderId - number_prefix (List[OCI.numberPrefix]): numberPrefix *Optional* + response_size_limit (int): responseSizeLimit *Optional* + search_criteria_device_type (List[OCI.searchCriteriaDeviceType]): + searchCriteriaDeviceType *Optional* + search_criteria_exact_signaling_address_type + (OCI.searchCriteriaExactSignalingAddressType): + searchCriteriaExactSignalingAddressType *Optional* + search_criteria_reseller_id (List[OCI.searchCriteriaResellerId]): + searchCriteriaResellerId *Optional* + search_criteria_device_configuration_options + (List[OCI.searchCriteriaDeviceConfigurationOptions]): + searchCriteriaDeviceConfigurationOptions *Optional* + include_system_level (bool): includeSystemLevel *Optional* """ __slots__: List[str] = [ - "service_provider_id", - "number_prefix", + "response_size_limit", + "search_criteria_device_type", + "search_criteria_exact_signaling_address_type", + "search_criteria_reseller_id", + "search_criteria_device_configuration_options", + "include_system_level", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("service_provider_id", "serviceProviderId", str, is_required=True), + E("response_size_limit", "responseSizeLimit", int), E( - "number_prefix", - "numberPrefix", - OCI.EnterpriseTrunkNumberPrefixModify, + "search_criteria_device_type", + "searchCriteriaDeviceType", + OCI.SearchCriteriaDeviceType, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_exact_signaling_address_type", + "searchCriteriaExactSignalingAddressType", + OCI.SearchCriteriaExactSignalingAddressType, + is_complex=True, + ), + E( + "search_criteria_reseller_id", + "searchCriteriaResellerId", + OCI.SearchCriteriaResellerId, is_complex=True, is_array=True, ), + E( + "search_criteria_device_configuration_options", + "searchCriteriaDeviceConfigurationOptions", + OCI.SearchCriteriaExactDeviceTypeConfigurationOptionType, + is_complex=True, + is_array=True, + ), + E("include_system_level", "includeSystemLevel", bool), ) -class ServiceProviderRouteListEnterpriseTrunkNumberRangeAddListRequest22(OCIRequest): +class SystemSecurityClassificationGetClassificationTrunkGroupUsageListRequest( + OCIRequest, +): """ - Add number ranges to a service provider. + Get a list of users that currently have the specified Security Classification + assigned. - The response is either `SuccessResponse()` or `ErrorResponse()`. + The response is either + `SystemSecurityClassificationGetClassificationTrunkGroupUsageListResponse()` or + `ErrorResponse()`. Attributes: - service_provider_id (str): serviceProviderId - number_range (List[OCI.numberRange]): numberRange + security_classification (str): securityClassification + response_size_limit (int): responseSizeLimit *Optional* + search_criteria_trunk_group_name (List[OCI.searchCriteriaTrunkGroupName]): + searchCriteriaTrunkGroupName *Optional* + search_criteria_group_id (List[OCI.searchCriteriaGroupId]): searchCriteriaGroupId + *Optional* + search_criteria_service_provider_id (List[OCI.searchCriteriaServiceProviderId]): + searchCriteriaServiceProviderId *Optional* + search_criteria_exact_organization_type (OCI.searchCriteriaExactOrganizationType): + searchCriteriaExactOrganizationType *Optional* """ __slots__: List[str] = [ - "service_provider_id", - "number_range", + "security_classification", + "response_size_limit", + "search_criteria_trunk_group_name", + "search_criteria_group_id", + "search_criteria_service_provider_id", + "search_criteria_exact_organization_type", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("service_provider_id", "serviceProviderId", str, is_required=True), E( - "number_range", - "numberRange", - OCI.EnterpriseTrunkNumberRange, - is_complex=True, + "security_classification", + "securityClassification", + str, is_required=True, + ), + E("response_size_limit", "responseSizeLimit", int), + E( + "search_criteria_trunk_group_name", + "searchCriteriaTrunkGroupName", + OCI.SearchCriteriaTrunkGroupName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_group_id", + "searchCriteriaGroupId", + OCI.SearchCriteriaGroupId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_service_provider_id", + "searchCriteriaServiceProviderId", + OCI.SearchCriteriaServiceProviderId, + is_complex=True, is_array=True, ), + E( + "search_criteria_exact_organization_type", + "searchCriteriaExactOrganizationType", + OCI.SearchCriteriaExactOrganizationType, + is_complex=True, + ), ) -class ServiceProviderServiceModifyAuthorizationListRequest(OCIRequest): +class SystemSecurityClassificationGetClassificationUserUsageListRequest(OCIRequest): """ - Requests to change the service provider's service authorization status. - - The boolean flags are used to authorize or unauthorize services. + Get a list of users that currently have the specified Security Classification + assigned. - The response is either `SuccessResponse()` or `ErrorResponse()`. + The response is either + `SystemSecurityClassificationGetClassificationUserUsageListResponse()` or + `ErrorResponse()`. Attributes: - service_provider_id (str): serviceProviderId - group_service_authorization (List[OCI.groupServiceAuthorization]): - groupServiceAuthorization *Optional* - user_service_authorization (List[OCI.userServiceAuthorization]): - userServiceAuthorization *Optional* + security_classification (str): securityClassification + response_size_limit (int): responseSizeLimit *Optional* + search_criteria_user_id (List[OCI.searchCriteriaUserId]): searchCriteriaUserId + *Optional* + search_criteria_user_last_name (List[OCI.searchCriteriaUserLastName]): + searchCriteriaUserLastName *Optional* + search_criteria_user_first_name (List[OCI.searchCriteriaUserFirstName]): + searchCriteriaUserFirstName *Optional* + search_criteria_dn (List[OCI.searchCriteriaDn]): searchCriteriaDn *Optional* + search_criteria_extension (List[OCI.searchCriteriaExtension]): + searchCriteriaExtension *Optional* """ __slots__: List[str] = [ - "service_provider_id", - "group_service_authorization", - "user_service_authorization", + "security_classification", + "response_size_limit", + "search_criteria_user_id", + "search_criteria_user_last_name", + "search_criteria_user_first_name", + "search_criteria_dn", + "search_criteria_extension", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("service_provider_id", "serviceProviderId", str, is_required=True), E( - "group_service_authorization", - "groupServiceAuthorization", - OCI.GroupServiceAuthorization, + "security_classification", + "securityClassification", + str, + is_required=True, + ), + E("response_size_limit", "responseSizeLimit", int), + E( + "search_criteria_user_id", + "searchCriteriaUserId", + OCI.SearchCriteriaUserId, is_complex=True, is_array=True, ), E( - "user_service_authorization", - "userServiceAuthorization", - OCI.UserServiceAuthorization, + "search_criteria_user_last_name", + "searchCriteriaUserLastName", + OCI.SearchCriteriaUserLastName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_first_name", + "searchCriteriaUserFirstName", + OCI.SearchCriteriaUserFirstName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_dn", + "searchCriteriaDn", + OCI.SearchCriteriaDn, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_extension", + "searchCriteriaExtension", + OCI.SearchCriteriaExtension, is_complex=True, is_array=True, ), ) -class SystemCommunicationBarringProfileModifyRequest(OCIRequest): +class SystemServiceCodeGetListRequest(OCIRequest): """ - Modify an existing Communication Barring Profile. + Request to get all service codes that have been defined in the system. - When the originatingDefaultAction is not Treatment, originatingDefaultTreatmentId will - be automatically cleared. Also when the action of originatingRule is not Treatment, - treatmentId will be automatically cleared for the rule. The priorities for - IncomingRules are requantized to consecutive integers as part of the modify. + It is possible to search by various criteria to restrict the number of rows returned. + Multiple search criteria are logically ANDed together. - The response is either a `SuccessResponse()` or an `ErrorResponse()`. The following - elements are only used in AS data mode: callMeNowDefaultAction - callMeNowDefaultCallTimeout callMeNowRule applyToAttendedCallTransfers + The response is either `SystemServiceCodeGetListResponse()` or `ErrorResponse()`. Attributes: - name (str): name - new_name (str): newName *Optional* - description (str): description *Optional* - originating_default_action (str): originatingDefaultAction *Optional* - originating_default_treatment_id (str): originatingDefaultTreatmentId *Optional* - originating_default_transfer_number (str): originatingDefaultTransferNumber - *Optional* - originating_default_call_timeout (int): originatingDefaultCallTimeout *Optional* - originating_rule (OCI.originatingRule): originatingRule *Optional* - redirecting_default_action (str): redirectingDefaultAction *Optional* - redirecting_default_call_timeout (int): redirectingDefaultCallTimeout *Optional* - redirecting_rule (OCI.redirectingRule): redirectingRule *Optional* - incoming_default_action (str): incomingDefaultAction *Optional* - incoming_default_call_timeout (int): incomingDefaultCallTimeout *Optional* - incoming_rule (OCI.incomingRule): incomingRule *Optional* - call_me_now_default_action (str): callMeNowDefaultAction *Optional* - call_me_now_default_call_timeout (int): callMeNowDefaultCallTimeout *Optional* - call_me_now_rule (OCI.callMeNowRule): callMeNowRule *Optional* - apply_to_attended_call_transfers (bool): applyToAttendedCallTransfers *Optional* + response_size_limit (int): responseSizeLimit *Optional* + search_criteria_service_code (List[OCI.searchCriteriaServiceCode]): + searchCriteriaServiceCode *Optional* + search_criteria_service_code_description + (List[OCI.searchCriteriaServiceCodeDescription]): + searchCriteriaServiceCodeDescription *Optional* """ __slots__: List[str] = [ - "name", - "new_name", - "description", - "originating_default_action", - "originating_default_treatment_id", - "originating_default_transfer_number", - "originating_default_call_timeout", - "originating_rule", - "redirecting_default_action", - "redirecting_default_call_timeout", - "redirecting_rule", - "incoming_default_action", - "incoming_default_call_timeout", - "incoming_rule", - "call_me_now_default_action", - "call_me_now_default_call_timeout", - "call_me_now_rule", - "apply_to_attended_call_transfers", + "response_size_limit", + "search_criteria_service_code", + "search_criteria_service_code_description", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("name", "name", str, is_required=True), - E("new_name", "newName", str), - E("description", "description", str), - E("originating_default_action", "originatingDefaultAction", str), - E("originating_default_treatment_id", "originatingDefaultTreatmentId", str), - E( - "originating_default_transfer_number", - "originatingDefaultTransferNumber", - str, - ), - E("originating_default_call_timeout", "originatingDefaultCallTimeout", int), + E("response_size_limit", "responseSizeLimit", int), E( - "originating_rule", - "originatingRule", - OCI.ReplacementCommunicationBarringOriginatingRuleList, + "search_criteria_service_code", + "searchCriteriaServiceCode", + OCI.SearchCriteriaServiceCode, is_complex=True, + is_array=True, ), - E("redirecting_default_action", "redirectingDefaultAction", str), - E("redirecting_default_call_timeout", "redirectingDefaultCallTimeout", int), E( - "redirecting_rule", - "redirectingRule", - OCI.ReplacementCommunicationBarringRedirectingRuleList, + "search_criteria_service_code_description", + "searchCriteriaServiceCodeDescription", + OCI.SearchCriteriaServiceCodeDescription, is_complex=True, + is_array=True, ), - E("incoming_default_action", "incomingDefaultAction", str), - E("incoming_default_call_timeout", "incomingDefaultCallTimeout", int), + ) + + +class SystemThirdPartyVoiceMailSupportGetDnListRequest(OCIRequest): + """ + Request to get a list of ThirdPartyVoiceMailSupport User DN's defined in the system. + + The response is either a `SystemThirdPartyVoiceMailSupportGetDnListResponse()` or an + `ErrorResponse()`. The search can be done using multiple criterion. + + Attributes: + response_size_limit (int): responseSizeLimit *Optional* + search_criteria_system_service_dn (List[OCI.searchCriteriaSystemServiceDn]): + searchCriteriaSystemServiceDn *Optional* + """ + + __slots__: List[str] = [ + "response_size_limit", + "search_criteria_system_service_dn", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("response_size_limit", "responseSizeLimit", int), E( - "incoming_rule", - "incomingRule", - OCI.ReplacementCommunicationBarringIncomingRuleList19sp1, + "search_criteria_system_service_dn", + "searchCriteriaSystemServiceDn", + OCI.SearchCriteriaSystemServiceDn, is_complex=True, + is_array=True, ), - E("call_me_now_default_action", "callMeNowDefaultAction", str), - E("call_me_now_default_call_timeout", "callMeNowDefaultCallTimeout", int), + ) + + +class SystemTwoStageDialingGetDnListRequest(OCIRequest): + """ + Request to get a list of Two Stage Dialing dns defined in the system. + + The response is either a `SystemTwoStageDialingGetDnListResponse()` or an + `ErrorResponse()`. + + Attributes: + response_size_limit (int): responseSizeLimit *Optional* + search_criteria_system_service_dn (List[OCI.searchCriteriaSystemServiceDn]): + searchCriteriaSystemServiceDn *Optional* + """ + + __slots__: List[str] = [ + "response_size_limit", + "search_criteria_system_service_dn", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("response_size_limit", "responseSizeLimit", int), E( - "call_me_now_rule", - "callMeNowRule", - OCI.ReplacementCommunicationBarringCallMeNowRuleList, + "search_criteria_system_service_dn", + "searchCriteriaSystemServiceDn", + OCI.SearchCriteriaSystemServiceDn, is_complex=True, + is_array=True, ), - E("apply_to_attended_call_transfers", "applyToAttendedCallTransfers", bool), ) @@ -138408,6 +133498,182 @@ def _elements(cls) -> Tuple[E, ...]: ) +class SystemXsiPolicyProfileGetAssignedServiceProviderListRequest(OCIRequest): + """ + Get usage of specific policy profile. + + The response is either a + `SystemXsiPolicyProfileGetAssignedServiceProviderListResponse()` or an + `ErrorResponse()`. + + Attributes: + xsi_policy_profile (OCI.xsiPolicyProfile): xsiPolicyProfile + response_size_limit (int): responseSizeLimit *Optional* + search_criteria_service_provider_id (List[OCI.searchCriteriaServiceProviderId]): + searchCriteriaServiceProviderId *Optional* + search_criteria_service_provider_name + (List[OCI.searchCriteriaServiceProviderName]): + searchCriteriaServiceProviderName *Optional* + search_criteria_exact_organization_type (OCI.searchCriteriaExactOrganizationType): + searchCriteriaExactOrganizationType *Optional* + search_criteria_reseller_id (List[OCI.searchCriteriaResellerId]): + searchCriteriaResellerId *Optional* + """ + + __slots__: List[str] = [ + "xsi_policy_profile", + "response_size_limit", + "search_criteria_service_provider_id", + "search_criteria_service_provider_name", + "search_criteria_exact_organization_type", + "search_criteria_reseller_id", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E( + "xsi_policy_profile", + "xsiPolicyProfile", + OCI.XsiPolicyProfileKey, + is_complex=True, + is_required=True, + ), + E("response_size_limit", "responseSizeLimit", int), + E( + "search_criteria_service_provider_id", + "searchCriteriaServiceProviderId", + OCI.SearchCriteriaServiceProviderId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_service_provider_name", + "searchCriteriaServiceProviderName", + OCI.SearchCriteriaServiceProviderName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_exact_organization_type", + "searchCriteriaExactOrganizationType", + OCI.SearchCriteriaExactOrganizationType, + is_complex=True, + ), + E( + "search_criteria_reseller_id", + "searchCriteriaResellerId", + OCI.SearchCriteriaResellerId, + is_complex=True, + is_array=True, + ), + ) + + +class SystemZoneCallingRestrictionsNetAddressGetListRequest(OCIRequest): + """ + Gets a list of IP Addresses and/or Ranges assigned to a zone Response is + `SystemZoneCallingRestrictionsNetAddressGetListResponse()`. + + Replaced by: `SystemZoneNetAddressGetListRequest()` + + Attributes: + zone_name (str): zoneName + response_size_limit (int): responseSizeLimit *Optional* + search_criteria_zone_ip_address (List[OCI.searchCriteriaZoneIPAddress]): + searchCriteriaZoneIPAddress *Optional* + """ + + __slots__: List[str] = [ + "zone_name", + "response_size_limit", + "search_criteria_zone_ip_address", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("zone_name", "zoneName", str, is_required=True), + E("response_size_limit", "responseSizeLimit", int), + E( + "search_criteria_zone_ip_address", + "searchCriteriaZoneIPAddress", + OCI.SearchCriteriaZoneIPAddress, + is_complex=True, + is_array=True, + ), + ) + + +class SystemZoneLocationBasedPhysicalLocationGetListRequest(OCIRequest): + """ + Gets a list of physical locations assigned to a zone. + + Response is `SystemZoneLocationBasedPhysicalLocationGetListResponse()` or an + `ErrorResponse()`. + + Attributes: + zone_name (str): zoneName + response_size_limit (int): responseSizeLimit *Optional* + search_criteria_physical_location (List[OCI.searchCriteriaPhysicalLocation]): + searchCriteriaPhysicalLocation *Optional* + """ + + __slots__: List[str] = [ + "zone_name", + "response_size_limit", + "search_criteria_physical_location", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("zone_name", "zoneName", str, is_required=True), + E("response_size_limit", "responseSizeLimit", int), + E( + "search_criteria_physical_location", + "searchCriteriaPhysicalLocation", + OCI.SearchCriteriaPhysicalLocation, + is_complex=True, + is_array=True, + ), + ) + + +class SystemZoneNetAddressGetListRequest(OCIRequest): + """ + Gets a list of IP Addresses and/or Ranges assigned to a zone. + + Response is `SystemZoneNetAddressGetListResponse()` or an `ErrorResponse()`. + + Attributes: + zone_name (str): zoneName + response_size_limit (int): responseSizeLimit *Optional* + search_criteria_zone_ip_address (List[OCI.searchCriteriaZoneIPAddress]): + searchCriteriaZoneIPAddress *Optional* + """ + + __slots__: List[str] = [ + "zone_name", + "response_size_limit", + "search_criteria_zone_ip_address", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("zone_name", "zoneName", str, is_required=True), + E("response_size_limit", "responseSizeLimit", int), + E( + "search_criteria_zone_ip_address", + "searchCriteriaZoneIPAddress", + OCI.SearchCriteriaZoneIPAddress, + is_complex=True, + is_array=True, + ), + ) + + class UserAddRequest14(OCIRequest): """ Request to add a user. @@ -138946,6 +134212,209 @@ def _elements(cls) -> Tuple[E, ...]: ) +class UserAnnouncementFileGetListRequest(OCIRequest): + """ + Get the list of announcement names with associated media type and filesize for a User + and given Announcement Repository Type The response is either a + `UserAnnouncementFileGetListResponse()` or an `ErrorResponse()`. + + + Attributes: + user_id (str): userId + announcement_file_type (str): announcementFileType *Optional* + include_announcement_table (bool): includeAnnouncementTable + response_size_limit (int): responseSizeLimit *Optional* + search_criteria_announcement_file_name + (List[OCI.searchCriteriaAnnouncementFileName]): + searchCriteriaAnnouncementFileName *Optional* + """ + + __slots__: List[str] = [ + "user_id", + "announcement_file_type", + "include_announcement_table", + "response_size_limit", + "search_criteria_announcement_file_name", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("user_id", "userId", str, is_required=True), + E("announcement_file_type", "announcementFileType", str), + E( + "include_announcement_table", + "includeAnnouncementTable", + bool, + is_required=True, + ), + E("response_size_limit", "responseSizeLimit", int), + E( + "search_criteria_announcement_file_name", + "searchCriteriaAnnouncementFileName", + OCI.SearchCriteriaAnnouncementFileName, + is_complex=True, + is_array=True, + ), + ) + + +class UserAnnouncementFileGetPagedSortedListRequest(OCIRequest): + """ + Get the list of announcement files for a user. + + If the responsePagingControl element is not provided, the paging startIndex will be + set to 1 by default, and the responsePageSize will be set to the maximum + responsePageSize by default. If no sortOrder is provided, the response is sorted by + Name ascending by default. Multiple search criteria are logically ANDed together + unless the searchCriteriaModeOr option is included. Then the search criteria are + logically ORed together. + + The response is either a `UserAnnouncementFileGetPagedSortedListResponse()` or an + `ErrorResponse()`. + + Attributes: + user_id (str): userId + response_paging_control (OCI.responsePagingControl): responsePagingControl + *Optional* + sort_by_announcement_file_name (OCI.sortByAnnouncementFileName): + sortByAnnouncementFileName *Optional* + sort_by_announcement_file_size (OCI.sortByAnnouncementFileSize): + sortByAnnouncementFileSize *Optional* + search_criteria_announcement_file_name + (List[OCI.searchCriteriaAnnouncementFileName]): + searchCriteriaAnnouncementFileName *Optional* + search_criteria_exact_announcement_file_type + (OCI.searchCriteriaExactAnnouncementFileType): + searchCriteriaExactAnnouncementFileType *Optional* + search_criteria_exact_media_file_type + (List[OCI.searchCriteriaExactMediaFileType]): searchCriteriaExactMediaFileType + *Optional* + search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* + """ + + __slots__: List[str] = [ + "user_id", + "response_paging_control", + "sort_by_announcement_file_name", + "sort_by_announcement_file_size", + "search_criteria_announcement_file_name", + "search_criteria_exact_announcement_file_type", + "search_criteria_exact_media_file_type", + "search_criteria_mode_or", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("user_id", "userId", str, is_required=True), + E( + "response_paging_control", + "responsePagingControl", + OCI.ResponsePagingControl, + is_complex=True, + ), + E( + "sort_by_announcement_file_name", + "sortByAnnouncementFileName", + OCI.SortByAnnouncementFileName, + is_complex=True, + ), + E( + "sort_by_announcement_file_size", + "sortByAnnouncementFileSize", + OCI.SortByAnnouncementFileSize, + is_complex=True, + ), + E( + "search_criteria_announcement_file_name", + "searchCriteriaAnnouncementFileName", + OCI.SearchCriteriaAnnouncementFileName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_exact_announcement_file_type", + "searchCriteriaExactAnnouncementFileType", + OCI.SearchCriteriaExactAnnouncementFileType, + is_complex=True, + ), + E( + "search_criteria_exact_media_file_type", + "searchCriteriaExactMediaFileType", + OCI.SearchCriteriaExactMediaFileType, + is_complex=True, + is_array=True, + ), + E("search_criteria_mode_or", "searchCriteriaModeOr", bool), + ) + + +class UserBroadWorksAnywhereGetPhoneNumberPagedSortedListRequest(OCIRequest): + """ + Get the list of all the BroadWorks Anywhere phone numbers for the user. + + If no sortOrder is included the response is sorted by Phone Number ascending by + default. + + The response is either a + `UserBroadWorksAnywhereGetPhoneNumberPagedSortedListResponse()` or an + `ErrorResponse()`. + + Attributes: + user_id (str): userId + response_paging_control (OCI.responsePagingControl): responsePagingControl + *Optional* + sort_by_location (OCI.sortByLocation): sortByLocation *Optional* + sort_by_enabled (OCI.sortByEnabled): sortByEnabled *Optional* + search_criteria_location (List[OCI.searchCriteriaLocation]): + searchCriteriaLocation *Optional* + search_criteria_exact_location_enabled (OCI.searchCriteriaExactLocationEnabled): + searchCriteriaExactLocationEnabled *Optional* + """ + + __slots__: List[str] = [ + "user_id", + "response_paging_control", + "sort_by_location", + "sort_by_enabled", + "search_criteria_location", + "search_criteria_exact_location_enabled", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("user_id", "userId", str, is_required=True), + E( + "response_paging_control", + "responsePagingControl", + OCI.ResponsePagingControl, + is_complex=True, + ), + E( + "sort_by_location", + "sortByLocation", + OCI.SortByLocation, + is_complex=True, + ), + E("sort_by_enabled", "sortByEnabled", OCI.SortByEnabled, is_complex=True), + E( + "search_criteria_location", + "searchCriteriaLocation", + OCI.SearchCriteriaLocation, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_exact_location_enabled", + "searchCriteriaExactLocationEnabled", + OCI.SearchCriteriaExactLocationEnabled, + is_complex=True, + ), + ) + + class UserBroadWorksAnywhereModifySelectiveCriteriaRequest(OCIRequest): """ Modify selective criteria for the user's BroadWorks Anywhere phone number. @@ -141038,6 +136507,64 @@ def _elements(cls) -> Tuple[E, ...]: ) +class UserCallCenterGetAvailableCallCenterPagedSortedListRequest(OCIRequest): + """ + This request gets a list of all call centers which the user can be assigned to as an + agent. + + Some of the call centers may already have the user as an agent. It is the clients + responsibility to discard the call centers that the user is already an agent of. If + the responsePagingControl element is not provided, the paging startIndex will be set + to 1 by default, and the responsePageSize will be set to the maximum ResponsePageSize + by default. It is possible to search by various criteria to restrict the number of + rows returned. Multiple search criteria are logically ANDed together unless the + searchCriteriaModeOr option is included. Then the search criteria are logically ORed + together. + + The response is either a + `UserCallCenterGetAvailableCallCenterPagedSortedListResponse()` or an + `ErrorResponse()`. + + Attributes: + user_id (str): userId + response_paging_control (OCI.responsePagingControl): responsePagingControl + *Optional* + sort_by_user_id (OCI.sortByUserId): sortByUserId *Optional* + search_criteria_user_id (List[OCI.searchCriteriaUserId]): searchCriteriaUserId + *Optional* + search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* + """ + + __slots__: List[str] = [ + "user_id", + "response_paging_control", + "sort_by_user_id", + "search_criteria_user_id", + "search_criteria_mode_or", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("user_id", "userId", str, is_required=True), + E( + "response_paging_control", + "responsePagingControl", + OCI.ResponsePagingControl, + is_complex=True, + ), + E("sort_by_user_id", "sortByUserId", OCI.SortByUserId, is_complex=True), + E( + "search_criteria_user_id", + "searchCriteriaUserId", + OCI.SearchCriteriaUserId, + is_complex=True, + is_array=True, + ), + E("search_criteria_mode_or", "searchCriteriaModeOr", bool), + ) + + class UserCallCenterGetSupervisedAgentListRequest(OCIRequest): """ Get a list of agents supervised by a supervisor on a given call center. @@ -141917,639 +137444,96 @@ def _elements(cls) -> Tuple[E, ...]: ) -class UserEnhancedCallLogsGetListRequest17sp4(OCIRequest): - """ - Request user's call logs. - - If the callLogType is not specified, all types of calls logs (placed, received, - missed) are returned. The filters "dateTimeRange", "numberFilter", - "redirectedNumberFilter", accountAuthorizationCodeFilter" and ""subscriberType" are - ignored if call logs are stored in CDS. When "ReceivedOrMissed" is specified as - "callLogType" and call logs are stored in CDS, all call logs including placed will be - returned. It is possible to restrict the number of rows returned using - responsePagingControl. If responsePagingControl is not specified, the value of - Enhanced Call Logs system parameter maxNonPagedResponseSize will control the maximum - number of call logs can be returned. - - The response is either a `UserEnhancedCallLogsGetListResponse17sp4()` or an - `ErrorResponse()`. Replaced by UserEnhancedCallLogsGetListRequest17sp4V2. Originally - deprecated in release 20. - - Attributes: - user_id (str): userId - call_log_type (str): callLogType *Optional* - date_time_range (OCI.dateTimeRange): dateTimeRange - number_filter (OCI.numberFilter): numberFilter *Optional* - redirected_number_filter (OCI.redirectedNumberFilter): redirectedNumberFilter - *Optional* - account_authorization_code_filter (OCI.accountAuthorizationCodeFilter): - accountAuthorizationCodeFilter *Optional* - subscriber_type (str): subscriberType *Optional* - response_paging_control (OCI.responsePagingControl): responsePagingControl - *Optional* - """ - - __slots__: List[str] = [ - "user_id", - "call_log_type", - "date_time_range", - "number_filter", - "redirected_number_filter", - "account_authorization_code_filter", - "subscriber_type", - "response_paging_control", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("user_id", "userId", str, is_required=True), - E("call_log_type", "callLogType", str), - E( - "date_time_range", - "dateTimeRange", - OCI.EnhancedCallLogsTimeRange, - is_complex=True, - is_required=True, - ), - E( - "number_filter", - "numberFilter", - OCI.EnhancedCallLogsNumberFilter, - is_complex=True, - ), - E( - "redirected_number_filter", - "redirectedNumberFilter", - OCI.EnhancedCallLogsRedirectedNumberFilter, - is_complex=True, - ), - E( - "account_authorization_code_filter", - "accountAuthorizationCodeFilter", - OCI.EnhancedCallLogsAccountAuthorizationCodeFilter, - is_complex=True, - ), - E("subscriber_type", "subscriberType", str), - E( - "response_paging_control", - "responsePagingControl", - OCI.ResponsePagingControl, - is_complex=True, - ), - ) - - -class UserEnhancedCallLogsGetListRequest20(OCIRequest): - """ - Request user's call logs. - - If the callLogType is not specified, all types of calls logs (placed, received, - missed) are returned. The filters "dateTimeRange", "numberFilter", - "redirectedNumberFilter", "accountAuthorizationCodeFilter" - "callAuthorizationCodeFilter" and "subscriberType" are ignored if call logs are stored - in CDS. When "ReceivedOrMissed" is specified as "callLogType" and call logs are stored - in CDS, all call logs including placed will be returned. It is possible to restrict - the number of rows returned using responsePagingControl. If responsePagingControl is - not specified, the value of Enhanced Call Logs system parameter - maxNonPagedResponseSize will control the maximum number of call logs can be returned. - - The response is either a `UserEnhancedCallLogsGetListResponse20()` or an - `ErrorResponse()`. The following elements are only used in AS data mode and not - returned in XS data mode: callAuthorizationCodeFilter - - Attributes: - user_id (str): userId - call_log_type (str): callLogType *Optional* - date_time_range (OCI.dateTimeRange): dateTimeRange - number_filter (OCI.numberFilter): numberFilter *Optional* - redirected_number_filter (OCI.redirectedNumberFilter): redirectedNumberFilter - *Optional* - account_authorization_code_filter (OCI.accountAuthorizationCodeFilter): - accountAuthorizationCodeFilter *Optional* - call_authorization_code_filter (OCI.callAuthorizationCodeFilter): - callAuthorizationCodeFilter *Optional* - subscriber_type (str): subscriberType *Optional* - response_paging_control (OCI.responsePagingControl): responsePagingControl - *Optional* - """ - - __slots__: List[str] = [ - "user_id", - "call_log_type", - "date_time_range", - "number_filter", - "redirected_number_filter", - "account_authorization_code_filter", - "call_authorization_code_filter", - "subscriber_type", - "response_paging_control", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("user_id", "userId", str, is_required=True), - E("call_log_type", "callLogType", str), - E( - "date_time_range", - "dateTimeRange", - OCI.EnhancedCallLogsTimeRange, - is_complex=True, - is_required=True, - ), - E( - "number_filter", - "numberFilter", - OCI.EnhancedCallLogsNumberFilter, - is_complex=True, - ), - E( - "redirected_number_filter", - "redirectedNumberFilter", - OCI.EnhancedCallLogsRedirectedNumberFilter, - is_complex=True, - ), - E( - "account_authorization_code_filter", - "accountAuthorizationCodeFilter", - OCI.EnhancedCallLogsAccountAuthorizationCodeFilter, - is_complex=True, - ), - E( - "call_authorization_code_filter", - "callAuthorizationCodeFilter", - OCI.EnhancedCallLogsCallAuthorizationCodeFilter, - is_complex=True, - ), - E("subscriber_type", "subscriberType", str), - E( - "response_paging_control", - "responsePagingControl", - OCI.ResponsePagingControl, - is_complex=True, - ), - ) - - -class UserEnhancedCallLogsGetListRequest20sp1(OCIRequest): - """ - Request user's call logs. - - If the callLogType is not specified, all types of calls logs (placed, received, - missed) are returned. The filters "dateTimeRange", "numberFilter", - "redirectedNumberFilter", "accountAuthorizationCodeFilter" - "callAuthorizationCodeFilter" and "subscriberType" are ignored if call logs are stored - in CDS. When "ReceivedOrMissed" is specified as "callLogType" and call logs are stored - in CDS, all call logs including placed will be returned. It is possible to restrict - the number of rows returned using responsePagingControl. If responsePagingControl is - not specified, the value of Enhanced Call Logs system parameter - maxNonPagedResponseSize will control the maximum number of call logs can be returned. - - The response is either a `UserEnhancedCallLogsGetListResponse20sp1()` or an - `ErrorResponse()`. The following elements are only used in AS data mode: - callAuthorizationCodeFilter callSecurityClassification - - Attributes: - user_id (str): userId - call_log_type (str): callLogType *Optional* - date_time_range (OCI.dateTimeRange): dateTimeRange - number_filter (OCI.numberFilter): numberFilter *Optional* - redirected_number_filter (OCI.redirectedNumberFilter): redirectedNumberFilter - *Optional* - account_authorization_code_filter (OCI.accountAuthorizationCodeFilter): - accountAuthorizationCodeFilter *Optional* - call_authorization_code_filter (OCI.callAuthorizationCodeFilter): - callAuthorizationCodeFilter *Optional* - subscriber_type (str): subscriberType *Optional* - response_paging_control (OCI.responsePagingControl): responsePagingControl - *Optional* - """ - - __slots__: List[str] = [ - "user_id", - "call_log_type", - "date_time_range", - "number_filter", - "redirected_number_filter", - "account_authorization_code_filter", - "call_authorization_code_filter", - "subscriber_type", - "response_paging_control", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("user_id", "userId", str, is_required=True), - E("call_log_type", "callLogType", str), - E( - "date_time_range", - "dateTimeRange", - OCI.EnhancedCallLogsTimeRange, - is_complex=True, - is_required=True, - ), - E( - "number_filter", - "numberFilter", - OCI.EnhancedCallLogsNumberFilter, - is_complex=True, - ), - E( - "redirected_number_filter", - "redirectedNumberFilter", - OCI.EnhancedCallLogsRedirectedNumberFilter20sp1, - is_complex=True, - ), - E( - "account_authorization_code_filter", - "accountAuthorizationCodeFilter", - OCI.EnhancedCallLogsAccountAuthorizationCodeFilter, - is_complex=True, - ), - E( - "call_authorization_code_filter", - "callAuthorizationCodeFilter", - OCI.EnhancedCallLogsCallAuthorizationCodeFilter, - is_complex=True, - ), - E("subscriber_type", "subscriberType", str), - E( - "response_paging_control", - "responsePagingControl", - OCI.ResponsePagingControl, - is_complex=True, - ), - ) - - -class UserEnhancedCallLogsGetListRequest21(OCIRequest): - """ - Request user's call logs. - - If the callLogType is not specified, all types of calls logs (placed, received, - missed) are returned. The filters "dateTimeRange", "numberFilter", - "redirectedNumberFilter", "accountAuthorizationCodeFilter" - "callAuthorizationCodeFilter" and "subscriberType" are ignored if call logs are stored - in CDS. When "ReceivedOrMissed" is specified as "callLogType" and call logs are stored - in CDS, all call logs including placed will be returned. It is possible to restrict - the number of rows returned using responsePagingControl. If responsePagingControl is - not specified, the value of Enhanced Call Logs system parameter - maxNonPagedResponseSize will control the maximum number of call logs can be returned. - - The response is either a `UserEnhancedCallLogsGetListResponse21()` or an - `ErrorResponse()`. The following elements are only used in AS data mode and not - returned in XS data mode: callAuthorizationCodeFilter Replaced by: - UserEnhancedCallLogsGetListRequest21Sp1 in AS data mode - - Attributes: - user_id (str): userId - call_log_type (str): callLogType *Optional* - date_time_range (OCI.dateTimeRange): dateTimeRange - number_filter (OCI.numberFilter): numberFilter *Optional* - redirected_number_filter (OCI.redirectedNumberFilter): redirectedNumberFilter - *Optional* - account_authorization_code_filter (OCI.accountAuthorizationCodeFilter): - accountAuthorizationCodeFilter *Optional* - call_authorization_code_filter (OCI.callAuthorizationCodeFilter): - callAuthorizationCodeFilter *Optional* - subscriber_type (str): subscriberType *Optional* - response_paging_control (OCI.responsePagingControl): responsePagingControl - *Optional* - """ - - __slots__: List[str] = [ - "user_id", - "call_log_type", - "date_time_range", - "number_filter", - "redirected_number_filter", - "account_authorization_code_filter", - "call_authorization_code_filter", - "subscriber_type", - "response_paging_control", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("user_id", "userId", str, is_required=True), - E("call_log_type", "callLogType", str), - E( - "date_time_range", - "dateTimeRange", - OCI.EnhancedCallLogsTimeRange, - is_complex=True, - is_required=True, - ), - E( - "number_filter", - "numberFilter", - OCI.EnhancedCallLogsNumberFilter, - is_complex=True, - ), - E( - "redirected_number_filter", - "redirectedNumberFilter", - OCI.EnhancedCallLogsRedirectedNumberFilter21, - is_complex=True, - ), - E( - "account_authorization_code_filter", - "accountAuthorizationCodeFilter", - OCI.EnhancedCallLogsAccountAuthorizationCodeFilter, - is_complex=True, - ), - E( - "call_authorization_code_filter", - "callAuthorizationCodeFilter", - OCI.EnhancedCallLogsCallAuthorizationCodeFilter, - is_complex=True, - ), - E("subscriber_type", "subscriberType", str), - E( - "response_paging_control", - "responsePagingControl", - OCI.ResponsePagingControl, - is_complex=True, - ), - ) - - -class UserEnhancedCallLogsGetListRequest21sp1(OCIRequest): - """ - Request user's call logs. - - If the callLogType is not specified, all types of calls logs (placed, received, - missed) are returned. The filters "dateTimeRange", "numberFilter", - "redirectedNumberFilter", "accountAuthorizationCodeFilter" - "callAuthorizationCodeFilter" and "subscriberType" are ignored if call logs are stored - in CDS. When "ReceivedOrMissed" is specified as "callLogType" and call logs are stored - in CDS, all call logs including placed will be returned. It is possible to restrict - the number of rows returned using responsePagingControl. If responsePagingControl is - not specified, the value of Enhanced Call Logs system parameter - maxNonPagedResponseSize will control the maximum number of call logs can be returned. - - The response is either a `UserEnhancedCallLogsGetListResponse21sp1()` or an - `ErrorResponse()`. The following elements are only used in AS data mode and ignored in - XS data mode: callAuthorizationCodeFilter Replaced by: - UserEnhancedCallLogsGetListRequest21Sp1V2 in AS data mode - - Attributes: - user_id (str): userId - call_log_type (str): callLogType *Optional* - date_time_range (OCI.dateTimeRange): dateTimeRange - number_filter (OCI.numberFilter): numberFilter *Optional* - redirected_number_filter (OCI.redirectedNumberFilter): redirectedNumberFilter - *Optional* - account_authorization_code_filter (OCI.accountAuthorizationCodeFilter): - accountAuthorizationCodeFilter *Optional* - call_authorization_code_filter (OCI.callAuthorizationCodeFilter): - callAuthorizationCodeFilter *Optional* - subscriber_type (str): subscriberType *Optional* - response_paging_control (OCI.responsePagingControl): responsePagingControl - *Optional* - """ - - __slots__: List[str] = [ - "user_id", - "call_log_type", - "date_time_range", - "number_filter", - "redirected_number_filter", - "account_authorization_code_filter", - "call_authorization_code_filter", - "subscriber_type", - "response_paging_control", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("user_id", "userId", str, is_required=True), - E("call_log_type", "callLogType", str), - E( - "date_time_range", - "dateTimeRange", - OCI.EnhancedCallLogsTimeRange, - is_complex=True, - is_required=True, - ), - E( - "number_filter", - "numberFilter", - OCI.EnhancedCallLogsNumberFilter, - is_complex=True, - ), - E( - "redirected_number_filter", - "redirectedNumberFilter", - OCI.EnhancedCallLogsRedirectedNumberFilter21sp1, - is_complex=True, - ), - E( - "account_authorization_code_filter", - "accountAuthorizationCodeFilter", - OCI.EnhancedCallLogsAccountAuthorizationCodeFilter, - is_complex=True, - ), - E( - "call_authorization_code_filter", - "callAuthorizationCodeFilter", - OCI.EnhancedCallLogsCallAuthorizationCodeFilter, - is_complex=True, - ), - E("subscriber_type", "subscriberType", str), - E( - "response_paging_control", - "responsePagingControl", - OCI.ResponsePagingControl, - is_complex=True, - ), - ) - - -class UserEnhancedCallLogsGetListRequest22(OCIRequest): +class UserEnterpriseCommonPhoneListGetPagedSortedListRequest(OCIRequest): """ - Request user's call logs. - - If the callLogType is not specified, all types of calls logs (placed, received, - missed) are returned. The filters "dateTimeRange", "numberFilter", - "redirectedNumberFilter", "accountAuthorizationCodeFilter" - "callAuthorizationCodeFilter" and "subscriberType" are ignored if call logs are stored - in CDS. When "ReceivedOrMissed" is specified as "callLogType" and call logs are stored - in CDS, all call logs including placed will be returned. It is possible to restrict - the number of rows returned using responsePagingControl. If responsePagingControl is - not specified, the value of Enhanced Call Logs system parameter - maxNonPagedResponseSize will control the maximum number of call logs can be returned. + Get an enterprise's common phone list for a user. - The response is either a `UserEnhancedCallLogsGetListResponse22()` or an - `ErrorResponse()`. The following elements are only used in AS data mode and ignored in - XS data mode: callAuthorizationCodeFilter + The response is either a `UserEnterpriseCommonPhoneListGetPagedSortedListResponse()` + or an `ErrorResponse()`. The search can be done using multiple criterion. If the + searchCriteriaModeOr is present, any result matching any one criteria is included in + the results. Otherwise, only results matching all the search criterion are included + in the results. If no search criteria is specified, all results are returned. + Specifying searchCriteriaModeOr without any search criteria results in an + `ErrorResponse()`. The sort can be done on the name or the number in the common phone + list. The following elements are only used in AS data mode and ignored in XS data + mode: searchCriteriaEnterpriseCommonMultiPartPhoneListName Attributes: user_id (str): userId - call_log_type (str): callLogType *Optional* - date_time_range (OCI.dateTimeRange): dateTimeRange - number_filter (OCI.numberFilter): numberFilter *Optional* - redirected_number_filter (OCI.redirectedNumberFilter): redirectedNumberFilter - *Optional* - account_authorization_code_filter (OCI.accountAuthorizationCodeFilter): - accountAuthorizationCodeFilter *Optional* - call_authorization_code_filter (OCI.callAuthorizationCodeFilter): - callAuthorizationCodeFilter *Optional* - subscriber_type (str): subscriberType *Optional* response_paging_control (OCI.responsePagingControl): responsePagingControl + sort_by_enterprise_common_phone_list_number + (OCI.sortByEnterpriseCommonPhoneListNumber): + sortByEnterpriseCommonPhoneListNumber *Optional* + sort_by_enterprise_common_phone_list_name + (OCI.sortByEnterpriseCommonPhoneListName): sortByEnterpriseCommonPhoneListName *Optional* + search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* + search_criteria_enterprise_common_phone_list_name + (List[OCI.searchCriteriaEnterpriseCommonPhoneListName]): + searchCriteriaEnterpriseCommonPhoneListName *Optional* + search_criteria_enterprise_common_phone_list_number + (List[OCI.searchCriteriaEnterpriseCommonPhoneListNumber]): + searchCriteriaEnterpriseCommonPhoneListNumber *Optional* + search_criteria_enterprise_common_multi_part_phone_list_name + (List[OCI.searchCriteriaEnterpriseCommonMultiPartPhoneListName]): + searchCriteriaEnterpriseCommonMultiPartPhoneListName *Optional* """ __slots__: List[str] = [ "user_id", - "call_log_type", - "date_time_range", - "number_filter", - "redirected_number_filter", - "account_authorization_code_filter", - "call_authorization_code_filter", - "subscriber_type", "response_paging_control", + "sort_by_enterprise_common_phone_list_number", + "sort_by_enterprise_common_phone_list_name", + "search_criteria_mode_or", + "search_criteria_enterprise_common_phone_list_name", + "search_criteria_enterprise_common_phone_list_number", + "search_criteria_enterprise_common_multi_part_phone_list_name", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( E("user_id", "userId", str, is_required=True), - E("call_log_type", "callLogType", str), - E( - "date_time_range", - "dateTimeRange", - OCI.EnhancedCallLogsTimeRange, - is_complex=True, - is_required=True, - ), - E( - "number_filter", - "numberFilter", - OCI.EnhancedCallLogsNumberFilter, - is_complex=True, - ), - E( - "redirected_number_filter", - "redirectedNumberFilter", - OCI.EnhancedCallLogsRedirectedNumberFilter21sp1, - is_complex=True, - ), - E( - "account_authorization_code_filter", - "accountAuthorizationCodeFilter", - OCI.EnhancedCallLogsAccountAuthorizationCodeFilter, - is_complex=True, - ), - E( - "call_authorization_code_filter", - "callAuthorizationCodeFilter", - OCI.EnhancedCallLogsCallAuthorizationCodeFilter, - is_complex=True, - ), - E("subscriber_type", "subscriberType", str), E( "response_paging_control", "responsePagingControl", OCI.ResponsePagingControl, is_complex=True, - ), - ) - - -class UserEnhancedCallLogsGetListRequest23(OCIRequest): - """ - Request user's call logs. - - If the callLogType is not specified, all types of calls logs (placed, received, - missed) are returned. The filters "dateTimeRange", "numberFilter", - "redirectedNumberFilter", "accountAuthorizationCodeFilter" - "callAuthorizationCodeFilter" and "subscriberType" are ignored if call logs are stored - in CDS. When "ReceivedOrMissed" is specified as "callLogType" and call logs are stored - in CDS, all call logs including placed will be returned. It is possible to restrict - the number of rows returned using responsePagingControl. If responsePagingControl is - not specified, the value of Enhanced Call Logs system parameter - maxNonPagedResponseSize will control the maximum number of call logs can be returned. - - The response is either a `UserEnhancedCallLogsGetListResponse23()` or an - `ErrorResponse()`. The following elements are only used in AS data mode and ignored in - XS data mode: callAuthorizationCodeFilter - - Attributes: - user_id (str): userId - call_log_type (str): callLogType *Optional* - date_time_range (OCI.dateTimeRange): dateTimeRange - number_filter (OCI.numberFilter): numberFilter *Optional* - redirected_number_filter (OCI.redirectedNumberFilter): redirectedNumberFilter - *Optional* - account_authorization_code_filter (OCI.accountAuthorizationCodeFilter): - accountAuthorizationCodeFilter *Optional* - call_authorization_code_filter (OCI.callAuthorizationCodeFilter): - callAuthorizationCodeFilter *Optional* - subscriber_type (str): subscriberType *Optional* - response_paging_control (OCI.responsePagingControl): responsePagingControl - *Optional* - """ - - __slots__: List[str] = [ - "user_id", - "call_log_type", - "date_time_range", - "number_filter", - "redirected_number_filter", - "account_authorization_code_filter", - "call_authorization_code_filter", - "subscriber_type", - "response_paging_control", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("user_id", "userId", str, is_required=True), - E("call_log_type", "callLogType", str), - E( - "date_time_range", - "dateTimeRange", - OCI.EnhancedCallLogsTimeRange, - is_complex=True, is_required=True, ), E( - "number_filter", - "numberFilter", - OCI.EnhancedCallLogsNumberFilter, + "sort_by_enterprise_common_phone_list_number", + "sortByEnterpriseCommonPhoneListNumber", + OCI.SortByEnterpriseCommonPhoneListNumber, is_complex=True, ), E( - "redirected_number_filter", - "redirectedNumberFilter", - OCI.EnhancedCallLogsRedirectedNumberFilter23, + "sort_by_enterprise_common_phone_list_name", + "sortByEnterpriseCommonPhoneListName", + OCI.SortByEnterpriseCommonPhoneListName, is_complex=True, ), + E("search_criteria_mode_or", "searchCriteriaModeOr", bool), E( - "account_authorization_code_filter", - "accountAuthorizationCodeFilter", - OCI.EnhancedCallLogsAccountAuthorizationCodeFilter, + "search_criteria_enterprise_common_phone_list_name", + "searchCriteriaEnterpriseCommonPhoneListName", + OCI.SearchCriteriaEnterpriseCommonPhoneListName, is_complex=True, + is_array=True, ), E( - "call_authorization_code_filter", - "callAuthorizationCodeFilter", - OCI.EnhancedCallLogsCallAuthorizationCodeFilter, + "search_criteria_enterprise_common_phone_list_number", + "searchCriteriaEnterpriseCommonPhoneListNumber", + OCI.SearchCriteriaEnterpriseCommonPhoneListNumber, is_complex=True, + is_array=True, ), - E("subscriber_type", "subscriberType", str), E( - "response_paging_control", - "responsePagingControl", - OCI.ResponsePagingControl, + "search_criteria_enterprise_common_multi_part_phone_list_name", + "searchCriteriaEnterpriseCommonMultiPartPhoneListName", + OCI.SearchCriteriaEnterpriseCommonMultiPartPhoneListName, is_complex=True, + is_array=True, ), ) @@ -142849,30 +137833,19 @@ def _elements(cls) -> Tuple[E, ...]: ) -class UserGetListInGroupPagedSortedListRequest(OCIRequest): +class UserGetListInGroupRequest(OCIRequest): """ Request the list of users in a group. - The response is either a `UserGetListInGroupPagedSortedListResponse()` or an - `ErrorResponse()`. If the responsePagingControl element is not provided, the paging - startIndex will be set to 1 by default, and the responsePageSize will be set to the - maximum ResponsePageSize by default. It is possible to search by various criteria to - restrict the number of rows returned. If no sortOrder is included the response is - sorted by User Id ascending by default. A limitation to the search by DN activation - exists when the Number Activation mode is set to Off. In this case DNs not assigned - to users are never returned by queries with the "dnActivationSearchCriteria" included. - Multiple search criteria are logically ANDed together unless the searchCriteriaModeOr - option is included. Then the search criteria are logically ORed together. The - following elements are used in AS data mode and ignored in XS data mode: - groupExternalId + It is possible to search by various criteria to restrict the number of rows returned. + Multiple search criteria are logically ANDed together. + + The response is either a `UserGetListInGroupResponse()` or an `ErrorResponse()`. Attributes: - service_provider_id (str): serviceProviderId *Optional* - group_id (str): groupId *Optional* - group_external_id (str): groupExternalId *Optional* - response_paging_control (OCI.responsePagingControl): responsePagingControl - *Optional* - sort_order (List[OCI.sortOrder]): sortOrder *Optional* + service_provider_id (str): serviceProviderId + group_id (str): GroupId + response_size_limit (int): responseSizeLimit *Optional* search_criteria_user_last_name (List[OCI.searchCriteriaUserLastName]): searchCriteriaUserLastName *Optional* search_criteria_user_first_name (List[OCI.searchCriteriaUserFirstName]): @@ -142880,8 +137853,8 @@ class UserGetListInGroupPagedSortedListRequest(OCIRequest): search_criteria_dn (List[OCI.searchCriteriaDn]): searchCriteriaDn *Optional* search_criteria_email_address (List[OCI.searchCriteriaEmailAddress]): searchCriteriaEmailAddress *Optional* - search_criteria_department_name (List[OCI.searchCriteriaDepartmentName]): - searchCriteriaDepartmentName *Optional* + search_criteria_exact_user_department (OCI.searchCriteriaExactUserDepartment): + searchCriteriaExactUserDepartment *Optional* search_criteria_exact_user_in_trunk_group (OCI.searchCriteriaExactUserInTrunkGroup): searchCriteriaExactUserInTrunkGroup *Optional* @@ -142889,48 +137862,28 @@ class UserGetListInGroupPagedSortedListRequest(OCIRequest): *Optional* search_criteria_extension (List[OCI.searchCriteriaExtension]): searchCriteriaExtension *Optional* - search_criteria_exact_dn_activation (OCI.searchCriteriaExactDnActivation): - searchCriteriaExactDnActivation *Optional* - search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* """ __slots__: List[str] = [ "service_provider_id", "group_id", - "group_external_id", - "response_paging_control", - "sort_order", + "response_size_limit", "search_criteria_user_last_name", "search_criteria_user_first_name", "search_criteria_dn", "search_criteria_email_address", - "search_criteria_department_name", + "search_criteria_exact_user_department", "search_criteria_exact_user_in_trunk_group", "search_criteria_user_id", "search_criteria_extension", - "search_criteria_exact_dn_activation", - "search_criteria_mode_or", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("service_provider_id", "serviceProviderId", str), - E("group_id", "groupId", str), - E("group_external_id", "groupExternalId", str), - E( - "response_paging_control", - "responsePagingControl", - OCI.ResponsePagingControl, - is_complex=True, - ), - E( - "sort_order", - "sortOrder", - OCI.SortOrderUserGetListInGroupPagedSortedList, - is_complex=True, - is_array=True, - ), + E("service_provider_id", "serviceProviderId", str, is_required=True), + E("group_id", "GroupId", str, is_required=True), + E("response_size_limit", "responseSizeLimit", int), E( "search_criteria_user_last_name", "searchCriteriaUserLastName", @@ -142960,11 +137913,10 @@ def _elements(cls) -> Tuple[E, ...]: is_array=True, ), E( - "search_criteria_department_name", - "searchCriteriaDepartmentName", - OCI.SearchCriteriaDepartmentName, + "search_criteria_exact_user_department", + "searchCriteriaExactUserDepartment", + OCI.SearchCriteriaExactUserDepartment, is_complex=True, - is_array=True, ), E( "search_criteria_exact_user_in_trunk_group", @@ -142986,28 +137938,23 @@ def _elements(cls) -> Tuple[E, ...]: is_complex=True, is_array=True, ), - E( - "search_criteria_exact_dn_activation", - "searchCriteriaExactDnActivation", - OCI.SearchCriteriaExactDnActivation, - is_complex=True, - ), - E("search_criteria_mode_or", "searchCriteriaModeOr", bool), ) -class UserGetListInGroupRequest(OCIRequest): +class UserGetListInServiceProviderRequest(OCIRequest): """ - Request the list of users in a group. + Request the list of users in a service provider or enterprise. It is possible to search by various criteria to restrict the number of rows returned. - Multiple search criteria are logically ANDed together. + Multiple search criteria are logically ANDed together. The following elements are + only used in AS data mode and ignored in XS data mode: serviceProviderExternalId - The response is either a `UserGetListInGroupResponse()` or an `ErrorResponse()`. + The response is either a `UserGetListInServiceProviderResponse()` or an + `ErrorResponse()`. Attributes: - service_provider_id (str): serviceProviderId - group_id (str): GroupId + service_provider_id (str): serviceProviderId *Optional* + service_provider_external_id (str): serviceProviderExternalId *Optional* response_size_limit (int): responseSizeLimit *Optional* search_criteria_user_last_name (List[OCI.searchCriteriaUserLastName]): searchCriteriaUserLastName *Optional* @@ -143016,8 +137963,6 @@ class UserGetListInGroupRequest(OCIRequest): search_criteria_dn (List[OCI.searchCriteriaDn]): searchCriteriaDn *Optional* search_criteria_email_address (List[OCI.searchCriteriaEmailAddress]): searchCriteriaEmailAddress *Optional* - search_criteria_exact_user_department (OCI.searchCriteriaExactUserDepartment): - searchCriteriaExactUserDepartment *Optional* search_criteria_exact_user_in_trunk_group (OCI.searchCriteriaExactUserInTrunkGroup): searchCriteriaExactUserInTrunkGroup *Optional* @@ -143025,27 +137970,29 @@ class UserGetListInGroupRequest(OCIRequest): *Optional* search_criteria_extension (List[OCI.searchCriteriaExtension]): searchCriteriaExtension *Optional* + search_criteria_exact_user_department (OCI.searchCriteriaExactUserDepartment): + searchCriteriaExactUserDepartment *Optional* """ __slots__: List[str] = [ "service_provider_id", - "group_id", + "service_provider_external_id", "response_size_limit", "search_criteria_user_last_name", "search_criteria_user_first_name", "search_criteria_dn", "search_criteria_email_address", - "search_criteria_exact_user_department", "search_criteria_exact_user_in_trunk_group", "search_criteria_user_id", "search_criteria_extension", + "search_criteria_exact_user_department", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("service_provider_id", "serviceProviderId", str, is_required=True), - E("group_id", "GroupId", str, is_required=True), + E("service_provider_id", "serviceProviderId", str), + E("service_provider_external_id", "serviceProviderExternalId", str), E("response_size_limit", "responseSizeLimit", int), E( "search_criteria_user_last_name", @@ -143075,12 +138022,6 @@ def _elements(cls) -> Tuple[E, ...]: is_complex=True, is_array=True, ), - E( - "search_criteria_exact_user_department", - "searchCriteriaExactUserDepartment", - OCI.SearchCriteriaExactUserDepartment, - is_complex=True, - ), E( "search_criteria_exact_user_in_trunk_group", "searchCriteriaExactUserInTrunkGroup", @@ -143101,23 +138042,28 @@ def _elements(cls) -> Tuple[E, ...]: is_complex=True, is_array=True, ), + E( + "search_criteria_exact_user_department", + "searchCriteriaExactUserDepartment", + OCI.SearchCriteriaExactUserDepartment, + is_complex=True, + ), ) -class UserGetListInServiceProviderRequest(OCIRequest): +class UserGetListInSystemRequest(OCIRequest): """ - Request the list of users in a service provider or enterprise. + Request the list of users in the system. It is possible to search by various criteria to restrict the number of rows returned. - Multiple search criteria are logically ANDed together. The following elements are - only used in AS data mode and ignored in XS data mode: serviceProviderExternalId + Multiple search criteria are logically ANDed together. If reseller administrator + sends the request, searchCriteriaResellerId is ignored. All the users in the + administrator's reseller meeting the search criteria are returned. - The response is either a `UserGetListInServiceProviderResponse()` or an - `ErrorResponse()`. + The response is either a `UserGetListInSystemResponse()` or an `ErrorResponse()`. The + following data elements are only used in AS data mode: searchCriteriaResellerId Attributes: - service_provider_id (str): serviceProviderId *Optional* - service_provider_external_id (str): serviceProviderExternalId *Optional* response_size_limit (int): responseSizeLimit *Optional* search_criteria_user_last_name (List[OCI.searchCriteriaUserLastName]): searchCriteriaUserLastName *Optional* @@ -143126,36 +138072,45 @@ class UserGetListInServiceProviderRequest(OCIRequest): search_criteria_dn (List[OCI.searchCriteriaDn]): searchCriteriaDn *Optional* search_criteria_email_address (List[OCI.searchCriteriaEmailAddress]): searchCriteriaEmailAddress *Optional* + search_criteria_group_id (List[OCI.searchCriteriaGroupId]): searchCriteriaGroupId + *Optional* + search_criteria_exact_service_provider (OCI.searchCriteriaExactServiceProvider): + searchCriteriaExactServiceProvider *Optional* + search_criteria_service_provider_id (List[OCI.searchCriteriaServiceProviderId]): + searchCriteriaServiceProviderId *Optional* search_criteria_exact_user_in_trunk_group (OCI.searchCriteriaExactUserInTrunkGroup): searchCriteriaExactUserInTrunkGroup *Optional* + search_criteria_exact_user_network_class_of_service + (OCI.searchCriteriaExactUserNetworkClassOfService): + searchCriteriaExactUserNetworkClassOfService *Optional* search_criteria_user_id (List[OCI.searchCriteriaUserId]): searchCriteriaUserId *Optional* search_criteria_extension (List[OCI.searchCriteriaExtension]): searchCriteriaExtension *Optional* - search_criteria_exact_user_department (OCI.searchCriteriaExactUserDepartment): - searchCriteriaExactUserDepartment *Optional* + search_criteria_reseller_id (List[OCI.searchCriteriaResellerId]): + searchCriteriaResellerId *Optional* """ __slots__: List[str] = [ - "service_provider_id", - "service_provider_external_id", "response_size_limit", "search_criteria_user_last_name", "search_criteria_user_first_name", "search_criteria_dn", "search_criteria_email_address", + "search_criteria_group_id", + "search_criteria_exact_service_provider", + "search_criteria_service_provider_id", "search_criteria_exact_user_in_trunk_group", + "search_criteria_exact_user_network_class_of_service", "search_criteria_user_id", "search_criteria_extension", - "search_criteria_exact_user_department", + "search_criteria_reseller_id", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("service_provider_id", "serviceProviderId", str), - E("service_provider_external_id", "serviceProviderExternalId", str), E("response_size_limit", "responseSizeLimit", int), E( "search_criteria_user_last_name", @@ -143185,12 +138140,38 @@ def _elements(cls) -> Tuple[E, ...]: is_complex=True, is_array=True, ), + E( + "search_criteria_group_id", + "searchCriteriaGroupId", + OCI.SearchCriteriaGroupId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_exact_service_provider", + "searchCriteriaExactServiceProvider", + OCI.SearchCriteriaExactServiceProvider, + is_complex=True, + ), + E( + "search_criteria_service_provider_id", + "searchCriteriaServiceProviderId", + OCI.SearchCriteriaServiceProviderId, + is_complex=True, + is_array=True, + ), E( "search_criteria_exact_user_in_trunk_group", "searchCriteriaExactUserInTrunkGroup", OCI.SearchCriteriaExactUserInTrunkGroup, is_complex=True, ), + E( + "search_criteria_exact_user_network_class_of_service", + "searchCriteriaExactUserNetworkClassOfService", + OCI.SearchCriteriaExactUserNetworkClassOfService, + is_complex=True, + ), E( "search_criteria_user_id", "searchCriteriaUserId", @@ -143206,10 +138187,11 @@ def _elements(cls) -> Tuple[E, ...]: is_array=True, ), E( - "search_criteria_exact_user_department", - "searchCriteriaExactUserDepartment", - OCI.SearchCriteriaExactUserDepartment, + "search_criteria_reseller_id", + "searchCriteriaResellerId", + OCI.SearchCriteriaResellerId, is_complex=True, + is_array=True, ), ) @@ -143311,6 +138293,390 @@ def _elements(cls) -> Tuple[E, ...]: ) +class UserGetServiceInstanceListInSystemRequest(OCIRequest): + """ + Request the list of Service Instances in the system. + + It is possible to search by various criteria to restrict the number of rows returned. + Multiple search criteria are logically ANDed together. If reseller administrator + sends the request, searchCriteriaResellerId is ignored. All the service instances in + the administrator's reseller meeting the search criteria are returned. + + The response is either a `UserGetServiceInstanceListInSystemResponse()` or an + `ErrorResponse()`. The following data elements are only used in AS data mode: + searchCriteriaResellerId + + Attributes: + response_size_limit (int): responseSizeLimit *Optional* + search_criteria_exact_service_type (OCI.searchCriteriaExactServiceType): + searchCriteriaExactServiceType *Optional* + search_criteria_user_id (List[OCI.searchCriteriaUserId]): searchCriteriaUserId + *Optional* + search_criteria_user_last_name (List[OCI.searchCriteriaUserLastName]): + searchCriteriaUserLastName *Optional* + search_criteria_dn (List[OCI.searchCriteriaDn]): searchCriteriaDn *Optional* + search_criteria_extension (List[OCI.searchCriteriaExtension]): + searchCriteriaExtension *Optional* + search_criteria_group_id (List[OCI.searchCriteriaGroupId]): searchCriteriaGroupId + *Optional* + search_criteria_exact_service_provider (OCI.searchCriteriaExactServiceProvider): + searchCriteriaExactServiceProvider *Optional* + search_criteria_service_provider_id (List[OCI.searchCriteriaServiceProviderId]): + searchCriteriaServiceProviderId *Optional* + search_criteria_reseller_id (List[OCI.searchCriteriaResellerId]): + searchCriteriaResellerId *Optional* + """ + + __slots__: List[str] = [ + "response_size_limit", + "search_criteria_exact_service_type", + "search_criteria_user_id", + "search_criteria_user_last_name", + "search_criteria_dn", + "search_criteria_extension", + "search_criteria_group_id", + "search_criteria_exact_service_provider", + "search_criteria_service_provider_id", + "search_criteria_reseller_id", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("response_size_limit", "responseSizeLimit", int), + E( + "search_criteria_exact_service_type", + "searchCriteriaExactServiceType", + OCI.SearchCriteriaExactServiceType, + is_complex=True, + ), + E( + "search_criteria_user_id", + "searchCriteriaUserId", + OCI.SearchCriteriaUserId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_last_name", + "searchCriteriaUserLastName", + OCI.SearchCriteriaUserLastName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_dn", + "searchCriteriaDn", + OCI.SearchCriteriaDn, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_extension", + "searchCriteriaExtension", + OCI.SearchCriteriaExtension, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_group_id", + "searchCriteriaGroupId", + OCI.SearchCriteriaGroupId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_exact_service_provider", + "searchCriteriaExactServiceProvider", + OCI.SearchCriteriaExactServiceProvider, + is_complex=True, + ), + E( + "search_criteria_service_provider_id", + "searchCriteriaServiceProviderId", + OCI.SearchCriteriaServiceProviderId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_reseller_id", + "searchCriteriaResellerId", + OCI.SearchCriteriaResellerId, + is_complex=True, + is_array=True, + ), + ) + + +class UserGroupCommonPhoneListGetPagedSortedListRequest(OCIRequest): + """ + Get a user's group's common phone list. + + The response is either a `UserGroupCommonPhoneListGetPagedSortedListResponse()` or an + `ErrorResponse()`. The search can be done using multiple criterion. If the + searchCriteriaModeOr is present, any result matching any one criteria is included in + the results. Otherwise, only results matching all the search criterion are included + in the results. If no search criteria is specified, all results are returned. + Specifying searchCriteriaModeOr without any search criteria results in an + `ErrorResponse()`. The sort can be done on the name or the number in the common phone + list. The following elements are only used in AS data mode and ignored in XS data + mode: searchCriteriaGroupCommonMultiPartPhoneListName + + Attributes: + user_id (str): userId + response_paging_control (OCI.responsePagingControl): responsePagingControl + sort_by_group_common_phone_list_number (OCI.sortByGroupCommonPhoneListNumber): + sortByGroupCommonPhoneListNumber *Optional* + sort_by_group_common_phone_list_name (OCI.sortByGroupCommonPhoneListName): + sortByGroupCommonPhoneListName *Optional* + search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* + search_criteria_group_common_phone_list_name + (List[OCI.searchCriteriaGroupCommonPhoneListName]): + searchCriteriaGroupCommonPhoneListName *Optional* + search_criteria_group_common_phone_list_number + (List[OCI.searchCriteriaGroupCommonPhoneListNumber]): + searchCriteriaGroupCommonPhoneListNumber *Optional* + search_criteria_group_common_multi_part_phone_list_name + (List[OCI.searchCriteriaGroupCommonMultiPartPhoneListName]): + searchCriteriaGroupCommonMultiPartPhoneListName *Optional* + """ + + __slots__: List[str] = [ + "user_id", + "response_paging_control", + "sort_by_group_common_phone_list_number", + "sort_by_group_common_phone_list_name", + "search_criteria_mode_or", + "search_criteria_group_common_phone_list_name", + "search_criteria_group_common_phone_list_number", + "search_criteria_group_common_multi_part_phone_list_name", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("user_id", "userId", str, is_required=True), + E( + "response_paging_control", + "responsePagingControl", + OCI.ResponsePagingControl, + is_complex=True, + is_required=True, + ), + E( + "sort_by_group_common_phone_list_number", + "sortByGroupCommonPhoneListNumber", + OCI.SortByGroupCommonPhoneListNumber, + is_complex=True, + ), + E( + "sort_by_group_common_phone_list_name", + "sortByGroupCommonPhoneListName", + OCI.SortByGroupCommonPhoneListName, + is_complex=True, + ), + E("search_criteria_mode_or", "searchCriteriaModeOr", bool), + E( + "search_criteria_group_common_phone_list_name", + "searchCriteriaGroupCommonPhoneListName", + OCI.SearchCriteriaGroupCommonPhoneListName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_group_common_phone_list_number", + "searchCriteriaGroupCommonPhoneListNumber", + OCI.SearchCriteriaGroupCommonPhoneListNumber, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_group_common_multi_part_phone_list_name", + "searchCriteriaGroupCommonMultiPartPhoneListName", + OCI.SearchCriteriaGroupCommonMultiPartPhoneListName, + is_complex=True, + is_array=True, + ), + ) + + +class UserGroupCustomContactDirectoryGetPagedSortedListRequest(OCIRequest): + """ + Gets a Custom Contact Directory in a group. + + The response is either `UserGroupCustomContactDirectoryGetPagedSortedListResponse()` + or `ErrorResponse()`. The search can be done using multiple criterion. If the + searchCriteriaModeOr is present, any result matching any one criteria is included in + the results. Otherwise, only results matching all the search criterion are included + in the results. If no search criteria is specified, all results are returned. + Specifying searchCriteriaModeOr without any search criteria results in an + `ErrorResponse()`. The sort can be done on the user last name, first name, department, + or contact notes. The Receptionist Note column is only populated, if the user sending + the request is a the owner of this Receptionist Note and a Note exists. + + Attributes: + user_id (str): userId + name (str): name + response_paging_control (OCI.responsePagingControl): responsePagingControl + sort_by_user_last_name (OCI.sortByUserLastName): sortByUserLastName *Optional* + sort_by_user_first_name (OCI.sortByUserFirstName): sortByUserFirstName *Optional* + sort_by_user_department (OCI.sortByUserDepartment): sortByUserDepartment + *Optional* + sort_by_receptionist_note (OCI.sortByReceptionistNote): sortByReceptionistNote + *Optional* + search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* + search_criteria_user_last_name (List[OCI.searchCriteriaUserLastName]): + searchCriteriaUserLastName *Optional* + search_criteria_user_first_name (List[OCI.searchCriteriaUserFirstName]): + searchCriteriaUserFirstName *Optional* + search_criteria_dn (List[OCI.searchCriteriaDn]): searchCriteriaDn *Optional* + search_criteria_extension (List[OCI.searchCriteriaExtension]): + searchCriteriaExtension *Optional* + search_criteria_mobile_phone_number (List[OCI.searchCriteriaMobilePhoneNumber]): + searchCriteriaMobilePhoneNumber *Optional* + search_criteria_user_id (List[OCI.searchCriteriaUserId]): searchCriteriaUserId + *Optional* + search_criteria_department_name (List[OCI.searchCriteriaDepartmentName]): + searchCriteriaDepartmentName *Optional* + search_criteria_imp_id (List[OCI.searchCriteriaImpId]): searchCriteriaImpId + *Optional* + search_criteria_title (List[OCI.searchCriteriaTitle]): searchCriteriaTitle + *Optional* + search_criteria_receptionist_note (List[OCI.searchCriteriaReceptionistNote]): + searchCriteriaReceptionistNote *Optional* + """ + + __slots__: List[str] = [ + "user_id", + "name", + "response_paging_control", + "sort_by_user_last_name", + "sort_by_user_first_name", + "sort_by_user_department", + "sort_by_receptionist_note", + "search_criteria_mode_or", + "search_criteria_user_last_name", + "search_criteria_user_first_name", + "search_criteria_dn", + "search_criteria_extension", + "search_criteria_mobile_phone_number", + "search_criteria_user_id", + "search_criteria_department_name", + "search_criteria_imp_id", + "search_criteria_title", + "search_criteria_receptionist_note", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("user_id", "userId", str, is_required=True), + E("name", "name", str, is_required=True), + E( + "response_paging_control", + "responsePagingControl", + OCI.ResponsePagingControl, + is_complex=True, + is_required=True, + ), + E( + "sort_by_user_last_name", + "sortByUserLastName", + OCI.SortByUserLastName, + is_complex=True, + ), + E( + "sort_by_user_first_name", + "sortByUserFirstName", + OCI.SortByUserFirstName, + is_complex=True, + ), + E( + "sort_by_user_department", + "sortByUserDepartment", + OCI.SortByUserDepartment, + is_complex=True, + ), + E( + "sort_by_receptionist_note", + "sortByReceptionistNote", + OCI.SortByReceptionistNote, + is_complex=True, + ), + E("search_criteria_mode_or", "searchCriteriaModeOr", bool), + E( + "search_criteria_user_last_name", + "searchCriteriaUserLastName", + OCI.SearchCriteriaUserLastName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_first_name", + "searchCriteriaUserFirstName", + OCI.SearchCriteriaUserFirstName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_dn", + "searchCriteriaDn", + OCI.SearchCriteriaDn, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_extension", + "searchCriteriaExtension", + OCI.SearchCriteriaExtension, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_mobile_phone_number", + "searchCriteriaMobilePhoneNumber", + OCI.SearchCriteriaMobilePhoneNumber, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_id", + "searchCriteriaUserId", + OCI.SearchCriteriaUserId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_department_name", + "searchCriteriaDepartmentName", + OCI.SearchCriteriaDepartmentName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_imp_id", + "searchCriteriaImpId", + OCI.SearchCriteriaImpId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_title", + "searchCriteriaTitle", + OCI.SearchCriteriaTitle, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_receptionist_note", + "searchCriteriaReceptionistNote", + OCI.SearchCriteriaReceptionistNote, + is_complex=True, + is_array=True, + ), + ) + + class UserHotelingGuestGetAvailableUserListRequest(OCIRequest): """ Get a list of users that can be assigned as Hoteling Guests. @@ -144162,6 +139528,201 @@ def _elements(cls) -> Tuple[E, ...]: ) +class UserPersonalAssistantExclusionNumberGetListRequest(OCIRequest): + """ + Request to get the User Personal Assistant Exclusion Number List information. + + The response is either a userPersonalAssistantExclusionNumberGetListResponse or an + `ErrorResponse()`. + + Attributes: + user_id (str): userId + search_criteria_personal_assistant_exclusion_number + (List[OCI.searchCriteriaPersonalAssistantExclusionNumber]): + searchCriteriaPersonalAssistantExclusionNumber *Optional* + search_criteria_personal_assistant_exclusion_number_description + (List[OCI.searchCriteriaPersonalAssistantExclusionNumberDescription]): + searchCriteriaPersonalAssistantExclusionNumberDescription *Optional* + response_size_limit (int): responseSizeLimit *Optional* + """ + + __slots__: List[str] = [ + "user_id", + "search_criteria_personal_assistant_exclusion_number", + "search_criteria_personal_assistant_exclusion_number_description", + "response_size_limit", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("user_id", "userId", str, is_required=True), + E( + "search_criteria_personal_assistant_exclusion_number", + "searchCriteriaPersonalAssistantExclusionNumber", + OCI.SearchCriteriaPersonalAssistantExclusionNumber, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_personal_assistant_exclusion_number_description", + "searchCriteriaPersonalAssistantExclusionNumberDescription", + OCI.SearchCriteriaPersonalAssistantExclusionNumberDescription, + is_complex=True, + is_array=True, + ), + E("response_size_limit", "responseSizeLimit", int), + ) + + +class UserPersonalPhoneListGetListRequest(OCIRequest): + """ + Get a user's personal phone list. + + The response is either a `UserPersonalPhoneListGetListResponse()` or an + `ErrorResponse()`. The search can be done using multiple criterion. If the + searchCriteriaModeOr is present, any result matching any one criteria is included in + the results. Otherwise, only results matching all the search criterion are included + in the results. If no search criteria is specified, all results are returned. + Specifying searchCriteriaModeOr without any search criteria results in an + `ErrorResponse()`. In all cases, if a responseSizeLimit is specified and the number of + matching results is more than this limit, then an `ErrorResponse()` is returned. + + Attributes: + user_id (str): userId + response_size_limit (int): responseSizeLimit *Optional* + search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* + search_criteria_user_personal_phone_list_name + (List[OCI.searchCriteriaUserPersonalPhoneListName]): + searchCriteriaUserPersonalPhoneListName *Optional* + search_criteria_user_personal_phone_list_number + (List[OCI.searchCriteriaUserPersonalPhoneListNumber]): + searchCriteriaUserPersonalPhoneListNumber *Optional* + """ + + __slots__: List[str] = [ + "user_id", + "response_size_limit", + "search_criteria_mode_or", + "search_criteria_user_personal_phone_list_name", + "search_criteria_user_personal_phone_list_number", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("user_id", "userId", str, is_required=True), + E("response_size_limit", "responseSizeLimit", int), + E("search_criteria_mode_or", "searchCriteriaModeOr", bool), + E( + "search_criteria_user_personal_phone_list_name", + "searchCriteriaUserPersonalPhoneListName", + OCI.SearchCriteriaUserPersonalPhoneListName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_personal_phone_list_number", + "searchCriteriaUserPersonalPhoneListNumber", + OCI.SearchCriteriaUserPersonalPhoneListNumber, + is_complex=True, + is_array=True, + ), + ) + + +class UserPersonalPhoneListGetPagedSortedListRequest(OCIRequest): + """ + Get a user's personal phone list. + + The response is either a `UserPersonalPhoneListGetPagedSortedListResponse()` or an + `ErrorResponse()`. The search can be done using multiple criterion. If the + searchCriteriaModeOr is present, any result matching any one criteria is included in + the results. Otherwise, only results matching all the search criterion are included + in the results. If no search criteria is specified, all results are returned. + Specifying searchCriteriaModeOr without any search criteria results in an + `ErrorResponse()`. The sort can done by the personal phone list number or name. The + following elements are only used in AS data mode and ignored in XS data mode: + searchCriteriaUserPersonalMultiPartPhoneListName + + Attributes: + user_id (str): userId + response_paging_control (OCI.responsePagingControl): responsePagingControl + sort_by_user_personal_phone_list_number (OCI.sortByUserPersonalPhoneListNumber): + sortByUserPersonalPhoneListNumber *Optional* + sort_by_user_personal_phone_list_name (OCI.sortByUserPersonalPhoneListName): + sortByUserPersonalPhoneListName *Optional* + search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* + search_criteria_user_personal_phone_list_name + (List[OCI.searchCriteriaUserPersonalPhoneListName]): + searchCriteriaUserPersonalPhoneListName *Optional* + search_criteria_user_personal_phone_list_number + (List[OCI.searchCriteriaUserPersonalPhoneListNumber]): + searchCriteriaUserPersonalPhoneListNumber *Optional* + search_criteria_user_personal_multi_part_phone_list_name + (List[OCI.searchCriteriaUserPersonalMultiPartPhoneListName]): + searchCriteriaUserPersonalMultiPartPhoneListName *Optional* + """ + + __slots__: List[str] = [ + "user_id", + "response_paging_control", + "sort_by_user_personal_phone_list_number", + "sort_by_user_personal_phone_list_name", + "search_criteria_mode_or", + "search_criteria_user_personal_phone_list_name", + "search_criteria_user_personal_phone_list_number", + "search_criteria_user_personal_multi_part_phone_list_name", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("user_id", "userId", str, is_required=True), + E( + "response_paging_control", + "responsePagingControl", + OCI.ResponsePagingControl, + is_complex=True, + is_required=True, + ), + E( + "sort_by_user_personal_phone_list_number", + "sortByUserPersonalPhoneListNumber", + OCI.SortByUserPersonalPhoneListNumber, + is_complex=True, + ), + E( + "sort_by_user_personal_phone_list_name", + "sortByUserPersonalPhoneListName", + OCI.SortByUserPersonalPhoneListName, + is_complex=True, + ), + E("search_criteria_mode_or", "searchCriteriaModeOr", bool), + E( + "search_criteria_user_personal_phone_list_name", + "searchCriteriaUserPersonalPhoneListName", + OCI.SearchCriteriaUserPersonalPhoneListName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_personal_phone_list_number", + "searchCriteriaUserPersonalPhoneListNumber", + OCI.SearchCriteriaUserPersonalPhoneListNumber, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_personal_multi_part_phone_list_name", + "searchCriteriaUserPersonalMultiPartPhoneListName", + OCI.SearchCriteriaUserPersonalMultiPartPhoneListName, + is_complex=True, + is_array=True, + ), + ) + + class UserPhoneDirectoryGetListRequest(OCIRequest): """ Request a table containing the phone directory for a user's group. @@ -144512,6 +140073,253 @@ def _elements(cls) -> Tuple[E, ...]: ) +class UserPhoneDirectoryGetPagedSortedListRequest(OCIRequest): + """ + Request a table containing the phone directory for a user. + + Setting isEnterpriseRequested to true will return enterprise directory members in the + response if the user is in an enterprise. Otherwise, just the group directory members + for a user are returned in the response. + + The response is either `UserPhoneDirectoryGetPagedSortedListResponse()` or + `ErrorResponse()`. The search can be done using multiple criteria. If the + searchCriteriaModeOr is present, any result matching any one criteria is included in + the results. Otherwise, only results matching all the search criteria are included in + the results. If no search criteria is specified, all results are returned. + Specifying searchCriteriaModeOr without any search criteria results in an + `ErrorResponse()`. The sort can be performed on user last name, first name, + department, or receptionist note. The Receptionist Note column is only populated, if + the user sending the request is the owner of the Receptionist Note and a Note exists. + The following elements are only used in AS data mode and ignored in XS data mode: + searchCriteriaMultiPartName + + Attributes: + user_id (str): userId + is_enterprise_info_requested (bool): isEnterpriseInfoRequested + response_paging_control (OCI.responsePagingControl): responsePagingControl + sort_by_user_last_name (OCI.sortByUserLastName): sortByUserLastName *Optional* + sort_by_user_first_name (OCI.sortByUserFirstName): sortByUserFirstName *Optional* + sort_by_user_department (OCI.sortByUserDepartment): sortByUserDepartment + *Optional* + sort_by_receptionist_note (OCI.sortByReceptionistNote): sortByReceptionistNote + *Optional* + search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* + search_criteria_user_last_name (List[OCI.searchCriteriaUserLastName]): + searchCriteriaUserLastName *Optional* + search_criteria_user_first_name (List[OCI.searchCriteriaUserFirstName]): + searchCriteriaUserFirstName *Optional* + search_criteria_user_name (List[OCI.searchCriteriaUserName]): + searchCriteriaUserName *Optional* + search_criteria_dn (List[OCI.searchCriteriaDn]): searchCriteriaDn *Optional* + search_criteria_group_location_code (List[OCI.searchCriteriaGroupLocationCode]): + searchCriteriaGroupLocationCode *Optional* + search_criteria_extension (List[OCI.searchCriteriaExtension]): + searchCriteriaExtension *Optional* + search_criteria_mobile_phone_number (List[OCI.searchCriteriaMobilePhoneNumber]): + searchCriteriaMobilePhoneNumber *Optional* + search_criteria_email_address (List[OCI.searchCriteriaEmailAddress]): + searchCriteriaEmailAddress *Optional* + search_criteria_yahoo_id (List[OCI.searchCriteriaYahooId]): searchCriteriaYahooId + *Optional* + search_criteria_exact_user_group (OCI.searchCriteriaExactUserGroup): + searchCriteriaExactUserGroup *Optional* + search_criteria_department_name (List[OCI.searchCriteriaDepartmentName]): + searchCriteriaDepartmentName *Optional* + search_criteria_user_id (List[OCI.searchCriteriaUserId]): searchCriteriaUserId + *Optional* + search_criteria_imp_id (List[OCI.searchCriteriaImpId]): searchCriteriaImpId + *Optional* + search_criteria_title (List[OCI.searchCriteriaTitle]): searchCriteriaTitle + *Optional* + search_criteria_receptionist_note (List[OCI.searchCriteriaReceptionistNote]): + searchCriteriaReceptionistNote *Optional* + search_criteria_multi_part_name (List[OCI.searchCriteriaMultiPartName]): + searchCriteriaMultiPartName *Optional* + """ + + __slots__: List[str] = [ + "user_id", + "is_enterprise_info_requested", + "response_paging_control", + "sort_by_user_last_name", + "sort_by_user_first_name", + "sort_by_user_department", + "sort_by_receptionist_note", + "search_criteria_mode_or", + "search_criteria_user_last_name", + "search_criteria_user_first_name", + "search_criteria_user_name", + "search_criteria_dn", + "search_criteria_group_location_code", + "search_criteria_extension", + "search_criteria_mobile_phone_number", + "search_criteria_email_address", + "search_criteria_yahoo_id", + "search_criteria_exact_user_group", + "search_criteria_department_name", + "search_criteria_user_id", + "search_criteria_imp_id", + "search_criteria_title", + "search_criteria_receptionist_note", + "search_criteria_multi_part_name", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("user_id", "userId", str, is_required=True), + E( + "is_enterprise_info_requested", + "isEnterpriseInfoRequested", + bool, + is_required=True, + ), + E( + "response_paging_control", + "responsePagingControl", + OCI.ResponsePagingControl, + is_complex=True, + is_required=True, + ), + E( + "sort_by_user_last_name", + "sortByUserLastName", + OCI.SortByUserLastName, + is_complex=True, + ), + E( + "sort_by_user_first_name", + "sortByUserFirstName", + OCI.SortByUserFirstName, + is_complex=True, + ), + E( + "sort_by_user_department", + "sortByUserDepartment", + OCI.SortByUserDepartment, + is_complex=True, + ), + E( + "sort_by_receptionist_note", + "sortByReceptionistNote", + OCI.SortByReceptionistNote, + is_complex=True, + ), + E("search_criteria_mode_or", "searchCriteriaModeOr", bool), + E( + "search_criteria_user_last_name", + "searchCriteriaUserLastName", + OCI.SearchCriteriaUserLastName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_first_name", + "searchCriteriaUserFirstName", + OCI.SearchCriteriaUserFirstName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_name", + "searchCriteriaUserName", + OCI.SearchCriteriaUserName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_dn", + "searchCriteriaDn", + OCI.SearchCriteriaDn, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_group_location_code", + "searchCriteriaGroupLocationCode", + OCI.SearchCriteriaGroupLocationCode, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_extension", + "searchCriteriaExtension", + OCI.SearchCriteriaExtension, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_mobile_phone_number", + "searchCriteriaMobilePhoneNumber", + OCI.SearchCriteriaMobilePhoneNumber, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_email_address", + "searchCriteriaEmailAddress", + OCI.SearchCriteriaEmailAddress, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_yahoo_id", + "searchCriteriaYahooId", + OCI.SearchCriteriaYahooId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_exact_user_group", + "searchCriteriaExactUserGroup", + OCI.SearchCriteriaExactUserGroup, + is_complex=True, + ), + E( + "search_criteria_department_name", + "searchCriteriaDepartmentName", + OCI.SearchCriteriaDepartmentName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_id", + "searchCriteriaUserId", + OCI.SearchCriteriaUserId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_imp_id", + "searchCriteriaImpId", + OCI.SearchCriteriaImpId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_title", + "searchCriteriaTitle", + OCI.SearchCriteriaTitle, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_receptionist_note", + "searchCriteriaReceptionistNote", + OCI.SearchCriteriaReceptionistNote, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_multi_part_name", + "searchCriteriaMultiPartName", + OCI.SearchCriteriaMultiPartUserName, + is_complex=True, + is_array=True, + ), + ) + + class UserPreAlertingAnnouncementModifyCriteriaRequest(OCIRequest): """ Modify a criteria for the user's pre-alerting service. @@ -144983,6 +140791,86 @@ def _elements(cls) -> Tuple[E, ...]: ) +class UserScheduleGetPagedSortedListRequest(OCIRequest): + """ + Get the list of schedules viewable by a User. + + The list can be filtered by schedule name, schedule type, and schedule level. + + The response is either a `UserScheduleGetPagedSortedListResponse()` or an + `ErrorResponse()`. This command is authorized to user who is Executive-Assistant of + the Executive. If no sortOrder is included, the response is sorted by Name ascending + by default. If the responsePagingControl element is not provided, the paging + startIndex will be set to 1 by default, and the responsePageSize will be set to the + maximum responsePageSize by default. Multiple search criteria are logically ANDed + together unless the searchCriteriaModeOr option is included. Then the search criteria + are logically ORed together. + + Attributes: + user_id (str): userId + response_paging_control (OCI.responsePagingControl): responsePagingControl + *Optional* + sort_by_schedule_name (OCI.sortByScheduleName): sortByScheduleName *Optional* + search_criteria_schedule_name (List[OCI.searchCriteriaScheduleName]): + searchCriteriaScheduleName *Optional* + search_criteria_exact_schedule_type (List[OCI.searchCriteriaExactScheduleType]): + searchCriteriaExactScheduleType *Optional* + search_criteria_exact_schedule_level (List[OCI.searchCriteriaExactScheduleLevel]): + searchCriteriaExactScheduleLevel *Optional* + search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* + """ + + __slots__: List[str] = [ + "user_id", + "response_paging_control", + "sort_by_schedule_name", + "search_criteria_schedule_name", + "search_criteria_exact_schedule_type", + "search_criteria_exact_schedule_level", + "search_criteria_mode_or", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("user_id", "userId", str, is_required=True), + E( + "response_paging_control", + "responsePagingControl", + OCI.ResponsePagingControl, + is_complex=True, + ), + E( + "sort_by_schedule_name", + "sortByScheduleName", + OCI.SortByScheduleName, + is_complex=True, + ), + E( + "search_criteria_schedule_name", + "searchCriteriaScheduleName", + OCI.SearchCriteriaScheduleName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_exact_schedule_type", + "searchCriteriaExactScheduleType", + OCI.SearchCriteriaExactScheduleType, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_exact_schedule_level", + "searchCriteriaExactScheduleLevel", + OCI.SearchCriteriaExactScheduleLevel, + is_complex=True, + is_array=True, + ), + E("search_criteria_mode_or", "searchCriteriaModeOr", bool), + ) + + class UserSelectiveCallAcceptanceModifyCriteriaRequest(OCIRequest): """ Modify a criteria for the user's selective call acceptance service. @@ -146721,6 +142609,626 @@ def _elements(cls) -> Tuple[E, ...]: ) +class EnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAssignmentPagedSortedListRequest( + OCIRequest, +): + """ + Request a summary table of all Mobile Subscriber Directory Numbers in an enterprise. + + If the responsePagingControl element is not provided, the paging startIndex will be + set to 1 by default, and the responsePageSize will be set to the maximum + ResponsePageSize by default. If no sortOrder is included the response is sorted by + Mobile Number ascending by default. Multiple search criteria are logically ANDed + together unless the searchCriteriaModeOr option is included. Then the search criteria + are logically ORed together. The department in both the search criteria and sort by + fields refer to the department of the user. + + The response is either + `EnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAssignmentPagedSortedListResponse()` + or `ErrorResponse()`. Replaced by: + `EnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAssignmentPagedSortedListRequest22()` + + Attributes: + service_provider_id (str): serviceProviderId + response_paging_control (OCI.responsePagingControl): responsePagingControl + *Optional* + sort_order (List[OCI.sortOrder]): sortOrder *Optional* + search_criteria_mobile_subscriber_directory_number + (List[OCI.searchCriteriaMobileSubscriberDirectoryNumber]): + searchCriteriaMobileSubscriberDirectoryNumber *Optional* + search_criteria_group_id (List[OCI.searchCriteriaGroupId]): searchCriteriaGroupId + *Optional* + search_criteria_user_id (List[OCI.searchCriteriaUserId]): searchCriteriaUserId + *Optional* + search_criteria_user_last_name (List[OCI.searchCriteriaUserLastName]): + searchCriteriaUserLastName *Optional* + search_criteria_user_first_name (List[OCI.searchCriteriaUserFirstName]): + searchCriteriaUserFirstName *Optional* + search_criteria_dn (List[OCI.searchCriteriaDn]): searchCriteriaDn *Optional* + search_criteria_extension (List[OCI.searchCriteriaExtension]): + searchCriteriaExtension *Optional* + search_criteria_department_name (List[OCI.searchCriteriaDepartmentName]): + searchCriteriaDepartmentName *Optional* + search_criteria_exact_mobile_network (List[OCI.searchCriteriaExactMobileNetwork]): + searchCriteriaExactMobileNetwork *Optional* + search_criteria_exact_mobile_dn_availability + (OCI.searchCriteriaExactMobileDnAvailability): + searchCriteriaExactMobileDnAvailability *Optional* + search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* + """ + + __slots__: List[str] = [ + "service_provider_id", + "response_paging_control", + "sort_order", + "search_criteria_mobile_subscriber_directory_number", + "search_criteria_group_id", + "search_criteria_user_id", + "search_criteria_user_last_name", + "search_criteria_user_first_name", + "search_criteria_dn", + "search_criteria_extension", + "search_criteria_department_name", + "search_criteria_exact_mobile_network", + "search_criteria_exact_mobile_dn_availability", + "search_criteria_mode_or", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("service_provider_id", "serviceProviderId", str, is_required=True), + E( + "response_paging_control", + "responsePagingControl", + OCI.ResponsePagingControl, + is_complex=True, + ), + E( + "sort_order", + "sortOrder", + OCI.SortOrderEnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAssignmentPagedSortedList, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_mobile_subscriber_directory_number", + "searchCriteriaMobileSubscriberDirectoryNumber", + OCI.SearchCriteriaMobileSubscriberDirectoryNumber, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_group_id", + "searchCriteriaGroupId", + OCI.SearchCriteriaGroupId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_id", + "searchCriteriaUserId", + OCI.SearchCriteriaUserId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_last_name", + "searchCriteriaUserLastName", + OCI.SearchCriteriaUserLastName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_first_name", + "searchCriteriaUserFirstName", + OCI.SearchCriteriaUserFirstName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_dn", + "searchCriteriaDn", + OCI.SearchCriteriaDn, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_extension", + "searchCriteriaExtension", + OCI.SearchCriteriaExtension, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_department_name", + "searchCriteriaDepartmentName", + OCI.SearchCriteriaDepartmentName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_exact_mobile_network", + "searchCriteriaExactMobileNetwork", + OCI.SearchCriteriaExactMobileNetwork, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_exact_mobile_dn_availability", + "searchCriteriaExactMobileDnAvailability", + OCI.SearchCriteriaExactMobileDnAvailability, + is_complex=True, + ), + E("search_criteria_mode_or", "searchCriteriaModeOr", bool), + ) + + +class EnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAssignmentPagedSortedListRequest22( + OCIRequest, +): + """ + Request a summary table of all Mobile Subscriber Directory Numbers in an enterprise. + + If the responsePagingControl element is not provided, the paging startIndex will be + set to 1 by default, and the responsePageSize will be set to the maximum + ResponsePageSize by default. If no sortOrder is included the response is sorted by + Mobile Number ascending by default. Multiple search criteria are logically ANDed + together unless the searchCriteriaModeOr option is included. Then the search criteria + are logically ORed together. The department in both the search criteria and sort by + fields refer to the department of the user. + + The response is either + `EnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAssignmentPagedSortedListResponse22()` + or `ErrorResponse()`. + + Attributes: + service_provider_id (str): serviceProviderId + include_total_number_of_rows (bool): includeTotalNumberOfRows *Optional* + response_paging_control (OCI.responsePagingControl): responsePagingControl + *Optional* + sort_order (List[OCI.sortOrder]): sortOrder *Optional* + search_criteria_mobile_subscriber_directory_number + (List[OCI.searchCriteriaMobileSubscriberDirectoryNumber]): + searchCriteriaMobileSubscriberDirectoryNumber *Optional* + search_criteria_group_id (List[OCI.searchCriteriaGroupId]): searchCriteriaGroupId + *Optional* + search_criteria_user_id (List[OCI.searchCriteriaUserId]): searchCriteriaUserId + *Optional* + search_criteria_user_last_name (List[OCI.searchCriteriaUserLastName]): + searchCriteriaUserLastName *Optional* + search_criteria_user_first_name (List[OCI.searchCriteriaUserFirstName]): + searchCriteriaUserFirstName *Optional* + search_criteria_dn (List[OCI.searchCriteriaDn]): searchCriteriaDn *Optional* + search_criteria_extension (List[OCI.searchCriteriaExtension]): + searchCriteriaExtension *Optional* + search_criteria_department_name (List[OCI.searchCriteriaDepartmentName]): + searchCriteriaDepartmentName *Optional* + search_criteria_exact_mobile_network (List[OCI.searchCriteriaExactMobileNetwork]): + searchCriteriaExactMobileNetwork *Optional* + search_criteria_exact_mobile_dn_availability + (OCI.searchCriteriaExactMobileDnAvailability): + searchCriteriaExactMobileDnAvailability *Optional* + search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* + """ + + __slots__: List[str] = [ + "service_provider_id", + "include_total_number_of_rows", + "response_paging_control", + "sort_order", + "search_criteria_mobile_subscriber_directory_number", + "search_criteria_group_id", + "search_criteria_user_id", + "search_criteria_user_last_name", + "search_criteria_user_first_name", + "search_criteria_dn", + "search_criteria_extension", + "search_criteria_department_name", + "search_criteria_exact_mobile_network", + "search_criteria_exact_mobile_dn_availability", + "search_criteria_mode_or", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("service_provider_id", "serviceProviderId", str, is_required=True), + E("include_total_number_of_rows", "includeTotalNumberOfRows", bool), + E( + "response_paging_control", + "responsePagingControl", + OCI.ResponsePagingControl, + is_complex=True, + ), + E( + "sort_order", + "sortOrder", + OCI.SortOrderEnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAssignmentPagedSortedList, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_mobile_subscriber_directory_number", + "searchCriteriaMobileSubscriberDirectoryNumber", + OCI.SearchCriteriaMobileSubscriberDirectoryNumber, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_group_id", + "searchCriteriaGroupId", + OCI.SearchCriteriaGroupId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_id", + "searchCriteriaUserId", + OCI.SearchCriteriaUserId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_last_name", + "searchCriteriaUserLastName", + OCI.SearchCriteriaUserLastName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_first_name", + "searchCriteriaUserFirstName", + OCI.SearchCriteriaUserFirstName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_dn", + "searchCriteriaDn", + OCI.SearchCriteriaDn, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_extension", + "searchCriteriaExtension", + OCI.SearchCriteriaExtension, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_department_name", + "searchCriteriaDepartmentName", + OCI.SearchCriteriaDepartmentName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_exact_mobile_network", + "searchCriteriaExactMobileNetwork", + OCI.SearchCriteriaExactMobileNetwork, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_exact_mobile_dn_availability", + "searchCriteriaExactMobileDnAvailability", + OCI.SearchCriteriaExactMobileDnAvailability, + is_complex=True, + ), + E("search_criteria_mode_or", "searchCriteriaModeOr", bool), + ) + + +class EnterpriseCallCenterAgentThresholdProfileGetAvailableAgentPagedSortedListRequest( + OCIRequest, +): + """ + Get the list of all Agents in the Enterprise that can be assigned to a given Call + Center Agent Threshold Profile in an Enterprise. + + An agent is available to be assigned to a given Agent Threshold Profile if it is a + Call Center Standard or Call Center Premium agent and the agent is not yet assigned to + the profile. If the responsePagingControl element is not provided, the paging + startIndex will be set to 1 by default, and the responsePageSize will be set to the + maximum ResponsePageSize by default. It is possible to search by various criteria to + restrict the number of rows returned. The available agent list for a new Call Center + Agent Threshold profile can be obtained by not setting the + excludeAgentsAssignedToProfileName. When the excludeAgentsAssignedToProfileName is + specified, all agents already assigned to the specified profile are not included in + the response, even if the search criterion element searchCriteriaAgentThresholdProfile + is specified using the same profile name. If no sortOrder is included the response is + sorted by User Id ascending by default. Multiple search criteria are logically ANDed + together unless the searchCriteriaModeOr option is included. Then the search criteria + are logically ORed together. `ErrorResponse()` is returned if + searchCriteriaExactUserGroup has multiple entries and searchCriteriaModeOr is not + included. + + The response is either a + `EnterpriseCallCenterAgentThresholdProfileGetAvailableAgentPagedSortedListResponse()` + or an `ErrorResponse()`. + + Attributes: + service_provider_id (str): serviceProviderId + exclude_agents_assigned_to_profile_name (str): excludeAgentsAssignedToProfileName + *Optional* + response_paging_control (OCI.responsePagingControl): responsePagingControl + *Optional* + sort_order (List[OCI.sortOrder]): sortOrder *Optional* + search_criteria_user_id (List[OCI.searchCriteriaUserId]): searchCriteriaUserId + *Optional* + search_criteria_user_last_name (List[OCI.searchCriteriaUserLastName]): + searchCriteriaUserLastName *Optional* + search_criteria_user_first_name (List[OCI.searchCriteriaUserFirstName]): + searchCriteriaUserFirstName *Optional* + search_criteria_dn (List[OCI.searchCriteriaDn]): searchCriteriaDn *Optional* + search_criteria_extension (List[OCI.searchCriteriaExtension]): + searchCriteriaExtension *Optional* + search_criteria_department_name (List[OCI.searchCriteriaDepartmentName]): + searchCriteriaDepartmentName *Optional* + search_criteria_email_address (List[OCI.searchCriteriaEmailAddress]): + searchCriteriaEmailAddress *Optional* + search_criteria_agent_threshold_profile + (List[OCI.searchCriteriaAgentThresholdProfile]): + searchCriteriaAgentThresholdProfile *Optional* + search_criteria_exact_user_group (List[OCI.searchCriteriaExactUserGroup]): + searchCriteriaExactUserGroup *Optional* + search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* + """ + + __slots__: List[str] = [ + "service_provider_id", + "exclude_agents_assigned_to_profile_name", + "response_paging_control", + "sort_order", + "search_criteria_user_id", + "search_criteria_user_last_name", + "search_criteria_user_first_name", + "search_criteria_dn", + "search_criteria_extension", + "search_criteria_department_name", + "search_criteria_email_address", + "search_criteria_agent_threshold_profile", + "search_criteria_exact_user_group", + "search_criteria_mode_or", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("service_provider_id", "serviceProviderId", str, is_required=True), + E( + "exclude_agents_assigned_to_profile_name", + "excludeAgentsAssignedToProfileName", + str, + ), + E( + "response_paging_control", + "responsePagingControl", + OCI.ResponsePagingControl, + is_complex=True, + ), + E( + "sort_order", + "sortOrder", + OCI.SortOrderEnterpriseCallCenterAgentThresholdProfileGetAvailableAgentPagedSortedList, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_id", + "searchCriteriaUserId", + OCI.SearchCriteriaUserId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_last_name", + "searchCriteriaUserLastName", + OCI.SearchCriteriaUserLastName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_first_name", + "searchCriteriaUserFirstName", + OCI.SearchCriteriaUserFirstName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_dn", + "searchCriteriaDn", + OCI.SearchCriteriaDn, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_extension", + "searchCriteriaExtension", + OCI.SearchCriteriaExtension, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_department_name", + "searchCriteriaDepartmentName", + OCI.SearchCriteriaDepartmentName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_email_address", + "searchCriteriaEmailAddress", + OCI.SearchCriteriaEmailAddress, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_agent_threshold_profile", + "searchCriteriaAgentThresholdProfile", + OCI.SearchCriteriaAgentThresholdProfile, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_exact_user_group", + "searchCriteriaExactUserGroup", + OCI.SearchCriteriaExactUserGroup, + is_complex=True, + is_array=True, + ), + E("search_criteria_mode_or", "searchCriteriaModeOr", bool), + ) + + +class EnterpriseCallCenterAgentThresholdProfileGetPagedSortedRequest(OCIRequest): + """ + Gets an existing specified Call Center Agent Threshold Profile in an Enterprise. + + The agentTable is what the search, sort, and pagination fields apply to. If the + responsePagingControl element is not provided, the paging startIndex will be set to 1 + by default, and the responsePageSize will be set to the maximum ResponsePageSize by + default. It is possible to search by various criteria to restrict the number of rows + returned. If no sortOrder is included the response is sorted by User Id ascending by + default. Multiple search criteria are logically ANDed together unless the + searchCriteriaModeOr option is included. Then the search criteria are logically ORed + together. `ErrorResponse()` is returned if searchCriteriaExactUserGroup has multiple + entries and searchCriteriaModeOr is not included. + + The response is either a + `EnterpriseCallCenterAgentThresholdProfileGetPagedSortedResponse()` or an + `ErrorResponse()`. + + Attributes: + service_provider_id (str): serviceProviderId + profile_name (str): profileName + response_paging_control (OCI.responsePagingControl): responsePagingControl + *Optional* + sort_order (List[OCI.sortOrder]): sortOrder *Optional* + search_criteria_user_id (List[OCI.searchCriteriaUserId]): searchCriteriaUserId + *Optional* + search_criteria_user_last_name (List[OCI.searchCriteriaUserLastName]): + searchCriteriaUserLastName *Optional* + search_criteria_user_first_name (List[OCI.searchCriteriaUserFirstName]): + searchCriteriaUserFirstName *Optional* + search_criteria_dn (List[OCI.searchCriteriaDn]): searchCriteriaDn *Optional* + search_criteria_extension (List[OCI.searchCriteriaExtension]): + searchCriteriaExtension *Optional* + search_criteria_department_name (List[OCI.searchCriteriaDepartmentName]): + searchCriteriaDepartmentName *Optional* + search_criteria_exact_user_group (List[OCI.searchCriteriaExactUserGroup]): + searchCriteriaExactUserGroup *Optional* + search_criteria_group_name (List[OCI.searchCriteriaGroupName]): + searchCriteriaGroupName *Optional* + search_criteria_email_address (List[OCI.searchCriteriaEmailAddress]): + searchCriteriaEmailAddress *Optional* + search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* + """ + + __slots__: List[str] = [ + "service_provider_id", + "profile_name", + "response_paging_control", + "sort_order", + "search_criteria_user_id", + "search_criteria_user_last_name", + "search_criteria_user_first_name", + "search_criteria_dn", + "search_criteria_extension", + "search_criteria_department_name", + "search_criteria_exact_user_group", + "search_criteria_group_name", + "search_criteria_email_address", + "search_criteria_mode_or", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("service_provider_id", "serviceProviderId", str, is_required=True), + E("profile_name", "profileName", str, is_required=True), + E( + "response_paging_control", + "responsePagingControl", + OCI.ResponsePagingControl, + is_complex=True, + ), + E( + "sort_order", + "sortOrder", + OCI.SortOrderEnterpriseCallCenterAgentThresholdProfileGetPagedSorted, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_id", + "searchCriteriaUserId", + OCI.SearchCriteriaUserId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_last_name", + "searchCriteriaUserLastName", + OCI.SearchCriteriaUserLastName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_first_name", + "searchCriteriaUserFirstName", + OCI.SearchCriteriaUserFirstName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_dn", + "searchCriteriaDn", + OCI.SearchCriteriaDn, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_extension", + "searchCriteriaExtension", + OCI.SearchCriteriaExtension, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_department_name", + "searchCriteriaDepartmentName", + OCI.SearchCriteriaDepartmentName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_exact_user_group", + "searchCriteriaExactUserGroup", + OCI.SearchCriteriaExactUserGroup, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_group_name", + "searchCriteriaGroupName", + OCI.SearchCriteriaGroupName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_email_address", + "searchCriteriaEmailAddress", + OCI.SearchCriteriaEmailAddress, + is_complex=True, + is_array=True, + ), + E("search_criteria_mode_or", "searchCriteriaModeOr", bool), + ) + + class EnterpriseCallCenterEnhancedReportingScheduledReportAddRequest(OCIRequest): """ Request to add an enterprise level call center reporting scheduled report. @@ -146943,65 +143451,266 @@ def _elements(cls) -> Tuple[E, ...]: E("report_date_format", "reportDateFormat", str), E("report_time_format", "reportTimeFormat", str), E( - "report_interval", - "reportInterval", - OCI.CallCenterReportInterval, + "report_interval", + "reportInterval", + OCI.CallCenterReportInterval, + is_complex=True, + ), + E("report_format", "reportFormat", str), + E( + "agent", + "agent", + OCI.CallCenterScheduledReportAgentSelection, + is_complex=True, + ), + E( + "call_center", + "callCenter", + OCI.CallCenterScheduledReportCallCenterSelection, + is_complex=True, + ), + E( + "dnis", + "dnis", + OCI.CallCenterScheduledReportDNISSelection, + is_complex=True, + ), + E( + "call_completion_threshold_seconds", + "callCompletionThresholdSeconds", + int, + ), + E("short_duration_threshold_seconds", "shortDurationThresholdSeconds", int), + E( + "service_level_threshold_seconds", + "serviceLevelThresholdSeconds", + OCI.CallCenterReportServiceLevelThresholdReplacementList, + is_complex=True, + ), + E( + "service_level_inclusions", + "serviceLevelInclusions", + OCI.CallCenterScheduledReportServiceLevelInclusionsModify, + is_complex=True, + ), + E( + "service_level_objective_percentage", + "serviceLevelObjectivePercentage", + int, + ), + E( + "abandoned_call_threshold_seconds", + "abandonedCallThresholdSeconds", + OCI.CallCenterReportAbandonedCallThresholdReplacementList, + is_complex=True, + ), + E( + "email_address", + "emailAddress", + OCI.CallCenterReportReplacementEmailList, + is_complex=True, + ), + ) + + +class EnterprisePhoneDirectoryGetPagedSortedListRequest(OCIRequest): + """ + Request a table containing the phone directory for an enterprise. + + The directory includes all users in the enterprise and all entries in the enterprise + common phone list. If the responsePagingControl element is not provided, the paging + startIndex will be set to 1 by default, and the responsePageSize will be set to the + maximum ResponsePageSize by default. It is possible to search by various criteria to + restrict the number of rows returned. If no sortOrder is included the response is + sorted by User Id ascending with a secondary sort by User Last Name ascending by + default. Multiple search criteria are logically ANDed together unless the + searchCriteriaModeOr option is included. Then the search criteria are logically ORed + together. `ErrorResponse()` is returned if searchCriteriaExactUserGroup or + searchCriteriaExactUserDepartment have multiple entries and searchCriteriaModeOr is + not included The following elements are only used in AS data mode and ignored in + Amplify and XS data mode: "sortByImpId" "searchCriteriaImpId" + + The response is either `EnterprisePhoneDirectoryGetPagedSortedListResponse()` or + `ErrorResponse()`. + + Attributes: + enterprise_id (str): enterpriseId + is_extended_info_requested (bool): isExtendedInfoRequested + response_paging_control (OCI.responsePagingControl): responsePagingControl + *Optional* + sort_order (List[OCI.sortOrder]): sortOrder *Optional* + search_criteria_user_last_name (List[OCI.searchCriteriaUserLastName]): + searchCriteriaUserLastName *Optional* + search_criteria_user_first_name (List[OCI.searchCriteriaUserFirstName]): + searchCriteriaUserFirstName *Optional* + search_criteria_dn (List[OCI.searchCriteriaDn]): searchCriteriaDn *Optional* + search_criteria_group_location_code (List[OCI.searchCriteriaGroupLocationCode]): + searchCriteriaGroupLocationCode *Optional* + search_criteria_extension (List[OCI.searchCriteriaExtension]): + searchCriteriaExtension *Optional* + search_criteria_mobile_phone_number (List[OCI.searchCriteriaMobilePhoneNumber]): + searchCriteriaMobilePhoneNumber *Optional* + search_criteria_email_address (List[OCI.searchCriteriaEmailAddress]): + searchCriteriaEmailAddress *Optional* + search_criteria_exact_user_department (OCI.searchCriteriaExactUserDepartment): + searchCriteriaExactUserDepartment *Optional* + search_criteria_department_name (List[OCI.searchCriteriaDepartmentName]): + searchCriteriaDepartmentName *Optional* + search_criteria_exact_user_group (OCI.searchCriteriaExactUserGroup): + searchCriteriaExactUserGroup *Optional* + search_criteria_group_name (List[OCI.searchCriteriaGroupName]): + searchCriteriaGroupName *Optional* + search_criteria_yahoo_id (List[OCI.searchCriteriaYahooId]): searchCriteriaYahooId + *Optional* + search_criteria_user_id (List[OCI.searchCriteriaUserId]): searchCriteriaUserId + *Optional* + search_criteria_imp_id (List[OCI.searchCriteriaImpId]): searchCriteriaImpId + *Optional* + search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* + """ + + __slots__: List[str] = [ + "enterprise_id", + "is_extended_info_requested", + "response_paging_control", + "sort_order", + "search_criteria_user_last_name", + "search_criteria_user_first_name", + "search_criteria_dn", + "search_criteria_group_location_code", + "search_criteria_extension", + "search_criteria_mobile_phone_number", + "search_criteria_email_address", + "search_criteria_exact_user_department", + "search_criteria_department_name", + "search_criteria_exact_user_group", + "search_criteria_group_name", + "search_criteria_yahoo_id", + "search_criteria_user_id", + "search_criteria_imp_id", + "search_criteria_mode_or", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("enterprise_id", "enterpriseId", str, is_required=True), + E( + "is_extended_info_requested", + "isExtendedInfoRequested", + bool, + is_required=True, + ), + E( + "response_paging_control", + "responsePagingControl", + OCI.ResponsePagingControl, is_complex=True, ), - E("report_format", "reportFormat", str), E( - "agent", - "agent", - OCI.CallCenterScheduledReportAgentSelection, + "sort_order", + "sortOrder", + OCI.SortOrderEnterprisePhoneDirectoryGetPagedSortedList, is_complex=True, + is_array=True, ), E( - "call_center", - "callCenter", - OCI.CallCenterScheduledReportCallCenterSelection, + "search_criteria_user_last_name", + "searchCriteriaUserLastName", + OCI.SearchCriteriaUserLastName, is_complex=True, + is_array=True, ), E( - "dnis", - "dnis", - OCI.CallCenterScheduledReportDNISSelection, + "search_criteria_user_first_name", + "searchCriteriaUserFirstName", + OCI.SearchCriteriaUserFirstName, is_complex=True, + is_array=True, ), E( - "call_completion_threshold_seconds", - "callCompletionThresholdSeconds", - int, + "search_criteria_dn", + "searchCriteriaDn", + OCI.SearchCriteriaDn, + is_complex=True, + is_array=True, ), - E("short_duration_threshold_seconds", "shortDurationThresholdSeconds", int), E( - "service_level_threshold_seconds", - "serviceLevelThresholdSeconds", - OCI.CallCenterReportServiceLevelThresholdReplacementList, + "search_criteria_group_location_code", + "searchCriteriaGroupLocationCode", + OCI.SearchCriteriaGroupLocationCode, is_complex=True, + is_array=True, ), E( - "service_level_inclusions", - "serviceLevelInclusions", - OCI.CallCenterScheduledReportServiceLevelInclusionsModify, + "search_criteria_extension", + "searchCriteriaExtension", + OCI.SearchCriteriaExtension, is_complex=True, + is_array=True, ), E( - "service_level_objective_percentage", - "serviceLevelObjectivePercentage", - int, + "search_criteria_mobile_phone_number", + "searchCriteriaMobilePhoneNumber", + OCI.SearchCriteriaMobilePhoneNumber, + is_complex=True, + is_array=True, ), E( - "abandoned_call_threshold_seconds", - "abandonedCallThresholdSeconds", - OCI.CallCenterReportAbandonedCallThresholdReplacementList, + "search_criteria_email_address", + "searchCriteriaEmailAddress", + OCI.SearchCriteriaEmailAddress, is_complex=True, + is_array=True, ), E( - "email_address", - "emailAddress", - OCI.CallCenterReportReplacementEmailList, + "search_criteria_exact_user_department", + "searchCriteriaExactUserDepartment", + OCI.SearchCriteriaExactUserDepartment, + is_complex=True, + ), + E( + "search_criteria_department_name", + "searchCriteriaDepartmentName", + OCI.SearchCriteriaDepartmentName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_exact_user_group", + "searchCriteriaExactUserGroup", + OCI.SearchCriteriaExactUserGroup, + is_complex=True, + ), + E( + "search_criteria_group_name", + "searchCriteriaGroupName", + OCI.SearchCriteriaGroupName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_yahoo_id", + "searchCriteriaYahooId", + OCI.SearchCriteriaYahooId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_id", + "searchCriteriaUserId", + OCI.SearchCriteriaUserId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_imp_id", + "searchCriteriaImpId", + OCI.SearchCriteriaImpId, is_complex=True, + is_array=True, ), + E("search_criteria_mode_or", "searchCriteriaModeOr", bool), ) @@ -147090,6 +143799,358 @@ def _elements(cls) -> Tuple[E, ...]: ) +class GroupAccessDeviceGetPagedSortedListRequest22(OCIRequest): + """ + Requests the list of access devices in a group. + + The response is either `GroupAccessDeviceGetPagedSortedListResponse()` or + `ErrorResponse()`. If no sortOrder is included, the response is sorted by Device Name + ascending by default. If the responsePagingControl element is not provided, the + paging startIndex will be set to 1 by default, and the responsePageSize will be set to + the maximum responsePageSize by default. Multiple search criteria are logically ANDed + together unless the searchCriteriaModeOr option is included. Then the search criteria + are logically ORed together. The getVisualDeviceManagementAPIDevicesOnly element can + only be set when CloudPBX is licenced. If the getVisualDeviceManagementAPIDevicesOnly + element is not set, all devices are returned with Visual Device Management API flag + set to empty. If the getVisualDeviceManagementAPIDevicesOnly element is set to true, + only SIP devices supporting Visual Device Management API are returned. If the + getVisualDeviceManagementAPIDevicesOnly element is set to false, all SIP devices are + returned with their current Visual Device Management API flag value. + + Attributes: + service_provider_id (str): serviceProviderId + group_id (str): groupId + include_total_number_of_rows (bool): includeTotalNumberOfRows *Optional* + response_paging_control (OCI.responsePagingControl): responsePagingControl + *Optional* + sort_order (List[OCI.sortOrder]): sortOrder *Optional* + search_criteria_device_name (List[OCI.searchCriteriaDeviceName]): + searchCriteriaDeviceName *Optional* + search_criteria_device_mac_address (List[OCI.searchCriteriaDeviceMACAddress]): + searchCriteriaDeviceMACAddress *Optional* + search_criteria_device_net_address (List[OCI.searchCriteriaDeviceNetAddress]): + searchCriteriaDeviceNetAddress *Optional* + search_criteria_exact_device_type (List[OCI.searchCriteriaExactDeviceType]): + searchCriteriaExactDeviceType *Optional* + search_criteria_access_device_version + (List[OCI.searchCriteriaAccessDeviceVersion]): + searchCriteriaAccessDeviceVersion *Optional* + search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* + get_visual_device_management_api_devices_only (bool): + getVisualDeviceManagementAPIDevicesOnly *Optional* + """ + + __slots__: List[str] = [ + "service_provider_id", + "group_id", + "include_total_number_of_rows", + "response_paging_control", + "sort_order", + "search_criteria_device_name", + "search_criteria_device_mac_address", + "search_criteria_device_net_address", + "search_criteria_exact_device_type", + "search_criteria_access_device_version", + "search_criteria_mode_or", + "get_visual_device_management_api_devices_only", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("service_provider_id", "serviceProviderId", str, is_required=True), + E("group_id", "groupId", str, is_required=True), + E("include_total_number_of_rows", "includeTotalNumberOfRows", bool), + E( + "response_paging_control", + "responsePagingControl", + OCI.ResponsePagingControl, + is_complex=True, + ), + E( + "sort_order", + "sortOrder", + OCI.SortOrderGroupAccessDeviceGetPagedSortedList, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_device_name", + "searchCriteriaDeviceName", + OCI.SearchCriteriaDeviceName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_device_mac_address", + "searchCriteriaDeviceMACAddress", + OCI.SearchCriteriaDeviceMACAddress, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_device_net_address", + "searchCriteriaDeviceNetAddress", + OCI.SearchCriteriaDeviceNetAddress, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_exact_device_type", + "searchCriteriaExactDeviceType", + OCI.SearchCriteriaExactDeviceType, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_access_device_version", + "searchCriteriaAccessDeviceVersion", + OCI.SearchCriteriaAccessDeviceVersion, + is_complex=True, + is_array=True, + ), + E("search_criteria_mode_or", "searchCriteriaModeOr", bool), + E( + "get_visual_device_management_api_devices_only", + "getVisualDeviceManagementAPIDevicesOnly", + bool, + ), + ) + + +class GroupAdminGetPagedSortedListRequest(OCIRequest): + """ + Get a list of group and department administrators within the group. + + The response is either a `GroupAdminGetPagedSortedListResponse()` or an + `ErrorResponse()`. If no sort criterion is included, the response is sorted by + administrator id ascending by default. If the responsePagingControl element is not + provided, the paging startIndex will be set to 1 by default, and the responsePageSize + will be set to the maximum responsePageSize by default. Multiple search criteria are + logically ANDed together unless the searchCriteriaModeOr option is included. Then the + search criteria are logically ORed together. + + Attributes: + service_provider_id (str): serviceProviderId + group_id (str): groupId + response_paging_control (OCI.responsePagingControl): responsePagingControl + *Optional* + sort_order (List[OCI.sortOrder]): sortOrder *Optional* + search_criteria_admin_id (List[OCI.searchCriteriaAdminId]): searchCriteriaAdminId + *Optional* + search_criteria_admin_last_name (List[OCI.searchCriteriaAdminLastName]): + searchCriteriaAdminLastName *Optional* + search_criteria_admin_first_name (List[OCI.searchCriteriaAdminFirstName]): + searchCriteriaAdminFirstName *Optional* + search_criteria_exact_group_admin_type + (List[OCI.searchCriteriaExactGroupAdminType]): + searchCriteriaExactGroupAdminType *Optional* + search_criteria_language (List[OCI.searchCriteriaLanguage]): + searchCriteriaLanguage *Optional* + search_criteria_department_name (List[OCI.searchCriteriaDepartmentName]): + searchCriteriaDepartmentName *Optional* + search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* + """ + + __slots__: List[str] = [ + "service_provider_id", + "group_id", + "response_paging_control", + "sort_order", + "search_criteria_admin_id", + "search_criteria_admin_last_name", + "search_criteria_admin_first_name", + "search_criteria_exact_group_admin_type", + "search_criteria_language", + "search_criteria_department_name", + "search_criteria_mode_or", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("service_provider_id", "serviceProviderId", str, is_required=True), + E("group_id", "groupId", str, is_required=True), + E( + "response_paging_control", + "responsePagingControl", + OCI.ResponsePagingControl, + is_complex=True, + ), + E( + "sort_order", + "sortOrder", + OCI.SortOrderGroupAdminGetPagedSortedList, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_admin_id", + "searchCriteriaAdminId", + OCI.SearchCriteriaAdminId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_admin_last_name", + "searchCriteriaAdminLastName", + OCI.SearchCriteriaAdminLastName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_admin_first_name", + "searchCriteriaAdminFirstName", + OCI.SearchCriteriaAdminFirstName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_exact_group_admin_type", + "searchCriteriaExactGroupAdminType", + OCI.SearchCriteriaExactGroupAdminType, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_language", + "searchCriteriaLanguage", + OCI.SearchCriteriaLanguage, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_department_name", + "searchCriteriaDepartmentName", + OCI.SearchCriteriaDepartmentName, + is_complex=True, + is_array=True, + ), + E("search_criteria_mode_or", "searchCriteriaModeOr", bool), + ) + + +class GroupAutoAttendantGetInstancePagedSortedListRequest(OCIRequest): + """ + Get a list of Auto Attendant instances within a group. + + The response is either `GroupAutoAttendantGetInstancePagedSortedListResponse()` or + `ErrorResponse()`. If no sortOrder is included the response is sorted by Name + ascending by default. A limitation to the search by DN activation exists when the + Number Activation mode is set to Off. In this case DNs not assigned to users are + never returned by queries with the "dnActivationSearchCriteria" included. If the + responsePagingControl element is not provided, the paging startIndex will be set to 1 + by default, and the responsePageSize will be set to the maximum responsePageSize by + default. Multiple search criteria are logically ANDed together unless the + searchCriteriaModeOr option is included. Then the search criteria are logically ORed + together. + + Attributes: + service_provider_id (str): serviceProviderId + group_id (str): groupId + response_paging_control (OCI.responsePagingControl): responsePagingControl + *Optional* + sort_order (List[OCI.sortOrder]): sortOrder *Optional* + search_criteria_user_id (List[OCI.searchCriteriaUserId]): searchCriteriaUserId + *Optional* + search_criteria_user_last_name (List[OCI.searchCriteriaUserLastName]): + searchCriteriaUserLastName *Optional* + search_criteria_dn (List[OCI.searchCriteriaDn]): searchCriteriaDn *Optional* + search_criteria_extension (List[OCI.searchCriteriaExtension]): + searchCriteriaExtension *Optional* + search_criteria_exact_dn_activation (OCI.searchCriteriaExactDnActivation): + searchCriteriaExactDnActivation *Optional* + search_criteria_service_status (OCI.searchCriteriaServiceStatus): + searchCriteriaServiceStatus *Optional* + search_criteria_exact_auto_attendant_type + (OCI.searchCriteriaExactAutoAttendantType): + searchCriteriaExactAutoAttendantType *Optional* + search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* + """ + + __slots__: List[str] = [ + "service_provider_id", + "group_id", + "response_paging_control", + "sort_order", + "search_criteria_user_id", + "search_criteria_user_last_name", + "search_criteria_dn", + "search_criteria_extension", + "search_criteria_exact_dn_activation", + "search_criteria_service_status", + "search_criteria_exact_auto_attendant_type", + "search_criteria_mode_or", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("service_provider_id", "serviceProviderId", str, is_required=True), + E("group_id", "groupId", str, is_required=True), + E( + "response_paging_control", + "responsePagingControl", + OCI.ResponsePagingControl, + is_complex=True, + ), + E( + "sort_order", + "sortOrder", + OCI.SortOrderGroupAutoAttendantGetInstancePagedSortedList, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_id", + "searchCriteriaUserId", + OCI.SearchCriteriaUserId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_last_name", + "searchCriteriaUserLastName", + OCI.SearchCriteriaUserLastName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_dn", + "searchCriteriaDn", + OCI.SearchCriteriaDn, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_extension", + "searchCriteriaExtension", + OCI.SearchCriteriaExtension, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_exact_dn_activation", + "searchCriteriaExactDnActivation", + OCI.SearchCriteriaExactDnActivation, + is_complex=True, + ), + E( + "search_criteria_service_status", + "searchCriteriaServiceStatus", + OCI.SearchCriteriaServiceStatus, + is_complex=True, + ), + E( + "search_criteria_exact_auto_attendant_type", + "searchCriteriaExactAutoAttendantType", + OCI.SearchCriteriaExactAutoAttendantType, + is_complex=True, + ), + E("search_criteria_mode_or", "searchCriteriaModeOr", bool), + ) + + class GroupAutoAttendantSubmenuAddRequest(OCIRequest): """ Request to add an Auto Attendant submenu instance. @@ -147292,6 +144353,286 @@ def _elements(cls) -> Tuple[E, ...]: ) +class GroupCallCenterAgentThresholdProfileGetAvailableAgentPagedSortedListRequest( + OCIRequest, +): + """ + Get the list of all Agents in the Group that can be assigned to a given Call Center + Agent Threshold Profile in a Group. + + An agent is available to be assigned to a given Agent Threshold Profile if it is a + Call Center Standard or Call Center Premium agent and the agent is not yet assigned to + the profile. If the responsePagingControl element is not provided, the paging + startIndex will be set to 1 by default, and the responsePageSize will be set to the + maximum ResponsePageSize by default. It is possible to search by various criteria to + restrict the number of rows returned. The available agent list for a new Call Center + Agent Threshold profile can be obtained by not setting the + excludeAgentsAssignedToProfileName. When the excludeAgentsAssignedToProfileName is + specified, all agents already assigned to the specified profile are not included in + the response, even if the search criterion element searchCriteriaAgentThresholdProfile + is specified using the same profile name. If no sortOrder is included the response is + sorted by User Id ascending by default. Multiple search criteria are logically ANDed + together unless the searchCriteriaModeOr option is included. Then the search criteria + are logically ORed together. + + The response is either a + `GroupCallCenterAgentThresholdProfileGetAvailableAgentPagedSortedListResponse()` or an + `ErrorResponse()`. + + Attributes: + service_provider_id (str): serviceProviderId + group_id (str): groupId + exclude_agents_assigned_to_profile_name (str): excludeAgentsAssignedToProfileName + *Optional* + response_paging_control (OCI.responsePagingControl): responsePagingControl + *Optional* + sort_order (List[OCI.sortOrder]): sortOrder *Optional* + search_criteria_user_id (List[OCI.searchCriteriaUserId]): searchCriteriaUserId + *Optional* + search_criteria_user_last_name (List[OCI.searchCriteriaUserLastName]): + searchCriteriaUserLastName *Optional* + search_criteria_user_first_name (List[OCI.searchCriteriaUserFirstName]): + searchCriteriaUserFirstName *Optional* + search_criteria_dn (List[OCI.searchCriteriaDn]): searchCriteriaDn *Optional* + search_criteria_extension (List[OCI.searchCriteriaExtension]): + searchCriteriaExtension *Optional* + search_criteria_department_name (List[OCI.searchCriteriaDepartmentName]): + searchCriteriaDepartmentName *Optional* + search_criteria_email_address (List[OCI.searchCriteriaEmailAddress]): + searchCriteriaEmailAddress *Optional* + search_criteria_agent_threshold_profile + (List[OCI.searchCriteriaAgentThresholdProfile]): + searchCriteriaAgentThresholdProfile *Optional* + search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* + """ + + __slots__: List[str] = [ + "service_provider_id", + "group_id", + "exclude_agents_assigned_to_profile_name", + "response_paging_control", + "sort_order", + "search_criteria_user_id", + "search_criteria_user_last_name", + "search_criteria_user_first_name", + "search_criteria_dn", + "search_criteria_extension", + "search_criteria_department_name", + "search_criteria_email_address", + "search_criteria_agent_threshold_profile", + "search_criteria_mode_or", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("service_provider_id", "serviceProviderId", str, is_required=True), + E("group_id", "groupId", str, is_required=True), + E( + "exclude_agents_assigned_to_profile_name", + "excludeAgentsAssignedToProfileName", + str, + ), + E( + "response_paging_control", + "responsePagingControl", + OCI.ResponsePagingControl, + is_complex=True, + ), + E( + "sort_order", + "sortOrder", + OCI.SortOrderGroupCallCenterAgentThresholdProfileGetAvailableAgentPagedSortedList, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_id", + "searchCriteriaUserId", + OCI.SearchCriteriaUserId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_last_name", + "searchCriteriaUserLastName", + OCI.SearchCriteriaUserLastName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_first_name", + "searchCriteriaUserFirstName", + OCI.SearchCriteriaUserFirstName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_dn", + "searchCriteriaDn", + OCI.SearchCriteriaDn, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_extension", + "searchCriteriaExtension", + OCI.SearchCriteriaExtension, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_department_name", + "searchCriteriaDepartmentName", + OCI.SearchCriteriaDepartmentName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_email_address", + "searchCriteriaEmailAddress", + OCI.SearchCriteriaEmailAddress, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_agent_threshold_profile", + "searchCriteriaAgentThresholdProfile", + OCI.SearchCriteriaAgentThresholdProfile, + is_complex=True, + is_array=True, + ), + E("search_criteria_mode_or", "searchCriteriaModeOr", bool), + ) + + +class GroupCallCenterAgentThresholdProfileGetPagedSortedRequest(OCIRequest): + """ + Gets an existing non-default Call Center Agent Threshold Profile in a Group. + + If the responsePagingControl element is not provided, the paging startIndex will be + set to 1 by default, and the responsePageSize will be set to the maximum + ResponsePageSize by default. It is possible to search by various criteria to restrict + the number of rows returned. If no sortOrder is included the response is sorted by + User Id ascending by default. Multiple search criteria are logically ANDed together + unless the searchCriteriaModeOr option is included. Then the search criteria are + logically ORed together. + + The response is either a + `GroupCallCenterAgentThresholdProfileGetPagedSortedResponse()` or an + `ErrorResponse()`. + + Attributes: + service_provider_id (str): serviceProviderId + group_id (str): groupId + profile_name (str): profileName + response_paging_control (OCI.responsePagingControl): responsePagingControl + *Optional* + sort_order (List[OCI.sortOrder]): sortOrder *Optional* + search_criteria_user_id (List[OCI.searchCriteriaUserId]): searchCriteriaUserId + *Optional* + search_criteria_user_last_name (List[OCI.searchCriteriaUserLastName]): + searchCriteriaUserLastName *Optional* + search_criteria_user_first_name (List[OCI.searchCriteriaUserFirstName]): + searchCriteriaUserFirstName *Optional* + search_criteria_dn (List[OCI.searchCriteriaDn]): searchCriteriaDn *Optional* + search_criteria_extension (List[OCI.searchCriteriaExtension]): + searchCriteriaExtension *Optional* + search_criteria_department_name (List[OCI.searchCriteriaDepartmentName]): + searchCriteriaDepartmentName *Optional* + search_criteria_email_address (List[OCI.searchCriteriaEmailAddress]): + searchCriteriaEmailAddress *Optional* + search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* + """ + + __slots__: List[str] = [ + "service_provider_id", + "group_id", + "profile_name", + "response_paging_control", + "sort_order", + "search_criteria_user_id", + "search_criteria_user_last_name", + "search_criteria_user_first_name", + "search_criteria_dn", + "search_criteria_extension", + "search_criteria_department_name", + "search_criteria_email_address", + "search_criteria_mode_or", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("service_provider_id", "serviceProviderId", str, is_required=True), + E("group_id", "groupId", str, is_required=True), + E("profile_name", "profileName", str, is_required=True), + E( + "response_paging_control", + "responsePagingControl", + OCI.ResponsePagingControl, + is_complex=True, + ), + E( + "sort_order", + "sortOrder", + OCI.SortOrderGroupCallCenterAgentThresholdProfileGetPagedSorted, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_id", + "searchCriteriaUserId", + OCI.SearchCriteriaUserId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_last_name", + "searchCriteriaUserLastName", + OCI.SearchCriteriaUserLastName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_first_name", + "searchCriteriaUserFirstName", + OCI.SearchCriteriaUserFirstName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_dn", + "searchCriteriaDn", + OCI.SearchCriteriaDn, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_extension", + "searchCriteriaExtension", + OCI.SearchCriteriaExtension, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_department_name", + "searchCriteriaDepartmentName", + OCI.SearchCriteriaDepartmentName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_email_address", + "searchCriteriaEmailAddress", + OCI.SearchCriteriaEmailAddress, + is_complex=True, + is_array=True, + ), + E("search_criteria_mode_or", "searchCriteriaModeOr", bool), + ) + + class GroupCallCenterEnhancedReportingScheduledReportAddRequest(OCIRequest): """ Request to add a group level call center reporting scheduled report. @@ -147452,57 +144793,330 @@ class GroupCallCenterEnhancedReportingScheduledReportModifyRequest(OCIRequest): Attributes: service_provider_id (str): serviceProviderId group_id (str): groupId - name (str): name - new_name (str): newName *Optional* - description (str): description *Optional* - schedule (OCI.schedule): schedule *Optional* - sampling_period (str): samplingPeriod *Optional* - start_day_of_week (str): startDayOfWeek *Optional* - report_time_zone (str): reportTimeZone *Optional* - report_date_format (str): reportDateFormat *Optional* - report_time_format (str): reportTimeFormat *Optional* - report_interval (OCI.reportInterval): reportInterval *Optional* - report_format (str): reportFormat *Optional* - agent (OCI.agent): agent *Optional* - call_center (OCI.callCenter): callCenter *Optional* - dnis (OCI.dnis): dnis *Optional* - call_completion_threshold_seconds (int): callCompletionThresholdSeconds *Optional* - short_duration_threshold_seconds (int): shortDurationThresholdSeconds *Optional* - service_level_threshold_seconds (OCI.serviceLevelThresholdSeconds): - serviceLevelThresholdSeconds *Optional* - service_level_inclusions (OCI.serviceLevelInclusions): serviceLevelInclusions + name (str): name + new_name (str): newName *Optional* + description (str): description *Optional* + schedule (OCI.schedule): schedule *Optional* + sampling_period (str): samplingPeriod *Optional* + start_day_of_week (str): startDayOfWeek *Optional* + report_time_zone (str): reportTimeZone *Optional* + report_date_format (str): reportDateFormat *Optional* + report_time_format (str): reportTimeFormat *Optional* + report_interval (OCI.reportInterval): reportInterval *Optional* + report_format (str): reportFormat *Optional* + agent (OCI.agent): agent *Optional* + call_center (OCI.callCenter): callCenter *Optional* + dnis (OCI.dnis): dnis *Optional* + call_completion_threshold_seconds (int): callCompletionThresholdSeconds *Optional* + short_duration_threshold_seconds (int): shortDurationThresholdSeconds *Optional* + service_level_threshold_seconds (OCI.serviceLevelThresholdSeconds): + serviceLevelThresholdSeconds *Optional* + service_level_inclusions (OCI.serviceLevelInclusions): serviceLevelInclusions + *Optional* + service_level_objective_percentage (int): serviceLevelObjectivePercentage + *Optional* + abandoned_call_threshold_seconds (OCI.abandonedCallThresholdSeconds): + abandonedCallThresholdSeconds *Optional* + email_address (OCI.emailAddress): emailAddress *Optional* + """ + + __slots__: List[str] = [ + "service_provider_id", + "group_id", + "name", + "new_name", + "description", + "schedule", + "sampling_period", + "start_day_of_week", + "report_time_zone", + "report_date_format", + "report_time_format", + "report_interval", + "report_format", + "agent", + "call_center", + "dnis", + "call_completion_threshold_seconds", + "short_duration_threshold_seconds", + "service_level_threshold_seconds", + "service_level_inclusions", + "service_level_objective_percentage", + "abandoned_call_threshold_seconds", + "email_address", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("service_provider_id", "serviceProviderId", str, is_required=True), + E("group_id", "groupId", str, is_required=True), + E("name", "name", str, is_required=True), + E("new_name", "newName", str), + E("description", "description", str), + E("schedule", "schedule", OCI.CallCenterReportSchedule, is_complex=True), + E("sampling_period", "samplingPeriod", str), + E("start_day_of_week", "startDayOfWeek", str), + E("report_time_zone", "reportTimeZone", str), + E("report_date_format", "reportDateFormat", str), + E("report_time_format", "reportTimeFormat", str), + E( + "report_interval", + "reportInterval", + OCI.CallCenterReportInterval, + is_complex=True, + ), + E("report_format", "reportFormat", str), + E( + "agent", + "agent", + OCI.CallCenterScheduledReportAgentSelection, + is_complex=True, + ), + E( + "call_center", + "callCenter", + OCI.CallCenterScheduledReportCallCenterSelection, + is_complex=True, + ), + E( + "dnis", + "dnis", + OCI.CallCenterScheduledReportDNISSelection, + is_complex=True, + ), + E( + "call_completion_threshold_seconds", + "callCompletionThresholdSeconds", + int, + ), + E("short_duration_threshold_seconds", "shortDurationThresholdSeconds", int), + E( + "service_level_threshold_seconds", + "serviceLevelThresholdSeconds", + OCI.CallCenterReportServiceLevelThresholdReplacementList, + is_complex=True, + ), + E( + "service_level_inclusions", + "serviceLevelInclusions", + OCI.CallCenterScheduledReportServiceLevelInclusionsModify, + is_complex=True, + ), + E( + "service_level_objective_percentage", + "serviceLevelObjectivePercentage", + int, + ), + E( + "abandoned_call_threshold_seconds", + "abandonedCallThresholdSeconds", + OCI.CallCenterReportAbandonedCallThresholdReplacementList, + is_complex=True, + ), + E( + "email_address", + "emailAddress", + OCI.CallCenterReportReplacementEmailList, + is_complex=True, + ), + ) + + +class GroupCallCenterGetAvailableAgentPagedSortedListRequest(OCIRequest): + """ + Get a list of users that can be assigned as agents to a given type of Call Center. + + Searching for users by group only makes sense when the call center is part of an + Enterprise. If the responsePagingControl element is not provided, the paging + startIndex will be set to 1 by default, and the responsePageSize will be set to the + maximum ResponsePageSize by default. It is possible to search by various criteria to + restrict the number of rows returned. If no sortOrder is included the response is + sorted by User Id ascending by default. Multiple search criteria are logically ANDed + together unless the searchCriteriaModeOr option is included. Then the search criteria + are logically ORed together. `ErrorResponse()` is returned if + searchCriteriaExactUserGroup has multiple entries and searchCriteriaModeOr is not + included. + + The response is either `GroupCallCenterGetAvailableAgentPagedSortedListResponse()` or + `ErrorResponse()`. + + Attributes: + service_provider_id (str): serviceProviderId + group_id (str): groupId + call_center_type (str): callCenterType + response_paging_control (OCI.responsePagingControl): responsePagingControl + *Optional* + sort_order (List[OCI.sortOrder]): sortOrder *Optional* + search_criteria_user_id (List[OCI.searchCriteriaUserId]): searchCriteriaUserId + *Optional* + search_criteria_user_last_name (List[OCI.searchCriteriaUserLastName]): + searchCriteriaUserLastName *Optional* + search_criteria_user_first_name (List[OCI.searchCriteriaUserFirstName]): + searchCriteriaUserFirstName *Optional* + search_criteria_dn (List[OCI.searchCriteriaDn]): searchCriteriaDn *Optional* + search_criteria_extension (List[OCI.searchCriteriaExtension]): + searchCriteriaExtension *Optional* + search_criteria_department_name (List[OCI.searchCriteriaDepartmentName]): + searchCriteriaDepartmentName *Optional* + search_criteria_email_address (List[OCI.searchCriteriaEmailAddress]): + searchCriteriaEmailAddress *Optional* + search_criteria_exact_user_group (List[OCI.searchCriteriaExactUserGroup]): + searchCriteriaExactUserGroup *Optional* + search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* + """ + + __slots__: List[str] = [ + "service_provider_id", + "group_id", + "call_center_type", + "response_paging_control", + "sort_order", + "search_criteria_user_id", + "search_criteria_user_last_name", + "search_criteria_user_first_name", + "search_criteria_dn", + "search_criteria_extension", + "search_criteria_department_name", + "search_criteria_email_address", + "search_criteria_exact_user_group", + "search_criteria_mode_or", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("service_provider_id", "serviceProviderId", str, is_required=True), + E("group_id", "groupId", str, is_required=True), + E("call_center_type", "callCenterType", str, is_required=True), + E( + "response_paging_control", + "responsePagingControl", + OCI.ResponsePagingControl, + is_complex=True, + ), + E( + "sort_order", + "sortOrder", + OCI.SortOrderGroupCallCenterGetAvailableAgentPagedSortedList, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_id", + "searchCriteriaUserId", + OCI.SearchCriteriaUserId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_last_name", + "searchCriteriaUserLastName", + OCI.SearchCriteriaUserLastName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_first_name", + "searchCriteriaUserFirstName", + OCI.SearchCriteriaUserFirstName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_dn", + "searchCriteriaDn", + OCI.SearchCriteriaDn, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_extension", + "searchCriteriaExtension", + OCI.SearchCriteriaExtension, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_department_name", + "searchCriteriaDepartmentName", + OCI.SearchCriteriaDepartmentName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_email_address", + "searchCriteriaEmailAddress", + OCI.SearchCriteriaEmailAddress, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_exact_user_group", + "searchCriteriaExactUserGroup", + OCI.SearchCriteriaExactUserGroup, + is_complex=True, + is_array=True, + ), + E("search_criteria_mode_or", "searchCriteriaModeOr", bool), + ) + + +class GroupCallCenterGetInstancePagedSortedListRequest(OCIRequest): + """ + Get a list of Call Center instances within a group. + + The response is either `GroupCallCenterGetInstancePagedSortedListResponse()` or + `ErrorResponse()`. It is possible to get the instances within a specified department. + If the responsePagingControl element is not provided, the paging startIndex will be + set to 1 by default, and the responsePageSize will be set to the maximum + ResponsePageSize by default. It is possible to search by various criteria to restrict + the number of rows returned. If no sortOrder is included the response is sorted by + User Id ascending by default. Multiple search criteria are logically ANDed together + unless the searchCriteriaModeOr option is included. Then the search criteria are + logically ORed together. `ErrorResponse()` is returned if + searchCriteriaExactHuntPolicy or searchCriteriaExactCallCenterType have multiple + entries and searchCriteriaModeOr is not include. + + Attributes: + service_provider_id (str): serviceProviderId + group_id (str): groupId + response_paging_control (OCI.responsePagingControl): responsePagingControl *Optional* - service_level_objective_percentage (int): serviceLevelObjectivePercentage + sort_order (List[OCI.sortOrder]): sortOrder *Optional* + search_criteria_user_id (List[OCI.searchCriteriaUserId]): searchCriteriaUserId *Optional* - abandoned_call_threshold_seconds (OCI.abandonedCallThresholdSeconds): - abandonedCallThresholdSeconds *Optional* - email_address (OCI.emailAddress): emailAddress *Optional* + search_criteria_call_center_name (List[OCI.searchCriteriaCallCenterName]): + searchCriteriaCallCenterName *Optional* + search_criteria_dn (List[OCI.searchCriteriaDn]): searchCriteriaDn *Optional* + search_criteria_extension (List[OCI.searchCriteriaExtension]): + searchCriteriaExtension *Optional* + search_criteria_department_name (List[OCI.searchCriteriaDepartmentName]): + searchCriteriaDepartmentName *Optional* + search_criteria_service_status (OCI.searchCriteriaServiceStatus): + searchCriteriaServiceStatus *Optional* + search_criteria_exact_hunt_policy (List[OCI.searchCriteriaExactHuntPolicy]): + searchCriteriaExactHuntPolicy *Optional* + search_criteria_exact_call_center_type + (List[OCI.searchCriteriaExactCallCenterType]): + searchCriteriaExactCallCenterType *Optional* + search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* """ __slots__: List[str] = [ "service_provider_id", "group_id", - "name", - "new_name", - "description", - "schedule", - "sampling_period", - "start_day_of_week", - "report_time_zone", - "report_date_format", - "report_time_format", - "report_interval", - "report_format", - "agent", - "call_center", - "dnis", - "call_completion_threshold_seconds", - "short_duration_threshold_seconds", - "service_level_threshold_seconds", - "service_level_inclusions", - "service_level_objective_percentage", - "abandoned_call_threshold_seconds", - "email_address", + "response_paging_control", + "sort_order", + "search_criteria_user_id", + "search_criteria_call_center_name", + "search_criteria_dn", + "search_criteria_extension", + "search_criteria_department_name", + "search_criteria_service_status", + "search_criteria_exact_hunt_policy", + "search_criteria_exact_call_center_type", + "search_criteria_mode_or", ] @classmethod @@ -147510,75 +145124,75 @@ def _elements(cls) -> Tuple[E, ...]: return ( E("service_provider_id", "serviceProviderId", str, is_required=True), E("group_id", "groupId", str, is_required=True), - E("name", "name", str, is_required=True), - E("new_name", "newName", str), - E("description", "description", str), - E("schedule", "schedule", OCI.CallCenterReportSchedule, is_complex=True), - E("sampling_period", "samplingPeriod", str), - E("start_day_of_week", "startDayOfWeek", str), - E("report_time_zone", "reportTimeZone", str), - E("report_date_format", "reportDateFormat", str), - E("report_time_format", "reportTimeFormat", str), E( - "report_interval", - "reportInterval", - OCI.CallCenterReportInterval, + "response_paging_control", + "responsePagingControl", + OCI.ResponsePagingControl, is_complex=True, ), - E("report_format", "reportFormat", str), E( - "agent", - "agent", - OCI.CallCenterScheduledReportAgentSelection, + "sort_order", + "sortOrder", + OCI.SortOrderGroupCallCenterGetInstancePagedSortedList, is_complex=True, + is_array=True, ), E( - "call_center", - "callCenter", - OCI.CallCenterScheduledReportCallCenterSelection, + "search_criteria_user_id", + "searchCriteriaUserId", + OCI.SearchCriteriaUserId, is_complex=True, + is_array=True, ), E( - "dnis", - "dnis", - OCI.CallCenterScheduledReportDNISSelection, + "search_criteria_call_center_name", + "searchCriteriaCallCenterName", + OCI.SearchCriteriaCallCenterName, is_complex=True, + is_array=True, ), E( - "call_completion_threshold_seconds", - "callCompletionThresholdSeconds", - int, + "search_criteria_dn", + "searchCriteriaDn", + OCI.SearchCriteriaDn, + is_complex=True, + is_array=True, ), - E("short_duration_threshold_seconds", "shortDurationThresholdSeconds", int), E( - "service_level_threshold_seconds", - "serviceLevelThresholdSeconds", - OCI.CallCenterReportServiceLevelThresholdReplacementList, + "search_criteria_extension", + "searchCriteriaExtension", + OCI.SearchCriteriaExtension, is_complex=True, + is_array=True, ), E( - "service_level_inclusions", - "serviceLevelInclusions", - OCI.CallCenterScheduledReportServiceLevelInclusionsModify, + "search_criteria_department_name", + "searchCriteriaDepartmentName", + OCI.SearchCriteriaDepartmentName, is_complex=True, + is_array=True, ), E( - "service_level_objective_percentage", - "serviceLevelObjectivePercentage", - int, + "search_criteria_service_status", + "searchCriteriaServiceStatus", + OCI.SearchCriteriaServiceStatus, + is_complex=True, ), E( - "abandoned_call_threshold_seconds", - "abandonedCallThresholdSeconds", - OCI.CallCenterReportAbandonedCallThresholdReplacementList, + "search_criteria_exact_hunt_policy", + "searchCriteriaExactHuntPolicy", + OCI.SearchCriteriaExactHuntPolicy, is_complex=True, + is_array=True, ), E( - "email_address", - "emailAddress", - OCI.CallCenterReportReplacementEmailList, + "search_criteria_exact_call_center_type", + "searchCriteriaExactCallCenterType", + OCI.SearchCriteriaExactCallCenterType, is_complex=True, + is_array=True, ), + E("search_criteria_mode_or", "searchCriteriaModeOr", bool), ) @@ -148445,251 +146059,1214 @@ class GroupCallCenterModifyDNISAnnouncementRequest20(OCIRequest): @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("dnis_key", "dnisKey", OCI.DNISKey, is_complex=True, is_required=True), - E("play_entrance_message", "playEntranceMessage", bool), - E("mandatory_entrance_message", "mandatoryEntranceMessage", bool), - E("entrance_audio_message_selection", "entranceAudioMessageSelection", str), + E("dnis_key", "dnisKey", OCI.DNISKey, is_complex=True, is_required=True), + E("play_entrance_message", "playEntranceMessage", bool), + E("mandatory_entrance_message", "mandatoryEntranceMessage", bool), + E("entrance_audio_message_selection", "entranceAudioMessageSelection", str), + E( + "entrance_message_audio_url_list", + "entranceMessageAudioUrlList", + OCI.CallCenterAnnouncementURLListModify, + is_complex=True, + ), + E( + "entrance_message_audio_file_list", + "entranceMessageAudioFileList", + OCI.CallCenterAnnouncementFileListModify20, + is_complex=True, + ), + E("entrance_video_message_selection", "entranceVideoMessageSelection", str), + E( + "entrance_message_video_url_list", + "entranceMessageVideoUrlList", + OCI.CallCenterAnnouncementURLListModify, + is_complex=True, + ), + E( + "entrance_message_video_file_list", + "entranceMessageVideoFileList", + OCI.CallCenterAnnouncementFileListModify20, + is_complex=True, + ), + E("play_periodic_comfort_message", "playPeriodicComfortMessage", bool), + E( + "time_between_comfort_messages_seconds", + "timeBetweenComfortMessagesSeconds", + int, + ), + E( + "periodic_comfort_audio_message_selection", + "periodicComfortAudioMessageSelection", + str, + ), + E( + "periodic_comfort_message_audio_url_list", + "periodicComfortMessageAudioUrlList", + OCI.CallCenterAnnouncementURLListModify, + is_complex=True, + ), + E( + "periodic_comfort_message_audio_file_list", + "periodicComfortMessageAudioFileList", + OCI.CallCenterAnnouncementFileListModify20, + is_complex=True, + ), + E( + "periodic_comfort_video_message_selection", + "periodicComfortVideoMessageSelection", + str, + ), + E( + "periodic_comfort_message_video_url_list", + "periodicComfortMessageVideoUrlList", + OCI.CallCenterAnnouncementURLListModify, + is_complex=True, + ), + E( + "periodic_comfort_message_video_file_list", + "periodicComfortMessageVideoFileList", + OCI.CallCenterAnnouncementFileListModify20, + is_complex=True, + ), + E( + "enable_media_on_hold_for_queued_calls", + "enableMediaOnHoldForQueuedCalls", + bool, + ), + E( + "media_on_hold_source", + "mediaOnHoldSource", + OCI.CallCenterMediaOnHoldSourceModify20, + is_complex=True, + ), + E("play_whisper_message", "playWhisperMessage", bool), + E("whisper_audio_message_selection", "whisperAudioMessageSelection", str), + E( + "whisper_message_audio_url_list", + "whisperMessageAudioUrlList", + OCI.CallCenterAnnouncementURLListModify, + is_complex=True, + ), + E( + "whisper_message_audio_file_list", + "whisperMessageAudioFileList", + OCI.CallCenterAnnouncementFileListModify20, + is_complex=True, + ), + E("whisper_video_message_selection", "whisperVideoMessageSelection", str), + E( + "whisper_message_video_url_list", + "whisperMessageVideoUrlList", + OCI.CallCenterAnnouncementURLListModify, + is_complex=True, + ), + E( + "whisper_message_video_file_list", + "whisperMessageVideoFileList", + OCI.CallCenterAnnouncementFileListModify20, + is_complex=True, + ), + E( + "estimated_wait_message_options_modify", + "estimatedWaitMessageOptionsModify", + OCI.EstimatedWaitMessageOptionsModify, + is_complex=True, + ), + ) + + +class GroupCallParkGetAvailableAlternateRecallUserPagedSortedListRequest(OCIRequest): + """ + Get a list of hunt groups that are available to select as an alternate recall user. + + If the responsePagingControl element is not provided, the paging startIndex will be + set to 1 by default, and the responsePageSize will be set to the maximum + ResponsePageSize by default. It is possible to search by various criteria to restrict + the number of rows returned. If no sortOrder is included the response is sorted by + User Id ascending by default. Multiple search criteria are logically ANDed together + unless the searchCriteriaModeOr option is included. Then the search criteria are + logically ORed together. + + The response is either + `GroupCallParkGetAvailableAlternateRecallUserPagedSortedListResponse()` or + `ErrorResponse()`. + + Attributes: + service_provider_id (str): serviceProviderId + group_id (str): groupId + response_paging_control (OCI.responsePagingControl): responsePagingControl + *Optional* + sort_order (List[OCI.sortOrder]): sortOrder *Optional* + search_criteria_user_id (List[OCI.searchCriteriaUserId]): searchCriteriaUserId + *Optional* + search_criteria_user_last_name (List[OCI.searchCriteriaUserLastName]): + searchCriteriaUserLastName *Optional* + search_criteria_user_first_name (List[OCI.searchCriteriaUserFirstName]): + searchCriteriaUserFirstName *Optional* + search_criteria_dn (List[OCI.searchCriteriaDn]): searchCriteriaDn *Optional* + search_criteria_extension (List[OCI.searchCriteriaExtension]): + searchCriteriaExtension *Optional* + search_criteria_department_name (List[OCI.searchCriteriaDepartmentName]): + searchCriteriaDepartmentName *Optional* + search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* + """ + + __slots__: List[str] = [ + "service_provider_id", + "group_id", + "response_paging_control", + "sort_order", + "search_criteria_user_id", + "search_criteria_user_last_name", + "search_criteria_user_first_name", + "search_criteria_dn", + "search_criteria_extension", + "search_criteria_department_name", + "search_criteria_mode_or", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("service_provider_id", "serviceProviderId", str, is_required=True), + E("group_id", "groupId", str, is_required=True), + E( + "response_paging_control", + "responsePagingControl", + OCI.ResponsePagingControl, + is_complex=True, + ), + E( + "sort_order", + "sortOrder", + OCI.SortOrderGroupCallParkGetAvailableAlternateRecallUserPagedSortedList, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_id", + "searchCriteriaUserId", + OCI.SearchCriteriaUserId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_last_name", + "searchCriteriaUserLastName", + OCI.SearchCriteriaUserLastName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_first_name", + "searchCriteriaUserFirstName", + OCI.SearchCriteriaUserFirstName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_dn", + "searchCriteriaDn", + OCI.SearchCriteriaDn, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_extension", + "searchCriteriaExtension", + OCI.SearchCriteriaExtension, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_department_name", + "searchCriteriaDepartmentName", + OCI.SearchCriteriaDepartmentName, + is_complex=True, + is_array=True, + ), + E("search_criteria_mode_or", "searchCriteriaModeOr", bool), + ) + + +class GroupCallParkGetAvailableUserPagedSortedListRequest(OCIRequest): + """ + Get a list of users that can be assigned to a Call Park group. + + The available user list for a new Call Park group can be obtained by not setting the + name. If the responsePagingControl element is not provided, the paging startIndex + will be set to 1 by default, and the responsePageSize will be set to the maximum + ResponsePageSize by default. It is possible to search by various criteria to restrict + the number of rows returned. If no sortOrder is included the response is sorted by + User Id ascending by default. Multiple search criteria are logically ANDed together + unless the searchCriteriaModeOr option is included. Then the search criteria are + logically ORed together. + + The response is either `GroupCallParkGetAvailableUserPagedSortedListResponse()` or + `ErrorResponse()`. + + Attributes: + service_provider_id (str): serviceProviderId + group_id (str): groupId + name (str): name *Optional* + response_paging_control (OCI.responsePagingControl): responsePagingControl + *Optional* + sort_order (List[OCI.sortOrder]): sortOrder *Optional* + search_criteria_user_id (List[OCI.searchCriteriaUserId]): searchCriteriaUserId + *Optional* + search_criteria_user_last_name (List[OCI.searchCriteriaUserLastName]): + searchCriteriaUserLastName *Optional* + search_criteria_user_first_name (List[OCI.searchCriteriaUserFirstName]): + searchCriteriaUserFirstName *Optional* + search_criteria_dn (List[OCI.searchCriteriaDn]): searchCriteriaDn *Optional* + search_criteria_extension (List[OCI.searchCriteriaExtension]): + searchCriteriaExtension *Optional* + search_criteria_department_name (List[OCI.searchCriteriaDepartmentName]): + searchCriteriaDepartmentName *Optional* + search_criteria_email_address (List[OCI.searchCriteriaEmailAddress]): + searchCriteriaEmailAddress *Optional* + search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* + """ + + __slots__: List[str] = [ + "service_provider_id", + "group_id", + "name", + "response_paging_control", + "sort_order", + "search_criteria_user_id", + "search_criteria_user_last_name", + "search_criteria_user_first_name", + "search_criteria_dn", + "search_criteria_extension", + "search_criteria_department_name", + "search_criteria_email_address", + "search_criteria_mode_or", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("service_provider_id", "serviceProviderId", str, is_required=True), + E("group_id", "groupId", str, is_required=True), + E("name", "name", str), + E( + "response_paging_control", + "responsePagingControl", + OCI.ResponsePagingControl, + is_complex=True, + ), + E( + "sort_order", + "sortOrder", + OCI.SortOrderGroupCallParkGetAvailableUserPagedSortedList, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_id", + "searchCriteriaUserId", + OCI.SearchCriteriaUserId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_last_name", + "searchCriteriaUserLastName", + OCI.SearchCriteriaUserLastName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_first_name", + "searchCriteriaUserFirstName", + OCI.SearchCriteriaUserFirstName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_dn", + "searchCriteriaDn", + OCI.SearchCriteriaDn, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_extension", + "searchCriteriaExtension", + OCI.SearchCriteriaExtension, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_department_name", + "searchCriteriaDepartmentName", + OCI.SearchCriteriaDepartmentName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_email_address", + "searchCriteriaEmailAddress", + OCI.SearchCriteriaEmailAddress, + is_complex=True, + is_array=True, + ), + E("search_criteria_mode_or", "searchCriteriaModeOr", bool), + ) + + +class GroupCallPickupGetAvailableUserPagedSortedListRequest(OCIRequest): + """ + Get a list of users that can be assigned to a Call Pickup group. + + The available user list for a new Call Pickup group can be obtained by not setting the + name. If the responsePagingControl element is not provided, the paging startIndex + will be set to 1 by default, and the responsePageSize will be set to the maximum + ResponsePageSize by default. It is possible to search by various criteria to restrict + the number of rows returned. If no sortOrder is included the response is sorted by + User Id ascending by default. Multiple search criteria are logically ANDed together + unless the searchCriteriaModeOr option is included. Then the search criteria are + logically ORed together. + + The response is either `GroupCallPickupGetAvailableUserPagedSortedListResponse()` or + `ErrorResponse()`. + + Attributes: + service_provider_id (str): serviceProviderId + group_id (str): groupId + name (str): name *Optional* + response_paging_control (OCI.responsePagingControl): responsePagingControl + *Optional* + sort_order (List[OCI.sortOrder]): sortOrder *Optional* + search_criteria_user_id (List[OCI.searchCriteriaUserId]): searchCriteriaUserId + *Optional* + search_criteria_user_last_name (List[OCI.searchCriteriaUserLastName]): + searchCriteriaUserLastName *Optional* + search_criteria_user_first_name (List[OCI.searchCriteriaUserFirstName]): + searchCriteriaUserFirstName *Optional* + search_criteria_dn (List[OCI.searchCriteriaDn]): searchCriteriaDn *Optional* + search_criteria_extension (List[OCI.searchCriteriaExtension]): + searchCriteriaExtension *Optional* + search_criteria_department_name (List[OCI.searchCriteriaDepartmentName]): + searchCriteriaDepartmentName *Optional* + search_criteria_email_address (List[OCI.searchCriteriaEmailAddress]): + searchCriteriaEmailAddress *Optional* + search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* + """ + + __slots__: List[str] = [ + "service_provider_id", + "group_id", + "name", + "response_paging_control", + "sort_order", + "search_criteria_user_id", + "search_criteria_user_last_name", + "search_criteria_user_first_name", + "search_criteria_dn", + "search_criteria_extension", + "search_criteria_department_name", + "search_criteria_email_address", + "search_criteria_mode_or", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("service_provider_id", "serviceProviderId", str, is_required=True), + E("group_id", "groupId", str, is_required=True), + E("name", "name", str), + E( + "response_paging_control", + "responsePagingControl", + OCI.ResponsePagingControl, + is_complex=True, + ), + E( + "sort_order", + "sortOrder", + OCI.SortOrderGroupCallPickupGetAvailableUserPagedSortedList, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_id", + "searchCriteriaUserId", + OCI.SearchCriteriaUserId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_last_name", + "searchCriteriaUserLastName", + OCI.SearchCriteriaUserLastName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_first_name", + "searchCriteriaUserFirstName", + OCI.SearchCriteriaUserFirstName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_dn", + "searchCriteriaDn", + OCI.SearchCriteriaDn, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_extension", + "searchCriteriaExtension", + OCI.SearchCriteriaExtension, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_department_name", + "searchCriteriaDepartmentName", + OCI.SearchCriteriaDepartmentName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_email_address", + "searchCriteriaEmailAddress", + OCI.SearchCriteriaEmailAddress, + is_complex=True, + is_array=True, + ), + E("search_criteria_mode_or", "searchCriteriaModeOr", bool), + ) + + +class GroupCallPickupGetInstancePagedSortedRequest(OCIRequest): + """ + Gets a Call Pickup group. + + If the responsePagingControl element is not provided, the paging startIndex will be + set to 1 by default, and the responsePageSize will be set to the maximum + ResponsePageSize by default. It is possible to search by various criteria to restrict + the number of rows returned. Multiple search criteria are logically ANDed together + unless the searchCriteriaModeOr option is included. Then the search criteria are + logically ORed together. If no sortOrder is included the response is sorted by User + Id ascending by default. + + The response is either `GroupCallPickupGetInstancePagedSortedResponse()` or + `ErrorResponse()`. + + Attributes: + service_provider_id (str): serviceProviderId + group_id (str): groupId + name (str): name + response_paging_control (OCI.responsePagingControl): responsePagingControl + *Optional* + sort_order (List[OCI.sortOrder]): sortOrder *Optional* + search_criteria_user_id (List[OCI.searchCriteriaUserId]): searchCriteriaUserId + *Optional* + search_criteria_user_last_name (List[OCI.searchCriteriaUserLastName]): + searchCriteriaUserLastName *Optional* + search_criteria_user_first_name (List[OCI.searchCriteriaUserFirstName]): + searchCriteriaUserFirstName *Optional* + search_criteria_dn (List[OCI.searchCriteriaDn]): searchCriteriaDn *Optional* + search_criteria_extension (List[OCI.searchCriteriaExtension]): + searchCriteriaExtension *Optional* + search_criteria_department_name (List[OCI.searchCriteriaDepartmentName]): + searchCriteriaDepartmentName *Optional* + search_criteria_email_address (List[OCI.searchCriteriaEmailAddress]): + searchCriteriaEmailAddress *Optional* + search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* + """ + + __slots__: List[str] = [ + "service_provider_id", + "group_id", + "name", + "response_paging_control", + "sort_order", + "search_criteria_user_id", + "search_criteria_user_last_name", + "search_criteria_user_first_name", + "search_criteria_dn", + "search_criteria_extension", + "search_criteria_department_name", + "search_criteria_email_address", + "search_criteria_mode_or", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("service_provider_id", "serviceProviderId", str, is_required=True), + E("group_id", "groupId", str, is_required=True), + E("name", "name", str, is_required=True), + E( + "response_paging_control", + "responsePagingControl", + OCI.ResponsePagingControl, + is_complex=True, + ), + E( + "sort_order", + "sortOrder", + OCI.SortOrderGroupCallPickupGetInstancePagedSorted, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_id", + "searchCriteriaUserId", + OCI.SearchCriteriaUserId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_last_name", + "searchCriteriaUserLastName", + OCI.SearchCriteriaUserLastName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_first_name", + "searchCriteriaUserFirstName", + OCI.SearchCriteriaUserFirstName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_dn", + "searchCriteriaDn", + OCI.SearchCriteriaDn, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_extension", + "searchCriteriaExtension", + OCI.SearchCriteriaExtension, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_department_name", + "searchCriteriaDepartmentName", + OCI.SearchCriteriaDepartmentName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_email_address", + "searchCriteriaEmailAddress", + OCI.SearchCriteriaEmailAddress, + is_complex=True, + is_array=True, + ), + E("search_criteria_mode_or", "searchCriteriaModeOr", bool), + ) + + +class GroupCollaborateBridgeConsolidatedModifyInstanceRequest(OCIRequest): + """ + Request to modify a Collaborate bridge. + + The request fails when the collaborateOwnerUserIdList is included in the request for + the default collaborate bridge. The request fails when the supportOutdial is included + in the request and the system-level collaborate supportOutdial setting is disabled. + When phone numbers are un-assigned from the user, the unused numbers may be un- + assigned from the group and service provider. If UnassignPhoneNumbersLevel is set to + 'Group', the user's primary phone number, fax number and any alternate numbers, will + be un-assigned from the group if the command is executed by a service provider + administrator or above. When set to 'Service Provider', they will be un-assigned from + the group and service provider if the command is executed by a provisioning + administrator or above. When omitted, the number(s) will be left assigned to the + group. An `ErrorResponse()` will be returned if any number cannot be unassigned + because of insufficient privilege. If the phoneNumber has not been assigned to the + group and addPhoneNumberToGroup is set to true, it will be added to group if needed if + the command is executed by a service provider administrator and above. The command + will fail otherwise. + + The response is either `SuccessResponse()` or `ErrorResponse()`. + + Attributes: + service_user_id (str): serviceUserId + unassign_phone_numbers (str): unassignPhoneNumbers *Optional* + add_phone_number_to_group (bool): addPhoneNumberToGroup *Optional* + service_instance_profile (OCI.serviceInstanceProfile): serviceInstanceProfile + *Optional* + maximum_bridge_participants (OCI.maximumBridgeParticipants): + maximumBridgeParticipants *Optional* + network_class_of_service (str): networkClassOfService *Optional* + max_collaborate_room_participants (int): maxCollaborateRoomParticipants *Optional* + support_outdial (bool): supportOutdial *Optional* + collaborate_owner_user_id_list (OCI.collaborateOwnerUserIdList): + collaborateOwnerUserIdList *Optional* + service_list (OCI.serviceList): serviceList *Optional* + """ + + __slots__: List[str] = [ + "service_user_id", + "unassign_phone_numbers", + "add_phone_number_to_group", + "service_instance_profile", + "maximum_bridge_participants", + "network_class_of_service", + "max_collaborate_room_participants", + "support_outdial", + "collaborate_owner_user_id_list", + "service_list", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("service_user_id", "serviceUserId", str, is_required=True), + E("unassign_phone_numbers", "unassignPhoneNumbers", str), + E("add_phone_number_to_group", "addPhoneNumberToGroup", bool), + E( + "service_instance_profile", + "serviceInstanceProfile", + OCI.ServiceInstanceModifyProfile, + is_complex=True, + ), + E( + "maximum_bridge_participants", + "maximumBridgeParticipants", + OCI.CollaborateBridgeMaximumParticipants, + is_complex=True, + ), + E("network_class_of_service", "networkClassOfService", str), + E( + "max_collaborate_room_participants", + "maxCollaborateRoomParticipants", + int, + ), + E("support_outdial", "supportOutdial", bool), + E( + "collaborate_owner_user_id_list", + "collaborateOwnerUserIdList", + OCI.ReplacementUserIdList, + is_complex=True, + ), + E( + "service_list", + "serviceList", + OCI.ReplacementConsolidatedUserServiceAssignmentList, + is_complex=True, + ), + ) + + +class GroupCollaborateBridgeGetAvailableUserPagedSortedListRequest(OCIRequest): + """ + Get a list of users with the Collaborate – Audio service assigned that can be assigned + to a collaborate bridge. + + For an Enterprise Group this will include all users in the group’s enterprise. The + searchCriteriaGroupId parameter is only applicable for enterprise groups. If no + sortOrder is included the response is sorted by Last Name ascending by default. A + limitation to the search by DN activation exists when the Number Activation mode is + set to Off. In this case DNs not assigned to users are never returned by queries with + the "dnActivationSearchCriteria" included. Multiple search criteria are logically + ANDed together unless the searchCriteriaModeOr option is included. Then the search + criteria are logically ORed together. + + The response is either + `GroupCollaborateBridgeGetAvailableUserPagedSortedListResponse()` or + `ErrorResponse()`. + + Attributes: + service_provider_id (str): serviceProviderId + group_id (str): groupId + response_paging_control (OCI.responsePagingControl): responsePagingControl + *Optional* + sort_order (List[OCI.sortOrder]): sortOrder *Optional* + search_criteria_user_last_name (List[OCI.searchCriteriaUserLastName]): + searchCriteriaUserLastName *Optional* + search_criteria_user_first_name (List[OCI.searchCriteriaUserFirstName]): + searchCriteriaUserFirstName *Optional* + search_criteria_department_name (List[OCI.searchCriteriaDepartmentName]): + searchCriteriaDepartmentName *Optional* + search_criteria_group_id (List[OCI.searchCriteriaGroupId]): searchCriteriaGroupId + *Optional* + search_criteria_user_id (List[OCI.searchCriteriaUserId]): searchCriteriaUserId + *Optional* + search_criteria_dn (List[OCI.searchCriteriaDn]): searchCriteriaDn *Optional* + search_criteria_extension (List[OCI.searchCriteriaExtension]): + searchCriteriaExtension *Optional* + search_criteria_exact_dn_activation (OCI.searchCriteriaExactDnActivation): + searchCriteriaExactDnActivation *Optional* + search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* + """ + + __slots__: List[str] = [ + "service_provider_id", + "group_id", + "response_paging_control", + "sort_order", + "search_criteria_user_last_name", + "search_criteria_user_first_name", + "search_criteria_department_name", + "search_criteria_group_id", + "search_criteria_user_id", + "search_criteria_dn", + "search_criteria_extension", + "search_criteria_exact_dn_activation", + "search_criteria_mode_or", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("service_provider_id", "serviceProviderId", str, is_required=True), + E("group_id", "groupId", str, is_required=True), + E( + "response_paging_control", + "responsePagingControl", + OCI.ResponsePagingControl, + is_complex=True, + ), + E( + "sort_order", + "sortOrder", + OCI.SortOrderGroupCollaborateBridgeGetAvailableUserPagedSortedList, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_last_name", + "searchCriteriaUserLastName", + OCI.SearchCriteriaUserLastName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_first_name", + "searchCriteriaUserFirstName", + OCI.SearchCriteriaUserFirstName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_department_name", + "searchCriteriaDepartmentName", + OCI.SearchCriteriaDepartmentName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_group_id", + "searchCriteriaGroupId", + OCI.SearchCriteriaGroupId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_id", + "searchCriteriaUserId", + OCI.SearchCriteriaUserId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_dn", + "searchCriteriaDn", + OCI.SearchCriteriaDn, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_extension", + "searchCriteriaExtension", + OCI.SearchCriteriaExtension, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_exact_dn_activation", + "searchCriteriaExactDnActivation", + OCI.SearchCriteriaExactDnActivation, + is_complex=True, + ), + E("search_criteria_mode_or", "searchCriteriaModeOr", bool), + ) + + +class GroupCollaborateBridgeGetInstancePagedSortedListRequest(OCIRequest): + """ + Get a list of collaborate bridges within a group. + + The response is either `GroupCollaborateBridgeGetInstancePagedSortedListResponse()` or + `ErrorResponse()`. If the responsePagingControl element is not provided, the paging + startIndex will be set to 1 by default, and the responsePageSize will be set to the + maximum responsePageSize by default. If no sortOrder is included the response is + sorted by Name ascending by default. . Multiple search criteria are logically ANDed + together unless the searchCriteriaModeOr option is included. Then the search criteria + are logically ORed together. + + Attributes: + service_provider_id (str): serviceProviderId + group_id (str): groupId + response_paging_control (OCI.responsePagingControl): responsePagingControl + *Optional* + sort_order (List[OCI.sortOrder]): sortOrder *Optional* + search_criteria_user_last_name (List[OCI.searchCriteriaUserLastName]): + searchCriteriaUserLastName *Optional* + search_criteria_department_name (List[OCI.searchCriteriaDepartmentName]): + searchCriteriaDepartmentName *Optional* + search_criteria_user_id (List[OCI.searchCriteriaUserId]): searchCriteriaUserId + *Optional* + search_criteria_dn (List[OCI.searchCriteriaDn]): searchCriteriaDn *Optional* + search_criteria_extension (List[OCI.searchCriteriaExtension]): + searchCriteriaExtension *Optional* + search_criteria_exact_dn_activation (OCI.searchCriteriaExactDnActivation): + searchCriteriaExactDnActivation *Optional* + search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* + """ + + __slots__: List[str] = [ + "service_provider_id", + "group_id", + "response_paging_control", + "sort_order", + "search_criteria_user_last_name", + "search_criteria_department_name", + "search_criteria_user_id", + "search_criteria_dn", + "search_criteria_extension", + "search_criteria_exact_dn_activation", + "search_criteria_mode_or", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("service_provider_id", "serviceProviderId", str, is_required=True), + E("group_id", "groupId", str, is_required=True), E( - "entrance_message_audio_url_list", - "entranceMessageAudioUrlList", - OCI.CallCenterAnnouncementURLListModify, + "response_paging_control", + "responsePagingControl", + OCI.ResponsePagingControl, is_complex=True, ), E( - "entrance_message_audio_file_list", - "entranceMessageAudioFileList", - OCI.CallCenterAnnouncementFileListModify20, + "sort_order", + "sortOrder", + OCI.SortOrderGroupCollaborateBridgeGetInstancePagedSortedList, is_complex=True, + is_array=True, ), - E("entrance_video_message_selection", "entranceVideoMessageSelection", str), E( - "entrance_message_video_url_list", - "entranceMessageVideoUrlList", - OCI.CallCenterAnnouncementURLListModify, + "search_criteria_user_last_name", + "searchCriteriaUserLastName", + OCI.SearchCriteriaUserLastName, is_complex=True, + is_array=True, ), E( - "entrance_message_video_file_list", - "entranceMessageVideoFileList", - OCI.CallCenterAnnouncementFileListModify20, + "search_criteria_department_name", + "searchCriteriaDepartmentName", + OCI.SearchCriteriaDepartmentName, is_complex=True, + is_array=True, ), - E("play_periodic_comfort_message", "playPeriodicComfortMessage", bool), E( - "time_between_comfort_messages_seconds", - "timeBetweenComfortMessagesSeconds", - int, + "search_criteria_user_id", + "searchCriteriaUserId", + OCI.SearchCriteriaUserId, + is_complex=True, + is_array=True, ), E( - "periodic_comfort_audio_message_selection", - "periodicComfortAudioMessageSelection", - str, + "search_criteria_dn", + "searchCriteriaDn", + OCI.SearchCriteriaDn, + is_complex=True, + is_array=True, ), E( - "periodic_comfort_message_audio_url_list", - "periodicComfortMessageAudioUrlList", - OCI.CallCenterAnnouncementURLListModify, + "search_criteria_extension", + "searchCriteriaExtension", + OCI.SearchCriteriaExtension, is_complex=True, + is_array=True, ), E( - "periodic_comfort_message_audio_file_list", - "periodicComfortMessageAudioFileList", - OCI.CallCenterAnnouncementFileListModify20, + "search_criteria_exact_dn_activation", + "searchCriteriaExactDnActivation", + OCI.SearchCriteriaExactDnActivation, + is_complex=True, + ), + E("search_criteria_mode_or", "searchCriteriaModeOr", bool), + ) + + +class GroupDnGetAssignmentPagedSortedListRequest(OCIRequest): + """ + Get the list of assigned and unassigned DNs in a group. + + Each DN can be assigned to a user and/or department. Ranges of DNs with identical + assignment and activation properties are coalesced to a single table row entry. Dns + assigned to the IMRN pool are not listed in the response. If the + responsePagingControl element is not provided, the paging startIndex will be set to 1 + by default, and the responsePageSize will be set to the maximum ResponsePageSize by + default. If no sortOrder is included the response is sorted by Phone Number by + default. Multiple search criteria are logically ANDed together unless the + searchCriteriaModeOr option is included. Then the search criterion are logically ORed + together. The department in both the search criteria and sort by fields refer to the + department to which the dn belongs. A limitation to the search by DN activation + exists when the Number Activation mode is set to Off. In this case DNs not assigned + to users are never returned by queries with the "dnActivationSearchCriteria" included. + + The response is either a `GroupDnGetAssignmentPagedSortedListResponse()` or an + `ErrorResponse()`. + + Attributes: + service_provider_id (str): serviceProviderId + group_id (str): groupId + response_paging_control (OCI.responsePagingControl): responsePagingControl + *Optional* + sort_order (List[OCI.sortOrder]): sortOrder *Optional* + search_criteria_dn (List[OCI.searchCriteriaDn]): searchCriteriaDn *Optional* + search_criteria_department_name (List[OCI.searchCriteriaDepartmentName]): + searchCriteriaDepartmentName *Optional* + search_criteria_exact_dn_activation (OCI.searchCriteriaExactDnActivation): + searchCriteriaExactDnActivation *Optional* + search_criteria_exact_dn_availability (OCI.searchCriteriaExactDnAvailability): + searchCriteriaExactDnAvailability *Optional* + search_criteria_user_id (List[OCI.searchCriteriaUserId]): searchCriteriaUserId + *Optional* + search_criteria_user_first_name (List[OCI.searchCriteriaUserFirstName]): + searchCriteriaUserFirstName *Optional* + search_criteria_user_last_name (List[OCI.searchCriteriaUserLastName]): + searchCriteriaUserLastName *Optional* + search_criteria_exact_user_type (List[OCI.searchCriteriaExactUserType]): + searchCriteriaExactUserType *Optional* + search_criteria_extension (List[OCI.searchCriteriaExtension]): + searchCriteriaExtension *Optional* + search_criteria_email_address (List[OCI.searchCriteriaEmailAddress]): + searchCriteriaEmailAddress *Optional* + search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* + """ + + __slots__: List[str] = [ + "service_provider_id", + "group_id", + "response_paging_control", + "sort_order", + "search_criteria_dn", + "search_criteria_department_name", + "search_criteria_exact_dn_activation", + "search_criteria_exact_dn_availability", + "search_criteria_user_id", + "search_criteria_user_first_name", + "search_criteria_user_last_name", + "search_criteria_exact_user_type", + "search_criteria_extension", + "search_criteria_email_address", + "search_criteria_mode_or", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("service_provider_id", "serviceProviderId", str, is_required=True), + E("group_id", "groupId", str, is_required=True), + E( + "response_paging_control", + "responsePagingControl", + OCI.ResponsePagingControl, is_complex=True, ), E( - "periodic_comfort_video_message_selection", - "periodicComfortVideoMessageSelection", - str, + "sort_order", + "sortOrder", + OCI.SortOrderGroupDnGetAssignmentPagedSortedList, + is_complex=True, + is_array=True, ), E( - "periodic_comfort_message_video_url_list", - "periodicComfortMessageVideoUrlList", - OCI.CallCenterAnnouncementURLListModify, + "search_criteria_dn", + "searchCriteriaDn", + OCI.SearchCriteriaDn, is_complex=True, + is_array=True, ), E( - "periodic_comfort_message_video_file_list", - "periodicComfortMessageVideoFileList", - OCI.CallCenterAnnouncementFileListModify20, + "search_criteria_department_name", + "searchCriteriaDepartmentName", + OCI.SearchCriteriaDepartmentName, is_complex=True, + is_array=True, ), E( - "enable_media_on_hold_for_queued_calls", - "enableMediaOnHoldForQueuedCalls", - bool, + "search_criteria_exact_dn_activation", + "searchCriteriaExactDnActivation", + OCI.SearchCriteriaExactDnActivation, + is_complex=True, ), E( - "media_on_hold_source", - "mediaOnHoldSource", - OCI.CallCenterMediaOnHoldSourceModify20, + "search_criteria_exact_dn_availability", + "searchCriteriaExactDnAvailability", + OCI.SearchCriteriaExactDnAvailability, is_complex=True, ), - E("play_whisper_message", "playWhisperMessage", bool), - E("whisper_audio_message_selection", "whisperAudioMessageSelection", str), E( - "whisper_message_audio_url_list", - "whisperMessageAudioUrlList", - OCI.CallCenterAnnouncementURLListModify, + "search_criteria_user_id", + "searchCriteriaUserId", + OCI.SearchCriteriaUserId, is_complex=True, + is_array=True, ), E( - "whisper_message_audio_file_list", - "whisperMessageAudioFileList", - OCI.CallCenterAnnouncementFileListModify20, + "search_criteria_user_first_name", + "searchCriteriaUserFirstName", + OCI.SearchCriteriaUserFirstName, is_complex=True, + is_array=True, ), - E("whisper_video_message_selection", "whisperVideoMessageSelection", str), E( - "whisper_message_video_url_list", - "whisperMessageVideoUrlList", - OCI.CallCenterAnnouncementURLListModify, + "search_criteria_user_last_name", + "searchCriteriaUserLastName", + OCI.SearchCriteriaUserLastName, is_complex=True, + is_array=True, ), E( - "whisper_message_video_file_list", - "whisperMessageVideoFileList", - OCI.CallCenterAnnouncementFileListModify20, + "search_criteria_exact_user_type", + "searchCriteriaExactUserType", + OCI.SearchCriteriaExactUserType, is_complex=True, + is_array=True, ), E( - "estimated_wait_message_options_modify", - "estimatedWaitMessageOptionsModify", - OCI.EstimatedWaitMessageOptionsModify, + "search_criteria_extension", + "searchCriteriaExtension", + OCI.SearchCriteriaExtension, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_email_address", + "searchCriteriaEmailAddress", + OCI.SearchCriteriaEmailAddress, is_complex=True, + is_array=True, ), + E("search_criteria_mode_or", "searchCriteriaModeOr", bool), ) -class GroupCollaborateBridgeConsolidatedModifyInstanceRequest(OCIRequest): +class GroupFlexibleSeatingHostModifyInstanceRequest22(OCIRequest): """ - Request to modify a Collaborate bridge. - - The request fails when the collaborateOwnerUserIdList is included in the request for - the default collaborate bridge. The request fails when the supportOutdial is included - in the request and the system-level collaborate supportOutdial setting is disabled. - When phone numbers are un-assigned from the user, the unused numbers may be un- - assigned from the group and service provider. If UnassignPhoneNumbersLevel is set to - 'Group', the user's primary phone number, fax number and any alternate numbers, will - be un-assigned from the group if the command is executed by a service provider - administrator or above. When set to 'Service Provider', they will be un-assigned from - the group and service provider if the command is executed by a provisioning - administrator or above. When omitted, the number(s) will be left assigned to the - group. An `ErrorResponse()` will be returned if any number cannot be unassigned - because of insufficient privilege. If the phoneNumber has not been assigned to the - group and addPhoneNumberToGroup is set to true, it will be added to group if needed if - the command is executed by a service provider administrator and above. The command - will fail otherwise. + Request to modify a flexible seating host instance. The response is either `SuccessResponse()` or `ErrorResponse()`. Attributes: service_user_id (str): serviceUserId - unassign_phone_numbers (str): unassignPhoneNumbers *Optional* - add_phone_number_to_group (bool): addPhoneNumberToGroup *Optional* service_instance_profile (OCI.serviceInstanceProfile): serviceInstanceProfile *Optional* - maximum_bridge_participants (OCI.maximumBridgeParticipants): - maximumBridgeParticipants *Optional* + access_device_endpoint (OCI.accessDeviceEndpoint): accessDeviceEndpoint *Optional* network_class_of_service (str): networkClassOfService *Optional* - max_collaborate_room_participants (int): maxCollaborateRoomParticipants *Optional* - support_outdial (bool): supportOutdial *Optional* - collaborate_owner_user_id_list (OCI.collaborateOwnerUserIdList): - collaborateOwnerUserIdList *Optional* - service_list (OCI.serviceList): serviceList *Optional* """ __slots__: List[str] = [ "service_user_id", - "unassign_phone_numbers", - "add_phone_number_to_group", "service_instance_profile", - "maximum_bridge_participants", + "access_device_endpoint", "network_class_of_service", - "max_collaborate_room_participants", - "support_outdial", - "collaborate_owner_user_id_list", - "service_list", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( E("service_user_id", "serviceUserId", str, is_required=True), - E("unassign_phone_numbers", "unassignPhoneNumbers", str), - E("add_phone_number_to_group", "addPhoneNumberToGroup", bool), E( "service_instance_profile", "serviceInstanceProfile", - OCI.ServiceInstanceModifyProfile, + OCI.ServiceInstanceModifyProfileFlexibleSeatingHost, is_complex=True, ), E( - "maximum_bridge_participants", - "maximumBridgeParticipants", - OCI.CollaborateBridgeMaximumParticipants, + "access_device_endpoint", + "accessDeviceEndpoint", + OCI.AccessDeviceMultipleContactEndpointModify22, is_complex=True, ), E("network_class_of_service", "networkClassOfService", str), - E( - "max_collaborate_room_participants", - "maxCollaborateRoomParticipants", - int, - ), - E("support_outdial", "supportOutdial", bool), - E( - "collaborate_owner_user_id_list", - "collaborateOwnerUserIdList", - OCI.ReplacementUserIdList, - is_complex=True, - ), - E( - "service_list", - "serviceList", - OCI.ReplacementConsolidatedUserServiceAssignmentList, - is_complex=True, - ), ) -class GroupFlexibleSeatingHostModifyInstanceRequest22(OCIRequest): +class GroupGetListInServiceProviderPagedSortedListRequest(OCIRequest): """ - Request to modify a flexible seating host instance. + Request the list of groups in a service provider or enterprise. - The response is either `SuccessResponse()` or `ErrorResponse()`. + If no sortOrder is included, the response is sorted by Group Id ascending by default. + + The response is either a `GroupGetListInServiceProviderPagedSortedListResponse()` or + an `ErrorResponse()`. If the responsePagingControl element is not provided, the paging + startIndex will be set to 1 by default, and the responsePageSize will be set to the + maximum responsePageSize by default. Multiple search criteria are logically ANDed + together unless the searchCriteriaModeOr option is included. Then the search criteria + are logically ORed together. Attributes: - service_user_id (str): serviceUserId - service_instance_profile (OCI.serviceInstanceProfile): serviceInstanceProfile + service_provider_id (str): serviceProviderId + response_paging_control (OCI.responsePagingControl): responsePagingControl *Optional* - access_device_endpoint (OCI.accessDeviceEndpoint): accessDeviceEndpoint *Optional* - network_class_of_service (str): networkClassOfService *Optional* + sort_order (List[OCI.sortOrder]): sortOrder *Optional* + search_criteria_group_id (List[OCI.searchCriteriaGroupId]): searchCriteriaGroupId + *Optional* + search_criteria_group_name (List[OCI.searchCriteriaGroupName]): + searchCriteriaGroupName *Optional* + search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* """ __slots__: List[str] = [ - "service_user_id", - "service_instance_profile", - "access_device_endpoint", - "network_class_of_service", + "service_provider_id", + "response_paging_control", + "sort_order", + "search_criteria_group_id", + "search_criteria_group_name", + "search_criteria_mode_or", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("service_user_id", "serviceUserId", str, is_required=True), + E("service_provider_id", "serviceProviderId", str, is_required=True), E( - "service_instance_profile", - "serviceInstanceProfile", - OCI.ServiceInstanceModifyProfileFlexibleSeatingHost, + "response_paging_control", + "responsePagingControl", + OCI.ResponsePagingControl, is_complex=True, ), E( - "access_device_endpoint", - "accessDeviceEndpoint", - OCI.AccessDeviceMultipleContactEndpointModify22, + "sort_order", + "sortOrder", + OCI.SortOrderGroupGetListInServiceProviderPagedSortedList, is_complex=True, + is_array=True, ), - E("network_class_of_service", "networkClassOfService", str), + E( + "search_criteria_group_id", + "searchCriteriaGroupId", + OCI.SearchCriteriaGroupId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_group_name", + "searchCriteriaGroupName", + OCI.SearchCriteriaGroupName, + is_complex=True, + is_array=True, + ), + E("search_criteria_mode_or", "searchCriteriaModeOr", bool), ) @@ -148866,6 +147443,260 @@ def _elements(cls) -> Tuple[E, ...]: ) +class GroupHuntGroupGetAvailableUserPagedSortedListRequest(OCIRequest): + """ + Get a list of users that can be assigned to a Hunt Group group. + + Searching for users by group only makes sense when the hunt group is part of an + Enterprise. A limitation to the search by DN activation exists when the Number + Activation mode is set to Off. In this case DNs not assigned to users are never + returned by queries with the "dnActivationSearchCriteria" included. + + The response is either `GroupHuntGroupGetAvailableUserPagedSortedListResponse()` or + `ErrorResponse()`. If no sortOrder is included, the response is sorted by User Id + ascending by default. If the responsePagingControl element is not provided, the + paging startIndex will be set to 1 by default, and the responsePageSize will be set to + the maximum responsePageSize by default. Multiple search criteria are logically ANDed + together unless the searchCriteriaModeOr option is included. Then the search criteria + are logically ORed together. + + Attributes: + service_provider_id (str): serviceProviderId + group_id (str): groupId + response_paging_control (OCI.responsePagingControl): responsePagingControl + *Optional* + sort_order (List[OCI.sortOrder]): sortOrder *Optional* + search_criteria_user_last_name (List[OCI.searchCriteriaUserLastName]): + searchCriteriaUserLastName *Optional* + search_criteria_user_first_name (List[OCI.searchCriteriaUserFirstName]): + searchCriteriaUserFirstName *Optional* + search_criteria_department_name (List[OCI.searchCriteriaDepartmentName]): + searchCriteriaDepartmentName *Optional* + search_criteria_group_id (List[OCI.searchCriteriaGroupId]): searchCriteriaGroupId + *Optional* + search_criteria_user_id (List[OCI.searchCriteriaUserId]): searchCriteriaUserId + *Optional* + search_criteria_dn (List[OCI.searchCriteriaDn]): searchCriteriaDn *Optional* + search_criteria_extension (List[OCI.searchCriteriaExtension]): + searchCriteriaExtension *Optional* + search_criteria_exact_dn_activation (OCI.searchCriteriaExactDnActivation): + searchCriteriaExactDnActivation *Optional* + search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* + """ + + __slots__: List[str] = [ + "service_provider_id", + "group_id", + "response_paging_control", + "sort_order", + "search_criteria_user_last_name", + "search_criteria_user_first_name", + "search_criteria_department_name", + "search_criteria_group_id", + "search_criteria_user_id", + "search_criteria_dn", + "search_criteria_extension", + "search_criteria_exact_dn_activation", + "search_criteria_mode_or", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("service_provider_id", "serviceProviderId", str, is_required=True), + E("group_id", "groupId", str, is_required=True), + E( + "response_paging_control", + "responsePagingControl", + OCI.ResponsePagingControl, + is_complex=True, + ), + E( + "sort_order", + "sortOrder", + OCI.SortOrderGroupHuntGroupGetAvailableUserPagedSortedList, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_last_name", + "searchCriteriaUserLastName", + OCI.SearchCriteriaUserLastName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_first_name", + "searchCriteriaUserFirstName", + OCI.SearchCriteriaUserFirstName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_department_name", + "searchCriteriaDepartmentName", + OCI.SearchCriteriaDepartmentName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_group_id", + "searchCriteriaGroupId", + OCI.SearchCriteriaGroupId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_id", + "searchCriteriaUserId", + OCI.SearchCriteriaUserId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_dn", + "searchCriteriaDn", + OCI.SearchCriteriaDn, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_extension", + "searchCriteriaExtension", + OCI.SearchCriteriaExtension, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_exact_dn_activation", + "searchCriteriaExactDnActivation", + OCI.SearchCriteriaExactDnActivation, + is_complex=True, + ), + E("search_criteria_mode_or", "searchCriteriaModeOr", bool), + ) + + +class GroupHuntGroupGetInstancePagedSortedListRequest(OCIRequest): + """ + Get a list of Hunt Group instances within a group. + + The response is either `GroupHuntGroupGetInstancePagedSortedListResponse()` or + `ErrorResponse()`. It is possible to get the instances within a specified department. + The department in both the search criteria and sort by fields refer to the department + to which the dn belongs. If no sortOrder is included, the response is sorted by User + Id ascending by default. If the responsePagingControl element is not provided, the + paging startIndex will be set to 1 by default, and the responsePageSize will be set to + the maximum responsePageSize by default. Multiple search criteria are logically ANDed + together unless the searchCriteriaModeOr option is included. Then the search criteria + are logically ORed together. + + Attributes: + service_provider_id (str): serviceProviderId + group_id (str): groupId + response_paging_control (OCI.responsePagingControl): responsePagingControl + *Optional* + sort_order (List[OCI.sortOrder]): sortOrder *Optional* + search_criteria_user_last_name (List[OCI.searchCriteriaUserLastName]): + searchCriteriaUserLastName *Optional* + search_criteria_department_name (List[OCI.searchCriteriaDepartmentName]): + searchCriteriaDepartmentName *Optional* + search_criteria_user_id (List[OCI.searchCriteriaUserId]): searchCriteriaUserId + *Optional* + search_criteria_dn (List[OCI.searchCriteriaDn]): searchCriteriaDn *Optional* + search_criteria_extension (List[OCI.searchCriteriaExtension]): + searchCriteriaExtension *Optional* + search_criteria_exact_dn_activation (OCI.searchCriteriaExactDnActivation): + searchCriteriaExactDnActivation *Optional* + search_criteria_service_status (OCI.searchCriteriaServiceStatus): + searchCriteriaServiceStatus *Optional* + search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* + """ + + __slots__: List[str] = [ + "service_provider_id", + "group_id", + "response_paging_control", + "sort_order", + "search_criteria_user_last_name", + "search_criteria_department_name", + "search_criteria_user_id", + "search_criteria_dn", + "search_criteria_extension", + "search_criteria_exact_dn_activation", + "search_criteria_service_status", + "search_criteria_mode_or", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("service_provider_id", "serviceProviderId", str, is_required=True), + E("group_id", "groupId", str, is_required=True), + E( + "response_paging_control", + "responsePagingControl", + OCI.ResponsePagingControl, + is_complex=True, + ), + E( + "sort_order", + "sortOrder", + OCI.SortOrderGroupHuntGroupGetInstancePagedSortedList, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_last_name", + "searchCriteriaUserLastName", + OCI.SearchCriteriaUserLastName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_department_name", + "searchCriteriaDepartmentName", + OCI.SearchCriteriaDepartmentName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_id", + "searchCriteriaUserId", + OCI.SearchCriteriaUserId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_dn", + "searchCriteriaDn", + OCI.SearchCriteriaDn, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_extension", + "searchCriteriaExtension", + OCI.SearchCriteriaExtension, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_exact_dn_activation", + "searchCriteriaExactDnActivation", + OCI.SearchCriteriaExactDnActivation, + is_complex=True, + ), + E( + "search_criteria_service_status", + "searchCriteriaServiceStatus", + OCI.SearchCriteriaServiceStatus, + is_complex=True, + ), + E("search_criteria_mode_or", "searchCriteriaModeOr", bool), + ) + + class GroupOutgoingCallingPlanDigitPlanCallMeNowModifyListRequest(OCIRequest): """ Modify the Call Me Now call permissions for digit patterns for a group default and @@ -149124,6 +147955,204 @@ def _elements(cls) -> Tuple[E, ...]: ) +class GroupPhoneDirectoryGetPagedSortedListRequest(OCIRequest): + """ + Request a table containing the phone directory for a group. + + The directory includes all users in the group and all entries in the group common + phone list. If the specified group is part of an enterprise, the directory includes + all users in the enterprise and all entries in the enterprise common phone list and + the common phone list of the specified group. If the specified group is part of a + service provider, the directory includes all users in the group and all entries in the + common phone list of the specified group. If the responsePagingControl element is not + provided, the paging startIndex will be set to 1 by default, and the responsePageSize + will be set to the maximum ResponsePageSize by default. It is possible to search by + various criteria to restrict the number of rows returned. If no sortOrder is included + the response is sorted by User Id ascending with a secondary sort by User Last Name + ascending by default. Multiple search criteria are logically ANDed together unless + the searchCriteriaModeOr option is included. Then the search criteria are logically + ORed together. `ErrorResponse()` is returned if searchCriteriaExactUserGroup or + searchCriteriaExactUserDepartment have multiple entries and searchCriteriaModeOr is + not included. The following elements are only used in AS data mode and ignored in + Amplify and XS data mode: "sortByImpId" "searchCriteriaImpId" + + The response is either `GroupPhoneDirectoryGetPagedSortedListResponse()` or + `ErrorResponse()`. + + Attributes: + service_provider_id (str): serviceProviderId + group_id (str): groupId + is_extended_info_requested (bool): isExtendedInfoRequested + response_paging_control (OCI.responsePagingControl): responsePagingControl + *Optional* + sort_order (List[OCI.sortOrder]): sortOrder *Optional* + search_criteria_user_last_name (List[OCI.searchCriteriaUserLastName]): + searchCriteriaUserLastName *Optional* + search_criteria_user_first_name (List[OCI.searchCriteriaUserFirstName]): + searchCriteriaUserFirstName *Optional* + search_criteria_dn (List[OCI.searchCriteriaDn]): searchCriteriaDn *Optional* + search_criteria_group_location_code (List[OCI.searchCriteriaGroupLocationCode]): + searchCriteriaGroupLocationCode *Optional* + search_criteria_extension (List[OCI.searchCriteriaExtension]): + searchCriteriaExtension *Optional* + search_criteria_mobile_phone_number (List[OCI.searchCriteriaMobilePhoneNumber]): + searchCriteriaMobilePhoneNumber *Optional* + search_criteria_email_address (List[OCI.searchCriteriaEmailAddress]): + searchCriteriaEmailAddress *Optional* + search_criteria_exact_user_department (OCI.searchCriteriaExactUserDepartment): + searchCriteriaExactUserDepartment *Optional* + search_criteria_department_name (List[OCI.searchCriteriaDepartmentName]): + searchCriteriaDepartmentName *Optional* + search_criteria_exact_user_group (OCI.searchCriteriaExactUserGroup): + searchCriteriaExactUserGroup *Optional* + search_criteria_yahoo_id (List[OCI.searchCriteriaYahooId]): searchCriteriaYahooId + *Optional* + search_criteria_user_id (List[OCI.searchCriteriaUserId]): searchCriteriaUserId + *Optional* + search_criteria_imp_id (List[OCI.searchCriteriaImpId]): searchCriteriaImpId + *Optional* + search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* + """ + + __slots__: List[str] = [ + "service_provider_id", + "group_id", + "is_extended_info_requested", + "response_paging_control", + "sort_order", + "search_criteria_user_last_name", + "search_criteria_user_first_name", + "search_criteria_dn", + "search_criteria_group_location_code", + "search_criteria_extension", + "search_criteria_mobile_phone_number", + "search_criteria_email_address", + "search_criteria_exact_user_department", + "search_criteria_department_name", + "search_criteria_exact_user_group", + "search_criteria_yahoo_id", + "search_criteria_user_id", + "search_criteria_imp_id", + "search_criteria_mode_or", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("service_provider_id", "serviceProviderId", str, is_required=True), + E("group_id", "groupId", str, is_required=True), + E( + "is_extended_info_requested", + "isExtendedInfoRequested", + bool, + is_required=True, + ), + E( + "response_paging_control", + "responsePagingControl", + OCI.ResponsePagingControl, + is_complex=True, + ), + E( + "sort_order", + "sortOrder", + OCI.SortOrderGroupPhoneDirectoryGetPagedSortedList, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_last_name", + "searchCriteriaUserLastName", + OCI.SearchCriteriaUserLastName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_first_name", + "searchCriteriaUserFirstName", + OCI.SearchCriteriaUserFirstName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_dn", + "searchCriteriaDn", + OCI.SearchCriteriaDn, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_group_location_code", + "searchCriteriaGroupLocationCode", + OCI.SearchCriteriaGroupLocationCode, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_extension", + "searchCriteriaExtension", + OCI.SearchCriteriaExtension, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_mobile_phone_number", + "searchCriteriaMobilePhoneNumber", + OCI.SearchCriteriaMobilePhoneNumber, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_email_address", + "searchCriteriaEmailAddress", + OCI.SearchCriteriaEmailAddress, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_exact_user_department", + "searchCriteriaExactUserDepartment", + OCI.SearchCriteriaExactUserDepartment, + is_complex=True, + ), + E( + "search_criteria_department_name", + "searchCriteriaDepartmentName", + OCI.SearchCriteriaDepartmentName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_exact_user_group", + "searchCriteriaExactUserGroup", + OCI.SearchCriteriaExactUserGroup, + is_complex=True, + ), + E( + "search_criteria_yahoo_id", + "searchCriteriaYahooId", + OCI.SearchCriteriaYahooId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_id", + "searchCriteriaUserId", + OCI.SearchCriteriaUserId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_imp_id", + "searchCriteriaImpId", + OCI.SearchCriteriaImpId, + is_complex=True, + is_array=True, + ), + E("search_criteria_mode_or", "searchCriteriaModeOr", bool), + ) + + class GroupRoutePointModifyAnnouncementRequest(OCIRequest): """ Modify a route point's announcement settings. @@ -149240,6 +148269,193 @@ def _elements(cls) -> Tuple[E, ...]: ) +class ServiceProviderAdminGetPagedSortedListRequest(OCIRequest): + """ + Get a list of service provider administrators. + + The response is either a `ServiceProviderAdminGetPagedSortedListResponse()` or an + `ErrorResponse()`. If no sortOrder is included, the response is sorted by + Administrator ID ascending by default. If the responsePagingControl element is not + provided, the paging startIndex will be set to 1 by default, and the responsePageSize + will be set to the maximum responsePageSize by default. Multiple search criteria are + logically ANDed together unless the searchCriteriaModeOr option is included. Then the + search criteria are logically ORed together. + + Attributes: + service_provider_id (str): serviceProviderId + response_paging_control (OCI.responsePagingControl): responsePagingControl + *Optional* + sort_order (List[OCI.sortOrder]): sortOrder *Optional* + search_criteria_admin_id (List[OCI.searchCriteriaAdminId]): searchCriteriaAdminId + *Optional* + search_criteria_admin_last_name (List[OCI.searchCriteriaAdminLastName]): + searchCriteriaAdminLastName *Optional* + search_criteria_admin_first_name (List[OCI.searchCriteriaAdminFirstName]): + searchCriteriaAdminFirstName *Optional* + search_criteria_exact_service_provider_admin_type + (List[OCI.searchCriteriaExactServiceProviderAdminType]): + searchCriteriaExactServiceProviderAdminType *Optional* + search_criteria_language (List[OCI.searchCriteriaLanguage]): + searchCriteriaLanguage *Optional* + search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* + """ + + __slots__: List[str] = [ + "service_provider_id", + "response_paging_control", + "sort_order", + "search_criteria_admin_id", + "search_criteria_admin_last_name", + "search_criteria_admin_first_name", + "search_criteria_exact_service_provider_admin_type", + "search_criteria_language", + "search_criteria_mode_or", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("service_provider_id", "serviceProviderId", str, is_required=True), + E( + "response_paging_control", + "responsePagingControl", + OCI.ResponsePagingControl, + is_complex=True, + ), + E( + "sort_order", + "sortOrder", + OCI.SortOrderServiceProviderAdminGetPagedSortedList, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_admin_id", + "searchCriteriaAdminId", + OCI.SearchCriteriaAdminId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_admin_last_name", + "searchCriteriaAdminLastName", + OCI.SearchCriteriaAdminLastName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_admin_first_name", + "searchCriteriaAdminFirstName", + OCI.SearchCriteriaAdminFirstName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_exact_service_provider_admin_type", + "searchCriteriaExactServiceProviderAdminType", + OCI.SearchCriteriaExactServiceProviderAdminType, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_language", + "searchCriteriaLanguage", + OCI.SearchCriteriaLanguage, + is_complex=True, + is_array=True, + ), + E("search_criteria_mode_or", "searchCriteriaModeOr", bool), + ) + + +class ServiceProviderGetPagedSortedListRequest(OCIRequest): + """ + Request a list of service providers and/or enterprises in the system. + + The response is either a `ServiceProviderGetPagedSortedListResponse()` or an + `ErrorResponse()`. If reseller administrator sends the request, + searchCriteriaResellerId is ignored. Service providers/enterprise within the + administrator's reseller meeting the search criteria are returned. If the + responsePagingControl element is not provided, the paging startIndex will be set to 1 + by default, and the responsePageSize will be set to the maximum responsePageSize by + default. If no sortOrder is included, the response is sorted by Service Provider Id + ascending by default. Multiple search criteria are logically ANDed together unless + the searchCriteriaModeOr option is included. Then the search criteria are logically + ORed together. + + Attributes: + response_paging_control (OCI.responsePagingControl): responsePagingControl + *Optional* + sort_order (List[OCI.sortOrder]): sortOrder *Optional* + search_criteria_service_provider_id (List[OCI.searchCriteriaServiceProviderId]): + searchCriteriaServiceProviderId *Optional* + search_criteria_service_provider_name + (List[OCI.searchCriteriaServiceProviderName]): + searchCriteriaServiceProviderName *Optional* + search_criteria_exact_organization_type (OCI.searchCriteriaExactOrganizationType): + searchCriteriaExactOrganizationType *Optional* + search_criteria_reseller_id (List[OCI.searchCriteriaResellerId]): + searchCriteriaResellerId *Optional* + search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* + """ + + __slots__: List[str] = [ + "response_paging_control", + "sort_order", + "search_criteria_service_provider_id", + "search_criteria_service_provider_name", + "search_criteria_exact_organization_type", + "search_criteria_reseller_id", + "search_criteria_mode_or", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E( + "response_paging_control", + "responsePagingControl", + OCI.ResponsePagingControl, + is_complex=True, + ), + E( + "sort_order", + "sortOrder", + OCI.SortOrderServiceProviderGetPagedSortedList, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_service_provider_id", + "searchCriteriaServiceProviderId", + OCI.SearchCriteriaServiceProviderId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_service_provider_name", + "searchCriteriaServiceProviderName", + OCI.SearchCriteriaServiceProviderName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_exact_organization_type", + "searchCriteriaExactOrganizationType", + OCI.SearchCriteriaExactOrganizationType, + is_complex=True, + ), + E( + "search_criteria_reseller_id", + "searchCriteriaResellerId", + OCI.SearchCriteriaResellerId, + is_complex=True, + is_array=True, + ), + E("search_criteria_mode_or", "searchCriteriaModeOr", bool), + ) + + class SystemSIPDeviceTypeAddRequest14sp6(OCIRequest): """ Request to add a sip device type. @@ -161310,6 +160526,643 @@ def _elements(cls) -> Tuple[E, ...]: ) +class UserEnhancedCallLogsGetListRequest17sp4(OCIRequest): + """ + Request user's call logs. + + If the callLogType is not specified, all types of calls logs (placed, received, + missed) are returned. The filters "dateTimeRange", "numberFilter", + "redirectedNumberFilter", accountAuthorizationCodeFilter" and ""subscriberType" are + ignored if call logs are stored in CDS. When "ReceivedOrMissed" is specified as + "callLogType" and call logs are stored in CDS, all call logs including placed will be + returned. It is possible to restrict the number of rows returned using + responsePagingControl. If responsePagingControl is not specified, the value of + Enhanced Call Logs system parameter maxNonPagedResponseSize will control the maximum + number of call logs can be returned. + + The response is either a `UserEnhancedCallLogsGetListResponse17sp4()` or an + `ErrorResponse()`. Replaced by UserEnhancedCallLogsGetListRequest17sp4V2. Originally + deprecated in release 20. + + Attributes: + user_id (str): userId + call_log_type (str): callLogType *Optional* + date_time_range (OCI.dateTimeRange): dateTimeRange + number_filter (OCI.numberFilter): numberFilter *Optional* + redirected_number_filter (OCI.redirectedNumberFilter): redirectedNumberFilter + *Optional* + account_authorization_code_filter (OCI.accountAuthorizationCodeFilter): + accountAuthorizationCodeFilter *Optional* + subscriber_type (str): subscriberType *Optional* + response_paging_control (OCI.responsePagingControl): responsePagingControl + *Optional* + """ + + __slots__: List[str] = [ + "user_id", + "call_log_type", + "date_time_range", + "number_filter", + "redirected_number_filter", + "account_authorization_code_filter", + "subscriber_type", + "response_paging_control", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("user_id", "userId", str, is_required=True), + E("call_log_type", "callLogType", str), + E( + "date_time_range", + "dateTimeRange", + OCI.EnhancedCallLogsTimeRange, + is_complex=True, + is_required=True, + ), + E( + "number_filter", + "numberFilter", + OCI.EnhancedCallLogsNumberFilter, + is_complex=True, + ), + E( + "redirected_number_filter", + "redirectedNumberFilter", + OCI.EnhancedCallLogsRedirectedNumberFilter, + is_complex=True, + ), + E( + "account_authorization_code_filter", + "accountAuthorizationCodeFilter", + OCI.EnhancedCallLogsAccountAuthorizationCodeFilter, + is_complex=True, + ), + E("subscriber_type", "subscriberType", str), + E( + "response_paging_control", + "responsePagingControl", + OCI.ResponsePagingControl, + is_complex=True, + ), + ) + + +class UserEnhancedCallLogsGetListRequest20(OCIRequest): + """ + Request user's call logs. + + If the callLogType is not specified, all types of calls logs (placed, received, + missed) are returned. The filters "dateTimeRange", "numberFilter", + "redirectedNumberFilter", "accountAuthorizationCodeFilter" + "callAuthorizationCodeFilter" and "subscriberType" are ignored if call logs are stored + in CDS. When "ReceivedOrMissed" is specified as "callLogType" and call logs are stored + in CDS, all call logs including placed will be returned. It is possible to restrict + the number of rows returned using responsePagingControl. If responsePagingControl is + not specified, the value of Enhanced Call Logs system parameter + maxNonPagedResponseSize will control the maximum number of call logs can be returned. + + The response is either a `UserEnhancedCallLogsGetListResponse20()` or an + `ErrorResponse()`. The following elements are only used in AS data mode and not + returned in XS data mode: callAuthorizationCodeFilter + + Attributes: + user_id (str): userId + call_log_type (str): callLogType *Optional* + date_time_range (OCI.dateTimeRange): dateTimeRange + number_filter (OCI.numberFilter): numberFilter *Optional* + redirected_number_filter (OCI.redirectedNumberFilter): redirectedNumberFilter + *Optional* + account_authorization_code_filter (OCI.accountAuthorizationCodeFilter): + accountAuthorizationCodeFilter *Optional* + call_authorization_code_filter (OCI.callAuthorizationCodeFilter): + callAuthorizationCodeFilter *Optional* + subscriber_type (str): subscriberType *Optional* + response_paging_control (OCI.responsePagingControl): responsePagingControl + *Optional* + """ + + __slots__: List[str] = [ + "user_id", + "call_log_type", + "date_time_range", + "number_filter", + "redirected_number_filter", + "account_authorization_code_filter", + "call_authorization_code_filter", + "subscriber_type", + "response_paging_control", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("user_id", "userId", str, is_required=True), + E("call_log_type", "callLogType", str), + E( + "date_time_range", + "dateTimeRange", + OCI.EnhancedCallLogsTimeRange, + is_complex=True, + is_required=True, + ), + E( + "number_filter", + "numberFilter", + OCI.EnhancedCallLogsNumberFilter, + is_complex=True, + ), + E( + "redirected_number_filter", + "redirectedNumberFilter", + OCI.EnhancedCallLogsRedirectedNumberFilter, + is_complex=True, + ), + E( + "account_authorization_code_filter", + "accountAuthorizationCodeFilter", + OCI.EnhancedCallLogsAccountAuthorizationCodeFilter, + is_complex=True, + ), + E( + "call_authorization_code_filter", + "callAuthorizationCodeFilter", + OCI.EnhancedCallLogsCallAuthorizationCodeFilter, + is_complex=True, + ), + E("subscriber_type", "subscriberType", str), + E( + "response_paging_control", + "responsePagingControl", + OCI.ResponsePagingControl, + is_complex=True, + ), + ) + + +class UserEnhancedCallLogsGetListRequest20sp1(OCIRequest): + """ + Request user's call logs. + + If the callLogType is not specified, all types of calls logs (placed, received, + missed) are returned. The filters "dateTimeRange", "numberFilter", + "redirectedNumberFilter", "accountAuthorizationCodeFilter" + "callAuthorizationCodeFilter" and "subscriberType" are ignored if call logs are stored + in CDS. When "ReceivedOrMissed" is specified as "callLogType" and call logs are stored + in CDS, all call logs including placed will be returned. It is possible to restrict + the number of rows returned using responsePagingControl. If responsePagingControl is + not specified, the value of Enhanced Call Logs system parameter + maxNonPagedResponseSize will control the maximum number of call logs can be returned. + + The response is either a `UserEnhancedCallLogsGetListResponse20sp1()` or an + `ErrorResponse()`. The following elements are only used in AS data mode: + callAuthorizationCodeFilter callSecurityClassification + + Attributes: + user_id (str): userId + call_log_type (str): callLogType *Optional* + date_time_range (OCI.dateTimeRange): dateTimeRange + number_filter (OCI.numberFilter): numberFilter *Optional* + redirected_number_filter (OCI.redirectedNumberFilter): redirectedNumberFilter + *Optional* + account_authorization_code_filter (OCI.accountAuthorizationCodeFilter): + accountAuthorizationCodeFilter *Optional* + call_authorization_code_filter (OCI.callAuthorizationCodeFilter): + callAuthorizationCodeFilter *Optional* + subscriber_type (str): subscriberType *Optional* + response_paging_control (OCI.responsePagingControl): responsePagingControl + *Optional* + """ + + __slots__: List[str] = [ + "user_id", + "call_log_type", + "date_time_range", + "number_filter", + "redirected_number_filter", + "account_authorization_code_filter", + "call_authorization_code_filter", + "subscriber_type", + "response_paging_control", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("user_id", "userId", str, is_required=True), + E("call_log_type", "callLogType", str), + E( + "date_time_range", + "dateTimeRange", + OCI.EnhancedCallLogsTimeRange, + is_complex=True, + is_required=True, + ), + E( + "number_filter", + "numberFilter", + OCI.EnhancedCallLogsNumberFilter, + is_complex=True, + ), + E( + "redirected_number_filter", + "redirectedNumberFilter", + OCI.EnhancedCallLogsRedirectedNumberFilter20sp1, + is_complex=True, + ), + E( + "account_authorization_code_filter", + "accountAuthorizationCodeFilter", + OCI.EnhancedCallLogsAccountAuthorizationCodeFilter, + is_complex=True, + ), + E( + "call_authorization_code_filter", + "callAuthorizationCodeFilter", + OCI.EnhancedCallLogsCallAuthorizationCodeFilter, + is_complex=True, + ), + E("subscriber_type", "subscriberType", str), + E( + "response_paging_control", + "responsePagingControl", + OCI.ResponsePagingControl, + is_complex=True, + ), + ) + + +class UserEnhancedCallLogsGetListRequest21(OCIRequest): + """ + Request user's call logs. + + If the callLogType is not specified, all types of calls logs (placed, received, + missed) are returned. The filters "dateTimeRange", "numberFilter", + "redirectedNumberFilter", "accountAuthorizationCodeFilter" + "callAuthorizationCodeFilter" and "subscriberType" are ignored if call logs are stored + in CDS. When "ReceivedOrMissed" is specified as "callLogType" and call logs are stored + in CDS, all call logs including placed will be returned. It is possible to restrict + the number of rows returned using responsePagingControl. If responsePagingControl is + not specified, the value of Enhanced Call Logs system parameter + maxNonPagedResponseSize will control the maximum number of call logs can be returned. + + The response is either a `UserEnhancedCallLogsGetListResponse21()` or an + `ErrorResponse()`. The following elements are only used in AS data mode and not + returned in XS data mode: callAuthorizationCodeFilter Replaced by: + UserEnhancedCallLogsGetListRequest21Sp1 in AS data mode + + Attributes: + user_id (str): userId + call_log_type (str): callLogType *Optional* + date_time_range (OCI.dateTimeRange): dateTimeRange + number_filter (OCI.numberFilter): numberFilter *Optional* + redirected_number_filter (OCI.redirectedNumberFilter): redirectedNumberFilter + *Optional* + account_authorization_code_filter (OCI.accountAuthorizationCodeFilter): + accountAuthorizationCodeFilter *Optional* + call_authorization_code_filter (OCI.callAuthorizationCodeFilter): + callAuthorizationCodeFilter *Optional* + subscriber_type (str): subscriberType *Optional* + response_paging_control (OCI.responsePagingControl): responsePagingControl + *Optional* + """ + + __slots__: List[str] = [ + "user_id", + "call_log_type", + "date_time_range", + "number_filter", + "redirected_number_filter", + "account_authorization_code_filter", + "call_authorization_code_filter", + "subscriber_type", + "response_paging_control", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("user_id", "userId", str, is_required=True), + E("call_log_type", "callLogType", str), + E( + "date_time_range", + "dateTimeRange", + OCI.EnhancedCallLogsTimeRange, + is_complex=True, + is_required=True, + ), + E( + "number_filter", + "numberFilter", + OCI.EnhancedCallLogsNumberFilter, + is_complex=True, + ), + E( + "redirected_number_filter", + "redirectedNumberFilter", + OCI.EnhancedCallLogsRedirectedNumberFilter21, + is_complex=True, + ), + E( + "account_authorization_code_filter", + "accountAuthorizationCodeFilter", + OCI.EnhancedCallLogsAccountAuthorizationCodeFilter, + is_complex=True, + ), + E( + "call_authorization_code_filter", + "callAuthorizationCodeFilter", + OCI.EnhancedCallLogsCallAuthorizationCodeFilter, + is_complex=True, + ), + E("subscriber_type", "subscriberType", str), + E( + "response_paging_control", + "responsePagingControl", + OCI.ResponsePagingControl, + is_complex=True, + ), + ) + + +class UserEnhancedCallLogsGetListRequest21sp1(OCIRequest): + """ + Request user's call logs. + + If the callLogType is not specified, all types of calls logs (placed, received, + missed) are returned. The filters "dateTimeRange", "numberFilter", + "redirectedNumberFilter", "accountAuthorizationCodeFilter" + "callAuthorizationCodeFilter" and "subscriberType" are ignored if call logs are stored + in CDS. When "ReceivedOrMissed" is specified as "callLogType" and call logs are stored + in CDS, all call logs including placed will be returned. It is possible to restrict + the number of rows returned using responsePagingControl. If responsePagingControl is + not specified, the value of Enhanced Call Logs system parameter + maxNonPagedResponseSize will control the maximum number of call logs can be returned. + + The response is either a `UserEnhancedCallLogsGetListResponse21sp1()` or an + `ErrorResponse()`. The following elements are only used in AS data mode and ignored in + XS data mode: callAuthorizationCodeFilter Replaced by: + UserEnhancedCallLogsGetListRequest21Sp1V2 in AS data mode + + Attributes: + user_id (str): userId + call_log_type (str): callLogType *Optional* + date_time_range (OCI.dateTimeRange): dateTimeRange + number_filter (OCI.numberFilter): numberFilter *Optional* + redirected_number_filter (OCI.redirectedNumberFilter): redirectedNumberFilter + *Optional* + account_authorization_code_filter (OCI.accountAuthorizationCodeFilter): + accountAuthorizationCodeFilter *Optional* + call_authorization_code_filter (OCI.callAuthorizationCodeFilter): + callAuthorizationCodeFilter *Optional* + subscriber_type (str): subscriberType *Optional* + response_paging_control (OCI.responsePagingControl): responsePagingControl + *Optional* + """ + + __slots__: List[str] = [ + "user_id", + "call_log_type", + "date_time_range", + "number_filter", + "redirected_number_filter", + "account_authorization_code_filter", + "call_authorization_code_filter", + "subscriber_type", + "response_paging_control", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("user_id", "userId", str, is_required=True), + E("call_log_type", "callLogType", str), + E( + "date_time_range", + "dateTimeRange", + OCI.EnhancedCallLogsTimeRange, + is_complex=True, + is_required=True, + ), + E( + "number_filter", + "numberFilter", + OCI.EnhancedCallLogsNumberFilter, + is_complex=True, + ), + E( + "redirected_number_filter", + "redirectedNumberFilter", + OCI.EnhancedCallLogsRedirectedNumberFilter21sp1, + is_complex=True, + ), + E( + "account_authorization_code_filter", + "accountAuthorizationCodeFilter", + OCI.EnhancedCallLogsAccountAuthorizationCodeFilter, + is_complex=True, + ), + E( + "call_authorization_code_filter", + "callAuthorizationCodeFilter", + OCI.EnhancedCallLogsCallAuthorizationCodeFilter, + is_complex=True, + ), + E("subscriber_type", "subscriberType", str), + E( + "response_paging_control", + "responsePagingControl", + OCI.ResponsePagingControl, + is_complex=True, + ), + ) + + +class UserEnhancedCallLogsGetListRequest22(OCIRequest): + """ + Request user's call logs. + + If the callLogType is not specified, all types of calls logs (placed, received, + missed) are returned. The filters "dateTimeRange", "numberFilter", + "redirectedNumberFilter", "accountAuthorizationCodeFilter" + "callAuthorizationCodeFilter" and "subscriberType" are ignored if call logs are stored + in CDS. When "ReceivedOrMissed" is specified as "callLogType" and call logs are stored + in CDS, all call logs including placed will be returned. It is possible to restrict + the number of rows returned using responsePagingControl. If responsePagingControl is + not specified, the value of Enhanced Call Logs system parameter + maxNonPagedResponseSize will control the maximum number of call logs can be returned. + + The response is either a `UserEnhancedCallLogsGetListResponse22()` or an + `ErrorResponse()`. The following elements are only used in AS data mode and ignored in + XS data mode: callAuthorizationCodeFilter + + Attributes: + user_id (str): userId + call_log_type (str): callLogType *Optional* + date_time_range (OCI.dateTimeRange): dateTimeRange + number_filter (OCI.numberFilter): numberFilter *Optional* + redirected_number_filter (OCI.redirectedNumberFilter): redirectedNumberFilter + *Optional* + account_authorization_code_filter (OCI.accountAuthorizationCodeFilter): + accountAuthorizationCodeFilter *Optional* + call_authorization_code_filter (OCI.callAuthorizationCodeFilter): + callAuthorizationCodeFilter *Optional* + subscriber_type (str): subscriberType *Optional* + response_paging_control (OCI.responsePagingControl): responsePagingControl + *Optional* + """ + + __slots__: List[str] = [ + "user_id", + "call_log_type", + "date_time_range", + "number_filter", + "redirected_number_filter", + "account_authorization_code_filter", + "call_authorization_code_filter", + "subscriber_type", + "response_paging_control", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("user_id", "userId", str, is_required=True), + E("call_log_type", "callLogType", str), + E( + "date_time_range", + "dateTimeRange", + OCI.EnhancedCallLogsTimeRange, + is_complex=True, + is_required=True, + ), + E( + "number_filter", + "numberFilter", + OCI.EnhancedCallLogsNumberFilter, + is_complex=True, + ), + E( + "redirected_number_filter", + "redirectedNumberFilter", + OCI.EnhancedCallLogsRedirectedNumberFilter21sp1, + is_complex=True, + ), + E( + "account_authorization_code_filter", + "accountAuthorizationCodeFilter", + OCI.EnhancedCallLogsAccountAuthorizationCodeFilter, + is_complex=True, + ), + E( + "call_authorization_code_filter", + "callAuthorizationCodeFilter", + OCI.EnhancedCallLogsCallAuthorizationCodeFilter, + is_complex=True, + ), + E("subscriber_type", "subscriberType", str), + E( + "response_paging_control", + "responsePagingControl", + OCI.ResponsePagingControl, + is_complex=True, + ), + ) + + +class UserEnhancedCallLogsGetListRequest23(OCIRequest): + """ + Request user's call logs. + + If the callLogType is not specified, all types of calls logs (placed, received, + missed) are returned. The filters "dateTimeRange", "numberFilter", + "redirectedNumberFilter", "accountAuthorizationCodeFilter" + "callAuthorizationCodeFilter" and "subscriberType" are ignored if call logs are stored + in CDS. When "ReceivedOrMissed" is specified as "callLogType" and call logs are stored + in CDS, all call logs including placed will be returned. It is possible to restrict + the number of rows returned using responsePagingControl. If responsePagingControl is + not specified, the value of Enhanced Call Logs system parameter + maxNonPagedResponseSize will control the maximum number of call logs can be returned. + + The response is either a `UserEnhancedCallLogsGetListResponse23()` or an + `ErrorResponse()`. The following elements are only used in AS data mode and ignored in + XS data mode: callAuthorizationCodeFilter + + Attributes: + user_id (str): userId + call_log_type (str): callLogType *Optional* + date_time_range (OCI.dateTimeRange): dateTimeRange + number_filter (OCI.numberFilter): numberFilter *Optional* + redirected_number_filter (OCI.redirectedNumberFilter): redirectedNumberFilter + *Optional* + account_authorization_code_filter (OCI.accountAuthorizationCodeFilter): + accountAuthorizationCodeFilter *Optional* + call_authorization_code_filter (OCI.callAuthorizationCodeFilter): + callAuthorizationCodeFilter *Optional* + subscriber_type (str): subscriberType *Optional* + response_paging_control (OCI.responsePagingControl): responsePagingControl + *Optional* + """ + + __slots__: List[str] = [ + "user_id", + "call_log_type", + "date_time_range", + "number_filter", + "redirected_number_filter", + "account_authorization_code_filter", + "call_authorization_code_filter", + "subscriber_type", + "response_paging_control", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("user_id", "userId", str, is_required=True), + E("call_log_type", "callLogType", str), + E( + "date_time_range", + "dateTimeRange", + OCI.EnhancedCallLogsTimeRange, + is_complex=True, + is_required=True, + ), + E( + "number_filter", + "numberFilter", + OCI.EnhancedCallLogsNumberFilter, + is_complex=True, + ), + E( + "redirected_number_filter", + "redirectedNumberFilter", + OCI.EnhancedCallLogsRedirectedNumberFilter23, + is_complex=True, + ), + E( + "account_authorization_code_filter", + "accountAuthorizationCodeFilter", + OCI.EnhancedCallLogsAccountAuthorizationCodeFilter, + is_complex=True, + ), + E( + "call_authorization_code_filter", + "callAuthorizationCodeFilter", + OCI.EnhancedCallLogsCallAuthorizationCodeFilter, + is_complex=True, + ), + E("subscriber_type", "subscriberType", str), + E( + "response_paging_control", + "responsePagingControl", + OCI.ResponsePagingControl, + is_complex=True, + ), + ) + + class UserFlexibleSeatingGuestModifyRequest22(OCIRequest): """ Modify the user level data associated with flexible seating guest. @@ -161361,6 +161214,153 @@ def _elements(cls) -> Tuple[E, ...]: ) +class UserGetListInGroupPagedSortedListRequest(OCIRequest): + """ + Request the list of users in a group. + + The response is either a `UserGetListInGroupPagedSortedListResponse()` or an + `ErrorResponse()`. If the responsePagingControl element is not provided, the paging + startIndex will be set to 1 by default, and the responsePageSize will be set to the + maximum ResponsePageSize by default. It is possible to search by various criteria to + restrict the number of rows returned. If no sortOrder is included the response is + sorted by User Id ascending by default. A limitation to the search by DN activation + exists when the Number Activation mode is set to Off. In this case DNs not assigned + to users are never returned by queries with the "dnActivationSearchCriteria" included. + Multiple search criteria are logically ANDed together unless the searchCriteriaModeOr + option is included. Then the search criteria are logically ORed together. The + following elements are used in AS data mode and ignored in XS data mode: + groupExternalId + + Attributes: + service_provider_id (str): serviceProviderId *Optional* + group_id (str): groupId *Optional* + group_external_id (str): groupExternalId *Optional* + response_paging_control (OCI.responsePagingControl): responsePagingControl + *Optional* + sort_order (List[OCI.sortOrder]): sortOrder *Optional* + search_criteria_user_last_name (List[OCI.searchCriteriaUserLastName]): + searchCriteriaUserLastName *Optional* + search_criteria_user_first_name (List[OCI.searchCriteriaUserFirstName]): + searchCriteriaUserFirstName *Optional* + search_criteria_dn (List[OCI.searchCriteriaDn]): searchCriteriaDn *Optional* + search_criteria_email_address (List[OCI.searchCriteriaEmailAddress]): + searchCriteriaEmailAddress *Optional* + search_criteria_department_name (List[OCI.searchCriteriaDepartmentName]): + searchCriteriaDepartmentName *Optional* + search_criteria_exact_user_in_trunk_group + (OCI.searchCriteriaExactUserInTrunkGroup): searchCriteriaExactUserInTrunkGroup + *Optional* + search_criteria_user_id (List[OCI.searchCriteriaUserId]): searchCriteriaUserId + *Optional* + search_criteria_extension (List[OCI.searchCriteriaExtension]): + searchCriteriaExtension *Optional* + search_criteria_exact_dn_activation (OCI.searchCriteriaExactDnActivation): + searchCriteriaExactDnActivation *Optional* + search_criteria_mode_or (bool): searchCriteriaModeOr *Optional* + """ + + __slots__: List[str] = [ + "service_provider_id", + "group_id", + "group_external_id", + "response_paging_control", + "sort_order", + "search_criteria_user_last_name", + "search_criteria_user_first_name", + "search_criteria_dn", + "search_criteria_email_address", + "search_criteria_department_name", + "search_criteria_exact_user_in_trunk_group", + "search_criteria_user_id", + "search_criteria_extension", + "search_criteria_exact_dn_activation", + "search_criteria_mode_or", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("service_provider_id", "serviceProviderId", str), + E("group_id", "groupId", str), + E("group_external_id", "groupExternalId", str), + E( + "response_paging_control", + "responsePagingControl", + OCI.ResponsePagingControl, + is_complex=True, + ), + E( + "sort_order", + "sortOrder", + OCI.SortOrderUserGetListInGroupPagedSortedList, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_last_name", + "searchCriteriaUserLastName", + OCI.SearchCriteriaUserLastName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_user_first_name", + "searchCriteriaUserFirstName", + OCI.SearchCriteriaUserFirstName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_dn", + "searchCriteriaDn", + OCI.SearchCriteriaDn, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_email_address", + "searchCriteriaEmailAddress", + OCI.SearchCriteriaEmailAddress, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_department_name", + "searchCriteriaDepartmentName", + OCI.SearchCriteriaDepartmentName, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_exact_user_in_trunk_group", + "searchCriteriaExactUserInTrunkGroup", + OCI.SearchCriteriaExactUserInTrunkGroup, + is_complex=True, + ), + E( + "search_criteria_user_id", + "searchCriteriaUserId", + OCI.SearchCriteriaUserId, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_extension", + "searchCriteriaExtension", + OCI.SearchCriteriaExtension, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_exact_dn_activation", + "searchCriteriaExactDnActivation", + OCI.SearchCriteriaExactDnActivation, + is_complex=True, + ), + E("search_criteria_mode_or", "searchCriteriaModeOr", bool), + ) + + class GroupAutoAttendantAddInstanceRequest14(OCIRequest): """ Add a Auto Attendant instance to a group. diff --git a/broadworks_ocip/responses.py b/broadworks_ocip/responses.py index 0d2fe38..88a410a 100644 --- a/broadworks_ocip/responses.py +++ b/broadworks_ocip/responses.py @@ -1,7 +1,7 @@ """Broadworks OCI-P Interface Response Classes""" # Autogenerated from the Broadworks XML Schemas. # Do not edit as changes will be overwritten. -# Generated on 2022-03-12T10:21:34.210441 +# Generated on 2022-03-29T09:12:43.402519 from typing import List from typing import Tuple @@ -99130,45 +99130,6 @@ def _elements(cls) -> Tuple[E, ...]: ) -class GroupDepartmentAdminGetResponse(OCIResponse): - """ - Response to the `GroupDepartmentAdminGetRequest()`. - - The response contains the group department administrators profile information. - - Attributes: - department_key (OCI.departmentKey): departmentKey - department_full_path (str): departmentFullPath - first_name (str): firstName *Optional* - last_name (str): lastName *Optional* - language (str): language - """ - - __slots__: List[str] = [ - "department_key", - "department_full_path", - "first_name", - "last_name", - "language", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E( - "department_key", - "departmentKey", - OCI.GroupDepartmentKey, - is_complex=True, - is_required=True, - ), - E("department_full_path", "departmentFullPath", str, is_required=True), - E("first_name", "firstName", str), - E("last_name", "lastName", str), - E("language", "language", str, is_required=True), - ) - - class GroupDepartmentGetAvailableParentListResponse(OCIResponse): """ Response to `GroupDepartmentGetAvailableParentListRequest()`. @@ -120443,6 +120404,45 @@ def _elements(cls) -> Tuple[E, ...]: ) +class GroupDepartmentAdminGetResponse(OCIResponse): + """ + Response to the `GroupDepartmentAdminGetRequest()`. + + The response contains the group department administrators profile information. + + Attributes: + department_key (OCI.departmentKey): departmentKey + department_full_path (str): departmentFullPath + first_name (str): firstName *Optional* + last_name (str): lastName *Optional* + language (str): language + """ + + __slots__: List[str] = [ + "department_key", + "department_full_path", + "first_name", + "last_name", + "language", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E( + "department_key", + "departmentKey", + OCI.GroupDepartmentKey, + is_complex=True, + is_required=True, + ), + E("department_full_path", "departmentFullPath", str, is_required=True), + E("first_name", "firstName", str), + E("last_name", "lastName", str), + E("language", "language", str, is_required=True), + ) + + class GroupFindMeFollowMeGetInstanceResponse(OCIResponse): """ Response to `GroupFindMeFollowMeGetInstanceRequest()`. diff --git a/broadworks_ocip/types.py b/broadworks_ocip/types.py index 80ed50c..2796396 100644 --- a/broadworks_ocip/types.py +++ b/broadworks_ocip/types.py @@ -1,7 +1,7 @@ """Broadworks OCI-P Interface Type Classes""" # Autogenerated from the Broadworks XML Schemas. # Do not edit as changes will be overwritten. -# Generated on 2022-03-12T10:21:34.210441 +# Generated on 2022-03-29T09:12:43.402519 from typing import List from typing import Tuple @@ -5025,31 +5025,6 @@ def _elements(cls) -> Tuple[E, ...]: ) -class EnterpriseDepartmentKey(OCIType): - """ - Uniquely identifies a department defined within an enterprise. - - To uniquely identify an enterprise department, we must know the department name and - which enterprise contains the department. - - Attributes: - service_provider_id (str): serviceProviderId - name (str): name - """ - - __slots__: List[str] = [ - "service_provider_id", - "name", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("service_provider_id", "serviceProviderId", str, is_required=True), - E("name", "name", str, is_required=True), - ) - - class EnterpriseSessionAdmissionControlGroupGetRequest21sp1V2(OCIType): """ Request to get a session admission control group for the enterprise. @@ -5156,70 +5131,6 @@ def _elements(cls) -> Tuple[E, ...]: return () -class EnterpriseVoiceVPNDigitManipulationNoValue(OCIType): - """ - Enterprise Voice VPN Digit Manipulation Entry that has no value. - - - Attributes: - operation (str): operation - """ - - __slots__: List[str] = [ - "operation", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return (E("operation", "operation", str, is_required=True),) - - -class EnterpriseVoiceVPNDigitManipulationOptionalValue(OCIType): - """ - Enterprise Voice VPN Digit Manipulation Entry that optionally has a value. - - - Attributes: - operation (str): operation - value (str): value *Optional* - """ - - __slots__: List[str] = [ - "operation", - "value", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("operation", "operation", str, is_required=True), - E("value", "value", str), - ) - - -class EnterpriseVoiceVPNDigitManipulationRequiredValue(OCIType): - """ - Enterprise Voice VPN Digit Manipulation Entry that has a value. - - - Attributes: - operation (str): operation - value (str): value - """ - - __slots__: List[str] = [ - "operation", - "value", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("operation", "operation", str, is_required=True), - E("value", "value", str, is_required=True), - ) - - class EnterpriseVoiceVPNTreatmentEntry(OCIType): """ Enterprise Voice VPN Treatment entry @@ -8607,34 +8518,6 @@ def _elements(cls) -> Tuple[E, ...]: ) -class GroupDepartmentKey(OCIType): - """ - Uniquely identifies a department defined within a group. - - To uniquely identify a group department, we must know the department name and which - group contains the department. - - Attributes: - service_provider_id (str): serviceProviderId - group_id (str): groupId - name (str): name - """ - - __slots__: List[str] = [ - "service_provider_id", - "group_id", - "name", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("service_provider_id", "serviceProviderId", str, is_required=True), - E("group_id", "groupId", str, is_required=True), - E("name", "name", str, is_required=True), - ) - - class GroupEnterpriseTrunkPriorityWeightedTrunkGroup(OCIType): """ Trunk group details (order and weight) for each trunk group @@ -13762,14348 +13645,15113 @@ def _elements(cls) -> Tuple[E, ...]: return () -class SearchCriteriaAccessDeviceEndpointPrivateIdentity(OCIType): +class SearchCriteriaComposedOr(OCIType): """ - Criteria for searching for a private identity. - + Abstract base type for specifying search criteria where the search criteria params are + OR'ed. - Attributes: - mode (str): mode - value (str): value - is_case_insensitive (bool): isCaseInsensitive + A search criteria is an optional element used to restrict the number of rows returned + when requesting a potentially large set of data from the provisioning server. """ - __slots__: List[str] = [ - "mode", - "value", - "is_case_insensitive", - ] + __slots__: List[str] = [] @classmethod def _elements(cls) -> Tuple[E, ...]: - return ( - E("mode", "mode", str, is_required=True), - E("value", "value", str, is_required=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), - ) + return () -class SearchCriteriaAccessDeviceVersion(OCIType): +class SecurityClassificationCustomizationActivation(OCIType): """ - Criteria for searching for an Access Device Version. + The security classification customization activation. Attributes: - mode (str): mode - value (str): value - is_case_insensitive (bool): isCaseInsensitive + name (str): name + is_customized (bool): isCustomized """ __slots__: List[str] = [ - "mode", - "value", - "is_case_insensitive", + "name", + "is_customized", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("mode", "mode", str, is_required=True), - E("value", "value", str, is_required=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + E("name", "name", str, is_required=True), + E("is_customized", "isCustomized", bool, is_required=True), ) -class SearchCriteriaAdminFirstName(OCIType): +class SelectDistributionListMenuKeysModifyEntry(OCIType): """ - Criteria for searching for an administrator's first name. + The voice portal select distribution list menu keys modify entry. Attributes: - mode (str): mode - value (str): value - is_case_insensitive (bool): isCaseInsensitive + return_to_previous_menu (str): returnToPreviousMenu *Optional* + repeat_menu_or_finish_entering_distribution_list_number (str): + repeatMenuOrFinishEnteringDistributionListNumber *Optional* """ __slots__: List[str] = [ - "mode", - "value", - "is_case_insensitive", + "return_to_previous_menu", + "repeat_menu_or_finish_entering_distribution_list_number", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("mode", "mode", str, is_required=True), - E("value", "value", str, is_required=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + E("return_to_previous_menu", "returnToPreviousMenu", str), + E( + "repeat_menu_or_finish_entering_distribution_list_number", + "repeatMenuOrFinishEnteringDistributionListNumber", + str, + ), ) -class SearchCriteriaAdminId(OCIType): +class SelectDistributionListMenuKeysReadEntry(OCIType): """ - Criteria for searching for an administrator's adminId. + The voice portal select distribution list menu keys. Attributes: - mode (str): mode - value (str): value - is_case_insensitive (bool): isCaseInsensitive + return_to_previous_menu (str): returnToPreviousMenu + repeat_menu_or_finish_entering_distribution_list_number (str): + repeatMenuOrFinishEnteringDistributionListNumber *Optional* """ __slots__: List[str] = [ - "mode", - "value", - "is_case_insensitive", + "return_to_previous_menu", + "repeat_menu_or_finish_entering_distribution_list_number", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("mode", "mode", str, is_required=True), - E("value", "value", str, is_required=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + E("return_to_previous_menu", "returnToPreviousMenu", str, is_required=True), + E( + "repeat_menu_or_finish_entering_distribution_list_number", + "repeatMenuOrFinishEnteringDistributionListNumber", + str, + ), ) -class SearchCriteriaAdminLastName(OCIType): +class SelectiveCallRejectionCriteriaCallType(OCIType): """ - Criteria for searching for an administrator's last name. + The call type criteria used within an add/get request. Attributes: - mode (str): mode - value (str): value - is_case_insensitive (bool): isCaseInsensitive + from_dn_criteria_selection (str): fromDnCriteriaSelection + include_anonymous_callers (bool): includeAnonymousCallers + include_unavailable_callers (bool): includeUnavailableCallers + phone_number (List[str]): phoneNumber *Optional* """ __slots__: List[str] = [ - "mode", - "value", - "is_case_insensitive", + "from_dn_criteria_selection", + "include_anonymous_callers", + "include_unavailable_callers", + "phone_number", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("mode", "mode", str, is_required=True), - E("value", "value", str, is_required=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + E( + "from_dn_criteria_selection", + "fromDnCriteriaSelection", + str, + is_required=True, + ), + E( + "include_anonymous_callers", + "includeAnonymousCallers", + bool, + is_required=True, + ), + E( + "include_unavailable_callers", + "includeUnavailableCallers", + bool, + is_required=True, + ), + E("phone_number", "phoneNumber", str, is_array=True), ) -class SearchCriteriaAgentThresholdProfile(OCIType): +class SendMessageToSelectedDistributionListMenuKeysModifyEntry(OCIType): """ - Criteria for searching a Call Center Agent Threshold Profile. + The voice portal send message to selected distribution list menu keys modify entry. Attributes: - mode (str): mode - value (str): value - is_case_insensitive (bool): isCaseInsensitive + confirm_sending_to_distribution_list (str): confirmSendingToDistributionList + *Optional* + cancel_sending_to_distribution_list (str): cancelSendingToDistributionList + *Optional* """ __slots__: List[str] = [ - "mode", - "value", - "is_case_insensitive", + "confirm_sending_to_distribution_list", + "cancel_sending_to_distribution_list", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("mode", "mode", str, is_required=True), - E("value", "value", str, is_required=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + E( + "confirm_sending_to_distribution_list", + "confirmSendingToDistributionList", + str, + ), + E( + "cancel_sending_to_distribution_list", + "cancelSendingToDistributionList", + str, + ), ) -class SearchCriteriaAlternateTrunkIdentity(OCIType): +class SendMessageToSelectedDistributionListMenuKeysReadEntry(OCIType): """ - Criteria for searching for a particular fully specified alternate trunk identity. + The voice portal send message to selected distribution list menu keys. - In IMS mode, it only applies to the user part of alternate trunk identity. Attributes: - mode (str): mode - value (str): value - is_case_insensitive (bool): isCaseInsensitive + confirm_sending_to_distribution_list (str): confirmSendingToDistributionList + *Optional* + cancel_sending_to_distribution_list (str): cancelSendingToDistributionList """ __slots__: List[str] = [ - "mode", - "value", - "is_case_insensitive", + "confirm_sending_to_distribution_list", + "cancel_sending_to_distribution_list", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("mode", "mode", str, is_required=True), - E("value", "value", str, is_required=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + E( + "confirm_sending_to_distribution_list", + "confirmSendingToDistributionList", + str, + ), + E( + "cancel_sending_to_distribution_list", + "cancelSendingToDistributionList", + str, + is_required=True, + ), ) -class SearchCriteriaAlternateTrunkIdentityDomain(OCIType): +class SendToAllGroupMembersMenuKeysModifyEntry(OCIType): """ - Criteria for searching for alternate trunk identity domain part. + The voice portal send to all group memeber menu keys modify entry. Attributes: - mode (str): mode - value (str): value - is_case_insensitive (bool): isCaseInsensitive + confirm_sending_to_entire_group (str): confirmSendingToEntireGroup *Optional* + cancel_sending_to_entire_group (str): cancelSendingToEntireGroup *Optional* """ __slots__: List[str] = [ - "mode", - "value", - "is_case_insensitive", + "confirm_sending_to_entire_group", + "cancel_sending_to_entire_group", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("mode", "mode", str, is_required=True), - E("value", "value", str, is_required=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + E("confirm_sending_to_entire_group", "confirmSendingToEntireGroup", str), + E("cancel_sending_to_entire_group", "cancelSendingToEntireGroup", str), ) -class SearchCriteriaAlternateUserId(OCIType): +class SendToAllGroupMembersMenuKeysReadEntry(OCIType): """ - Criteria for searching for a user's alternate userId. + The voice portal send to all group memeber menu keys. Attributes: - mode (str): mode - value (str): value - is_case_insensitive (bool): isCaseInsensitive + confirm_sending_to_entire_group (str): confirmSendingToEntireGroup + cancel_sending_to_entire_group (str): cancelSendingToEntireGroup """ __slots__: List[str] = [ - "mode", - "value", - "is_case_insensitive", + "confirm_sending_to_entire_group", + "cancel_sending_to_entire_group", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("mode", "mode", str, is_required=True), - E("value", "value", str, is_required=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + E( + "confirm_sending_to_entire_group", + "confirmSendingToEntireGroup", + str, + is_required=True, + ), + E( + "cancel_sending_to_entire_group", + "cancelSendingToEntireGroup", + str, + is_required=True, + ), ) -class SearchCriteriaAnnouncementFileName(OCIType): +class SendToDistributionListMenuKeysModifyEntry(OCIType): """ - Criteria for searching for an Announcement File Name. + The voice portal send to distribution list menu keys modify entry. Attributes: - mode (str): mode - value (str): value - is_case_insensitive (bool): isCaseInsensitive + send_message_to_selected_distribution_list (str): + sendMessageToSelectedDistributionList *Optional* + select_distribution_list (str): selectDistributionList *Optional* + review_selected_distribution_list (str): reviewSelectedDistributionList *Optional* + return_to_previous_menu (str): returnToPreviousMenu *Optional* + repeat_menu (str): repeatMenu *Optional* """ __slots__: List[str] = [ - "mode", - "value", - "is_case_insensitive", + "send_message_to_selected_distribution_list", + "select_distribution_list", + "review_selected_distribution_list", + "return_to_previous_menu", + "repeat_menu", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("mode", "mode", str, is_required=True), - E("value", "value", str, is_required=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + E( + "send_message_to_selected_distribution_list", + "sendMessageToSelectedDistributionList", + str, + ), + E("select_distribution_list", "selectDistributionList", str), + E( + "review_selected_distribution_list", + "reviewSelectedDistributionList", + str, + ), + E("return_to_previous_menu", "returnToPreviousMenu", str), + E("repeat_menu", "repeatMenu", str), ) -class SearchCriteriaCallCenterName(OCIType): +class SendToDistributionListMenuKeysReadEntry(OCIType): """ - Criteria for searching for a call center + The voice portal send to distribution list menu keys. + Attributes: - mode (str): mode - value (str): value - is_case_insensitive (bool): isCaseInsensitive + send_message_to_selected_distribution_list (str): + sendMessageToSelectedDistributionList + select_distribution_list (str): selectDistributionList *Optional* + review_selected_distribution_list (str): reviewSelectedDistributionList *Optional* + return_to_previous_menu (str): returnToPreviousMenu + repeat_menu (str): repeatMenu *Optional* """ __slots__: List[str] = [ - "mode", - "value", - "is_case_insensitive", + "send_message_to_selected_distribution_list", + "select_distribution_list", + "review_selected_distribution_list", + "return_to_previous_menu", + "repeat_menu", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("mode", "mode", str, is_required=True), - E("value", "value", str, is_required=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + E( + "send_message_to_selected_distribution_list", + "sendMessageToSelectedDistributionList", + str, + is_required=True, + ), + E("select_distribution_list", "selectDistributionList", str), + E( + "review_selected_distribution_list", + "reviewSelectedDistributionList", + str, + ), + E("return_to_previous_menu", "returnToPreviousMenu", str, is_required=True), + E("repeat_menu", "repeatMenu", str), ) -class SearchCriteriaCallCenterReportTemplateName(OCIType): +class SendToPersonMenuKeysModifyEntry(OCIType): """ - Criteria for searching for a particular call center enhanced reporting report - template. + The voice portal send to person menu keys modify entry. Attributes: - mode (str): mode - value (str): value - is_case_insensitive (bool): isCaseInsensitive + confirm_sending_message (str): confirmSendingMessage *Optional* + cancel_sending_message (str): cancelSendingMessage *Optional* + finish_entering_number_where_to_send_message_to (str): + finishEnteringNumberWhereToSendMessageTo *Optional* + finish_forwarding_or_sending_message (str): finishForwardingOrSendingMessage + *Optional* """ __slots__: List[str] = [ - "mode", - "value", - "is_case_insensitive", + "confirm_sending_message", + "cancel_sending_message", + "finish_entering_number_where_to_send_message_to", + "finish_forwarding_or_sending_message", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("mode", "mode", str, is_required=True), - E("value", "value", str, is_required=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + E("confirm_sending_message", "confirmSendingMessage", str), + E("cancel_sending_message", "cancelSendingMessage", str), + E( + "finish_entering_number_where_to_send_message_to", + "finishEnteringNumberWhereToSendMessageTo", + str, + ), + E( + "finish_forwarding_or_sending_message", + "finishForwardingOrSendingMessage", + str, + ), ) -class SearchCriteriaCallCenterScheduledReportName(OCIType): +class SendToPersonMenuKeysReadEntry(OCIType): """ - Criteria for searching for a call center enhanced reporting scheduled report name. + The voice portal send to person menu keys. Attributes: - mode (str): mode - value (str): value - is_case_insensitive (bool): isCaseInsensitive + confirm_sending_message (str): confirmSendingMessage + cancel_sending_message (str): cancelSendingMessage + finish_entering_number_where_to_send_message_to (str): + finishEnteringNumberWhereToSendMessageTo + finish_forwarding_or_sending_message (str): finishForwardingOrSendingMessage """ __slots__: List[str] = [ - "mode", - "value", - "is_case_insensitive", + "confirm_sending_message", + "cancel_sending_message", + "finish_entering_number_where_to_send_message_to", + "finish_forwarding_or_sending_message", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("mode", "mode", str, is_required=True), - E("value", "value", str, is_required=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + E( + "confirm_sending_message", + "confirmSendingMessage", + str, + is_required=True, + ), + E("cancel_sending_message", "cancelSendingMessage", str, is_required=True), + E( + "finish_entering_number_where_to_send_message_to", + "finishEnteringNumberWhereToSendMessageTo", + str, + is_required=True, + ), + E( + "finish_forwarding_or_sending_message", + "finishForwardingOrSendingMessage", + str, + is_required=True, + ), ) -class SearchCriteriaCallParkName(OCIType): +class SequentialRingLocation(OCIType): """ - Criteria for searching for a call park by name + Sequential Ring Location. + + Replaced By: SequentialRingLocation14sp4 Attributes: - mode (str): mode - value (str): value - is_case_insensitive (bool): isCaseInsensitive + phone_number (str): phoneNumber *Optional* + number_of_rings (int): numberOfRings """ __slots__: List[str] = [ - "mode", - "value", - "is_case_insensitive", + "phone_number", + "number_of_rings", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("mode", "mode", str, is_required=True), - E("value", "value", str, is_required=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + E("phone_number", "phoneNumber", str), + E("number_of_rings", "numberOfRings", int, is_required=True), ) -class SearchCriteriaCallPickupName(OCIType): +class SequentialRingLocation14sp4(OCIType): """ - Criteria for searching for a call pickup by name + Sequential Ring Location. + Attributes: - mode (str): mode - value (str): value - is_case_insensitive (bool): isCaseInsensitive + phone_number (str): phoneNumber *Optional* + number_of_rings (int): numberOfRings + answer_confirmation_required (bool): answerConfirmationRequired """ __slots__: List[str] = [ - "mode", - "value", - "is_case_insensitive", + "phone_number", + "number_of_rings", + "answer_confirmation_required", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("mode", "mode", str, is_required=True), - E("value", "value", str, is_required=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + E("phone_number", "phoneNumber", str), + E("number_of_rings", "numberOfRings", int, is_required=True), + E( + "answer_confirmation_required", + "answerConfirmationRequired", + bool, + is_required=True, + ), ) -class SearchCriteriaCommunicationBarringAuthorizationCode(OCIType): +class SequentialRingLocationModify(OCIType): """ - Criteria for searching for a Communication Barring Authorization Code. + Sequential Ring Location. Attributes: - mode (str): mode - value (str): value - is_case_insensitive (bool): isCaseInsensitive + phone_number (str): phoneNumber *Optional* + number_of_rings (int): numberOfRings *Optional* + answer_confirmation_required (bool): answerConfirmationRequired *Optional* """ __slots__: List[str] = [ - "mode", - "value", - "is_case_insensitive", + "phone_number", + "number_of_rings", + "answer_confirmation_required", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("mode", "mode", str, is_required=True), - E("value", "value", str, is_required=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + E("phone_number", "phoneNumber", str), + E("number_of_rings", "numberOfRings", int), + E("answer_confirmation_required", "answerConfirmationRequired", bool), ) -class SearchCriteriaCommunicationBarringAuthorizationCodeDescription(OCIType): +class ServiceActivation(OCIType): """ - Criteria for searching for a Communication Barring Authorization Code description. - + Service Instance active status indicator Attributes: - mode (str): mode - value (str): value - is_case_insensitive (bool): isCaseInsensitive + service_user_id (str): serviceUserId + is_active (bool): isActive """ __slots__: List[str] = [ - "mode", - "value", - "is_case_insensitive", + "service_user_id", + "is_active", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("mode", "mode", str, is_required=True), - E("value", "value", str, is_required=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + E("service_user_id", "serviceUserId", str, is_required=True), + E("is_active", "isActive", bool, is_required=True), ) -class SearchCriteriaComposedOr(OCIType): +class ServiceAttributeEntry(OCIType): """ - Abstract base type for specifying search criteria where the search criteria params are - OR'ed. + The service attributes name and value pair. - A search criteria is an optional element used to restrict the number of rows returned - when requesting a potentially large set of data from the provisioning server. + + Attributes: + name (str): name + value (str): value """ - __slots__: List[str] = [] + __slots__: List[str] = [ + "name", + "value", + ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return () + return ( + E("name", "name", str, is_required=True), + E("value", "value", str, is_required=True), + ) -class SearchCriteriaComposedOrUserName(OCIType): +class ServiceAttributeEntryRead(OCIType): """ - Criteria for searching for a user's full name. + The service attributes name and value pair. - This search criterion will be compared against multiple combinations of first name and - last name: First Name + ‘ ‘ + Last Name Last Name + ‘ ‘ + First Name Hiragana Last - Name + ' ' + Hiragana First Name Note: For this search criterion, the searchMode is - always ‘Contains’ and the search criteria are always OR’ed. Attributes: - value (List[str]): value - is_case_insensitive (bool): isCaseInsensitive + name (str): name + value (str): value *Optional* """ __slots__: List[str] = [ + "name", "value", - "is_case_insensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("value", "value", str, is_required=True, is_array=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + E("name", "name", str, is_required=True), + E("value", "value", str), ) -class SearchCriteriaDepartmentName(OCIType): +class ServiceCodeEntry(OCIType): """ - Criteria for searching for a user's department. + The service code entry. Attributes: - mode (str): mode - value (str): value - is_case_insensitive (bool): isCaseInsensitive + service_code (str): serviceCode + description (str): description """ __slots__: List[str] = [ - "mode", - "value", - "is_case_insensitive", + "service_code", + "description", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("mode", "mode", str, is_required=True), - E("value", "value", str, is_required=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + E("service_code", "serviceCode", str, is_required=True), + E("description", "description", str, is_required=True), ) -class SearchCriteriaDeviceMACAddress(OCIType): +class ServicePolicyAttributeEntry(OCIType): """ - Criteria for searching for device MAC address. + The service policy attributes name and value pair. Attributes: - mode (str): mode - value (str): value - is_case_insensitive (bool): isCaseInsensitive + name (str): name + value (str): value *Optional* """ __slots__: List[str] = [ - "mode", + "name", "value", - "is_case_insensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("mode", "mode", str, is_required=True), - E("value", "value", str, is_required=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + E("name", "name", str, is_required=True), + E("value", "value", str), ) -class SearchCriteriaDeviceManagementEventAdditionalInfo(OCIType): +class ServicePolicyAttributeModifyEntry(OCIType): """ - Criteria for searching for a particular additional info of a DeviceManagement event. + The service policy attributes name and value pair. Attributes: - mode (str): mode + name (str): name value (str): value - is_case_insensitive (bool): isCaseInsensitive """ __slots__: List[str] = [ - "mode", + "name", "value", - "is_case_insensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("mode", "mode", str, is_required=True), + E("name", "name", str, is_required=True), E("value", "value", str, is_required=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), ) -class SearchCriteriaDeviceManagementEventLoginId(OCIType): +class ServicePolicyProfileKey(OCIType): """ - Criteria for searching for a particular login id. + The service policy profile key. Attributes: - mode (str): mode - value (str): value - is_case_insensitive (bool): isCaseInsensitive + name (str): name + category (str): category """ __slots__: List[str] = [ - "mode", - "value", - "is_case_insensitive", + "name", + "category", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("mode", "mode", str, is_required=True), - E("value", "value", str, is_required=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + E("name", "name", str, is_required=True), + E("category", "category", str, is_required=True), ) -class SearchCriteriaDeviceName(OCIType): +class ServiceProviderAdmin(OCIType): """ - Criteria for searching for device name. + The common Service Provider Admin elements. Attributes: - mode (str): mode - value (str): value - is_case_insensitive (bool): isCaseInsensitive + user_id (str): userId + first_name (str): firstName *Optional* + last_name (str): lastName *Optional* + password (str): password *Optional* + language (str): language *Optional* + administrator_type (str): administratorType """ __slots__: List[str] = [ - "mode", - "value", - "is_case_insensitive", + "user_id", + "first_name", + "last_name", + "password", + "language", + "administrator_type", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("mode", "mode", str, is_required=True), - E("value", "value", str, is_required=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + E("user_id", "userId", str, is_required=True), + E("first_name", "firstName", str), + E("last_name", "lastName", str), + E("password", "password", str), + E("language", "language", str), + E("administrator_type", "administratorType", str, is_required=True), ) -class SearchCriteriaDeviceNetAddress(OCIType): +class ServiceProviderBroadWorksMobilityGetRequest21sp1V2(OCIType): """ - Criteria for searching for device network address. + Get the service provider BroadWorks Mobility service settings. + The response is either a ServiceProviderBroadWorksMobilityGetResponse21sp1V2 or an + `ErrorResponse()`. Replaced by `ServiceProviderBroadWorksMobilityGetRequest22V2()`. Attributes: - mode (str): mode - value (str): value - is_case_insensitive (bool): isCaseInsensitive + service_provider_id (str): serviceProviderId """ __slots__: List[str] = [ - "mode", - "value", - "is_case_insensitive", + "service_provider_id", ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return ( - E("mode", "mode", str, is_required=True), - E("value", "value", str, is_required=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), - ) + return (E("service_provider_id", "serviceProviderId", str, is_required=True),) -class SearchCriteriaDeviceSerialNumber(OCIType): +class ServiceProviderBroadWorksMobilityGetResponse21sp1V2(OCIType): """ - Criteria for searching for device serial number. + The response to a ServiceProviderBroadWorksMobilityGetRequest21sp1V2. + Replaced by `ServiceProviderBroadWorksMobilityGetResponse22V2()`. Attributes: - mode (str): mode - value (str): value - is_case_insensitive (bool): isCaseInsensitive + use_setting_level (str): useSettingLevel + enable_location_services (bool): enableLocationServices + enable_msrn_lookup (bool): enableMSRNLookup + enable_mobile_state_checking (bool): enableMobileStateChecking + deny_call_originations (bool): denyCallOriginations + deny_call_terminations (bool): denyCallTerminations + enable_announcement_suppression (bool): enableAnnouncementSuppression + enable_internal_clid_delivery_access_locations (bool): + enableInternalCLIDDeliveryAccessLocations + enable_enhanced_unreachable_state_checking (bool): + enableEnhancedUnreachableStateChecking + enable_network_call_barring_status_check (bool): + enableNetworkCallBarringStatusCheck """ __slots__: List[str] = [ - "mode", - "value", - "is_case_insensitive", + "use_setting_level", + "enable_location_services", + "enable_msrn_lookup", + "enable_mobile_state_checking", + "deny_call_originations", + "deny_call_terminations", + "enable_announcement_suppression", + "enable_internal_clid_delivery_access_locations", + "enable_enhanced_unreachable_state_checking", + "enable_network_call_barring_status_check", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("mode", "mode", str, is_required=True), - E("value", "value", str, is_required=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + E("use_setting_level", "useSettingLevel", str, is_required=True), + E( + "enable_location_services", + "enableLocationServices", + bool, + is_required=True, + ), + E("enable_msrn_lookup", "enableMSRNLookup", bool, is_required=True), + E( + "enable_mobile_state_checking", + "enableMobileStateChecking", + bool, + is_required=True, + ), + E("deny_call_originations", "denyCallOriginations", bool, is_required=True), + E("deny_call_terminations", "denyCallTerminations", bool, is_required=True), + E( + "enable_announcement_suppression", + "enableAnnouncementSuppression", + bool, + is_required=True, + ), + E( + "enable_internal_clid_delivery_access_locations", + "enableInternalCLIDDeliveryAccessLocations", + bool, + is_required=True, + ), + E( + "enable_enhanced_unreachable_state_checking", + "enableEnhancedUnreachableStateChecking", + bool, + is_required=True, + ), + E( + "enable_network_call_barring_status_check", + "enableNetworkCallBarringStatusCheck", + bool, + is_required=True, + ), ) -class SearchCriteriaDeviceType(OCIType): +class ServiceProviderCommunicationBarringHierarchicalCallMeNowRule(OCIType): """ - Criteria for searching for device type. - + Service Provider Communication Barring Hierarchical Call Me Now Rule Attributes: - mode (str): mode - value (str): value - is_case_insensitive (bool): isCaseInsensitive + criteria (str): criteria *Optional* + digit_pattern_criteria (str): digitPatternCriteria *Optional* + action (str): action + call_timeout_seconds (int): callTimeoutSeconds *Optional* + time_schedule (str): timeSchedule *Optional* + holiday_schedule (str): holidaySchedule *Optional* + priority (str): priority """ __slots__: List[str] = [ - "mode", - "value", - "is_case_insensitive", + "criteria", + "digit_pattern_criteria", + "action", + "call_timeout_seconds", + "time_schedule", + "holiday_schedule", + "priority", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("mode", "mode", str, is_required=True), - E("value", "value", str, is_required=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + E("criteria", "criteria", str), + E("digit_pattern_criteria", "digitPatternCriteria", str), + E("action", "action", str, is_required=True), + E("call_timeout_seconds", "callTimeoutSeconds", int), + E("time_schedule", "timeSchedule", str), + E("holiday_schedule", "holidaySchedule", str), + E("priority", "priority", str, is_required=True), ) -class SearchCriteriaDigitPattern(OCIType): +class ServiceProviderCommunicationBarringHierarchicalOriginatingRule(OCIType): """ - Criteria for searching for digit pattern. - + Service Provider Communication Barring Hierarchical Originating Rule Attributes: - mode (str): mode - value (str): value - is_case_insensitive (bool): isCaseInsensitive + criteria (str): criteria *Optional* + digit_pattern_criteria (str): digitPatternCriteria *Optional* + action (str): action + treatment_id (str): treatmentId *Optional* + transfer_number (str): transferNumber *Optional* + call_timeout_seconds (int): callTimeoutSeconds *Optional* + time_schedule (str): timeSchedule *Optional* + holiday_schedule (str): holidaySchedule *Optional* + priority (str): priority """ __slots__: List[str] = [ - "mode", - "value", - "is_case_insensitive", + "criteria", + "digit_pattern_criteria", + "action", + "treatment_id", + "transfer_number", + "call_timeout_seconds", + "time_schedule", + "holiday_schedule", + "priority", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("mode", "mode", str, is_required=True), - E("value", "value", str, is_required=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + E("criteria", "criteria", str), + E("digit_pattern_criteria", "digitPatternCriteria", str), + E("action", "action", str, is_required=True), + E("treatment_id", "treatmentId", str), + E("transfer_number", "transferNumber", str), + E("call_timeout_seconds", "callTimeoutSeconds", int), + E("time_schedule", "timeSchedule", str), + E("holiday_schedule", "holidaySchedule", str), + E("priority", "priority", str, is_required=True), ) -class SearchCriteriaDn(OCIType): +class ServiceProviderCommunicationBarringHierarchicalRedirectingRule(OCIType): """ - Criteria for searching for a DN. - + Service Provider Communication Barring Hierarchical Redirecting Rule Attributes: - mode (str): mode - value (str): value - is_case_insensitive (bool): isCaseInsensitive + criteria (str): criteria *Optional* + digit_pattern_criteria (str): digitPatternCriteria *Optional* + action (str): action + call_timeout_seconds (int): callTimeoutSeconds *Optional* + time_schedule (str): timeSchedule *Optional* + holiday_schedule (str): holidaySchedule *Optional* + priority (str): priority """ __slots__: List[str] = [ - "mode", - "value", - "is_case_insensitive", + "criteria", + "digit_pattern_criteria", + "action", + "call_timeout_seconds", + "time_schedule", + "holiday_schedule", + "priority", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("mode", "mode", str, is_required=True), - E("value", "value", str, is_required=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + E("criteria", "criteria", str), + E("digit_pattern_criteria", "digitPatternCriteria", str), + E("action", "action", str, is_required=True), + E("call_timeout_seconds", "callTimeoutSeconds", int), + E("time_schedule", "timeSchedule", str), + E("holiday_schedule", "holidaySchedule", str), + E("priority", "priority", str, is_required=True), ) -class SearchCriteriaDomainName(OCIType): +class ServiceProviderCommunicationBarringProfileGetRequest19sp1V2(OCIType): """ - Criteria for searching for Domain Names. + Get an existing Communication Barring Profile. + The response is either a ServiceProviderCommunicationBarringProfileGetResponse19sp1V2 + or an `ErrorResponse()`. Attributes: - mode (str): mode - value (str): value - is_case_insensitive (bool): isCaseInsensitive + service_provider_id (str): serviceProviderId + name (str): name """ __slots__: List[str] = [ - "mode", - "value", - "is_case_insensitive", + "service_provider_id", + "name", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("mode", "mode", str, is_required=True), - E("value", "value", str, is_required=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + E("service_provider_id", "serviceProviderId", str, is_required=True), + E("name", "name", str, is_required=True), ) -class SearchCriteriaEmailAddress(OCIType): +class ServiceProviderVoiceMessagingGroupSettingsAdd(OCIType): """ - Criteria for searching for a email address. + A service provider's or enterprise's voice messaging settings used in the context of + add. Attributes: - mode (str): mode - value (str): value - is_case_insensitive (bool): isCaseInsensitive + delivery_from_address (str): deliveryFromAddress *Optional* + notification_from_address (str): notificationFromAddress *Optional* + voice_portal_lockout_from_address (str): voicePortalLockoutFromAddress *Optional* + use_system_default_delivery_from_address (bool): + useSystemDefaultDeliveryFromAddress + use_system_default_notification_from_address (bool): + useSystemDefaultNotificationFromAddress + use_system_default_voice_portal_lockout_from_address (bool): + useSystemDefaultVoicePortalLockoutFromAddress """ __slots__: List[str] = [ - "mode", - "value", - "is_case_insensitive", + "delivery_from_address", + "notification_from_address", + "voice_portal_lockout_from_address", + "use_system_default_delivery_from_address", + "use_system_default_notification_from_address", + "use_system_default_voice_portal_lockout_from_address", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("mode", "mode", str, is_required=True), - E("value", "value", str, is_required=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + E("delivery_from_address", "deliveryFromAddress", str), + E("notification_from_address", "notificationFromAddress", str), + E( + "voice_portal_lockout_from_address", + "voicePortalLockoutFromAddress", + str, + ), + E( + "use_system_default_delivery_from_address", + "useSystemDefaultDeliveryFromAddress", + bool, + is_required=True, + ), + E( + "use_system_default_notification_from_address", + "useSystemDefaultNotificationFromAddress", + bool, + is_required=True, + ), + E( + "use_system_default_voice_portal_lockout_from_address", + "useSystemDefaultVoicePortalLockoutFromAddress", + bool, + is_required=True, + ), ) -class SearchCriteriaEnterpriseCommonMultiPartPhoneListName(OCIType): +class SimultaneousRingNumber(OCIType): """ - Criteria for searching for a multi-part name in an enterprise common phone list. + Simultaneous Ring number entry. - Note: For this search criterion, the searchMode is always ‘Contains’ and the multi- - part search criteria are always AND’ed. Attributes: - value (List[str]): value - is_case_insensitive (bool): isCaseInsensitive + phone_number (str): phoneNumber + answer_confirmation_required (bool): answerConfirmationRequired """ __slots__: List[str] = [ - "value", - "is_case_insensitive", + "phone_number", + "answer_confirmation_required", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("value", "value", str, is_required=True, is_array=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + E("phone_number", "phoneNumber", str, is_required=True), + E( + "answer_confirmation_required", + "answerConfirmationRequired", + bool, + is_required=True, + ), ) -class SearchCriteriaEnterpriseCommonPhoneListName(OCIType): +class SortCriteria(OCIType): """ - Criteria for searching for a name in an enterprise common phone list. + The sort criteria specifies whether sort is ascending or descending, and whether the + sort is case sensitive. + Sort order defaults to ascending and case sensitive. Attributes: - mode (str): mode - value (str): value - is_case_insensitive (bool): isCaseInsensitive + is_ascending (bool): isAscending + is_case_sensitive (bool): isCaseSensitive """ __slots__: List[str] = [ - "mode", - "value", - "is_case_insensitive", + "is_ascending", + "is_case_sensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("mode", "mode", str, is_required=True), - E("value", "value", str, is_required=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + E("is_ascending", "isAscending", bool, is_required=True), + E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), ) -class SearchCriteriaEnterpriseCommonPhoneListNumber(OCIType): +class SortCriteriaNumeric(OCIType): """ - Criteria for searching for a phone number in an enterprise common phone list. + The sort criteria specifies whether sort is ascending or descending. + Sort order defaults to ascending. Attributes: - mode (str): mode - value (str): value - is_case_insensitive (bool): isCaseInsensitive + is_ascending (bool): isAscending """ __slots__: List[str] = [ - "mode", - "value", - "is_case_insensitive", + "is_ascending", ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return ( - E("mode", "mode", str, is_required=True), - E("value", "value", str, is_required=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), - ) + return (E("is_ascending", "isAscending", bool, is_required=True),) -class SearchCriteriaEnterpriseTrunkName(OCIType): +class SpeedDial100Entry(OCIType): """ - Criteria for searching for an Enterprise Trunk name. + Modify the speed dial 100 prefix setting for a group. + The response is either a `SuccessResponse()` or an `ErrorResponse()`. Attributes: - mode (str): mode - value (str): value - is_case_insensitive (bool): isCaseInsensitive + speed_code (int): speedCode + phone_number (str): phoneNumber + description (str): description *Optional* """ __slots__: List[str] = [ - "mode", - "value", - "is_case_insensitive", + "speed_code", + "phone_number", + "description", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("mode", "mode", str, is_required=True), - E("value", "value", str, is_required=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + E("speed_code", "speedCode", int, is_required=True), + E("phone_number", "phoneNumber", str, is_required=True), + E("description", "description", str), ) -class SearchCriteriaExactAnnouncementFileType(OCIType): +class SpeedDial100EntryModify(OCIType): """ - Criteria for searching for a particular announcement file type. + Modify the speed dial 100 prefix setting for a group. + The response is either a `SuccessResponse()` or an `ErrorResponse()`. Attributes: - type (str): type + speed_code (int): speedCode + phone_number (str): phoneNumber *Optional* + description (str): description *Optional* """ __slots__: List[str] = [ - "type", + "speed_code", + "phone_number", + "description", ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return (E("type", "type", str, is_required=True),) + return ( + E("speed_code", "speedCode", int, is_required=True), + E("phone_number", "phoneNumber", str), + E("description", "description", str), + ) -class SearchCriteriaExactAutoAttendantType(OCIType): +class SpeedDial8Entry(OCIType): """ - Criteria for searching for a particular auto-attendant type. + Modify the speed dial 8 prefix setting for a group. + The response is either a `SuccessResponse()` or an `ErrorResponse()`. Attributes: - type (str): type + speed_code (int): speedCode + phone_number (str): phoneNumber *Optional* + description (str): description *Optional* """ __slots__: List[str] = [ - "type", + "speed_code", + "phone_number", + "description", ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return (E("type", "type", str, is_required=True),) + return ( + E("speed_code", "speedCode", int, is_required=True), + E("phone_number", "phoneNumber", str), + E("description", "description", str), + ) -class SearchCriteriaExactCallCenterScheduledReportCreatedBySupervisor(OCIType): +class StreetAddress(OCIType): """ - Criteria for searching for call center scheduled report created by a supervisor or - administrator. + Street address information. Attributes: - created_by_supervisor (bool): createdBySupervisor + address_line1 (str): addressLine1 *Optional* + address_line2 (str): addressLine2 *Optional* + city (str): city *Optional* + state_or_province (str): stateOrProvince *Optional* + state_or_province_display_name (str): stateOrProvinceDisplayName *Optional* + zip_or_postal_code (str): zipOrPostalCode *Optional* + country (str): country *Optional* """ __slots__: List[str] = [ - "created_by_supervisor", + "address_line1", + "address_line2", + "city", + "state_or_province", + "state_or_province_display_name", + "zip_or_postal_code", + "country", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("created_by_supervisor", "createdBySupervisor", bool, is_required=True), + E("address_line1", "addressLine1", str), + E("address_line2", "addressLine2", str), + E("city", "city", str), + E("state_or_province", "stateOrProvince", str), + E("state_or_province_display_name", "stateOrProvinceDisplayName", str), + E("zip_or_postal_code", "zipOrPostalCode", str), + E("country", "country", str), ) -class SearchCriteriaExactCallCenterScheduledReportGroup(OCIType): +class SystemBroadWorksMobilityGetRequest21sp1V2(OCIType): """ - Criteria for searching for a particular fully specified call center scheduled report's - group. - + Get the broadworks mobility system parameters. - Attributes: - service_provider_id (str): serviceProviderId - group_id (str): groupId + The response is either a SystemBroadWorksMobilityGetResponse21sp1V2 or an + `ErrorResponse()`. Replaced by `SystemBroadWorksMobilityGetRequest22V2()`. """ - __slots__: List[str] = [ - "service_provider_id", - "group_id", - ] + __slots__: List[str] = [] @classmethod def _elements(cls) -> Tuple[E, ...]: - return ( - E("service_provider_id", "serviceProviderId", str, is_required=True), - E("group_id", "groupId", str, is_required=True), - ) + return () -class SearchCriteriaExactCallCenterScheduledReportServiceProvider(OCIType): +class SystemBroadWorksMobilityGetResponse21sp1V2(OCIType): """ - Criteria for searching for a particular call center scheduled report's service - provider. + The response to a SystemBroadWorksMobilityGetRequest21sp1V2. + Replaced by `SystemBroadWorksMobilityGetResponse22V2()`. Attributes: - service_provider_id (str): serviceProviderId + enable_location_services (bool): enableLocationServices + enable_msrn_lookup (bool): enableMSRNLookup + enable_mobile_state_checking (bool): enableMobileStateChecking + deny_call_originations (bool): denyCallOriginations + deny_call_terminations (bool): denyCallTerminations + imrn_timeout_millisecnds (int): imrnTimeoutMillisecnds + enable_internal_clid_delivery_access_locations (bool): + enableInternalCLIDDeliveryAccessLocations + enable_enhanced_unreachable_state_checking (bool): + enableEnhancedUnreachableStateChecking + enable_network_call_barring_status_check (bool): + enableNetworkCallBarringStatusCheck """ __slots__: List[str] = [ - "service_provider_id", + "enable_location_services", + "enable_msrn_lookup", + "enable_mobile_state_checking", + "deny_call_originations", + "deny_call_terminations", + "imrn_timeout_millisecnds", + "enable_internal_clid_delivery_access_locations", + "enable_enhanced_unreachable_state_checking", + "enable_network_call_barring_status_check", ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return (E("service_provider_id", "serviceProviderId", str, is_required=True),) + return ( + E( + "enable_location_services", + "enableLocationServices", + bool, + is_required=True, + ), + E("enable_msrn_lookup", "enableMSRNLookup", bool, is_required=True), + E( + "enable_mobile_state_checking", + "enableMobileStateChecking", + bool, + is_required=True, + ), + E("deny_call_originations", "denyCallOriginations", bool, is_required=True), + E("deny_call_terminations", "denyCallTerminations", bool, is_required=True), + E( + "imrn_timeout_millisecnds", + "imrnTimeoutMillisecnds", + int, + is_required=True, + ), + E( + "enable_internal_clid_delivery_access_locations", + "enableInternalCLIDDeliveryAccessLocations", + bool, + is_required=True, + ), + E( + "enable_enhanced_unreachable_state_checking", + "enableEnhancedUnreachableStateChecking", + bool, + is_required=True, + ), + E( + "enable_network_call_barring_status_check", + "enableNetworkCallBarringStatusCheck", + bool, + is_required=True, + ), + ) -class SearchCriteriaExactCallCenterType(OCIType): +class SystemCollaborateGetRequest20sp1V2(OCIType): """ - Criteria for searching for a particular fully specified call center type. - + Request the system level data associated with collaborate services. - Attributes: - call_center_type (str): callCenterType + The response is either a SystemCollaborateGetResponse20sp1V2 or an `ErrorResponse()`. """ - __slots__: List[str] = [ - "call_center_type", - ] + __slots__: List[str] = [] @classmethod def _elements(cls) -> Tuple[E, ...]: - return (E("call_center_type", "callCenterType", str, is_required=True),) + return () -class SearchCriteriaExactCustomContactDirectory(OCIType): +class SystemCommunicationBarringProfileGetRequest19sp1V2(OCIType): """ - Criteria for searching for a particular fully specified custom contact directory. + Get an existing Communication Barring Profile. + The response is either a SystemCommunicationBarringProfileGetResponse19sp1V2 or an + `ErrorResponse()`. Attributes: - custom_contact_directory_name (str): customContactDirectoryName + name (str): name """ __slots__: List[str] = [ - "custom_contact_directory_name", + "name", ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return ( - E( - "custom_contact_directory_name", - "customContactDirectoryName", - str, - is_required=True, - ), - ) + return (E("name", "name", str, is_required=True),) -class SearchCriteriaExactDeviceLevel(OCIType): +class SystemSIPDeviceTypeGetRequest18sp1V2(OCIType): """ - Criteria for searching for a particular device level. + Request to get a sip device type. + + See Also: `SystemDeviceTypeGetRequest()` + The response is either `SystemSIPDeviceTypeGetResponse19()` or `ErrorResponse()`. + Replaced by: `SystemSIPDeviceTypeGetRequest19()`. Attributes: - device_level (str): deviceLevel + device_type (str): deviceType """ __slots__: List[str] = [ - "device_level", + "device_type", ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return (E("device_level", "deviceLevel", str, is_required=True),) + return (E("device_type", "deviceType", str, is_required=True),) -class SearchCriteriaExactDeviceManagementEventAction(OCIType): +class SystemSIPDeviceTypeGetRequest21sp1V2(OCIType): """ - Criteria for searching for a particular fully specified DeviceManagement event action. + Request to get a sip device type. + See Also: `SystemDeviceTypeGetRequest()` + + The response is either SystemSIPDeviceTypeGetResponse21sp1V2 or `ErrorResponse()`. + Replaced by: `SystemSIPDeviceTypeGetRequest22()` in AS data mode. Attributes: - dm_event_action (str): dmEventAction + device_type (str): deviceType """ __slots__: List[str] = [ - "dm_event_action", + "device_type", ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return (E("dm_event_action", "dmEventAction", str, is_required=True),) + return (E("device_type", "deviceType", str, is_required=True),) -class SearchCriteriaExactDeviceManagementEventLevel(OCIType): +class TimeInterval(OCIType): """ - Criteria for searching for a particular fully specified DeviceManagement event level. + Time Interval. Attributes: - dm_event_level (str): dmEventLevel + start_day_of_week (str): startDayOfWeek + start_hour (int): startHour + start_minute (int): startMinute + end_day_of_week (str): endDayOfWeek + end_hour (int): endHour + end_minute (int): endMinute """ __slots__: List[str] = [ - "dm_event_level", + "start_day_of_week", + "start_hour", + "start_minute", + "end_day_of_week", + "end_hour", + "end_minute", ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return (E("dm_event_level", "dmEventLevel", str, is_required=True),) + return ( + E("start_day_of_week", "startDayOfWeek", str, is_required=True), + E("start_hour", "startHour", int, is_required=True), + E("start_minute", "startMinute", int, is_required=True), + E("end_day_of_week", "endDayOfWeek", str, is_required=True), + E("end_hour", "endHour", int, is_required=True), + E("end_minute", "endMinute", int, is_required=True), + ) -class SearchCriteriaExactDeviceManagementEventStatusCompleted(OCIType): +class TimeSchedule(OCIType): """ - Criteria for searching for a particular fully specified Device Management completed - event status. + The from dn criteria. Attributes: - dm_event_status_completed (str): dmEventStatusCompleted + type (str): type + name (str): name """ __slots__: List[str] = [ - "dm_event_status_completed", + "type", + "name", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E( - "dm_event_status_completed", - "dmEventStatusCompleted", - str, - is_required=True, - ), + E("type", "type", str, is_required=True), + E("name", "name", str, is_required=True), ) -class SearchCriteriaExactDeviceManagementEventStatusInProgressOrPending(OCIType): +class TrunkGroupDeviceEndpointAdd(OCIType): """ - Criteria for searching for a particular fully specified Device Management event in - progress or pending status. + Trunk group device endpoint used in the context of modify. Attributes: - dm_event_status_in_progress_or_pending (str): dmEventStatusInProgressOrPending + name (str): name + line_port (str): linePort + contact (str): contact *Optional* """ __slots__: List[str] = [ - "dm_event_status_in_progress_or_pending", + "name", + "line_port", + "contact", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E( - "dm_event_status_in_progress_or_pending", - "dmEventStatusInProgressOrPending", - str, - is_required=True, - ), + E("name", "name", str, is_required=True), + E("line_port", "linePort", str, is_required=True), + E("contact", "contact", str), ) -class SearchCriteriaExactDeviceManagementEventType(OCIType): +class TrunkGroupDeviceEndpointModify(OCIType): """ - Criteria for searching for a particular fully specified DeviceManagement event type. + Trunk group device endpoint used in the context of modify. Attributes: - dm_event_type (str): dmEventType + name (str): name + line_port (str): linePort + contact (str): contact *Optional* """ __slots__: List[str] = [ - "dm_event_type", + "name", + "line_port", + "contact", ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return (E("dm_event_type", "dmEventType", str, is_required=True),) + return ( + E("name", "name", str, is_required=True), + E("line_port", "linePort", str, is_required=True), + E("contact", "contact", str), + ) -class SearchCriteriaExactDeviceServiceProvider(OCIType): +class TrunkGroupDeviceEndpointRead(OCIType): """ - Criteria for searching for a particular fully specified service provider associated - with a device. + Trunk group device endpoint. Attributes: - service_provider_id (str): serviceProviderId + service_user_id (str): serviceUserId + name (str): name + line_port (str): linePort + contact (str): contact *Optional* + static_registration_capable (bool): staticRegistrationCapable + use_domain (bool): useDomain """ __slots__: List[str] = [ - "service_provider_id", + "service_user_id", + "name", + "line_port", + "contact", + "static_registration_capable", + "use_domain", ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return (E("service_provider_id", "serviceProviderId", str, is_required=True),) + return ( + E("service_user_id", "serviceUserId", str, is_required=True), + E("name", "name", str, is_required=True), + E("line_port", "linePort", str, is_required=True), + E("contact", "contact", str), + E( + "static_registration_capable", + "staticRegistrationCapable", + bool, + is_required=True, + ), + E("use_domain", "useDomain", bool, is_required=True), + ) -class SearchCriteriaExactDeviceType(OCIType): +class TrunkGroupDeviceEndpointRead14sp4(OCIType): """ - Criteria for searching for a particular fully specified device type. + Trunk group device endpoint. Attributes: - device_type (str): deviceType + name (str): name + line_port (str): linePort + contact (str): contact *Optional* + static_registration_capable (bool): staticRegistrationCapable + use_domain (bool): useDomain + is_pilot_user (bool): isPilotUser """ __slots__: List[str] = [ - "device_type", + "name", + "line_port", + "contact", + "static_registration_capable", + "use_domain", + "is_pilot_user", ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return (E("device_type", "deviceType", str, is_required=True),) + return ( + E("name", "name", str, is_required=True), + E("line_port", "linePort", str, is_required=True), + E("contact", "contact", str), + E( + "static_registration_capable", + "staticRegistrationCapable", + bool, + is_required=True, + ), + E("use_domain", "useDomain", bool, is_required=True), + E("is_pilot_user", "isPilotUser", bool, is_required=True), + ) -class SearchCriteriaExactDeviceTypeConfigurationOptionType(OCIType): +class TrunkGroupDeviceMultipleContactEndpointAdd(OCIType): """ - Criteria for searching for a particular fully specified - DeviceTypeConfigurationOptionType. + Trunk group device endpoint used in the context of modify that can have multiple + contacts. Attributes: - device_config_options (str): deviceConfigOptions + name (str): name + line_port (str): linePort + contact (List[str]): contact *Optional* """ __slots__: List[str] = [ - "device_config_options", + "name", + "line_port", + "contact", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("device_config_options", "deviceConfigOptions", str, is_required=True), + E("name", "name", str, is_required=True), + E("line_port", "linePort", str, is_required=True), + E("contact", "contact", str, is_array=True), ) -class SearchCriteriaExactDnActivation(OCIType): +class TrunkGroupDeviceMultipleContactEndpointRead(OCIType): """ - Criteria for searching for a particular Dn activation state. + Trunk group device endpoint that can have multiple contacts. Attributes: - activated (bool): activated + name (str): name + line_port (str): linePort + contact (List[str]): contact *Optional* + static_registration_capable (bool): staticRegistrationCapable + use_domain (bool): useDomain + is_pilot_user (bool): isPilotUser """ __slots__: List[str] = [ - "activated", + "name", + "line_port", + "contact", + "static_registration_capable", + "use_domain", + "is_pilot_user", ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return (E("activated", "activated", bool, is_required=True),) + return ( + E("name", "name", str, is_required=True), + E("line_port", "linePort", str, is_required=True), + E("contact", "contact", str, is_array=True), + E( + "static_registration_capable", + "staticRegistrationCapable", + bool, + is_required=True, + ), + E("use_domain", "useDomain", bool, is_required=True), + E("is_pilot_user", "isPilotUser", bool, is_required=True), + ) -class SearchCriteriaExactDnAvailability(OCIType): +class TrunkGroupKey(OCIType): """ - Criteria for searching for a particular dn availability. + Uniquely identifies a Trunk Group system-wide. + The trunkGroupName is unique within a group, but not unique system-wide. Attributes: - available (bool): available + service_provider_id (str): serviceProviderId + group_id (str): groupId + name (str): name """ __slots__: List[str] = [ - "available", + "service_provider_id", + "group_id", + "name", ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return (E("available", "available", bool, is_required=True),) + return ( + E("service_provider_id", "serviceProviderId", str, is_required=True), + E("group_id", "groupId", str, is_required=True), + E("name", "name", str, is_required=True), + ) -class SearchCriteriaExactDomainLevel(OCIType): +class UnboundedNonNegativeInt(OCIType): """ - Criteria for searching for a particular domain level. + Unbounded Quantity. + Can either be unlimited or a non-negative int quantity. Attributes: - domain_level (str): domainLevel + unlimited (bool): unlimited *Optional* + quantity (int): quantity *Optional* """ __slots__: List[str] = [ - "domain_level", + "unlimited", + "quantity", ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return (E("domain_level", "domainLevel", str, is_required=True),) + return ( + E("unlimited", "unlimited", bool), + E("quantity", "quantity", int), + ) -class SearchCriteriaExactEndpointType(OCIType): +class UnboundedPositiveInt(OCIType): """ - Criteria for searching for a particular endpoint type. + Unbounded Quantity. + Can either be unlimited or a positive int quantity. Attributes: - endpoint_type (str): endpointType + unlimited (bool): unlimited *Optional* + quantity (int): quantity *Optional* """ __slots__: List[str] = [ - "endpoint_type", + "unlimited", + "quantity", ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return (E("endpoint_type", "endpointType", str, is_required=True),) + return ( + E("unlimited", "unlimited", bool), + E("quantity", "quantity", int), + ) -class SearchCriteriaExactEndpointType21sp1(OCIType): +class UserBroadWorksMobilityMobileIdentityGetRequest21sp1V2(OCIType): """ - Criteria for searching for a particular endpoint type. + Get the settings for a user's specified mobile identity. + The response is either a UserBroadWorksMobilityMobileIdentityGetResponse21sp1V2 or an + `ErrorResponse()`. Replaced by: `UserBroadWorksMobilityMobileIdentityGetRequest22()`. Attributes: - endpoint_type (str): endpointType + user_id (str): userId + mobile_number (str): mobileNumber """ __slots__: List[str] = [ - "endpoint_type", + "user_id", + "mobile_number", ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return (E("endpoint_type", "endpointType", str, is_required=True),) + return ( + E("user_id", "userId", str, is_required=True), + E("mobile_number", "mobileNumber", str, is_required=True), + ) -class SearchCriteriaExactGroupAdminType(OCIType): +class UserDNExtension(OCIType): """ - Criteria for searching for a particular group administrator type. + User's DN and extension. + Used in SearchCriteriaComposedOrDnExtension when either a DN or an extension can be + used as a search criteria. Attributes: - type (str): type + dn (str): dn *Optional* + extension (str): extension *Optional* """ __slots__: List[str] = [ - "type", + "dn", + "extension", ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return (E("type", "type", str, is_required=True),) + return ( + E("dn", "dn", str), + E("extension", "extension", str), + ) -class SearchCriteriaExactHuntPolicy(OCIType): +class UserDisplayNames(OCIType): """ - Criteria for searching for a particular fully specified hunt policy. + The parts of a user's display name that a client can display in whatever way is + appropriate for the client application. Attributes: - hunt_policy (str): huntPolicy + last_name (str): lastName + first_name (str): firstName + hiragana_last_name (str): hiraganaLastName *Optional* + hiragana_first_name (str): hiraganaFirstName *Optional* """ __slots__: List[str] = [ - "hunt_policy", + "last_name", + "first_name", + "hiragana_last_name", + "hiragana_first_name", ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return (E("hunt_policy", "huntPolicy", str, is_required=True),) + return ( + E("last_name", "lastName", str, is_required=True), + E("first_name", "firstName", str, is_required=True), + E("hiragana_last_name", "hiraganaLastName", str), + E("hiragana_first_name", "hiraganaFirstName", str), + ) -class SearchCriteriaExactLocationEnabled(OCIType): +class UserEndpointKey(OCIType): """ - Criteria for searching for a particular Location enabled state. + Key to uniquely identify a user endpoint. Attributes: - enabled (bool): enabled + user_id (str): userId + line_port (str): linePort """ __slots__: List[str] = [ - "enabled", + "user_id", + "line_port", ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return (E("enabled", "enabled", bool, is_required=True),) + return ( + E("user_id", "userId", str, is_required=True), + E("line_port", "linePort", str, is_required=True), + ) -class SearchCriteriaExactMediaFileType(OCIType): +class UserEnhancedCallLogsGetListResponse17sp4V2(OCIType): """ - Criteria for searching for a particular media file type. + Response to UserEnhancedCallLogsGetListRequest17sp4V2. + Total numbers of rows is: - the total number of retrievable logs of the call log type + that was specified in the UserEnhancedCallLogsGetListRequest17sp4V2, if a call log + type was specified in the request. - the total number of retrievable logs, if no call + log type was specified in the request. A list of MixedCallLogsEntry will be returned + if the call logs are stored on CDS A list of ExtendedMixedCallLogsEntry17sp4 will be + returned if the call logs are stored on DBS The logs are sorted by date/time of the + call. Attributes: - type (str): type + total_number_of_rows (int): totalNumberOfRows + legacy_entry (legacyEntry): legacyEntry *Optional* + extended_entry (extendedEntry): extendedEntry *Optional* """ __slots__: List[str] = [ - "type", + "total_number_of_rows", + "legacy_entry", + "extended_entry", ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return (E("type", "type", str, is_required=True),) + return ( + E("total_number_of_rows", "totalNumberOfRows", int, is_required=True), + E("legacy_entry", "legacyEntry", str, is_complex=True), # unknown + E("extended_entry", "extendedEntry", str, is_complex=True), # unknown + ) -class SearchCriteriaExactMobileDnAvailability(OCIType): +class UserEnhancedCallLogsGetListResponse21sp1V2(OCIType): """ - Criteria for searching for a particular mobile dn availability. + Response to UserEnhancedCallLogsGetListRequest21sp1V2. + Total numbers of rows is: - the total number of retrievable logs of the call log type + that was specified in the UserEnhancedCallLogsGetListRequest21sp1V2, if a call log + type was specified in the request. - the total number of retrievable logs, if no call + log type was specified in the request. A list of MixedCallLogsEntry will be returned + if the call logs are stored on CDS A list of ExtendedMixedCallLogsEntry21sp1V2 will be + returned if the call logs are stored on DBS The logs are sorted by date/time of the + call. Attributes: - available (bool): available + total_number_of_rows (int): totalNumberOfRows + legacy_entry (legacyEntry): legacyEntry *Optional* + extended_entry (extendedEntry): extendedEntry *Optional* """ __slots__: List[str] = [ - "available", + "total_number_of_rows", + "legacy_entry", + "extended_entry", ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return (E("available", "available", bool, is_required=True),) + return ( + E("total_number_of_rows", "totalNumberOfRows", int, is_required=True), + E("legacy_entry", "legacyEntry", str, is_complex=True), # unknown + E("extended_entry", "extendedEntry", str, is_complex=True), # unknown + ) -class SearchCriteriaExactMobileNetwork(OCIType): +class UserFeatureAccessCodeModifyEntry(OCIType): """ - Criteria for searching for a particular BroadWorks Mobility Mobile Network. + Feature Access Code Entry to be used in all user modify command. Attributes: - mobile_network_name (str): mobileNetworkName + feature_access_code_name (str): featureAccessCodeName + enable_fac (bool): enableFAC *Optional* """ __slots__: List[str] = [ - "mobile_network_name", + "feature_access_code_name", + "enable_fac", ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return (E("mobile_network_name", "mobileNetworkName", str, is_required=True),) + return ( + E( + "feature_access_code_name", + "featureAccessCodeName", + str, + is_required=True, + ), + E("enable_fac", "enableFAC", bool), + ) -class SearchCriteriaExactOrganizationType(OCIType): +class UserGetRequest21sp1V2(OCIType): """ - Criteria for searching for an organization type. + Request to get the user information. + The response is either UserGetResponse21sp1V2 or `ErrorResponse()`. Replaced by + `UserGetRequest22V3()` in AS data mode Attributes: - organization_type (str): organizationType + user_id (str): userId """ __slots__: List[str] = [ - "organization_type", + "user_id", ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return (E("organization_type", "organizationType", str, is_required=True),) + return (E("user_id", "userId", str, is_required=True),) -class SearchCriteriaExactPolicySelection(OCIType): +class UserMoveMessage(OCIType): """ - Criteria for searching for a particular Voice VPN policy selection. + The message describes the impact made when moving a user from one group to another + group within the enterprise. + The message could also contain the error condition that prevents the user move. Attributes: - policy_selection (str): policySelection + message_code (int): messageCode + summary (str): summary + summary_english (str): summaryEnglish """ __slots__: List[str] = [ - "policy_selection", + "message_code", + "summary", + "summary_english", ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return (E("policy_selection", "policySelection", str, is_required=True),) + return ( + E("message_code", "messageCode", int, is_required=True), + E("summary", "summary", str, is_required=True), + E("summary_english", "summaryEnglish", str, is_required=True), + ) -class SearchCriteriaExactPortNumber(OCIType): +class UserPreferredCarrierName(OCIType): """ - Criteria for searching for a port number. + User can either use it's group's preferred carrier or use it's own. + The user carrier name is exposed if it was previously configured. Attributes: - port (int): port + use_group_preferred_carrier (bool): useGroupPreferredCarrier + carrier (str): carrier *Optional* """ __slots__: List[str] = [ - "port", + "use_group_preferred_carrier", + "carrier", ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return (E("port", "port", int, is_required=True),) + return ( + E( + "use_group_preferred_carrier", + "useGroupPreferredCarrier", + bool, + is_required=True, + ), + E("carrier", "carrier", str), + ) -class SearchCriteriaExactScheduleLevel(OCIType): +class UserPreferredCarrierNameModify(OCIType): """ - Criteria for searching for a particular schedule level. + User can either use it's group's preferred carrier or use it's own. + You can use the group's preferred carrier without clearing the user carrier name -- in + this case, the user carrier name is retained. Attributes: - level (str): level + use_group_preferred_carrier (bool): useGroupPreferredCarrier + carrier (str): carrier *Optional* """ __slots__: List[str] = [ - "level", + "use_group_preferred_carrier", + "carrier", ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return (E("level", "level", str, is_required=True),) + return ( + E( + "use_group_preferred_carrier", + "useGroupPreferredCarrier", + bool, + is_required=True, + ), + E("carrier", "carrier", str), + ) -class SearchCriteriaExactScheduleType(OCIType): +class UserTwoStageDialingGetRequest13Mp20(OCIType): """ - Criteria for searching for a particular schedule type. + Request the user level data associated with Two Stage Dialing. + The response is either a UserTwoStageDialingGetResponse13Mp20 or an `ErrorResponse()`. Attributes: - type (str): type + user_id (str): userId """ __slots__: List[str] = [ - "type", + "user_id", ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return (E("type", "type", str, is_required=True),) + return (E("user_id", "userId", str, is_required=True),) -class SearchCriteriaExactServiceProvider(OCIType): +class UserTwoStageDialingGetResponse13Mp20(OCIType): """ - Criteria for searching for a particular fully specified service provider. + Response to UserTwoStageDialingGetRequest13Mp20. Attributes: - service_provider_id (str): serviceProviderId + is_active (bool): isActive + allow_activation_with_user_addresses (bool): allowActivationWithUserAddresses """ __slots__: List[str] = [ - "service_provider_id", + "is_active", + "allow_activation_with_user_addresses", ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return (E("service_provider_id", "serviceProviderId", str, is_required=True),) + return ( + E("is_active", "isActive", bool, is_required=True), + E( + "allow_activation_with_user_addresses", + "allowActivationWithUserAddresses", + bool, + is_required=True, + ), + ) -class SearchCriteriaExactServiceProviderAdminType(OCIType): +class VerifyTranslationAndRoutingOrigination(OCIType): """ - Criteria for searching for a particular service provider administrator type. + Verification Translation and Routing origination value. Attributes: - type (str): type + line_port (str): linePort *Optional* + phone (str): phone *Optional* + user_id (str): userId *Optional* + url (str): url *Optional* """ __slots__: List[str] = [ - "type", + "line_port", + "phone", + "user_id", + "url", ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return (E("type", "type", str, is_required=True),) + return ( + E("line_port", "linePort", str), + E("phone", "phone", str), + E("user_id", "userId", str), + E("url", "url", str), + ) -class SearchCriteriaExactServiceType(OCIType): +class VirtualOnNetUser(OCIType): """ - Criteria for searching for a particular fully specified service type. + Virtual On-Net User. Attributes: - service_type (str): serviceType + phone_number (str): phoneNumber + extension (str): extension + first_name (str): firstName + last_name (str): lastName + calling_line_id_first_name (str): callingLineIdFirstName + calling_line_id_last_name (str): callingLineIdLastName + virtual_on_net_call_type_name (str): virtualOnNetCallTypeName """ __slots__: List[str] = [ - "service_type", + "phone_number", + "extension", + "first_name", + "last_name", + "calling_line_id_first_name", + "calling_line_id_last_name", + "virtual_on_net_call_type_name", ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return (E("service_type", "serviceType", str, is_required=True),) + return ( + E("phone_number", "phoneNumber", str, is_required=True), + E("extension", "extension", str, is_required=True), + E("first_name", "firstName", str, is_required=True), + E("last_name", "lastName", str, is_required=True), + E( + "calling_line_id_first_name", + "callingLineIdFirstName", + str, + is_required=True, + ), + E( + "calling_line_id_last_name", + "callingLineIdLastName", + str, + is_required=True, + ), + E( + "virtual_on_net_call_type_name", + "virtualOnNetCallTypeName", + str, + is_required=True, + ), + ) -class SearchCriteriaExactSignalingAddressType(OCIType): +class VirtualOnNetUserKey(OCIType): """ - Criteria for searching for a particular fully specified SignalingAddressType. + Virtual On-Net User identifier which is the Service Provider ID, Group ID, and phone + number (in E. + 164 format). Attributes: - profile (str): profile + service_provider_id (str): serviceProviderId + group_id (str): groupId + phone_number (str): phoneNumber """ __slots__: List[str] = [ - "profile", + "service_provider_id", + "group_id", + "phone_number", ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return (E("profile", "profile", str, is_required=True),) + return ( + E("service_provider_id", "serviceProviderId", str, is_required=True), + E("group_id", "groupId", str, is_required=True), + E("phone_number", "phoneNumber", str, is_required=True), + ) -class SearchCriteriaExactSkillLevel(OCIType): +class VoiceMessagingAliasListModify(OCIType): """ - Criteria for searching for a skill Level. + A list of dns that is added to a previously configured list. Attributes: - skill_level (int): skillLevel + phone_number (List[str]): phoneNumber """ __slots__: List[str] = [ - "skill_level", + "phone_number", ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return (E("skill_level", "skillLevel", int, is_required=True),) + return (E("phone_number", "phoneNumber", str, is_required=True, is_array=True),) -class SearchCriteriaExactUserGroup(OCIType): +class VoiceMessagingAliasReplacementList(OCIType): """ - Criteria for searching for a particular fully specified user's group. + A list of dns that that replaces a previously configured list. + By convention, an element of this type may be set nil to clear the list. Attributes: - service_provider_id (str): serviceProviderId - group_id (str): groupId + phone_number (List[str]): phoneNumber """ __slots__: List[str] = [ - "service_provider_id", - "group_id", + "phone_number", ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return ( - E("service_provider_id", "serviceProviderId", str, is_required=True), - E("group_id", "groupId", str, is_required=True), - ) + return (E("phone_number", "phoneNumber", str, is_required=True, is_array=True),) -class SearchCriteriaExactUserInTrunkGroup(OCIType): +class VoiceMessagingAlternateNoAnswerGreetingRead(OCIType): """ - Criteria for searching for user in/not in a trunk group. + The configuration of a alternate no answer greeting. + It is used when geting a user's voice messaging greeting. Attributes: - user_in_trunk_group (bool): userInTrunkGroup + name (str): name + audio_file (str): audioFile *Optional* + video_file (str): videoFile *Optional* """ __slots__: List[str] = [ - "user_in_trunk_group", + "name", + "audio_file", + "video_file", ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return (E("user_in_trunk_group", "userInTrunkGroup", bool, is_required=True),) + return ( + E("name", "name", str, is_required=True), + E("audio_file", "audioFile", str), + E("video_file", "videoFile", str), + ) -class SearchCriteriaExactUserNetworkClassOfService(OCIType): +class VoiceMessagingAlternateNoAnswerGreetingRead16(OCIType): """ - Criteria for searching for users with a specified network class of service. + The configuration of a alternate no answer greeting. + It is used when geting a user's voice messaging greeting. Attributes: - network_class_of_service (str): networkClassOfService + name (str): name + audio_file (str): audioFile *Optional* + audio_media_type (str): audioMediaType *Optional* + video_file (str): videoFile *Optional* + video_media_type (str): videoMediaType *Optional* """ __slots__: List[str] = [ - "network_class_of_service", + "name", + "audio_file", + "audio_media_type", + "video_file", + "video_media_type", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E( - "network_class_of_service", - "networkClassOfService", - str, - is_required=True, - ), + E("name", "name", str, is_required=True), + E("audio_file", "audioFile", str), + E("audio_media_type", "audioMediaType", str), + E("video_file", "videoFile", str), + E("video_media_type", "videoMediaType", str), ) -class SearchCriteriaExactUserRouteListAssigned(OCIType): +class VoiceMessagingMenuKeysModifyEntry(OCIType): """ - Criteria for searching for users with/without Route List feature assigned. + The voice portal voice messaging menu keys modify entry. Attributes: - route_list_assigned (bool): routeListAssigned + play_messages (str): playMessages *Optional* + change_busy_greeting (str): changeBusyGreeting *Optional* + change_no_answer_greeting (str): changeNoAnswerGreeting *Optional* + change_extended_away_greeting (str): changeExtendedAwayGreeting *Optional* + compose_message (str): composeMessage *Optional* + delete_all_messages (str): deleteAllMessages *Optional* + passcode (str): passcode *Optional* + personalized_name (str): personalizedName *Optional* + message_deposit (str): messageDeposit *Optional* + return_to_previous_menu (str): returnToPreviousMenu *Optional* + repeat_menu (str): repeatMenu *Optional* """ __slots__: List[str] = [ - "route_list_assigned", + "play_messages", + "change_busy_greeting", + "change_no_answer_greeting", + "change_extended_away_greeting", + "compose_message", + "delete_all_messages", + "passcode", + "personalized_name", + "message_deposit", + "return_to_previous_menu", + "repeat_menu", ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return (E("route_list_assigned", "routeListAssigned", bool, is_required=True),) + return ( + E("play_messages", "playMessages", str), + E("change_busy_greeting", "changeBusyGreeting", str), + E("change_no_answer_greeting", "changeNoAnswerGreeting", str), + E("change_extended_away_greeting", "changeExtendedAwayGreeting", str), + E("compose_message", "composeMessage", str), + E("delete_all_messages", "deleteAllMessages", str), + E("passcode", "passcode", str), + E("personalized_name", "personalizedName", str), + E("message_deposit", "messageDeposit", str), + E("return_to_previous_menu", "returnToPreviousMenu", str), + E("repeat_menu", "repeatMenu", str), + ) -class SearchCriteriaExactUserRouteListAssignment(OCIType): +class VoiceMessagingMenuKeysReadEntry(OCIType): """ - Criteria for searching for users with Route List feature assignment. + The voice portal voice messaging menu keys. Attributes: - assigned (bool): assigned + play_messages (str): playMessages *Optional* + change_busy_greeting (str): changeBusyGreeting *Optional* + change_no_answer_greeting (str): changeNoAnswerGreeting *Optional* + change_extended_away_greeting (str): changeExtendedAwayGreeting *Optional* + compose_message (str): composeMessage *Optional* + delete_all_messages (str): deleteAllMessages *Optional* + passcode (str): passcode *Optional* + personalized_name (str): personalizedName *Optional* + message_deposit (str): messageDeposit *Optional* + return_to_previous_menu (str): returnToPreviousMenu + repeat_menu (str): repeatMenu *Optional* """ __slots__: List[str] = [ - "assigned", + "play_messages", + "change_busy_greeting", + "change_no_answer_greeting", + "change_extended_away_greeting", + "compose_message", + "delete_all_messages", + "passcode", + "personalized_name", + "message_deposit", + "return_to_previous_menu", + "repeat_menu", ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return (E("assigned", "assigned", bool, is_required=True),) + return ( + E("play_messages", "playMessages", str), + E("change_busy_greeting", "changeBusyGreeting", str), + E("change_no_answer_greeting", "changeNoAnswerGreeting", str), + E("change_extended_away_greeting", "changeExtendedAwayGreeting", str), + E("compose_message", "composeMessage", str), + E("delete_all_messages", "deleteAllMessages", str), + E("passcode", "passcode", str), + E("personalized_name", "personalizedName", str), + E("message_deposit", "messageDeposit", str), + E("return_to_previous_menu", "returnToPreviousMenu", str, is_required=True), + E("repeat_menu", "repeatMenu", str), + ) -class SearchCriteriaExactUserType(OCIType): +class VoicePortalCallingMenuKeysModifyEntry(OCIType): """ - Criteria for searching for a particular User Type. + The voice portal calling menu keys modify entry. Attributes: - user_type (str): userType + end_current_call_and_go_back_to_previous_menu (str): + endCurrentCallAndGoBackToPreviousMenu *Optional* + return_to_previous_menu (str): returnToPreviousMenu *Optional* """ __slots__: List[str] = [ - "user_type", + "end_current_call_and_go_back_to_previous_menu", + "return_to_previous_menu", ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return (E("user_type", "userType", str, is_required=True),) + return ( + E( + "end_current_call_and_go_back_to_previous_menu", + "endCurrentCallAndGoBackToPreviousMenu", + str, + ), + E("return_to_previous_menu", "returnToPreviousMenu", str), + ) -class SearchCriteriaExactVirtualOnNetCallTypeName(OCIType): +class VoicePortalCallingMenuKeysReadEntry(OCIType): """ - Criteria for searching for a particular fully specified Virtual On-Net Call Type Name. + The voice portal change calling menu keys. Attributes: - virtual_on_net_call_type_name (str): virtualOnNetCallTypeName + end_current_call_and_go_back_to_previous_menu (str): + endCurrentCallAndGoBackToPreviousMenu + return_to_previous_menu (str): returnToPreviousMenu """ __slots__: List[str] = [ - "virtual_on_net_call_type_name", + "end_current_call_and_go_back_to_previous_menu", + "return_to_previous_menu", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( E( - "virtual_on_net_call_type_name", - "virtualOnNetCallTypeName", + "end_current_call_and_go_back_to_previous_menu", + "endCurrentCallAndGoBackToPreviousMenu", str, is_required=True, ), + E("return_to_previous_menu", "returnToPreviousMenu", str, is_required=True), ) -class SearchCriteriaExtension(OCIType): +class VoicePortalLoginMenuKeysModifyEntry(OCIType): """ - Criteria for searching for an extension. + The voice portal voice portal login menu keys modify entry. Attributes: - mode (str): mode - value (str): value - is_case_insensitive (bool): isCaseInsensitive + access_using_other_mailbox_id (str): accessUsingOtherMailboxId *Optional* """ __slots__: List[str] = [ - "mode", - "value", - "is_case_insensitive", + "access_using_other_mailbox_id", ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return ( - E("mode", "mode", str, is_required=True), - E("value", "value", str, is_required=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), - ) + return (E("access_using_other_mailbox_id", "accessUsingOtherMailboxId", str),) -class SearchCriteriaForwardedToNumber(OCIType): +class VoicePortalLoginMenuKeysReadEntry(OCIType): """ - Criteria for searching for a forwarded to number. + The voice portal login menu keys. - This search criteria data type is only intended to be used by the commands introduced - by BW-2301. The commands are `EnterpriseUserCallForwardingSettingsGetListRequest()` - and `GroupUserCallForwardingSettingsGetListRequest()`. The following Call Forwarding - services are compatible for this search: Call Forwarding Always, Call Forwarding - Always Secondary, Call Forwarding Busy, Call Forwarding No Answer, Call Forwarding Not - Reachable, Call Forwarding Selective. Attributes: - mode (str): mode - value (str): value - is_case_insensitive (bool): isCaseInsensitive + access_using_other_mailbox_id (str): accessUsingOtherMailboxId *Optional* """ __slots__: List[str] = [ - "mode", - "value", - "is_case_insensitive", + "access_using_other_mailbox_id", ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return ( - E("mode", "mode", str, is_required=True), - E("value", "value", str, is_required=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), - ) + return (E("access_using_other_mailbox_id", "accessUsingOtherMailboxId", str),) -class SearchCriteriaGroupCommonMultiPartPhoneListName(OCIType): +class VoicePortalMainMenuKeysModifyEntry(OCIType): """ - Criteria for searching for a multi-value name in a group common phone list. + The voice portal main menu keys modify entry. - Note: For this search criterion, the searchMode is always ‘Contains’ and the multi- - part search criteria are always AND’ed. Attributes: - value (List[str]): value - is_case_insensitive (bool): isCaseInsensitive + voice_messaging (str): voiceMessaging *Optional* + comm_pilot_express_profile (str): commPilotExpressProfile *Optional* + greetings (str): greetings *Optional* + call_forwarding_options (str): callForwardingOptions *Optional* + voice_portal_calling (str): voicePortalCalling *Optional* + hoteling (str): hoteling *Optional* + passcode (str): passcode *Optional* + exit_voice_portal (str): exitVoicePortal *Optional* + repeat_menu (str): repeatMenu *Optional* + external_routing (str): externalRouting *Optional* + announcement (str): announcement *Optional* + personal_assistant (str): personalAssistant *Optional* """ __slots__: List[str] = [ - "value", - "is_case_insensitive", + "voice_messaging", + "comm_pilot_express_profile", + "greetings", + "call_forwarding_options", + "voice_portal_calling", + "hoteling", + "passcode", + "exit_voice_portal", + "repeat_menu", + "external_routing", + "announcement", + "personal_assistant", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("value", "value", str, is_required=True, is_array=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + E("voice_messaging", "voiceMessaging", str), + E("comm_pilot_express_profile", "commPilotExpressProfile", str), + E("greetings", "greetings", str), + E("call_forwarding_options", "callForwardingOptions", str), + E("voice_portal_calling", "voicePortalCalling", str), + E("hoteling", "hoteling", str), + E("passcode", "passcode", str), + E("exit_voice_portal", "exitVoicePortal", str), + E("repeat_menu", "repeatMenu", str), + E("external_routing", "externalRouting", str), + E("announcement", "announcement", str), + E("personal_assistant", "personalAssistant", str), ) -class SearchCriteriaGroupCommonPhoneListName(OCIType): +class VoicePortalMainMenuKeysReadEntry(OCIType): """ - Criteria for searching for a name in a group common phone list. + The voice portal main menu keys. Attributes: - mode (str): mode - value (str): value - is_case_insensitive (bool): isCaseInsensitive + voice_messaging (str): voiceMessaging *Optional* + comm_pilot_express_profile (str): commPilotExpressProfile *Optional* + greetings (str): greetings *Optional* + call_forwarding_options (str): callForwardingOptions *Optional* + voice_portal_calling (str): voicePortalCalling *Optional* + hoteling (str): hoteling *Optional* + passcode (str): passcode *Optional* + exit_voice_portal (str): exitVoicePortal *Optional* + repeat_menu (str): repeatMenu *Optional* + external_routing (str): externalRouting *Optional* + announcement (str): announcement *Optional* + personal_assistant (str): personalAssistant *Optional* """ __slots__: List[str] = [ - "mode", - "value", - "is_case_insensitive", + "voice_messaging", + "comm_pilot_express_profile", + "greetings", + "call_forwarding_options", + "voice_portal_calling", + "hoteling", + "passcode", + "exit_voice_portal", + "repeat_menu", + "external_routing", + "announcement", + "personal_assistant", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("mode", "mode", str, is_required=True), - E("value", "value", str, is_required=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + E("voice_messaging", "voiceMessaging", str), + E("comm_pilot_express_profile", "commPilotExpressProfile", str), + E("greetings", "greetings", str), + E("call_forwarding_options", "callForwardingOptions", str), + E("voice_portal_calling", "voicePortalCalling", str), + E("hoteling", "hoteling", str), + E("passcode", "passcode", str), + E("exit_voice_portal", "exitVoicePortal", str), + E("repeat_menu", "repeatMenu", str), + E("external_routing", "externalRouting", str), + E("announcement", "announcement", str), + E("personal_assistant", "personalAssistant", str), ) -class SearchCriteriaGroupCommonPhoneListNumber(OCIType): +class XsiApplicationIdEntry(OCIType): """ - Criteria for searching for a phone number in a group common phone list. + The system application Id entry. Attributes: - mode (str): mode - value (str): value - is_case_insensitive (bool): isCaseInsensitive + xsi_application_id (str): xsiApplicationId + description (str): description *Optional* """ __slots__: List[str] = [ - "mode", - "value", - "is_case_insensitive", + "xsi_application_id", + "description", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("mode", "mode", str, is_required=True), - E("value", "value", str, is_required=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + E("xsi_application_id", "xsiApplicationId", str, is_required=True), + E("description", "description", str), ) -class SearchCriteriaGroupExternalId(OCIType): +class XsiPolicyProfileAssignEntry(OCIType): """ - Criteria for searching by a group's externalId. + The Xsi policy profile assign entry contains multiple Xsi policy profile and one + default xsi policy profile. Attributes: - mode (str): mode - value (str): value + name (List[str]): name *Optional* + default (str): default *Optional* """ __slots__: List[str] = [ - "mode", - "value", + "name", + "default", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("mode", "mode", str, is_required=True), - E("value", "value", str, is_required=True), + E("name", "name", str, is_array=True), + E("default", "default", str), ) -class SearchCriteriaGroupId(OCIType): +class XsiPolicyProfileKey(OCIType): """ - Criteria for searching for a group ID. + The system Xsi policy profile key. Attributes: - mode (str): mode - value (str): value - is_case_insensitive (bool): isCaseInsensitive + name (str): name + level (str): level """ __slots__: List[str] = [ - "mode", - "value", - "is_case_insensitive", + "name", + "level", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("mode", "mode", str, is_required=True), - E("value", "value", str, is_required=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + E("name", "name", str, is_required=True), + E("level", "level", str, is_required=True), ) -class SearchCriteriaGroupLocationCode(OCIType): +class XsiPolicyProfileUnassignEntry(OCIType): """ - Criteria for searching for a group location dialing code. + The Xsi policy profile unassign entry contains mutiltipe Xsi policy profile and a new + replacement default xsi policy profile. Attributes: - mode (str): mode - value (str): value - is_case_insensitive (bool): isCaseInsensitive + name (List[str]): name *Optional* + new_default (str): newDefault *Optional* """ __slots__: List[str] = [ - "mode", - "value", - "is_case_insensitive", + "name", + "new_default", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("mode", "mode", str, is_required=True), - E("value", "value", str, is_required=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + E("name", "name", str, is_array=True), + E("new_default", "newDefault", str), ) -class SearchCriteriaGroupName(OCIType): +class AccessDeviceEndpointAdd(OCIType): """ - Criteria for searching for a group name. + Access device end point used in the context of add. + Port numbers are only used by devices with static line ordering. The following + element is only used in AS data mode and ignored in XS data mode: pathHeader Attributes: - mode (str): mode - value (str): value - is_case_insensitive (bool): isCaseInsensitive + access_device (accessDevice): accessDevice + line_port (str): linePort + contact (str): contact *Optional* + path_header (str): pathHeader *Optional* + port_number (int): portNumber *Optional* """ __slots__: List[str] = [ - "mode", - "value", - "is_case_insensitive", + "access_device", + "line_port", + "contact", + "path_header", + "port_number", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("mode", "mode", str, is_required=True), - E("value", "value", str, is_required=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + E( + "access_device", + "accessDevice", + AccessDevice, + is_complex=True, + is_required=True, + ), + E("line_port", "linePort", str, is_required=True), + E("contact", "contact", str), + E("path_header", "pathHeader", str), + E("port_number", "portNumber", int), ) -class SearchCriteriaHomeMscAddress(OCIType): +class AccessDeviceEndpointAndHotlineAdd(OCIType): """ - Criteria for searching for a system Home Network Msc Address. + Access device end point used in the context of add. + Port numbers are only used by devices with static line ordering. The following + element is only used in AS data mode and ignored in XS data mode: pathHeader + useHotline, use value false in XS data mode hotlineContact The following element is + only used in XS data mode and ignored in AS data mode: privateIdentity Attributes: - mode (str): mode - value (str): value - is_case_insensitive (bool): isCaseInsensitive + access_device (accessDevice): accessDevice + line_port (str): linePort + private_identity (str): privateIdentity *Optional* + contact (str): contact *Optional* + path_header (str): pathHeader *Optional* + port_number (int): portNumber *Optional* + use_hotline (bool): useHotline + hotline_contact (str): hotlineContact *Optional* """ __slots__: List[str] = [ - "mode", - "value", - "is_case_insensitive", + "access_device", + "line_port", + "private_identity", + "contact", + "path_header", + "port_number", + "use_hotline", + "hotline_contact", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("mode", "mode", str, is_required=True), - E("value", "value", str, is_required=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + E( + "access_device", + "accessDevice", + AccessDevice, + is_complex=True, + is_required=True, + ), + E("line_port", "linePort", str, is_required=True), + E("private_identity", "privateIdentity", str), + E("contact", "contact", str), + E("path_header", "pathHeader", str), + E("port_number", "portNumber", int), + E("use_hotline", "useHotline", bool, is_required=True), + E("hotline_contact", "hotlineContact", str), ) -class SearchCriteriaIMRN(OCIType): +class AccessDeviceEndpointAndHotlineModify(OCIType): """ - Criteria for searching for an IMRN Number. + Access device end point used in the context of modify. + Port numbers are only used by devices with static line ordering. The following + element is only used in AS data mode and ignored in XS data mode: pathHeader + useHotline hotlineContact Attributes: - mode (str): mode - value (str): value - is_case_insensitive (bool): isCaseInsensitive + access_device (accessDevice): accessDevice + line_port (str): linePort + contact (str): contact *Optional* + path_header (str): pathHeader *Optional* + port_number (int): portNumber *Optional* + use_hotline (bool): useHotline *Optional* + hotline_contact (str): hotlineContact *Optional* """ __slots__: List[str] = [ - "mode", - "value", - "is_case_insensitive", + "access_device", + "line_port", + "contact", + "path_header", + "port_number", + "use_hotline", + "hotline_contact", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("mode", "mode", str, is_required=True), - E("value", "value", str, is_required=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + E( + "access_device", + "accessDevice", + AccessDevice, + is_complex=True, + is_required=True, + ), + E("line_port", "linePort", str, is_required=True), + E("contact", "contact", str), + E("path_header", "pathHeader", str), + E("port_number", "portNumber", int), + E("use_hotline", "useHotline", bool), + E("hotline_contact", "hotlineContact", str), ) -class SearchCriteriaImpId(OCIType): +class AccessDeviceEndpointKey(OCIType): """ - Criteria for searching for a user's IMP Id. + Access device end point in the context of a modify or delete command. Attributes: - mode (str): mode - value (str): value - is_case_insensitive (bool): isCaseInsensitive + access_device (accessDevice): accessDevice + line_port (str): linePort """ __slots__: List[str] = [ - "mode", - "value", - "is_case_insensitive", + "access_device", + "line_port", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("mode", "mode", str, is_required=True), - E("value", "value", str, is_required=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + E( + "access_device", + "accessDevice", + AccessDevice, + is_complex=True, + is_required=True, + ), + E("line_port", "linePort", str, is_required=True), ) -class SearchCriteriaLanguage(OCIType): +class AccessDeviceEndpointModify(OCIType): """ - Criteria for searching for a language. + Access device end point used in the context of modify. + Port numbers are only used by devices with static line ordering. The following + element is only used in AS data mode and ignored in XS data mode: pathHeader Attributes: - mode (str): mode - value (str): value - is_case_insensitive (bool): isCaseInsensitive + access_device (accessDevice): accessDevice + line_port (str): linePort + contact (str): contact *Optional* + path_header (str): pathHeader *Optional* + port_number (int): portNumber *Optional* """ __slots__: List[str] = [ - "mode", - "value", - "is_case_insensitive", + "access_device", + "line_port", + "contact", + "path_header", + "port_number", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("mode", "mode", str, is_required=True), - E("value", "value", str, is_required=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + E( + "access_device", + "accessDevice", + AccessDevice, + is_complex=True, + is_required=True, + ), + E("line_port", "linePort", str, is_required=True), + E("contact", "contact", str), + E("path_header", "pathHeader", str), + E("port_number", "portNumber", int), ) -class SearchCriteriaLinePortDomain(OCIType): +class AccessDeviceEndpointRead14(OCIType): """ - Criteria for searching for device line/port, or SIPURI domain part. + Access device end point. Attributes: - mode (str): mode - value (str): value - is_case_insensitive (bool): isCaseInsensitive + access_device (accessDevice): accessDevice + line_port (str): linePort + contact (str): contact *Optional* + static_registration_capable (bool): staticRegistrationCapable + use_domain (bool): useDomain """ __slots__: List[str] = [ - "mode", - "value", - "is_case_insensitive", + "access_device", + "line_port", + "contact", + "static_registration_capable", + "use_domain", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("mode", "mode", str, is_required=True), - E("value", "value", str, is_required=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + E( + "access_device", + "accessDevice", + AccessDevice, + is_complex=True, + is_required=True, + ), + E("line_port", "linePort", str, is_required=True), + E("contact", "contact", str), + E( + "static_registration_capable", + "staticRegistrationCapable", + bool, + is_required=True, + ), + E("use_domain", "useDomain", bool, is_required=True), ) -class SearchCriteriaLinePortUserPart(OCIType): +class AccessDeviceEndpointWithPortNumberRead(OCIType): """ - Criteria for searching for device line/port, or SIPURI user part. + Access device end point. + Port numbers are only used by devices with static line ordering. Attributes: - mode (str): mode - value (str): value - is_case_insensitive (bool): isCaseInsensitive + access_device (accessDevice): accessDevice + line_port (str): linePort + contact (str): contact *Optional* + static_registration_capable (bool): staticRegistrationCapable + use_domain (bool): useDomain + port_number (int): portNumber *Optional* """ __slots__: List[str] = [ - "mode", - "value", - "is_case_insensitive", + "access_device", + "line_port", + "contact", + "static_registration_capable", + "use_domain", + "port_number", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("mode", "mode", str, is_required=True), - E("value", "value", str, is_required=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + E( + "access_device", + "accessDevice", + AccessDevice, + is_complex=True, + is_required=True, + ), + E("line_port", "linePort", str, is_required=True), + E("contact", "contact", str), + E( + "static_registration_capable", + "staticRegistrationCapable", + bool, + is_required=True, + ), + E("use_domain", "useDomain", bool, is_required=True), + E("port_number", "portNumber", int), ) -class SearchCriteriaLocation(OCIType): +class AccessDeviceEndpointWithPortNumberRead22(OCIType): """ - Criteria for searching for a Location. + Access device end point. + Port numbers are only used by devices with static line ordering. The following + element is only used in AS data mode and ignored in XS data mode: pathHeader Attributes: - mode (str): mode - value (str): value - is_case_insensitive (bool): isCaseInsensitive + access_device (accessDevice): accessDevice + line_port (str): linePort + contact (str): contact *Optional* + path_header (str): pathHeader *Optional* + static_registration_capable (bool): staticRegistrationCapable + use_domain (bool): useDomain + port_number (int): portNumber *Optional* """ __slots__: List[str] = [ - "mode", - "value", - "is_case_insensitive", + "access_device", + "line_port", + "contact", + "path_header", + "static_registration_capable", + "use_domain", + "port_number", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("mode", "mode", str, is_required=True), - E("value", "value", str, is_required=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + E( + "access_device", + "accessDevice", + AccessDevice, + is_complex=True, + is_required=True, + ), + E("line_port", "linePort", str, is_required=True), + E("contact", "contact", str), + E("path_header", "pathHeader", str), + E( + "static_registration_capable", + "staticRegistrationCapable", + bool, + is_required=True, + ), + E("use_domain", "useDomain", bool, is_required=True), + E("port_number", "portNumber", int), ) -class SearchCriteriaLoginId(OCIType): +class AccessDeviceEndpointWithPortNumberRead22V2(OCIType): """ - Criteria for searching for a Login Id. + Access device end point. + Port numbers are only used by devices with static line ordering. The following + element is only used in AS data mode and ignored in XS data mode: pathHeader + hotlineContact The following elements are only used in AS data mode and a value false + is returned in the XS mode: useHotline Attributes: - mode (str): mode - value (str): value - is_case_insensitive (bool): isCaseInsensitive + access_device (accessDevice): accessDevice + line_port (str): linePort + contact (str): contact *Optional* + path_header (str): pathHeader *Optional* + static_registration_capable (bool): staticRegistrationCapable + use_domain (bool): useDomain + port_number (int): portNumber *Optional* + use_hotline (bool): useHotline + hotline_contact (str): hotlineContact *Optional* """ __slots__: List[str] = [ - "mode", - "value", - "is_case_insensitive", - ] - - @classmethod + "access_device", + "line_port", + "contact", + "path_header", + "static_registration_capable", + "use_domain", + "port_number", + "use_hotline", + "hotline_contact", + ] + + @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("mode", "mode", str, is_required=True), - E("value", "value", str, is_required=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + E( + "access_device", + "accessDevice", + AccessDevice, + is_complex=True, + is_required=True, + ), + E("line_port", "linePort", str, is_required=True), + E("contact", "contact", str), + E("path_header", "pathHeader", str), + E( + "static_registration_capable", + "staticRegistrationCapable", + bool, + is_required=True, + ), + E("use_domain", "useDomain", bool, is_required=True), + E("port_number", "portNumber", int), + E("use_hotline", "useHotline", bool, is_required=True), + E("hotline_contact", "hotlineContact", str), ) -class SearchCriteriaMobilePhoneNumber(OCIType): +class AccessDeviceMultipleContactEndpointAdd(OCIType): """ - Criteria for searching for a user's mobile phone number. + Access device end point used in the context of add that can have more than one contact + defined. + Only Static Registration capabable devices may have more than one contact defined. + Port numbers are only used by devices with static line ordering. Attributes: - mode (str): mode - value (str): value - is_case_insensitive (bool): isCaseInsensitive + access_device (accessDevice): accessDevice + line_port (str): linePort + contact (List[str]): contact *Optional* + port_number (int): portNumber *Optional* """ __slots__: List[str] = [ - "mode", - "value", - "is_case_insensitive", + "access_device", + "line_port", + "contact", + "port_number", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("mode", "mode", str, is_required=True), - E("value", "value", str, is_required=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + E( + "access_device", + "accessDevice", + AccessDevice, + is_complex=True, + is_required=True, + ), + E("line_port", "linePort", str, is_required=True), + E("contact", "contact", str, is_array=True), + E("port_number", "portNumber", int), ) -class SearchCriteriaMobileSubscriberDirectoryNumber(OCIType): +class AccessDeviceMultipleContactEndpointAdd22(OCIType): """ - Criteria for searching for a BroadWorks Mobility Mobile Subscriber Directory Number. + Access device end point used in the context of add that can have more than one contact + defined. + Only Static Registration capabable devices may have more than one contact defined. + Port numbers are only used by devices with static line ordering. Attributes: - mode (str): mode - value (str): value - is_case_insensitive (bool): isCaseInsensitive + access_device (accessDevice): accessDevice + line_port (str): linePort + contact (List[contact]): contact *Optional* + port_number (int): portNumber *Optional* """ __slots__: List[str] = [ - "mode", - "value", - "is_case_insensitive", + "access_device", + "line_port", + "contact", + "port_number", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("mode", "mode", str, is_required=True), - E("value", "value", str, is_required=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + E( + "access_device", + "accessDevice", + AccessDevice, + is_complex=True, + is_required=True, + ), + E("line_port", "linePort", str, is_required=True), + E("contact", "contact", SIPContactInfo, is_complex=True, is_array=True), + E("port_number", "portNumber", int), ) -class SearchCriteriaMultiPartUserName(OCIType): +class AccessDeviceMultipleContactEndpointModify(OCIType): """ - Criteria for searching for a user's full name. + Access device end point used in the context of modify that can have more than one + contact defined. - This search criterion will be compared against multiple combinations of first name and - last name: First Name + ‘ ‘ + Last Name Last Name + ‘ ‘ + First Name Last Name + ‘, ‘ - + First Name Hiragana Last Name + Hiragana First Name Note that when specific - conditions are met, VON users will be included in the search results. Note: For this - search criterion, the searchMode is always ‘Contains’ and the multi-part search - criteria are always AND’ed. + Only Static Registration capable devices may have more than one contact defined. Port + numbers are only used by devices with static line ordering. Attributes: - value (List[str]): value - is_case_insensitive (bool): isCaseInsensitive + access_device (accessDevice): accessDevice *Optional* + line_port (str): linePort *Optional* + contact_list (contactList): contactList *Optional* + port_number (int): portNumber *Optional* """ __slots__: List[str] = [ - "value", - "is_case_insensitive", + "access_device", + "line_port", + "contact_list", + "port_number", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("value", "value", str, is_required=True, is_array=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + E("access_device", "accessDevice", AccessDevice, is_complex=True), + E("line_port", "linePort", str), + E("contact_list", "contactList", ReplacementContactList, is_complex=True), + E("port_number", "portNumber", int), ) -class SearchCriteriaNetworkClassOfServiceName(OCIType): +class AccessDeviceMultipleContactEndpointRead(OCIType): """ - Criteria for searching for a Network Class of Service name. + Access device end point that can have multiple contacts. + Replaced by AccessDeviceMultipleContactEndpointRead19. Attributes: - mode (str): mode - value (str): value - is_case_insensitive (bool): isCaseInsensitive + access_device (accessDevice): accessDevice + line_port (str): linePort + contact (List[str]): contact *Optional* + static_registration_capable (bool): staticRegistrationCapable + use_domain (bool): useDomain """ __slots__: List[str] = [ - "mode", - "value", - "is_case_insensitive", + "access_device", + "line_port", + "contact", + "static_registration_capable", + "use_domain", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("mode", "mode", str, is_required=True), - E("value", "value", str, is_required=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + E( + "access_device", + "accessDevice", + AccessDevice, + is_complex=True, + is_required=True, + ), + E("line_port", "linePort", str, is_required=True), + E("contact", "contact", str, is_array=True), + E( + "static_registration_capable", + "staticRegistrationCapable", + bool, + is_required=True, + ), + E("use_domain", "useDomain", bool, is_required=True), ) -class SearchCriteriaNumberPortabilityQueryDigitPattern(OCIType): +class AccessDeviceMultipleContactEndpointRead19(OCIType): """ - Criteria for searching for digit pattern. + Access device end point that can have multiple contacts. + Port numbers are only used by devices with static line ordering. Replaced by + AccessDeviceMultipleContactEndpointRead20. Attributes: - mode (str): mode - value (str): value - is_case_insensitive (bool): isCaseInsensitive + access_device (accessDevice): accessDevice + line_port (str): linePort + contact (List[str]): contact *Optional* + static_registration_capable (bool): staticRegistrationCapable + use_domain (bool): useDomain + port_number (int): portNumber *Optional* """ __slots__: List[str] = [ - "mode", - "value", - "is_case_insensitive", + "access_device", + "line_port", + "contact", + "static_registration_capable", + "use_domain", + "port_number", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("mode", "mode", str, is_required=True), - E("value", "value", str, is_required=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + E( + "access_device", + "accessDevice", + AccessDevice, + is_complex=True, + is_required=True, + ), + E("line_port", "linePort", str, is_required=True), + E("contact", "contact", str, is_array=True), + E( + "static_registration_capable", + "staticRegistrationCapable", + bool, + is_required=True, + ), + E("use_domain", "useDomain", bool, is_required=True), + E("port_number", "portNumber", int), ) -class SearchCriteriaNumberPortabilityStatus(OCIType): +class AccessDeviceMultipleContactEndpointRead20(OCIType): """ - Criteria for searching for number portability status. + Access device end point that can have multiple contacts. + Port numbers are only used by devices with static line ordering. Replaced by + AccessDeviceMultipleContactEndpointRead22. Attributes: - mode (str): mode - value (str): value - is_case_insensitive (bool): isCaseInsensitive + access_device (accessDevice): accessDevice + line_port (str): linePort + contact (List[str]): contact *Optional* + static_registration_capable (bool): staticRegistrationCapable + use_domain (bool): useDomain + port_number (int): portNumber *Optional* + support_visual_device_management (bool): supportVisualDeviceManagement """ __slots__: List[str] = [ - "mode", - "value", - "is_case_insensitive", + "access_device", + "line_port", + "contact", + "static_registration_capable", + "use_domain", + "port_number", + "support_visual_device_management", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("mode", "mode", str, is_required=True), - E("value", "value", str, is_required=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + E( + "access_device", + "accessDevice", + AccessDevice, + is_complex=True, + is_required=True, + ), + E("line_port", "linePort", str, is_required=True), + E("contact", "contact", str, is_array=True), + E( + "static_registration_capable", + "staticRegistrationCapable", + bool, + is_required=True, + ), + E("use_domain", "useDomain", bool, is_required=True), + E("port_number", "portNumber", int), + E( + "support_visual_device_management", + "supportVisualDeviceManagement", + bool, + is_required=True, + ), ) -class SearchCriteriaOutgoingDNorSIPURI(OCIType): +class AccessDeviceMultipleContactEndpointRead22(OCIType): """ - Criteria for searching for a phone number or SIPURI. + Access device end point that can have multiple contacts. + Port numbers are only used by devices with static line ordering. Attributes: - mode (str): mode - value (str): value - is_case_insensitive (bool): isCaseInsensitive + access_device (accessDevice): accessDevice + line_port (str): linePort + contact (List[contact]): contact *Optional* + static_registration_capable (bool): staticRegistrationCapable + use_domain (bool): useDomain + port_number (int): portNumber *Optional* + support_visual_device_management (bool): supportVisualDeviceManagement """ __slots__: List[str] = [ - "mode", - "value", - "is_case_insensitive", + "access_device", + "line_port", + "contact", + "static_registration_capable", + "use_domain", + "port_number", + "support_visual_device_management", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("mode", "mode", str, is_required=True), - E("value", "value", str, is_required=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + E( + "access_device", + "accessDevice", + AccessDevice, + is_complex=True, + is_required=True, + ), + E("line_port", "linePort", str, is_required=True), + E("contact", "contact", SIPContactInfo, is_complex=True, is_array=True), + E( + "static_registration_capable", + "staticRegistrationCapable", + bool, + is_required=True, + ), + E("use_domain", "useDomain", bool, is_required=True), + E("port_number", "portNumber", int), + E( + "support_visual_device_management", + "supportVisualDeviceManagement", + bool, + is_required=True, + ), ) -class SearchCriteriaPersonalAssistantExclusionNumber(OCIType): +class AccessDeviceMultipleIdentityAndContactEndpointAdd(OCIType): """ - Criteria for searching for Personal Assistant Exclusion Number. + Access device end point used in the context of add that can have more than one contact + defined. + The endpoint is identified by its linePort (public Identity) and possibly a private + Identity. Only Static Registration capabable devices may have more than one contact + defined. Port numbers are only used by devices with static line ordering. The + following elements are only used in XS data mode and ignored in AS data mode: + privateIdentity Attributes: - mode (str): mode - value (str): value - is_case_insensitive (bool): isCaseInsensitive + access_device (accessDevice): accessDevice + line_port (str): linePort + private_identity (str): privateIdentity *Optional* + contact (List[str]): contact *Optional* + port_number (int): portNumber *Optional* """ __slots__: List[str] = [ - "mode", - "value", - "is_case_insensitive", + "access_device", + "line_port", + "private_identity", + "contact", + "port_number", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("mode", "mode", str, is_required=True), - E("value", "value", str, is_required=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + E( + "access_device", + "accessDevice", + AccessDevice, + is_complex=True, + is_required=True, + ), + E("line_port", "linePort", str, is_required=True), + E("private_identity", "privateIdentity", str), + E("contact", "contact", str, is_array=True), + E("port_number", "portNumber", int), ) -class SearchCriteriaPersonalAssistantExclusionNumberDescription(OCIType): +class AccessDeviceMultipleIdentityAndContactEndpointAdd22(OCIType): """ - Criteria for searching Personal Assistant Exclusion Number's Description. + Access device end point used in the context of add that can have more than one contact + defined. + The endpoint is identified by its linePort (public Identity) and possibly a private + Identity. Only Static Registration capabable devices may have more than one contact + defined. Port numbers are only used by devices with static line ordering. The + following elements are only used in XS data mode and ignored in AS data mode: + privateIdentity Attributes: - mode (str): mode - value (str): value - is_case_insensitive (bool): isCaseInsensitive + access_device (accessDevice): accessDevice + line_port (str): linePort + private_identity (str): privateIdentity *Optional* + contact (List[contact]): contact *Optional* + port_number (int): portNumber *Optional* """ __slots__: List[str] = [ - "mode", - "value", - "is_case_insensitive", + "access_device", + "line_port", + "private_identity", + "contact", + "port_number", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("mode", "mode", str, is_required=True), - E("value", "value", str, is_required=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + E( + "access_device", + "accessDevice", + AccessDevice, + is_complex=True, + is_required=True, + ), + E("line_port", "linePort", str, is_required=True), + E("private_identity", "privateIdentity", str), + E("contact", "contact", SIPContactInfo, is_complex=True, is_array=True), + E("port_number", "portNumber", int), ) -class SearchCriteriaPhysicalLocation(OCIType): +class AccessDeviceMultipleIdentityAndContactEndpointAdd22V2(OCIType): """ - Criteria for searching for a Physical Location. + Access device end point used in the context of add that can have more than one contact + defined. + The endpoint is identified by its linePort (public Identity) and possibly a private + Identity. Only Static Registration capabable devices may have more than one contact + defined. Port numbers are only used by devices with static line ordering. The + following elements are only used in XS data mode and ignored in AS data mode: + privateIdentity The following elements are only used in AS data mode and ignored in XS + data mode: useHotline, use value false in XS data mode hotlineContact Attributes: - mode (str): mode - value (str): value - is_case_insensitive (bool): isCaseInsensitive + access_device (accessDevice): accessDevice + line_port (str): linePort + private_identity (str): privateIdentity *Optional* + contact (List[contact]): contact *Optional* + port_number (int): portNumber *Optional* + use_hotline (bool): useHotline + hotline_contact (str): hotlineContact *Optional* """ __slots__: List[str] = [ - "mode", - "value", - "is_case_insensitive", + "access_device", + "line_port", + "private_identity", + "contact", + "port_number", + "use_hotline", + "hotline_contact", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("mode", "mode", str, is_required=True), - E("value", "value", str, is_required=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + E( + "access_device", + "accessDevice", + AccessDevice, + is_complex=True, + is_required=True, + ), + E("line_port", "linePort", str, is_required=True), + E("private_identity", "privateIdentity", str), + E("contact", "contact", SIPContactInfo, is_complex=True, is_array=True), + E("port_number", "portNumber", int), + E("use_hotline", "useHotline", bool, is_required=True), + E("hotline_contact", "hotlineContact", str), ) -class SearchCriteriaProfileServiceCode(OCIType): +class AccessDeviceMultipleIdentityAndContactEndpointModify(OCIType): """ - Criteria for searching for a Service Code. + Access device end point used in the context of modify that can have more than one + contact defined. + The endpoint is identified by its linePort (public Identity) and possibly a private + Identity. Only Static Registration capabable devices may have more than one contact + defined. Port numbers are only used by devices with static line ordering. The + following elements are only used in XS data mode and ignored in AS data mode: + privateIdentity Attributes: - mode (str): mode - value (str): value - is_case_insensitive (bool): isCaseInsensitive + access_device (accessDevice): accessDevice *Optional* + line_port (str): linePort *Optional* + private_identity (str): privateIdentity *Optional* + contact_list (contactList): contactList *Optional* + port_number (int): portNumber *Optional* """ __slots__: List[str] = [ - "mode", - "value", - "is_case_insensitive", + "access_device", + "line_port", + "private_identity", + "contact_list", + "port_number", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("mode", "mode", str, is_required=True), - E("value", "value", str, is_required=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + E("access_device", "accessDevice", AccessDevice, is_complex=True), + E("line_port", "linePort", str), + E("private_identity", "privateIdentity", str), + E("contact_list", "contactList", ReplacementContactList, is_complex=True), + E("port_number", "portNumber", int), ) -class SearchCriteriaProfileServiceCodeDescription(OCIType): +class AccessDeviceMultipleIdentityAndContactEndpointRead(OCIType): """ - Criteria for searching for a Service Code description. + Access device end point that can have multiple contacts. + The endpoint is identified by its linePort (public Identity) and possibly a private + Identity. Port numbers are only used by devices with static line ordering. The + following elements are only used in XS data mode and not returned in AS data mode: + privateIdentity The following elements are only used in AS data mode and a value false + is returned in the XS mode: supportVisualDeviceManagement Attributes: - mode (str): mode - value (str): value - is_case_insensitive (bool): isCaseInsensitive + access_device (accessDevice): accessDevice + line_port (str): linePort + private_identity (str): privateIdentity *Optional* + contact (List[str]): contact *Optional* + static_registration_capable (bool): staticRegistrationCapable + use_domain (bool): useDomain + port_number (int): portNumber *Optional* + support_visual_device_management (bool): supportVisualDeviceManagement """ __slots__: List[str] = [ - "mode", - "value", - "is_case_insensitive", + "access_device", + "line_port", + "private_identity", + "contact", + "static_registration_capable", + "use_domain", + "port_number", + "support_visual_device_management", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("mode", "mode", str, is_required=True), - E("value", "value", str, is_required=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), - ) - - -class SearchCriteriaReceptionistNote(OCIType): - """ - Criteria for searching for Receptionist Notes. - - - Attributes: - mode (str): mode - value (str): value - is_case_insensitive (bool): isCaseInsensitive - """ - - __slots__: List[str] = [ - "mode", - "value", - "is_case_insensitive", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("mode", "mode", str, is_required=True), - E("value", "value", str, is_required=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + E( + "access_device", + "accessDevice", + AccessDevice, + is_complex=True, + is_required=True, + ), + E("line_port", "linePort", str, is_required=True), + E("private_identity", "privateIdentity", str), + E("contact", "contact", str, is_array=True), + E( + "static_registration_capable", + "staticRegistrationCapable", + bool, + is_required=True, + ), + E("use_domain", "useDomain", bool, is_required=True), + E("port_number", "portNumber", int), + E( + "support_visual_device_management", + "supportVisualDeviceManagement", + bool, + is_required=True, + ), ) -class SearchCriteriaRegistrationURI(OCIType): +class AccessDeviceMultipleIdentityAndContactEndpointRead22(OCIType): """ - Criteria for searching for a RegistrationURI. + Access device end point that can have multiple contacts. + The endpoint is identified by its linePort (public Identity) and possibly a private + Identity. Port numbers are only used by devices with static line ordering. The + following elements are only used in XS data mode and not returned in AS data mode: + privateIdentity The following elements are only used in AS data mode and a value false + is returned in the XS mode: supportVisualDeviceManagement Attributes: - mode (str): mode - value (str): value - is_case_insensitive (bool): isCaseInsensitive + access_device (accessDevice): accessDevice + line_port (str): linePort + private_identity (str): privateIdentity *Optional* + contact (List[contact]): contact *Optional* + static_registration_capable (bool): staticRegistrationCapable + use_domain (bool): useDomain + port_number (int): portNumber *Optional* + support_visual_device_management (bool): supportVisualDeviceManagement """ __slots__: List[str] = [ - "mode", - "value", - "is_case_insensitive", + "access_device", + "line_port", + "private_identity", + "contact", + "static_registration_capable", + "use_domain", + "port_number", + "support_visual_device_management", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("mode", "mode", str, is_required=True), - E("value", "value", str, is_required=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + E( + "access_device", + "accessDevice", + AccessDevice, + is_complex=True, + is_required=True, + ), + E("line_port", "linePort", str, is_required=True), + E("private_identity", "privateIdentity", str), + E("contact", "contact", SIPContactInfo, is_complex=True, is_array=True), + E( + "static_registration_capable", + "staticRegistrationCapable", + bool, + is_required=True, + ), + E("use_domain", "useDomain", bool, is_required=True), + E("port_number", "portNumber", int), + E( + "support_visual_device_management", + "supportVisualDeviceManagement", + bool, + is_required=True, + ), ) -class SearchCriteriaResellerId(OCIType): +class AccessDeviceMultipleIdentityAndContactEndpointRead22V2(OCIType): """ - Criteria for searching for a reseller ID. + Access device end point that can have multiple contacts. + The endpoint is identified by its linePort (public Identity) and possibly a private + Identity. Port numbers are only used by devices with static line ordering. The + following elements are only used in XS data mode and not returned in AS data mode: + privateIdentity The following elements are only used in AS data mode and a value false + is returned in the XS mode: supportVisualDeviceManagement useHotline The following + elements are only used in AS data mode and not returned in XS data mode: + hotlineContact Attributes: - mode (str): mode - value (str): value - is_case_insensitive (bool): isCaseInsensitive + access_device (accessDevice): accessDevice + line_port (str): linePort + private_identity (str): privateIdentity *Optional* + contact (List[contact]): contact *Optional* + static_registration_capable (bool): staticRegistrationCapable + use_domain (bool): useDomain + port_number (int): portNumber *Optional* + support_visual_device_management (bool): supportVisualDeviceManagement + use_hotline (bool): useHotline + hotline_contact (str): hotlineContact *Optional* """ __slots__: List[str] = [ - "mode", - "value", - "is_case_insensitive", + "access_device", + "line_port", + "private_identity", + "contact", + "static_registration_capable", + "use_domain", + "port_number", + "support_visual_device_management", + "use_hotline", + "hotline_contact", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("mode", "mode", str, is_required=True), - E("value", "value", str, is_required=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + E( + "access_device", + "accessDevice", + AccessDevice, + is_complex=True, + is_required=True, + ), + E("line_port", "linePort", str, is_required=True), + E("private_identity", "privateIdentity", str), + E("contact", "contact", SIPContactInfo, is_complex=True, is_array=True), + E( + "static_registration_capable", + "staticRegistrationCapable", + bool, + is_required=True, + ), + E("use_domain", "useDomain", bool, is_required=True), + E("port_number", "portNumber", int), + E( + "support_visual_device_management", + "supportVisualDeviceManagement", + bool, + is_required=True, + ), + E("use_hotline", "useHotline", bool, is_required=True), + E("hotline_contact", "hotlineContact", str), ) -class SearchCriteriaResellerName(OCIType): +class AccessDeviceMultipleIdentityEndpointAdd(OCIType): """ - Criteria for searching for a reseller name. + Access device end point used in the context of add. + The endpoint is identified by its linePort (public Identity) and possibly a private + Identity. Port numbers are only used by devices with static line ordering. The + following elements are only used in XS data mode and ignored in AS data mode: + privateIdentity Attributes: - mode (str): mode - value (str): value - is_case_insensitive (bool): isCaseInsensitive + access_device (accessDevice): accessDevice + line_port (str): linePort + private_identity (str): privateIdentity *Optional* + contact (str): contact *Optional* + port_number (int): portNumber *Optional* """ __slots__: List[str] = [ - "mode", - "value", - "is_case_insensitive", + "access_device", + "line_port", + "private_identity", + "contact", + "port_number", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("mode", "mode", str, is_required=True), - E("value", "value", str, is_required=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + E( + "access_device", + "accessDevice", + AccessDevice, + is_complex=True, + is_required=True, + ), + E("line_port", "linePort", str, is_required=True), + E("private_identity", "privateIdentity", str), + E("contact", "contact", str), + E("port_number", "portNumber", int), ) -class SearchCriteriaRoamingMscAddress(OCIType): +class AccessDeviceMultipleIdentityEndpointKey(OCIType): """ - Criteria for searching for a system Roaming Network Msc Address. + Access device end point in the context of a modify or delete command. + The endpoint is identified by its linePort (public Identity) and possibly a private + Identity. The following elements are only used in XS data mode and ignored in AS data + mode: privateIdentity Attributes: - mode (str): mode - value (str): value - is_case_insensitive (bool): isCaseInsensitive + access_device (accessDevice): accessDevice + line_port (str): linePort + private_identity (str): privateIdentity *Optional* """ __slots__: List[str] = [ - "mode", - "value", - "is_case_insensitive", + "access_device", + "line_port", + "private_identity", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("mode", "mode", str, is_required=True), - E("value", "value", str, is_required=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + E( + "access_device", + "accessDevice", + AccessDevice, + is_complex=True, + is_required=True, + ), + E("line_port", "linePort", str, is_required=True), + E("private_identity", "privateIdentity", str), ) -class SearchCriteriaRoutePointName(OCIType): +class AccessDeviceMultipleIdentityEndpointWithType(OCIType): """ - Criteria for searching for a route point + Access device end point that can have multiple contacts. + + The endpoint is identified by its linePort (public Identity) and possibly a private + Identity. Port numbers are only used by devices with static line ordering. Attributes: - mode (str): mode - value (str): value - is_case_insensitive (bool): isCaseInsensitive + access_device (accessDevice): accessDevice + device_type (str): deviceType + line_port (str): linePort + private_identity (str): privateIdentity *Optional* + contact (str): contact *Optional* + port_number (int): portNumber *Optional* + mac_address (str): macAddress *Optional* """ __slots__: List[str] = [ - "mode", - "value", - "is_case_insensitive", + "access_device", + "device_type", + "line_port", + "private_identity", + "contact", + "port_number", + "mac_address", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("mode", "mode", str, is_required=True), - E("value", "value", str, is_required=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + E( + "access_device", + "accessDevice", + AccessDevice, + is_complex=True, + is_required=True, + ), + E("device_type", "deviceType", str, is_required=True), + E("line_port", "linePort", str, is_required=True), + E("private_identity", "privateIdentity", str), + E("contact", "contact", str), + E("port_number", "portNumber", int), + E("mac_address", "macAddress", str), ) -class SearchCriteriaSIPContact(OCIType): +class AutoAttendantKeyConfigurationEntry(OCIType): """ - Criteria for searching for a SIP Contact. + The configuration entry of a key for Auto Attendant. + The following elements are only used in AS data mode: audioFile videoFile Attributes: - mode (str): mode - value (str): value - is_case_insensitive (bool): isCaseInsensitive + description (str): description *Optional* + action (str): action + phone_number (str): phoneNumber *Optional* + audio_file (audioFile): audioFile *Optional* + video_file (videoFile): videoFile *Optional* """ __slots__: List[str] = [ - "mode", - "value", - "is_case_insensitive", + "description", + "action", + "phone_number", + "audio_file", + "video_file", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("mode", "mode", str, is_required=True), - E("value", "value", str, is_required=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + E("description", "description", str), + E("action", "action", str, is_required=True), + E("phone_number", "phoneNumber", str), + E("audio_file", "audioFile", LabeledMediaFileResource, is_complex=True), + E("video_file", "videoFile", LabeledMediaFileResource, is_complex=True), ) -class SearchCriteriaScheduleName(OCIType): +class AutoAttendantKeyConfigurationEntry19(OCIType): """ - Criteria for searching for a schedule name. + The configuration entry of a key for Auto Attendant. + The following data elements are only valid for Standard Auto Attendants: submenuId Attributes: - mode (str): mode - value (str): value - is_case_insensitive (bool): isCaseInsensitive + description (str): description *Optional* + action (str): action + phone_number (str): phoneNumber *Optional* + audio_file (audioFile): audioFile *Optional* + video_file (videoFile): videoFile *Optional* + submenu_id (str): submenuId *Optional* """ __slots__: List[str] = [ - "mode", - "value", - "is_case_insensitive", + "description", + "action", + "phone_number", + "audio_file", + "video_file", + "submenu_id", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("mode", "mode", str, is_required=True), - E("value", "value", str, is_required=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + E("description", "description", str), + E("action", "action", str, is_required=True), + E("phone_number", "phoneNumber", str), + E("audio_file", "audioFile", LabeledMediaFileResource, is_complex=True), + E("video_file", "videoFile", LabeledMediaFileResource, is_complex=True), + E("submenu_id", "submenuId", str), ) -class SearchCriteriaServiceCode(OCIType): +class AutoAttendantKeyConfigurationEntry20(OCIType): """ - Criteria for searching for a Service Code. + The configuration entry of a key for Auto Attendant. + The following data elements are only used in AS data mode: audioFile videoFile + submenuId The following data elements are only valid for Standard Auto Attendants: + submenuId Attributes: - mode (str): mode - value (str): value - is_case_insensitive (bool): isCaseInsensitive + description (str): description *Optional* + action (str): action + phone_number (str): phoneNumber *Optional* + audio_file (audioFile): audioFile *Optional* + video_file (videoFile): videoFile *Optional* + submenu_id (str): submenuId *Optional* """ __slots__: List[str] = [ - "mode", - "value", - "is_case_insensitive", + "description", + "action", + "phone_number", + "audio_file", + "video_file", + "submenu_id", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("mode", "mode", str, is_required=True), - E("value", "value", str, is_required=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + E("description", "description", str), + E("action", "action", str, is_required=True), + E("phone_number", "phoneNumber", str), + E("audio_file", "audioFile", AnnouncementFileLevelKey, is_complex=True), + E("video_file", "videoFile", AnnouncementFileLevelKey, is_complex=True), + E("submenu_id", "submenuId", str), ) -class SearchCriteriaServiceCodeDescription(OCIType): +class AutoAttendantKeyConfigurationModifyEntry(OCIType): """ - Criteria for searching for a Service Code description. + The modify configuration entry of a key for Auto Attendant. + The following data elements are only valid for Standard Auto Attendants: submenuId Attributes: - mode (str): mode - value (str): value - is_case_insensitive (bool): isCaseInsensitive + description (str): description *Optional* + action (str): action + phone_number (str): phoneNumber *Optional* + audio_file (audioFile): audioFile *Optional* + video_file (videoFile): videoFile *Optional* + submenu_id (str): submenuId *Optional* """ __slots__: List[str] = [ - "mode", - "value", - "is_case_insensitive", + "description", + "action", + "phone_number", + "audio_file", + "video_file", + "submenu_id", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("mode", "mode", str, is_required=True), - E("value", "value", str, is_required=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + E("description", "description", str), + E("action", "action", str, is_required=True), + E("phone_number", "phoneNumber", str), + E("audio_file", "audioFile", LabeledMediaFileResource, is_complex=True), + E("video_file", "videoFile", LabeledMediaFileResource, is_complex=True), + E("submenu_id", "submenuId", str), ) -class SearchCriteriaServiceInstanceName(OCIType): +class AutoAttendantKeyConfigurationModifyEntry20(OCIType): """ - Criteria for searching for a service instance name. + The modify configuration entry of a key for Auto Attendant. + The following data elements are only used in AS data mode: audioFile videoFile + submenuId The following data elements are only valid for Standard Auto Attendants: + submenuId Attributes: - mode (str): mode - value (str): value - is_case_insensitive (bool): isCaseInsensitive + description (str): description *Optional* + action (str): action + phone_number (str): phoneNumber *Optional* + audio_file (audioFile): audioFile *Optional* + video_file (videoFile): videoFile *Optional* + submenu_id (str): submenuId *Optional* """ __slots__: List[str] = [ - "mode", - "value", - "is_case_insensitive", + "description", + "action", + "phone_number", + "audio_file", + "video_file", + "submenu_id", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("mode", "mode", str, is_required=True), - E("value", "value", str, is_required=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + E("description", "description", str), + E("action", "action", str, is_required=True), + E("phone_number", "phoneNumber", str), + E("audio_file", "audioFile", AnnouncementFileLevelKey, is_complex=True), + E("video_file", "videoFile", AnnouncementFileLevelKey, is_complex=True), + E("submenu_id", "submenuId", str), ) -class SearchCriteriaServiceProviderId(OCIType): +class AutoAttendantKeyConfigurationReadEntry20(OCIType): """ - Criteria for searching for a service provider ID. + The read configuration entry of a key for Auto Attendant. + The following data elements are only used in AS data mode: submenuId The following + data elements are only valid for Standard Auto Attendants: submenuId Attributes: - mode (str): mode - value (str): value - is_case_insensitive (bool): isCaseInsensitive + description (str): description *Optional* + action (str): action + phone_number (str): phoneNumber *Optional* + audio_file (audioFile): audioFile *Optional* + video_file (videoFile): videoFile *Optional* + submenu_id (str): submenuId *Optional* """ __slots__: List[str] = [ - "mode", - "value", - "is_case_insensitive", + "description", + "action", + "phone_number", + "audio_file", + "video_file", + "submenu_id", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("mode", "mode", str, is_required=True), - E("value", "value", str, is_required=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + E("description", "description", str), + E("action", "action", str, is_required=True), + E("phone_number", "phoneNumber", str), + E("audio_file", "audioFile", AnnouncementFileLevelKey, is_complex=True), + E("video_file", "videoFile", AnnouncementFileLevelKey, is_complex=True), + E("submenu_id", "submenuId", str), ) -class SearchCriteriaServiceProviderName(OCIType): +class AutoAttendantKeyReadConfiguration(OCIType): """ - Criteria for searching for a service provider name. + The read configuration of a key for Auto Attendant. Attributes: - mode (str): mode - value (str): value - is_case_insensitive (bool): isCaseInsensitive + key (str): key + entry (entry): entry """ __slots__: List[str] = [ - "mode", - "value", - "is_case_insensitive", + "key", + "entry", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("mode", "mode", str, is_required=True), - E("value", "value", str, is_required=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + E("key", "key", str, is_required=True), + E( + "entry", + "entry", + AutoAttendantKeyConfigurationReadEntry, + is_complex=True, + is_required=True, + ), ) -class SearchCriteriaServiceProviderNumberPortabilityQueryDigitPattern(OCIType): +class AutoAttendantKeyReadConfiguration19(OCIType): """ - Criteria for searching for digit pattern. + The read configuration of a key for Auto Attendant. Attributes: - mode (str): mode - value (str): value - is_case_insensitive (bool): isCaseInsensitive + key (str): key + entry (entry): entry """ __slots__: List[str] = [ - "mode", - "value", - "is_case_insensitive", + "key", + "entry", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("mode", "mode", str, is_required=True), - E("value", "value", str, is_required=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + E("key", "key", str, is_required=True), + E( + "entry", + "entry", + AutoAttendantKeyConfigurationReadEntry19, + is_complex=True, + is_required=True, + ), ) -class SearchCriteriaServiceStatus(OCIType): +class CPEDeviceOptionsRead(OCIType): """ - Criteria for searching for services that are active or not. + CPE device's options. - This search criteria data type is only intended to be used by the commands introduced - by BW-2301. The commands are `EnterpriseUserCallWaitingSettingsGetListRequest()` and - `GroupUserCallWaitingSettingsGetListRequest()`. Attributes: - is_active (bool): isActive + enable_monitoring (bool): enableMonitoring + reset_event (str): resetEvent *Optional* + config_type (str): configType + system_file_name (str): systemFileName *Optional* + device_file_format (str): deviceFileFormat *Optional* + device_management_device_type_options (deviceManagementDeviceTypeOptions): + deviceManagementDeviceTypeOptions *Optional* """ __slots__: List[str] = [ - "is_active", + "enable_monitoring", + "reset_event", + "config_type", + "system_file_name", + "device_file_format", + "device_management_device_type_options", ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return (E("is_active", "isActive", bool, is_required=True),) + return ( + E("enable_monitoring", "enableMonitoring", bool, is_required=True), + E("reset_event", "resetEvent", str), + E("config_type", "configType", str, is_required=True), + E("system_file_name", "systemFileName", str), + E("device_file_format", "deviceFileFormat", str), + E( + "device_management_device_type_options", + "deviceManagementDeviceTypeOptions", + DeviceManagementDeviceTypeOptionsRead, + is_complex=True, + ), + ) -class SearchCriteriaSystemServiceDn(OCIType): +class CPEDeviceOptionsRead16(OCIType): """ - Criteria for searching for a system service DN. + CPE device's options. Attributes: - mode (str): mode - value (str): value - is_case_insensitive (bool): isCaseInsensitive + enable_monitoring (bool): enableMonitoring + reset_event (str): resetEvent *Optional* + config_type (str): configType + system_file_name (str): systemFileName *Optional* + device_file_format (str): deviceFileFormat *Optional* + device_management_device_type_options (deviceManagementDeviceTypeOptions): + deviceManagementDeviceTypeOptions *Optional* """ __slots__: List[str] = [ - "mode", - "value", - "is_case_insensitive", + "enable_monitoring", + "reset_event", + "config_type", + "system_file_name", + "device_file_format", + "device_management_device_type_options", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("mode", "mode", str, is_required=True), - E("value", "value", str, is_required=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + E("enable_monitoring", "enableMonitoring", bool, is_required=True), + E("reset_event", "resetEvent", str), + E("config_type", "configType", str, is_required=True), + E("system_file_name", "systemFileName", str), + E("device_file_format", "deviceFileFormat", str), + E( + "device_management_device_type_options", + "deviceManagementDeviceTypeOptions", + DeviceManagementDeviceTypeOptionsRead16, + is_complex=True, + ), ) -class SearchCriteriaTitle(OCIType): +class CPEDeviceOptionsRead16sp1(OCIType): """ - Criteria for searching for a user's title. + CPE device's options. Attributes: - mode (str): mode - value (str): value - is_case_insensitive (bool): isCaseInsensitive + enable_monitoring (bool): enableMonitoring + config_type (str): configType *Optional* + system_file_name (str): systemFileName *Optional* + device_file_format (str): deviceFileFormat *Optional* + device_management_device_type_options (deviceManagementDeviceTypeOptions): + deviceManagementDeviceTypeOptions *Optional* """ __slots__: List[str] = [ - "mode", - "value", - "is_case_insensitive", + "enable_monitoring", + "config_type", + "system_file_name", + "device_file_format", + "device_management_device_type_options", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("mode", "mode", str, is_required=True), - E("value", "value", str, is_required=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + E("enable_monitoring", "enableMonitoring", bool, is_required=True), + E("config_type", "configType", str), + E("system_file_name", "systemFileName", str), + E("device_file_format", "deviceFileFormat", str), + E( + "device_management_device_type_options", + "deviceManagementDeviceTypeOptions", + DeviceManagementDeviceTypeOptionsRead16, + is_complex=True, + ), ) -class SearchCriteriaTrunkGroupName(OCIType): +class CPEDeviceOptionsRead21sp1(OCIType): """ - Criteria for searching for a trunk group + CPE device's options. + Attributes: - mode (str): mode - value (str): value - is_case_insensitive (bool): isCaseInsensitive + enable_monitoring (bool): enableMonitoring + config_type (str): configType *Optional* + system_file_name (str): systemFileName *Optional* + device_file_format (str): deviceFileFormat *Optional* + device_management_device_type_options (deviceManagementDeviceTypeOptions): + deviceManagementDeviceTypeOptions *Optional* """ __slots__: List[str] = [ - "mode", - "value", - "is_case_insensitive", + "enable_monitoring", + "config_type", + "system_file_name", + "device_file_format", + "device_management_device_type_options", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("mode", "mode", str, is_required=True), - E("value", "value", str, is_required=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + E("enable_monitoring", "enableMonitoring", bool, is_required=True), + E("config_type", "configType", str), + E("system_file_name", "systemFileName", str), + E("device_file_format", "deviceFileFormat", str), + E( + "device_management_device_type_options", + "deviceManagementDeviceTypeOptions", + DeviceManagementDeviceTypeOptionsRead21sp1, + is_complex=True, + ), ) -class SearchCriteriaUserExternalId(OCIType): +class CPEDeviceOptionsRead22(OCIType): """ - Criteria for searching for a user's externalId. + CPE device's options. Attributes: - mode (str): mode - value (str): value + enable_monitoring (bool): enableMonitoring + config_type (str): configType *Optional* + system_file_name (str): systemFileName *Optional* + device_file_format (str): deviceFileFormat *Optional* + device_management_device_type_options (deviceManagementDeviceTypeOptions): + deviceManagementDeviceTypeOptions *Optional* """ __slots__: List[str] = [ - "mode", - "value", + "enable_monitoring", + "config_type", + "system_file_name", + "device_file_format", + "device_management_device_type_options", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("mode", "mode", str, is_required=True), - E("value", "value", str, is_required=True), + E("enable_monitoring", "enableMonitoring", bool, is_required=True), + E("config_type", "configType", str), + E("system_file_name", "systemFileName", str), + E("device_file_format", "deviceFileFormat", str), + E( + "device_management_device_type_options", + "deviceManagementDeviceTypeOptions", + DeviceManagementDeviceTypeOptionsRead22, + is_complex=True, + ), ) -class SearchCriteriaUserFirstName(OCIType): +class CPEDeviceOptionsRead22V2(OCIType): """ - Criteria for searching for a user's first name. + CPE device's options. Attributes: - mode (str): mode - value (str): value - is_case_insensitive (bool): isCaseInsensitive + enable_monitoring (bool): enableMonitoring + config_type (str): configType *Optional* + system_file_name (str): systemFileName *Optional* + device_file_format (str): deviceFileFormat *Optional* + device_management_device_type_options (deviceManagementDeviceTypeOptions): + deviceManagementDeviceTypeOptions *Optional* """ __slots__: List[str] = [ - "mode", - "value", - "is_case_insensitive", + "enable_monitoring", + "config_type", + "system_file_name", + "device_file_format", + "device_management_device_type_options", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("mode", "mode", str, is_required=True), - E("value", "value", str, is_required=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + E("enable_monitoring", "enableMonitoring", bool, is_required=True), + E("config_type", "configType", str), + E("system_file_name", "systemFileName", str), + E("device_file_format", "deviceFileFormat", str), + E( + "device_management_device_type_options", + "deviceManagementDeviceTypeOptions", + DeviceManagementDeviceTypeOptionsRead22V2, + is_complex=True, + ), ) -class SearchCriteriaUserHotlineContact(OCIType): +class CPEDeviceOptionsRead22V3(OCIType): """ - Criteria for searching for a user's hotline contact. + CPE device's options. Attributes: - mode (str): mode - value (str): value - is_case_insensitive (bool): isCaseInsensitive + enable_monitoring (bool): enableMonitoring + config_type (str): configType *Optional* + system_file_name (str): systemFileName *Optional* + device_file_format (str): deviceFileFormat *Optional* + device_management_device_type_options (deviceManagementDeviceTypeOptions): + deviceManagementDeviceTypeOptions *Optional* """ __slots__: List[str] = [ - "mode", - "value", - "is_case_insensitive", + "enable_monitoring", + "config_type", + "system_file_name", + "device_file_format", + "device_management_device_type_options", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("mode", "mode", str, is_required=True), - E("value", "value", str, is_required=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + E("enable_monitoring", "enableMonitoring", bool, is_required=True), + E("config_type", "configType", str), + E("system_file_name", "systemFileName", str), + E("device_file_format", "deviceFileFormat", str), + E( + "device_management_device_type_options", + "deviceManagementDeviceTypeOptions", + DeviceManagementDeviceTypeOptionsRead22V3, + is_complex=True, + ), ) -class SearchCriteriaUserId(OCIType): +class CPEDeviceOptionsRead22V4(OCIType): """ - Criteria for searching for a user's userId. + CPE device's options. Attributes: - mode (str): mode - value (str): value - is_case_insensitive (bool): isCaseInsensitive + enable_monitoring (bool): enableMonitoring + config_type (str): configType *Optional* + system_file_name (str): systemFileName *Optional* + device_file_format (str): deviceFileFormat *Optional* + device_management_device_type_options (deviceManagementDeviceTypeOptions): + deviceManagementDeviceTypeOptions *Optional* """ __slots__: List[str] = [ - "mode", - "value", - "is_case_insensitive", + "enable_monitoring", + "config_type", + "system_file_name", + "device_file_format", + "device_management_device_type_options", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("mode", "mode", str, is_required=True), - E("value", "value", str, is_required=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + E("enable_monitoring", "enableMonitoring", bool, is_required=True), + E("config_type", "configType", str), + E("system_file_name", "systemFileName", str), + E("device_file_format", "deviceFileFormat", str), + E( + "device_management_device_type_options", + "deviceManagementDeviceTypeOptions", + DeviceManagementDeviceTypeOptionsRead22V4, + is_complex=True, + ), ) -class SearchCriteriaUserLastName(OCIType): +class CallCenterAgentStatistics13mp8(OCIType): """ - Criteria for searching for a user's last name. + Contains Call Center statistics for a specified agent. Attributes: - mode (str): mode - value (str): value - is_case_insensitive (bool): isCaseInsensitive + agent_user_id (str): agentUserId + agent_display_names (agentDisplayNames): agentDisplayNames + available (bool): available + statistics_yesterday (statisticsYesterday): statisticsYesterday + statistics_today (statisticsToday): statisticsToday """ __slots__: List[str] = [ - "mode", - "value", - "is_case_insensitive", + "agent_user_id", + "agent_display_names", + "available", + "statistics_yesterday", + "statistics_today", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("mode", "mode", str, is_required=True), - E("value", "value", str, is_required=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + E("agent_user_id", "agentUserId", str, is_required=True), + E( + "agent_display_names", + "agentDisplayNames", + UserDisplayNames, + is_complex=True, + is_required=True, + ), + E("available", "available", bool, is_required=True), + E( + "statistics_yesterday", + "statisticsYesterday", + CallCenterAgentDailyStatistics13mp8, + is_complex=True, + is_required=True, + ), + E( + "statistics_today", + "statisticsToday", + CallCenterAgentDailyStatistics13mp8, + is_complex=True, + is_required=True, + ), ) -class SearchCriteriaUserName(OCIType): +class CallCenterAgentStatistics14sp9(OCIType): """ - Criteria for searching for a user's full name. + Contains Call Center statistics for a specified agent. - This search criterion will be compared against multiple combinations of first name and - last name: First Name + ' ' + Last Name Last Name + ' ' + First Name Last Name + ', ' - + First Name Hiragana Last Name + ' ' + Hiragana First Name Note that when specific - conditions are met, VON users will be included in the search results. Attributes: - mode (str): mode - value (str): value - is_case_insensitive (bool): isCaseInsensitive + agent_user_id (str): agentUserId + agent_display_names (agentDisplayNames): agentDisplayNames + available (bool): available + statistics (statistics): statistics """ __slots__: List[str] = [ - "mode", - "value", - "is_case_insensitive", + "agent_user_id", + "agent_display_names", + "available", + "statistics", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("mode", "mode", str, is_required=True), - E("value", "value", str, is_required=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + E("agent_user_id", "agentUserId", str, is_required=True), + E( + "agent_display_names", + "agentDisplayNames", + UserDisplayNames, + is_complex=True, + is_required=True, + ), + E("available", "available", bool, is_required=True), + E( + "statistics", + "statistics", + AgentStatistics, + is_complex=True, + is_required=True, + ), ) -class SearchCriteriaUserPersonalMultiPartPhoneListName(OCIType): +class CallCenterAnnouncementFileListModify(OCIType): """ - Criteria for searching for a name in a user personal phone list. + Contains a list of audio or video files to modify. - Note: For this search criterion, the searchMode is always ‘Contains’ and the multi- - part search criteria are always AND’ed. Attributes: - value (List[str]): value - is_case_insensitive (bool): isCaseInsensitive + file1 (file1): file1 *Optional* + file2 (file2): file2 *Optional* + file3 (file3): file3 *Optional* + file4 (file4): file4 *Optional* """ __slots__: List[str] = [ - "value", - "is_case_insensitive", + "file1", + "file2", + "file3", + "file4", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("value", "value", str, is_required=True, is_array=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + E("file1", "file1", LabeledMediaFileResource, is_complex=True), + E("file2", "file2", LabeledMediaFileResource, is_complex=True), + E("file3", "file3", LabeledMediaFileResource, is_complex=True), + E("file4", "file4", LabeledMediaFileResource, is_complex=True), ) -class SearchCriteriaUserPersonalPhoneListName(OCIType): +class CallCenterAnnouncementFileListModify20(OCIType): """ - Criteria for searching for a name in a user personal phone list. - + Contains a list of announcement repository files Attributes: - mode (str): mode - value (str): value - is_case_insensitive (bool): isCaseInsensitive + file1 (file1): file1 *Optional* + file2 (file2): file2 *Optional* + file3 (file3): file3 *Optional* + file4 (file4): file4 *Optional* """ __slots__: List[str] = [ - "mode", - "value", - "is_case_insensitive", + "file1", + "file2", + "file3", + "file4", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("mode", "mode", str, is_required=True), - E("value", "value", str, is_required=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + E("file1", "file1", AnnouncementFileLevelKey, is_complex=True), + E("file2", "file2", AnnouncementFileLevelKey, is_complex=True), + E("file3", "file3", AnnouncementFileLevelKey, is_complex=True), + E("file4", "file4", AnnouncementFileLevelKey, is_complex=True), ) -class SearchCriteriaUserPersonalPhoneListNumber(OCIType): +class CallCenterAnnouncementFileListRead20(OCIType): """ - Criteria for searching for a phone number in a user personal phone list. - + Contains a list of announcement repository files Attributes: - mode (str): mode - value (str): value - is_case_insensitive (bool): isCaseInsensitive + file1 (file1): file1 *Optional* + file2 (file2): file2 *Optional* + file3 (file3): file3 *Optional* + file4 (file4): file4 *Optional* """ __slots__: List[str] = [ - "mode", - "value", - "is_case_insensitive", + "file1", + "file2", + "file3", + "file4", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("mode", "mode", str, is_required=True), - E("value", "value", str, is_required=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + E("file1", "file1", AnnouncementFileLevelKey, is_complex=True), + E("file2", "file2", AnnouncementFileLevelKey, is_complex=True), + E("file3", "file3", AnnouncementFileLevelKey, is_complex=True), + E("file4", "file4", AnnouncementFileLevelKey, is_complex=True), ) -class SearchCriteriaUserPlaceType(OCIType): +class CallCenterReplacementSkilledAgents(OCIType): """ - Criteria for searching based on a user type – “User” or “Place”. + A list of agents grouped by skill levels. Attributes: - value (str): value + skill_level (int): skillLevel + agents (agents): agents """ __slots__: List[str] = [ - "value", + "skill_level", + "agents", ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return (E("value", "value", str, is_required=True),) + return ( + E("skill_level", "skillLevel", int, is_required=True), + E( + "agents", + "agents", + ReplacementUserIdList, + is_complex=True, + is_required=True, + ), + ) -class SearchCriteriaYahooId(OCIType): +class CallCenterReportIntervalDates(OCIType): """ - Criteria for searching for a user's yahoo id. + The call center enhanced reporting report interval, using dates. Attributes: - mode (str): mode - value (str): value - is_case_insensitive (bool): isCaseInsensitive + start_date (str): startDate + start_time (startTime): startTime + end_date (str): endDate + end_time (endTime): endTime """ __slots__: List[str] = [ - "mode", - "value", - "is_case_insensitive", + "start_date", + "start_time", + "end_date", + "end_time", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("mode", "mode", str, is_required=True), - E("value", "value", str, is_required=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + E("start_date", "startDate", str, is_required=True), + E("start_time", "startTime", HourMinute, is_complex=True, is_required=True), + E("end_date", "endDate", str, is_required=True), + E("end_time", "endTime", HourMinute, is_complex=True, is_required=True), ) -class SearchCriteriaZoneIPAddress(OCIType): +class CallCenterReportScheduleRecurrence(OCIType): """ - Criteria for searching for a system zone's IP Address. + A recurring schedule for call center enhanced reporting scheduled report. Attributes: - mode (str): mode - value (str): value - is_case_insensitive (bool): isCaseInsensitive + time_zone (str): timeZone + start_date (str): startDate + schedule_time (scheduleTime): scheduleTime + recurrence (recurrence): recurrence """ __slots__: List[str] = [ - "mode", - "value", - "is_case_insensitive", + "time_zone", + "start_date", + "schedule_time", + "recurrence", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("mode", "mode", str, is_required=True), - E("value", "value", str, is_required=True), - E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + E("time_zone", "timeZone", str, is_required=True), + E("start_date", "startDate", str, is_required=True), + E( + "schedule_time", + "scheduleTime", + HourMinute, + is_complex=True, + is_required=True, + ), + E( + "recurrence", + "recurrence", + Recurrence, + is_complex=True, + is_required=True, + ), ) -class SecurityClassificationCustomizationActivation(OCIType): +class CallCenterReportScheduleTime(OCIType): """ - The security classification customization activation. + A scheduled time for call center enhanced reporting scheduled report. Attributes: - name (str): name - is_customized (bool): isCustomized + time_zone (str): timeZone + schedule_date (str): scheduleDate + schedule_time (scheduleTime): scheduleTime """ __slots__: List[str] = [ - "name", - "is_customized", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("name", "name", str, is_required=True), - E("is_customized", "isCustomized", bool, is_required=True), - ) - - -class SelectDistributionListMenuKeysModifyEntry(OCIType): - """ - The voice portal select distribution list menu keys modify entry. - - - Attributes: - return_to_previous_menu (str): returnToPreviousMenu *Optional* - repeat_menu_or_finish_entering_distribution_list_number (str): - repeatMenuOrFinishEnteringDistributionListNumber *Optional* - """ - - __slots__: List[str] = [ - "return_to_previous_menu", - "repeat_menu_or_finish_entering_distribution_list_number", + "time_zone", + "schedule_date", + "schedule_time", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("return_to_previous_menu", "returnToPreviousMenu", str), + E("time_zone", "timeZone", str, is_required=True), + E("schedule_date", "scheduleDate", str, is_required=True), E( - "repeat_menu_or_finish_entering_distribution_list_number", - "repeatMenuOrFinishEnteringDistributionListNumber", - str, + "schedule_time", + "scheduleTime", + HourMinute, + is_complex=True, + is_required=True, ), ) -class SelectDistributionListMenuKeysReadEntry(OCIType): +class CallMeNowToDnCriteriaModify(OCIType): """ - The voice portal select distribution list menu keys. + The To dn criteria used on the call me now external number to be modified. Attributes: - return_to_previous_menu (str): returnToPreviousMenu - repeat_menu_or_finish_entering_distribution_list_number (str): - repeatMenuOrFinishEnteringDistributionListNumber *Optional* + to_dn_criteria_selection (str): toDnCriteriaSelection *Optional* + phone_number_list (phoneNumberList): phoneNumberList *Optional* """ __slots__: List[str] = [ - "return_to_previous_menu", - "repeat_menu_or_finish_entering_distribution_list_number", + "to_dn_criteria_selection", + "phone_number_list", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("return_to_previous_menu", "returnToPreviousMenu", str, is_required=True), + E("to_dn_criteria_selection", "toDnCriteriaSelection", str), E( - "repeat_menu_or_finish_entering_distribution_list_number", - "repeatMenuOrFinishEnteringDistributionListNumber", - str, + "phone_number_list", + "phoneNumberList", + CriteriaReplacementDNList, + is_complex=True, ), ) -class SelectiveCallRejectionCriteriaCallType(OCIType): +class CombinedAccessDeviceMultipleIdentityEndpointAdd(OCIType): """ - The call type criteria used within an add/get request. + Access device end point used in the context of add. + The endpoint is identified by its linePort (public Identity) and possibly a private + Identity. Only Static Registration capable devices may have more than one contact + defined. Port numbers are only used by devices with static line ordering. In the + case an access device referenced by accessDevice does not exist, the device will be + added. The device attributes deviceType, protocol, netAddress, port, + outboundProxyServerNetAddress, stunServerNetAddress, macAddress, serialNumber, + description, physicalLocation, transportProtocol, useCustomUserNamePassword and + accessDeviceCredentials will be ignored if the access device already exists. Attributes: - from_dn_criteria_selection (str): fromDnCriteriaSelection - include_anonymous_callers (bool): includeAnonymousCallers - include_unavailable_callers (bool): includeUnavailableCallers - phone_number (List[str]): phoneNumber *Optional* + access_device (accessDevice): accessDevice + line_port (str): linePort + private_identity (str): privateIdentity *Optional* + contact (str): contact *Optional* + port_number (int): portNumber *Optional* + device_type (str): deviceType *Optional* + protocol (str): protocol *Optional* + net_address (str): netAddress *Optional* + port (int): port *Optional* + outbound_proxy_server_net_address (str): outboundProxyServerNetAddress *Optional* + stun_server_net_address (str): stunServerNetAddress *Optional* + mac_address (str): macAddress *Optional* + serial_number (str): serialNumber *Optional* + description (str): description *Optional* + physical_location (str): physicalLocation *Optional* + transport_protocol (str): transportProtocol *Optional* + use_custom_user_name_password (bool): useCustomUserNamePassword *Optional* + access_device_credentials (accessDeviceCredentials): accessDeviceCredentials + *Optional* """ __slots__: List[str] = [ - "from_dn_criteria_selection", - "include_anonymous_callers", - "include_unavailable_callers", - "phone_number", + "access_device", + "line_port", + "private_identity", + "contact", + "port_number", + "device_type", + "protocol", + "net_address", + "port", + "outbound_proxy_server_net_address", + "stun_server_net_address", + "mac_address", + "serial_number", + "description", + "physical_location", + "transport_protocol", + "use_custom_user_name_password", + "access_device_credentials", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( E( - "from_dn_criteria_selection", - "fromDnCriteriaSelection", - str, + "access_device", + "accessDevice", + AccessDevice, + is_complex=True, is_required=True, ), + E("line_port", "linePort", str, is_required=True), + E("private_identity", "privateIdentity", str), + E("contact", "contact", str), + E("port_number", "portNumber", int), + E("device_type", "deviceType", str), + E("protocol", "protocol", str), + E("net_address", "netAddress", str), + E("port", "port", int), E( - "include_anonymous_callers", - "includeAnonymousCallers", - bool, - is_required=True, + "outbound_proxy_server_net_address", + "outboundProxyServerNetAddress", + str, ), + E("stun_server_net_address", "stunServerNetAddress", str), + E("mac_address", "macAddress", str), + E("serial_number", "serialNumber", str), + E("description", "description", str), + E("physical_location", "physicalLocation", str), + E("transport_protocol", "transportProtocol", str), + E("use_custom_user_name_password", "useCustomUserNamePassword", bool), E( - "include_unavailable_callers", - "includeUnavailableCallers", - bool, - is_required=True, + "access_device_credentials", + "accessDeviceCredentials", + DeviceManagementUserNamePassword16, + is_complex=True, ), - E("phone_number", "phoneNumber", str, is_array=True), ) -class SendMessageToSelectedDistributionListMenuKeysModifyEntry(OCIType): +class CombinedAccessDeviceMultipleIdentityEndpointModify(OCIType): """ - The voice portal send message to selected distribution list menu keys modify entry. + Access device end point used in the context of modify. + The endpoint is identified by its linePort (public Identity) and possibly a private + Identity. Only Static Registration capable devices may have more than one contact + defined. Port numbers are only used by devices with static line ordering. In the + case an access device referenced by accessDevice does not exist, the device will be + added. When the device needs to be added, if the linePort is not specified, the + request will fail The device attributes deviceType, protocol, netAddress, port, + outboundProxyServerNetAddress, stunServerNetAddress, macAddress, serialNumber, + description, physicalLocation, transportProtocol, useCustomUserNamePassword and + accessDeviceCredentials will be ignored if the access device already exists. Attributes: - confirm_sending_to_distribution_list (str): confirmSendingToDistributionList - *Optional* - cancel_sending_to_distribution_list (str): cancelSendingToDistributionList + access_device (accessDevice): accessDevice *Optional* + line_port (str): linePort *Optional* + private_identity (str): privateIdentity *Optional* + contact (str): contact *Optional* + port_number (int): portNumber *Optional* + device_type (str): deviceType *Optional* + protocol (str): protocol *Optional* + net_address (str): netAddress *Optional* + port (int): port *Optional* + outbound_proxy_server_net_address (str): outboundProxyServerNetAddress *Optional* + stun_server_net_address (str): stunServerNetAddress *Optional* + mac_address (str): macAddress *Optional* + serial_number (str): serialNumber *Optional* + description (str): description *Optional* + physical_location (str): physicalLocation *Optional* + transport_protocol (str): transportProtocol *Optional* + use_custom_user_name_password (bool): useCustomUserNamePassword *Optional* + access_device_credentials (accessDeviceCredentials): accessDeviceCredentials *Optional* """ __slots__: List[str] = [ - "confirm_sending_to_distribution_list", - "cancel_sending_to_distribution_list", + "access_device", + "line_port", + "private_identity", + "contact", + "port_number", + "device_type", + "protocol", + "net_address", + "port", + "outbound_proxy_server_net_address", + "stun_server_net_address", + "mac_address", + "serial_number", + "description", + "physical_location", + "transport_protocol", + "use_custom_user_name_password", + "access_device_credentials", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( + E("access_device", "accessDevice", AccessDevice, is_complex=True), + E("line_port", "linePort", str), + E("private_identity", "privateIdentity", str), + E("contact", "contact", str), + E("port_number", "portNumber", int), + E("device_type", "deviceType", str), + E("protocol", "protocol", str), + E("net_address", "netAddress", str), + E("port", "port", int), E( - "confirm_sending_to_distribution_list", - "confirmSendingToDistributionList", + "outbound_proxy_server_net_address", + "outboundProxyServerNetAddress", str, ), + E("stun_server_net_address", "stunServerNetAddress", str), + E("mac_address", "macAddress", str), + E("serial_number", "serialNumber", str), + E("description", "description", str), + E("physical_location", "physicalLocation", str), + E("transport_protocol", "transportProtocol", str), + E("use_custom_user_name_password", "useCustomUserNamePassword", bool), E( - "cancel_sending_to_distribution_list", - "cancelSendingToDistributionList", - str, + "access_device_credentials", + "accessDeviceCredentials", + DeviceManagementUserNamePassword16, + is_complex=True, ), ) -class SendMessageToSelectedDistributionListMenuKeysReadEntry(OCIType): +class CombinedGroupServiceAuthorization(OCIType): """ - The voice portal send message to selected distribution list menu keys. + Authorize a group service. Attributes: - confirm_sending_to_distribution_list (str): confirmSendingToDistributionList - *Optional* - cancel_sending_to_distribution_list (str): cancelSendingToDistributionList + service_name (str): serviceName + authorized_quantity (authorizedQuantity): authorizedQuantity *Optional* """ __slots__: List[str] = [ - "confirm_sending_to_distribution_list", - "cancel_sending_to_distribution_list", + "service_name", + "authorized_quantity", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( + E("service_name", "serviceName", str, is_required=True), E( - "confirm_sending_to_distribution_list", - "confirmSendingToDistributionList", - str, - ), - E( - "cancel_sending_to_distribution_list", - "cancelSendingToDistributionList", - str, - is_required=True, + "authorized_quantity", + "authorizedQuantity", + UnboundedPositiveInt, + is_complex=True, ), ) -class SendToAllGroupMembersMenuKeysModifyEntry(OCIType): +class CombinedServiceInstanceAddProfile(OCIType): """ - The voice portal send to all group memeber menu keys modify entry. + Service Profile Information for group service. + When name, callingLineIdLastName and callingLineIdFirstName are not included, the + values in the corresponding service instance template (if this is used to add a Hunt + Group, for example, the name will come from the Hunt Group template) will be used. + Otherwise, the request will fail. If the phoneNumber has not been assigned to the + group, it will be added to group and service provider if needed. Attributes: - confirm_sending_to_entire_group (str): confirmSendingToEntireGroup *Optional* - cancel_sending_to_entire_group (str): cancelSendingToEntireGroup *Optional* + name (str): name *Optional* + calling_line_id_last_name (str): callingLineIdLastName *Optional* + calling_line_id_first_name (str): callingLineIdFirstName *Optional* + hiragana_last_name (str): hiraganaLastName *Optional* + hiragana_first_name (str): hiraganaFirstName *Optional* + phone_number (str): phoneNumber *Optional* + extension (str): extension *Optional* + password (str): password *Optional* + department (department): department *Optional* + language (str): language *Optional* + time_zone (str): timeZone *Optional* + alias (List[str]): alias *Optional* + public_user_identity (str): publicUserIdentity *Optional* + calling_line_id_phone_number (str): callingLineIdPhoneNumber *Optional* """ __slots__: List[str] = [ - "confirm_sending_to_entire_group", - "cancel_sending_to_entire_group", + "name", + "calling_line_id_last_name", + "calling_line_id_first_name", + "hiragana_last_name", + "hiragana_first_name", + "phone_number", + "extension", + "password", + "department", + "language", + "time_zone", + "alias", + "public_user_identity", + "calling_line_id_phone_number", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("confirm_sending_to_entire_group", "confirmSendingToEntireGroup", str), - E("cancel_sending_to_entire_group", "cancelSendingToEntireGroup", str), + E("name", "name", str), + E("calling_line_id_last_name", "callingLineIdLastName", str), + E("calling_line_id_first_name", "callingLineIdFirstName", str), + E("hiragana_last_name", "hiraganaLastName", str), + E("hiragana_first_name", "hiraganaFirstName", str), + E("phone_number", "phoneNumber", str), + E("extension", "extension", str), + E("password", "password", str), + E("department", "department", DepartmentKey, is_complex=True), + E("language", "language", str), + E("time_zone", "timeZone", str), + E("alias", "alias", str, is_array=True), + E("public_user_identity", "publicUserIdentity", str), + E("calling_line_id_phone_number", "callingLineIdPhoneNumber", str), ) -class SendToAllGroupMembersMenuKeysReadEntry(OCIType): +class CombinedServicePackAssignment(OCIType): """ - The voice portal send to all group memeber menu keys. + Assign a service pack to user. + If the service pack has not been authorized to service provider or group, it will be + authorized. If the service pack needs to be authorized at group/service provider + levels, the authorizedQuantity will be used. Otherwise, it will be ignored. If the + authorizedQuantity is not included, the quantity will come from the group template for + the service pack. If a template does not exist, the service quantity will be set to + unlimited. Attributes: - confirm_sending_to_entire_group (str): confirmSendingToEntireGroup - cancel_sending_to_entire_group (str): cancelSendingToEntireGroup + service_pack_name (str): servicePackName + authorized_quantity (authorizedQuantity): authorizedQuantity *Optional* """ __slots__: List[str] = [ - "confirm_sending_to_entire_group", - "cancel_sending_to_entire_group", + "service_pack_name", + "authorized_quantity", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( + E("service_pack_name", "servicePackName", str, is_required=True), E( - "confirm_sending_to_entire_group", - "confirmSendingToEntireGroup", - str, - is_required=True, - ), - E( - "cancel_sending_to_entire_group", - "cancelSendingToEntireGroup", - str, - is_required=True, + "authorized_quantity", + "authorizedQuantity", + UnboundedPositiveInt, + is_complex=True, ), ) -class SendToDistributionListMenuKeysModifyEntry(OCIType): +class CombinedServicePackAuthorization(OCIType): """ - The voice portal send to distribution list menu keys modify entry. + Authorize a service pack. Attributes: - send_message_to_selected_distribution_list (str): - sendMessageToSelectedDistributionList *Optional* - select_distribution_list (str): selectDistributionList *Optional* - review_selected_distribution_list (str): reviewSelectedDistributionList *Optional* - return_to_previous_menu (str): returnToPreviousMenu *Optional* - repeat_menu (str): repeatMenu *Optional* + service_pack_name (str): servicePackName + authorized_quantity (authorizedQuantity): authorizedQuantity *Optional* """ __slots__: List[str] = [ - "send_message_to_selected_distribution_list", - "select_distribution_list", - "review_selected_distribution_list", - "return_to_previous_menu", - "repeat_menu", + "service_pack_name", + "authorized_quantity", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( + E("service_pack_name", "servicePackName", str, is_required=True), E( - "send_message_to_selected_distribution_list", - "sendMessageToSelectedDistributionList", - str, - ), - E("select_distribution_list", "selectDistributionList", str), - E( - "review_selected_distribution_list", - "reviewSelectedDistributionList", - str, + "authorized_quantity", + "authorizedQuantity", + UnboundedPositiveInt, + is_complex=True, ), - E("return_to_previous_menu", "returnToPreviousMenu", str), - E("repeat_menu", "repeatMenu", str), ) -class SendToDistributionListMenuKeysReadEntry(OCIType): +class CombinedSharedCallAppearanceAccessDeviceMultipleIdentityEndpoint(OCIType): """ - The voice portal send to distribution list menu keys. + Access device end point for Shared Call Appearance Service used in the context of add. + The endpoint is identified by its linePort (public Identity) and possibly a private + Identity. Port numbers are only used by devices with static line ordering. In the + case an access device referenced by accessDevice does not exist, the device will be + added. When elements for isActive, allowOrigination, allowTermination and allowVideo + are not included in the request, the values for them will come for the Shared Call + Appearance endpoints template. If the template does not exist, the request using this + data type will fail. The device attributes deviceType, protocol, netAddress, port, + outboundProxyServerNetAddress, stunServerNetAddress, macAddress, serialNumber, + description, physicalLocation, transportProtocol, useCustomUserNamePassword and + accessDeviceCredentials will be ignored if the access device already exists. Attributes: - send_message_to_selected_distribution_list (str): - sendMessageToSelectedDistributionList - select_distribution_list (str): selectDistributionList *Optional* - review_selected_distribution_list (str): reviewSelectedDistributionList *Optional* - return_to_previous_menu (str): returnToPreviousMenu - repeat_menu (str): repeatMenu *Optional* + access_device (accessDevice): accessDevice + line_port (str): linePort + private_identity (str): privateIdentity *Optional* + contact (str): contact *Optional* + port_number (int): portNumber *Optional* + is_active (bool): isActive *Optional* + allow_origination (bool): allowOrigination *Optional* + allow_termination (bool): allowTermination *Optional* + allow_video (bool): allowVideo *Optional* + device_type (str): deviceType *Optional* + protocol (str): protocol *Optional* + net_address (str): netAddress *Optional* + port (int): port *Optional* + outbound_proxy_server_net_address (str): outboundProxyServerNetAddress *Optional* + stun_server_net_address (str): stunServerNetAddress *Optional* + mac_address (str): macAddress *Optional* + serial_number (str): serialNumber *Optional* + description (str): description *Optional* + physical_location (str): physicalLocation *Optional* + transport_protocol (str): transportProtocol *Optional* + use_custom_user_name_password (bool): useCustomUserNamePassword *Optional* + access_device_credentials (accessDeviceCredentials): accessDeviceCredentials + *Optional* """ __slots__: List[str] = [ - "send_message_to_selected_distribution_list", - "select_distribution_list", - "review_selected_distribution_list", - "return_to_previous_menu", - "repeat_menu", + "access_device", + "line_port", + "private_identity", + "contact", + "port_number", + "is_active", + "allow_origination", + "allow_termination", + "allow_video", + "device_type", + "protocol", + "net_address", + "port", + "outbound_proxy_server_net_address", + "stun_server_net_address", + "mac_address", + "serial_number", + "description", + "physical_location", + "transport_protocol", + "use_custom_user_name_password", + "access_device_credentials", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( E( - "send_message_to_selected_distribution_list", - "sendMessageToSelectedDistributionList", - str, + "access_device", + "accessDevice", + AccessDevice, + is_complex=True, is_required=True, ), - E("select_distribution_list", "selectDistributionList", str), + E("line_port", "linePort", str, is_required=True), + E("private_identity", "privateIdentity", str), + E("contact", "contact", str), + E("port_number", "portNumber", int), + E("is_active", "isActive", bool), + E("allow_origination", "allowOrigination", bool), + E("allow_termination", "allowTermination", bool), + E("allow_video", "allowVideo", bool), + E("device_type", "deviceType", str), + E("protocol", "protocol", str), + E("net_address", "netAddress", str), + E("port", "port", int), E( - "review_selected_distribution_list", - "reviewSelectedDistributionList", + "outbound_proxy_server_net_address", + "outboundProxyServerNetAddress", str, ), - E("return_to_previous_menu", "returnToPreviousMenu", str, is_required=True), - E("repeat_menu", "repeatMenu", str), + E("stun_server_net_address", "stunServerNetAddress", str), + E("mac_address", "macAddress", str), + E("serial_number", "serialNumber", str), + E("description", "description", str), + E("physical_location", "physicalLocation", str), + E("transport_protocol", "transportProtocol", str), + E("use_custom_user_name_password", "useCustomUserNamePassword", bool), + E( + "access_device_credentials", + "accessDeviceCredentials", + DeviceManagementUserNamePassword16, + is_complex=True, + ), ) -class SendToPersonMenuKeysModifyEntry(OCIType): +class CombinedUserServiceAssignment(OCIType): """ - The voice portal send to person menu keys modify entry. + Assign a service user. + If the service has not been authorized to service provider or group, it will be + authorized. If the service needs to be authorized at group/service provider levels, + the authorizedQuantity will be used. Otherwise, it will be ignored. If the + authorizedQuantity is not included, the quantity will come from the group template for + the service. If a template does not exist, the service quantity will be set to + unlimited. Attributes: - confirm_sending_message (str): confirmSendingMessage *Optional* - cancel_sending_message (str): cancelSendingMessage *Optional* - finish_entering_number_where_to_send_message_to (str): - finishEnteringNumberWhereToSendMessageTo *Optional* - finish_forwarding_or_sending_message (str): finishForwardingOrSendingMessage - *Optional* + user_service (str): userService + authorized_quantity (authorizedQuantity): authorizedQuantity *Optional* """ __slots__: List[str] = [ - "confirm_sending_message", - "cancel_sending_message", - "finish_entering_number_where_to_send_message_to", - "finish_forwarding_or_sending_message", + "user_service", + "authorized_quantity", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("confirm_sending_message", "confirmSendingMessage", str), - E("cancel_sending_message", "cancelSendingMessage", str), - E( - "finish_entering_number_where_to_send_message_to", - "finishEnteringNumberWhereToSendMessageTo", - str, - ), + E("user_service", "userService", str, is_required=True), E( - "finish_forwarding_or_sending_message", - "finishForwardingOrSendingMessage", - str, + "authorized_quantity", + "authorizedQuantity", + UnboundedPositiveInt, + is_complex=True, ), ) -class SendToPersonMenuKeysReadEntry(OCIType): +class CombinedUserServiceAuthorization(OCIType): """ - The voice portal send to person menu keys. + Authorize a user service. Attributes: - confirm_sending_message (str): confirmSendingMessage - cancel_sending_message (str): cancelSendingMessage - finish_entering_number_where_to_send_message_to (str): - finishEnteringNumberWhereToSendMessageTo - finish_forwarding_or_sending_message (str): finishForwardingOrSendingMessage + service_name (str): serviceName + authorized_quantity (authorizedQuantity): authorizedQuantity *Optional* """ __slots__: List[str] = [ - "confirm_sending_message", - "cancel_sending_message", - "finish_entering_number_where_to_send_message_to", - "finish_forwarding_or_sending_message", + "service_name", + "authorized_quantity", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( + E("service_name", "serviceName", str, is_required=True), E( - "confirm_sending_message", - "confirmSendingMessage", - str, - is_required=True, - ), - E("cancel_sending_message", "cancelSendingMessage", str, is_required=True), - E( - "finish_entering_number_where_to_send_message_to", - "finishEnteringNumberWhereToSendMessageTo", - str, - is_required=True, - ), - E( - "finish_forwarding_or_sending_message", - "finishForwardingOrSendingMessage", - str, - is_required=True, + "authorized_quantity", + "authorizedQuantity", + UnboundedPositiveInt, + is_complex=True, ), ) -class SequentialRingLocation(OCIType): +class CommPilotExpressAvailableInOffice(OCIType): """ - Sequential Ring Location. + CommPilot Express Available In Office Settings. - Replaced By: SequentialRingLocation14sp4 Attributes: - phone_number (str): phoneNumber *Optional* - number_of_rings (int): numberOfRings + additional_phone_number_to_ring (str): additionalPhoneNumberToRing *Optional* + busy_setting (busySetting): busySetting + no_answer_setting (noAnswerSetting): noAnswerSetting """ __slots__: List[str] = [ - "phone_number", - "number_of_rings", + "additional_phone_number_to_ring", + "busy_setting", + "no_answer_setting", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("phone_number", "phoneNumber", str), - E("number_of_rings", "numberOfRings", int, is_required=True), + E("additional_phone_number_to_ring", "additionalPhoneNumberToRing", str), + E( + "busy_setting", + "busySetting", + CommPilotExpressRedirection, + is_complex=True, + is_required=True, + ), + E( + "no_answer_setting", + "noAnswerSetting", + CommPilotExpressRedirection, + is_complex=True, + is_required=True, + ), ) -class SequentialRingLocation14sp4(OCIType): +class CommPilotExpressAvailableInOfficeModify(OCIType): """ - Sequential Ring Location. + CommPilot Express Available In Office Settings. Attributes: - phone_number (str): phoneNumber *Optional* - number_of_rings (int): numberOfRings - answer_confirmation_required (bool): answerConfirmationRequired + additional_phone_number_to_ring (str): additionalPhoneNumberToRing *Optional* + busy_setting (busySetting): busySetting *Optional* + no_answer_setting (noAnswerSetting): noAnswerSetting *Optional* """ __slots__: List[str] = [ - "phone_number", - "number_of_rings", - "answer_confirmation_required", + "additional_phone_number_to_ring", + "busy_setting", + "no_answer_setting", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("phone_number", "phoneNumber", str), - E("number_of_rings", "numberOfRings", int, is_required=True), + E("additional_phone_number_to_ring", "additionalPhoneNumberToRing", str), E( - "answer_confirmation_required", - "answerConfirmationRequired", - bool, - is_required=True, + "busy_setting", + "busySetting", + CommPilotExpressRedirectionModify, + is_complex=True, + ), + E( + "no_answer_setting", + "noAnswerSetting", + CommPilotExpressRedirectionModify, + is_complex=True, ), ) -class SequentialRingLocationModify(OCIType): +class CommPilotExpressAvailableOutOfOffice(OCIType): """ - Sequential Ring Location. + CommPilot Express Available Out Of Office Configuration used in the context of a get. Attributes: - phone_number (str): phoneNumber *Optional* - number_of_rings (int): numberOfRings *Optional* - answer_confirmation_required (bool): answerConfirmationRequired *Optional* + incoming_calls (incomingCalls): incomingCalls + incoming_call_notify (incomingCallNotify): incomingCallNotify """ __slots__: List[str] = [ - "phone_number", - "number_of_rings", - "answer_confirmation_required", + "incoming_calls", + "incoming_call_notify", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("phone_number", "phoneNumber", str), - E("number_of_rings", "numberOfRings", int), - E("answer_confirmation_required", "answerConfirmationRequired", bool), + E( + "incoming_calls", + "incomingCalls", + CommPilotExpressRedirection, + is_complex=True, + is_required=True, + ), + E( + "incoming_call_notify", + "incomingCallNotify", + CommPilotExpressEmailNotify, + is_complex=True, + is_required=True, + ), ) -class ServiceActivation(OCIType): +class CommPilotExpressAvailableOutOfOfficeModify(OCIType): """ - Service Instance active status indicator + CommPilot Express Available Out Of Office Configuration used in the context of a + modify. + Attributes: - service_user_id (str): serviceUserId - is_active (bool): isActive + incoming_calls (incomingCalls): incomingCalls *Optional* + incoming_call_notify (incomingCallNotify): incomingCallNotify *Optional* """ __slots__: List[str] = [ - "service_user_id", - "is_active", + "incoming_calls", + "incoming_call_notify", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("service_user_id", "serviceUserId", str, is_required=True), - E("is_active", "isActive", bool, is_required=True), + E( + "incoming_calls", + "incomingCalls", + CommPilotExpressRedirectionModify, + is_complex=True, + ), + E( + "incoming_call_notify", + "incomingCallNotify", + CommPilotExpressEmailNotifyModify, + is_complex=True, + ), ) -class ServiceAttributeEntry(OCIType): +class CommPilotExpressBusy(OCIType): """ - The service attributes name and value pair. + CommPilot Express Available In Office Configuration used in the context of a get. Attributes: - name (str): name - value (str): value + incoming_calls (incomingCalls): incomingCalls + voice_mail_notify (voiceMailNotify): voiceMailNotify """ __slots__: List[str] = [ - "name", - "value", + "incoming_calls", + "voice_mail_notify", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("name", "name", str, is_required=True), - E("value", "value", str, is_required=True), + E( + "incoming_calls", + "incomingCalls", + CommPilotExpressRedirectionWithException, + is_complex=True, + is_required=True, + ), + E( + "voice_mail_notify", + "voiceMailNotify", + CommPilotExpressEmailNotify, + is_complex=True, + is_required=True, + ), ) -class ServiceAttributeEntryRead(OCIType): +class CommPilotExpressBusyModify(OCIType): """ - The service attributes name and value pair. + CommPilot Express Available In Office Configuration used in the context of a modify. Attributes: - name (str): name - value (str): value *Optional* + incoming_calls (incomingCalls): incomingCalls *Optional* + voice_mail_notify (voiceMailNotify): voiceMailNotify *Optional* """ __slots__: List[str] = [ - "name", - "value", + "incoming_calls", + "voice_mail_notify", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("name", "name", str, is_required=True), - E("value", "value", str), + E( + "incoming_calls", + "incomingCalls", + CommPilotExpressRedirectionWithExceptionModify, + is_complex=True, + ), + E( + "voice_mail_notify", + "voiceMailNotify", + CommPilotExpressEmailNotifyModify, + is_complex=True, + ), ) -class ServiceCodeEntry(OCIType): +class CommPilotExpressUnavailable(OCIType): """ - The service code entry. + CommPilot Express Unavailable Configuration used in the context of a get. Attributes: - service_code (str): serviceCode - description (str): description + incoming_calls (incomingCalls): incomingCalls + voice_mail_greeting (str): voiceMailGreeting """ __slots__: List[str] = [ - "service_code", - "description", + "incoming_calls", + "voice_mail_greeting", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("service_code", "serviceCode", str, is_required=True), - E("description", "description", str, is_required=True), + E( + "incoming_calls", + "incomingCalls", + CommPilotExpressRedirectionWithException, + is_complex=True, + is_required=True, + ), + E("voice_mail_greeting", "voiceMailGreeting", str, is_required=True), ) -class ServicePolicyAttributeEntry(OCIType): +class CommPilotExpressUnavailableModify(OCIType): """ - The service policy attributes name and value pair. + CommPilot Express Unavailable Configuration used in the context of a modify. Attributes: - name (str): name - value (str): value *Optional* + incoming_calls (incomingCalls): incomingCalls *Optional* + voice_mail_greeting (str): voiceMailGreeting *Optional* """ __slots__: List[str] = [ - "name", - "value", + "incoming_calls", + "voice_mail_greeting", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("name", "name", str, is_required=True), - E("value", "value", str), + E( + "incoming_calls", + "incomingCalls", + CommPilotExpressRedirectionWithExceptionModify, + is_complex=True, + ), + E("voice_mail_greeting", "voiceMailGreeting", str), ) -class ServicePolicyAttributeModifyEntry(OCIType): +class ConsolidatedAccessDeviceMultipleIdentityEndpointAndContactAdd(OCIType): """ - The service policy attributes name and value pair. + Access device end point used in the context of add. + The endpoint is identified by its linePort (public Identity) and possibly a private + Identity. In XS data mode, only one contact can be defined. Only Static Registration + capable devices may have more than one contact defined. Port numbers are only used by + devices with static line ordering. In the case an access device referenced by + accessDevice does not exist, the device will be added. The device attributes + deviceType, protocol, netAddress, port, outboundProxyServerNetAddress, + stunServerNetAddress, macAddress, serialNumber, description, physicalLocation, + transportProtocol, useCustomUserNamePassword and accessDeviceCredentials will be + ignored if the access device already exists. Attributes: - name (str): name - value (str): value + access_device (accessDevice): accessDevice + line_port (str): linePort + private_identity (str): privateIdentity *Optional* + contact (List[str]): contact *Optional* + port_number (int): portNumber *Optional* + device_type (str): deviceType *Optional* + protocol (str): protocol *Optional* + net_address (str): netAddress *Optional* + port (int): port *Optional* + outbound_proxy_server_net_address (str): outboundProxyServerNetAddress *Optional* + stun_server_net_address (str): stunServerNetAddress *Optional* + mac_address (str): macAddress *Optional* + serial_number (str): serialNumber *Optional* + description (str): description *Optional* + physical_location (str): physicalLocation *Optional* + transport_protocol (str): transportProtocol *Optional* + use_custom_user_name_password (bool): useCustomUserNamePassword *Optional* + access_device_credentials (accessDeviceCredentials): accessDeviceCredentials + *Optional* """ __slots__: List[str] = [ - "name", - "value", + "access_device", + "line_port", + "private_identity", + "contact", + "port_number", + "device_type", + "protocol", + "net_address", + "port", + "outbound_proxy_server_net_address", + "stun_server_net_address", + "mac_address", + "serial_number", + "description", + "physical_location", + "transport_protocol", + "use_custom_user_name_password", + "access_device_credentials", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("name", "name", str, is_required=True), - E("value", "value", str, is_required=True), + E( + "access_device", + "accessDevice", + AccessDevice, + is_complex=True, + is_required=True, + ), + E("line_port", "linePort", str, is_required=True), + E("private_identity", "privateIdentity", str), + E("contact", "contact", str, is_array=True), + E("port_number", "portNumber", int), + E("device_type", "deviceType", str), + E("protocol", "protocol", str), + E("net_address", "netAddress", str), + E("port", "port", int), + E( + "outbound_proxy_server_net_address", + "outboundProxyServerNetAddress", + str, + ), + E("stun_server_net_address", "stunServerNetAddress", str), + E("mac_address", "macAddress", str), + E("serial_number", "serialNumber", str), + E("description", "description", str), + E("physical_location", "physicalLocation", str), + E("transport_protocol", "transportProtocol", str), + E("use_custom_user_name_password", "useCustomUserNamePassword", bool), + E( + "access_device_credentials", + "accessDeviceCredentials", + DeviceManagementUserNamePassword16, + is_complex=True, + ), ) -class ServicePolicyProfileKey(OCIType): +class ConsolidatedAccessDeviceMultipleIdentityEndpointAndContactAdd22(OCIType): """ - The service policy profile key. + Access device end point used in the context of add. + The endpoint is identified by its linePort (public Identity) and possibly a private + Identity. In XS data mode, only one contact can be defined. Only Static Registration + capable devices may have more than one contact defined. Port numbers are only used by + devices with static line ordering. In the case an access device referenced by + accessDevice does not exist, the device will be added. The device attributes + deviceType, protocol, netAddress, port, outboundProxyServerNetAddress, + stunServerNetAddress, macAddress, serialNumber, description, physicalLocation, + transportProtocol, useCustomUserNamePassword and accessDeviceCredentials will be + ignored if the access device already exists. The following elements are only used in + AS data mode and ignored in XS data mode: useHotline, use value false in XS data mode + hotlineContact Attributes: - name (str): name - category (str): category + access_device (accessDevice): accessDevice + line_port (str): linePort + private_identity (str): privateIdentity *Optional* + contact (List[str]): contact *Optional* + port_number (int): portNumber *Optional* + device_type (str): deviceType *Optional* + protocol (str): protocol *Optional* + net_address (str): netAddress *Optional* + port (int): port *Optional* + outbound_proxy_server_net_address (str): outboundProxyServerNetAddress *Optional* + stun_server_net_address (str): stunServerNetAddress *Optional* + mac_address (str): macAddress *Optional* + serial_number (str): serialNumber *Optional* + description (str): description *Optional* + physical_location (str): physicalLocation *Optional* + transport_protocol (str): transportProtocol *Optional* + use_custom_user_name_password (bool): useCustomUserNamePassword *Optional* + access_device_credentials (accessDeviceCredentials): accessDeviceCredentials + *Optional* + use_hotline (bool): useHotline + hotline_contact (str): hotlineContact *Optional* """ __slots__: List[str] = [ - "name", - "category", + "access_device", + "line_port", + "private_identity", + "contact", + "port_number", + "device_type", + "protocol", + "net_address", + "port", + "outbound_proxy_server_net_address", + "stun_server_net_address", + "mac_address", + "serial_number", + "description", + "physical_location", + "transport_protocol", + "use_custom_user_name_password", + "access_device_credentials", + "use_hotline", + "hotline_contact", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("name", "name", str, is_required=True), - E("category", "category", str, is_required=True), + E( + "access_device", + "accessDevice", + AccessDevice, + is_complex=True, + is_required=True, + ), + E("line_port", "linePort", str, is_required=True), + E("private_identity", "privateIdentity", str), + E("contact", "contact", str, is_array=True), + E("port_number", "portNumber", int), + E("device_type", "deviceType", str), + E("protocol", "protocol", str), + E("net_address", "netAddress", str), + E("port", "port", int), + E( + "outbound_proxy_server_net_address", + "outboundProxyServerNetAddress", + str, + ), + E("stun_server_net_address", "stunServerNetAddress", str), + E("mac_address", "macAddress", str), + E("serial_number", "serialNumber", str), + E("description", "description", str), + E("physical_location", "physicalLocation", str), + E("transport_protocol", "transportProtocol", str), + E("use_custom_user_name_password", "useCustomUserNamePassword", bool), + E( + "access_device_credentials", + "accessDeviceCredentials", + DeviceManagementUserNamePassword16, + is_complex=True, + ), + E("use_hotline", "useHotline", bool, is_required=True), + E("hotline_contact", "hotlineContact", str), ) -class ServiceProviderAdmin(OCIType): +class ConsolidatedAccessDeviceMultipleIdentityEndpointAndContactModify(OCIType): """ - The common Service Provider Admin elements. + Access device end point used in the context of modify. + . The endpoint is identified by its linePort (public Identity) and possibly a private + Identity. Only Static Registration capable devices may have more than one contact + defined. Only the first contact in contactList is used in XS data mode. Port numbers + are only used by devices with static line ordering. In the case an access device + referenced by accessDevice does not exist, the device will be added. When the device + needs to be added, if the linePort is not specified, the request will fail If the + deviceType is included in the request a new device will be created using the type + unless a device with the same name already exists. The device attributes protocol, + netAddress, port, outboundProxyServerNetAddress, stunServerNetAddress, macAddress, + serialNumber, description, physicalLocation, transportProtocol, + useCustomUserNamePassword and accessDeviceCredentials will be ignored if the access + device already exists. The following elements are only used in AS data mode and + ignored in XS data mode: useHotline hotlineContact Attributes: - user_id (str): userId - first_name (str): firstName *Optional* - last_name (str): lastName *Optional* - password (str): password *Optional* - language (str): language *Optional* - administrator_type (str): administratorType - """ - - __slots__: List[str] = [ - "user_id", - "first_name", - "last_name", - "password", - "language", - "administrator_type", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("user_id", "userId", str, is_required=True), - E("first_name", "firstName", str), - E("last_name", "lastName", str), - E("password", "password", str), - E("language", "language", str), - E("administrator_type", "administratorType", str, is_required=True), - ) - - -class ServiceProviderBroadWorksMobilityGetRequest21sp1V2(OCIType): - """ - Get the service provider BroadWorks Mobility service settings. - - The response is either a ServiceProviderBroadWorksMobilityGetResponse21sp1V2 or an - `ErrorResponse()`. Replaced by `ServiceProviderBroadWorksMobilityGetRequest22V2()`. - - Attributes: - service_provider_id (str): serviceProviderId + access_device (accessDevice): accessDevice *Optional* + line_port (str): linePort *Optional* + private_identity (str): privateIdentity *Optional* + contact_list (contactList): contactList *Optional* + port_number (int): portNumber *Optional* + device_type (str): deviceType *Optional* + protocol (str): protocol *Optional* + net_address (str): netAddress *Optional* + port (int): port *Optional* + outbound_proxy_server_net_address (str): outboundProxyServerNetAddress *Optional* + stun_server_net_address (str): stunServerNetAddress *Optional* + mac_address (str): macAddress *Optional* + serial_number (str): serialNumber *Optional* + description (str): description *Optional* + physical_location (str): physicalLocation *Optional* + transport_protocol (str): transportProtocol *Optional* + use_custom_user_name_password (bool): useCustomUserNamePassword *Optional* + access_device_credentials (accessDeviceCredentials): accessDeviceCredentials + *Optional* + use_hotline (bool): useHotline *Optional* + hotline_contact (str): hotlineContact *Optional* """ __slots__: List[str] = [ - "service_provider_id", + "access_device", + "line_port", + "private_identity", + "contact_list", + "port_number", + "device_type", + "protocol", + "net_address", + "port", + "outbound_proxy_server_net_address", + "stun_server_net_address", + "mac_address", + "serial_number", + "description", + "physical_location", + "transport_protocol", + "use_custom_user_name_password", + "access_device_credentials", + "use_hotline", + "hotline_contact", ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return (E("service_provider_id", "serviceProviderId", str, is_required=True),) + return ( + E("access_device", "accessDevice", AccessDevice, is_complex=True), + E("line_port", "linePort", str), + E("private_identity", "privateIdentity", str), + E("contact_list", "contactList", ReplacementContactList, is_complex=True), + E("port_number", "portNumber", int), + E("device_type", "deviceType", str), + E("protocol", "protocol", str), + E("net_address", "netAddress", str), + E("port", "port", int), + E( + "outbound_proxy_server_net_address", + "outboundProxyServerNetAddress", + str, + ), + E("stun_server_net_address", "stunServerNetAddress", str), + E("mac_address", "macAddress", str), + E("serial_number", "serialNumber", str), + E("description", "description", str), + E("physical_location", "physicalLocation", str), + E("transport_protocol", "transportProtocol", str), + E("use_custom_user_name_password", "useCustomUserNamePassword", bool), + E( + "access_device_credentials", + "accessDeviceCredentials", + DeviceManagementUserNamePassword16, + is_complex=True, + ), + E("use_hotline", "useHotline", bool), + E("hotline_contact", "hotlineContact", str), + ) -class ServiceProviderBroadWorksMobilityGetResponse21sp1V2(OCIType): +class ConsolidatedGroupServiceAssignment(OCIType): """ - The response to a ServiceProviderBroadWorksMobilityGetRequest21sp1V2. + Authorize and assign a group service. - Replaced by `ServiceProviderBroadWorksMobilityGetResponse22V2()`. + The authorizedQuantity will be used at the group level if provided; otherwise, the + service quantity will be set to unlimited. The command will fail if the authorized + quantity set at the service provider level is insufficient. Attributes: - use_setting_level (str): useSettingLevel - enable_location_services (bool): enableLocationServices - enable_msrn_lookup (bool): enableMSRNLookup - enable_mobile_state_checking (bool): enableMobileStateChecking - deny_call_originations (bool): denyCallOriginations - deny_call_terminations (bool): denyCallTerminations - enable_announcement_suppression (bool): enableAnnouncementSuppression - enable_internal_clid_delivery_access_locations (bool): - enableInternalCLIDDeliveryAccessLocations - enable_enhanced_unreachable_state_checking (bool): - enableEnhancedUnreachableStateChecking - enable_network_call_barring_status_check (bool): - enableNetworkCallBarringStatusCheck + group_service_name (str): groupServiceName + authorized_quantity (authorizedQuantity): authorizedQuantity *Optional* """ __slots__: List[str] = [ - "use_setting_level", - "enable_location_services", - "enable_msrn_lookup", - "enable_mobile_state_checking", - "deny_call_originations", - "deny_call_terminations", - "enable_announcement_suppression", - "enable_internal_clid_delivery_access_locations", - "enable_enhanced_unreachable_state_checking", - "enable_network_call_barring_status_check", + "group_service_name", + "authorized_quantity", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("use_setting_level", "useSettingLevel", str, is_required=True), - E( - "enable_location_services", - "enableLocationServices", - bool, - is_required=True, - ), - E("enable_msrn_lookup", "enableMSRNLookup", bool, is_required=True), - E( - "enable_mobile_state_checking", - "enableMobileStateChecking", - bool, - is_required=True, - ), - E("deny_call_originations", "denyCallOriginations", bool, is_required=True), - E("deny_call_terminations", "denyCallTerminations", bool, is_required=True), - E( - "enable_announcement_suppression", - "enableAnnouncementSuppression", - bool, - is_required=True, - ), - E( - "enable_internal_clid_delivery_access_locations", - "enableInternalCLIDDeliveryAccessLocations", - bool, - is_required=True, - ), - E( - "enable_enhanced_unreachable_state_checking", - "enableEnhancedUnreachableStateChecking", - bool, - is_required=True, - ), + E("group_service_name", "groupServiceName", str, is_required=True), E( - "enable_network_call_barring_status_check", - "enableNetworkCallBarringStatusCheck", - bool, - is_required=True, + "authorized_quantity", + "authorizedQuantity", + UnboundedPositiveInt, + is_complex=True, ), ) -class ServiceProviderCommunicationBarringHierarchicalCallMeNowRule(OCIType): +class ConsolidatedServicePackAssignment(OCIType): """ - Service Provider Communication Barring Hierarchical Call Me Now Rule + Assign a service pack to user. + + If the service pack has not been authorized to the group, it will be authorized. The + authorizedQuantity will be used at the group level if provided; otherwise, the service + quantity will be set to unlimited. The command will fail if the authorized quantity + set at the service provider level is insufficient. Attributes: - criteria (str): criteria *Optional* - digit_pattern_criteria (str): digitPatternCriteria *Optional* - action (str): action - call_timeout_seconds (int): callTimeoutSeconds *Optional* - time_schedule (str): timeSchedule *Optional* - holiday_schedule (str): holidaySchedule *Optional* - priority (str): priority + service_pack_name (str): servicePackName + authorized_quantity (authorizedQuantity): authorizedQuantity *Optional* """ __slots__: List[str] = [ - "criteria", - "digit_pattern_criteria", - "action", - "call_timeout_seconds", - "time_schedule", - "holiday_schedule", - "priority", + "service_pack_name", + "authorized_quantity", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("criteria", "criteria", str), - E("digit_pattern_criteria", "digitPatternCriteria", str), - E("action", "action", str, is_required=True), - E("call_timeout_seconds", "callTimeoutSeconds", int), - E("time_schedule", "timeSchedule", str), - E("holiday_schedule", "holidaySchedule", str), - E("priority", "priority", str, is_required=True), + E("service_pack_name", "servicePackName", str, is_required=True), + E( + "authorized_quantity", + "authorizedQuantity", + UnboundedPositiveInt, + is_complex=True, + ), ) -class ServiceProviderCommunicationBarringHierarchicalOriginatingRule(OCIType): +class ConsolidatedSharedCallAppearanceAccessDeviceMultipleIdentityEndpoint(OCIType): """ - Service Provider Communication Barring Hierarchical Originating Rule + Access device end point for Shared Call Appearance Service used in the context of add. + + The endpoint is identified by its linePort (public Identity) and possibly a private + Identity. Port numbers are only used by devices with static line ordering. In the + case an access device referenced by accessDevice does not exist, the device will be + added. The device attributes deviceType, protocol, netAddress, port, + outboundProxyServerNetAddress, stunServerNetAddress, macAddress, serialNumber, + description, physicalLocation, transportProtocol, useCustomUserNamePassword and + accessDeviceCredentials will be ignored if the access device already exists. The + following elements are only used in XS data mode and ignored in AS data mode: + privateIdentity Attributes: - criteria (str): criteria *Optional* - digit_pattern_criteria (str): digitPatternCriteria *Optional* - action (str): action - treatment_id (str): treatmentId *Optional* - transfer_number (str): transferNumber *Optional* - call_timeout_seconds (int): callTimeoutSeconds *Optional* - time_schedule (str): timeSchedule *Optional* - holiday_schedule (str): holidaySchedule *Optional* - priority (str): priority + access_device (accessDevice): accessDevice + line_port (str): linePort + private_identity (str): privateIdentity *Optional* + contact (str): contact *Optional* + port_number (int): portNumber *Optional* + is_active (bool): isActive + allow_origination (bool): allowOrigination + allow_termination (bool): allowTermination + device_type (str): deviceType *Optional* + protocol (str): protocol *Optional* + net_address (str): netAddress *Optional* + port (int): port *Optional* + outbound_proxy_server_net_address (str): outboundProxyServerNetAddress *Optional* + stun_server_net_address (str): stunServerNetAddress *Optional* + mac_address (str): macAddress *Optional* + serial_number (str): serialNumber *Optional* + description (str): description *Optional* + physical_location (str): physicalLocation *Optional* + transport_protocol (str): transportProtocol *Optional* + use_custom_user_name_password (bool): useCustomUserNamePassword *Optional* + access_device_credentials (accessDeviceCredentials): accessDeviceCredentials + *Optional* + use_hotline (bool): useHotline *Optional* + hotline_contact (str): hotlineContact *Optional* """ __slots__: List[str] = [ - "criteria", - "digit_pattern_criteria", - "action", - "treatment_id", - "transfer_number", - "call_timeout_seconds", - "time_schedule", - "holiday_schedule", - "priority", + "access_device", + "line_port", + "private_identity", + "contact", + "port_number", + "is_active", + "allow_origination", + "allow_termination", + "device_type", + "protocol", + "net_address", + "port", + "outbound_proxy_server_net_address", + "stun_server_net_address", + "mac_address", + "serial_number", + "description", + "physical_location", + "transport_protocol", + "use_custom_user_name_password", + "access_device_credentials", + "use_hotline", + "hotline_contact", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("criteria", "criteria", str), - E("digit_pattern_criteria", "digitPatternCriteria", str), - E("action", "action", str, is_required=True), - E("treatment_id", "treatmentId", str), - E("transfer_number", "transferNumber", str), - E("call_timeout_seconds", "callTimeoutSeconds", int), - E("time_schedule", "timeSchedule", str), - E("holiday_schedule", "holidaySchedule", str), - E("priority", "priority", str, is_required=True), + E( + "access_device", + "accessDevice", + AccessDevice, + is_complex=True, + is_required=True, + ), + E("line_port", "linePort", str, is_required=True), + E("private_identity", "privateIdentity", str), + E("contact", "contact", str), + E("port_number", "portNumber", int), + E("is_active", "isActive", bool, is_required=True), + E("allow_origination", "allowOrigination", bool, is_required=True), + E("allow_termination", "allowTermination", bool, is_required=True), + E("device_type", "deviceType", str), + E("protocol", "protocol", str), + E("net_address", "netAddress", str), + E("port", "port", int), + E( + "outbound_proxy_server_net_address", + "outboundProxyServerNetAddress", + str, + ), + E("stun_server_net_address", "stunServerNetAddress", str), + E("mac_address", "macAddress", str), + E("serial_number", "serialNumber", str), + E("description", "description", str), + E("physical_location", "physicalLocation", str), + E("transport_protocol", "transportProtocol", str), + E("use_custom_user_name_password", "useCustomUserNamePassword", bool), + E( + "access_device_credentials", + "accessDeviceCredentials", + DeviceManagementUserNamePassword16, + is_complex=True, + ), + E("use_hotline", "useHotline", bool), + E("hotline_contact", "hotlineContact", str), ) -class ServiceProviderCommunicationBarringHierarchicalRedirectingRule(OCIType): +class ConsolidatedSharedCallAppearanceAccessDeviceMultipleIdentityEndpointAdd22( + OCIType, +): """ - Service Provider Communication Barring Hierarchical Redirecting Rule + Access device end point for Shared Call Appearance Service used in the context of add. + + The endpoint is identified by its linePort (public Identity) and possibly a private + Identity. Port numbers are only used by devices with static line ordering. In the + case an access device referenced by accessDevice does not exist, the device will be + added. The device attributes deviceType, protocol, netAddress, port, + outboundProxyServerNetAddress, stunServerNetAddress, macAddress, serialNumber, + description, physicalLocation, transportProtocol, useCustomUserNamePassword and + accessDeviceCredentials will be ignored if the access device already exists. The + following elements are only used in XS data mode and ignored in AS data mode: + privateIdentity The following elements are only used in AS data mode and ignored in XS + data mode: useHotline, use value false in XS data mode hotlineContact Attributes: - criteria (str): criteria *Optional* - digit_pattern_criteria (str): digitPatternCriteria *Optional* - action (str): action - call_timeout_seconds (int): callTimeoutSeconds *Optional* - time_schedule (str): timeSchedule *Optional* - holiday_schedule (str): holidaySchedule *Optional* - priority (str): priority + access_device (accessDevice): accessDevice + line_port (str): linePort + private_identity (str): privateIdentity *Optional* + contact (str): contact *Optional* + port_number (int): portNumber *Optional* + is_active (bool): isActive + allow_origination (bool): allowOrigination + allow_termination (bool): allowTermination + device_type (str): deviceType *Optional* + protocol (str): protocol *Optional* + net_address (str): netAddress *Optional* + port (int): port *Optional* + outbound_proxy_server_net_address (str): outboundProxyServerNetAddress *Optional* + stun_server_net_address (str): stunServerNetAddress *Optional* + mac_address (str): macAddress *Optional* + serial_number (str): serialNumber *Optional* + description (str): description *Optional* + physical_location (str): physicalLocation *Optional* + transport_protocol (str): transportProtocol *Optional* + use_custom_user_name_password (bool): useCustomUserNamePassword *Optional* + access_device_credentials (accessDeviceCredentials): accessDeviceCredentials + *Optional* + use_hotline (bool): useHotline + hotline_contact (str): hotlineContact *Optional* """ __slots__: List[str] = [ - "criteria", - "digit_pattern_criteria", - "action", - "call_timeout_seconds", - "time_schedule", - "holiday_schedule", - "priority", + "access_device", + "line_port", + "private_identity", + "contact", + "port_number", + "is_active", + "allow_origination", + "allow_termination", + "device_type", + "protocol", + "net_address", + "port", + "outbound_proxy_server_net_address", + "stun_server_net_address", + "mac_address", + "serial_number", + "description", + "physical_location", + "transport_protocol", + "use_custom_user_name_password", + "access_device_credentials", + "use_hotline", + "hotline_contact", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("criteria", "criteria", str), - E("digit_pattern_criteria", "digitPatternCriteria", str), - E("action", "action", str, is_required=True), - E("call_timeout_seconds", "callTimeoutSeconds", int), - E("time_schedule", "timeSchedule", str), - E("holiday_schedule", "holidaySchedule", str), - E("priority", "priority", str, is_required=True), + E( + "access_device", + "accessDevice", + AccessDevice, + is_complex=True, + is_required=True, + ), + E("line_port", "linePort", str, is_required=True), + E("private_identity", "privateIdentity", str), + E("contact", "contact", str), + E("port_number", "portNumber", int), + E("is_active", "isActive", bool, is_required=True), + E("allow_origination", "allowOrigination", bool, is_required=True), + E("allow_termination", "allowTermination", bool, is_required=True), + E("device_type", "deviceType", str), + E("protocol", "protocol", str), + E("net_address", "netAddress", str), + E("port", "port", int), + E( + "outbound_proxy_server_net_address", + "outboundProxyServerNetAddress", + str, + ), + E("stun_server_net_address", "stunServerNetAddress", str), + E("mac_address", "macAddress", str), + E("serial_number", "serialNumber", str), + E("description", "description", str), + E("physical_location", "physicalLocation", str), + E("transport_protocol", "transportProtocol", str), + E("use_custom_user_name_password", "useCustomUserNamePassword", bool), + E( + "access_device_credentials", + "accessDeviceCredentials", + DeviceManagementUserNamePassword16, + is_complex=True, + ), + E("use_hotline", "useHotline", bool, is_required=True), + E("hotline_contact", "hotlineContact", str), ) -class ServiceProviderCommunicationBarringProfileGetRequest19sp1V2(OCIType): +class ConsolidatedUserServiceAssignment(OCIType): """ - Get an existing Communication Barring Profile. + Assign a user service. - The response is either a ServiceProviderCommunicationBarringProfileGetResponse19sp1V2 - or an `ErrorResponse()`. + If the service has not been authorized to the group, it will be authorized. The + authorizedQuantity will be used at the group level if provided; otherwise, the service + quantity will be set to unlimited. The command will fail if the authorized quantity + set at the service provider level is insufficient. Attributes: - service_provider_id (str): serviceProviderId - name (str): name + user_service_name (str): userServiceName + authorized_quantity (authorizedQuantity): authorizedQuantity *Optional* """ __slots__: List[str] = [ - "service_provider_id", - "name", + "user_service_name", + "authorized_quantity", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("service_provider_id", "serviceProviderId", str, is_required=True), - E("name", "name", str, is_required=True), + E("user_service_name", "userServiceName", str, is_required=True), + E( + "authorized_quantity", + "authorizedQuantity", + UnboundedPositiveInt, + is_complex=True, + ), ) -class ServiceProviderVoiceMessagingGroupSettingsAdd(OCIType): +class CriteriaFromDnModify(OCIType): """ - A service provider's or enterprise's voice messaging settings used in the context of - add. + The from dn criteria used within a modify request. Attributes: - delivery_from_address (str): deliveryFromAddress *Optional* - notification_from_address (str): notificationFromAddress *Optional* - voice_portal_lockout_from_address (str): voicePortalLockoutFromAddress *Optional* - use_system_default_delivery_from_address (bool): - useSystemDefaultDeliveryFromAddress - use_system_default_notification_from_address (bool): - useSystemDefaultNotificationFromAddress - use_system_default_voice_portal_lockout_from_address (bool): - useSystemDefaultVoicePortalLockoutFromAddress + from_dn_criteria_selection (str): fromDnCriteriaSelection *Optional* + include_anonymous_callers (bool): includeAnonymousCallers *Optional* + include_unavailable_callers (bool): includeUnavailableCallers *Optional* + phone_number_list (phoneNumberList): phoneNumberList *Optional* """ __slots__: List[str] = [ - "delivery_from_address", - "notification_from_address", - "voice_portal_lockout_from_address", - "use_system_default_delivery_from_address", - "use_system_default_notification_from_address", - "use_system_default_voice_portal_lockout_from_address", + "from_dn_criteria_selection", + "include_anonymous_callers", + "include_unavailable_callers", + "phone_number_list", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("delivery_from_address", "deliveryFromAddress", str), - E("notification_from_address", "notificationFromAddress", str), - E( - "voice_portal_lockout_from_address", - "voicePortalLockoutFromAddress", - str, - ), - E( - "use_system_default_delivery_from_address", - "useSystemDefaultDeliveryFromAddress", - bool, - is_required=True, - ), - E( - "use_system_default_notification_from_address", - "useSystemDefaultNotificationFromAddress", - bool, - is_required=True, - ), + E("from_dn_criteria_selection", "fromDnCriteriaSelection", str), + E("include_anonymous_callers", "includeAnonymousCallers", bool), + E("include_unavailable_callers", "includeUnavailableCallers", bool), E( - "use_system_default_voice_portal_lockout_from_address", - "useSystemDefaultVoicePortalLockoutFromAddress", - bool, - is_required=True, + "phone_number_list", + "phoneNumberList", + CriteriaReplacementDNList, + is_complex=True, ), ) -class SimultaneousRingNumber(OCIType): +class DeviceManagementDeviceTypeModifyOptions(OCIType): """ - Simultaneous Ring number entry. + Device Management System device type options during a modify request. Attributes: - phone_number (str): phoneNumber - answer_confirmation_required (bool): answerConfirmationRequired + device_access_protocol (str): deviceAccessProtocol *Optional* + tag_mode (str): tagMode *Optional* + tag_set (str): tagSet *Optional* + allow_device_profile_custom_tag_set (bool): allowDeviceProfileCustomTagSet + *Optional* + allow_group_custom_tag_set (bool): allowGroupCustomTagSet *Optional* + send_email_upon_reset_failure (bool): sendEmailUponResetFailure *Optional* + device_access_net_address (str): deviceAccessNetAddress *Optional* + device_access_port (int): deviceAccessPort *Optional* + device_access_context (str): deviceAccessContext *Optional* + default_device_language (str): defaultDeviceLanguage *Optional* + default_device_encoding (str): defaultDeviceEncoding *Optional* + access_device_credentials (accessDeviceCredentials): accessDeviceCredentials + *Optional* + use_http_digest_authentication (bool): useHttpDigestAuthentication *Optional* + mac_based_file_authentication (bool): macBasedFileAuthentication *Optional* + user_name_password_file_authentication (bool): userNamePasswordFileAuthentication + *Optional* + mac_in_non_request_uri (bool): macInNonRequestURI *Optional* + mac_format_in_non_request_uri (str): macFormatInNonRequestURI *Optional* """ __slots__: List[str] = [ - "phone_number", - "answer_confirmation_required", + "device_access_protocol", + "tag_mode", + "tag_set", + "allow_device_profile_custom_tag_set", + "allow_group_custom_tag_set", + "send_email_upon_reset_failure", + "device_access_net_address", + "device_access_port", + "device_access_context", + "default_device_language", + "default_device_encoding", + "access_device_credentials", + "use_http_digest_authentication", + "mac_based_file_authentication", + "user_name_password_file_authentication", + "mac_in_non_request_uri", + "mac_format_in_non_request_uri", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("phone_number", "phoneNumber", str, is_required=True), + E("device_access_protocol", "deviceAccessProtocol", str), + E("tag_mode", "tagMode", str), + E("tag_set", "tagSet", str), E( - "answer_confirmation_required", - "answerConfirmationRequired", + "allow_device_profile_custom_tag_set", + "allowDeviceProfileCustomTagSet", + bool, + ), + E("allow_group_custom_tag_set", "allowGroupCustomTagSet", bool), + E("send_email_upon_reset_failure", "sendEmailUponResetFailure", bool), + E("device_access_net_address", "deviceAccessNetAddress", str), + E("device_access_port", "deviceAccessPort", int), + E("device_access_context", "deviceAccessContext", str), + E("default_device_language", "defaultDeviceLanguage", str), + E("default_device_encoding", "defaultDeviceEncoding", str), + E( + "access_device_credentials", + "accessDeviceCredentials", + DeviceManagementUserNamePassword, + is_complex=True, + ), + E("use_http_digest_authentication", "useHttpDigestAuthentication", bool), + E("mac_based_file_authentication", "macBasedFileAuthentication", bool), + E( + "user_name_password_file_authentication", + "userNamePasswordFileAuthentication", bool, - is_required=True, ), + E("mac_in_non_request_uri", "macInNonRequestURI", bool), + E("mac_format_in_non_request_uri", "macFormatInNonRequestURI", str), ) -class SortByAdminFirstName(OCIType): +class DeviceManagementDeviceTypeModifyOptions16(OCIType): """ - The sort criteria specifies the administrator first name as the column for the sort, - whether the sort is ascending or descending, and whether the sort is case sensitive. + Device Management System device type options during a modify request. Attributes: - is_ascending (bool): isAscending - is_case_sensitive (bool): isCaseSensitive + device_access_protocol (str): deviceAccessProtocol *Optional* + tag_mode (str): tagMode *Optional* + tag_set (str): tagSet *Optional* + allow_device_profile_custom_tag_set (bool): allowDeviceProfileCustomTagSet + *Optional* + allow_group_custom_tag_set (bool): allowGroupCustomTagSet *Optional* + allow_sp_custom_tag_set (bool): allowSpCustomTagSet *Optional* + send_email_upon_reset_failure (bool): sendEmailUponResetFailure *Optional* + device_access_net_address (str): deviceAccessNetAddress *Optional* + device_access_port (int): deviceAccessPort *Optional* + device_access_context (str): deviceAccessContext *Optional* + default_device_language (str): defaultDeviceLanguage *Optional* + default_device_encoding (str): defaultDeviceEncoding *Optional* + access_device_credentials (accessDeviceCredentials): accessDeviceCredentials + *Optional* + use_http_digest_authentication (bool): useHttpDigestAuthentication *Optional* + mac_based_file_authentication (bool): macBasedFileAuthentication *Optional* + user_name_password_file_authentication (bool): userNamePasswordFileAuthentication + *Optional* + mac_in_non_request_uri (bool): macInNonRequestURI *Optional* + mac_in_cert (bool): macInCert *Optional* + mac_format_in_non_request_uri (str): macFormatInNonRequestURI *Optional* """ __slots__: List[str] = [ - "is_ascending", - "is_case_sensitive", + "device_access_protocol", + "tag_mode", + "tag_set", + "allow_device_profile_custom_tag_set", + "allow_group_custom_tag_set", + "allow_sp_custom_tag_set", + "send_email_upon_reset_failure", + "device_access_net_address", + "device_access_port", + "device_access_context", + "default_device_language", + "default_device_encoding", + "access_device_credentials", + "use_http_digest_authentication", + "mac_based_file_authentication", + "user_name_password_file_authentication", + "mac_in_non_request_uri", + "mac_in_cert", + "mac_format_in_non_request_uri", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("is_ascending", "isAscending", bool, is_required=True), - E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), + E("device_access_protocol", "deviceAccessProtocol", str), + E("tag_mode", "tagMode", str), + E("tag_set", "tagSet", str), + E( + "allow_device_profile_custom_tag_set", + "allowDeviceProfileCustomTagSet", + bool, + ), + E("allow_group_custom_tag_set", "allowGroupCustomTagSet", bool), + E("allow_sp_custom_tag_set", "allowSpCustomTagSet", bool), + E("send_email_upon_reset_failure", "sendEmailUponResetFailure", bool), + E("device_access_net_address", "deviceAccessNetAddress", str), + E("device_access_port", "deviceAccessPort", int), + E("device_access_context", "deviceAccessContext", str), + E("default_device_language", "defaultDeviceLanguage", str), + E("default_device_encoding", "defaultDeviceEncoding", str), + E( + "access_device_credentials", + "accessDeviceCredentials", + DeviceManagementUserNamePassword16, + is_complex=True, + ), + E("use_http_digest_authentication", "useHttpDigestAuthentication", bool), + E("mac_based_file_authentication", "macBasedFileAuthentication", bool), + E( + "user_name_password_file_authentication", + "userNamePasswordFileAuthentication", + bool, + ), + E("mac_in_non_request_uri", "macInNonRequestURI", bool), + E("mac_in_cert", "macInCert", bool), + E("mac_format_in_non_request_uri", "macFormatInNonRequestURI", str), ) -class SortByAdminId(OCIType): +class DeviceManagementDeviceTypeModifyOptions22(OCIType): """ - The sort criteria specifies the administrator id as the column for the sort, whether - the sort is ascending or descending, and whether the sort is case sensitive. + Device Management System device type options during a modify request. + The following data elements are only used in AS data mode and ignored in XS data mode: + enableDeviceActivation deviceModel Attributes: - is_ascending (bool): isAscending - is_case_sensitive (bool): isCaseSensitive + device_access_protocol (str): deviceAccessProtocol *Optional* + tag_mode (str): tagMode *Optional* + tag_set (str): tagSet *Optional* + allow_device_profile_custom_tag_set (bool): allowDeviceProfileCustomTagSet + *Optional* + allow_group_custom_tag_set (bool): allowGroupCustomTagSet *Optional* + allow_sp_custom_tag_set (bool): allowSpCustomTagSet *Optional* + send_email_upon_reset_failure (bool): sendEmailUponResetFailure *Optional* + device_access_net_address (str): deviceAccessNetAddress *Optional* + device_access_port (int): deviceAccessPort *Optional* + device_access_context (str): deviceAccessContext *Optional* + default_device_language (str): defaultDeviceLanguage *Optional* + default_device_encoding (str): defaultDeviceEncoding *Optional* + access_device_credentials (accessDeviceCredentials): accessDeviceCredentials + *Optional* + use_http_digest_authentication (bool): useHttpDigestAuthentication *Optional* + mac_based_file_authentication (bool): macBasedFileAuthentication *Optional* + user_name_password_file_authentication (bool): userNamePasswordFileAuthentication + *Optional* + mac_in_non_request_uri (bool): macInNonRequestURI *Optional* + mac_in_cert (bool): macInCert *Optional* + mac_format_in_non_request_uri (str): macFormatInNonRequestURI *Optional* + enable_device_activation (bool): enableDeviceActivation *Optional* + device_model (str): deviceModel *Optional* """ __slots__: List[str] = [ - "is_ascending", - "is_case_sensitive", + "device_access_protocol", + "tag_mode", + "tag_set", + "allow_device_profile_custom_tag_set", + "allow_group_custom_tag_set", + "allow_sp_custom_tag_set", + "send_email_upon_reset_failure", + "device_access_net_address", + "device_access_port", + "device_access_context", + "default_device_language", + "default_device_encoding", + "access_device_credentials", + "use_http_digest_authentication", + "mac_based_file_authentication", + "user_name_password_file_authentication", + "mac_in_non_request_uri", + "mac_in_cert", + "mac_format_in_non_request_uri", + "enable_device_activation", + "device_model", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("is_ascending", "isAscending", bool, is_required=True), - E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), + E("device_access_protocol", "deviceAccessProtocol", str), + E("tag_mode", "tagMode", str), + E("tag_set", "tagSet", str), + E( + "allow_device_profile_custom_tag_set", + "allowDeviceProfileCustomTagSet", + bool, + ), + E("allow_group_custom_tag_set", "allowGroupCustomTagSet", bool), + E("allow_sp_custom_tag_set", "allowSpCustomTagSet", bool), + E("send_email_upon_reset_failure", "sendEmailUponResetFailure", bool), + E("device_access_net_address", "deviceAccessNetAddress", str), + E("device_access_port", "deviceAccessPort", int), + E("device_access_context", "deviceAccessContext", str), + E("default_device_language", "defaultDeviceLanguage", str), + E("default_device_encoding", "defaultDeviceEncoding", str), + E( + "access_device_credentials", + "accessDeviceCredentials", + DeviceManagementUserNamePassword16, + is_complex=True, + ), + E("use_http_digest_authentication", "useHttpDigestAuthentication", bool), + E("mac_based_file_authentication", "macBasedFileAuthentication", bool), + E( + "user_name_password_file_authentication", + "userNamePasswordFileAuthentication", + bool, + ), + E("mac_in_non_request_uri", "macInNonRequestURI", bool), + E("mac_in_cert", "macInCert", bool), + E("mac_format_in_non_request_uri", "macFormatInNonRequestURI", str), + E("enable_device_activation", "enableDeviceActivation", bool), + E("device_model", "deviceModel", str), ) -class SortByAdminLastName(OCIType): +class DeviceManagementDeviceTypeOptions(OCIType): """ - The sort criteria specifies the administrator last name as the column for the sort, - whether the sort is ascending or descending, and whether the sort is case sensitive. + Device Management System device type options. Attributes: - is_ascending (bool): isAscending - is_case_sensitive (bool): isCaseSensitive + device_access_protocol (str): deviceAccessProtocol + tag_mode (str): tagMode + tag_set (str): tagSet *Optional* + allow_device_profile_custom_tag_set (bool): allowDeviceProfileCustomTagSet + allow_group_custom_tag_set (bool): allowGroupCustomTagSet + send_email_upon_reset_failure (bool): sendEmailUponResetFailure + device_access_net_address (str): deviceAccessNetAddress *Optional* + device_access_port (int): deviceAccessPort *Optional* + device_access_context (str): deviceAccessContext *Optional* + device_access_uri (str): deviceAccessURI *Optional* + default_device_language (str): defaultDeviceLanguage *Optional* + default_device_encoding (str): defaultDeviceEncoding *Optional* + access_device_credentials (accessDeviceCredentials): accessDeviceCredentials + *Optional* + use_http_digest_authentication (bool): useHttpDigestAuthentication + mac_based_file_authentication (bool): macBasedFileAuthentication + user_name_password_file_authentication (bool): userNamePasswordFileAuthentication + mac_in_non_request_uri (bool): macInNonRequestURI + mac_format_in_non_request_uri (str): macFormatInNonRequestURI *Optional* """ __slots__: List[str] = [ - "is_ascending", - "is_case_sensitive", + "device_access_protocol", + "tag_mode", + "tag_set", + "allow_device_profile_custom_tag_set", + "allow_group_custom_tag_set", + "send_email_upon_reset_failure", + "device_access_net_address", + "device_access_port", + "device_access_context", + "device_access_uri", + "default_device_language", + "default_device_encoding", + "access_device_credentials", + "use_http_digest_authentication", + "mac_based_file_authentication", + "user_name_password_file_authentication", + "mac_in_non_request_uri", + "mac_format_in_non_request_uri", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("is_ascending", "isAscending", bool, is_required=True), - E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), + E("device_access_protocol", "deviceAccessProtocol", str, is_required=True), + E("tag_mode", "tagMode", str, is_required=True), + E("tag_set", "tagSet", str), + E( + "allow_device_profile_custom_tag_set", + "allowDeviceProfileCustomTagSet", + bool, + is_required=True, + ), + E( + "allow_group_custom_tag_set", + "allowGroupCustomTagSet", + bool, + is_required=True, + ), + E( + "send_email_upon_reset_failure", + "sendEmailUponResetFailure", + bool, + is_required=True, + ), + E("device_access_net_address", "deviceAccessNetAddress", str), + E("device_access_port", "deviceAccessPort", int), + E("device_access_context", "deviceAccessContext", str), + E("device_access_uri", "deviceAccessURI", str), + E("default_device_language", "defaultDeviceLanguage", str), + E("default_device_encoding", "defaultDeviceEncoding", str), + E( + "access_device_credentials", + "accessDeviceCredentials", + DeviceManagementUserNamePassword, + is_complex=True, + ), + E( + "use_http_digest_authentication", + "useHttpDigestAuthentication", + bool, + is_required=True, + ), + E( + "mac_based_file_authentication", + "macBasedFileAuthentication", + bool, + is_required=True, + ), + E( + "user_name_password_file_authentication", + "userNamePasswordFileAuthentication", + bool, + is_required=True, + ), + E("mac_in_non_request_uri", "macInNonRequestURI", bool, is_required=True), + E("mac_format_in_non_request_uri", "macFormatInNonRequestURI", str), ) -class SortByAgentThresholdProfile(OCIType): +class DeviceManagementDeviceTypeOptions16(OCIType): """ - The sort criteria specifies the call center agent threshold profile as the column for - the sort, whether the sort is ascending or descending, and whether the sort is case - sensitive. + Device Management System device type options. Attributes: - is_ascending (bool): isAscending - is_case_sensitive (bool): isCaseSensitive + device_access_protocol (str): deviceAccessProtocol + tag_mode (str): tagMode + tag_set (str): tagSet *Optional* + allow_device_profile_custom_tag_set (bool): allowDeviceProfileCustomTagSet + allow_group_custom_tag_set (bool): allowGroupCustomTagSet + send_email_upon_reset_failure (bool): sendEmailUponResetFailure + device_access_net_address (str): deviceAccessNetAddress *Optional* + device_access_port (int): deviceAccessPort *Optional* + device_access_context (str): deviceAccessContext *Optional* + device_access_uri (str): deviceAccessURI *Optional* + default_device_language (str): defaultDeviceLanguage *Optional* + default_device_encoding (str): defaultDeviceEncoding *Optional* + access_device_credentials (accessDeviceCredentials): accessDeviceCredentials + *Optional* + use_http_digest_authentication (bool): useHttpDigestAuthentication + mac_based_file_authentication (bool): macBasedFileAuthentication + user_name_password_file_authentication (bool): userNamePasswordFileAuthentication + mac_in_non_request_uri (bool): macInNonRequestURI + mac_format_in_non_request_uri (str): macFormatInNonRequestURI *Optional* """ __slots__: List[str] = [ - "is_ascending", - "is_case_sensitive", + "device_access_protocol", + "tag_mode", + "tag_set", + "allow_device_profile_custom_tag_set", + "allow_group_custom_tag_set", + "send_email_upon_reset_failure", + "device_access_net_address", + "device_access_port", + "device_access_context", + "device_access_uri", + "default_device_language", + "default_device_encoding", + "access_device_credentials", + "use_http_digest_authentication", + "mac_based_file_authentication", + "user_name_password_file_authentication", + "mac_in_non_request_uri", + "mac_format_in_non_request_uri", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("is_ascending", "isAscending", bool, is_required=True), - E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), + E("device_access_protocol", "deviceAccessProtocol", str, is_required=True), + E("tag_mode", "tagMode", str, is_required=True), + E("tag_set", "tagSet", str), + E( + "allow_device_profile_custom_tag_set", + "allowDeviceProfileCustomTagSet", + bool, + is_required=True, + ), + E( + "allow_group_custom_tag_set", + "allowGroupCustomTagSet", + bool, + is_required=True, + ), + E( + "send_email_upon_reset_failure", + "sendEmailUponResetFailure", + bool, + is_required=True, + ), + E("device_access_net_address", "deviceAccessNetAddress", str), + E("device_access_port", "deviceAccessPort", int), + E("device_access_context", "deviceAccessContext", str), + E("device_access_uri", "deviceAccessURI", str), + E("default_device_language", "defaultDeviceLanguage", str), + E("default_device_encoding", "defaultDeviceEncoding", str), + E( + "access_device_credentials", + "accessDeviceCredentials", + DeviceManagementUserNamePassword16, + is_complex=True, + ), + E( + "use_http_digest_authentication", + "useHttpDigestAuthentication", + bool, + is_required=True, + ), + E( + "mac_based_file_authentication", + "macBasedFileAuthentication", + bool, + is_required=True, + ), + E( + "user_name_password_file_authentication", + "userNamePasswordFileAuthentication", + bool, + is_required=True, + ), + E("mac_in_non_request_uri", "macInNonRequestURI", bool, is_required=True), + E("mac_format_in_non_request_uri", "macFormatInNonRequestURI", str), ) -class SortByAnnouncementFileName(OCIType): +class DeviceManagementDeviceTypeOptions21sp1(OCIType): """ - The sort criteria specifies the file name as the column for the sort, whether the sort - is ascending or descending, and whether the sort is case sensitive. + Device Management System device type options. + Note: For the elements listed below, when device configuration is set to + deviceManagement, those elements apply to the creation of the Polycom Phone Services + directory file only. For all other files, they are not used. Those elements are + instead configured on a per-file basis at the Device Type File level. When device + configuration is set to legacy, those elements apply to all configuration files. + useHttpDigestAuthentication macBasedFileAuthentication + userNamePasswordFileAuthentication macInNonRequestURI macInCert + macFormatInNonRequestURI Attributes: - is_ascending (bool): isAscending - is_case_sensitive (bool): isCaseSensitive - """ - - __slots__: List[str] = [ - "is_ascending", - "is_case_sensitive", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("is_ascending", "isAscending", bool, is_required=True), - E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), - ) - - -class SortByAnnouncementFileSize(OCIType): - """ - The sort criteria specifies the file size as the column for the sort, whether the sort - is ascending or descending, and whether the sort is case sensitive. - - - Attributes: - is_ascending (bool): isAscending - """ - - __slots__: List[str] = [ - "is_ascending", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return (E("is_ascending", "isAscending", bool, is_required=True),) - - -class SortByCallCenterName(OCIType): - """ - The sort criteria specifies the call center name as the column for the sort, whether - the sort is ascending or descending, and whether the sort is case sensitive. - - - Attributes: - is_ascending (bool): isAscending - is_case_sensitive (bool): isCaseSensitive + device_access_protocol (str): deviceAccessProtocol + tag_mode (str): tagMode + tag_set (str): tagSet *Optional* + allow_device_profile_custom_tag_set (bool): allowDeviceProfileCustomTagSet + allow_group_custom_tag_set (bool): allowGroupCustomTagSet + send_email_upon_reset_failure (bool): sendEmailUponResetFailure + device_access_net_address (str): deviceAccessNetAddress *Optional* + device_access_port (int): deviceAccessPort *Optional* + device_access_context (str): deviceAccessContext *Optional* + device_access_uri (str): deviceAccessURI *Optional* + default_device_language (str): defaultDeviceLanguage *Optional* + default_device_encoding (str): defaultDeviceEncoding *Optional* + access_device_credentials (accessDeviceCredentials): accessDeviceCredentials + *Optional* + use_http_digest_authentication (bool): useHttpDigestAuthentication + mac_based_file_authentication (bool): macBasedFileAuthentication + user_name_password_file_authentication (bool): userNamePasswordFileAuthentication + mac_in_non_request_uri (bool): macInNonRequestURI + mac_in_cert (bool): macInCert + mac_format_in_non_request_uri (str): macFormatInNonRequestURI *Optional* """ __slots__: List[str] = [ - "is_ascending", - "is_case_sensitive", + "device_access_protocol", + "tag_mode", + "tag_set", + "allow_device_profile_custom_tag_set", + "allow_group_custom_tag_set", + "send_email_upon_reset_failure", + "device_access_net_address", + "device_access_port", + "device_access_context", + "device_access_uri", + "default_device_language", + "default_device_encoding", + "access_device_credentials", + "use_http_digest_authentication", + "mac_based_file_authentication", + "user_name_password_file_authentication", + "mac_in_non_request_uri", + "mac_in_cert", + "mac_format_in_non_request_uri", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("is_ascending", "isAscending", bool, is_required=True), - E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), + E("device_access_protocol", "deviceAccessProtocol", str, is_required=True), + E("tag_mode", "tagMode", str, is_required=True), + E("tag_set", "tagSet", str), + E( + "allow_device_profile_custom_tag_set", + "allowDeviceProfileCustomTagSet", + bool, + is_required=True, + ), + E( + "allow_group_custom_tag_set", + "allowGroupCustomTagSet", + bool, + is_required=True, + ), + E( + "send_email_upon_reset_failure", + "sendEmailUponResetFailure", + bool, + is_required=True, + ), + E("device_access_net_address", "deviceAccessNetAddress", str), + E("device_access_port", "deviceAccessPort", int), + E("device_access_context", "deviceAccessContext", str), + E("device_access_uri", "deviceAccessURI", str), + E("default_device_language", "defaultDeviceLanguage", str), + E("default_device_encoding", "defaultDeviceEncoding", str), + E( + "access_device_credentials", + "accessDeviceCredentials", + DeviceManagementUserNamePassword16, + is_complex=True, + ), + E( + "use_http_digest_authentication", + "useHttpDigestAuthentication", + bool, + is_required=True, + ), + E( + "mac_based_file_authentication", + "macBasedFileAuthentication", + bool, + is_required=True, + ), + E( + "user_name_password_file_authentication", + "userNamePasswordFileAuthentication", + bool, + is_required=True, + ), + E("mac_in_non_request_uri", "macInNonRequestURI", bool, is_required=True), + E("mac_in_cert", "macInCert", bool, is_required=True), + E("mac_format_in_non_request_uri", "macFormatInNonRequestURI", str), ) -class SortByCallCenterType(OCIType): +class DeviceManagementDeviceTypeOptions22(OCIType): """ - The sort criteria specifies the call center type as the column for the sort, whether - the sort is ascending or descending, and whether the sort is case sensitive. + Device Management System device type options. + Note: For the elements listed below, when device configuration is set to + deviceManagement, those elements apply to the creation of the Polycom Phone Services + directory file only. For all other files, they are not used. Those elements are + instead configured on a per-file basis at the Device Type File level. When device + configuration is set to legacy, those elements apply to all configuration files. + useHttpDigestAuthentication macBasedFileAuthentication + userNamePasswordFileAuthentication macInNonRequestURI macInCert + macFormatInNonRequestURI Attributes: - is_ascending (bool): isAscending - is_case_sensitive (bool): isCaseSensitive + device_access_protocol (str): deviceAccessProtocol + tag_mode (str): tagMode + tag_set (str): tagSet *Optional* + allow_device_profile_custom_tag_set (bool): allowDeviceProfileCustomTagSet + allow_group_custom_tag_set (bool): allowGroupCustomTagSet + allow_sp_custom_tag_set (bool): allowSpCustomTagSet + send_email_upon_reset_failure (bool): sendEmailUponResetFailure + device_access_net_address (str): deviceAccessNetAddress *Optional* + device_access_port (int): deviceAccessPort *Optional* + device_access_context (str): deviceAccessContext *Optional* + device_access_uri (str): deviceAccessURI *Optional* + default_device_language (str): defaultDeviceLanguage *Optional* + default_device_encoding (str): defaultDeviceEncoding *Optional* + access_device_credentials (accessDeviceCredentials): accessDeviceCredentials + *Optional* + use_http_digest_authentication (bool): useHttpDigestAuthentication + mac_based_file_authentication (bool): macBasedFileAuthentication + user_name_password_file_authentication (bool): userNamePasswordFileAuthentication + mac_in_non_request_uri (bool): macInNonRequestURI + mac_in_cert (bool): macInCert + mac_format_in_non_request_uri (str): macFormatInNonRequestURI *Optional* """ __slots__: List[str] = [ - "is_ascending", - "is_case_sensitive", + "device_access_protocol", + "tag_mode", + "tag_set", + "allow_device_profile_custom_tag_set", + "allow_group_custom_tag_set", + "allow_sp_custom_tag_set", + "send_email_upon_reset_failure", + "device_access_net_address", + "device_access_port", + "device_access_context", + "device_access_uri", + "default_device_language", + "default_device_encoding", + "access_device_credentials", + "use_http_digest_authentication", + "mac_based_file_authentication", + "user_name_password_file_authentication", + "mac_in_non_request_uri", + "mac_in_cert", + "mac_format_in_non_request_uri", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("is_ascending", "isAscending", bool, is_required=True), - E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), + E("device_access_protocol", "deviceAccessProtocol", str, is_required=True), + E("tag_mode", "tagMode", str, is_required=True), + E("tag_set", "tagSet", str), + E( + "allow_device_profile_custom_tag_set", + "allowDeviceProfileCustomTagSet", + bool, + is_required=True, + ), + E( + "allow_group_custom_tag_set", + "allowGroupCustomTagSet", + bool, + is_required=True, + ), + E("allow_sp_custom_tag_set", "allowSpCustomTagSet", bool, is_required=True), + E( + "send_email_upon_reset_failure", + "sendEmailUponResetFailure", + bool, + is_required=True, + ), + E("device_access_net_address", "deviceAccessNetAddress", str), + E("device_access_port", "deviceAccessPort", int), + E("device_access_context", "deviceAccessContext", str), + E("device_access_uri", "deviceAccessURI", str), + E("default_device_language", "defaultDeviceLanguage", str), + E("default_device_encoding", "defaultDeviceEncoding", str), + E( + "access_device_credentials", + "accessDeviceCredentials", + DeviceManagementUserNamePassword16, + is_complex=True, + ), + E( + "use_http_digest_authentication", + "useHttpDigestAuthentication", + bool, + is_required=True, + ), + E( + "mac_based_file_authentication", + "macBasedFileAuthentication", + bool, + is_required=True, + ), + E( + "user_name_password_file_authentication", + "userNamePasswordFileAuthentication", + bool, + is_required=True, + ), + E("mac_in_non_request_uri", "macInNonRequestURI", bool, is_required=True), + E("mac_in_cert", "macInCert", bool, is_required=True), + E("mac_format_in_non_request_uri", "macFormatInNonRequestURI", str), ) -class SortByCallParkName(OCIType): +class DeviceManagementDeviceTypeOptions22V2(OCIType): """ - The sort criteria specifies the call park name as the column for the sort, whether the - sort is ascending or descending, and whether the sort is case sensitive. + Device Management System device type options. + Note: For the elements listed below, when device configuration is set to + deviceManagement, those elements apply to the creation of the Polycom Phone Services + directory file only. For all other files, they are not used. Those elements are + instead configured on a per-file basis at the Device Type File level. When device + configuration is set to legacy, those elements apply to all configuration files. + useHttpDigestAuthentication macBasedFileAuthentication + userNamePasswordFileAuthentication macInNonRequestURI macInCert + macFormatInNonRequestURI Attributes: - is_ascending (bool): isAscending - is_case_sensitive (bool): isCaseSensitive + device_access_protocol (str): deviceAccessProtocol + tag_mode (str): tagMode + tag_set (str): tagSet *Optional* + allow_device_profile_custom_tag_set (bool): allowDeviceProfileCustomTagSet + allow_group_custom_tag_set (bool): allowGroupCustomTagSet + allow_sp_custom_tag_set (bool): allowSpCustomTagSet + send_email_upon_reset_failure (bool): sendEmailUponResetFailure + device_access_net_address (str): deviceAccessNetAddress *Optional* + device_access_port (int): deviceAccessPort *Optional* + device_access_context (str): deviceAccessContext *Optional* + device_access_uri (str): deviceAccessURI *Optional* + default_device_language (str): defaultDeviceLanguage *Optional* + default_device_encoding (str): defaultDeviceEncoding *Optional* + access_device_credentials (accessDeviceCredentials): accessDeviceCredentials + *Optional* + use_http_digest_authentication (bool): useHttpDigestAuthentication + mac_based_file_authentication (bool): macBasedFileAuthentication + user_name_password_file_authentication (bool): userNamePasswordFileAuthentication + mac_in_non_request_uri (bool): macInNonRequestURI + mac_in_cert (bool): macInCert + mac_format_in_non_request_uri (str): macFormatInNonRequestURI *Optional* """ __slots__: List[str] = [ - "is_ascending", - "is_case_sensitive", + "device_access_protocol", + "tag_mode", + "tag_set", + "allow_device_profile_custom_tag_set", + "allow_group_custom_tag_set", + "allow_sp_custom_tag_set", + "send_email_upon_reset_failure", + "device_access_net_address", + "device_access_port", + "device_access_context", + "device_access_uri", + "default_device_language", + "default_device_encoding", + "access_device_credentials", + "use_http_digest_authentication", + "mac_based_file_authentication", + "user_name_password_file_authentication", + "mac_in_non_request_uri", + "mac_in_cert", + "mac_format_in_non_request_uri", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("is_ascending", "isAscending", bool, is_required=True), - E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), + E("device_access_protocol", "deviceAccessProtocol", str, is_required=True), + E("tag_mode", "tagMode", str, is_required=True), + E("tag_set", "tagSet", str), + E( + "allow_device_profile_custom_tag_set", + "allowDeviceProfileCustomTagSet", + bool, + is_required=True, + ), + E( + "allow_group_custom_tag_set", + "allowGroupCustomTagSet", + bool, + is_required=True, + ), + E("allow_sp_custom_tag_set", "allowSpCustomTagSet", bool, is_required=True), + E( + "send_email_upon_reset_failure", + "sendEmailUponResetFailure", + bool, + is_required=True, + ), + E("device_access_net_address", "deviceAccessNetAddress", str), + E("device_access_port", "deviceAccessPort", int), + E("device_access_context", "deviceAccessContext", str), + E("device_access_uri", "deviceAccessURI", str), + E("default_device_language", "defaultDeviceLanguage", str), + E("default_device_encoding", "defaultDeviceEncoding", str), + E( + "access_device_credentials", + "accessDeviceCredentials", + DeviceManagementUserNamePassword16, + is_complex=True, + ), + E( + "use_http_digest_authentication", + "useHttpDigestAuthentication", + bool, + is_required=True, + ), + E( + "mac_based_file_authentication", + "macBasedFileAuthentication", + bool, + is_required=True, + ), + E( + "user_name_password_file_authentication", + "userNamePasswordFileAuthentication", + bool, + is_required=True, + ), + E("mac_in_non_request_uri", "macInNonRequestURI", bool, is_required=True), + E("mac_in_cert", "macInCert", bool, is_required=True), + E("mac_format_in_non_request_uri", "macFormatInNonRequestURI", str), ) -class SortByCallPickupName(OCIType): +class DeviceManagementDeviceTypeOptions22V3(OCIType): """ - The sort criteria specifies the call pickup name as the column for the sort, whether - the sort is ascending or descending, and whether the sort is case sensitive. + Device Management System device type options. + Note: For the elements listed below, when device configuration is set to + deviceManagement, those elements apply to the creation of the Polycom Phone Services + directory file only. For all other files, they are not used. Those elements are + instead configured on a per-file basis at the Device Type File level. When device + configuration is set to legacy, those elements apply to all configuration files. + useHttpDigestAuthentication macBasedFileAuthentication + userNamePasswordFileAuthentication macInNonRequestURI macInCert + macFormatInNonRequestURI The following data elements are only used in AS data mode and + ignored in XS data mode: enableDeviceActivation deviceModel Attributes: - is_ascending (bool): isAscending - is_case_sensitive (bool): isCaseSensitive + device_access_protocol (str): deviceAccessProtocol + tag_mode (str): tagMode + tag_set (str): tagSet *Optional* + allow_device_profile_custom_tag_set (bool): allowDeviceProfileCustomTagSet + allow_group_custom_tag_set (bool): allowGroupCustomTagSet + allow_sp_custom_tag_set (bool): allowSpCustomTagSet + send_email_upon_reset_failure (bool): sendEmailUponResetFailure + device_access_net_address (str): deviceAccessNetAddress *Optional* + device_access_port (int): deviceAccessPort *Optional* + device_access_context (str): deviceAccessContext *Optional* + device_access_uri (str): deviceAccessURI *Optional* + default_device_language (str): defaultDeviceLanguage *Optional* + default_device_encoding (str): defaultDeviceEncoding *Optional* + access_device_credentials (accessDeviceCredentials): accessDeviceCredentials + *Optional* + use_http_digest_authentication (bool): useHttpDigestAuthentication + mac_based_file_authentication (bool): macBasedFileAuthentication + user_name_password_file_authentication (bool): userNamePasswordFileAuthentication + mac_in_non_request_uri (bool): macInNonRequestURI + mac_in_cert (bool): macInCert + mac_format_in_non_request_uri (str): macFormatInNonRequestURI *Optional* + enable_device_activation (bool): enableDeviceActivation + device_model (str): deviceModel *Optional* """ __slots__: List[str] = [ - "is_ascending", - "is_case_sensitive", + "device_access_protocol", + "tag_mode", + "tag_set", + "allow_device_profile_custom_tag_set", + "allow_group_custom_tag_set", + "allow_sp_custom_tag_set", + "send_email_upon_reset_failure", + "device_access_net_address", + "device_access_port", + "device_access_context", + "device_access_uri", + "default_device_language", + "default_device_encoding", + "access_device_credentials", + "use_http_digest_authentication", + "mac_based_file_authentication", + "user_name_password_file_authentication", + "mac_in_non_request_uri", + "mac_in_cert", + "mac_format_in_non_request_uri", + "enable_device_activation", + "device_model", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("is_ascending", "isAscending", bool, is_required=True), - E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), + E("device_access_protocol", "deviceAccessProtocol", str, is_required=True), + E("tag_mode", "tagMode", str, is_required=True), + E("tag_set", "tagSet", str), + E( + "allow_device_profile_custom_tag_set", + "allowDeviceProfileCustomTagSet", + bool, + is_required=True, + ), + E( + "allow_group_custom_tag_set", + "allowGroupCustomTagSet", + bool, + is_required=True, + ), + E("allow_sp_custom_tag_set", "allowSpCustomTagSet", bool, is_required=True), + E( + "send_email_upon_reset_failure", + "sendEmailUponResetFailure", + bool, + is_required=True, + ), + E("device_access_net_address", "deviceAccessNetAddress", str), + E("device_access_port", "deviceAccessPort", int), + E("device_access_context", "deviceAccessContext", str), + E("device_access_uri", "deviceAccessURI", str), + E("default_device_language", "defaultDeviceLanguage", str), + E("default_device_encoding", "defaultDeviceEncoding", str), + E( + "access_device_credentials", + "accessDeviceCredentials", + DeviceManagementUserNamePassword16, + is_complex=True, + ), + E( + "use_http_digest_authentication", + "useHttpDigestAuthentication", + bool, + is_required=True, + ), + E( + "mac_based_file_authentication", + "macBasedFileAuthentication", + bool, + is_required=True, + ), + E( + "user_name_password_file_authentication", + "userNamePasswordFileAuthentication", + bool, + is_required=True, + ), + E("mac_in_non_request_uri", "macInNonRequestURI", bool, is_required=True), + E("mac_in_cert", "macInCert", bool, is_required=True), + E("mac_format_in_non_request_uri", "macFormatInNonRequestURI", str), + E( + "enable_device_activation", + "enableDeviceActivation", + bool, + is_required=True, + ), + E("device_model", "deviceModel", str), ) -class SortByDepartmentName(OCIType): +class DeviceManagementDeviceTypeOptions22V4(OCIType): """ - The sort criteria specifies the department name as the column for the sort, whether - the sort is ascending or descending, and whether the sort is case sensitive. + Device Management System device type options. + Note: For the elements listed below, when device configuration is set to + deviceManagement, those elements apply to the creation of the Polycom Phone Services + directory file only. For all other files, they are not used. Those elements are + instead configured on a per-file basis at the Device Type File level. When device + configuration is set to legacy, those elements apply to all configuration files. + useHttpDigestAuthentication macBasedFileAuthentication + userNamePasswordFileAuthentication macInNonRequestURI macInCert + macFormatInNonRequestURI The following data elements are only used in AS data mode and + ignored in XS data mode: enableDeviceActivation deviceModel supportLinks Attributes: - is_ascending (bool): isAscending - is_case_sensitive (bool): isCaseSensitive + device_access_protocol (str): deviceAccessProtocol + tag_mode (str): tagMode + tag_set (str): tagSet *Optional* + allow_device_profile_custom_tag_set (bool): allowDeviceProfileCustomTagSet + allow_group_custom_tag_set (bool): allowGroupCustomTagSet + allow_sp_custom_tag_set (bool): allowSpCustomTagSet + send_email_upon_reset_failure (bool): sendEmailUponResetFailure + device_access_net_address (str): deviceAccessNetAddress *Optional* + device_access_port (int): deviceAccessPort *Optional* + device_access_context (str): deviceAccessContext *Optional* + device_access_uri (str): deviceAccessURI *Optional* + default_device_language (str): defaultDeviceLanguage *Optional* + default_device_encoding (str): defaultDeviceEncoding *Optional* + access_device_credentials (accessDeviceCredentials): accessDeviceCredentials + *Optional* + use_http_digest_authentication (bool): useHttpDigestAuthentication + mac_based_file_authentication (bool): macBasedFileAuthentication + user_name_password_file_authentication (bool): userNamePasswordFileAuthentication + mac_in_non_request_uri (bool): macInNonRequestURI + mac_in_cert (bool): macInCert + mac_format_in_non_request_uri (str): macFormatInNonRequestURI *Optional* + enable_device_activation (bool): enableDeviceActivation + device_model (str): deviceModel *Optional* + support_links (str): supportLinks """ __slots__: List[str] = [ - "is_ascending", - "is_case_sensitive", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("is_ascending", "isAscending", bool, is_required=True), - E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), - ) - - -class SortByDeviceMACAddress(OCIType): - """ - The sort criteria specifies the device MAC address as the column for the sort, whether - the sort is ascending or descending, and whether the sort is case sensitive. - - - Attributes: - is_ascending (bool): isAscending - is_case_sensitive (bool): isCaseSensitive - """ - - __slots__: List[str] = [ - "is_ascending", - "is_case_sensitive", + "device_access_protocol", + "tag_mode", + "tag_set", + "allow_device_profile_custom_tag_set", + "allow_group_custom_tag_set", + "allow_sp_custom_tag_set", + "send_email_upon_reset_failure", + "device_access_net_address", + "device_access_port", + "device_access_context", + "device_access_uri", + "default_device_language", + "default_device_encoding", + "access_device_credentials", + "use_http_digest_authentication", + "mac_based_file_authentication", + "user_name_password_file_authentication", + "mac_in_non_request_uri", + "mac_in_cert", + "mac_format_in_non_request_uri", + "enable_device_activation", + "device_model", + "support_links", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("is_ascending", "isAscending", bool, is_required=True), - E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), + E("device_access_protocol", "deviceAccessProtocol", str, is_required=True), + E("tag_mode", "tagMode", str, is_required=True), + E("tag_set", "tagSet", str), + E( + "allow_device_profile_custom_tag_set", + "allowDeviceProfileCustomTagSet", + bool, + is_required=True, + ), + E( + "allow_group_custom_tag_set", + "allowGroupCustomTagSet", + bool, + is_required=True, + ), + E("allow_sp_custom_tag_set", "allowSpCustomTagSet", bool, is_required=True), + E( + "send_email_upon_reset_failure", + "sendEmailUponResetFailure", + bool, + is_required=True, + ), + E("device_access_net_address", "deviceAccessNetAddress", str), + E("device_access_port", "deviceAccessPort", int), + E("device_access_context", "deviceAccessContext", str), + E("device_access_uri", "deviceAccessURI", str), + E("default_device_language", "defaultDeviceLanguage", str), + E("default_device_encoding", "defaultDeviceEncoding", str), + E( + "access_device_credentials", + "accessDeviceCredentials", + DeviceManagementUserNamePassword16, + is_complex=True, + ), + E( + "use_http_digest_authentication", + "useHttpDigestAuthentication", + bool, + is_required=True, + ), + E( + "mac_based_file_authentication", + "macBasedFileAuthentication", + bool, + is_required=True, + ), + E( + "user_name_password_file_authentication", + "userNamePasswordFileAuthentication", + bool, + is_required=True, + ), + E("mac_in_non_request_uri", "macInNonRequestURI", bool, is_required=True), + E("mac_in_cert", "macInCert", bool, is_required=True), + E("mac_format_in_non_request_uri", "macFormatInNonRequestURI", str), + E( + "enable_device_activation", + "enableDeviceActivation", + bool, + is_required=True, + ), + E("device_model", "deviceModel", str), + E("support_links", "supportLinks", str, is_required=True), ) -class SortByDeviceName(OCIType): +class EnterpriseAccessDevice(OCIType): """ - The sort criteria specifies the device name as the column for the sort, whether the - sort is ascending or descending, and whether the sort is case sensitive. + Uniquely identifies an access device accessible for an enterprise. + It could be a system level device, an enterprise level device or a group level device. Attributes: - is_ascending (bool): isAscending - is_case_sensitive (bool): isCaseSensitive + access_device (accessDevice): accessDevice + group_id (str): groupId *Optional* """ __slots__: List[str] = [ - "is_ascending", - "is_case_sensitive", + "access_device", + "group_id", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("is_ascending", "isAscending", bool, is_required=True), - E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), + E( + "access_device", + "accessDevice", + AccessDevice, + is_complex=True, + is_required=True, + ), + E("group_id", "groupId", str), ) -class SortByDeviceNetAddress(OCIType): +class EnterpriseDepartmentKey(DepartmentKey): """ - The sort criteria specifies the device net address as the column for the sort, whether - the sort is ascending or descending, and whether the sort is case sensitive. + Uniquely identifies a department defined within an enterprise. + To uniquely identify an enterprise department, we must know the department name and + which enterprise contains the department. Attributes: - is_ascending (bool): isAscending - is_case_sensitive (bool): isCaseSensitive + service_provider_id (str): serviceProviderId + name (str): name """ __slots__: List[str] = [ - "is_ascending", - "is_case_sensitive", + "service_provider_id", + "name", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("is_ascending", "isAscending", bool, is_required=True), - E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), + E("service_provider_id", "serviceProviderId", str, is_required=True), + E("name", "name", str, is_required=True), ) -class SortByDeviceType(OCIType): +class EnterpriseEnterpriseTrunkPriorityWeightedTrunkGroup(OCIType): """ - The sort criteria specifies the device type as the column for the sort, whether the - sort is ascending or descending, and whether the sort is case sensitive. - + Trunk group details (order and weight) for each trunk group Attributes: - is_ascending (bool): isAscending - is_case_sensitive (bool): isCaseSensitive + trunk_group (trunkGroup): trunkGroup + priority (int): priority + weight (int): weight """ __slots__: List[str] = [ - "is_ascending", - "is_case_sensitive", + "trunk_group", + "priority", + "weight", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("is_ascending", "isAscending", bool, is_required=True), - E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), + E( + "trunk_group", + "trunkGroup", + EnterpriseTrunkTrunkGroupKey, + is_complex=True, + is_required=True, + ), + E("priority", "priority", int, is_required=True), + E("weight", "weight", int, is_required=True), ) -class SortByDn(OCIType): +class EnterpriseTrunkNumberPrefix22(OCIType): """ - The sort criteria specifies the DN as the column for the sort, whether the sort is - ascending or descending, and whether the sort is case sensitive. - + Enterprise Trunk Number Prefix Attributes: - is_ascending (bool): isAscending - is_case_sensitive (bool): isCaseSensitive + number_prefix (str): numberPrefix + extension_range (extensionRange): extensionRange *Optional* """ __slots__: List[str] = [ - "is_ascending", - "is_case_sensitive", + "number_prefix", + "extension_range", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("is_ascending", "isAscending", bool, is_required=True), - E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), + E("number_prefix", "numberPrefix", str, is_required=True), + E("extension_range", "extensionRange", ExtensionRange17, is_complex=True), ) -class SortByDnActivated(OCIType): +class EnterpriseTrunkNumberPrefixModify(OCIType): """ - The sort criteria specifies the dn activation status as the column for the sort, - whether the sort is ascending or descending, and whether the sort is case sensitive. + Enterprise Trunk Number Prefix for modify. Attributes: - is_ascending (bool): isAscending - is_case_sensitive (bool): isCaseSensitive + number_prefix (str): numberPrefix + extension_range (extensionRange): extensionRange *Optional* """ __slots__: List[str] = [ - "is_ascending", - "is_case_sensitive", + "number_prefix", + "extension_range", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("is_ascending", "isAscending", bool, is_required=True), - E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), + E("number_prefix", "numberPrefix", str, is_required=True), + E("extension_range", "extensionRange", ExtensionRange17, is_complex=True), ) -class SortByDnAvailable(OCIType): +class EnterpriseTrunkNumberRange(OCIType): """ - The sort criteria specifies the dn availability as the column for the sort, whether - the sort is ascending or descending, and whether the sort is case sensitive. + Directory number range. + The minimum and maximum values are inclusive. Attributes: - is_ascending (bool): isAscending - is_case_sensitive (bool): isCaseSensitive + dn_range (dnRange): dnRange + extension_length (int): extensionLength *Optional* """ __slots__: List[str] = [ - "is_ascending", - "is_case_sensitive", + "dn_range", + "extension_length", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("is_ascending", "isAscending", bool, is_required=True), - E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), + E("dn_range", "dnRange", DNRange, is_complex=True, is_required=True), + E("extension_length", "extensionLength", int), ) -class SortByEmailAddress(OCIType): +class EnterpriseTrunkPriorityWeightedTrunkGroup(OCIType): """ - The sort criteria specifies the email as the column for the sort, whether the sort is - ascending or descending, and whether the sort is case sensitive. - + Trunk group details (order and weight) for each trunk group Attributes: - is_ascending (bool): isAscending - is_case_sensitive (bool): isCaseSensitive + trunk_group (trunkGroup): trunkGroup + priority (int): priority + weight (int): weight """ __slots__: List[str] = [ - "is_ascending", - "is_case_sensitive", + "trunk_group", + "priority", + "weight", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("is_ascending", "isAscending", bool, is_required=True), - E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), + E( + "trunk_group", + "trunkGroup", + EnterpriseTrunkTrunkGroupKey, + is_complex=True, + is_required=True, + ), + E("priority", "priority", int, is_required=True), + E("weight", "weight", int, is_required=True), ) -class SortByEnabled(OCIType): +class EnterpriseVoiceVPNDigitManipulationNoValue(EnterpriseVoiceVPNDigitManipulation): """ - The sort criteria specifies the Broadworks Enabled Flag as the column for the sort, - whether the sort is ascending or descending, and whether the sort is case sensitive. + Enterprise Voice VPN Digit Manipulation Entry that has no value. Attributes: - is_ascending (bool): isAscending - is_case_sensitive (bool): isCaseSensitive + operation (str): operation """ __slots__: List[str] = [ - "is_ascending", - "is_case_sensitive", + "operation", ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return ( - E("is_ascending", "isAscending", bool, is_required=True), - E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), - ) + return (E("operation", "operation", str, is_required=True),) -class SortByEnterpriseCommonPhoneListName(OCIType): +class EnterpriseVoiceVPNDigitManipulationOptionalValue( + EnterpriseVoiceVPNDigitManipulation, +): """ - The sort criteria specifies the enterprise common phone list name as the column for - the sort, whether sort is ascending or descending, and whether the sort is case - sensitive. + Enterprise Voice VPN Digit Manipulation Entry that optionally has a value. Attributes: - is_ascending (bool): isAscending - is_case_sensitive (bool): isCaseSensitive + operation (str): operation + value (str): value *Optional* """ __slots__: List[str] = [ - "is_ascending", - "is_case_sensitive", + "operation", + "value", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("is_ascending", "isAscending", bool, is_required=True), - E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), + E("operation", "operation", str, is_required=True), + E("value", "value", str), ) -class SortByEnterpriseCommonPhoneListNumber(OCIType): +class EnterpriseVoiceVPNDigitManipulationRequiredValue( + EnterpriseVoiceVPNDigitManipulation, +): """ - The sort criteria specifies the enterprise common phone list number as as the column - for the sort, whether sort is ascending or descending, and whether the sort is case - sensitive. + Enterprise Voice VPN Digit Manipulation Entry that has a value. Attributes: - is_ascending (bool): isAscending - is_case_sensitive (bool): isCaseSensitive + operation (str): operation + value (str): value """ __slots__: List[str] = [ - "is_ascending", - "is_case_sensitive", + "operation", + "value", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("is_ascending", "isAscending", bool, is_required=True), - E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), + E("operation", "operation", str, is_required=True), + E("value", "value", str, is_required=True), ) -class SortByExtension(OCIType): +class ExecutiveCallFilteringCriteriaFromDnModify(OCIType): """ - The sort criteria specifies the extension as the column for the sort, whether the sort - is ascending or descending, and whether the sort is case sensitive. + The from dn criteria used within an executive call filtering criteria modify request. Attributes: - is_ascending (bool): isAscending - is_case_sensitive (bool): isCaseSensitive + from_dn_criteria_selection (str): fromDnCriteriaSelection *Optional* + include_anonymous_callers (bool): includeAnonymousCallers *Optional* + include_unavailable_callers (bool): includeUnavailableCallers *Optional* + phone_number_list (phoneNumberList): phoneNumberList *Optional* """ __slots__: List[str] = [ - "is_ascending", - "is_case_sensitive", + "from_dn_criteria_selection", + "include_anonymous_callers", + "include_unavailable_callers", + "phone_number_list", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("is_ascending", "isAscending", bool, is_required=True), - E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), + E("from_dn_criteria_selection", "fromDnCriteriaSelection", str), + E("include_anonymous_callers", "includeAnonymousCallers", bool), + E("include_unavailable_callers", "includeUnavailableCallers", bool), + E( + "phone_number_list", + "phoneNumberList", + CriteriaReplacementDNList, + is_complex=True, + ), ) -class SortByForwardedToNumber(OCIType): +class ExtendedFileResource(OCIType): """ - The sort criteria specifies the forwarded to phone number as the column for the sort, - whether the sort is ascending or descending, and whether the sort is case sensitive. + Represents either an existing file for the application server to use, or the contents + of a file to transfer and an URL. - This sort criteria data type is only intended to be used by the commands introduced by - BW-2301. The commands are `EnterpriseUserCallForwardingSettingsGetListRequest()` and - `GroupUserCallForwardingSettingsGetListRequest()`. The following Call Forwarding - services are compatible for this search: Call Forwarding Always, Call Forwarding - Always Secondary, Call Forwarding Busy, Call Forwarding No Answer, Call Forwarding Not - Reachable, Call Forwarding Selective. Attributes: - is_ascending (bool): isAscending - is_case_sensitive (bool): isCaseSensitive + file (file): file *Optional* + url (str): url *Optional* """ __slots__: List[str] = [ - "is_ascending", - "is_case_sensitive", + "file", + "url", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("is_ascending", "isAscending", bool, is_required=True), - E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), + E("file", "file", LabeledFileResource, is_complex=True), + E("url", "url", str), ) -class SortByGroupCommonPhoneListName(OCIType): +class ExtendedMediaFileLevelResource20(OCIType): """ - The sort criteria specifies the group common phone list name as the column for the - sort, whether the sort is ascending or descending, and whether the sort is case - sensitive. + Represents either an existing file for the application server to use, or the contents + of a file to transfer and an URL. Attributes: - is_ascending (bool): isAscending - is_case_sensitive (bool): isCaseSensitive + file (file): file *Optional* + url (str): url *Optional* """ __slots__: List[str] = [ - "is_ascending", - "is_case_sensitive", + "file", + "url", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("is_ascending", "isAscending", bool, is_required=True), - E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), + E("file", "file", AnnouncementFileLevelKey, is_complex=True), + E("url", "url", str), ) -class SortByGroupCommonPhoneListNumber(OCIType): +class ExtendedMediaFileResource(OCIType): """ - The sort criteria specifies the group common phone list number as the column for the - sort, whether sort is ascending or descending, and whether the sort is case sensitive. + Represents either an existing file for the application server to use, or the contents + of a file to transfer and an URL. Attributes: - is_ascending (bool): isAscending - is_case_sensitive (bool): isCaseSensitive + file (file): file *Optional* + url (str): url *Optional* """ __slots__: List[str] = [ - "is_ascending", - "is_case_sensitive", + "file", + "url", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("is_ascending", "isAscending", bool, is_required=True), - E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), + E("file", "file", LabeledMediaFileResource, is_complex=True), + E("url", "url", str), ) -class SortByGroupId(OCIType): +class ExtendedMediaFileResource20(OCIType): """ - The sort criteria specifies the group id as the column for the sort, whether the sort - is ascending or descending, and whether the sort is case sensitive. + Represents either an existing file for the application server to use, or the contents + of a file to transfer and an URL. Attributes: - is_ascending (bool): isAscending - is_case_sensitive (bool): isCaseSensitive + file (file): file *Optional* + url (str): url *Optional* """ __slots__: List[str] = [ - "is_ascending", - "is_case_sensitive", + "file", + "url", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("is_ascending", "isAscending", bool, is_required=True), - E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), + E("file", "file", AnnouncementFileKey, is_complex=True), + E("url", "url", str), ) -class SortByGroupLocationCode(OCIType): +class GroupDepartmentKey(DepartmentKey): """ - The sort criteria specifies the group location code as the column for the sort, - whether the sort is ascending or descending, and whether the sort is case sensitive. + Uniquely identifies a department defined within a group. + To uniquely identify a group department, we must know the department name and which + group contains the department. Attributes: - is_ascending (bool): isAscending - is_case_sensitive (bool): isCaseSensitive + service_provider_id (str): serviceProviderId + group_id (str): groupId + name (str): name """ __slots__: List[str] = [ - "is_ascending", - "is_case_sensitive", + "service_provider_id", + "group_id", + "name", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("is_ascending", "isAscending", bool, is_required=True), - E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), + E("service_provider_id", "serviceProviderId", str, is_required=True), + E("group_id", "groupId", str, is_required=True), + E("name", "name", str, is_required=True), ) -class SortByGroupName(OCIType): +class GroupServiceAuthorization(OCIType): """ - The sort criteria specifies the group name as the column for the sort, whether the - sort is ascending or descending, and whether the sort is case sensitive. + Authorize (with quantity) or unauthorize a group service. Attributes: - is_ascending (bool): isAscending - is_case_sensitive (bool): isCaseSensitive + service_name (str): serviceName + authorized_quantity (authorizedQuantity): authorizedQuantity *Optional* + unauthorized (bool): unauthorized *Optional* """ __slots__: List[str] = [ - "is_ascending", - "is_case_sensitive", + "service_name", + "authorized_quantity", + "unauthorized", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("is_ascending", "isAscending", bool, is_required=True), - E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), + E("service_name", "serviceName", str, is_required=True), + E( + "authorized_quantity", + "authorizedQuantity", + UnboundedPositiveInt, + is_complex=True, + ), + E("unauthorized", "unauthorized", bool), ) -class SortByHuntPolicy(OCIType): +class GroupServiceAuthorizationAndAssignment(OCIType): """ - The sort criteria specifies the call center hunt policy as the column for the sort, - whether the sort is ascending or descending, and whether the sort is case sensitive. + Authorize (with quantity) a group service, and optionally assign the service. Attributes: - is_ascending (bool): isAscending - is_case_sensitive (bool): isCaseSensitive + service_name (str): serviceName + authorized_quantity (authorizedQuantity): authorizedQuantity *Optional* + assign (bool): assign *Optional* """ __slots__: List[str] = [ - "is_ascending", - "is_case_sensitive", + "service_name", + "authorized_quantity", + "assign", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("is_ascending", "isAscending", bool, is_required=True), - E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), + E("service_name", "serviceName", str, is_required=True), + E( + "authorized_quantity", + "authorizedQuantity", + UnboundedPositiveInt, + is_complex=True, + ), + E("assign", "assign", bool), ) -class SortByImpId(OCIType): +class GroupSessionAdmissionControlGroupGetResponse21sp1V2(OCIType): """ - The sort criteria specifies the imp id as the column for the sort, whether the sort is - ascending or descending, and whether the sort is case sensitive. + Response to GroupSessionAdmissionControlGroupGetRequest21sp1V2. + Returns the profile information for the session admission control group. Attributes: - is_ascending (bool): isAscending - is_case_sensitive (bool): isCaseSensitive + max_session (int): maxSession + max_user_originating_sessions (int): maxUserOriginatingSessions *Optional* + max_user_terminating_sessions (int): maxUserTerminatingSessions *Optional* + reserved_session (int): reservedSession + reserved_user_originating_sessions (int): reservedUserOriginatingSessions + *Optional* + reserved_user_terminating_sessions (int): reservedUserTerminatingSessions + *Optional* + default_group (bool): defaultGroup + count_intra_sac_group_sessions (bool): countIntraSACGroupSessions + devices (List[devices]): devices *Optional* + block_emergency_and_repair_calls_due_to_sac_limits (bool): + blockEmergencyAndRepairCallsDueToSACLimits + media_group_name (str): mediaGroupName *Optional* + access_info_pattern (str): accessInfoPattern *Optional* """ __slots__: List[str] = [ - "is_ascending", - "is_case_sensitive", + "max_session", + "max_user_originating_sessions", + "max_user_terminating_sessions", + "reserved_session", + "reserved_user_originating_sessions", + "reserved_user_terminating_sessions", + "default_group", + "count_intra_sac_group_sessions", + "devices", + "block_emergency_and_repair_calls_due_to_sac_limits", + "media_group_name", + "access_info_pattern", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("is_ascending", "isAscending", bool, is_required=True), - E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), - ) - - -class SortByLocation(OCIType): - """ - The sort criteria specifies the Broadworks Location as the column for the sort, - whether the sort is ascending or descending, and whether the sort is case sensitive. - - - Attributes: - is_ascending (bool): isAscending - is_case_sensitive (bool): isCaseSensitive - """ - - __slots__: List[str] = [ - "is_ascending", - "is_case_sensitive", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("is_ascending", "isAscending", bool, is_required=True), - E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), - ) - - -class SortByMobileDirectoryNumber(OCIType): - """ - The sort criteria specifies the Mobile dn availability as the column for the sort, - whether the sort is ascending or descending, and whether the sort is case sensitive. - - - Attributes: - is_ascending (bool): isAscending - is_case_sensitive (bool): isCaseSensitive - """ - - __slots__: List[str] = [ - "is_ascending", - "is_case_sensitive", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("is_ascending", "isAscending", bool, is_required=True), - E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), + E("max_session", "maxSession", int, is_required=True), + E("max_user_originating_sessions", "maxUserOriginatingSessions", int), + E("max_user_terminating_sessions", "maxUserTerminatingSessions", int), + E("reserved_session", "reservedSession", int, is_required=True), + E( + "reserved_user_originating_sessions", + "reservedUserOriginatingSessions", + int, + ), + E( + "reserved_user_terminating_sessions", + "reservedUserTerminatingSessions", + int, + ), + E("default_group", "defaultGroup", bool, is_required=True), + E( + "count_intra_sac_group_sessions", + "countIntraSACGroupSessions", + bool, + is_required=True, + ), + E("devices", "devices", AccessDevice, is_complex=True, is_array=True), + E( + "block_emergency_and_repair_calls_due_to_sac_limits", + "blockEmergencyAndRepairCallsDueToSACLimits", + bool, + is_required=True, + ), + E("media_group_name", "mediaGroupName", str), + E("access_info_pattern", "accessInfoPattern", str), ) -class SortByMobilePhoneNumber(OCIType): +class GroupTrunkGroupGetInstanceRequest14sp9A(OCIType): """ - The sort criteria specifies the mobile phone number as the column for the sort, - whether the sort is ascending or descending, and whether the sort is case sensitive. + Get a Trunk Group Instance's profile. + The response is either a GroupTrunkGroupGetInstanceResponse14sp9A or an + `ErrorResponse()`. The response contains a hosted user table with column headings: + "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name". Attributes: - is_ascending (bool): isAscending - is_case_sensitive (bool): isCaseSensitive + trunk_group_key (trunkGroupKey): trunkGroupKey """ __slots__: List[str] = [ - "is_ascending", - "is_case_sensitive", + "trunk_group_key", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("is_ascending", "isAscending", bool, is_required=True), - E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), + E( + "trunk_group_key", + "trunkGroupKey", + TrunkGroupKey, + is_complex=True, + is_required=True, + ), ) -class SortByReceptionistNote(OCIType): +class GroupTrunkGroupGetInstanceRequest17sp4V2(OCIType): """ - The sort criteria specifies the Receptionist Notes as the column for the sort, whether - the sort is ascending or descending, and whether the sort is case sensitive. + Get a Trunk Group Instance's profile. + The response is either a GroupTrunkGroupGetInstanceResponse17sp4V2 or an + `ErrorResponse()`. The response contains a hosted user table with column headings: + "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name". + Replaced by: `GroupTrunkGroupGetInstanceRequest19V2()` Attributes: - is_ascending (bool): isAscending - is_case_sensitive (bool): isCaseSensitive + trunk_group_key (trunkGroupKey): trunkGroupKey """ __slots__: List[str] = [ - "is_ascending", - "is_case_sensitive", + "trunk_group_key", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("is_ascending", "isAscending", bool, is_required=True), - E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), + E( + "trunk_group_key", + "trunkGroupKey", + TrunkGroupKey, + is_complex=True, + is_required=True, + ), ) -class SortByScheduleName(OCIType): +class GroupTrunkGroupGetInstanceRequest19sp1V2(OCIType): """ - The sort criteria specifies the schedule name as the column for the sort, whether the - sort is ascending or descending, and whether the sort is case sensitive. + Get a Trunk Group Instance's profile. + The response is either a GroupTrunkGroupGetInstanceResponse19sp1V2 or an + `ErrorResponse()`. The response contains a hosted user table with column headings: + "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name", + "Phone Number", "Extension", "Department", "Email Address". Replaced by: + `GroupTrunkGroupGetInstanceRequest20sp1()` Attributes: - is_ascending (bool): isAscending - is_case_sensitive (bool): isCaseSensitive + trunk_group_key (trunkGroupKey): trunkGroupKey """ __slots__: List[str] = [ - "is_ascending", - "is_case_sensitive", + "trunk_group_key", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("is_ascending", "isAscending", bool, is_required=True), - E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), + E( + "trunk_group_key", + "trunkGroupKey", + TrunkGroupKey, + is_complex=True, + is_required=True, + ), ) -class SortByServiceProviderId(OCIType): +class GroupTrunkGroupGetInstanceResponse14sp9A(OCIType): """ - The sort criteria specifies the service provider id as the column for the sort, - whether the sort is ascending or descending, and whether the sort is case sensitive. + Response to GroupTrunkGroupGetInstanceRequest14sp9A. + Returns the profile information for the Trunk Group. Contains a hosted user table + with column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name", + "Hiragana First Name". Attributes: - is_ascending (bool): isAscending - is_case_sensitive (bool): isCaseSensitive + pilot_user_id (str): pilotUserId *Optional* + department (department): department *Optional* + access_device (accessDevice): accessDevice *Optional* + max_active_calls (int): maxActiveCalls + max_incoming_calls (int): maxIncomingCalls *Optional* + max_outgoing_calls (int): maxOutgoingCalls *Optional* + enable_bursting (bool): enableBursting + bursting_max_active_calls (int): burstingMaxActiveCalls *Optional* + bursting_max_incoming_calls (int): burstingMaxIncomingCalls *Optional* + bursting_max_outgoing_calls (int): burstingMaxOutgoingCalls *Optional* + capacity_exceeded_action (str): capacityExceededAction *Optional* + capacity_exceeded_forward_address (str): capacityExceededForwardAddress *Optional* + capacity_exceeded_reroute_trunk_group_key (capacityExceededRerouteTrunkGroupKey): + capacityExceededRerouteTrunkGroupKey *Optional* + capacity_exceeded_trap_initial_calls (int): capacityExceededTrapInitialCalls + capacity_exceeded_trap_offset_calls (int): capacityExceededTrapOffsetCalls + unreachable_destination_action (str): unreachableDestinationAction *Optional* + unreachable_destination_forward_address (str): + unreachableDestinationForwardAddress *Optional* + unreachable_destination_reroute_trunk_group_key + (unreachableDestinationRerouteTrunkGroupKey): + unreachableDestinationRerouteTrunkGroupKey *Optional* + unreachable_destination_trap_initial_calls (int): + unreachableDestinationTrapInitialCalls + unreachable_destination_trap_offset_calls (int): + unreachableDestinationTrapOffsetCalls + invitation_timeout (int): invitationTimeout + require_authentication (bool): requireAuthentication + sip_authentication_user_name (str): sipAuthenticationUserName *Optional* + hosted_user_table (List(hostedUserTable)): hostedUserTable - *Table* array of + hostedUserTable named tuples *Optional* + trunk_group_identity (str): trunkGroupIdentity *Optional* + otg_dtg_identity (str): otgDtgIdentity *Optional* + include_trunk_group_identity (bool): includeTrunkGroupIdentity + include_dtg_identity (bool): includeDtgIdentity + enable_network_address_identity (bool): enableNetworkAddressIdentity + allow_unscreened_calls (bool): allowUnscreenedCalls + allow_unscreened_emergency_calls (bool): allowUnscreenedEmergencyCalls + pilot_user_calling_line_identity_policy (str): pilotUserCallingLineIdentityPolicy + pilot_user_charge_number_policy (str): pilotUserChargeNumberPolicy + call_forwarding_always_action (str): callForwardingAlwaysAction *Optional* + call_forwarding_always_forward_address (str): callForwardingAlwaysForwardAddress + *Optional* + call_forwarding_always_reroute_trunk_group_key + (callForwardingAlwaysRerouteTrunkGroupKey): + callForwardingAlwaysRerouteTrunkGroupKey *Optional* """ __slots__: List[str] = [ - "is_ascending", - "is_case_sensitive", + "pilot_user_id", + "department", + "access_device", + "max_active_calls", + "max_incoming_calls", + "max_outgoing_calls", + "enable_bursting", + "bursting_max_active_calls", + "bursting_max_incoming_calls", + "bursting_max_outgoing_calls", + "capacity_exceeded_action", + "capacity_exceeded_forward_address", + "capacity_exceeded_reroute_trunk_group_key", + "capacity_exceeded_trap_initial_calls", + "capacity_exceeded_trap_offset_calls", + "unreachable_destination_action", + "unreachable_destination_forward_address", + "unreachable_destination_reroute_trunk_group_key", + "unreachable_destination_trap_initial_calls", + "unreachable_destination_trap_offset_calls", + "invitation_timeout", + "require_authentication", + "sip_authentication_user_name", + "hosted_user_table", + "trunk_group_identity", + "otg_dtg_identity", + "include_trunk_group_identity", + "include_dtg_identity", + "enable_network_address_identity", + "allow_unscreened_calls", + "allow_unscreened_emergency_calls", + "pilot_user_calling_line_identity_policy", + "pilot_user_charge_number_policy", + "call_forwarding_always_action", + "call_forwarding_always_forward_address", + "call_forwarding_always_reroute_trunk_group_key", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("is_ascending", "isAscending", bool, is_required=True), - E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), + E("pilot_user_id", "pilotUserId", str), + E("department", "department", DepartmentKey, is_complex=True), + E("access_device", "accessDevice", AccessDevice, is_complex=True), + E("max_active_calls", "maxActiveCalls", int, is_required=True), + E("max_incoming_calls", "maxIncomingCalls", int), + E("max_outgoing_calls", "maxOutgoingCalls", int), + E("enable_bursting", "enableBursting", bool, is_required=True), + E("bursting_max_active_calls", "burstingMaxActiveCalls", int), + E("bursting_max_incoming_calls", "burstingMaxIncomingCalls", int), + E("bursting_max_outgoing_calls", "burstingMaxOutgoingCalls", int), + E("capacity_exceeded_action", "capacityExceededAction", str), + E( + "capacity_exceeded_forward_address", + "capacityExceededForwardAddress", + str, + ), + E( + "capacity_exceeded_reroute_trunk_group_key", + "capacityExceededRerouteTrunkGroupKey", + TrunkGroupKey, + is_complex=True, + ), + E( + "capacity_exceeded_trap_initial_calls", + "capacityExceededTrapInitialCalls", + int, + is_required=True, + ), + E( + "capacity_exceeded_trap_offset_calls", + "capacityExceededTrapOffsetCalls", + int, + is_required=True, + ), + E("unreachable_destination_action", "unreachableDestinationAction", str), + E( + "unreachable_destination_forward_address", + "unreachableDestinationForwardAddress", + str, + ), + E( + "unreachable_destination_reroute_trunk_group_key", + "unreachableDestinationRerouteTrunkGroupKey", + TrunkGroupKey, + is_complex=True, + ), + E( + "unreachable_destination_trap_initial_calls", + "unreachableDestinationTrapInitialCalls", + int, + is_required=True, + ), + E( + "unreachable_destination_trap_offset_calls", + "unreachableDestinationTrapOffsetCalls", + int, + is_required=True, + ), + E("invitation_timeout", "invitationTimeout", int, is_required=True), + E( + "require_authentication", + "requireAuthentication", + bool, + is_required=True, + ), + E("sip_authentication_user_name", "sipAuthenticationUserName", str), + E( + "hosted_user_table", + "hostedUserTable", + list, + is_complex=True, + is_table=True, + ), + E("trunk_group_identity", "trunkGroupIdentity", str), + E("otg_dtg_identity", "otgDtgIdentity", str), + E( + "include_trunk_group_identity", + "includeTrunkGroupIdentity", + bool, + is_required=True, + ), + E("include_dtg_identity", "includeDtgIdentity", bool, is_required=True), + E( + "enable_network_address_identity", + "enableNetworkAddressIdentity", + bool, + is_required=True, + ), + E("allow_unscreened_calls", "allowUnscreenedCalls", bool, is_required=True), + E( + "allow_unscreened_emergency_calls", + "allowUnscreenedEmergencyCalls", + bool, + is_required=True, + ), + E( + "pilot_user_calling_line_identity_policy", + "pilotUserCallingLineIdentityPolicy", + str, + is_required=True, + ), + E( + "pilot_user_charge_number_policy", + "pilotUserChargeNumberPolicy", + str, + is_required=True, + ), + E("call_forwarding_always_action", "callForwardingAlwaysAction", str), + E( + "call_forwarding_always_forward_address", + "callForwardingAlwaysForwardAddress", + str, + ), + E( + "call_forwarding_always_reroute_trunk_group_key", + "callForwardingAlwaysRerouteTrunkGroupKey", + TrunkGroupKey, + is_complex=True, + ), ) -class SortByServiceProviderName(OCIType): +class GroupTrunkGroupGetInstanceResponse17sp4V2(OCIType): """ - The sort criteria specifies the service provider name as the column for the sort, - whether the sort is ascending or descending, and whether the sort is case sensitive. + Response to GroupTrunkGroupGetInstanceRequest17sp4V2. + Returns the profile information for the Trunk Group. Contains a hosted user table + with column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name", + "Hiragana First Name". Replaced by: `GroupTrunkGroupGetInstanceResponse19V2()` Attributes: - is_ascending (bool): isAscending - is_case_sensitive (bool): isCaseSensitive + pilot_user_id (str): pilotUserId *Optional* + department (department): department *Optional* + access_device (accessDevice): accessDevice *Optional* + max_active_calls (int): maxActiveCalls + max_incoming_calls (int): maxIncomingCalls *Optional* + max_outgoing_calls (int): maxOutgoingCalls *Optional* + enable_bursting (bool): enableBursting + bursting_max_active_calls (int): burstingMaxActiveCalls *Optional* + bursting_max_incoming_calls (int): burstingMaxIncomingCalls *Optional* + bursting_max_outgoing_calls (int): burstingMaxOutgoingCalls *Optional* + capacity_exceeded_action (str): capacityExceededAction *Optional* + capacity_exceeded_forward_address (str): capacityExceededForwardAddress *Optional* + capacity_exceeded_reroute_trunk_group_key (capacityExceededRerouteTrunkGroupKey): + capacityExceededRerouteTrunkGroupKey *Optional* + capacity_exceeded_trap_initial_calls (int): capacityExceededTrapInitialCalls + capacity_exceeded_trap_offset_calls (int): capacityExceededTrapOffsetCalls + unreachable_destination_action (str): unreachableDestinationAction *Optional* + unreachable_destination_forward_address (str): + unreachableDestinationForwardAddress *Optional* + unreachable_destination_reroute_trunk_group_key + (unreachableDestinationRerouteTrunkGroupKey): + unreachableDestinationRerouteTrunkGroupKey *Optional* + invitation_timeout (int): invitationTimeout + require_authentication (bool): requireAuthentication + sip_authentication_user_name (str): sipAuthenticationUserName *Optional* + hosted_user_table (List(hostedUserTable)): hostedUserTable - *Table* array of + hostedUserTable named tuples *Optional* + trunk_group_identity (str): trunkGroupIdentity *Optional* + otg_dtg_identity (str): otgDtgIdentity *Optional* + allow_termination_to_trunk_group_identity (bool): + allowTerminationToTrunkGroupIdentity + allow_termination_to_dtg_identity (bool): allowTerminationToDtgIdentity + include_trunk_group_identity (bool): includeTrunkGroupIdentity + include_dtg_identity (bool): includeDtgIdentity + include_trunk_group_identity_for_network_calls (bool): + includeTrunkGroupIdentityForNetworkCalls + include_otg_identity_for_network_calls (bool): includeOtgIdentityForNetworkCalls + enable_network_address_identity (bool): enableNetworkAddressIdentity + allow_unscreened_calls (bool): allowUnscreenedCalls + allow_unscreened_emergency_calls (bool): allowUnscreenedEmergencyCalls + pilot_user_calling_line_identity_policy (str): pilotUserCallingLineIdentityPolicy + pilot_user_charge_number_policy (str): pilotUserChargeNumberPolicy + call_forwarding_always_action (str): callForwardingAlwaysAction *Optional* + call_forwarding_always_forward_address (str): callForwardingAlwaysForwardAddress + *Optional* + call_forwarding_always_reroute_trunk_group_key + (callForwardingAlwaysRerouteTrunkGroupKey): + callForwardingAlwaysRerouteTrunkGroupKey *Optional* + peering_domain (str): peeringDomain *Optional* + route_to_peering_domain (bool): routeToPeeringDomain + prefix_enabled (bool): prefixEnabled + prefix (str): prefix *Optional* + stateful_rerouting_enabled (bool): statefulReroutingEnabled + send_continuous_options_message (bool): sendContinuousOptionsMessage + continuous_options_sending_interval_seconds (int): + continuousOptionsSendingIntervalSeconds + failure_options_sending_interval_seconds (int): + failureOptionsSendingIntervalSeconds + failure_threshold_counter (int): failureThresholdCounter + success_threshold_counter (int): successThresholdCounter + invite_failure_threshold_counter (int): inviteFailureThresholdCounter + invite_failure_threshold_window_seconds (int): inviteFailureThresholdWindowSeconds + trunk_group_state (str): trunkGroupState + pilot_user_calling_line_asserted_identity_policy (str): + pilotUserCallingLineAssertedIdentityPolicy + use_system_calling_line_asserted_identity_policy (bool): + useSystemCallingLineAssertedIdentityPolicy """ __slots__: List[str] = [ - "is_ascending", - "is_case_sensitive", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("is_ascending", "isAscending", bool, is_required=True), - E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), - ) - - -class SortByServiceStatus(OCIType): - """ - The sort criteria specifies the service status as the column for the sort, whether the - sort is ascending or descending, and whether the sort is case sensitive. - - This sort criteria data type is only intended to be used by the commands introduced by - BW-2301. The commands are `EnterpriseUserCallWaitingSettingsGetListRequest()`, - `GroupUserCallWaitingSettingsGetListRequest()`, - `EnterpriseUserHotelingGuestSettingsGetListRequest()`, and - `GroupUserHotelingGuestSettingsGetListRequest()`. - - Attributes: - is_ascending (bool): isAscending - is_case_sensitive (bool): isCaseSensitive - """ - - __slots__: List[str] = [ - "is_ascending", - "is_case_sensitive", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("is_ascending", "isAscending", bool, is_required=True), - E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), - ) - - -class SortByTrunkGroupName(OCIType): - """ - The sort criteria specifies the trunk group name as the column for the sort, whether - the sort is ascending or descending, and whether the sort is case sensitive. - - - Attributes: - is_ascending (bool): isAscending - is_case_sensitive (bool): isCaseSensitive - """ - - __slots__: List[str] = [ - "is_ascending", - "is_case_sensitive", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("is_ascending", "isAscending", bool, is_required=True), - E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), - ) - - -class SortByUserDepartment(OCIType): - """ - The sort criteria specifies the user department name as the column for the sort, - whether the sort is ascending or descending, and whether the sort is case sensitive. - - - Attributes: - is_ascending (bool): isAscending - is_case_sensitive (bool): isCaseSensitive - """ - - __slots__: List[str] = [ - "is_ascending", - "is_case_sensitive", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("is_ascending", "isAscending", bool, is_required=True), - E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), - ) - - -class SortByUserFirstName(OCIType): - """ - The sort criteria specifies the user first name as the column for the sort, whether - the sort is ascending or descending, and whether the sort is case sensitive. - - - Attributes: - is_ascending (bool): isAscending - is_case_sensitive (bool): isCaseSensitive - """ - - __slots__: List[str] = [ - "is_ascending", - "is_case_sensitive", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("is_ascending", "isAscending", bool, is_required=True), - E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), - ) - - -class SortByUserId(OCIType): - """ - The sort criteria specifies the user id as the column for the sort, whether the sort - is ascending or descending, and whether the sort is case sensitive. - - - Attributes: - is_ascending (bool): isAscending - is_case_sensitive (bool): isCaseSensitive - """ - - __slots__: List[str] = [ - "is_ascending", - "is_case_sensitive", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("is_ascending", "isAscending", bool, is_required=True), - E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), - ) - - -class SortByUserLastName(OCIType): - """ - The sort criteria specifies the user last name as the column for the sort, whether the - sort is ascending or descending, and whether the sort is case sensitive. - - - Attributes: - is_ascending (bool): isAscending - is_case_sensitive (bool): isCaseSensitive - """ - - __slots__: List[str] = [ - "is_ascending", - "is_case_sensitive", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("is_ascending", "isAscending", bool, is_required=True), - E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), - ) - - -class SortByUserPersonalPhoneListName(OCIType): - """ - The sort criteria specifies the user personal phone list name as the column for the - sort, whether sort is ascending or descending, and whether the sort is case sensitive. - - - Attributes: - is_ascending (bool): isAscending - is_case_sensitive (bool): isCaseSensitive - """ - - __slots__: List[str] = [ - "is_ascending", - "is_case_sensitive", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("is_ascending", "isAscending", bool, is_required=True), - E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), - ) - - -class SortByUserPersonalPhoneListNumber(OCIType): - """ - The sort criteria specifies the user personal phone list number as the column for the - sort, whether the sort is ascending or descending, and whether the sort is case - sensitive. - - - Attributes: - is_ascending (bool): isAscending - is_case_sensitive (bool): isCaseSensitive - """ - - __slots__: List[str] = [ - "is_ascending", - "is_case_sensitive", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("is_ascending", "isAscending", bool, is_required=True), - E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), - ) - - -class SortByYahooId(OCIType): - """ - The sort criteria specifies the yahoo id as the column for the sort, whether the sort - is ascending or descending, and whether the sort is case sensitive. - - - Attributes: - is_ascending (bool): isAscending - is_case_sensitive (bool): isCaseSensitive - """ - - __slots__: List[str] = [ - "is_ascending", - "is_case_sensitive", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("is_ascending", "isAscending", bool, is_required=True), - E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), - ) - - -class SortCriteria(OCIType): - """ - The sort criteria specifies whether sort is ascending or descending, and whether the - sort is case sensitive. - - Sort order defaults to ascending and case sensitive. - - Attributes: - is_ascending (bool): isAscending - is_case_sensitive (bool): isCaseSensitive - """ - - __slots__: List[str] = [ - "is_ascending", - "is_case_sensitive", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("is_ascending", "isAscending", bool, is_required=True), - E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), - ) - - -class SortCriteriaNumeric(OCIType): - """ - The sort criteria specifies whether sort is ascending or descending. - - Sort order defaults to ascending. - - Attributes: - is_ascending (bool): isAscending - """ - - __slots__: List[str] = [ - "is_ascending", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return (E("is_ascending", "isAscending", bool, is_required=True),) - - -class SpeedDial100Entry(OCIType): - """ - Modify the speed dial 100 prefix setting for a group. - - The response is either a `SuccessResponse()` or an `ErrorResponse()`. - - Attributes: - speed_code (int): speedCode - phone_number (str): phoneNumber - description (str): description *Optional* - """ - - __slots__: List[str] = [ - "speed_code", - "phone_number", - "description", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("speed_code", "speedCode", int, is_required=True), - E("phone_number", "phoneNumber", str, is_required=True), - E("description", "description", str), - ) - - -class SpeedDial100EntryModify(OCIType): - """ - Modify the speed dial 100 prefix setting for a group. - - The response is either a `SuccessResponse()` or an `ErrorResponse()`. - - Attributes: - speed_code (int): speedCode - phone_number (str): phoneNumber *Optional* - description (str): description *Optional* - """ - - __slots__: List[str] = [ - "speed_code", - "phone_number", - "description", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("speed_code", "speedCode", int, is_required=True), - E("phone_number", "phoneNumber", str), - E("description", "description", str), - ) - - -class SpeedDial8Entry(OCIType): - """ - Modify the speed dial 8 prefix setting for a group. - - The response is either a `SuccessResponse()` or an `ErrorResponse()`. - - Attributes: - speed_code (int): speedCode - phone_number (str): phoneNumber *Optional* - description (str): description *Optional* - """ - - __slots__: List[str] = [ - "speed_code", - "phone_number", - "description", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("speed_code", "speedCode", int, is_required=True), - E("phone_number", "phoneNumber", str), - E("description", "description", str), - ) - - -class StreetAddress(OCIType): - """ - Street address information. - - - Attributes: - address_line1 (str): addressLine1 *Optional* - address_line2 (str): addressLine2 *Optional* - city (str): city *Optional* - state_or_province (str): stateOrProvince *Optional* - state_or_province_display_name (str): stateOrProvinceDisplayName *Optional* - zip_or_postal_code (str): zipOrPostalCode *Optional* - country (str): country *Optional* - """ - - __slots__: List[str] = [ - "address_line1", - "address_line2", - "city", - "state_or_province", - "state_or_province_display_name", - "zip_or_postal_code", - "country", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("address_line1", "addressLine1", str), - E("address_line2", "addressLine2", str), - E("city", "city", str), - E("state_or_province", "stateOrProvince", str), - E("state_or_province_display_name", "stateOrProvinceDisplayName", str), - E("zip_or_postal_code", "zipOrPostalCode", str), - E("country", "country", str), - ) - - -class SystemBroadWorksMobilityGetRequest21sp1V2(OCIType): - """ - Get the broadworks mobility system parameters. - - The response is either a SystemBroadWorksMobilityGetResponse21sp1V2 or an - `ErrorResponse()`. Replaced by `SystemBroadWorksMobilityGetRequest22V2()`. - """ - - __slots__: List[str] = [] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return () - - -class SystemBroadWorksMobilityGetResponse21sp1V2(OCIType): - """ - The response to a SystemBroadWorksMobilityGetRequest21sp1V2. - - Replaced by `SystemBroadWorksMobilityGetResponse22V2()`. - - Attributes: - enable_location_services (bool): enableLocationServices - enable_msrn_lookup (bool): enableMSRNLookup - enable_mobile_state_checking (bool): enableMobileStateChecking - deny_call_originations (bool): denyCallOriginations - deny_call_terminations (bool): denyCallTerminations - imrn_timeout_millisecnds (int): imrnTimeoutMillisecnds - enable_internal_clid_delivery_access_locations (bool): - enableInternalCLIDDeliveryAccessLocations - enable_enhanced_unreachable_state_checking (bool): - enableEnhancedUnreachableStateChecking - enable_network_call_barring_status_check (bool): - enableNetworkCallBarringStatusCheck - """ - - __slots__: List[str] = [ - "enable_location_services", - "enable_msrn_lookup", - "enable_mobile_state_checking", - "deny_call_originations", - "deny_call_terminations", - "imrn_timeout_millisecnds", - "enable_internal_clid_delivery_access_locations", - "enable_enhanced_unreachable_state_checking", - "enable_network_call_barring_status_check", + "pilot_user_id", + "department", + "access_device", + "max_active_calls", + "max_incoming_calls", + "max_outgoing_calls", + "enable_bursting", + "bursting_max_active_calls", + "bursting_max_incoming_calls", + "bursting_max_outgoing_calls", + "capacity_exceeded_action", + "capacity_exceeded_forward_address", + "capacity_exceeded_reroute_trunk_group_key", + "capacity_exceeded_trap_initial_calls", + "capacity_exceeded_trap_offset_calls", + "unreachable_destination_action", + "unreachable_destination_forward_address", + "unreachable_destination_reroute_trunk_group_key", + "invitation_timeout", + "require_authentication", + "sip_authentication_user_name", + "hosted_user_table", + "trunk_group_identity", + "otg_dtg_identity", + "allow_termination_to_trunk_group_identity", + "allow_termination_to_dtg_identity", + "include_trunk_group_identity", + "include_dtg_identity", + "include_trunk_group_identity_for_network_calls", + "include_otg_identity_for_network_calls", + "enable_network_address_identity", + "allow_unscreened_calls", + "allow_unscreened_emergency_calls", + "pilot_user_calling_line_identity_policy", + "pilot_user_charge_number_policy", + "call_forwarding_always_action", + "call_forwarding_always_forward_address", + "call_forwarding_always_reroute_trunk_group_key", + "peering_domain", + "route_to_peering_domain", + "prefix_enabled", + "prefix", + "stateful_rerouting_enabled", + "send_continuous_options_message", + "continuous_options_sending_interval_seconds", + "failure_options_sending_interval_seconds", + "failure_threshold_counter", + "success_threshold_counter", + "invite_failure_threshold_counter", + "invite_failure_threshold_window_seconds", + "trunk_group_state", + "pilot_user_calling_line_asserted_identity_policy", + "use_system_calling_line_asserted_identity_policy", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( + E("pilot_user_id", "pilotUserId", str), + E("department", "department", DepartmentKey, is_complex=True), + E("access_device", "accessDevice", AccessDevice, is_complex=True), + E("max_active_calls", "maxActiveCalls", int, is_required=True), + E("max_incoming_calls", "maxIncomingCalls", int), + E("max_outgoing_calls", "maxOutgoingCalls", int), + E("enable_bursting", "enableBursting", bool, is_required=True), + E("bursting_max_active_calls", "burstingMaxActiveCalls", int), + E("bursting_max_incoming_calls", "burstingMaxIncomingCalls", int), + E("bursting_max_outgoing_calls", "burstingMaxOutgoingCalls", int), + E("capacity_exceeded_action", "capacityExceededAction", str), E( - "enable_location_services", - "enableLocationServices", + "capacity_exceeded_forward_address", + "capacityExceededForwardAddress", + str, + ), + E( + "capacity_exceeded_reroute_trunk_group_key", + "capacityExceededRerouteTrunkGroupKey", + TrunkGroupKey, + is_complex=True, + ), + E( + "capacity_exceeded_trap_initial_calls", + "capacityExceededTrapInitialCalls", + int, + is_required=True, + ), + E( + "capacity_exceeded_trap_offset_calls", + "capacityExceededTrapOffsetCalls", + int, + is_required=True, + ), + E("unreachable_destination_action", "unreachableDestinationAction", str), + E( + "unreachable_destination_forward_address", + "unreachableDestinationForwardAddress", + str, + ), + E( + "unreachable_destination_reroute_trunk_group_key", + "unreachableDestinationRerouteTrunkGroupKey", + TrunkGroupKey, + is_complex=True, + ), + E("invitation_timeout", "invitationTimeout", int, is_required=True), + E( + "require_authentication", + "requireAuthentication", bool, is_required=True, ), - E("enable_msrn_lookup", "enableMSRNLookup", bool, is_required=True), + E("sip_authentication_user_name", "sipAuthenticationUserName", str), E( - "enable_mobile_state_checking", - "enableMobileStateChecking", + "hosted_user_table", + "hostedUserTable", + list, + is_complex=True, + is_table=True, + ), + E("trunk_group_identity", "trunkGroupIdentity", str), + E("otg_dtg_identity", "otgDtgIdentity", str), + E( + "allow_termination_to_trunk_group_identity", + "allowTerminationToTrunkGroupIdentity", bool, is_required=True, ), - E("deny_call_originations", "denyCallOriginations", bool, is_required=True), - E("deny_call_terminations", "denyCallTerminations", bool, is_required=True), E( - "imrn_timeout_millisecnds", - "imrnTimeoutMillisecnds", - int, + "allow_termination_to_dtg_identity", + "allowTerminationToDtgIdentity", + bool, is_required=True, ), E( - "enable_internal_clid_delivery_access_locations", - "enableInternalCLIDDeliveryAccessLocations", + "include_trunk_group_identity", + "includeTrunkGroupIdentity", bool, is_required=True, ), + E("include_dtg_identity", "includeDtgIdentity", bool, is_required=True), E( - "enable_enhanced_unreachable_state_checking", - "enableEnhancedUnreachableStateChecking", + "include_trunk_group_identity_for_network_calls", + "includeTrunkGroupIdentityForNetworkCalls", bool, is_required=True, ), E( - "enable_network_call_barring_status_check", - "enableNetworkCallBarringStatusCheck", + "include_otg_identity_for_network_calls", + "includeOtgIdentityForNetworkCalls", bool, is_required=True, ), - ) - - -class SystemCollaborateGetRequest20sp1V2(OCIType): - """ - Request the system level data associated with collaborate services. - - The response is either a SystemCollaborateGetResponse20sp1V2 or an `ErrorResponse()`. - """ - - __slots__: List[str] = [] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return () - - -class SystemCommunicationBarringProfileGetRequest19sp1V2(OCIType): - """ - Get an existing Communication Barring Profile. - - The response is either a SystemCommunicationBarringProfileGetResponse19sp1V2 or an - `ErrorResponse()`. - - Attributes: - name (str): name - """ - - __slots__: List[str] = [ - "name", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return (E("name", "name", str, is_required=True),) - - -class SystemSIPDeviceTypeGetRequest18sp1V2(OCIType): - """ - Request to get a sip device type. - - See Also: `SystemDeviceTypeGetRequest()` - - The response is either `SystemSIPDeviceTypeGetResponse19()` or `ErrorResponse()`. - Replaced by: `SystemSIPDeviceTypeGetRequest19()`. - - Attributes: - device_type (str): deviceType - """ - - __slots__: List[str] = [ - "device_type", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return (E("device_type", "deviceType", str, is_required=True),) - - -class SystemSIPDeviceTypeGetRequest21sp1V2(OCIType): - """ - Request to get a sip device type. - - See Also: `SystemDeviceTypeGetRequest()` - - The response is either SystemSIPDeviceTypeGetResponse21sp1V2 or `ErrorResponse()`. - Replaced by: `SystemSIPDeviceTypeGetRequest22()` in AS data mode. - - Attributes: - device_type (str): deviceType - """ - - __slots__: List[str] = [ - "device_type", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return (E("device_type", "deviceType", str, is_required=True),) - - -class TimeInterval(OCIType): - """ - Time Interval. - - - Attributes: - start_day_of_week (str): startDayOfWeek - start_hour (int): startHour - start_minute (int): startMinute - end_day_of_week (str): endDayOfWeek - end_hour (int): endHour - end_minute (int): endMinute - """ - - __slots__: List[str] = [ - "start_day_of_week", - "start_hour", - "start_minute", - "end_day_of_week", - "end_hour", - "end_minute", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("start_day_of_week", "startDayOfWeek", str, is_required=True), - E("start_hour", "startHour", int, is_required=True), - E("start_minute", "startMinute", int, is_required=True), - E("end_day_of_week", "endDayOfWeek", str, is_required=True), - E("end_hour", "endHour", int, is_required=True), - E("end_minute", "endMinute", int, is_required=True), - ) - - -class TimeSchedule(OCIType): - """ - The from dn criteria. - - - Attributes: - type (str): type - name (str): name - """ - - __slots__: List[str] = [ - "type", - "name", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("type", "type", str, is_required=True), - E("name", "name", str, is_required=True), - ) - - -class TrunkGroupDeviceEndpointAdd(OCIType): - """ - Trunk group device endpoint used in the context of modify. - - - Attributes: - name (str): name - line_port (str): linePort - contact (str): contact *Optional* - """ - - __slots__: List[str] = [ - "name", - "line_port", - "contact", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("name", "name", str, is_required=True), - E("line_port", "linePort", str, is_required=True), - E("contact", "contact", str), - ) - - -class TrunkGroupDeviceEndpointModify(OCIType): - """ - Trunk group device endpoint used in the context of modify. - - - Attributes: - name (str): name - line_port (str): linePort - contact (str): contact *Optional* - """ - - __slots__: List[str] = [ - "name", - "line_port", - "contact", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("name", "name", str, is_required=True), - E("line_port", "linePort", str, is_required=True), - E("contact", "contact", str), - ) - - -class TrunkGroupDeviceEndpointRead(OCIType): - """ - Trunk group device endpoint. - - - Attributes: - service_user_id (str): serviceUserId - name (str): name - line_port (str): linePort - contact (str): contact *Optional* - static_registration_capable (bool): staticRegistrationCapable - use_domain (bool): useDomain - """ - - __slots__: List[str] = [ - "service_user_id", - "name", - "line_port", - "contact", - "static_registration_capable", - "use_domain", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("service_user_id", "serviceUserId", str, is_required=True), - E("name", "name", str, is_required=True), - E("line_port", "linePort", str, is_required=True), - E("contact", "contact", str), E( - "static_registration_capable", - "staticRegistrationCapable", + "enable_network_address_identity", + "enableNetworkAddressIdentity", bool, is_required=True, ), - E("use_domain", "useDomain", bool, is_required=True), - ) - - -class TrunkGroupDeviceEndpointRead14sp4(OCIType): - """ - Trunk group device endpoint. - - - Attributes: - name (str): name - line_port (str): linePort - contact (str): contact *Optional* - static_registration_capable (bool): staticRegistrationCapable - use_domain (bool): useDomain - is_pilot_user (bool): isPilotUser - """ - - __slots__: List[str] = [ - "name", - "line_port", - "contact", - "static_registration_capable", - "use_domain", - "is_pilot_user", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("name", "name", str, is_required=True), - E("line_port", "linePort", str, is_required=True), - E("contact", "contact", str), + E("allow_unscreened_calls", "allowUnscreenedCalls", bool, is_required=True), E( - "static_registration_capable", - "staticRegistrationCapable", + "allow_unscreened_emergency_calls", + "allowUnscreenedEmergencyCalls", + bool, + is_required=True, + ), + E( + "pilot_user_calling_line_identity_policy", + "pilotUserCallingLineIdentityPolicy", + str, + is_required=True, + ), + E( + "pilot_user_charge_number_policy", + "pilotUserChargeNumberPolicy", + str, + is_required=True, + ), + E("call_forwarding_always_action", "callForwardingAlwaysAction", str), + E( + "call_forwarding_always_forward_address", + "callForwardingAlwaysForwardAddress", + str, + ), + E( + "call_forwarding_always_reroute_trunk_group_key", + "callForwardingAlwaysRerouteTrunkGroupKey", + TrunkGroupKey, + is_complex=True, + ), + E("peering_domain", "peeringDomain", str), + E( + "route_to_peering_domain", + "routeToPeeringDomain", + bool, + is_required=True, + ), + E("prefix_enabled", "prefixEnabled", bool, is_required=True), + E("prefix", "prefix", str), + E( + "stateful_rerouting_enabled", + "statefulReroutingEnabled", + bool, + is_required=True, + ), + E( + "send_continuous_options_message", + "sendContinuousOptionsMessage", + bool, + is_required=True, + ), + E( + "continuous_options_sending_interval_seconds", + "continuousOptionsSendingIntervalSeconds", + int, + is_required=True, + ), + E( + "failure_options_sending_interval_seconds", + "failureOptionsSendingIntervalSeconds", + int, + is_required=True, + ), + E( + "failure_threshold_counter", + "failureThresholdCounter", + int, + is_required=True, + ), + E( + "success_threshold_counter", + "successThresholdCounter", + int, + is_required=True, + ), + E( + "invite_failure_threshold_counter", + "inviteFailureThresholdCounter", + int, + is_required=True, + ), + E( + "invite_failure_threshold_window_seconds", + "inviteFailureThresholdWindowSeconds", + int, + is_required=True, + ), + E("trunk_group_state", "trunkGroupState", str, is_required=True), + E( + "pilot_user_calling_line_asserted_identity_policy", + "pilotUserCallingLineAssertedIdentityPolicy", + str, + is_required=True, + ), + E( + "use_system_calling_line_asserted_identity_policy", + "useSystemCallingLineAssertedIdentityPolicy", bool, is_required=True, ), - E("use_domain", "useDomain", bool, is_required=True), - E("is_pilot_user", "isPilotUser", bool, is_required=True), ) -class TrunkGroupDeviceMultipleContactEndpointAdd(OCIType): +class GroupTrunkGroupGetInstanceResponse19sp1V2(OCIType): """ - Trunk group device endpoint used in the context of modify that can have multiple - contacts. + Response to GroupTrunkGroupGetInstanceRequest19sp1V2. + Returns the profile information for the Trunk Group. Contains a hosted user table + with column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name", + "Hiragana First Name", "Phone Number", "Extension", "Department", "Email Address". + Replaced by: `GroupTrunkGroupGetInstanceResponse20sp1()` Attributes: - name (str): name - line_port (str): linePort - contact (List[str]): contact *Optional* + pilot_user_id (str): pilotUserId *Optional* + department (department): department *Optional* + access_device (accessDevice): accessDevice *Optional* + max_active_calls (int): maxActiveCalls + max_incoming_calls (int): maxIncomingCalls *Optional* + max_outgoing_calls (int): maxOutgoingCalls *Optional* + enable_bursting (bool): enableBursting + bursting_max_active_calls (int): burstingMaxActiveCalls *Optional* + bursting_max_incoming_calls (int): burstingMaxIncomingCalls *Optional* + bursting_max_outgoing_calls (int): burstingMaxOutgoingCalls *Optional* + capacity_exceeded_action (str): capacityExceededAction *Optional* + capacity_exceeded_forward_address (str): capacityExceededForwardAddress *Optional* + capacity_exceeded_reroute_trunk_group_key (capacityExceededRerouteTrunkGroupKey): + capacityExceededRerouteTrunkGroupKey *Optional* + capacity_exceeded_trap_initial_calls (int): capacityExceededTrapInitialCalls + capacity_exceeded_trap_offset_calls (int): capacityExceededTrapOffsetCalls + unreachable_destination_action (str): unreachableDestinationAction *Optional* + unreachable_destination_forward_address (str): + unreachableDestinationForwardAddress *Optional* + unreachable_destination_reroute_trunk_group_key + (unreachableDestinationRerouteTrunkGroupKey): + unreachableDestinationRerouteTrunkGroupKey *Optional* + invitation_timeout (int): invitationTimeout + require_authentication (bool): requireAuthentication + sip_authentication_user_name (str): sipAuthenticationUserName *Optional* + hosted_user_table (List(hostedUserTable)): hostedUserTable - *Table* array of + hostedUserTable named tuples *Optional* + trunk_group_identity (str): trunkGroupIdentity *Optional* + otg_dtg_identity (str): otgDtgIdentity *Optional* + allow_termination_to_trunk_group_identity (bool): + allowTerminationToTrunkGroupIdentity + allow_termination_to_dtg_identity (bool): allowTerminationToDtgIdentity + include_trunk_group_identity (bool): includeTrunkGroupIdentity + include_dtg_identity (bool): includeDtgIdentity + include_trunk_group_identity_for_network_calls (bool): + includeTrunkGroupIdentityForNetworkCalls + include_otg_identity_for_network_calls (bool): includeOtgIdentityForNetworkCalls + enable_network_address_identity (bool): enableNetworkAddressIdentity + allow_unscreened_calls (bool): allowUnscreenedCalls + allow_unscreened_emergency_calls (bool): allowUnscreenedEmergencyCalls + pilot_user_calling_line_identity_for_external_calls_policy (str): + pilotUserCallingLineIdentityForExternalCallsPolicy + pilot_user_charge_number_policy (str): pilotUserChargeNumberPolicy + call_forwarding_always_action (str): callForwardingAlwaysAction *Optional* + call_forwarding_always_forward_address (str): callForwardingAlwaysForwardAddress + *Optional* + call_forwarding_always_reroute_trunk_group_key + (callForwardingAlwaysRerouteTrunkGroupKey): + callForwardingAlwaysRerouteTrunkGroupKey *Optional* + peering_domain (str): peeringDomain *Optional* + route_to_peering_domain (bool): routeToPeeringDomain + prefix_enabled (bool): prefixEnabled + prefix (str): prefix *Optional* + stateful_rerouting_enabled (bool): statefulReroutingEnabled + send_continuous_options_message (bool): sendContinuousOptionsMessage + continuous_options_sending_interval_seconds (int): + continuousOptionsSendingIntervalSeconds + failure_options_sending_interval_seconds (int): + failureOptionsSendingIntervalSeconds + failure_threshold_counter (int): failureThresholdCounter + success_threshold_counter (int): successThresholdCounter + invite_failure_threshold_counter (int): inviteFailureThresholdCounter + invite_failure_threshold_window_seconds (int): inviteFailureThresholdWindowSeconds + trunk_group_state (str): trunkGroupState + pilot_user_calling_line_asserted_identity_policy (str): + pilotUserCallingLineAssertedIdentityPolicy + use_system_calling_line_asserted_identity_policy (bool): + useSystemCallingLineAssertedIdentityPolicy + total_active_incoming_calls (int): totalActiveIncomingCalls + total_active_outgoing_calls (int): totalActiveOutgoingCalls + pilot_user_call_optimization_policy (str): pilotUserCallOptimizationPolicy + clid_source_for_screened_calls_policy (str): clidSourceForScreenedCallsPolicy + use_system_clid_source_for_screened_calls_policy (bool): + useSystemCLIDSourceForScreenedCallsPolicy + user_lookup_policy (str): userLookupPolicy + use_system_user_lookup_policy (bool): useSystemUserLookupPolicy + pilot_user_calling_line_identity_for_emergency_calls_policy (str): + pilotUserCallingLineIdentityForEmergencyCallsPolicy """ __slots__: List[str] = [ - "name", - "line_port", - "contact", + "pilot_user_id", + "department", + "access_device", + "max_active_calls", + "max_incoming_calls", + "max_outgoing_calls", + "enable_bursting", + "bursting_max_active_calls", + "bursting_max_incoming_calls", + "bursting_max_outgoing_calls", + "capacity_exceeded_action", + "capacity_exceeded_forward_address", + "capacity_exceeded_reroute_trunk_group_key", + "capacity_exceeded_trap_initial_calls", + "capacity_exceeded_trap_offset_calls", + "unreachable_destination_action", + "unreachable_destination_forward_address", + "unreachable_destination_reroute_trunk_group_key", + "invitation_timeout", + "require_authentication", + "sip_authentication_user_name", + "hosted_user_table", + "trunk_group_identity", + "otg_dtg_identity", + "allow_termination_to_trunk_group_identity", + "allow_termination_to_dtg_identity", + "include_trunk_group_identity", + "include_dtg_identity", + "include_trunk_group_identity_for_network_calls", + "include_otg_identity_for_network_calls", + "enable_network_address_identity", + "allow_unscreened_calls", + "allow_unscreened_emergency_calls", + "pilot_user_calling_line_identity_for_external_calls_policy", + "pilot_user_charge_number_policy", + "call_forwarding_always_action", + "call_forwarding_always_forward_address", + "call_forwarding_always_reroute_trunk_group_key", + "peering_domain", + "route_to_peering_domain", + "prefix_enabled", + "prefix", + "stateful_rerouting_enabled", + "send_continuous_options_message", + "continuous_options_sending_interval_seconds", + "failure_options_sending_interval_seconds", + "failure_threshold_counter", + "success_threshold_counter", + "invite_failure_threshold_counter", + "invite_failure_threshold_window_seconds", + "trunk_group_state", + "pilot_user_calling_line_asserted_identity_policy", + "use_system_calling_line_asserted_identity_policy", + "total_active_incoming_calls", + "total_active_outgoing_calls", + "pilot_user_call_optimization_policy", + "clid_source_for_screened_calls_policy", + "use_system_clid_source_for_screened_calls_policy", + "user_lookup_policy", + "use_system_user_lookup_policy", + "pilot_user_calling_line_identity_for_emergency_calls_policy", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("name", "name", str, is_required=True), - E("line_port", "linePort", str, is_required=True), - E("contact", "contact", str, is_array=True), - ) - - -class TrunkGroupDeviceMultipleContactEndpointRead(OCIType): - """ - Trunk group device endpoint that can have multiple contacts. - - - Attributes: - name (str): name - line_port (str): linePort - contact (List[str]): contact *Optional* - static_registration_capable (bool): staticRegistrationCapable - use_domain (bool): useDomain - is_pilot_user (bool): isPilotUser - """ - - __slots__: List[str] = [ - "name", - "line_port", - "contact", - "static_registration_capable", - "use_domain", - "is_pilot_user", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("name", "name", str, is_required=True), - E("line_port", "linePort", str, is_required=True), - E("contact", "contact", str, is_array=True), + E("pilot_user_id", "pilotUserId", str), + E("department", "department", DepartmentKey, is_complex=True), + E("access_device", "accessDevice", AccessDevice, is_complex=True), + E("max_active_calls", "maxActiveCalls", int, is_required=True), + E("max_incoming_calls", "maxIncomingCalls", int), + E("max_outgoing_calls", "maxOutgoingCalls", int), + E("enable_bursting", "enableBursting", bool, is_required=True), + E("bursting_max_active_calls", "burstingMaxActiveCalls", int), + E("bursting_max_incoming_calls", "burstingMaxIncomingCalls", int), + E("bursting_max_outgoing_calls", "burstingMaxOutgoingCalls", int), + E("capacity_exceeded_action", "capacityExceededAction", str), E( - "static_registration_capable", - "staticRegistrationCapable", + "capacity_exceeded_forward_address", + "capacityExceededForwardAddress", + str, + ), + E( + "capacity_exceeded_reroute_trunk_group_key", + "capacityExceededRerouteTrunkGroupKey", + TrunkGroupKey, + is_complex=True, + ), + E( + "capacity_exceeded_trap_initial_calls", + "capacityExceededTrapInitialCalls", + int, + is_required=True, + ), + E( + "capacity_exceeded_trap_offset_calls", + "capacityExceededTrapOffsetCalls", + int, + is_required=True, + ), + E("unreachable_destination_action", "unreachableDestinationAction", str), + E( + "unreachable_destination_forward_address", + "unreachableDestinationForwardAddress", + str, + ), + E( + "unreachable_destination_reroute_trunk_group_key", + "unreachableDestinationRerouteTrunkGroupKey", + TrunkGroupKey, + is_complex=True, + ), + E("invitation_timeout", "invitationTimeout", int, is_required=True), + E( + "require_authentication", + "requireAuthentication", bool, is_required=True, ), - E("use_domain", "useDomain", bool, is_required=True), - E("is_pilot_user", "isPilotUser", bool, is_required=True), + E("sip_authentication_user_name", "sipAuthenticationUserName", str), + E( + "hosted_user_table", + "hostedUserTable", + list, + is_complex=True, + is_table=True, + ), + E("trunk_group_identity", "trunkGroupIdentity", str), + E("otg_dtg_identity", "otgDtgIdentity", str), + E( + "allow_termination_to_trunk_group_identity", + "allowTerminationToTrunkGroupIdentity", + bool, + is_required=True, + ), + E( + "allow_termination_to_dtg_identity", + "allowTerminationToDtgIdentity", + bool, + is_required=True, + ), + E( + "include_trunk_group_identity", + "includeTrunkGroupIdentity", + bool, + is_required=True, + ), + E("include_dtg_identity", "includeDtgIdentity", bool, is_required=True), + E( + "include_trunk_group_identity_for_network_calls", + "includeTrunkGroupIdentityForNetworkCalls", + bool, + is_required=True, + ), + E( + "include_otg_identity_for_network_calls", + "includeOtgIdentityForNetworkCalls", + bool, + is_required=True, + ), + E( + "enable_network_address_identity", + "enableNetworkAddressIdentity", + bool, + is_required=True, + ), + E("allow_unscreened_calls", "allowUnscreenedCalls", bool, is_required=True), + E( + "allow_unscreened_emergency_calls", + "allowUnscreenedEmergencyCalls", + bool, + is_required=True, + ), + E( + "pilot_user_calling_line_identity_for_external_calls_policy", + "pilotUserCallingLineIdentityForExternalCallsPolicy", + str, + is_required=True, + ), + E( + "pilot_user_charge_number_policy", + "pilotUserChargeNumberPolicy", + str, + is_required=True, + ), + E("call_forwarding_always_action", "callForwardingAlwaysAction", str), + E( + "call_forwarding_always_forward_address", + "callForwardingAlwaysForwardAddress", + str, + ), + E( + "call_forwarding_always_reroute_trunk_group_key", + "callForwardingAlwaysRerouteTrunkGroupKey", + TrunkGroupKey, + is_complex=True, + ), + E("peering_domain", "peeringDomain", str), + E( + "route_to_peering_domain", + "routeToPeeringDomain", + bool, + is_required=True, + ), + E("prefix_enabled", "prefixEnabled", bool, is_required=True), + E("prefix", "prefix", str), + E( + "stateful_rerouting_enabled", + "statefulReroutingEnabled", + bool, + is_required=True, + ), + E( + "send_continuous_options_message", + "sendContinuousOptionsMessage", + bool, + is_required=True, + ), + E( + "continuous_options_sending_interval_seconds", + "continuousOptionsSendingIntervalSeconds", + int, + is_required=True, + ), + E( + "failure_options_sending_interval_seconds", + "failureOptionsSendingIntervalSeconds", + int, + is_required=True, + ), + E( + "failure_threshold_counter", + "failureThresholdCounter", + int, + is_required=True, + ), + E( + "success_threshold_counter", + "successThresholdCounter", + int, + is_required=True, + ), + E( + "invite_failure_threshold_counter", + "inviteFailureThresholdCounter", + int, + is_required=True, + ), + E( + "invite_failure_threshold_window_seconds", + "inviteFailureThresholdWindowSeconds", + int, + is_required=True, + ), + E("trunk_group_state", "trunkGroupState", str, is_required=True), + E( + "pilot_user_calling_line_asserted_identity_policy", + "pilotUserCallingLineAssertedIdentityPolicy", + str, + is_required=True, + ), + E( + "use_system_calling_line_asserted_identity_policy", + "useSystemCallingLineAssertedIdentityPolicy", + bool, + is_required=True, + ), + E( + "total_active_incoming_calls", + "totalActiveIncomingCalls", + int, + is_required=True, + ), + E( + "total_active_outgoing_calls", + "totalActiveOutgoingCalls", + int, + is_required=True, + ), + E( + "pilot_user_call_optimization_policy", + "pilotUserCallOptimizationPolicy", + str, + is_required=True, + ), + E( + "clid_source_for_screened_calls_policy", + "clidSourceForScreenedCallsPolicy", + str, + is_required=True, + ), + E( + "use_system_clid_source_for_screened_calls_policy", + "useSystemCLIDSourceForScreenedCallsPolicy", + bool, + is_required=True, + ), + E("user_lookup_policy", "userLookupPolicy", str, is_required=True), + E( + "use_system_user_lookup_policy", + "useSystemUserLookupPolicy", + bool, + is_required=True, + ), + E( + "pilot_user_calling_line_identity_for_emergency_calls_policy", + "pilotUserCallingLineIdentityForEmergencyCallsPolicy", + str, + is_required=True, + ), ) -class TrunkGroupKey(OCIType): +class GroupTrunkGroupModifyInstanceRequest14sp9A(OCIType): """ - Uniquely identifies a Trunk Group system-wide. + Modify a Trunk Group Instance in a group. - The trunkGroupName is unique within a group, but not unique system-wide. + The access device cannot be modified or cleared if there are any users assigned to the + Trunk Group. + + The response is either a `SuccessResponse()` or an `ErrorResponse()`. Attributes: - service_provider_id (str): serviceProviderId - group_id (str): groupId - name (str): name + trunk_group_key (trunkGroupKey): trunkGroupKey + new_name (str): newName *Optional* + pilot_user_id (str): pilotUserId *Optional* + department (department): department *Optional* + access_device (accessDevice): accessDevice *Optional* + max_active_calls (int): maxActiveCalls *Optional* + max_incoming_calls (int): maxIncomingCalls *Optional* + max_outgoing_calls (int): maxOutgoingCalls *Optional* + enable_bursting (bool): enableBursting *Optional* + bursting_max_active_calls (int): burstingMaxActiveCalls *Optional* + bursting_max_incoming_calls (int): burstingMaxIncomingCalls *Optional* + bursting_max_outgoing_calls (int): burstingMaxOutgoingCalls *Optional* + capacity_exceeded_action (str): capacityExceededAction *Optional* + capacity_exceeded_forward_address (str): capacityExceededForwardAddress *Optional* + capacity_exceeded_reroute_trunk_group_key (capacityExceededRerouteTrunkGroupKey): + capacityExceededRerouteTrunkGroupKey *Optional* + capacity_exceeded_trap_initial_calls (int): capacityExceededTrapInitialCalls + *Optional* + capacity_exceeded_trap_offset_calls (int): capacityExceededTrapOffsetCalls + *Optional* + unreachable_destination_action (str): unreachableDestinationAction *Optional* + unreachable_destination_forward_address (str): + unreachableDestinationForwardAddress *Optional* + unreachable_destination_reroute_trunk_group_key + (unreachableDestinationRerouteTrunkGroupKey): + unreachableDestinationRerouteTrunkGroupKey *Optional* + unreachable_destination_trap_initial_calls (int): + unreachableDestinationTrapInitialCalls *Optional* + unreachable_destination_trap_offset_calls (int): + unreachableDestinationTrapOffsetCalls *Optional* + invitation_timeout (int): invitationTimeout *Optional* + require_authentication (bool): requireAuthentication *Optional* + sip_authentication_user_name (str): sipAuthenticationUserName *Optional* + sip_authentication_password (str): sipAuthenticationPassword *Optional* + hosted_user_id_list (hostedUserIdList): hostedUserIdList *Optional* + trunk_group_identity (str): trunkGroupIdentity *Optional* + otg_dtg_identity (str): otgDtgIdentity *Optional* + include_trunk_group_identity (bool): includeTrunkGroupIdentity *Optional* + include_dtg_identity (bool): includeDtgIdentity *Optional* + enable_network_address_identity (bool): enableNetworkAddressIdentity *Optional* + allow_unscreened_calls (bool): allowUnscreenedCalls *Optional* + allow_unscreened_emergency_calls (bool): allowUnscreenedEmergencyCalls *Optional* + pilot_user_calling_line_identity_policy (str): pilotUserCallingLineIdentityPolicy + *Optional* + pilot_user_charge_number_policy (str): pilotUserChargeNumberPolicy *Optional* + call_forwarding_always_action (str): callForwardingAlwaysAction *Optional* + call_forwarding_always_forward_address (str): callForwardingAlwaysForwardAddress + *Optional* + call_forwarding_always_reroute_trunk_group_key + (callForwardingAlwaysRerouteTrunkGroupKey): + callForwardingAlwaysRerouteTrunkGroupKey *Optional* """ __slots__: List[str] = [ - "service_provider_id", - "group_id", - "name", + "trunk_group_key", + "new_name", + "pilot_user_id", + "department", + "access_device", + "max_active_calls", + "max_incoming_calls", + "max_outgoing_calls", + "enable_bursting", + "bursting_max_active_calls", + "bursting_max_incoming_calls", + "bursting_max_outgoing_calls", + "capacity_exceeded_action", + "capacity_exceeded_forward_address", + "capacity_exceeded_reroute_trunk_group_key", + "capacity_exceeded_trap_initial_calls", + "capacity_exceeded_trap_offset_calls", + "unreachable_destination_action", + "unreachable_destination_forward_address", + "unreachable_destination_reroute_trunk_group_key", + "unreachable_destination_trap_initial_calls", + "unreachable_destination_trap_offset_calls", + "invitation_timeout", + "require_authentication", + "sip_authentication_user_name", + "sip_authentication_password", + "hosted_user_id_list", + "trunk_group_identity", + "otg_dtg_identity", + "include_trunk_group_identity", + "include_dtg_identity", + "enable_network_address_identity", + "allow_unscreened_calls", + "allow_unscreened_emergency_calls", + "pilot_user_calling_line_identity_policy", + "pilot_user_charge_number_policy", + "call_forwarding_always_action", + "call_forwarding_always_forward_address", + "call_forwarding_always_reroute_trunk_group_key", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("service_provider_id", "serviceProviderId", str, is_required=True), - E("group_id", "groupId", str, is_required=True), - E("name", "name", str, is_required=True), + E( + "trunk_group_key", + "trunkGroupKey", + TrunkGroupKey, + is_complex=True, + is_required=True, + ), + E("new_name", "newName", str), + E("pilot_user_id", "pilotUserId", str), + E("department", "department", DepartmentKey, is_complex=True), + E("access_device", "accessDevice", AccessDevice, is_complex=True), + E("max_active_calls", "maxActiveCalls", int), + E("max_incoming_calls", "maxIncomingCalls", int), + E("max_outgoing_calls", "maxOutgoingCalls", int), + E("enable_bursting", "enableBursting", bool), + E("bursting_max_active_calls", "burstingMaxActiveCalls", int), + E("bursting_max_incoming_calls", "burstingMaxIncomingCalls", int), + E("bursting_max_outgoing_calls", "burstingMaxOutgoingCalls", int), + E("capacity_exceeded_action", "capacityExceededAction", str), + E( + "capacity_exceeded_forward_address", + "capacityExceededForwardAddress", + str, + ), + E( + "capacity_exceeded_reroute_trunk_group_key", + "capacityExceededRerouteTrunkGroupKey", + TrunkGroupKey, + is_complex=True, + ), + E( + "capacity_exceeded_trap_initial_calls", + "capacityExceededTrapInitialCalls", + int, + ), + E( + "capacity_exceeded_trap_offset_calls", + "capacityExceededTrapOffsetCalls", + int, + ), + E("unreachable_destination_action", "unreachableDestinationAction", str), + E( + "unreachable_destination_forward_address", + "unreachableDestinationForwardAddress", + str, + ), + E( + "unreachable_destination_reroute_trunk_group_key", + "unreachableDestinationRerouteTrunkGroupKey", + TrunkGroupKey, + is_complex=True, + ), + E( + "unreachable_destination_trap_initial_calls", + "unreachableDestinationTrapInitialCalls", + int, + ), + E( + "unreachable_destination_trap_offset_calls", + "unreachableDestinationTrapOffsetCalls", + int, + ), + E("invitation_timeout", "invitationTimeout", int), + E("require_authentication", "requireAuthentication", bool), + E("sip_authentication_user_name", "sipAuthenticationUserName", str), + E("sip_authentication_password", "sipAuthenticationPassword", str), + E( + "hosted_user_id_list", + "hostedUserIdList", + ReplacementUserIdList, + is_complex=True, + ), + E("trunk_group_identity", "trunkGroupIdentity", str), + E("otg_dtg_identity", "otgDtgIdentity", str), + E("include_trunk_group_identity", "includeTrunkGroupIdentity", bool), + E("include_dtg_identity", "includeDtgIdentity", bool), + E("enable_network_address_identity", "enableNetworkAddressIdentity", bool), + E("allow_unscreened_calls", "allowUnscreenedCalls", bool), + E( + "allow_unscreened_emergency_calls", + "allowUnscreenedEmergencyCalls", + bool, + ), + E( + "pilot_user_calling_line_identity_policy", + "pilotUserCallingLineIdentityPolicy", + str, + ), + E("pilot_user_charge_number_policy", "pilotUserChargeNumberPolicy", str), + E("call_forwarding_always_action", "callForwardingAlwaysAction", str), + E( + "call_forwarding_always_forward_address", + "callForwardingAlwaysForwardAddress", + str, + ), + E( + "call_forwarding_always_reroute_trunk_group_key", + "callForwardingAlwaysRerouteTrunkGroupKey", + TrunkGroupKey, + is_complex=True, + ), ) -class UnboundedNonNegativeInt(OCIType): +class IncomingCallingPlanDepartmentPermissions(OCIType): """ - Unbounded Quantity. + Allows or disallows various types of incoming calls for a specified department. - Can either be unlimited or a non-negative int quantity. Attributes: - unlimited (bool): unlimited *Optional* - quantity (int): quantity *Optional* + department_key (departmentKey): departmentKey + department_full_path_name (str): departmentFullPathName + allow_from_within_group (bool): allowFromWithinGroup + allow_from_outside_group (str): allowFromOutsideGroup + allow_collect_calls (bool): allowCollectCalls + digit_pattern_permission (List[digitPatternPermission]): digitPatternPermission + *Optional* """ __slots__: List[str] = [ - "unlimited", - "quantity", + "department_key", + "department_full_path_name", + "allow_from_within_group", + "allow_from_outside_group", + "allow_collect_calls", + "digit_pattern_permission", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("unlimited", "unlimited", bool), - E("quantity", "quantity", int), - ) - - -class UnboundedPositiveInt(OCIType): - """ - Unbounded Quantity. - - Can either be unlimited or a positive int quantity. - - Attributes: - unlimited (bool): unlimited *Optional* - quantity (int): quantity *Optional* - """ - - __slots__: List[str] = [ - "unlimited", - "quantity", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("unlimited", "unlimited", bool), - E("quantity", "quantity", int), + E( + "department_key", + "departmentKey", + DepartmentKey, + is_complex=True, + is_required=True, + ), + E( + "department_full_path_name", + "departmentFullPathName", + str, + is_required=True, + ), + E( + "allow_from_within_group", + "allowFromWithinGroup", + bool, + is_required=True, + ), + E( + "allow_from_outside_group", + "allowFromOutsideGroup", + str, + is_required=True, + ), + E("allow_collect_calls", "allowCollectCalls", bool, is_required=True), + E( + "digit_pattern_permission", + "digitPatternPermission", + IncomingCallingPlanDigitPatternPermission, + is_complex=True, + is_array=True, + ), ) -class UserBroadWorksMobilityMobileIdentityGetRequest21sp1V2(OCIType): +class IncomingCallingPlanDepartmentPermissionsModify(OCIType): """ - Get the settings for a user's specified mobile identity. + Allows or disallows various types of incoming calls for a specified department. - The response is either a UserBroadWorksMobilityMobileIdentityGetResponse21sp1V2 or an - `ErrorResponse()`. Replaced by: `UserBroadWorksMobilityMobileIdentityGetRequest22()`. + For use when modifing settings. Attributes: - user_id (str): userId - mobile_number (str): mobileNumber + department_key (departmentKey): departmentKey + allow_from_within_group (bool): allowFromWithinGroup *Optional* + allow_from_outside_group (str): allowFromOutsideGroup *Optional* + allow_collect_calls (bool): allowCollectCalls *Optional* + digit_pattern_permission (List[digitPatternPermission]): digitPatternPermission + *Optional* """ __slots__: List[str] = [ - "user_id", - "mobile_number", + "department_key", + "allow_from_within_group", + "allow_from_outside_group", + "allow_collect_calls", + "digit_pattern_permission", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("user_id", "userId", str, is_required=True), - E("mobile_number", "mobileNumber", str, is_required=True), + E( + "department_key", + "departmentKey", + DepartmentKey, + is_complex=True, + is_required=True, + ), + E("allow_from_within_group", "allowFromWithinGroup", bool), + E("allow_from_outside_group", "allowFromOutsideGroup", str), + E("allow_collect_calls", "allowCollectCalls", bool), + E( + "digit_pattern_permission", + "digitPatternPermission", + IncomingCallingPlanDigitPatternPermission, + is_complex=True, + is_array=True, + ), ) -class UserDNExtension(OCIType): +class IncomingCallingPlanPermissions(OCIType): """ - User's DN and extension. + Allows or disallows various types of incoming calls for a user or group -- not any + particular department. - Used in SearchCriteriaComposedOrDnExtension when either a DN or an extension can be - used as a search criteria. Attributes: - dn (str): dn *Optional* - extension (str): extension *Optional* + allow_from_within_group (bool): allowFromWithinGroup + allow_from_outside_group (str): allowFromOutsideGroup + allow_collect_calls (bool): allowCollectCalls + digit_pattern_permission (List[digitPatternPermission]): digitPatternPermission + *Optional* """ __slots__: List[str] = [ - "dn", - "extension", + "allow_from_within_group", + "allow_from_outside_group", + "allow_collect_calls", + "digit_pattern_permission", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("dn", "dn", str), - E("extension", "extension", str), + E( + "allow_from_within_group", + "allowFromWithinGroup", + bool, + is_required=True, + ), + E( + "allow_from_outside_group", + "allowFromOutsideGroup", + str, + is_required=True, + ), + E("allow_collect_calls", "allowCollectCalls", bool, is_required=True), + E( + "digit_pattern_permission", + "digitPatternPermission", + IncomingCallingPlanDigitPatternPermission, + is_complex=True, + is_array=True, + ), ) -class UserDisplayNames(OCIType): +class IncomingCallingPlanPermissionsModify(OCIType): """ - The parts of a user's display name that a client can display in whatever way is - appropriate for the client application. + Allows or disallows various types of incoming calls for a user or group -- not any + particular department. + For use when modifing settings. Attributes: - last_name (str): lastName - first_name (str): firstName - hiragana_last_name (str): hiraganaLastName *Optional* - hiragana_first_name (str): hiraganaFirstName *Optional* + allow_from_within_group (bool): allowFromWithinGroup *Optional* + allow_from_outside_group (str): allowFromOutsideGroup *Optional* + allow_collect_calls (bool): allowCollectCalls *Optional* + digit_pattern_permission (List[digitPatternPermission]): digitPatternPermission + *Optional* """ __slots__: List[str] = [ - "last_name", - "first_name", - "hiragana_last_name", - "hiragana_first_name", + "allow_from_within_group", + "allow_from_outside_group", + "allow_collect_calls", + "digit_pattern_permission", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("last_name", "lastName", str, is_required=True), - E("first_name", "firstName", str, is_required=True), - E("hiragana_last_name", "hiraganaLastName", str), - E("hiragana_first_name", "hiraganaFirstName", str), + E("allow_from_within_group", "allowFromWithinGroup", bool), + E("allow_from_outside_group", "allowFromOutsideGroup", str), + E("allow_collect_calls", "allowCollectCalls", bool), + E( + "digit_pattern_permission", + "digitPatternPermission", + IncomingCallingPlanDigitPatternPermission, + is_complex=True, + is_array=True, + ), ) -class UserEndpointKey(OCIType): +class MWIDeliveryToMobileEndpointTemplateBody(OCIType): """ - Key to uniquely identify a user endpoint. + MWI Delivery To Mobile Endpoint template body. Attributes: - user_id (str): userId - line_port (str): linePort + line (List[line]): line """ __slots__: List[str] = [ - "user_id", - "line_port", + "line", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("user_id", "userId", str, is_required=True), - E("line_port", "linePort", str, is_required=True), + E( + "line", + "line", + MWIDeliveryToMobileEndpointTemplateLine, + is_complex=True, + is_required=True, + is_array=True, + ), ) -class UserEnhancedCallLogsGetListResponse17sp4V2(OCIType): +class OutgoingCallingPlanCallMeNowDepartmentPermissions(OCIType): """ - Response to UserEnhancedCallLogsGetListRequest17sp4V2. + Outgoing Calling Plan for Call Me Now call permissions for a department. - Total numbers of rows is: - the total number of retrievable logs of the call log type - that was specified in the UserEnhancedCallLogsGetListRequest17sp4V2, if a call log - type was specified in the request. - the total number of retrievable logs, if no call - log type was specified in the request. A list of MixedCallLogsEntry will be returned - if the call logs are stored on CDS A list of ExtendedMixedCallLogsEntry17sp4 will be - returned if the call logs are stored on DBS The logs are sorted by date/time of the - call. Attributes: - total_number_of_rows (int): totalNumberOfRows - legacy_entry (legacyEntry): legacyEntry *Optional* - extended_entry (extendedEntry): extendedEntry *Optional* + department_key (departmentKey): departmentKey + department_name (str): departmentName + permissions (permissions): permissions """ __slots__: List[str] = [ - "total_number_of_rows", - "legacy_entry", - "extended_entry", + "department_key", + "department_name", + "permissions", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("total_number_of_rows", "totalNumberOfRows", int, is_required=True), - E("legacy_entry", "legacyEntry", str, is_complex=True), # unknown - E("extended_entry", "extendedEntry", str, is_complex=True), # unknown + E( + "department_key", + "departmentKey", + DepartmentKey, + is_complex=True, + is_required=True, + ), + E("department_name", "departmentName", str, is_required=True), + E( + "permissions", + "permissions", + OutgoingCallingPlanCallMeNowPermissions, + is_complex=True, + is_required=True, + ), ) -class UserEnhancedCallLogsGetListResponse21sp1V2(OCIType): +class OutgoingCallingPlanCallMeNowDepartmentPermissionsModify(OCIType): """ - Response to UserEnhancedCallLogsGetListRequest21sp1V2. + Modify outgoing Calling Plan for Call Me Now call permissions for a department. - Total numbers of rows is: - the total number of retrievable logs of the call log type - that was specified in the UserEnhancedCallLogsGetListRequest21sp1V2, if a call log - type was specified in the request. - the total number of retrievable logs, if no call - log type was specified in the request. A list of MixedCallLogsEntry will be returned - if the call logs are stored on CDS A list of ExtendedMixedCallLogsEntry21sp1V2 will be - returned if the call logs are stored on DBS The logs are sorted by date/time of the - call. Attributes: - total_number_of_rows (int): totalNumberOfRows - legacy_entry (legacyEntry): legacyEntry *Optional* - extended_entry (extendedEntry): extendedEntry *Optional* + department_key (departmentKey): departmentKey + permissions (permissions): permissions """ __slots__: List[str] = [ - "total_number_of_rows", - "legacy_entry", - "extended_entry", + "department_key", + "permissions", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("total_number_of_rows", "totalNumberOfRows", int, is_required=True), - E("legacy_entry", "legacyEntry", str, is_complex=True), # unknown - E("extended_entry", "extendedEntry", str, is_complex=True), # unknown + E( + "department_key", + "departmentKey", + DepartmentKey, + is_complex=True, + is_required=True, + ), + E( + "permissions", + "permissions", + OutgoingCallingPlanCallMeNowPermissionsModify, + is_complex=True, + is_required=True, + ), ) -class UserFeatureAccessCodeModifyEntry(OCIType): +class OutgoingCallingPlanDepartmentAuthorizationCodes(OCIType): """ - Feature Access Code Entry to be used in all user modify command. + Outgoing Calling Plan Authorization Code for a department. Attributes: - feature_access_code_name (str): featureAccessCodeName - enable_fac (bool): enableFAC *Optional* + department_key (departmentKey): departmentKey + department_name (str): departmentName + code_entry (List[codeEntry]): codeEntry *Optional* """ __slots__: List[str] = [ - "feature_access_code_name", - "enable_fac", + "department_key", + "department_name", + "code_entry", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( E( - "feature_access_code_name", - "featureAccessCodeName", - str, + "department_key", + "departmentKey", + DepartmentKey, + is_complex=True, is_required=True, ), - E("enable_fac", "enableFAC", bool), + E("department_name", "departmentName", str, is_required=True), + E( + "code_entry", + "codeEntry", + OutgoingCallingPlanAuthorizationCodeEntry, + is_complex=True, + is_array=True, + ), ) -class UserGetRequest21sp1V2(OCIType): +class OutgoingCallingPlanDepartmentTransferNumbers(OCIType): """ - Request to get the user information. + Outgoing Calling Plan transfer numbers for a department. - The response is either UserGetResponse21sp1V2 or `ErrorResponse()`. Replaced by - `UserGetRequest22V3()` in AS data mode Attributes: - user_id (str): userId + department_key (departmentKey): departmentKey + department_name (str): departmentName + transfer_numbers (transferNumbers): transferNumbers """ __slots__: List[str] = [ - "user_id", + "department_key", + "department_name", + "transfer_numbers", ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return (E("user_id", "userId", str, is_required=True),) + return ( + E( + "department_key", + "departmentKey", + DepartmentKey, + is_complex=True, + is_required=True, + ), + E("department_name", "departmentName", str, is_required=True), + E( + "transfer_numbers", + "transferNumbers", + OutgoingCallingPlanTransferNumbers, + is_complex=True, + is_required=True, + ), + ) -class UserMoveMessage(OCIType): +class OutgoingCallingPlanDepartmentTransferNumbersModify(OCIType): """ - The message describes the impact made when moving a user from one group to another - group within the enterprise. + Outgoing Calling Plan transfer numbers for a department. - The message could also contain the error condition that prevents the user move. Attributes: - message_code (int): messageCode - summary (str): summary - summary_english (str): summaryEnglish + department_key (departmentKey): departmentKey + transfer_numbers (transferNumbers): transferNumbers *Optional* """ __slots__: List[str] = [ - "message_code", - "summary", - "summary_english", + "department_key", + "transfer_numbers", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("message_code", "messageCode", int, is_required=True), - E("summary", "summary", str, is_required=True), - E("summary_english", "summaryEnglish", str, is_required=True), + E( + "department_key", + "departmentKey", + DepartmentKey, + is_complex=True, + is_required=True, + ), + E( + "transfer_numbers", + "transferNumbers", + OutgoingCallingPlanTransferNumbersModify, + is_complex=True, + ), ) -class UserPreferredCarrierName(OCIType): +class OutgoingCallingPlanDigitPatternCallMeNowPermissions(OCIType): """ - User can either use it's group's preferred carrier or use it's own. + Outgoing Calling Plan Call Me Now call permissions for specified digit patterns. - The user carrier name is exposed if it was previously configured. Attributes: - use_group_preferred_carrier (bool): useGroupPreferredCarrier - carrier (str): carrier *Optional* + digit_pattern_permissions (List[digitPatternPermissions]): digitPatternPermissions """ __slots__: List[str] = [ - "use_group_preferred_carrier", - "carrier", + "digit_pattern_permissions", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( E( - "use_group_preferred_carrier", - "useGroupPreferredCarrier", - bool, + "digit_pattern_permissions", + "digitPatternPermissions", + OutgoingCallingPlanDigitPatternCallMeNowPermission, + is_complex=True, is_required=True, + is_array=True, ), - E("carrier", "carrier", str), ) -class UserPreferredCarrierNameModify(OCIType): +class OutgoingCallingPlanDigitPatternOriginatingPermissions(OCIType): """ - User can either use it's group's preferred carrier or use it's own. + Outgoing Calling Plan originating call permissions for specified digit patterns. - You can use the group's preferred carrier without clearing the user carrier name -- in - this case, the user carrier name is retained. Attributes: - use_group_preferred_carrier (bool): useGroupPreferredCarrier - carrier (str): carrier *Optional* + digit_pattern_permissions (List[digitPatternPermissions]): digitPatternPermissions """ __slots__: List[str] = [ - "use_group_preferred_carrier", - "carrier", + "digit_pattern_permissions", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( E( - "use_group_preferred_carrier", - "useGroupPreferredCarrier", - bool, + "digit_pattern_permissions", + "digitPatternPermissions", + OutgoingCallingPlanDigitPatternOriginatingPermission, + is_complex=True, is_required=True, + is_array=True, ), - E("carrier", "carrier", str), ) -class UserTwoStageDialingGetRequest13Mp20(OCIType): +class OutgoingCallingPlanDigitPatternRedirectingPermissions(OCIType): """ - Request the user level data associated with Two Stage Dialing. + Outgoing Calling Plan redirecting call permissions for specified digit patterns. - The response is either a UserTwoStageDialingGetResponse13Mp20 or an `ErrorResponse()`. Attributes: - user_id (str): userId + digit_pattern_permissions (List[digitPatternPermissions]): digitPatternPermissions """ __slots__: List[str] = [ - "user_id", + "digit_pattern_permissions", ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return (E("user_id", "userId", str, is_required=True),) + return ( + E( + "digit_pattern_permissions", + "digitPatternPermissions", + OutgoingCallingPlanDigitPatternRedirectingPermission, + is_complex=True, + is_required=True, + is_array=True, + ), + ) -class UserTwoStageDialingGetResponse13Mp20(OCIType): +class OutgoingCallingPlanGroupAuthorizationCodes(OCIType): """ - Response to UserTwoStageDialingGetRequest13Mp20. + Outgoing Calling Plan Authorization Code for the group default. Attributes: - is_active (bool): isActive - allow_activation_with_user_addresses (bool): allowActivationWithUserAddresses + code_entry (List[codeEntry]): codeEntry *Optional* """ __slots__: List[str] = [ - "is_active", - "allow_activation_with_user_addresses", + "code_entry", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("is_active", "isActive", bool, is_required=True), E( - "allow_activation_with_user_addresses", - "allowActivationWithUserAddresses", - bool, - is_required=True, + "code_entry", + "codeEntry", + OutgoingCallingPlanAuthorizationCodeEntry, + is_complex=True, + is_array=True, ), ) -class VerifyTranslationAndRoutingOrigination(OCIType): +class OutgoingCallingPlanOriginatingDepartmentPermissions(OCIType): """ - Verification Translation and Routing origination value. + Outgoing Calling Plan originating call permissions for a department. Attributes: - line_port (str): linePort *Optional* - phone (str): phone *Optional* - user_id (str): userId *Optional* - url (str): url *Optional* + department_key (departmentKey): departmentKey + department_name (str): departmentName + permissions (permissions): permissions """ __slots__: List[str] = [ - "line_port", - "phone", - "user_id", - "url", + "department_key", + "department_name", + "permissions", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("line_port", "linePort", str), - E("phone", "phone", str), - E("user_id", "userId", str), - E("url", "url", str), + E( + "department_key", + "departmentKey", + DepartmentKey, + is_complex=True, + is_required=True, + ), + E("department_name", "departmentName", str, is_required=True), + E( + "permissions", + "permissions", + OutgoingCallingPlanOriginatingPermissions, + is_complex=True, + is_required=True, + ), ) -class VirtualOnNetUser(OCIType): +class OutgoingCallingPlanOriginatingDepartmentPermissionsModify(OCIType): """ - Virtual On-Net User. + Outgoing Calling Plan originating call permissions for a department. Attributes: - phone_number (str): phoneNumber - extension (str): extension - first_name (str): firstName - last_name (str): lastName - calling_line_id_first_name (str): callingLineIdFirstName - calling_line_id_last_name (str): callingLineIdLastName - virtual_on_net_call_type_name (str): virtualOnNetCallTypeName + department_key (departmentKey): departmentKey + permissions (permissions): permissions *Optional* """ __slots__: List[str] = [ - "phone_number", - "extension", - "first_name", - "last_name", - "calling_line_id_first_name", - "calling_line_id_last_name", - "virtual_on_net_call_type_name", + "department_key", + "permissions", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("phone_number", "phoneNumber", str, is_required=True), - E("extension", "extension", str, is_required=True), - E("first_name", "firstName", str, is_required=True), - E("last_name", "lastName", str, is_required=True), E( - "calling_line_id_first_name", - "callingLineIdFirstName", - str, + "department_key", + "departmentKey", + DepartmentKey, + is_complex=True, is_required=True, ), E( - "calling_line_id_last_name", - "callingLineIdLastName", - str, - is_required=True, - ), - E( - "virtual_on_net_call_type_name", - "virtualOnNetCallTypeName", - str, - is_required=True, + "permissions", + "permissions", + OutgoingCallingPlanOriginatingPermissionsModify, + is_complex=True, ), ) -class VirtualOnNetUserKey(OCIType): +class OutgoingCallingPlanRedirectedDepartmentPermissions(OCIType): """ - Virtual On-Net User identifier which is the Service Provider ID, Group ID, and phone - number (in E. + Outgoing Calling Plan being forwarded/transferred permissions for a department. - 164 format). Attributes: - service_provider_id (str): serviceProviderId - group_id (str): groupId - phone_number (str): phoneNumber + department_key (departmentKey): departmentKey + department_name (str): departmentName + permissions (permissions): permissions """ __slots__: List[str] = [ - "service_provider_id", - "group_id", - "phone_number", + "department_key", + "department_name", + "permissions", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("service_provider_id", "serviceProviderId", str, is_required=True), - E("group_id", "groupId", str, is_required=True), - E("phone_number", "phoneNumber", str, is_required=True), + E( + "department_key", + "departmentKey", + DepartmentKey, + is_complex=True, + is_required=True, + ), + E("department_name", "departmentName", str, is_required=True), + E( + "permissions", + "permissions", + OutgoingCallingPlanRedirectedPermissions, + is_complex=True, + is_required=True, + ), ) -class VoiceMessagingAliasListModify(OCIType): +class OutgoingCallingPlanRedirectedDepartmentPermissionsModify(OCIType): """ - A list of dns that is added to a previously configured list. + Outgoing Calling Plan being forwarded/transferred permissions for a department. Attributes: - phone_number (List[str]): phoneNumber + department_key (departmentKey): departmentKey + permissions (permissions): permissions """ __slots__: List[str] = [ - "phone_number", + "department_key", + "permissions", ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return (E("phone_number", "phoneNumber", str, is_required=True, is_array=True),) + return ( + E( + "department_key", + "departmentKey", + DepartmentKey, + is_complex=True, + is_required=True, + ), + E( + "permissions", + "permissions", + OutgoingCallingPlanRedirectedPermissionsModify, + is_complex=True, + is_required=True, + ), + ) -class VoiceMessagingAliasReplacementList(OCIType): +class OutgoingCallingPlanRedirectingDepartmentPermissions(OCIType): """ - A list of dns that that replaces a previously configured list. + Outgoing Calling Plan initiating call forwards/transfer permissions for a department. - By convention, an element of this type may be set nil to clear the list. Attributes: - phone_number (List[str]): phoneNumber + department_key (departmentKey): departmentKey + department_name (str): departmentName + permissions (permissions): permissions """ __slots__: List[str] = [ - "phone_number", + "department_key", + "department_name", + "permissions", ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return (E("phone_number", "phoneNumber", str, is_required=True, is_array=True),) + return ( + E( + "department_key", + "departmentKey", + DepartmentKey, + is_complex=True, + is_required=True, + ), + E("department_name", "departmentName", str, is_required=True), + E( + "permissions", + "permissions", + OutgoingCallingPlanRedirectingPermissions, + is_complex=True, + is_required=True, + ), + ) -class VoiceMessagingAlternateNoAnswerGreetingRead(OCIType): +class OutgoingCallingPlanRedirectingDepartmentPermissionsModify(OCIType): """ - The configuration of a alternate no answer greeting. + Outgoing Calling Plan initiating call forwards/transfer permissions for a department. - It is used when geting a user's voice messaging greeting. Attributes: - name (str): name - audio_file (str): audioFile *Optional* - video_file (str): videoFile *Optional* + department_key (departmentKey): departmentKey + permissions (permissions): permissions """ __slots__: List[str] = [ - "name", - "audio_file", - "video_file", + "department_key", + "permissions", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("name", "name", str, is_required=True), - E("audio_file", "audioFile", str), - E("video_file", "videoFile", str), + E( + "department_key", + "departmentKey", + DepartmentKey, + is_complex=True, + is_required=True, + ), + E( + "permissions", + "permissions", + OutgoingCallingPlanRedirectingPermissionsModify, + is_complex=True, + is_required=True, + ), ) -class VoiceMessagingAlternateNoAnswerGreetingRead16(OCIType): +class OutgoingPinholeDigitPlanDigitPatternCallMeNowPermissions(OCIType): """ - The configuration of a alternate no answer greeting. + Outgoing Pinhole Digit Plan Call Me Now call permissions for specified digit patterns. - It is used when geting a user's voice messaging greeting. Attributes: - name (str): name - audio_file (str): audioFile *Optional* - audio_media_type (str): audioMediaType *Optional* - video_file (str): videoFile *Optional* - video_media_type (str): videoMediaType *Optional* + digit_pattern_permissions (List[digitPatternPermissions]): digitPatternPermissions """ __slots__: List[str] = [ - "name", - "audio_file", - "audio_media_type", - "video_file", - "video_media_type", + "digit_pattern_permissions", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("name", "name", str, is_required=True), - E("audio_file", "audioFile", str), - E("audio_media_type", "audioMediaType", str), - E("video_file", "videoFile", str), - E("video_media_type", "videoMediaType", str), + E( + "digit_pattern_permissions", + "digitPatternPermissions", + OutgoingPinholeDigitPlanDigitPatternCallMeNowPermission, + is_complex=True, + is_required=True, + is_array=True, + ), ) -class VoiceMessagingMenuKeysModifyEntry(OCIType): +class OutgoingPinholeDigitPlanDigitPatternOriginatingPermissions(OCIType): """ - The voice portal voice messaging menu keys modify entry. + Outgoing Pinhole Digit Plan originating call permissions for specified digit patterns. Attributes: - play_messages (str): playMessages *Optional* - change_busy_greeting (str): changeBusyGreeting *Optional* - change_no_answer_greeting (str): changeNoAnswerGreeting *Optional* - change_extended_away_greeting (str): changeExtendedAwayGreeting *Optional* - compose_message (str): composeMessage *Optional* - delete_all_messages (str): deleteAllMessages *Optional* - passcode (str): passcode *Optional* - personalized_name (str): personalizedName *Optional* - message_deposit (str): messageDeposit *Optional* - return_to_previous_menu (str): returnToPreviousMenu *Optional* - repeat_menu (str): repeatMenu *Optional* + digit_pattern_permissions (List[digitPatternPermissions]): digitPatternPermissions """ __slots__: List[str] = [ - "play_messages", - "change_busy_greeting", - "change_no_answer_greeting", - "change_extended_away_greeting", - "compose_message", - "delete_all_messages", - "passcode", - "personalized_name", - "message_deposit", - "return_to_previous_menu", - "repeat_menu", + "digit_pattern_permissions", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("play_messages", "playMessages", str), - E("change_busy_greeting", "changeBusyGreeting", str), - E("change_no_answer_greeting", "changeNoAnswerGreeting", str), - E("change_extended_away_greeting", "changeExtendedAwayGreeting", str), - E("compose_message", "composeMessage", str), - E("delete_all_messages", "deleteAllMessages", str), - E("passcode", "passcode", str), - E("personalized_name", "personalizedName", str), - E("message_deposit", "messageDeposit", str), - E("return_to_previous_menu", "returnToPreviousMenu", str), - E("repeat_menu", "repeatMenu", str), + E( + "digit_pattern_permissions", + "digitPatternPermissions", + OutgoingPinholeDigitPlanDigitPatternOriginatingPermission, + is_complex=True, + is_required=True, + is_array=True, + ), ) -class VoiceMessagingMenuKeysReadEntry(OCIType): +class OutgoingPinholeDigitPlanDigitPatternRedirectingPermissions(OCIType): """ - The voice portal voice messaging menu keys. + Outgoing Pinhole Digit Plan redirecting call permissions for specified digit patterns. Attributes: - play_messages (str): playMessages *Optional* - change_busy_greeting (str): changeBusyGreeting *Optional* - change_no_answer_greeting (str): changeNoAnswerGreeting *Optional* - change_extended_away_greeting (str): changeExtendedAwayGreeting *Optional* - compose_message (str): composeMessage *Optional* - delete_all_messages (str): deleteAllMessages *Optional* - passcode (str): passcode *Optional* - personalized_name (str): personalizedName *Optional* - message_deposit (str): messageDeposit *Optional* - return_to_previous_menu (str): returnToPreviousMenu - repeat_menu (str): repeatMenu *Optional* + digit_pattern_permissions (List[digitPatternPermissions]): digitPatternPermissions """ __slots__: List[str] = [ - "play_messages", - "change_busy_greeting", - "change_no_answer_greeting", - "change_extended_away_greeting", - "compose_message", - "delete_all_messages", - "passcode", - "personalized_name", - "message_deposit", - "return_to_previous_menu", - "repeat_menu", + "digit_pattern_permissions", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("play_messages", "playMessages", str), - E("change_busy_greeting", "changeBusyGreeting", str), - E("change_no_answer_greeting", "changeNoAnswerGreeting", str), - E("change_extended_away_greeting", "changeExtendedAwayGreeting", str), - E("compose_message", "composeMessage", str), - E("delete_all_messages", "deleteAllMessages", str), - E("passcode", "passcode", str), - E("personalized_name", "personalizedName", str), - E("message_deposit", "messageDeposit", str), - E("return_to_previous_menu", "returnToPreviousMenu", str, is_required=True), - E("repeat_menu", "repeatMenu", str), + E( + "digit_pattern_permissions", + "digitPatternPermissions", + OutgoingPinholeDigitPlanDigitPatternRedirectingPermission, + is_complex=True, + is_required=True, + is_array=True, + ), ) -class VoicePortalCallingMenuKeysModifyEntry(OCIType): +class PriorityAlertCriteriaFromDnModify(OCIType): """ - The voice portal calling menu keys modify entry. + The from dn criteria used within a modify request. Attributes: - end_current_call_and_go_back_to_previous_menu (str): - endCurrentCallAndGoBackToPreviousMenu *Optional* - return_to_previous_menu (str): returnToPreviousMenu *Optional* + from_dn_criteria_selection (str): fromDnCriteriaSelection *Optional* + include_anonymous_callers (bool): includeAnonymousCallers *Optional* + include_unavailable_callers (bool): includeUnavailableCallers *Optional* + phone_number_list (phoneNumberList): phoneNumberList *Optional* """ __slots__: List[str] = [ - "end_current_call_and_go_back_to_previous_menu", - "return_to_previous_menu", + "from_dn_criteria_selection", + "include_anonymous_callers", + "include_unavailable_callers", + "phone_number_list", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( + E("from_dn_criteria_selection", "fromDnCriteriaSelection", str), + E("include_anonymous_callers", "includeAnonymousCallers", bool), + E("include_unavailable_callers", "includeUnavailableCallers", bool), E( - "end_current_call_and_go_back_to_previous_menu", - "endCurrentCallAndGoBackToPreviousMenu", - str, + "phone_number_list", + "phoneNumberList", + CriteriaReplacementDNList, + is_complex=True, ), - E("return_to_previous_menu", "returnToPreviousMenu", str), ) -class VoicePortalCallingMenuKeysReadEntry(OCIType): +class ProfileAndServiceDeviceEndpointInfo(OCIType): """ - The voice portal change calling menu keys. - + Represents information about an endpoint device Attributes: - end_current_call_and_go_back_to_previous_menu (str): - endCurrentCallAndGoBackToPreviousMenu - return_to_previous_menu (str): returnToPreviousMenu + access_device (accessDevice): accessDevice + line_port (str): linePort + private_identity (str): privateIdentity *Optional* + access_device_mac_address (str): accessDeviceMacAddress *Optional* """ __slots__: List[str] = [ - "end_current_call_and_go_back_to_previous_menu", - "return_to_previous_menu", + "access_device", + "line_port", + "private_identity", + "access_device_mac_address", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( E( - "end_current_call_and_go_back_to_previous_menu", - "endCurrentCallAndGoBackToPreviousMenu", - str, + "access_device", + "accessDevice", + AccessDevice, + is_complex=True, is_required=True, ), - E("return_to_previous_menu", "returnToPreviousMenu", str, is_required=True), + E("line_port", "linePort", str, is_required=True), + E("private_identity", "privateIdentity", str), + E("access_device_mac_address", "accessDeviceMacAddress", str), ) -class VoicePortalLoginMenuKeysModifyEntry(OCIType): +class ProfileAndServiceMusicOnHoldInfo(OCIType): """ - The voice portal voice portal login menu keys modify entry. - + This is the configuration parameters for Music On Hold service Attributes: - access_using_other_mailbox_id (str): accessUsingOtherMailboxId *Optional* + enable_video (bool): enableVideo + source (source): source + use_alternate_source_for_internal_calls (bool): useAlternateSourceForInternalCalls + internal_source (internalSource): internalSource *Optional* """ __slots__: List[str] = [ - "access_using_other_mailbox_id", + "enable_video", + "source", + "use_alternate_source_for_internal_calls", + "internal_source", ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return (E("access_using_other_mailbox_id", "accessUsingOtherMailboxId", str),) + return ( + E("enable_video", "enableVideo", bool, is_required=True), + E( + "source", + "source", + MusicOnHoldUserSourceRead16, + is_complex=True, + is_required=True, + ), + E( + "use_alternate_source_for_internal_calls", + "useAlternateSourceForInternalCalls", + bool, + is_required=True, + ), + E( + "internal_source", + "internalSource", + MusicOnHoldUserSourceRead16, + is_complex=True, + ), + ) -class VoicePortalLoginMenuKeysReadEntry(OCIType): +class ProfileAndServiceSimultaneousRingPersonalInfo(OCIType): """ - The voice portal login menu keys. + This is the configuration parameters for Simultaneous Ring Personal service Contains a + criteria table with column heading: "Is Active", "Criteria Name", "Time Schedule", + "Holiday Schedule", "Calls From" and "Blacklisted". + The "Calls From" column is a string containing call numbers Attributes: - access_using_other_mailbox_id (str): accessUsingOtherMailboxId *Optional* + is_active (bool): isActive + do_not_ring_if_on_call (bool): doNotRingIfOnCall + simultaneous_ring_number (List[simultaneousRingNumber]): simultaneousRingNumber + *Optional* + criteria_table (List(criteriaTable)): criteriaTable - *Table* array of + criteriaTable named tuples """ __slots__: List[str] = [ - "access_using_other_mailbox_id", + "is_active", + "do_not_ring_if_on_call", + "simultaneous_ring_number", + "criteria_table", ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return (E("access_using_other_mailbox_id", "accessUsingOtherMailboxId", str),) + return ( + E("is_active", "isActive", bool, is_required=True), + E("do_not_ring_if_on_call", "doNotRingIfOnCall", bool, is_required=True), + E( + "simultaneous_ring_number", + "simultaneousRingNumber", + SimultaneousRingNumber, + is_complex=True, + is_array=True, + ), + E( + "criteria_table", + "criteriaTable", + list, + is_complex=True, + is_required=True, + is_table=True, + ), + ) -class VoicePortalMainMenuKeysModifyEntry(OCIType): +class ProfileAndServiceSpeedDial100Info(OCIType): """ - The voice portal main menu keys modify entry. - + This is the configuration parameters for Speed Dial 100 service Attributes: - voice_messaging (str): voiceMessaging *Optional* - comm_pilot_express_profile (str): commPilotExpressProfile *Optional* - greetings (str): greetings *Optional* - call_forwarding_options (str): callForwardingOptions *Optional* - voice_portal_calling (str): voicePortalCalling *Optional* - hoteling (str): hoteling *Optional* - passcode (str): passcode *Optional* - exit_voice_portal (str): exitVoicePortal *Optional* - repeat_menu (str): repeatMenu *Optional* - external_routing (str): externalRouting *Optional* - announcement (str): announcement *Optional* - personal_assistant (str): personalAssistant *Optional* + prefix (str): prefix *Optional* + speed_dial_entry (List[speedDialEntry]): speedDialEntry *Optional* """ __slots__: List[str] = [ - "voice_messaging", - "comm_pilot_express_profile", - "greetings", - "call_forwarding_options", - "voice_portal_calling", - "hoteling", - "passcode", - "exit_voice_portal", - "repeat_menu", - "external_routing", - "announcement", - "personal_assistant", + "prefix", + "speed_dial_entry", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("voice_messaging", "voiceMessaging", str), - E("comm_pilot_express_profile", "commPilotExpressProfile", str), - E("greetings", "greetings", str), - E("call_forwarding_options", "callForwardingOptions", str), - E("voice_portal_calling", "voicePortalCalling", str), - E("hoteling", "hoteling", str), - E("passcode", "passcode", str), - E("exit_voice_portal", "exitVoicePortal", str), - E("repeat_menu", "repeatMenu", str), - E("external_routing", "externalRouting", str), - E("announcement", "announcement", str), - E("personal_assistant", "personalAssistant", str), + E("prefix", "prefix", str), + E( + "speed_dial_entry", + "speedDialEntry", + SpeedDial100Entry, + is_complex=True, + is_array=True, + ), ) -class VoicePortalMainMenuKeysReadEntry(OCIType): +class ProfileAndServiceSpeedDial8Info(OCIType): """ - The voice portal main menu keys. - + This is the configuration parameters for Speed Dial 8 service Attributes: - voice_messaging (str): voiceMessaging *Optional* - comm_pilot_express_profile (str): commPilotExpressProfile *Optional* - greetings (str): greetings *Optional* - call_forwarding_options (str): callForwardingOptions *Optional* - voice_portal_calling (str): voicePortalCalling *Optional* - hoteling (str): hoteling *Optional* - passcode (str): passcode *Optional* - exit_voice_portal (str): exitVoicePortal *Optional* - repeat_menu (str): repeatMenu *Optional* - external_routing (str): externalRouting *Optional* - announcement (str): announcement *Optional* - personal_assistant (str): personalAssistant *Optional* + speed_dial_entry (List[speedDialEntry]): speedDialEntry *Optional* """ __slots__: List[str] = [ - "voice_messaging", - "comm_pilot_express_profile", - "greetings", - "call_forwarding_options", - "voice_portal_calling", - "hoteling", - "passcode", - "exit_voice_portal", - "repeat_menu", - "external_routing", - "announcement", - "personal_assistant", + "speed_dial_entry", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("voice_messaging", "voiceMessaging", str), - E("comm_pilot_express_profile", "commPilotExpressProfile", str), - E("greetings", "greetings", str), - E("call_forwarding_options", "callForwardingOptions", str), - E("voice_portal_calling", "voicePortalCalling", str), - E("hoteling", "hoteling", str), - E("passcode", "passcode", str), - E("exit_voice_portal", "exitVoicePortal", str), - E("repeat_menu", "repeatMenu", str), - E("external_routing", "externalRouting", str), - E("announcement", "announcement", str), - E("personal_assistant", "personalAssistant", str), + E( + "speed_dial_entry", + "speedDialEntry", + SpeedDial8Entry, + is_complex=True, + is_array=True, + ), ) -class XsiApplicationIdEntry(OCIType): +class PushNotificationTokenData(OCIType): """ - The system application Id entry. + ? The common push notification token elements. Attributes: - xsi_application_id (str): xsiApplicationId - description (str): description *Optional* + push_notification_token (str): pushNotificationToken + push_notification_type (str): pushNotificationType + push_notification_event_data (List[pushNotificationEventData]): + pushNotificationEventData *Optional* """ __slots__: List[str] = [ - "xsi_application_id", - "description", + "push_notification_token", + "push_notification_type", + "push_notification_event_data", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("xsi_application_id", "xsiApplicationId", str, is_required=True), - E("description", "description", str), + E( + "push_notification_token", + "pushNotificationToken", + str, + is_required=True, + ), + E("push_notification_type", "pushNotificationType", str, is_required=True), + E( + "push_notification_event_data", + "pushNotificationEventData", + PushNotificationEventData, + is_complex=True, + is_array=True, + ), ) -class XsiPolicyProfileAssignEntry(OCIType): +class ReceptionistContactUserAndNote(OCIType): """ - The Xsi policy profile assign entry contains multiple Xsi policy profile and one - default xsi policy profile. + The Receptionist User (or VON User) and Receptionist Notes. Attributes: - name (List[str]): name *Optional* - default (str): default *Optional* + contact_user_id (str): contactUserId *Optional* + von_user (vonUser): vonUser *Optional* + note (str): note """ __slots__: List[str] = [ - "name", - "default", + "contact_user_id", + "von_user", + "note", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("name", "name", str, is_array=True), - E("default", "default", str), + E("contact_user_id", "contactUserId", str), + E("von_user", "vonUser", VirtualOnNetUserKey, is_complex=True), + E("note", "note", str, is_required=True), ) -class XsiPolicyProfileKey(OCIType): +class ReplacementAgentWeightList(OCIType): """ - The system Xsi policy profile key. + A list of agent userIds and hunt agent weights that replaces the previously configured + list. + By convention, an element of this type may be set nill to clear the list. Attributes: - name (str): name - level (str): level + agent_weight (List[agentWeight]): agentWeight """ __slots__: List[str] = [ - "name", - "level", + "agent_weight", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("name", "name", str, is_required=True), - E("level", "level", str, is_required=True), + E( + "agent_weight", + "agentWeight", + HuntAgentWeight, + is_complex=True, + is_required=True, + is_array=True, + ), ) -class XsiPolicyProfileUnassignEntry(OCIType): +class ReplacementAlternateUserIdEntryList(OCIType): """ - The Xsi policy profile unassign entry contains mutiltipe Xsi policy profile and a new - replacement default xsi policy profile. + A list of alternate user ids that that replaces a previously configured list. + By convention, an element of this type may be set nill to clear the list. Attributes: - name (List[str]): name *Optional* - new_default (str): newDefault *Optional* + alternate_user_id (List[alternateUserId]): alternateUserId """ __slots__: List[str] = [ - "name", - "new_default", + "alternate_user_id", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("name", "name", str, is_array=True), - E("new_default", "newDefault", str), + E( + "alternate_user_id", + "alternateUserId", + AlternateUserIdEntry, + is_complex=True, + is_required=True, + is_array=True, + ), ) -class AccessDeviceEndpointAdd(OCIType): +class ReplacementCallToNumberList(OCIType): """ - Access device end point used in the context of add. + A list of Call to Numbers that replaces a previously configured list. - Port numbers are only used by devices with static line ordering. The following - element is only used in AS data mode and ignored in XS data mode: pathHeader + By convention, an element of this type may be set nill to clear the list. For the + callToNumbers, the extension element is not used and the number element is only used + when the type is BroadWorks Mobility. Attributes: - access_device (accessDevice): accessDevice - line_port (str): linePort - contact (str): contact *Optional* - path_header (str): pathHeader *Optional* - port_number (int): portNumber *Optional* + call_to_number (List[callToNumber]): callToNumber """ __slots__: List[str] = [ - "access_device", - "line_port", - "contact", - "path_header", - "port_number", + "call_to_number", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( E( - "access_device", - "accessDevice", - AccessDevice, + "call_to_number", + "callToNumber", + CallToNumber, is_complex=True, is_required=True, + is_array=True, ), - E("line_port", "linePort", str, is_required=True), - E("contact", "contact", str), - E("path_header", "pathHeader", str), - E("port_number", "portNumber", int), ) -class AccessDeviceEndpointAndHotlineAdd(OCIType): +class ReplacementCommunicationBarringCallMeNowRuleList(OCIType): """ - Access device end point used in the context of add. + A list of Communication Barring CallMeNow Rules that replaces a previously configured + list. - Port numbers are only used by devices with static line ordering. The following - element is only used in AS data mode and ignored in XS data mode: pathHeader - useHotline, use value false in XS data mode hotlineContact The following element is - only used in XS data mode and ignored in AS data mode: privateIdentity + By convention, an element of this type may be set nill to clear the list. Attributes: - access_device (accessDevice): accessDevice - line_port (str): linePort - private_identity (str): privateIdentity *Optional* - contact (str): contact *Optional* - path_header (str): pathHeader *Optional* - port_number (int): portNumber *Optional* - use_hotline (bool): useHotline - hotline_contact (str): hotlineContact *Optional* + rule (List[rule]): rule """ __slots__: List[str] = [ - "access_device", - "line_port", - "private_identity", - "contact", - "path_header", - "port_number", - "use_hotline", - "hotline_contact", + "rule", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( E( - "access_device", - "accessDevice", - AccessDevice, + "rule", + "rule", + CommunicationBarringCallMeNowRule, is_complex=True, is_required=True, + is_array=True, ), - E("line_port", "linePort", str, is_required=True), - E("private_identity", "privateIdentity", str), - E("contact", "contact", str), - E("path_header", "pathHeader", str), - E("port_number", "portNumber", int), - E("use_hotline", "useHotline", bool, is_required=True), - E("hotline_contact", "hotlineContact", str), ) -class AccessDeviceEndpointAndHotlineModify(OCIType): +class ReplacementCommunicationBarringIncomingRuleList(OCIType): """ - Access device end point used in the context of modify. + A list of Communication Barring Incoming Rules that replaces a previously configured + list. - Port numbers are only used by devices with static line ordering. The following - element is only used in AS data mode and ignored in XS data mode: pathHeader - useHotline hotlineContact + By convention, an element of this type may be set nill to clear the list. Attributes: - access_device (accessDevice): accessDevice - line_port (str): linePort - contact (str): contact *Optional* - path_header (str): pathHeader *Optional* - port_number (int): portNumber *Optional* - use_hotline (bool): useHotline *Optional* - hotline_contact (str): hotlineContact *Optional* + rule (List[rule]): rule """ __slots__: List[str] = [ - "access_device", - "line_port", - "contact", - "path_header", - "port_number", - "use_hotline", - "hotline_contact", + "rule", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( E( - "access_device", - "accessDevice", - AccessDevice, + "rule", + "rule", + CommunicationBarringIncomingRule, is_complex=True, is_required=True, + is_array=True, ), - E("line_port", "linePort", str, is_required=True), - E("contact", "contact", str), - E("path_header", "pathHeader", str), - E("port_number", "portNumber", int), - E("use_hotline", "useHotline", bool), - E("hotline_contact", "hotlineContact", str), ) -class AccessDeviceEndpointKey(OCIType): +class ReplacementCommunicationBarringIncomingRuleList19sp1(OCIType): """ - Access device end point in the context of a modify or delete command. + A list of Communication Barring Incoming Rules that replaces a previously configured + list. + By convention, an element of this type may be set nill to clear the list. Attributes: - access_device (accessDevice): accessDevice - line_port (str): linePort + rule (List[rule]): rule """ __slots__: List[str] = [ - "access_device", - "line_port", + "rule", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( E( - "access_device", - "accessDevice", - AccessDevice, + "rule", + "rule", + CommunicationBarringIncomingRule19sp1, is_complex=True, is_required=True, + is_array=True, ), - E("line_port", "linePort", str, is_required=True), ) -class AccessDeviceEndpointModify(OCIType): +class ReplacementCommunicationBarringOriginatingRuleList(OCIType): """ - Access device end point used in the context of modify. + A list of Communication Barring Originating Rules that replaces a previously + configured list. - Port numbers are only used by devices with static line ordering. The following - element is only used in AS data mode and ignored in XS data mode: pathHeader + By convention, an element of this type may be set nill to clear the list. Attributes: - access_device (accessDevice): accessDevice - line_port (str): linePort - contact (str): contact *Optional* - path_header (str): pathHeader *Optional* - port_number (int): portNumber *Optional* + rule (List[rule]): rule """ __slots__: List[str] = [ - "access_device", - "line_port", - "contact", - "path_header", - "port_number", + "rule", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( E( - "access_device", - "accessDevice", - AccessDevice, + "rule", + "rule", + CommunicationBarringOriginatingRule, is_complex=True, is_required=True, + is_array=True, ), - E("line_port", "linePort", str, is_required=True), - E("contact", "contact", str), - E("path_header", "pathHeader", str), - E("port_number", "portNumber", int), ) -class AccessDeviceEndpointRead14(OCIType): +class ReplacementCommunicationBarringRedirectingRuleList(OCIType): """ - Access device end point. + A list of Communication Barring Redirecting Rules that replaces a previously + configured list. + By convention, an element of this type may be set nill to clear the list. Attributes: - access_device (accessDevice): accessDevice - line_port (str): linePort - contact (str): contact *Optional* - static_registration_capable (bool): staticRegistrationCapable - use_domain (bool): useDomain + rule (List[rule]): rule """ __slots__: List[str] = [ - "access_device", - "line_port", - "contact", - "static_registration_capable", - "use_domain", + "rule", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( E( - "access_device", - "accessDevice", - AccessDevice, + "rule", + "rule", + CommunicationBarringRedirectingRule, is_complex=True, is_required=True, + is_array=True, ), - E("line_port", "linePort", str, is_required=True), - E("contact", "contact", str), - E( - "static_registration_capable", - "staticRegistrationCapable", - bool, - is_required=True, - ), - E("use_domain", "useDomain", bool, is_required=True), ) -class AccessDeviceEndpointWithPortNumberRead(OCIType): +class ReplacementContactList22(OCIType): """ - Access device end point. + A list of SIP contacts that replaces a previously configured list. - Port numbers are only used by devices with static line ordering. + By convention, an element of this type may be set nill to clear the list. Attributes: - access_device (accessDevice): accessDevice - line_port (str): linePort - contact (str): contact *Optional* - static_registration_capable (bool): staticRegistrationCapable - use_domain (bool): useDomain - port_number (int): portNumber *Optional* + contact (List[contact]): contact """ __slots__: List[str] = [ - "access_device", - "line_port", "contact", - "static_registration_capable", - "use_domain", - "port_number", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( E( - "access_device", - "accessDevice", - AccessDevice, + "contact", + "contact", + SIPContactInfo, is_complex=True, is_required=True, + is_array=True, ), - E("line_port", "linePort", str, is_required=True), - E("contact", "contact", str), - E( - "static_registration_capable", - "staticRegistrationCapable", - bool, - is_required=True, - ), - E("use_domain", "useDomain", bool, is_required=True), - E("port_number", "portNumber", int), ) -class AccessDeviceEndpointWithPortNumberRead22(OCIType): +class ReplacementCustomContactDirectoryEntryList(OCIType): """ - Access device end point. + A list of userIds and/or Virtual On-Net user DNs that replaces a previously configured + list. - Port numbers are only used by devices with static line ordering. The following - element is only used in AS data mode and ignored in XS data mode: pathHeader + By convention, an element of this type may be set nill to clear the list. Attributes: - access_device (accessDevice): accessDevice - line_port (str): linePort - contact (str): contact *Optional* - path_header (str): pathHeader *Optional* - static_registration_capable (bool): staticRegistrationCapable - use_domain (bool): useDomain - port_number (int): portNumber *Optional* + entry (List[entry]): entry """ __slots__: List[str] = [ - "access_device", - "line_port", - "contact", - "path_header", - "static_registration_capable", - "use_domain", - "port_number", + "entry", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( E( - "access_device", - "accessDevice", - AccessDevice, + "entry", + "entry", + CustomContactDirectoryEntry, is_complex=True, is_required=True, + is_array=True, ), - E("line_port", "linePort", str, is_required=True), - E("contact", "contact", str), - E("path_header", "pathHeader", str), - E( - "static_registration_capable", - "staticRegistrationCapable", - bool, - is_required=True, - ), - E("use_domain", "useDomain", bool, is_required=True), - E("port_number", "portNumber", int), ) -class AccessDeviceEndpointWithPortNumberRead22V2(OCIType): +class ReplacementDeviceList(OCIType): """ - Access device end point. + A list of devices that replaces a previously configured list. - Port numbers are only used by devices with static line ordering. The following - element is only used in AS data mode and ignored in XS data mode: pathHeader - hotlineContact The following elements are only used in AS data mode and a value false - is returned in the XS mode: useHotline + By convention, an element of this type may be set nill to clear the list. Attributes: - access_device (accessDevice): accessDevice - line_port (str): linePort - contact (str): contact *Optional* - path_header (str): pathHeader *Optional* - static_registration_capable (bool): staticRegistrationCapable - use_domain (bool): useDomain - port_number (int): portNumber *Optional* - use_hotline (bool): useHotline - hotline_contact (str): hotlineContact *Optional* + device (List[device]): device """ __slots__: List[str] = [ - "access_device", - "line_port", - "contact", - "path_header", - "static_registration_capable", - "use_domain", - "port_number", - "use_hotline", - "hotline_contact", + "device", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( E( - "access_device", - "accessDevice", + "device", + "device", AccessDevice, is_complex=True, is_required=True, + is_array=True, ), - E("line_port", "linePort", str, is_required=True), - E("contact", "contact", str), - E("path_header", "pathHeader", str), - E( - "static_registration_capable", - "staticRegistrationCapable", - bool, - is_required=True, - ), - E("use_domain", "useDomain", bool, is_required=True), - E("port_number", "portNumber", int), - E("use_hotline", "useHotline", bool, is_required=True), - E("hotline_contact", "hotlineContact", str), ) -class AccessDeviceMultipleContactEndpointAdd(OCIType): +class ReplacementEnterpriseEnterpriseTrunkTrunkGroupKeyList(OCIType): """ - Access device end point used in the context of add that can have more than one contact - defined. + A list of Enterprise Trunk Krunk Group Keys that replaces a previously configured + list. - Only Static Registration capabable devices may have more than one contact defined. - Port numbers are only used by devices with static line ordering. + By convention, an element of this type may be set nill to clear the list. Attributes: - access_device (accessDevice): accessDevice - line_port (str): linePort - contact (List[str]): contact *Optional* - port_number (int): portNumber *Optional* + trunk_group (List[trunkGroup]): trunkGroup """ __slots__: List[str] = [ - "access_device", - "line_port", - "contact", - "port_number", + "trunk_group", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( E( - "access_device", - "accessDevice", - AccessDevice, + "trunk_group", + "trunkGroup", + EnterpriseTrunkTrunkGroupKey, is_complex=True, is_required=True, + is_array=True, ), - E("line_port", "linePort", str, is_required=True), - E("contact", "contact", str, is_array=True), - E("port_number", "portNumber", int), ) -class AccessDeviceMultipleContactEndpointAdd22(OCIType): +class ReplacementEnterpriseTrunkTrunkGroupKeyList(OCIType): """ - Access device end point used in the context of add that can have more than one contact - defined. + A list of Enterprise Trunk Krunk Group Keys that replaces a previously configured + list. - Only Static Registration capabable devices may have more than one contact defined. - Port numbers are only used by devices with static line ordering. + By convention, an element of this type may be set nill to clear the list. Attributes: - access_device (accessDevice): accessDevice - line_port (str): linePort - contact (List[contact]): contact *Optional* - port_number (int): portNumber *Optional* + trunk_group_list (List[trunkGroupList]): trunkGroupList """ __slots__: List[str] = [ - "access_device", - "line_port", - "contact", - "port_number", + "trunk_group_list", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( E( - "access_device", - "accessDevice", - AccessDevice, + "trunk_group_list", + "trunkGroupList", + EnterpriseTrunkTrunkGroupKey, is_complex=True, is_required=True, + is_array=True, ), - E("line_port", "linePort", str, is_required=True), - E("contact", "contact", SIPContactInfo, is_complex=True, is_array=True), - E("port_number", "portNumber", int), ) -class AccessDeviceMultipleContactEndpointModify(OCIType): +class ReplacementGroupEnterpriseTrunkPriorityWeightedTrunkGroupList(OCIType): """ - Access device end point used in the context of modify that can have more than one - contact defined. + A list of enterprise trunk priority weighted trunk groups in a group that replaces a + previously configured list. - Only Static Registration capable devices may have more than one contact defined. Port - numbers are only used by devices with static line ordering. + By convention, an element of this type may be set nill to clear the list. Attributes: - access_device (accessDevice): accessDevice *Optional* - line_port (str): linePort *Optional* - contact_list (contactList): contactList *Optional* - port_number (int): portNumber *Optional* + trunk_group (List[trunkGroup]): trunkGroup """ __slots__: List[str] = [ - "access_device", - "line_port", - "contact_list", - "port_number", + "trunk_group", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("access_device", "accessDevice", AccessDevice, is_complex=True), - E("line_port", "linePort", str), - E("contact_list", "contactList", ReplacementContactList, is_complex=True), - E("port_number", "portNumber", int), + E( + "trunk_group", + "trunkGroup", + GroupEnterpriseTrunkPriorityWeightedTrunkGroup, + is_complex=True, + is_required=True, + is_array=True, + ), ) -class AccessDeviceMultipleContactEndpointRead(OCIType): +class ScheduleEvents(OCIType): """ - Access device end point that can have multiple contacts. + Retrives all Holiday or Time Event details for a given schedulel Level. - Replaced by AccessDeviceMultipleContactEndpointRead19. Attributes: - access_device (accessDevice): accessDevice - line_port (str): linePort - contact (List[str]): contact *Optional* - static_registration_capable (bool): staticRegistrationCapable - use_domain (bool): useDomain + eventname (str): eventname + start_date (str): startDate + all_day_event (bool): allDayEvent *Optional* + start_time (startTime): startTime *Optional* + end_time (endTime): endTime *Optional* + end_date (str): endDate + recurrence (recurrence): recurrence *Optional* """ __slots__: List[str] = [ - "access_device", - "line_port", - "contact", - "static_registration_capable", - "use_domain", - ] + "eventname", + "start_date", + "all_day_event", + "start_time", + "end_time", + "end_date", + "recurrence", + ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E( - "access_device", - "accessDevice", - AccessDevice, - is_complex=True, - is_required=True, - ), - E("line_port", "linePort", str, is_required=True), - E("contact", "contact", str, is_array=True), - E( - "static_registration_capable", - "staticRegistrationCapable", - bool, - is_required=True, - ), - E("use_domain", "useDomain", bool, is_required=True), + E("eventname", "eventname", str, is_required=True), + E("start_date", "startDate", str, is_required=True), + E("all_day_event", "allDayEvent", bool), + E("start_time", "startTime", HourMinute, is_complex=True), + E("end_time", "endTime", HourMinute, is_complex=True), + E("end_date", "endDate", str, is_required=True), + E("recurrence", "recurrence", Recurrence, is_complex=True), ) -class AccessDeviceMultipleContactEndpointRead19(OCIType): +class ScheduleGlobalKey(OCIType): """ - Access device end point that can have multiple contacts. + Uniquely identifies Holiday and Time Schedules throughout all System, Service + Provider, Group and User level. - Port numbers are only used by devices with static line ordering. Replaced by - AccessDeviceMultipleContactEndpointRead20. Attributes: - access_device (accessDevice): accessDevice - line_port (str): linePort - contact (List[str]): contact *Optional* - static_registration_capable (bool): staticRegistrationCapable - use_domain (bool): useDomain - port_number (int): portNumber *Optional* + schedule_key (scheduleKey): scheduleKey + schedule_level (str): scheduleLevel """ __slots__: List[str] = [ - "access_device", - "line_port", - "contact", - "static_registration_capable", - "use_domain", - "port_number", + "schedule_key", + "schedule_level", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( E( - "access_device", - "accessDevice", - AccessDevice, + "schedule_key", + "scheduleKey", + ScheduleKey, is_complex=True, is_required=True, ), - E("line_port", "linePort", str, is_required=True), - E("contact", "contact", str, is_array=True), - E( - "static_registration_capable", - "staticRegistrationCapable", - bool, - is_required=True, - ), - E("use_domain", "useDomain", bool, is_required=True), - E("port_number", "portNumber", int), + E("schedule_level", "scheduleLevel", str, is_required=True), ) -class AccessDeviceMultipleContactEndpointRead20(OCIType): +class SearchCriteriaAccessDeviceEndpointPrivateIdentity(SearchCriteria): """ - Access device end point that can have multiple contacts. + Criteria for searching for a private identity. - Port numbers are only used by devices with static line ordering. Replaced by - AccessDeviceMultipleContactEndpointRead22. Attributes: - access_device (accessDevice): accessDevice - line_port (str): linePort - contact (List[str]): contact *Optional* - static_registration_capable (bool): staticRegistrationCapable - use_domain (bool): useDomain - port_number (int): portNumber *Optional* - support_visual_device_management (bool): supportVisualDeviceManagement + mode (str): mode + value (str): value + is_case_insensitive (bool): isCaseInsensitive """ __slots__: List[str] = [ - "access_device", - "line_port", - "contact", - "static_registration_capable", - "use_domain", - "port_number", - "support_visual_device_management", + "mode", + "value", + "is_case_insensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E( - "access_device", - "accessDevice", - AccessDevice, - is_complex=True, - is_required=True, - ), - E("line_port", "linePort", str, is_required=True), - E("contact", "contact", str, is_array=True), - E( - "static_registration_capable", - "staticRegistrationCapable", - bool, - is_required=True, - ), - E("use_domain", "useDomain", bool, is_required=True), - E("port_number", "portNumber", int), - E( - "support_visual_device_management", - "supportVisualDeviceManagement", - bool, - is_required=True, - ), + E("mode", "mode", str, is_required=True), + E("value", "value", str, is_required=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), ) -class AccessDeviceMultipleContactEndpointRead22(OCIType): +class SearchCriteriaAccessDeviceVersion(SearchCriteria): """ - Access device end point that can have multiple contacts. + Criteria for searching for an Access Device Version. - Port numbers are only used by devices with static line ordering. Attributes: - access_device (accessDevice): accessDevice - line_port (str): linePort - contact (List[contact]): contact *Optional* - static_registration_capable (bool): staticRegistrationCapable - use_domain (bool): useDomain - port_number (int): portNumber *Optional* - support_visual_device_management (bool): supportVisualDeviceManagement + mode (str): mode + value (str): value + is_case_insensitive (bool): isCaseInsensitive """ __slots__: List[str] = [ - "access_device", - "line_port", - "contact", - "static_registration_capable", - "use_domain", - "port_number", - "support_visual_device_management", + "mode", + "value", + "is_case_insensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E( - "access_device", - "accessDevice", - AccessDevice, - is_complex=True, - is_required=True, - ), - E("line_port", "linePort", str, is_required=True), - E("contact", "contact", SIPContactInfo, is_complex=True, is_array=True), - E( - "static_registration_capable", - "staticRegistrationCapable", - bool, - is_required=True, - ), - E("use_domain", "useDomain", bool, is_required=True), - E("port_number", "portNumber", int), - E( - "support_visual_device_management", - "supportVisualDeviceManagement", - bool, - is_required=True, - ), + E("mode", "mode", str, is_required=True), + E("value", "value", str, is_required=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), ) -class AccessDeviceMultipleIdentityAndContactEndpointAdd(OCIType): +class SearchCriteriaAdminFirstName(SearchCriteria): """ - Access device end point used in the context of add that can have more than one contact - defined. + Criteria for searching for an administrator's first name. - The endpoint is identified by its linePort (public Identity) and possibly a private - Identity. Only Static Registration capabable devices may have more than one contact - defined. Port numbers are only used by devices with static line ordering. The - following elements are only used in XS data mode and ignored in AS data mode: - privateIdentity Attributes: - access_device (accessDevice): accessDevice - line_port (str): linePort - private_identity (str): privateIdentity *Optional* - contact (List[str]): contact *Optional* - port_number (int): portNumber *Optional* + mode (str): mode + value (str): value + is_case_insensitive (bool): isCaseInsensitive """ __slots__: List[str] = [ - "access_device", - "line_port", - "private_identity", - "contact", - "port_number", + "mode", + "value", + "is_case_insensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E( - "access_device", - "accessDevice", - AccessDevice, - is_complex=True, - is_required=True, - ), - E("line_port", "linePort", str, is_required=True), - E("private_identity", "privateIdentity", str), - E("contact", "contact", str, is_array=True), - E("port_number", "portNumber", int), + E("mode", "mode", str, is_required=True), + E("value", "value", str, is_required=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), ) -class AccessDeviceMultipleIdentityAndContactEndpointAdd22(OCIType): +class SearchCriteriaAdminId(SearchCriteria): """ - Access device end point used in the context of add that can have more than one contact - defined. + Criteria for searching for an administrator's adminId. - The endpoint is identified by its linePort (public Identity) and possibly a private - Identity. Only Static Registration capabable devices may have more than one contact - defined. Port numbers are only used by devices with static line ordering. The - following elements are only used in XS data mode and ignored in AS data mode: - privateIdentity Attributes: - access_device (accessDevice): accessDevice - line_port (str): linePort - private_identity (str): privateIdentity *Optional* - contact (List[contact]): contact *Optional* - port_number (int): portNumber *Optional* + mode (str): mode + value (str): value + is_case_insensitive (bool): isCaseInsensitive """ __slots__: List[str] = [ - "access_device", - "line_port", - "private_identity", - "contact", - "port_number", + "mode", + "value", + "is_case_insensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E( - "access_device", - "accessDevice", - AccessDevice, - is_complex=True, - is_required=True, - ), - E("line_port", "linePort", str, is_required=True), - E("private_identity", "privateIdentity", str), - E("contact", "contact", SIPContactInfo, is_complex=True, is_array=True), - E("port_number", "portNumber", int), + E("mode", "mode", str, is_required=True), + E("value", "value", str, is_required=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), ) -class AccessDeviceMultipleIdentityAndContactEndpointAdd22V2(OCIType): +class SearchCriteriaAdminLastName(SearchCriteria): """ - Access device end point used in the context of add that can have more than one contact - defined. + Criteria for searching for an administrator's last name. - The endpoint is identified by its linePort (public Identity) and possibly a private - Identity. Only Static Registration capabable devices may have more than one contact - defined. Port numbers are only used by devices with static line ordering. The - following elements are only used in XS data mode and ignored in AS data mode: - privateIdentity The following elements are only used in AS data mode and ignored in XS - data mode: useHotline, use value false in XS data mode hotlineContact Attributes: - access_device (accessDevice): accessDevice - line_port (str): linePort - private_identity (str): privateIdentity *Optional* - contact (List[contact]): contact *Optional* - port_number (int): portNumber *Optional* - use_hotline (bool): useHotline - hotline_contact (str): hotlineContact *Optional* + mode (str): mode + value (str): value + is_case_insensitive (bool): isCaseInsensitive """ __slots__: List[str] = [ - "access_device", - "line_port", - "private_identity", - "contact", - "port_number", - "use_hotline", - "hotline_contact", + "mode", + "value", + "is_case_insensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E( - "access_device", - "accessDevice", - AccessDevice, - is_complex=True, - is_required=True, - ), - E("line_port", "linePort", str, is_required=True), - E("private_identity", "privateIdentity", str), - E("contact", "contact", SIPContactInfo, is_complex=True, is_array=True), - E("port_number", "portNumber", int), - E("use_hotline", "useHotline", bool, is_required=True), - E("hotline_contact", "hotlineContact", str), + E("mode", "mode", str, is_required=True), + E("value", "value", str, is_required=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), ) -class AccessDeviceMultipleIdentityAndContactEndpointModify(OCIType): +class SearchCriteriaAgentThresholdProfile(SearchCriteria): """ - Access device end point used in the context of modify that can have more than one - contact defined. + Criteria for searching a Call Center Agent Threshold Profile. - The endpoint is identified by its linePort (public Identity) and possibly a private - Identity. Only Static Registration capabable devices may have more than one contact - defined. Port numbers are only used by devices with static line ordering. The - following elements are only used in XS data mode and ignored in AS data mode: - privateIdentity Attributes: - access_device (accessDevice): accessDevice *Optional* - line_port (str): linePort *Optional* - private_identity (str): privateIdentity *Optional* - contact_list (contactList): contactList *Optional* - port_number (int): portNumber *Optional* + mode (str): mode + value (str): value + is_case_insensitive (bool): isCaseInsensitive """ __slots__: List[str] = [ - "access_device", - "line_port", - "private_identity", - "contact_list", - "port_number", + "mode", + "value", + "is_case_insensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("access_device", "accessDevice", AccessDevice, is_complex=True), - E("line_port", "linePort", str), - E("private_identity", "privateIdentity", str), - E("contact_list", "contactList", ReplacementContactList, is_complex=True), - E("port_number", "portNumber", int), + E("mode", "mode", str, is_required=True), + E("value", "value", str, is_required=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), ) -class AccessDeviceMultipleIdentityAndContactEndpointRead(OCIType): +class SearchCriteriaAlternateTrunkIdentity(SearchCriteria): """ - Access device end point that can have multiple contacts. + Criteria for searching for a particular fully specified alternate trunk identity. - The endpoint is identified by its linePort (public Identity) and possibly a private - Identity. Port numbers are only used by devices with static line ordering. The - following elements are only used in XS data mode and not returned in AS data mode: - privateIdentity The following elements are only used in AS data mode and a value false - is returned in the XS mode: supportVisualDeviceManagement + In IMS mode, it only applies to the user part of alternate trunk identity. Attributes: - access_device (accessDevice): accessDevice - line_port (str): linePort - private_identity (str): privateIdentity *Optional* - contact (List[str]): contact *Optional* - static_registration_capable (bool): staticRegistrationCapable - use_domain (bool): useDomain - port_number (int): portNumber *Optional* - support_visual_device_management (bool): supportVisualDeviceManagement + mode (str): mode + value (str): value + is_case_insensitive (bool): isCaseInsensitive """ __slots__: List[str] = [ - "access_device", - "line_port", - "private_identity", - "contact", - "static_registration_capable", - "use_domain", - "port_number", - "support_visual_device_management", + "mode", + "value", + "is_case_insensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E( - "access_device", - "accessDevice", - AccessDevice, - is_complex=True, - is_required=True, - ), - E("line_port", "linePort", str, is_required=True), - E("private_identity", "privateIdentity", str), - E("contact", "contact", str, is_array=True), - E( - "static_registration_capable", - "staticRegistrationCapable", - bool, - is_required=True, - ), - E("use_domain", "useDomain", bool, is_required=True), - E("port_number", "portNumber", int), - E( - "support_visual_device_management", - "supportVisualDeviceManagement", - bool, - is_required=True, - ), + E("mode", "mode", str, is_required=True), + E("value", "value", str, is_required=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), ) -class AccessDeviceMultipleIdentityAndContactEndpointRead22(OCIType): +class SearchCriteriaAlternateTrunkIdentityDomain(SearchCriteria): """ - Access device end point that can have multiple contacts. + Criteria for searching for alternate trunk identity domain part. - The endpoint is identified by its linePort (public Identity) and possibly a private - Identity. Port numbers are only used by devices with static line ordering. The - following elements are only used in XS data mode and not returned in AS data mode: - privateIdentity The following elements are only used in AS data mode and a value false - is returned in the XS mode: supportVisualDeviceManagement Attributes: - access_device (accessDevice): accessDevice - line_port (str): linePort - private_identity (str): privateIdentity *Optional* - contact (List[contact]): contact *Optional* - static_registration_capable (bool): staticRegistrationCapable - use_domain (bool): useDomain - port_number (int): portNumber *Optional* - support_visual_device_management (bool): supportVisualDeviceManagement + mode (str): mode + value (str): value + is_case_insensitive (bool): isCaseInsensitive """ __slots__: List[str] = [ - "access_device", - "line_port", - "private_identity", - "contact", - "static_registration_capable", - "use_domain", - "port_number", - "support_visual_device_management", + "mode", + "value", + "is_case_insensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E( - "access_device", - "accessDevice", - AccessDevice, - is_complex=True, - is_required=True, - ), - E("line_port", "linePort", str, is_required=True), - E("private_identity", "privateIdentity", str), - E("contact", "contact", SIPContactInfo, is_complex=True, is_array=True), - E( - "static_registration_capable", - "staticRegistrationCapable", - bool, - is_required=True, - ), - E("use_domain", "useDomain", bool, is_required=True), - E("port_number", "portNumber", int), - E( - "support_visual_device_management", - "supportVisualDeviceManagement", - bool, - is_required=True, - ), + E("mode", "mode", str, is_required=True), + E("value", "value", str, is_required=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), ) -class AccessDeviceMultipleIdentityAndContactEndpointRead22V2(OCIType): +class SearchCriteriaAlternateUserId(SearchCriteria): """ - Access device end point that can have multiple contacts. + Criteria for searching for a user's alternate userId. - The endpoint is identified by its linePort (public Identity) and possibly a private - Identity. Port numbers are only used by devices with static line ordering. The - following elements are only used in XS data mode and not returned in AS data mode: - privateIdentity The following elements are only used in AS data mode and a value false - is returned in the XS mode: supportVisualDeviceManagement useHotline The following - elements are only used in AS data mode and not returned in XS data mode: - hotlineContact Attributes: - access_device (accessDevice): accessDevice - line_port (str): linePort - private_identity (str): privateIdentity *Optional* - contact (List[contact]): contact *Optional* - static_registration_capable (bool): staticRegistrationCapable - use_domain (bool): useDomain - port_number (int): portNumber *Optional* - support_visual_device_management (bool): supportVisualDeviceManagement - use_hotline (bool): useHotline - hotline_contact (str): hotlineContact *Optional* + mode (str): mode + value (str): value + is_case_insensitive (bool): isCaseInsensitive """ __slots__: List[str] = [ - "access_device", - "line_port", - "private_identity", - "contact", - "static_registration_capable", - "use_domain", - "port_number", - "support_visual_device_management", - "use_hotline", - "hotline_contact", + "mode", + "value", + "is_case_insensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E( - "access_device", - "accessDevice", - AccessDevice, - is_complex=True, - is_required=True, - ), - E("line_port", "linePort", str, is_required=True), - E("private_identity", "privateIdentity", str), - E("contact", "contact", SIPContactInfo, is_complex=True, is_array=True), - E( - "static_registration_capable", - "staticRegistrationCapable", - bool, - is_required=True, - ), - E("use_domain", "useDomain", bool, is_required=True), - E("port_number", "portNumber", int), - E( - "support_visual_device_management", - "supportVisualDeviceManagement", - bool, - is_required=True, - ), - E("use_hotline", "useHotline", bool, is_required=True), - E("hotline_contact", "hotlineContact", str), + E("mode", "mode", str, is_required=True), + E("value", "value", str, is_required=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), ) -class AccessDeviceMultipleIdentityEndpointAdd(OCIType): +class SearchCriteriaAnnouncementFileName(SearchCriteria): """ - Access device end point used in the context of add. + Criteria for searching for an Announcement File Name. - The endpoint is identified by its linePort (public Identity) and possibly a private - Identity. Port numbers are only used by devices with static line ordering. The - following elements are only used in XS data mode and ignored in AS data mode: - privateIdentity Attributes: - access_device (accessDevice): accessDevice - line_port (str): linePort - private_identity (str): privateIdentity *Optional* - contact (str): contact *Optional* - port_number (int): portNumber *Optional* + mode (str): mode + value (str): value + is_case_insensitive (bool): isCaseInsensitive """ __slots__: List[str] = [ - "access_device", - "line_port", - "private_identity", - "contact", - "port_number", + "mode", + "value", + "is_case_insensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E( - "access_device", - "accessDevice", - AccessDevice, - is_complex=True, - is_required=True, - ), - E("line_port", "linePort", str, is_required=True), - E("private_identity", "privateIdentity", str), - E("contact", "contact", str), - E("port_number", "portNumber", int), + E("mode", "mode", str, is_required=True), + E("value", "value", str, is_required=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), ) -class AccessDeviceMultipleIdentityEndpointKey(OCIType): +class SearchCriteriaCallCenterName(SearchCriteria): """ - Access device end point in the context of a modify or delete command. - - The endpoint is identified by its linePort (public Identity) and possibly a private - Identity. The following elements are only used in XS data mode and ignored in AS data - mode: privateIdentity + Criteria for searching for a call center Attributes: - access_device (accessDevice): accessDevice - line_port (str): linePort - private_identity (str): privateIdentity *Optional* + mode (str): mode + value (str): value + is_case_insensitive (bool): isCaseInsensitive """ __slots__: List[str] = [ - "access_device", - "line_port", - "private_identity", + "mode", + "value", + "is_case_insensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E( - "access_device", - "accessDevice", - AccessDevice, - is_complex=True, - is_required=True, - ), - E("line_port", "linePort", str, is_required=True), - E("private_identity", "privateIdentity", str), + E("mode", "mode", str, is_required=True), + E("value", "value", str, is_required=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), ) -class AccessDeviceMultipleIdentityEndpointWithType(OCIType): +class SearchCriteriaCallCenterReportTemplateName(SearchCriteria): """ - Access device end point that can have multiple contacts. + Criteria for searching for a particular call center enhanced reporting report + template. - The endpoint is identified by its linePort (public Identity) and possibly a private - Identity. Port numbers are only used by devices with static line ordering. Attributes: - access_device (accessDevice): accessDevice - device_type (str): deviceType - line_port (str): linePort - private_identity (str): privateIdentity *Optional* - contact (str): contact *Optional* - port_number (int): portNumber *Optional* - mac_address (str): macAddress *Optional* + mode (str): mode + value (str): value + is_case_insensitive (bool): isCaseInsensitive """ __slots__: List[str] = [ - "access_device", - "device_type", - "line_port", - "private_identity", - "contact", - "port_number", - "mac_address", + "mode", + "value", + "is_case_insensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E( - "access_device", - "accessDevice", - AccessDevice, - is_complex=True, - is_required=True, - ), - E("device_type", "deviceType", str, is_required=True), - E("line_port", "linePort", str, is_required=True), - E("private_identity", "privateIdentity", str), - E("contact", "contact", str), - E("port_number", "portNumber", int), - E("mac_address", "macAddress", str), + E("mode", "mode", str, is_required=True), + E("value", "value", str, is_required=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), ) -class AutoAttendantKeyConfigurationEntry(OCIType): +class SearchCriteriaCallCenterScheduledReportName(SearchCriteria): """ - The configuration entry of a key for Auto Attendant. + Criteria for searching for a call center enhanced reporting scheduled report name. - The following elements are only used in AS data mode: audioFile videoFile Attributes: - description (str): description *Optional* - action (str): action - phone_number (str): phoneNumber *Optional* - audio_file (audioFile): audioFile *Optional* - video_file (videoFile): videoFile *Optional* + mode (str): mode + value (str): value + is_case_insensitive (bool): isCaseInsensitive """ __slots__: List[str] = [ - "description", - "action", - "phone_number", - "audio_file", - "video_file", + "mode", + "value", + "is_case_insensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("description", "description", str), - E("action", "action", str, is_required=True), - E("phone_number", "phoneNumber", str), - E("audio_file", "audioFile", LabeledMediaFileResource, is_complex=True), - E("video_file", "videoFile", LabeledMediaFileResource, is_complex=True), + E("mode", "mode", str, is_required=True), + E("value", "value", str, is_required=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), ) -class AutoAttendantKeyConfigurationEntry19(OCIType): +class SearchCriteriaCallParkName(SearchCriteria): """ - The configuration entry of a key for Auto Attendant. - - The following data elements are only valid for Standard Auto Attendants: submenuId + Criteria for searching for a call park by name Attributes: - description (str): description *Optional* - action (str): action - phone_number (str): phoneNumber *Optional* - audio_file (audioFile): audioFile *Optional* - video_file (videoFile): videoFile *Optional* - submenu_id (str): submenuId *Optional* + mode (str): mode + value (str): value + is_case_insensitive (bool): isCaseInsensitive """ __slots__: List[str] = [ - "description", - "action", - "phone_number", - "audio_file", - "video_file", - "submenu_id", + "mode", + "value", + "is_case_insensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("description", "description", str), - E("action", "action", str, is_required=True), - E("phone_number", "phoneNumber", str), - E("audio_file", "audioFile", LabeledMediaFileResource, is_complex=True), - E("video_file", "videoFile", LabeledMediaFileResource, is_complex=True), - E("submenu_id", "submenuId", str), + E("mode", "mode", str, is_required=True), + E("value", "value", str, is_required=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), ) -class AutoAttendantKeyConfigurationEntry20(OCIType): +class SearchCriteriaCallPickupName(SearchCriteria): """ - The configuration entry of a key for Auto Attendant. - - The following data elements are only used in AS data mode: audioFile videoFile - submenuId The following data elements are only valid for Standard Auto Attendants: - submenuId + Criteria for searching for a call pickup by name Attributes: - description (str): description *Optional* - action (str): action - phone_number (str): phoneNumber *Optional* - audio_file (audioFile): audioFile *Optional* - video_file (videoFile): videoFile *Optional* - submenu_id (str): submenuId *Optional* + mode (str): mode + value (str): value + is_case_insensitive (bool): isCaseInsensitive """ __slots__: List[str] = [ - "description", - "action", - "phone_number", - "audio_file", - "video_file", - "submenu_id", + "mode", + "value", + "is_case_insensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("description", "description", str), - E("action", "action", str, is_required=True), - E("phone_number", "phoneNumber", str), - E("audio_file", "audioFile", AnnouncementFileLevelKey, is_complex=True), - E("video_file", "videoFile", AnnouncementFileLevelKey, is_complex=True), - E("submenu_id", "submenuId", str), + E("mode", "mode", str, is_required=True), + E("value", "value", str, is_required=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), ) -class AutoAttendantKeyConfigurationModifyEntry(OCIType): +class SearchCriteriaCommunicationBarringAuthorizationCode(SearchCriteria): """ - The modify configuration entry of a key for Auto Attendant. + Criteria for searching for a Communication Barring Authorization Code. - The following data elements are only valid for Standard Auto Attendants: submenuId Attributes: - description (str): description *Optional* - action (str): action - phone_number (str): phoneNumber *Optional* - audio_file (audioFile): audioFile *Optional* - video_file (videoFile): videoFile *Optional* - submenu_id (str): submenuId *Optional* + mode (str): mode + value (str): value + is_case_insensitive (bool): isCaseInsensitive """ __slots__: List[str] = [ - "description", - "action", - "phone_number", - "audio_file", - "video_file", - "submenu_id", + "mode", + "value", + "is_case_insensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("description", "description", str), - E("action", "action", str, is_required=True), - E("phone_number", "phoneNumber", str), - E("audio_file", "audioFile", LabeledMediaFileResource, is_complex=True), - E("video_file", "videoFile", LabeledMediaFileResource, is_complex=True), - E("submenu_id", "submenuId", str), + E("mode", "mode", str, is_required=True), + E("value", "value", str, is_required=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), ) -class AutoAttendantKeyConfigurationModifyEntry20(OCIType): +class SearchCriteriaCommunicationBarringAuthorizationCodeDescription(SearchCriteria): """ - The modify configuration entry of a key for Auto Attendant. + Criteria for searching for a Communication Barring Authorization Code description. - The following data elements are only used in AS data mode: audioFile videoFile - submenuId The following data elements are only valid for Standard Auto Attendants: - submenuId Attributes: - description (str): description *Optional* - action (str): action - phone_number (str): phoneNumber *Optional* - audio_file (audioFile): audioFile *Optional* - video_file (videoFile): videoFile *Optional* - submenu_id (str): submenuId *Optional* + mode (str): mode + value (str): value + is_case_insensitive (bool): isCaseInsensitive """ __slots__: List[str] = [ - "description", - "action", - "phone_number", - "audio_file", - "video_file", - "submenu_id", + "mode", + "value", + "is_case_insensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("description", "description", str), - E("action", "action", str, is_required=True), - E("phone_number", "phoneNumber", str), - E("audio_file", "audioFile", AnnouncementFileLevelKey, is_complex=True), - E("video_file", "videoFile", AnnouncementFileLevelKey, is_complex=True), - E("submenu_id", "submenuId", str), + E("mode", "mode", str, is_required=True), + E("value", "value", str, is_required=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), ) -class AutoAttendantKeyConfigurationReadEntry20(OCIType): +class SearchCriteriaComposedOrDnExtension(SearchCriteriaComposedOr): """ - The read configuration entry of a key for Auto Attendant. + Criteria for searching for a DN OR an extension. - The following data elements are only used in AS data mode: submenuId The following - data elements are only valid for Standard Auto Attendants: submenuId + Note: For this search criterion, the searchMode is always ‘Contains’ and the search + criteria are always OR’ed. Attributes: - description (str): description *Optional* - action (str): action - phone_number (str): phoneNumber *Optional* - audio_file (audioFile): audioFile *Optional* - video_file (videoFile): videoFile *Optional* - submenu_id (str): submenuId *Optional* + value (value): value """ __slots__: List[str] = [ - "description", - "action", - "phone_number", - "audio_file", - "video_file", - "submenu_id", + "value", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("description", "description", str), - E("action", "action", str, is_required=True), - E("phone_number", "phoneNumber", str), - E("audio_file", "audioFile", AnnouncementFileLevelKey, is_complex=True), - E("video_file", "videoFile", AnnouncementFileLevelKey, is_complex=True), - E("submenu_id", "submenuId", str), + E("value", "value", UserDNExtension, is_complex=True, is_required=True), ) -class AutoAttendantKeyReadConfiguration(OCIType): +class SearchCriteriaComposedOrUserName(SearchCriteriaComposedOr): """ - The read configuration of a key for Auto Attendant. + Criteria for searching for a user's full name. + This search criterion will be compared against multiple combinations of first name and + last name: First Name + ‘ ‘ + Last Name Last Name + ‘ ‘ + First Name Hiragana Last + Name + ' ' + Hiragana First Name Note: For this search criterion, the searchMode is + always ‘Contains’ and the search criteria are always OR’ed. Attributes: - key (str): key - entry (entry): entry + value (List[str]): value + is_case_insensitive (bool): isCaseInsensitive """ __slots__: List[str] = [ - "key", - "entry", + "value", + "is_case_insensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("key", "key", str, is_required=True), - E( - "entry", - "entry", - AutoAttendantKeyConfigurationReadEntry, - is_complex=True, - is_required=True, - ), + E("value", "value", str, is_required=True, is_array=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), ) -class AutoAttendantKeyReadConfiguration19(OCIType): +class SearchCriteriaDepartmentName(SearchCriteria): """ - The read configuration of a key for Auto Attendant. + Criteria for searching for a user's department. Attributes: - key (str): key - entry (entry): entry + mode (str): mode + value (str): value + is_case_insensitive (bool): isCaseInsensitive """ __slots__: List[str] = [ - "key", - "entry", + "mode", + "value", + "is_case_insensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("key", "key", str, is_required=True), - E( - "entry", - "entry", - AutoAttendantKeyConfigurationReadEntry19, - is_complex=True, - is_required=True, - ), + E("mode", "mode", str, is_required=True), + E("value", "value", str, is_required=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), ) -class CPEDeviceOptionsRead(OCIType): +class SearchCriteriaDeviceMACAddress(SearchCriteria): """ - CPE device's options. + Criteria for searching for device MAC address. Attributes: - enable_monitoring (bool): enableMonitoring - reset_event (str): resetEvent *Optional* - config_type (str): configType - system_file_name (str): systemFileName *Optional* - device_file_format (str): deviceFileFormat *Optional* - device_management_device_type_options (deviceManagementDeviceTypeOptions): - deviceManagementDeviceTypeOptions *Optional* + mode (str): mode + value (str): value + is_case_insensitive (bool): isCaseInsensitive """ __slots__: List[str] = [ - "enable_monitoring", - "reset_event", - "config_type", - "system_file_name", - "device_file_format", - "device_management_device_type_options", + "mode", + "value", + "is_case_insensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("enable_monitoring", "enableMonitoring", bool, is_required=True), - E("reset_event", "resetEvent", str), - E("config_type", "configType", str, is_required=True), - E("system_file_name", "systemFileName", str), - E("device_file_format", "deviceFileFormat", str), - E( - "device_management_device_type_options", - "deviceManagementDeviceTypeOptions", - DeviceManagementDeviceTypeOptionsRead, - is_complex=True, - ), + E("mode", "mode", str, is_required=True), + E("value", "value", str, is_required=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), ) -class CPEDeviceOptionsRead16(OCIType): +class SearchCriteriaDeviceManagementEventAdditionalInfo(SearchCriteria): """ - CPE device's options. + Criteria for searching for a particular additional info of a DeviceManagement event. Attributes: - enable_monitoring (bool): enableMonitoring - reset_event (str): resetEvent *Optional* - config_type (str): configType - system_file_name (str): systemFileName *Optional* - device_file_format (str): deviceFileFormat *Optional* - device_management_device_type_options (deviceManagementDeviceTypeOptions): - deviceManagementDeviceTypeOptions *Optional* + mode (str): mode + value (str): value + is_case_insensitive (bool): isCaseInsensitive """ __slots__: List[str] = [ - "enable_monitoring", - "reset_event", - "config_type", - "system_file_name", - "device_file_format", - "device_management_device_type_options", + "mode", + "value", + "is_case_insensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("enable_monitoring", "enableMonitoring", bool, is_required=True), - E("reset_event", "resetEvent", str), - E("config_type", "configType", str, is_required=True), - E("system_file_name", "systemFileName", str), - E("device_file_format", "deviceFileFormat", str), - E( - "device_management_device_type_options", - "deviceManagementDeviceTypeOptions", - DeviceManagementDeviceTypeOptionsRead16, - is_complex=True, - ), + E("mode", "mode", str, is_required=True), + E("value", "value", str, is_required=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), ) -class CPEDeviceOptionsRead16sp1(OCIType): +class SearchCriteriaDeviceManagementEventLoginId(SearchCriteria): """ - CPE device's options. + Criteria for searching for a particular login id. Attributes: - enable_monitoring (bool): enableMonitoring - config_type (str): configType *Optional* - system_file_name (str): systemFileName *Optional* - device_file_format (str): deviceFileFormat *Optional* - device_management_device_type_options (deviceManagementDeviceTypeOptions): - deviceManagementDeviceTypeOptions *Optional* + mode (str): mode + value (str): value + is_case_insensitive (bool): isCaseInsensitive """ __slots__: List[str] = [ - "enable_monitoring", - "config_type", - "system_file_name", - "device_file_format", - "device_management_device_type_options", + "mode", + "value", + "is_case_insensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("enable_monitoring", "enableMonitoring", bool, is_required=True), - E("config_type", "configType", str), - E("system_file_name", "systemFileName", str), - E("device_file_format", "deviceFileFormat", str), - E( - "device_management_device_type_options", - "deviceManagementDeviceTypeOptions", - DeviceManagementDeviceTypeOptionsRead16, - is_complex=True, - ), + E("mode", "mode", str, is_required=True), + E("value", "value", str, is_required=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), ) -class CPEDeviceOptionsRead21sp1(OCIType): +class SearchCriteriaDeviceName(SearchCriteria): """ - CPE device's options. + Criteria for searching for device name. Attributes: - enable_monitoring (bool): enableMonitoring - config_type (str): configType *Optional* - system_file_name (str): systemFileName *Optional* - device_file_format (str): deviceFileFormat *Optional* - device_management_device_type_options (deviceManagementDeviceTypeOptions): - deviceManagementDeviceTypeOptions *Optional* + mode (str): mode + value (str): value + is_case_insensitive (bool): isCaseInsensitive """ __slots__: List[str] = [ - "enable_monitoring", - "config_type", - "system_file_name", - "device_file_format", - "device_management_device_type_options", + "mode", + "value", + "is_case_insensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("enable_monitoring", "enableMonitoring", bool, is_required=True), - E("config_type", "configType", str), - E("system_file_name", "systemFileName", str), - E("device_file_format", "deviceFileFormat", str), - E( - "device_management_device_type_options", - "deviceManagementDeviceTypeOptions", - DeviceManagementDeviceTypeOptionsRead21sp1, - is_complex=True, - ), + E("mode", "mode", str, is_required=True), + E("value", "value", str, is_required=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), ) -class CPEDeviceOptionsRead22(OCIType): +class SearchCriteriaDeviceNetAddress(SearchCriteria): """ - CPE device's options. + Criteria for searching for device network address. Attributes: - enable_monitoring (bool): enableMonitoring - config_type (str): configType *Optional* - system_file_name (str): systemFileName *Optional* - device_file_format (str): deviceFileFormat *Optional* - device_management_device_type_options (deviceManagementDeviceTypeOptions): - deviceManagementDeviceTypeOptions *Optional* + mode (str): mode + value (str): value + is_case_insensitive (bool): isCaseInsensitive """ __slots__: List[str] = [ - "enable_monitoring", - "config_type", - "system_file_name", - "device_file_format", - "device_management_device_type_options", + "mode", + "value", + "is_case_insensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("enable_monitoring", "enableMonitoring", bool, is_required=True), - E("config_type", "configType", str), - E("system_file_name", "systemFileName", str), - E("device_file_format", "deviceFileFormat", str), - E( - "device_management_device_type_options", - "deviceManagementDeviceTypeOptions", - DeviceManagementDeviceTypeOptionsRead22, - is_complex=True, - ), - ) - + E("mode", "mode", str, is_required=True), + E("value", "value", str, is_required=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + ) -class CPEDeviceOptionsRead22V2(OCIType): + +class SearchCriteriaDeviceSerialNumber(SearchCriteria): """ - CPE device's options. + Criteria for searching for device serial number. Attributes: - enable_monitoring (bool): enableMonitoring - config_type (str): configType *Optional* - system_file_name (str): systemFileName *Optional* - device_file_format (str): deviceFileFormat *Optional* - device_management_device_type_options (deviceManagementDeviceTypeOptions): - deviceManagementDeviceTypeOptions *Optional* + mode (str): mode + value (str): value + is_case_insensitive (bool): isCaseInsensitive """ __slots__: List[str] = [ - "enable_monitoring", - "config_type", - "system_file_name", - "device_file_format", - "device_management_device_type_options", + "mode", + "value", + "is_case_insensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("enable_monitoring", "enableMonitoring", bool, is_required=True), - E("config_type", "configType", str), - E("system_file_name", "systemFileName", str), - E("device_file_format", "deviceFileFormat", str), - E( - "device_management_device_type_options", - "deviceManagementDeviceTypeOptions", - DeviceManagementDeviceTypeOptionsRead22V2, - is_complex=True, - ), + E("mode", "mode", str, is_required=True), + E("value", "value", str, is_required=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), ) -class CPEDeviceOptionsRead22V3(OCIType): +class SearchCriteriaDeviceType(SearchCriteria): """ - CPE device's options. + Criteria for searching for device type. Attributes: - enable_monitoring (bool): enableMonitoring - config_type (str): configType *Optional* - system_file_name (str): systemFileName *Optional* - device_file_format (str): deviceFileFormat *Optional* - device_management_device_type_options (deviceManagementDeviceTypeOptions): - deviceManagementDeviceTypeOptions *Optional* + mode (str): mode + value (str): value + is_case_insensitive (bool): isCaseInsensitive """ __slots__: List[str] = [ - "enable_monitoring", - "config_type", - "system_file_name", - "device_file_format", - "device_management_device_type_options", + "mode", + "value", + "is_case_insensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("enable_monitoring", "enableMonitoring", bool, is_required=True), - E("config_type", "configType", str), - E("system_file_name", "systemFileName", str), - E("device_file_format", "deviceFileFormat", str), - E( - "device_management_device_type_options", - "deviceManagementDeviceTypeOptions", - DeviceManagementDeviceTypeOptionsRead22V3, - is_complex=True, - ), + E("mode", "mode", str, is_required=True), + E("value", "value", str, is_required=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), ) -class CPEDeviceOptionsRead22V4(OCIType): +class SearchCriteriaDigitPattern(SearchCriteria): """ - CPE device's options. + Criteria for searching for digit pattern. Attributes: - enable_monitoring (bool): enableMonitoring - config_type (str): configType *Optional* - system_file_name (str): systemFileName *Optional* - device_file_format (str): deviceFileFormat *Optional* - device_management_device_type_options (deviceManagementDeviceTypeOptions): - deviceManagementDeviceTypeOptions *Optional* + mode (str): mode + value (str): value + is_case_insensitive (bool): isCaseInsensitive """ __slots__: List[str] = [ - "enable_monitoring", - "config_type", - "system_file_name", - "device_file_format", - "device_management_device_type_options", + "mode", + "value", + "is_case_insensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("enable_monitoring", "enableMonitoring", bool, is_required=True), - E("config_type", "configType", str), - E("system_file_name", "systemFileName", str), - E("device_file_format", "deviceFileFormat", str), - E( - "device_management_device_type_options", - "deviceManagementDeviceTypeOptions", - DeviceManagementDeviceTypeOptionsRead22V4, - is_complex=True, - ), + E("mode", "mode", str, is_required=True), + E("value", "value", str, is_required=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), ) -class CallCenterAgentStatistics13mp8(OCIType): +class SearchCriteriaDn(SearchCriteria): """ - Contains Call Center statistics for a specified agent. + Criteria for searching for a DN. Attributes: - agent_user_id (str): agentUserId - agent_display_names (agentDisplayNames): agentDisplayNames - available (bool): available - statistics_yesterday (statisticsYesterday): statisticsYesterday - statistics_today (statisticsToday): statisticsToday + mode (str): mode + value (str): value + is_case_insensitive (bool): isCaseInsensitive """ __slots__: List[str] = [ - "agent_user_id", - "agent_display_names", - "available", - "statistics_yesterday", - "statistics_today", + "mode", + "value", + "is_case_insensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("agent_user_id", "agentUserId", str, is_required=True), - E( - "agent_display_names", - "agentDisplayNames", - UserDisplayNames, - is_complex=True, - is_required=True, - ), - E("available", "available", bool, is_required=True), - E( - "statistics_yesterday", - "statisticsYesterday", - CallCenterAgentDailyStatistics13mp8, - is_complex=True, - is_required=True, - ), - E( - "statistics_today", - "statisticsToday", - CallCenterAgentDailyStatistics13mp8, - is_complex=True, - is_required=True, - ), + E("mode", "mode", str, is_required=True), + E("value", "value", str, is_required=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), ) -class CallCenterAgentStatistics14sp9(OCIType): +class SearchCriteriaDomainName(SearchCriteria): """ - Contains Call Center statistics for a specified agent. + Criteria for searching for Domain Names. Attributes: - agent_user_id (str): agentUserId - agent_display_names (agentDisplayNames): agentDisplayNames - available (bool): available - statistics (statistics): statistics + mode (str): mode + value (str): value + is_case_insensitive (bool): isCaseInsensitive """ __slots__: List[str] = [ - "agent_user_id", - "agent_display_names", - "available", - "statistics", + "mode", + "value", + "is_case_insensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("agent_user_id", "agentUserId", str, is_required=True), - E( - "agent_display_names", - "agentDisplayNames", - UserDisplayNames, - is_complex=True, - is_required=True, - ), - E("available", "available", bool, is_required=True), - E( - "statistics", - "statistics", - AgentStatistics, - is_complex=True, - is_required=True, - ), + E("mode", "mode", str, is_required=True), + E("value", "value", str, is_required=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), ) -class CallCenterAnnouncementFileListModify(OCIType): +class SearchCriteriaEmailAddress(SearchCriteria): """ - Contains a list of audio or video files to modify. + Criteria for searching for a email address. Attributes: - file1 (file1): file1 *Optional* - file2 (file2): file2 *Optional* - file3 (file3): file3 *Optional* - file4 (file4): file4 *Optional* + mode (str): mode + value (str): value + is_case_insensitive (bool): isCaseInsensitive """ __slots__: List[str] = [ - "file1", - "file2", - "file3", - "file4", + "mode", + "value", + "is_case_insensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("file1", "file1", LabeledMediaFileResource, is_complex=True), - E("file2", "file2", LabeledMediaFileResource, is_complex=True), - E("file3", "file3", LabeledMediaFileResource, is_complex=True), - E("file4", "file4", LabeledMediaFileResource, is_complex=True), + E("mode", "mode", str, is_required=True), + E("value", "value", str, is_required=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), ) -class CallCenterAnnouncementFileListModify20(OCIType): +class SearchCriteriaEnterpriseCommonMultiPartPhoneListName(SearchCriteria): """ - Contains a list of announcement repository files + Criteria for searching for a multi-part name in an enterprise common phone list. + + Note: For this search criterion, the searchMode is always ‘Contains’ and the multi- + part search criteria are always AND’ed. Attributes: - file1 (file1): file1 *Optional* - file2 (file2): file2 *Optional* - file3 (file3): file3 *Optional* - file4 (file4): file4 *Optional* + value (List[str]): value + is_case_insensitive (bool): isCaseInsensitive """ __slots__: List[str] = [ - "file1", - "file2", - "file3", - "file4", + "value", + "is_case_insensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("file1", "file1", AnnouncementFileLevelKey, is_complex=True), - E("file2", "file2", AnnouncementFileLevelKey, is_complex=True), - E("file3", "file3", AnnouncementFileLevelKey, is_complex=True), - E("file4", "file4", AnnouncementFileLevelKey, is_complex=True), + E("value", "value", str, is_required=True, is_array=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), ) -class CallCenterAnnouncementFileListRead20(OCIType): +class SearchCriteriaEnterpriseCommonPhoneListName(SearchCriteria): """ - Contains a list of announcement repository files + Criteria for searching for a name in an enterprise common phone list. + Attributes: - file1 (file1): file1 *Optional* - file2 (file2): file2 *Optional* - file3 (file3): file3 *Optional* - file4 (file4): file4 *Optional* + mode (str): mode + value (str): value + is_case_insensitive (bool): isCaseInsensitive """ __slots__: List[str] = [ - "file1", - "file2", - "file3", - "file4", + "mode", + "value", + "is_case_insensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("file1", "file1", AnnouncementFileLevelKey, is_complex=True), - E("file2", "file2", AnnouncementFileLevelKey, is_complex=True), - E("file3", "file3", AnnouncementFileLevelKey, is_complex=True), - E("file4", "file4", AnnouncementFileLevelKey, is_complex=True), + E("mode", "mode", str, is_required=True), + E("value", "value", str, is_required=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), ) -class CallCenterReplacementSkilledAgents(OCIType): +class SearchCriteriaEnterpriseCommonPhoneListNumber(SearchCriteria): """ - A list of agents grouped by skill levels. + Criteria for searching for a phone number in an enterprise common phone list. Attributes: - skill_level (int): skillLevel - agents (agents): agents + mode (str): mode + value (str): value + is_case_insensitive (bool): isCaseInsensitive """ __slots__: List[str] = [ - "skill_level", - "agents", + "mode", + "value", + "is_case_insensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("skill_level", "skillLevel", int, is_required=True), - E( - "agents", - "agents", - ReplacementUserIdList, - is_complex=True, - is_required=True, - ), + E("mode", "mode", str, is_required=True), + E("value", "value", str, is_required=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), ) -class CallCenterReportIntervalDates(OCIType): +class SearchCriteriaEnterpriseTrunkName(SearchCriteria): """ - The call center enhanced reporting report interval, using dates. + Criteria for searching for an Enterprise Trunk name. Attributes: - start_date (str): startDate - start_time (startTime): startTime - end_date (str): endDate - end_time (endTime): endTime + mode (str): mode + value (str): value + is_case_insensitive (bool): isCaseInsensitive """ __slots__: List[str] = [ - "start_date", - "start_time", - "end_date", - "end_time", + "mode", + "value", + "is_case_insensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("start_date", "startDate", str, is_required=True), - E("start_time", "startTime", HourMinute, is_complex=True, is_required=True), - E("end_date", "endDate", str, is_required=True), - E("end_time", "endTime", HourMinute, is_complex=True, is_required=True), + E("mode", "mode", str, is_required=True), + E("value", "value", str, is_required=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), ) -class CallCenterReportScheduleRecurrence(OCIType): +class SearchCriteriaExactAnnouncementFileType(SearchCriteria): """ - A recurring schedule for call center enhanced reporting scheduled report. + Criteria for searching for a particular announcement file type. Attributes: - time_zone (str): timeZone - start_date (str): startDate - schedule_time (scheduleTime): scheduleTime - recurrence (recurrence): recurrence + type (str): type """ __slots__: List[str] = [ - "time_zone", - "start_date", - "schedule_time", - "recurrence", + "type", ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return ( - E("time_zone", "timeZone", str, is_required=True), - E("start_date", "startDate", str, is_required=True), - E( - "schedule_time", - "scheduleTime", - HourMinute, - is_complex=True, - is_required=True, - ), - E( - "recurrence", - "recurrence", - Recurrence, - is_complex=True, - is_required=True, - ), - ) + return (E("type", "type", str, is_required=True),) -class CallCenterReportScheduleTime(OCIType): +class SearchCriteriaExactAutoAttendantType(SearchCriteria): """ - A scheduled time for call center enhanced reporting scheduled report. + Criteria for searching for a particular auto-attendant type. Attributes: - time_zone (str): timeZone - schedule_date (str): scheduleDate - schedule_time (scheduleTime): scheduleTime + type (str): type """ __slots__: List[str] = [ - "time_zone", - "schedule_date", - "schedule_time", + "type", ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return ( - E("time_zone", "timeZone", str, is_required=True), - E("schedule_date", "scheduleDate", str, is_required=True), - E( - "schedule_time", - "scheduleTime", - HourMinute, - is_complex=True, - is_required=True, - ), - ) + return (E("type", "type", str, is_required=True),) -class CallMeNowToDnCriteriaModify(OCIType): +class SearchCriteriaExactCallCenterReportTemplateKey(SearchCriteria): """ - The To dn criteria used on the call me now external number to be modified. + Criteria for searching for a particular call center enhanced reporting report + template. Attributes: - to_dn_criteria_selection (str): toDnCriteriaSelection *Optional* - phone_number_list (phoneNumberList): phoneNumberList *Optional* + report_template (reportTemplate): reportTemplate """ __slots__: List[str] = [ - "to_dn_criteria_selection", - "phone_number_list", + "report_template", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("to_dn_criteria_selection", "toDnCriteriaSelection", str), E( - "phone_number_list", - "phoneNumberList", - CriteriaReplacementDNList, + "report_template", + "reportTemplate", + CallCenterReportTemplateKey, is_complex=True, + is_required=True, ), ) -class CombinedAccessDeviceMultipleIdentityEndpointAdd(OCIType): +class SearchCriteriaExactCallCenterScheduledReportCreatedBySupervisor(SearchCriteria): """ - Access device end point used in the context of add. + Criteria for searching for call center scheduled report created by a supervisor or + administrator. - The endpoint is identified by its linePort (public Identity) and possibly a private - Identity. Only Static Registration capable devices may have more than one contact - defined. Port numbers are only used by devices with static line ordering. In the - case an access device referenced by accessDevice does not exist, the device will be - added. The device attributes deviceType, protocol, netAddress, port, - outboundProxyServerNetAddress, stunServerNetAddress, macAddress, serialNumber, - description, physicalLocation, transportProtocol, useCustomUserNamePassword and - accessDeviceCredentials will be ignored if the access device already exists. Attributes: - access_device (accessDevice): accessDevice - line_port (str): linePort - private_identity (str): privateIdentity *Optional* - contact (str): contact *Optional* - port_number (int): portNumber *Optional* - device_type (str): deviceType *Optional* - protocol (str): protocol *Optional* - net_address (str): netAddress *Optional* - port (int): port *Optional* - outbound_proxy_server_net_address (str): outboundProxyServerNetAddress *Optional* - stun_server_net_address (str): stunServerNetAddress *Optional* - mac_address (str): macAddress *Optional* - serial_number (str): serialNumber *Optional* - description (str): description *Optional* - physical_location (str): physicalLocation *Optional* - transport_protocol (str): transportProtocol *Optional* - use_custom_user_name_password (bool): useCustomUserNamePassword *Optional* - access_device_credentials (accessDeviceCredentials): accessDeviceCredentials - *Optional* + created_by_supervisor (bool): createdBySupervisor """ __slots__: List[str] = [ - "access_device", - "line_port", - "private_identity", - "contact", - "port_number", - "device_type", - "protocol", - "net_address", - "port", - "outbound_proxy_server_net_address", - "stun_server_net_address", - "mac_address", - "serial_number", - "description", - "physical_location", - "transport_protocol", - "use_custom_user_name_password", - "access_device_credentials", + "created_by_supervisor", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E( - "access_device", - "accessDevice", - AccessDevice, - is_complex=True, - is_required=True, - ), - E("line_port", "linePort", str, is_required=True), - E("private_identity", "privateIdentity", str), - E("contact", "contact", str), - E("port_number", "portNumber", int), - E("device_type", "deviceType", str), - E("protocol", "protocol", str), - E("net_address", "netAddress", str), - E("port", "port", int), - E( - "outbound_proxy_server_net_address", - "outboundProxyServerNetAddress", - str, - ), - E("stun_server_net_address", "stunServerNetAddress", str), - E("mac_address", "macAddress", str), - E("serial_number", "serialNumber", str), - E("description", "description", str), - E("physical_location", "physicalLocation", str), - E("transport_protocol", "transportProtocol", str), - E("use_custom_user_name_password", "useCustomUserNamePassword", bool), - E( - "access_device_credentials", - "accessDeviceCredentials", - DeviceManagementUserNamePassword16, - is_complex=True, - ), + E("created_by_supervisor", "createdBySupervisor", bool, is_required=True), ) -class CombinedAccessDeviceMultipleIdentityEndpointModify(OCIType): +class SearchCriteriaExactCallCenterScheduledReportGroup(SearchCriteria): """ - Access device end point used in the context of modify. + Criteria for searching for a particular fully specified call center scheduled report's + group. - The endpoint is identified by its linePort (public Identity) and possibly a private - Identity. Only Static Registration capable devices may have more than one contact - defined. Port numbers are only used by devices with static line ordering. In the - case an access device referenced by accessDevice does not exist, the device will be - added. When the device needs to be added, if the linePort is not specified, the - request will fail The device attributes deviceType, protocol, netAddress, port, - outboundProxyServerNetAddress, stunServerNetAddress, macAddress, serialNumber, - description, physicalLocation, transportProtocol, useCustomUserNamePassword and - accessDeviceCredentials will be ignored if the access device already exists. Attributes: - access_device (accessDevice): accessDevice *Optional* - line_port (str): linePort *Optional* - private_identity (str): privateIdentity *Optional* - contact (str): contact *Optional* - port_number (int): portNumber *Optional* - device_type (str): deviceType *Optional* - protocol (str): protocol *Optional* - net_address (str): netAddress *Optional* - port (int): port *Optional* - outbound_proxy_server_net_address (str): outboundProxyServerNetAddress *Optional* - stun_server_net_address (str): stunServerNetAddress *Optional* - mac_address (str): macAddress *Optional* - serial_number (str): serialNumber *Optional* - description (str): description *Optional* - physical_location (str): physicalLocation *Optional* - transport_protocol (str): transportProtocol *Optional* - use_custom_user_name_password (bool): useCustomUserNamePassword *Optional* - access_device_credentials (accessDeviceCredentials): accessDeviceCredentials - *Optional* + service_provider_id (str): serviceProviderId + group_id (str): groupId """ __slots__: List[str] = [ - "access_device", - "line_port", - "private_identity", - "contact", - "port_number", - "device_type", - "protocol", - "net_address", - "port", - "outbound_proxy_server_net_address", - "stun_server_net_address", - "mac_address", - "serial_number", - "description", - "physical_location", - "transport_protocol", - "use_custom_user_name_password", - "access_device_credentials", + "service_provider_id", + "group_id", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("access_device", "accessDevice", AccessDevice, is_complex=True), - E("line_port", "linePort", str), - E("private_identity", "privateIdentity", str), - E("contact", "contact", str), - E("port_number", "portNumber", int), - E("device_type", "deviceType", str), - E("protocol", "protocol", str), - E("net_address", "netAddress", str), - E("port", "port", int), - E( - "outbound_proxy_server_net_address", - "outboundProxyServerNetAddress", - str, - ), - E("stun_server_net_address", "stunServerNetAddress", str), - E("mac_address", "macAddress", str), - E("serial_number", "serialNumber", str), - E("description", "description", str), - E("physical_location", "physicalLocation", str), - E("transport_protocol", "transportProtocol", str), - E("use_custom_user_name_password", "useCustomUserNamePassword", bool), - E( - "access_device_credentials", - "accessDeviceCredentials", - DeviceManagementUserNamePassword16, - is_complex=True, - ), + E("service_provider_id", "serviceProviderId", str, is_required=True), + E("group_id", "groupId", str, is_required=True), ) -class CombinedGroupServiceAuthorization(OCIType): +class SearchCriteriaExactCallCenterScheduledReportServiceProvider(SearchCriteria): """ - Authorize a group service. + Criteria for searching for a particular call center scheduled report's service + provider. Attributes: - service_name (str): serviceName - authorized_quantity (authorizedQuantity): authorizedQuantity *Optional* + service_provider_id (str): serviceProviderId """ __slots__: List[str] = [ - "service_name", - "authorized_quantity", + "service_provider_id", ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return ( - E("service_name", "serviceName", str, is_required=True), - E( - "authorized_quantity", - "authorizedQuantity", - UnboundedPositiveInt, - is_complex=True, - ), - ) + return (E("service_provider_id", "serviceProviderId", str, is_required=True),) -class CombinedServiceInstanceAddProfile(OCIType): +class SearchCriteriaExactCallCenterType(SearchCriteria): """ - Service Profile Information for group service. + Criteria for searching for a particular fully specified call center type. - When name, callingLineIdLastName and callingLineIdFirstName are not included, the - values in the corresponding service instance template (if this is used to add a Hunt - Group, for example, the name will come from the Hunt Group template) will be used. - Otherwise, the request will fail. If the phoneNumber has not been assigned to the - group, it will be added to group and service provider if needed. Attributes: - name (str): name *Optional* - calling_line_id_last_name (str): callingLineIdLastName *Optional* - calling_line_id_first_name (str): callingLineIdFirstName *Optional* - hiragana_last_name (str): hiraganaLastName *Optional* - hiragana_first_name (str): hiraganaFirstName *Optional* - phone_number (str): phoneNumber *Optional* - extension (str): extension *Optional* - password (str): password *Optional* - department (department): department *Optional* - language (str): language *Optional* - time_zone (str): timeZone *Optional* - alias (List[str]): alias *Optional* - public_user_identity (str): publicUserIdentity *Optional* - calling_line_id_phone_number (str): callingLineIdPhoneNumber *Optional* + call_center_type (str): callCenterType """ __slots__: List[str] = [ - "name", - "calling_line_id_last_name", - "calling_line_id_first_name", - "hiragana_last_name", - "hiragana_first_name", - "phone_number", - "extension", - "password", - "department", - "language", - "time_zone", - "alias", - "public_user_identity", - "calling_line_id_phone_number", + "call_center_type", ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return ( - E("name", "name", str), - E("calling_line_id_last_name", "callingLineIdLastName", str), - E("calling_line_id_first_name", "callingLineIdFirstName", str), - E("hiragana_last_name", "hiraganaLastName", str), - E("hiragana_first_name", "hiraganaFirstName", str), - E("phone_number", "phoneNumber", str), - E("extension", "extension", str), - E("password", "password", str), - E("department", "department", DepartmentKey, is_complex=True), - E("language", "language", str), - E("time_zone", "timeZone", str), - E("alias", "alias", str, is_array=True), - E("public_user_identity", "publicUserIdentity", str), - E("calling_line_id_phone_number", "callingLineIdPhoneNumber", str), - ) + return (E("call_center_type", "callCenterType", str, is_required=True),) -class CombinedServicePackAssignment(OCIType): +class SearchCriteriaExactCustomContactDirectory(SearchCriteria): """ - Assign a service pack to user. + Criteria for searching for a particular fully specified custom contact directory. - If the service pack has not been authorized to service provider or group, it will be - authorized. If the service pack needs to be authorized at group/service provider - levels, the authorizedQuantity will be used. Otherwise, it will be ignored. If the - authorizedQuantity is not included, the quantity will come from the group template for - the service pack. If a template does not exist, the service quantity will be set to - unlimited. Attributes: - service_pack_name (str): servicePackName - authorized_quantity (authorizedQuantity): authorizedQuantity *Optional* + custom_contact_directory_name (str): customContactDirectoryName """ __slots__: List[str] = [ - "service_pack_name", - "authorized_quantity", + "custom_contact_directory_name", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("service_pack_name", "servicePackName", str, is_required=True), E( - "authorized_quantity", - "authorizedQuantity", - UnboundedPositiveInt, - is_complex=True, + "custom_contact_directory_name", + "customContactDirectoryName", + str, + is_required=True, ), ) -class CombinedServicePackAuthorization(OCIType): +class SearchCriteriaExactDeviceLevel(SearchCriteria): """ - Authorize a service pack. + Criteria for searching for a particular device level. Attributes: - service_pack_name (str): servicePackName - authorized_quantity (authorizedQuantity): authorizedQuantity *Optional* + device_level (str): deviceLevel """ __slots__: List[str] = [ - "service_pack_name", - "authorized_quantity", + "device_level", ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return ( - E("service_pack_name", "servicePackName", str, is_required=True), - E( - "authorized_quantity", - "authorizedQuantity", - UnboundedPositiveInt, - is_complex=True, - ), - ) + return (E("device_level", "deviceLevel", str, is_required=True),) -class CombinedSharedCallAppearanceAccessDeviceMultipleIdentityEndpoint(OCIType): +class SearchCriteriaExactDeviceManagementEventAction(SearchCriteria): """ - Access device end point for Shared Call Appearance Service used in the context of add. + Criteria for searching for a particular fully specified DeviceManagement event action. - The endpoint is identified by its linePort (public Identity) and possibly a private - Identity. Port numbers are only used by devices with static line ordering. In the - case an access device referenced by accessDevice does not exist, the device will be - added. When elements for isActive, allowOrigination, allowTermination and allowVideo - are not included in the request, the values for them will come for the Shared Call - Appearance endpoints template. If the template does not exist, the request using this - data type will fail. The device attributes deviceType, protocol, netAddress, port, - outboundProxyServerNetAddress, stunServerNetAddress, macAddress, serialNumber, - description, physicalLocation, transportProtocol, useCustomUserNamePassword and - accessDeviceCredentials will be ignored if the access device already exists. Attributes: - access_device (accessDevice): accessDevice - line_port (str): linePort - private_identity (str): privateIdentity *Optional* - contact (str): contact *Optional* - port_number (int): portNumber *Optional* - is_active (bool): isActive *Optional* - allow_origination (bool): allowOrigination *Optional* - allow_termination (bool): allowTermination *Optional* - allow_video (bool): allowVideo *Optional* - device_type (str): deviceType *Optional* - protocol (str): protocol *Optional* - net_address (str): netAddress *Optional* - port (int): port *Optional* - outbound_proxy_server_net_address (str): outboundProxyServerNetAddress *Optional* - stun_server_net_address (str): stunServerNetAddress *Optional* - mac_address (str): macAddress *Optional* - serial_number (str): serialNumber *Optional* - description (str): description *Optional* - physical_location (str): physicalLocation *Optional* - transport_protocol (str): transportProtocol *Optional* - use_custom_user_name_password (bool): useCustomUserNamePassword *Optional* - access_device_credentials (accessDeviceCredentials): accessDeviceCredentials - *Optional* + dm_event_action (str): dmEventAction """ __slots__: List[str] = [ - "access_device", - "line_port", - "private_identity", - "contact", - "port_number", - "is_active", - "allow_origination", - "allow_termination", - "allow_video", - "device_type", - "protocol", - "net_address", - "port", - "outbound_proxy_server_net_address", - "stun_server_net_address", - "mac_address", - "serial_number", - "description", - "physical_location", - "transport_protocol", - "use_custom_user_name_password", - "access_device_credentials", + "dm_event_action", ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return ( - E( - "access_device", - "accessDevice", - AccessDevice, - is_complex=True, - is_required=True, - ), - E("line_port", "linePort", str, is_required=True), - E("private_identity", "privateIdentity", str), - E("contact", "contact", str), - E("port_number", "portNumber", int), - E("is_active", "isActive", bool), - E("allow_origination", "allowOrigination", bool), - E("allow_termination", "allowTermination", bool), - E("allow_video", "allowVideo", bool), - E("device_type", "deviceType", str), - E("protocol", "protocol", str), - E("net_address", "netAddress", str), - E("port", "port", int), - E( - "outbound_proxy_server_net_address", - "outboundProxyServerNetAddress", - str, - ), - E("stun_server_net_address", "stunServerNetAddress", str), - E("mac_address", "macAddress", str), - E("serial_number", "serialNumber", str), - E("description", "description", str), - E("physical_location", "physicalLocation", str), - E("transport_protocol", "transportProtocol", str), - E("use_custom_user_name_password", "useCustomUserNamePassword", bool), - E( - "access_device_credentials", - "accessDeviceCredentials", - DeviceManagementUserNamePassword16, - is_complex=True, - ), - ) + return (E("dm_event_action", "dmEventAction", str, is_required=True),) -class CombinedUserServiceAssignment(OCIType): +class SearchCriteriaExactDeviceManagementEventLevel(SearchCriteria): """ - Assign a service user. + Criteria for searching for a particular fully specified DeviceManagement event level. - If the service has not been authorized to service provider or group, it will be - authorized. If the service needs to be authorized at group/service provider levels, - the authorizedQuantity will be used. Otherwise, it will be ignored. If the - authorizedQuantity is not included, the quantity will come from the group template for - the service. If a template does not exist, the service quantity will be set to - unlimited. Attributes: - user_service (str): userService - authorized_quantity (authorizedQuantity): authorizedQuantity *Optional* + dm_event_level (str): dmEventLevel """ __slots__: List[str] = [ - "user_service", - "authorized_quantity", + "dm_event_level", ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return ( - E("user_service", "userService", str, is_required=True), - E( - "authorized_quantity", - "authorizedQuantity", - UnboundedPositiveInt, - is_complex=True, - ), - ) + return (E("dm_event_level", "dmEventLevel", str, is_required=True),) -class CombinedUserServiceAuthorization(OCIType): +class SearchCriteriaExactDeviceManagementEventStatusCompleted(SearchCriteria): """ - Authorize a user service. + Criteria for searching for a particular fully specified Device Management completed + event status. Attributes: - service_name (str): serviceName - authorized_quantity (authorizedQuantity): authorizedQuantity *Optional* + dm_event_status_completed (str): dmEventStatusCompleted """ __slots__: List[str] = [ - "service_name", - "authorized_quantity", + "dm_event_status_completed", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("service_name", "serviceName", str, is_required=True), E( - "authorized_quantity", - "authorizedQuantity", - UnboundedPositiveInt, - is_complex=True, + "dm_event_status_completed", + "dmEventStatusCompleted", + str, + is_required=True, ), ) -class CommPilotExpressAvailableInOffice(OCIType): +class SearchCriteriaExactDeviceManagementEventStatusInProgressOrPending(SearchCriteria): """ - CommPilot Express Available In Office Settings. + Criteria for searching for a particular fully specified Device Management event in + progress or pending status. Attributes: - additional_phone_number_to_ring (str): additionalPhoneNumberToRing *Optional* - busy_setting (busySetting): busySetting - no_answer_setting (noAnswerSetting): noAnswerSetting + dm_event_status_in_progress_or_pending (str): dmEventStatusInProgressOrPending """ __slots__: List[str] = [ - "additional_phone_number_to_ring", - "busy_setting", - "no_answer_setting", + "dm_event_status_in_progress_or_pending", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("additional_phone_number_to_ring", "additionalPhoneNumberToRing", str), - E( - "busy_setting", - "busySetting", - CommPilotExpressRedirection, - is_complex=True, - is_required=True, - ), E( - "no_answer_setting", - "noAnswerSetting", - CommPilotExpressRedirection, - is_complex=True, + "dm_event_status_in_progress_or_pending", + "dmEventStatusInProgressOrPending", + str, is_required=True, ), ) -class CommPilotExpressAvailableInOfficeModify(OCIType): +class SearchCriteriaExactDeviceManagementEventType(SearchCriteria): """ - CommPilot Express Available In Office Settings. + Criteria for searching for a particular fully specified DeviceManagement event type. Attributes: - additional_phone_number_to_ring (str): additionalPhoneNumberToRing *Optional* - busy_setting (busySetting): busySetting *Optional* - no_answer_setting (noAnswerSetting): noAnswerSetting *Optional* + dm_event_type (str): dmEventType """ __slots__: List[str] = [ - "additional_phone_number_to_ring", - "busy_setting", - "no_answer_setting", + "dm_event_type", ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return ( - E("additional_phone_number_to_ring", "additionalPhoneNumberToRing", str), - E( - "busy_setting", - "busySetting", - CommPilotExpressRedirectionModify, - is_complex=True, - ), - E( - "no_answer_setting", - "noAnswerSetting", - CommPilotExpressRedirectionModify, - is_complex=True, - ), - ) + return (E("dm_event_type", "dmEventType", str, is_required=True),) -class CommPilotExpressAvailableOutOfOffice(OCIType): +class SearchCriteriaExactDeviceServiceProvider(SearchCriteria): """ - CommPilot Express Available Out Of Office Configuration used in the context of a get. + Criteria for searching for a particular fully specified service provider associated + with a device. Attributes: - incoming_calls (incomingCalls): incomingCalls - incoming_call_notify (incomingCallNotify): incomingCallNotify + service_provider_id (str): serviceProviderId """ __slots__: List[str] = [ - "incoming_calls", - "incoming_call_notify", + "service_provider_id", ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return ( - E( - "incoming_calls", - "incomingCalls", - CommPilotExpressRedirection, - is_complex=True, - is_required=True, - ), - E( - "incoming_call_notify", - "incomingCallNotify", - CommPilotExpressEmailNotify, - is_complex=True, - is_required=True, - ), - ) + return (E("service_provider_id", "serviceProviderId", str, is_required=True),) -class CommPilotExpressAvailableOutOfOfficeModify(OCIType): +class SearchCriteriaExactDeviceType(SearchCriteria): """ - CommPilot Express Available Out Of Office Configuration used in the context of a - modify. + Criteria for searching for a particular fully specified device type. Attributes: - incoming_calls (incomingCalls): incomingCalls *Optional* - incoming_call_notify (incomingCallNotify): incomingCallNotify *Optional* + device_type (str): deviceType """ __slots__: List[str] = [ - "incoming_calls", - "incoming_call_notify", + "device_type", ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return ( - E( - "incoming_calls", - "incomingCalls", - CommPilotExpressRedirectionModify, - is_complex=True, - ), - E( - "incoming_call_notify", - "incomingCallNotify", - CommPilotExpressEmailNotifyModify, - is_complex=True, - ), - ) + return (E("device_type", "deviceType", str, is_required=True),) -class CommPilotExpressBusy(OCIType): +class SearchCriteriaExactDeviceTypeConfigurationOptionType(SearchCriteria): """ - CommPilot Express Available In Office Configuration used in the context of a get. + Criteria for searching for a particular fully specified + DeviceTypeConfigurationOptionType. Attributes: - incoming_calls (incomingCalls): incomingCalls - voice_mail_notify (voiceMailNotify): voiceMailNotify + device_config_options (str): deviceConfigOptions """ __slots__: List[str] = [ - "incoming_calls", - "voice_mail_notify", + "device_config_options", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E( - "incoming_calls", - "incomingCalls", - CommPilotExpressRedirectionWithException, - is_complex=True, - is_required=True, - ), - E( - "voice_mail_notify", - "voiceMailNotify", - CommPilotExpressEmailNotify, - is_complex=True, - is_required=True, - ), + E("device_config_options", "deviceConfigOptions", str, is_required=True), ) -class CommPilotExpressBusyModify(OCIType): +class SearchCriteriaExactDnActivation(SearchCriteria): """ - CommPilot Express Available In Office Configuration used in the context of a modify. + Criteria for searching for a particular Dn activation state. Attributes: - incoming_calls (incomingCalls): incomingCalls *Optional* - voice_mail_notify (voiceMailNotify): voiceMailNotify *Optional* + activated (bool): activated """ __slots__: List[str] = [ - "incoming_calls", - "voice_mail_notify", + "activated", ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return ( - E( - "incoming_calls", - "incomingCalls", - CommPilotExpressRedirectionWithExceptionModify, - is_complex=True, - ), - E( - "voice_mail_notify", - "voiceMailNotify", - CommPilotExpressEmailNotifyModify, - is_complex=True, - ), - ) + return (E("activated", "activated", bool, is_required=True),) -class CommPilotExpressUnavailable(OCIType): +class SearchCriteriaExactDnAvailability(SearchCriteria): """ - CommPilot Express Unavailable Configuration used in the context of a get. + Criteria for searching for a particular dn availability. Attributes: - incoming_calls (incomingCalls): incomingCalls - voice_mail_greeting (str): voiceMailGreeting + available (bool): available """ __slots__: List[str] = [ - "incoming_calls", - "voice_mail_greeting", + "available", ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return ( - E( - "incoming_calls", - "incomingCalls", - CommPilotExpressRedirectionWithException, - is_complex=True, - is_required=True, - ), - E("voice_mail_greeting", "voiceMailGreeting", str, is_required=True), - ) + return (E("available", "available", bool, is_required=True),) -class CommPilotExpressUnavailableModify(OCIType): +class SearchCriteriaExactDnDepartment(SearchCriteria): """ - CommPilot Express Unavailable Configuration used in the context of a modify. + Criteria for searching for a particular fully specified DN's department. Attributes: - incoming_calls (incomingCalls): incomingCalls *Optional* - voice_mail_greeting (str): voiceMailGreeting *Optional* + department_key (departmentKey): departmentKey """ __slots__: List[str] = [ - "incoming_calls", - "voice_mail_greeting", + "department_key", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( E( - "incoming_calls", - "incomingCalls", - CommPilotExpressRedirectionWithExceptionModify, + "department_key", + "departmentKey", + DepartmentKey, is_complex=True, + is_required=True, ), - E("voice_mail_greeting", "voiceMailGreeting", str), ) -class ConsolidatedAccessDeviceMultipleIdentityEndpointAndContactAdd(OCIType): +class SearchCriteriaExactDomainLevel(SearchCriteria): """ - Access device end point used in the context of add. + Criteria for searching for a particular domain level. - The endpoint is identified by its linePort (public Identity) and possibly a private - Identity. In XS data mode, only one contact can be defined. Only Static Registration - capable devices may have more than one contact defined. Port numbers are only used by - devices with static line ordering. In the case an access device referenced by - accessDevice does not exist, the device will be added. The device attributes - deviceType, protocol, netAddress, port, outboundProxyServerNetAddress, - stunServerNetAddress, macAddress, serialNumber, description, physicalLocation, - transportProtocol, useCustomUserNamePassword and accessDeviceCredentials will be - ignored if the access device already exists. Attributes: - access_device (accessDevice): accessDevice - line_port (str): linePort - private_identity (str): privateIdentity *Optional* - contact (List[str]): contact *Optional* - port_number (int): portNumber *Optional* - device_type (str): deviceType *Optional* - protocol (str): protocol *Optional* - net_address (str): netAddress *Optional* - port (int): port *Optional* - outbound_proxy_server_net_address (str): outboundProxyServerNetAddress *Optional* - stun_server_net_address (str): stunServerNetAddress *Optional* - mac_address (str): macAddress *Optional* - serial_number (str): serialNumber *Optional* - description (str): description *Optional* - physical_location (str): physicalLocation *Optional* - transport_protocol (str): transportProtocol *Optional* - use_custom_user_name_password (bool): useCustomUserNamePassword *Optional* - access_device_credentials (accessDeviceCredentials): accessDeviceCredentials - *Optional* + domain_level (str): domainLevel """ __slots__: List[str] = [ - "access_device", - "line_port", - "private_identity", - "contact", - "port_number", - "device_type", - "protocol", - "net_address", - "port", - "outbound_proxy_server_net_address", - "stun_server_net_address", - "mac_address", - "serial_number", - "description", - "physical_location", - "transport_protocol", - "use_custom_user_name_password", - "access_device_credentials", + "domain_level", ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return ( - E( - "access_device", - "accessDevice", - AccessDevice, - is_complex=True, - is_required=True, - ), - E("line_port", "linePort", str, is_required=True), - E("private_identity", "privateIdentity", str), - E("contact", "contact", str, is_array=True), - E("port_number", "portNumber", int), - E("device_type", "deviceType", str), - E("protocol", "protocol", str), - E("net_address", "netAddress", str), - E("port", "port", int), - E( - "outbound_proxy_server_net_address", - "outboundProxyServerNetAddress", - str, - ), - E("stun_server_net_address", "stunServerNetAddress", str), - E("mac_address", "macAddress", str), - E("serial_number", "serialNumber", str), - E("description", "description", str), - E("physical_location", "physicalLocation", str), - E("transport_protocol", "transportProtocol", str), - E("use_custom_user_name_password", "useCustomUserNamePassword", bool), - E( - "access_device_credentials", - "accessDeviceCredentials", - DeviceManagementUserNamePassword16, - is_complex=True, - ), - ) + return (E("domain_level", "domainLevel", str, is_required=True),) -class ConsolidatedAccessDeviceMultipleIdentityEndpointAndContactAdd22(OCIType): +class SearchCriteriaExactEndpointType(SearchCriteria): """ - Access device end point used in the context of add. + Criteria for searching for a particular endpoint type. - The endpoint is identified by its linePort (public Identity) and possibly a private - Identity. In XS data mode, only one contact can be defined. Only Static Registration - capable devices may have more than one contact defined. Port numbers are only used by - devices with static line ordering. In the case an access device referenced by - accessDevice does not exist, the device will be added. The device attributes - deviceType, protocol, netAddress, port, outboundProxyServerNetAddress, - stunServerNetAddress, macAddress, serialNumber, description, physicalLocation, - transportProtocol, useCustomUserNamePassword and accessDeviceCredentials will be - ignored if the access device already exists. The following elements are only used in - AS data mode and ignored in XS data mode: useHotline, use value false in XS data mode - hotlineContact Attributes: - access_device (accessDevice): accessDevice - line_port (str): linePort - private_identity (str): privateIdentity *Optional* - contact (List[str]): contact *Optional* - port_number (int): portNumber *Optional* - device_type (str): deviceType *Optional* - protocol (str): protocol *Optional* - net_address (str): netAddress *Optional* - port (int): port *Optional* - outbound_proxy_server_net_address (str): outboundProxyServerNetAddress *Optional* - stun_server_net_address (str): stunServerNetAddress *Optional* - mac_address (str): macAddress *Optional* - serial_number (str): serialNumber *Optional* - description (str): description *Optional* - physical_location (str): physicalLocation *Optional* - transport_protocol (str): transportProtocol *Optional* - use_custom_user_name_password (bool): useCustomUserNamePassword *Optional* - access_device_credentials (accessDeviceCredentials): accessDeviceCredentials - *Optional* - use_hotline (bool): useHotline - hotline_contact (str): hotlineContact *Optional* + endpoint_type (str): endpointType """ __slots__: List[str] = [ - "access_device", - "line_port", - "private_identity", - "contact", - "port_number", - "device_type", - "protocol", - "net_address", - "port", - "outbound_proxy_server_net_address", - "stun_server_net_address", - "mac_address", - "serial_number", - "description", - "physical_location", - "transport_protocol", - "use_custom_user_name_password", - "access_device_credentials", - "use_hotline", - "hotline_contact", + "endpoint_type", ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return ( - E( - "access_device", - "accessDevice", - AccessDevice, - is_complex=True, - is_required=True, - ), - E("line_port", "linePort", str, is_required=True), - E("private_identity", "privateIdentity", str), - E("contact", "contact", str, is_array=True), - E("port_number", "portNumber", int), - E("device_type", "deviceType", str), - E("protocol", "protocol", str), - E("net_address", "netAddress", str), - E("port", "port", int), - E( - "outbound_proxy_server_net_address", - "outboundProxyServerNetAddress", - str, - ), - E("stun_server_net_address", "stunServerNetAddress", str), - E("mac_address", "macAddress", str), - E("serial_number", "serialNumber", str), - E("description", "description", str), - E("physical_location", "physicalLocation", str), - E("transport_protocol", "transportProtocol", str), - E("use_custom_user_name_password", "useCustomUserNamePassword", bool), - E( - "access_device_credentials", - "accessDeviceCredentials", - DeviceManagementUserNamePassword16, - is_complex=True, - ), - E("use_hotline", "useHotline", bool, is_required=True), - E("hotline_contact", "hotlineContact", str), - ) + return (E("endpoint_type", "endpointType", str, is_required=True),) -class ConsolidatedAccessDeviceMultipleIdentityEndpointAndContactModify(OCIType): +class SearchCriteriaExactEndpointType21sp1(SearchCriteria): """ - Access device end point used in the context of modify. + Criteria for searching for a particular endpoint type. - . The endpoint is identified by its linePort (public Identity) and possibly a private - Identity. Only Static Registration capable devices may have more than one contact - defined. Only the first contact in contactList is used in XS data mode. Port numbers - are only used by devices with static line ordering. In the case an access device - referenced by accessDevice does not exist, the device will be added. When the device - needs to be added, if the linePort is not specified, the request will fail If the - deviceType is included in the request a new device will be created using the type - unless a device with the same name already exists. The device attributes protocol, - netAddress, port, outboundProxyServerNetAddress, stunServerNetAddress, macAddress, - serialNumber, description, physicalLocation, transportProtocol, - useCustomUserNamePassword and accessDeviceCredentials will be ignored if the access - device already exists. The following elements are only used in AS data mode and - ignored in XS data mode: useHotline hotlineContact Attributes: - access_device (accessDevice): accessDevice *Optional* - line_port (str): linePort *Optional* - private_identity (str): privateIdentity *Optional* - contact_list (contactList): contactList *Optional* - port_number (int): portNumber *Optional* - device_type (str): deviceType *Optional* - protocol (str): protocol *Optional* - net_address (str): netAddress *Optional* - port (int): port *Optional* - outbound_proxy_server_net_address (str): outboundProxyServerNetAddress *Optional* - stun_server_net_address (str): stunServerNetAddress *Optional* - mac_address (str): macAddress *Optional* - serial_number (str): serialNumber *Optional* - description (str): description *Optional* - physical_location (str): physicalLocation *Optional* - transport_protocol (str): transportProtocol *Optional* - use_custom_user_name_password (bool): useCustomUserNamePassword *Optional* - access_device_credentials (accessDeviceCredentials): accessDeviceCredentials - *Optional* - use_hotline (bool): useHotline *Optional* - hotline_contact (str): hotlineContact *Optional* + endpoint_type (str): endpointType """ __slots__: List[str] = [ - "access_device", - "line_port", - "private_identity", - "contact_list", - "port_number", - "device_type", - "protocol", - "net_address", - "port", - "outbound_proxy_server_net_address", - "stun_server_net_address", - "mac_address", - "serial_number", - "description", - "physical_location", - "transport_protocol", - "use_custom_user_name_password", - "access_device_credentials", - "use_hotline", - "hotline_contact", + "endpoint_type", ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return ( - E("access_device", "accessDevice", AccessDevice, is_complex=True), - E("line_port", "linePort", str), - E("private_identity", "privateIdentity", str), - E("contact_list", "contactList", ReplacementContactList, is_complex=True), - E("port_number", "portNumber", int), - E("device_type", "deviceType", str), - E("protocol", "protocol", str), - E("net_address", "netAddress", str), - E("port", "port", int), - E( - "outbound_proxy_server_net_address", - "outboundProxyServerNetAddress", - str, - ), - E("stun_server_net_address", "stunServerNetAddress", str), - E("mac_address", "macAddress", str), - E("serial_number", "serialNumber", str), - E("description", "description", str), - E("physical_location", "physicalLocation", str), - E("transport_protocol", "transportProtocol", str), - E("use_custom_user_name_password", "useCustomUserNamePassword", bool), - E( - "access_device_credentials", - "accessDeviceCredentials", - DeviceManagementUserNamePassword16, - is_complex=True, - ), - E("use_hotline", "useHotline", bool), - E("hotline_contact", "hotlineContact", str), - ) + return (E("endpoint_type", "endpointType", str, is_required=True),) -class ConsolidatedGroupServiceAssignment(OCIType): +class SearchCriteriaExactGroupAdminType(SearchCriteria): """ - Authorize and assign a group service. + Criteria for searching for a particular group administrator type. - The authorizedQuantity will be used at the group level if provided; otherwise, the - service quantity will be set to unlimited. The command will fail if the authorized - quantity set at the service provider level is insufficient. Attributes: - group_service_name (str): groupServiceName - authorized_quantity (authorizedQuantity): authorizedQuantity *Optional* + type (str): type """ __slots__: List[str] = [ - "group_service_name", - "authorized_quantity", + "type", ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return ( - E("group_service_name", "groupServiceName", str, is_required=True), - E( - "authorized_quantity", - "authorizedQuantity", - UnboundedPositiveInt, - is_complex=True, - ), - ) + return (E("type", "type", str, is_required=True),) -class ConsolidatedServicePackAssignment(OCIType): +class SearchCriteriaExactHuntPolicy(SearchCriteria): """ - Assign a service pack to user. + Criteria for searching for a particular fully specified hunt policy. - If the service pack has not been authorized to the group, it will be authorized. The - authorizedQuantity will be used at the group level if provided; otherwise, the service - quantity will be set to unlimited. The command will fail if the authorized quantity - set at the service provider level is insufficient. Attributes: - service_pack_name (str): servicePackName - authorized_quantity (authorizedQuantity): authorizedQuantity *Optional* + hunt_policy (str): huntPolicy """ __slots__: List[str] = [ - "service_pack_name", - "authorized_quantity", + "hunt_policy", ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return ( - E("service_pack_name", "servicePackName", str, is_required=True), - E( - "authorized_quantity", - "authorizedQuantity", - UnboundedPositiveInt, - is_complex=True, - ), - ) + return (E("hunt_policy", "huntPolicy", str, is_required=True),) -class ConsolidatedSharedCallAppearanceAccessDeviceMultipleIdentityEndpoint(OCIType): +class SearchCriteriaExactLocationEnabled(SearchCriteria): """ - Access device end point for Shared Call Appearance Service used in the context of add. + Criteria for searching for a particular Location enabled state. - The endpoint is identified by its linePort (public Identity) and possibly a private - Identity. Port numbers are only used by devices with static line ordering. In the - case an access device referenced by accessDevice does not exist, the device will be - added. The device attributes deviceType, protocol, netAddress, port, - outboundProxyServerNetAddress, stunServerNetAddress, macAddress, serialNumber, - description, physicalLocation, transportProtocol, useCustomUserNamePassword and - accessDeviceCredentials will be ignored if the access device already exists. The - following elements are only used in XS data mode and ignored in AS data mode: - privateIdentity Attributes: - access_device (accessDevice): accessDevice - line_port (str): linePort - private_identity (str): privateIdentity *Optional* - contact (str): contact *Optional* - port_number (int): portNumber *Optional* - is_active (bool): isActive - allow_origination (bool): allowOrigination - allow_termination (bool): allowTermination - device_type (str): deviceType *Optional* - protocol (str): protocol *Optional* - net_address (str): netAddress *Optional* - port (int): port *Optional* - outbound_proxy_server_net_address (str): outboundProxyServerNetAddress *Optional* - stun_server_net_address (str): stunServerNetAddress *Optional* - mac_address (str): macAddress *Optional* - serial_number (str): serialNumber *Optional* - description (str): description *Optional* - physical_location (str): physicalLocation *Optional* - transport_protocol (str): transportProtocol *Optional* - use_custom_user_name_password (bool): useCustomUserNamePassword *Optional* - access_device_credentials (accessDeviceCredentials): accessDeviceCredentials - *Optional* - use_hotline (bool): useHotline *Optional* - hotline_contact (str): hotlineContact *Optional* + enabled (bool): enabled """ __slots__: List[str] = [ - "access_device", - "line_port", - "private_identity", - "contact", - "port_number", - "is_active", - "allow_origination", - "allow_termination", - "device_type", - "protocol", - "net_address", - "port", - "outbound_proxy_server_net_address", - "stun_server_net_address", - "mac_address", - "serial_number", - "description", - "physical_location", - "transport_protocol", - "use_custom_user_name_password", - "access_device_credentials", - "use_hotline", - "hotline_contact", + "enabled", ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return ( - E( - "access_device", - "accessDevice", - AccessDevice, - is_complex=True, - is_required=True, - ), - E("line_port", "linePort", str, is_required=True), - E("private_identity", "privateIdentity", str), - E("contact", "contact", str), - E("port_number", "portNumber", int), - E("is_active", "isActive", bool, is_required=True), - E("allow_origination", "allowOrigination", bool, is_required=True), - E("allow_termination", "allowTermination", bool, is_required=True), - E("device_type", "deviceType", str), - E("protocol", "protocol", str), - E("net_address", "netAddress", str), - E("port", "port", int), - E( - "outbound_proxy_server_net_address", - "outboundProxyServerNetAddress", - str, - ), - E("stun_server_net_address", "stunServerNetAddress", str), - E("mac_address", "macAddress", str), - E("serial_number", "serialNumber", str), - E("description", "description", str), - E("physical_location", "physicalLocation", str), - E("transport_protocol", "transportProtocol", str), - E("use_custom_user_name_password", "useCustomUserNamePassword", bool), - E( - "access_device_credentials", - "accessDeviceCredentials", - DeviceManagementUserNamePassword16, - is_complex=True, - ), - E("use_hotline", "useHotline", bool), - E("hotline_contact", "hotlineContact", str), - ) + return (E("enabled", "enabled", bool, is_required=True),) -class ConsolidatedSharedCallAppearanceAccessDeviceMultipleIdentityEndpointAdd22( - OCIType, -): +class SearchCriteriaExactMediaFileType(SearchCriteria): """ - Access device end point for Shared Call Appearance Service used in the context of add. + Criteria for searching for a particular media file type. - The endpoint is identified by its linePort (public Identity) and possibly a private - Identity. Port numbers are only used by devices with static line ordering. In the - case an access device referenced by accessDevice does not exist, the device will be - added. The device attributes deviceType, protocol, netAddress, port, - outboundProxyServerNetAddress, stunServerNetAddress, macAddress, serialNumber, - description, physicalLocation, transportProtocol, useCustomUserNamePassword and - accessDeviceCredentials will be ignored if the access device already exists. The - following elements are only used in XS data mode and ignored in AS data mode: - privateIdentity The following elements are only used in AS data mode and ignored in XS - data mode: useHotline, use value false in XS data mode hotlineContact Attributes: - access_device (accessDevice): accessDevice - line_port (str): linePort - private_identity (str): privateIdentity *Optional* - contact (str): contact *Optional* - port_number (int): portNumber *Optional* - is_active (bool): isActive - allow_origination (bool): allowOrigination - allow_termination (bool): allowTermination - device_type (str): deviceType *Optional* - protocol (str): protocol *Optional* - net_address (str): netAddress *Optional* - port (int): port *Optional* - outbound_proxy_server_net_address (str): outboundProxyServerNetAddress *Optional* - stun_server_net_address (str): stunServerNetAddress *Optional* - mac_address (str): macAddress *Optional* - serial_number (str): serialNumber *Optional* - description (str): description *Optional* - physical_location (str): physicalLocation *Optional* - transport_protocol (str): transportProtocol *Optional* - use_custom_user_name_password (bool): useCustomUserNamePassword *Optional* - access_device_credentials (accessDeviceCredentials): accessDeviceCredentials - *Optional* - use_hotline (bool): useHotline - hotline_contact (str): hotlineContact *Optional* + type (str): type """ __slots__: List[str] = [ - "access_device", - "line_port", - "private_identity", - "contact", - "port_number", - "is_active", - "allow_origination", - "allow_termination", - "device_type", - "protocol", - "net_address", - "port", - "outbound_proxy_server_net_address", - "stun_server_net_address", - "mac_address", - "serial_number", - "description", - "physical_location", - "transport_protocol", - "use_custom_user_name_password", - "access_device_credentials", - "use_hotline", - "hotline_contact", + "type", ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return ( - E( - "access_device", - "accessDevice", - AccessDevice, - is_complex=True, - is_required=True, - ), - E("line_port", "linePort", str, is_required=True), - E("private_identity", "privateIdentity", str), - E("contact", "contact", str), - E("port_number", "portNumber", int), - E("is_active", "isActive", bool, is_required=True), - E("allow_origination", "allowOrigination", bool, is_required=True), - E("allow_termination", "allowTermination", bool, is_required=True), - E("device_type", "deviceType", str), - E("protocol", "protocol", str), - E("net_address", "netAddress", str), - E("port", "port", int), - E( - "outbound_proxy_server_net_address", - "outboundProxyServerNetAddress", - str, - ), - E("stun_server_net_address", "stunServerNetAddress", str), - E("mac_address", "macAddress", str), - E("serial_number", "serialNumber", str), - E("description", "description", str), - E("physical_location", "physicalLocation", str), - E("transport_protocol", "transportProtocol", str), - E("use_custom_user_name_password", "useCustomUserNamePassword", bool), - E( - "access_device_credentials", - "accessDeviceCredentials", - DeviceManagementUserNamePassword16, - is_complex=True, - ), - E("use_hotline", "useHotline", bool, is_required=True), - E("hotline_contact", "hotlineContact", str), - ) + return (E("type", "type", str, is_required=True),) -class ConsolidatedUserServiceAssignment(OCIType): +class SearchCriteriaExactMobileDnAvailability(SearchCriteria): """ - Assign a user service. + Criteria for searching for a particular mobile dn availability. - If the service has not been authorized to the group, it will be authorized. The - authorizedQuantity will be used at the group level if provided; otherwise, the service - quantity will be set to unlimited. The command will fail if the authorized quantity - set at the service provider level is insufficient. Attributes: - user_service_name (str): userServiceName - authorized_quantity (authorizedQuantity): authorizedQuantity *Optional* + available (bool): available """ __slots__: List[str] = [ - "user_service_name", - "authorized_quantity", + "available", ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return ( - E("user_service_name", "userServiceName", str, is_required=True), - E( - "authorized_quantity", - "authorizedQuantity", - UnboundedPositiveInt, - is_complex=True, - ), - ) + return (E("available", "available", bool, is_required=True),) -class CriteriaFromDnModify(OCIType): +class SearchCriteriaExactMobileNetwork(SearchCriteria): """ - The from dn criteria used within a modify request. + Criteria for searching for a particular BroadWorks Mobility Mobile Network. Attributes: - from_dn_criteria_selection (str): fromDnCriteriaSelection *Optional* - include_anonymous_callers (bool): includeAnonymousCallers *Optional* - include_unavailable_callers (bool): includeUnavailableCallers *Optional* - phone_number_list (phoneNumberList): phoneNumberList *Optional* + mobile_network_name (str): mobileNetworkName """ __slots__: List[str] = [ - "from_dn_criteria_selection", - "include_anonymous_callers", - "include_unavailable_callers", - "phone_number_list", + "mobile_network_name", ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return ( - E("from_dn_criteria_selection", "fromDnCriteriaSelection", str), - E("include_anonymous_callers", "includeAnonymousCallers", bool), - E("include_unavailable_callers", "includeUnavailableCallers", bool), - E( - "phone_number_list", - "phoneNumberList", - CriteriaReplacementDNList, - is_complex=True, - ), - ) + return (E("mobile_network_name", "mobileNetworkName", str, is_required=True),) -class DeviceManagementDeviceTypeModifyOptions(OCIType): +class SearchCriteriaExactOrganizationType(SearchCriteria): """ - Device Management System device type options during a modify request. + Criteria for searching for an organization type. Attributes: - device_access_protocol (str): deviceAccessProtocol *Optional* - tag_mode (str): tagMode *Optional* - tag_set (str): tagSet *Optional* - allow_device_profile_custom_tag_set (bool): allowDeviceProfileCustomTagSet - *Optional* - allow_group_custom_tag_set (bool): allowGroupCustomTagSet *Optional* - send_email_upon_reset_failure (bool): sendEmailUponResetFailure *Optional* - device_access_net_address (str): deviceAccessNetAddress *Optional* - device_access_port (int): deviceAccessPort *Optional* - device_access_context (str): deviceAccessContext *Optional* - default_device_language (str): defaultDeviceLanguage *Optional* - default_device_encoding (str): defaultDeviceEncoding *Optional* - access_device_credentials (accessDeviceCredentials): accessDeviceCredentials - *Optional* - use_http_digest_authentication (bool): useHttpDigestAuthentication *Optional* - mac_based_file_authentication (bool): macBasedFileAuthentication *Optional* - user_name_password_file_authentication (bool): userNamePasswordFileAuthentication - *Optional* - mac_in_non_request_uri (bool): macInNonRequestURI *Optional* - mac_format_in_non_request_uri (str): macFormatInNonRequestURI *Optional* + organization_type (str): organizationType """ __slots__: List[str] = [ - "device_access_protocol", - "tag_mode", - "tag_set", - "allow_device_profile_custom_tag_set", - "allow_group_custom_tag_set", - "send_email_upon_reset_failure", - "device_access_net_address", - "device_access_port", - "device_access_context", - "default_device_language", - "default_device_encoding", - "access_device_credentials", - "use_http_digest_authentication", - "mac_based_file_authentication", - "user_name_password_file_authentication", - "mac_in_non_request_uri", - "mac_format_in_non_request_uri", + "organization_type", ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return ( - E("device_access_protocol", "deviceAccessProtocol", str), - E("tag_mode", "tagMode", str), - E("tag_set", "tagSet", str), - E( - "allow_device_profile_custom_tag_set", - "allowDeviceProfileCustomTagSet", - bool, - ), - E("allow_group_custom_tag_set", "allowGroupCustomTagSet", bool), - E("send_email_upon_reset_failure", "sendEmailUponResetFailure", bool), - E("device_access_net_address", "deviceAccessNetAddress", str), - E("device_access_port", "deviceAccessPort", int), - E("device_access_context", "deviceAccessContext", str), - E("default_device_language", "defaultDeviceLanguage", str), - E("default_device_encoding", "defaultDeviceEncoding", str), - E( - "access_device_credentials", - "accessDeviceCredentials", - DeviceManagementUserNamePassword, - is_complex=True, - ), - E("use_http_digest_authentication", "useHttpDigestAuthentication", bool), - E("mac_based_file_authentication", "macBasedFileAuthentication", bool), - E( - "user_name_password_file_authentication", - "userNamePasswordFileAuthentication", - bool, - ), - E("mac_in_non_request_uri", "macInNonRequestURI", bool), - E("mac_format_in_non_request_uri", "macFormatInNonRequestURI", str), - ) + return (E("organization_type", "organizationType", str, is_required=True),) -class DeviceManagementDeviceTypeModifyOptions16(OCIType): +class SearchCriteriaExactPolicySelection(SearchCriteria): """ - Device Management System device type options during a modify request. + Criteria for searching for a particular Voice VPN policy selection. Attributes: - device_access_protocol (str): deviceAccessProtocol *Optional* - tag_mode (str): tagMode *Optional* - tag_set (str): tagSet *Optional* - allow_device_profile_custom_tag_set (bool): allowDeviceProfileCustomTagSet - *Optional* - allow_group_custom_tag_set (bool): allowGroupCustomTagSet *Optional* - allow_sp_custom_tag_set (bool): allowSpCustomTagSet *Optional* - send_email_upon_reset_failure (bool): sendEmailUponResetFailure *Optional* - device_access_net_address (str): deviceAccessNetAddress *Optional* - device_access_port (int): deviceAccessPort *Optional* - device_access_context (str): deviceAccessContext *Optional* - default_device_language (str): defaultDeviceLanguage *Optional* - default_device_encoding (str): defaultDeviceEncoding *Optional* - access_device_credentials (accessDeviceCredentials): accessDeviceCredentials - *Optional* - use_http_digest_authentication (bool): useHttpDigestAuthentication *Optional* - mac_based_file_authentication (bool): macBasedFileAuthentication *Optional* - user_name_password_file_authentication (bool): userNamePasswordFileAuthentication - *Optional* - mac_in_non_request_uri (bool): macInNonRequestURI *Optional* - mac_in_cert (bool): macInCert *Optional* - mac_format_in_non_request_uri (str): macFormatInNonRequestURI *Optional* + policy_selection (str): policySelection """ __slots__: List[str] = [ - "device_access_protocol", - "tag_mode", - "tag_set", - "allow_device_profile_custom_tag_set", - "allow_group_custom_tag_set", - "allow_sp_custom_tag_set", - "send_email_upon_reset_failure", - "device_access_net_address", - "device_access_port", - "device_access_context", - "default_device_language", - "default_device_encoding", - "access_device_credentials", - "use_http_digest_authentication", - "mac_based_file_authentication", - "user_name_password_file_authentication", - "mac_in_non_request_uri", - "mac_in_cert", - "mac_format_in_non_request_uri", + "policy_selection", ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return ( - E("device_access_protocol", "deviceAccessProtocol", str), - E("tag_mode", "tagMode", str), - E("tag_set", "tagSet", str), - E( - "allow_device_profile_custom_tag_set", - "allowDeviceProfileCustomTagSet", - bool, - ), - E("allow_group_custom_tag_set", "allowGroupCustomTagSet", bool), - E("allow_sp_custom_tag_set", "allowSpCustomTagSet", bool), - E("send_email_upon_reset_failure", "sendEmailUponResetFailure", bool), - E("device_access_net_address", "deviceAccessNetAddress", str), - E("device_access_port", "deviceAccessPort", int), - E("device_access_context", "deviceAccessContext", str), - E("default_device_language", "defaultDeviceLanguage", str), - E("default_device_encoding", "defaultDeviceEncoding", str), - E( - "access_device_credentials", - "accessDeviceCredentials", - DeviceManagementUserNamePassword16, - is_complex=True, - ), - E("use_http_digest_authentication", "useHttpDigestAuthentication", bool), - E("mac_based_file_authentication", "macBasedFileAuthentication", bool), - E( - "user_name_password_file_authentication", - "userNamePasswordFileAuthentication", - bool, - ), - E("mac_in_non_request_uri", "macInNonRequestURI", bool), - E("mac_in_cert", "macInCert", bool), - E("mac_format_in_non_request_uri", "macFormatInNonRequestURI", str), - ) + return (E("policy_selection", "policySelection", str, is_required=True),) -class DeviceManagementDeviceTypeModifyOptions22(OCIType): +class SearchCriteriaExactPortNumber(SearchCriteria): """ - Device Management System device type options during a modify request. + Criteria for searching for a port number. - The following data elements are only used in AS data mode and ignored in XS data mode: - enableDeviceActivation deviceModel Attributes: - device_access_protocol (str): deviceAccessProtocol *Optional* - tag_mode (str): tagMode *Optional* - tag_set (str): tagSet *Optional* - allow_device_profile_custom_tag_set (bool): allowDeviceProfileCustomTagSet - *Optional* - allow_group_custom_tag_set (bool): allowGroupCustomTagSet *Optional* - allow_sp_custom_tag_set (bool): allowSpCustomTagSet *Optional* - send_email_upon_reset_failure (bool): sendEmailUponResetFailure *Optional* - device_access_net_address (str): deviceAccessNetAddress *Optional* - device_access_port (int): deviceAccessPort *Optional* - device_access_context (str): deviceAccessContext *Optional* - default_device_language (str): defaultDeviceLanguage *Optional* - default_device_encoding (str): defaultDeviceEncoding *Optional* - access_device_credentials (accessDeviceCredentials): accessDeviceCredentials - *Optional* - use_http_digest_authentication (bool): useHttpDigestAuthentication *Optional* - mac_based_file_authentication (bool): macBasedFileAuthentication *Optional* - user_name_password_file_authentication (bool): userNamePasswordFileAuthentication - *Optional* - mac_in_non_request_uri (bool): macInNonRequestURI *Optional* - mac_in_cert (bool): macInCert *Optional* - mac_format_in_non_request_uri (str): macFormatInNonRequestURI *Optional* - enable_device_activation (bool): enableDeviceActivation *Optional* - device_model (str): deviceModel *Optional* + port (int): port """ __slots__: List[str] = [ - "device_access_protocol", - "tag_mode", - "tag_set", - "allow_device_profile_custom_tag_set", - "allow_group_custom_tag_set", - "allow_sp_custom_tag_set", - "send_email_upon_reset_failure", - "device_access_net_address", - "device_access_port", - "device_access_context", - "default_device_language", - "default_device_encoding", - "access_device_credentials", - "use_http_digest_authentication", - "mac_based_file_authentication", - "user_name_password_file_authentication", - "mac_in_non_request_uri", - "mac_in_cert", - "mac_format_in_non_request_uri", - "enable_device_activation", - "device_model", + "port", ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return ( - E("device_access_protocol", "deviceAccessProtocol", str), - E("tag_mode", "tagMode", str), - E("tag_set", "tagSet", str), - E( - "allow_device_profile_custom_tag_set", - "allowDeviceProfileCustomTagSet", - bool, - ), - E("allow_group_custom_tag_set", "allowGroupCustomTagSet", bool), - E("allow_sp_custom_tag_set", "allowSpCustomTagSet", bool), - E("send_email_upon_reset_failure", "sendEmailUponResetFailure", bool), - E("device_access_net_address", "deviceAccessNetAddress", str), - E("device_access_port", "deviceAccessPort", int), - E("device_access_context", "deviceAccessContext", str), - E("default_device_language", "defaultDeviceLanguage", str), - E("default_device_encoding", "defaultDeviceEncoding", str), - E( - "access_device_credentials", - "accessDeviceCredentials", - DeviceManagementUserNamePassword16, - is_complex=True, - ), - E("use_http_digest_authentication", "useHttpDigestAuthentication", bool), - E("mac_based_file_authentication", "macBasedFileAuthentication", bool), - E( - "user_name_password_file_authentication", - "userNamePasswordFileAuthentication", - bool, - ), - E("mac_in_non_request_uri", "macInNonRequestURI", bool), - E("mac_in_cert", "macInCert", bool), - E("mac_format_in_non_request_uri", "macFormatInNonRequestURI", str), - E("enable_device_activation", "enableDeviceActivation", bool), - E("device_model", "deviceModel", str), - ) + return (E("port", "port", int, is_required=True),) -class DeviceManagementDeviceTypeOptions(OCIType): +class SearchCriteriaExactScheduleLevel(SearchCriteria): """ - Device Management System device type options. + Criteria for searching for a particular schedule level. Attributes: - device_access_protocol (str): deviceAccessProtocol - tag_mode (str): tagMode - tag_set (str): tagSet *Optional* - allow_device_profile_custom_tag_set (bool): allowDeviceProfileCustomTagSet - allow_group_custom_tag_set (bool): allowGroupCustomTagSet - send_email_upon_reset_failure (bool): sendEmailUponResetFailure - device_access_net_address (str): deviceAccessNetAddress *Optional* - device_access_port (int): deviceAccessPort *Optional* - device_access_context (str): deviceAccessContext *Optional* - device_access_uri (str): deviceAccessURI *Optional* - default_device_language (str): defaultDeviceLanguage *Optional* - default_device_encoding (str): defaultDeviceEncoding *Optional* - access_device_credentials (accessDeviceCredentials): accessDeviceCredentials - *Optional* - use_http_digest_authentication (bool): useHttpDigestAuthentication - mac_based_file_authentication (bool): macBasedFileAuthentication - user_name_password_file_authentication (bool): userNamePasswordFileAuthentication - mac_in_non_request_uri (bool): macInNonRequestURI - mac_format_in_non_request_uri (str): macFormatInNonRequestURI *Optional* + level (str): level """ __slots__: List[str] = [ - "device_access_protocol", - "tag_mode", - "tag_set", - "allow_device_profile_custom_tag_set", - "allow_group_custom_tag_set", - "send_email_upon_reset_failure", - "device_access_net_address", - "device_access_port", - "device_access_context", - "device_access_uri", - "default_device_language", - "default_device_encoding", - "access_device_credentials", - "use_http_digest_authentication", - "mac_based_file_authentication", - "user_name_password_file_authentication", - "mac_in_non_request_uri", - "mac_format_in_non_request_uri", + "level", ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return ( - E("device_access_protocol", "deviceAccessProtocol", str, is_required=True), - E("tag_mode", "tagMode", str, is_required=True), - E("tag_set", "tagSet", str), - E( - "allow_device_profile_custom_tag_set", - "allowDeviceProfileCustomTagSet", - bool, - is_required=True, - ), - E( - "allow_group_custom_tag_set", - "allowGroupCustomTagSet", - bool, - is_required=True, - ), - E( - "send_email_upon_reset_failure", - "sendEmailUponResetFailure", - bool, - is_required=True, - ), - E("device_access_net_address", "deviceAccessNetAddress", str), - E("device_access_port", "deviceAccessPort", int), - E("device_access_context", "deviceAccessContext", str), - E("device_access_uri", "deviceAccessURI", str), - E("default_device_language", "defaultDeviceLanguage", str), - E("default_device_encoding", "defaultDeviceEncoding", str), - E( - "access_device_credentials", - "accessDeviceCredentials", - DeviceManagementUserNamePassword, - is_complex=True, - ), - E( - "use_http_digest_authentication", - "useHttpDigestAuthentication", - bool, - is_required=True, - ), - E( - "mac_based_file_authentication", - "macBasedFileAuthentication", - bool, - is_required=True, - ), - E( - "user_name_password_file_authentication", - "userNamePasswordFileAuthentication", - bool, - is_required=True, - ), - E("mac_in_non_request_uri", "macInNonRequestURI", bool, is_required=True), - E("mac_format_in_non_request_uri", "macFormatInNonRequestURI", str), - ) + return (E("level", "level", str, is_required=True),) -class DeviceManagementDeviceTypeOptions16(OCIType): +class SearchCriteriaExactScheduleType(SearchCriteria): """ - Device Management System device type options. + Criteria for searching for a particular schedule type. Attributes: - device_access_protocol (str): deviceAccessProtocol - tag_mode (str): tagMode - tag_set (str): tagSet *Optional* - allow_device_profile_custom_tag_set (bool): allowDeviceProfileCustomTagSet - allow_group_custom_tag_set (bool): allowGroupCustomTagSet - send_email_upon_reset_failure (bool): sendEmailUponResetFailure - device_access_net_address (str): deviceAccessNetAddress *Optional* - device_access_port (int): deviceAccessPort *Optional* - device_access_context (str): deviceAccessContext *Optional* - device_access_uri (str): deviceAccessURI *Optional* - default_device_language (str): defaultDeviceLanguage *Optional* - default_device_encoding (str): defaultDeviceEncoding *Optional* - access_device_credentials (accessDeviceCredentials): accessDeviceCredentials - *Optional* - use_http_digest_authentication (bool): useHttpDigestAuthentication - mac_based_file_authentication (bool): macBasedFileAuthentication - user_name_password_file_authentication (bool): userNamePasswordFileAuthentication - mac_in_non_request_uri (bool): macInNonRequestURI - mac_format_in_non_request_uri (str): macFormatInNonRequestURI *Optional* + type (str): type """ __slots__: List[str] = [ - "device_access_protocol", - "tag_mode", - "tag_set", - "allow_device_profile_custom_tag_set", - "allow_group_custom_tag_set", - "send_email_upon_reset_failure", - "device_access_net_address", - "device_access_port", - "device_access_context", - "device_access_uri", - "default_device_language", - "default_device_encoding", - "access_device_credentials", - "use_http_digest_authentication", - "mac_based_file_authentication", - "user_name_password_file_authentication", - "mac_in_non_request_uri", - "mac_format_in_non_request_uri", + "type", ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return ( - E("device_access_protocol", "deviceAccessProtocol", str, is_required=True), - E("tag_mode", "tagMode", str, is_required=True), - E("tag_set", "tagSet", str), - E( - "allow_device_profile_custom_tag_set", - "allowDeviceProfileCustomTagSet", - bool, - is_required=True, - ), - E( - "allow_group_custom_tag_set", - "allowGroupCustomTagSet", - bool, - is_required=True, - ), - E( - "send_email_upon_reset_failure", - "sendEmailUponResetFailure", - bool, - is_required=True, - ), - E("device_access_net_address", "deviceAccessNetAddress", str), - E("device_access_port", "deviceAccessPort", int), - E("device_access_context", "deviceAccessContext", str), - E("device_access_uri", "deviceAccessURI", str), - E("default_device_language", "defaultDeviceLanguage", str), - E("default_device_encoding", "defaultDeviceEncoding", str), - E( - "access_device_credentials", - "accessDeviceCredentials", - DeviceManagementUserNamePassword16, - is_complex=True, - ), - E( - "use_http_digest_authentication", - "useHttpDigestAuthentication", - bool, - is_required=True, - ), - E( - "mac_based_file_authentication", - "macBasedFileAuthentication", - bool, - is_required=True, - ), - E( - "user_name_password_file_authentication", - "userNamePasswordFileAuthentication", - bool, - is_required=True, - ), - E("mac_in_non_request_uri", "macInNonRequestURI", bool, is_required=True), - E("mac_format_in_non_request_uri", "macFormatInNonRequestURI", str), - ) + return (E("type", "type", str, is_required=True),) -class DeviceManagementDeviceTypeOptions21sp1(OCIType): +class SearchCriteriaExactServiceProvider(SearchCriteria): """ - Device Management System device type options. + Criteria for searching for a particular fully specified service provider. - Note: For the elements listed below, when device configuration is set to - deviceManagement, those elements apply to the creation of the Polycom Phone Services - directory file only. For all other files, they are not used. Those elements are - instead configured on a per-file basis at the Device Type File level. When device - configuration is set to legacy, those elements apply to all configuration files. - useHttpDigestAuthentication macBasedFileAuthentication - userNamePasswordFileAuthentication macInNonRequestURI macInCert - macFormatInNonRequestURI Attributes: - device_access_protocol (str): deviceAccessProtocol - tag_mode (str): tagMode - tag_set (str): tagSet *Optional* - allow_device_profile_custom_tag_set (bool): allowDeviceProfileCustomTagSet - allow_group_custom_tag_set (bool): allowGroupCustomTagSet - send_email_upon_reset_failure (bool): sendEmailUponResetFailure - device_access_net_address (str): deviceAccessNetAddress *Optional* - device_access_port (int): deviceAccessPort *Optional* - device_access_context (str): deviceAccessContext *Optional* - device_access_uri (str): deviceAccessURI *Optional* - default_device_language (str): defaultDeviceLanguage *Optional* - default_device_encoding (str): defaultDeviceEncoding *Optional* - access_device_credentials (accessDeviceCredentials): accessDeviceCredentials - *Optional* - use_http_digest_authentication (bool): useHttpDigestAuthentication - mac_based_file_authentication (bool): macBasedFileAuthentication - user_name_password_file_authentication (bool): userNamePasswordFileAuthentication - mac_in_non_request_uri (bool): macInNonRequestURI - mac_in_cert (bool): macInCert - mac_format_in_non_request_uri (str): macFormatInNonRequestURI *Optional* + service_provider_id (str): serviceProviderId """ __slots__: List[str] = [ - "device_access_protocol", - "tag_mode", - "tag_set", - "allow_device_profile_custom_tag_set", - "allow_group_custom_tag_set", - "send_email_upon_reset_failure", - "device_access_net_address", - "device_access_port", - "device_access_context", - "device_access_uri", - "default_device_language", - "default_device_encoding", - "access_device_credentials", - "use_http_digest_authentication", - "mac_based_file_authentication", - "user_name_password_file_authentication", - "mac_in_non_request_uri", - "mac_in_cert", - "mac_format_in_non_request_uri", + "service_provider_id", ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return ( - E("device_access_protocol", "deviceAccessProtocol", str, is_required=True), - E("tag_mode", "tagMode", str, is_required=True), - E("tag_set", "tagSet", str), - E( - "allow_device_profile_custom_tag_set", - "allowDeviceProfileCustomTagSet", - bool, - is_required=True, - ), - E( - "allow_group_custom_tag_set", - "allowGroupCustomTagSet", - bool, - is_required=True, - ), - E( - "send_email_upon_reset_failure", - "sendEmailUponResetFailure", - bool, - is_required=True, - ), - E("device_access_net_address", "deviceAccessNetAddress", str), - E("device_access_port", "deviceAccessPort", int), - E("device_access_context", "deviceAccessContext", str), - E("device_access_uri", "deviceAccessURI", str), - E("default_device_language", "defaultDeviceLanguage", str), - E("default_device_encoding", "defaultDeviceEncoding", str), - E( - "access_device_credentials", - "accessDeviceCredentials", - DeviceManagementUserNamePassword16, - is_complex=True, - ), - E( - "use_http_digest_authentication", - "useHttpDigestAuthentication", - bool, - is_required=True, - ), - E( - "mac_based_file_authentication", - "macBasedFileAuthentication", - bool, - is_required=True, - ), - E( - "user_name_password_file_authentication", - "userNamePasswordFileAuthentication", - bool, - is_required=True, - ), - E("mac_in_non_request_uri", "macInNonRequestURI", bool, is_required=True), - E("mac_in_cert", "macInCert", bool, is_required=True), - E("mac_format_in_non_request_uri", "macFormatInNonRequestURI", str), - ) + return (E("service_provider_id", "serviceProviderId", str, is_required=True),) -class DeviceManagementDeviceTypeOptions22(OCIType): +class SearchCriteriaExactServiceProviderAdminType(SearchCriteria): """ - Device Management System device type options. + Criteria for searching for a particular service provider administrator type. - Note: For the elements listed below, when device configuration is set to - deviceManagement, those elements apply to the creation of the Polycom Phone Services - directory file only. For all other files, they are not used. Those elements are - instead configured on a per-file basis at the Device Type File level. When device - configuration is set to legacy, those elements apply to all configuration files. - useHttpDigestAuthentication macBasedFileAuthentication - userNamePasswordFileAuthentication macInNonRequestURI macInCert - macFormatInNonRequestURI Attributes: - device_access_protocol (str): deviceAccessProtocol - tag_mode (str): tagMode - tag_set (str): tagSet *Optional* - allow_device_profile_custom_tag_set (bool): allowDeviceProfileCustomTagSet - allow_group_custom_tag_set (bool): allowGroupCustomTagSet - allow_sp_custom_tag_set (bool): allowSpCustomTagSet - send_email_upon_reset_failure (bool): sendEmailUponResetFailure - device_access_net_address (str): deviceAccessNetAddress *Optional* - device_access_port (int): deviceAccessPort *Optional* - device_access_context (str): deviceAccessContext *Optional* - device_access_uri (str): deviceAccessURI *Optional* - default_device_language (str): defaultDeviceLanguage *Optional* - default_device_encoding (str): defaultDeviceEncoding *Optional* - access_device_credentials (accessDeviceCredentials): accessDeviceCredentials - *Optional* - use_http_digest_authentication (bool): useHttpDigestAuthentication - mac_based_file_authentication (bool): macBasedFileAuthentication - user_name_password_file_authentication (bool): userNamePasswordFileAuthentication - mac_in_non_request_uri (bool): macInNonRequestURI - mac_in_cert (bool): macInCert - mac_format_in_non_request_uri (str): macFormatInNonRequestURI *Optional* + type (str): type """ __slots__: List[str] = [ - "device_access_protocol", - "tag_mode", - "tag_set", - "allow_device_profile_custom_tag_set", - "allow_group_custom_tag_set", - "allow_sp_custom_tag_set", - "send_email_upon_reset_failure", - "device_access_net_address", - "device_access_port", - "device_access_context", - "device_access_uri", - "default_device_language", - "default_device_encoding", - "access_device_credentials", - "use_http_digest_authentication", - "mac_based_file_authentication", - "user_name_password_file_authentication", - "mac_in_non_request_uri", - "mac_in_cert", - "mac_format_in_non_request_uri", + "type", ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return ( - E("device_access_protocol", "deviceAccessProtocol", str, is_required=True), - E("tag_mode", "tagMode", str, is_required=True), - E("tag_set", "tagSet", str), - E( - "allow_device_profile_custom_tag_set", - "allowDeviceProfileCustomTagSet", - bool, - is_required=True, - ), - E( - "allow_group_custom_tag_set", - "allowGroupCustomTagSet", - bool, - is_required=True, - ), - E("allow_sp_custom_tag_set", "allowSpCustomTagSet", bool, is_required=True), - E( - "send_email_upon_reset_failure", - "sendEmailUponResetFailure", - bool, - is_required=True, - ), - E("device_access_net_address", "deviceAccessNetAddress", str), - E("device_access_port", "deviceAccessPort", int), - E("device_access_context", "deviceAccessContext", str), - E("device_access_uri", "deviceAccessURI", str), - E("default_device_language", "defaultDeviceLanguage", str), - E("default_device_encoding", "defaultDeviceEncoding", str), - E( - "access_device_credentials", - "accessDeviceCredentials", - DeviceManagementUserNamePassword16, - is_complex=True, - ), - E( - "use_http_digest_authentication", - "useHttpDigestAuthentication", - bool, - is_required=True, - ), - E( - "mac_based_file_authentication", - "macBasedFileAuthentication", - bool, - is_required=True, - ), - E( - "user_name_password_file_authentication", - "userNamePasswordFileAuthentication", - bool, - is_required=True, - ), - E("mac_in_non_request_uri", "macInNonRequestURI", bool, is_required=True), - E("mac_in_cert", "macInCert", bool, is_required=True), - E("mac_format_in_non_request_uri", "macFormatInNonRequestURI", str), - ) + return (E("type", "type", str, is_required=True),) -class DeviceManagementDeviceTypeOptions22V2(OCIType): +class SearchCriteriaExactServiceType(SearchCriteria): """ - Device Management System device type options. + Criteria for searching for a particular fully specified service type. - Note: For the elements listed below, when device configuration is set to - deviceManagement, those elements apply to the creation of the Polycom Phone Services - directory file only. For all other files, they are not used. Those elements are - instead configured on a per-file basis at the Device Type File level. When device - configuration is set to legacy, those elements apply to all configuration files. - useHttpDigestAuthentication macBasedFileAuthentication - userNamePasswordFileAuthentication macInNonRequestURI macInCert - macFormatInNonRequestURI Attributes: - device_access_protocol (str): deviceAccessProtocol - tag_mode (str): tagMode - tag_set (str): tagSet *Optional* - allow_device_profile_custom_tag_set (bool): allowDeviceProfileCustomTagSet - allow_group_custom_tag_set (bool): allowGroupCustomTagSet - allow_sp_custom_tag_set (bool): allowSpCustomTagSet - send_email_upon_reset_failure (bool): sendEmailUponResetFailure - device_access_net_address (str): deviceAccessNetAddress *Optional* - device_access_port (int): deviceAccessPort *Optional* - device_access_context (str): deviceAccessContext *Optional* - device_access_uri (str): deviceAccessURI *Optional* - default_device_language (str): defaultDeviceLanguage *Optional* - default_device_encoding (str): defaultDeviceEncoding *Optional* - access_device_credentials (accessDeviceCredentials): accessDeviceCredentials - *Optional* - use_http_digest_authentication (bool): useHttpDigestAuthentication - mac_based_file_authentication (bool): macBasedFileAuthentication - user_name_password_file_authentication (bool): userNamePasswordFileAuthentication - mac_in_non_request_uri (bool): macInNonRequestURI - mac_in_cert (bool): macInCert - mac_format_in_non_request_uri (str): macFormatInNonRequestURI *Optional* + service_type (str): serviceType """ __slots__: List[str] = [ - "device_access_protocol", - "tag_mode", - "tag_set", - "allow_device_profile_custom_tag_set", - "allow_group_custom_tag_set", - "allow_sp_custom_tag_set", - "send_email_upon_reset_failure", - "device_access_net_address", - "device_access_port", - "device_access_context", - "device_access_uri", - "default_device_language", - "default_device_encoding", - "access_device_credentials", - "use_http_digest_authentication", - "mac_based_file_authentication", - "user_name_password_file_authentication", - "mac_in_non_request_uri", - "mac_in_cert", - "mac_format_in_non_request_uri", + "service_type", ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return ( - E("device_access_protocol", "deviceAccessProtocol", str, is_required=True), - E("tag_mode", "tagMode", str, is_required=True), - E("tag_set", "tagSet", str), - E( - "allow_device_profile_custom_tag_set", - "allowDeviceProfileCustomTagSet", - bool, - is_required=True, - ), - E( - "allow_group_custom_tag_set", - "allowGroupCustomTagSet", - bool, - is_required=True, - ), - E("allow_sp_custom_tag_set", "allowSpCustomTagSet", bool, is_required=True), - E( - "send_email_upon_reset_failure", - "sendEmailUponResetFailure", - bool, - is_required=True, - ), - E("device_access_net_address", "deviceAccessNetAddress", str), - E("device_access_port", "deviceAccessPort", int), - E("device_access_context", "deviceAccessContext", str), - E("device_access_uri", "deviceAccessURI", str), - E("default_device_language", "defaultDeviceLanguage", str), - E("default_device_encoding", "defaultDeviceEncoding", str), - E( - "access_device_credentials", - "accessDeviceCredentials", - DeviceManagementUserNamePassword16, - is_complex=True, - ), - E( - "use_http_digest_authentication", - "useHttpDigestAuthentication", - bool, - is_required=True, - ), - E( - "mac_based_file_authentication", - "macBasedFileAuthentication", - bool, - is_required=True, - ), - E( - "user_name_password_file_authentication", - "userNamePasswordFileAuthentication", - bool, - is_required=True, - ), - E("mac_in_non_request_uri", "macInNonRequestURI", bool, is_required=True), - E("mac_in_cert", "macInCert", bool, is_required=True), - E("mac_format_in_non_request_uri", "macFormatInNonRequestURI", str), - ) + return (E("service_type", "serviceType", str, is_required=True),) -class DeviceManagementDeviceTypeOptions22V3(OCIType): +class SearchCriteriaExactSignalingAddressType(SearchCriteria): """ - Device Management System device type options. + Criteria for searching for a particular fully specified SignalingAddressType. - Note: For the elements listed below, when device configuration is set to - deviceManagement, those elements apply to the creation of the Polycom Phone Services - directory file only. For all other files, they are not used. Those elements are - instead configured on a per-file basis at the Device Type File level. When device - configuration is set to legacy, those elements apply to all configuration files. - useHttpDigestAuthentication macBasedFileAuthentication - userNamePasswordFileAuthentication macInNonRequestURI macInCert - macFormatInNonRequestURI The following data elements are only used in AS data mode and - ignored in XS data mode: enableDeviceActivation deviceModel Attributes: - device_access_protocol (str): deviceAccessProtocol - tag_mode (str): tagMode - tag_set (str): tagSet *Optional* - allow_device_profile_custom_tag_set (bool): allowDeviceProfileCustomTagSet - allow_group_custom_tag_set (bool): allowGroupCustomTagSet - allow_sp_custom_tag_set (bool): allowSpCustomTagSet - send_email_upon_reset_failure (bool): sendEmailUponResetFailure - device_access_net_address (str): deviceAccessNetAddress *Optional* - device_access_port (int): deviceAccessPort *Optional* - device_access_context (str): deviceAccessContext *Optional* - device_access_uri (str): deviceAccessURI *Optional* - default_device_language (str): defaultDeviceLanguage *Optional* - default_device_encoding (str): defaultDeviceEncoding *Optional* - access_device_credentials (accessDeviceCredentials): accessDeviceCredentials - *Optional* - use_http_digest_authentication (bool): useHttpDigestAuthentication - mac_based_file_authentication (bool): macBasedFileAuthentication - user_name_password_file_authentication (bool): userNamePasswordFileAuthentication - mac_in_non_request_uri (bool): macInNonRequestURI - mac_in_cert (bool): macInCert - mac_format_in_non_request_uri (str): macFormatInNonRequestURI *Optional* - enable_device_activation (bool): enableDeviceActivation - device_model (str): deviceModel *Optional* + profile (str): profile """ __slots__: List[str] = [ - "device_access_protocol", - "tag_mode", - "tag_set", - "allow_device_profile_custom_tag_set", - "allow_group_custom_tag_set", - "allow_sp_custom_tag_set", - "send_email_upon_reset_failure", - "device_access_net_address", - "device_access_port", - "device_access_context", - "device_access_uri", - "default_device_language", - "default_device_encoding", - "access_device_credentials", - "use_http_digest_authentication", - "mac_based_file_authentication", - "user_name_password_file_authentication", - "mac_in_non_request_uri", - "mac_in_cert", - "mac_format_in_non_request_uri", - "enable_device_activation", - "device_model", + "profile", ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return ( - E("device_access_protocol", "deviceAccessProtocol", str, is_required=True), - E("tag_mode", "tagMode", str, is_required=True), - E("tag_set", "tagSet", str), - E( - "allow_device_profile_custom_tag_set", - "allowDeviceProfileCustomTagSet", - bool, - is_required=True, - ), - E( - "allow_group_custom_tag_set", - "allowGroupCustomTagSet", - bool, - is_required=True, - ), - E("allow_sp_custom_tag_set", "allowSpCustomTagSet", bool, is_required=True), - E( - "send_email_upon_reset_failure", - "sendEmailUponResetFailure", - bool, - is_required=True, - ), - E("device_access_net_address", "deviceAccessNetAddress", str), - E("device_access_port", "deviceAccessPort", int), - E("device_access_context", "deviceAccessContext", str), - E("device_access_uri", "deviceAccessURI", str), - E("default_device_language", "defaultDeviceLanguage", str), - E("default_device_encoding", "defaultDeviceEncoding", str), - E( - "access_device_credentials", - "accessDeviceCredentials", - DeviceManagementUserNamePassword16, - is_complex=True, - ), - E( - "use_http_digest_authentication", - "useHttpDigestAuthentication", - bool, - is_required=True, - ), - E( - "mac_based_file_authentication", - "macBasedFileAuthentication", - bool, - is_required=True, - ), - E( - "user_name_password_file_authentication", - "userNamePasswordFileAuthentication", - bool, - is_required=True, - ), - E("mac_in_non_request_uri", "macInNonRequestURI", bool, is_required=True), - E("mac_in_cert", "macInCert", bool, is_required=True), - E("mac_format_in_non_request_uri", "macFormatInNonRequestURI", str), - E( - "enable_device_activation", - "enableDeviceActivation", - bool, - is_required=True, - ), - E("device_model", "deviceModel", str), - ) + return (E("profile", "profile", str, is_required=True),) -class DeviceManagementDeviceTypeOptions22V4(OCIType): +class SearchCriteriaExactSkillLevel(SearchCriteria): """ - Device Management System device type options. + Criteria for searching for a skill Level. - Note: For the elements listed below, when device configuration is set to - deviceManagement, those elements apply to the creation of the Polycom Phone Services - directory file only. For all other files, they are not used. Those elements are - instead configured on a per-file basis at the Device Type File level. When device - configuration is set to legacy, those elements apply to all configuration files. - useHttpDigestAuthentication macBasedFileAuthentication - userNamePasswordFileAuthentication macInNonRequestURI macInCert - macFormatInNonRequestURI The following data elements are only used in AS data mode and - ignored in XS data mode: enableDeviceActivation deviceModel supportLinks Attributes: - device_access_protocol (str): deviceAccessProtocol - tag_mode (str): tagMode - tag_set (str): tagSet *Optional* - allow_device_profile_custom_tag_set (bool): allowDeviceProfileCustomTagSet - allow_group_custom_tag_set (bool): allowGroupCustomTagSet - allow_sp_custom_tag_set (bool): allowSpCustomTagSet - send_email_upon_reset_failure (bool): sendEmailUponResetFailure - device_access_net_address (str): deviceAccessNetAddress *Optional* - device_access_port (int): deviceAccessPort *Optional* - device_access_context (str): deviceAccessContext *Optional* - device_access_uri (str): deviceAccessURI *Optional* - default_device_language (str): defaultDeviceLanguage *Optional* - default_device_encoding (str): defaultDeviceEncoding *Optional* - access_device_credentials (accessDeviceCredentials): accessDeviceCredentials - *Optional* - use_http_digest_authentication (bool): useHttpDigestAuthentication - mac_based_file_authentication (bool): macBasedFileAuthentication - user_name_password_file_authentication (bool): userNamePasswordFileAuthentication - mac_in_non_request_uri (bool): macInNonRequestURI - mac_in_cert (bool): macInCert - mac_format_in_non_request_uri (str): macFormatInNonRequestURI *Optional* - enable_device_activation (bool): enableDeviceActivation - device_model (str): deviceModel *Optional* - support_links (str): supportLinks + skill_level (int): skillLevel """ __slots__: List[str] = [ - "device_access_protocol", - "tag_mode", - "tag_set", - "allow_device_profile_custom_tag_set", - "allow_group_custom_tag_set", - "allow_sp_custom_tag_set", - "send_email_upon_reset_failure", - "device_access_net_address", - "device_access_port", - "device_access_context", - "device_access_uri", - "default_device_language", - "default_device_encoding", - "access_device_credentials", - "use_http_digest_authentication", - "mac_based_file_authentication", - "user_name_password_file_authentication", - "mac_in_non_request_uri", - "mac_in_cert", - "mac_format_in_non_request_uri", - "enable_device_activation", - "device_model", - "support_links", + "skill_level", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return (E("skill_level", "skillLevel", int, is_required=True),) + + +class SearchCriteriaExactUserDepartment(SearchCriteria): + """ + Criteria for searching for a particular fully specified user's department. + + + Attributes: + department_key (departmentKey): departmentKey + """ + + __slots__: List[str] = [ + "department_key", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("device_access_protocol", "deviceAccessProtocol", str, is_required=True), - E("tag_mode", "tagMode", str, is_required=True), - E("tag_set", "tagSet", str), E( - "allow_device_profile_custom_tag_set", - "allowDeviceProfileCustomTagSet", - bool, + "department_key", + "departmentKey", + DepartmentKey, + is_complex=True, is_required=True, ), - E( - "allow_group_custom_tag_set", - "allowGroupCustomTagSet", - bool, - is_required=True, - ), - E("allow_sp_custom_tag_set", "allowSpCustomTagSet", bool, is_required=True), - E( - "send_email_upon_reset_failure", - "sendEmailUponResetFailure", - bool, - is_required=True, - ), - E("device_access_net_address", "deviceAccessNetAddress", str), - E("device_access_port", "deviceAccessPort", int), - E("device_access_context", "deviceAccessContext", str), - E("device_access_uri", "deviceAccessURI", str), - E("default_device_language", "defaultDeviceLanguage", str), - E("default_device_encoding", "defaultDeviceEncoding", str), - E( - "access_device_credentials", - "accessDeviceCredentials", - DeviceManagementUserNamePassword16, - is_complex=True, - ), - E( - "use_http_digest_authentication", - "useHttpDigestAuthentication", - bool, - is_required=True, - ), - E( - "mac_based_file_authentication", - "macBasedFileAuthentication", - bool, - is_required=True, - ), - E( - "user_name_password_file_authentication", - "userNamePasswordFileAuthentication", - bool, - is_required=True, - ), - E("mac_in_non_request_uri", "macInNonRequestURI", bool, is_required=True), - E("mac_in_cert", "macInCert", bool, is_required=True), - E("mac_format_in_non_request_uri", "macFormatInNonRequestURI", str), - E( - "enable_device_activation", - "enableDeviceActivation", - bool, - is_required=True, - ), - E("device_model", "deviceModel", str), - E("support_links", "supportLinks", str, is_required=True), ) -class EnhancedCallLogsNumberFilter(OCIType): +class SearchCriteriaExactUserGroup(SearchCriteria): """ - Filter criteria based on the called number or number called. + Criteria for searching for a particular fully specified user's group. Attributes: - include_basic_call_type (List[str]): includeBasicCallType *Optional* - include_call_category (List[str]): includeCallCategory *Optional* - include_configurable_call_type (List[str]): includeConfigurableCallType *Optional* - search_criteria_dialed_number (List[searchCriteriaDialedNumber]): - searchCriteriaDialedNumber *Optional* - search_criteria_called_number (List[searchCriteriaCalledNumber]): - searchCriteriaCalledNumber *Optional* - search_criteria_network_translated_number - (List[searchCriteriaNetworkTranslatedNumber]): - searchCriteriaNetworkTranslatedNumber *Optional* - search_criteria_calling_presentation_number - (List[searchCriteriaCallingPresentationNumber]): - searchCriteriaCallingPresentationNumber *Optional* + service_provider_id (str): serviceProviderId + group_id (str): groupId """ __slots__: List[str] = [ - "include_basic_call_type", - "include_call_category", - "include_configurable_call_type", - "search_criteria_dialed_number", - "search_criteria_called_number", - "search_criteria_network_translated_number", - "search_criteria_calling_presentation_number", + "service_provider_id", + "group_id", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("include_basic_call_type", "includeBasicCallType", str, is_array=True), - E("include_call_category", "includeCallCategory", str, is_array=True), - E( - "include_configurable_call_type", - "includeConfigurableCallType", - str, - is_array=True, - ), - E( - "search_criteria_dialed_number", - "searchCriteriaDialedNumber", - SearchCriteriaOutgoingDNorSIPURI, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_called_number", - "searchCriteriaCalledNumber", - SearchCriteriaOutgoingDNorSIPURI, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_network_translated_number", - "searchCriteriaNetworkTranslatedNumber", - SearchCriteriaOutgoingDNorSIPURI, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_calling_presentation_number", - "searchCriteriaCallingPresentationNumber", - SearchCriteriaOutgoingDNorSIPURI, - is_complex=True, - is_array=True, - ), + E("service_provider_id", "serviceProviderId", str, is_required=True), + E("group_id", "groupId", str, is_required=True), ) -class EnhancedCallLogsRedirectedNumberFilter(OCIType): +class SearchCriteriaExactUserInTrunkGroup(SearchCriteria): """ - Filter criteria based on the transferred/forwarded number. + Criteria for searching for user in/not in a trunk group. Attributes: - redirected_call (redirectedCall): redirectedCall *Optional* - include_service_invocation_basic_call_type (List[str]): - includeServiceInvocationBasicCallType *Optional* - include_service_invocation_call_category (List[str]): - includeServiceInvocationCallCategory *Optional* - include_service_invocation_configurable_call_type (List[str]): - includeServiceInvocationConfigurableCallType *Optional* - search_criteria_service_invocation_dialed_number - (List[searchCriteriaServiceInvocationDialedNumber]): - searchCriteriaServiceInvocationDialedNumber *Optional* - search_criteria_service_invocation_called_number - (List[searchCriteriaServiceInvocationCalledNumber]): - searchCriteriaServiceInvocationCalledNumber *Optional* - search_criteria_service_invocation_network_translated_number - (List[searchCriteriaServiceInvocationNetworkTranslatedNumber]): - searchCriteriaServiceInvocationNetworkTranslatedNumber *Optional* + user_in_trunk_group (bool): userInTrunkGroup """ __slots__: List[str] = [ - "redirected_call", - "include_service_invocation_basic_call_type", - "include_service_invocation_call_category", - "include_service_invocation_configurable_call_type", - "search_criteria_service_invocation_dialed_number", - "search_criteria_service_invocation_called_number", - "search_criteria_service_invocation_network_translated_number", + "user_in_trunk_group", ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return ( - E( - "redirected_call", - "redirectedCall", - EnhancedCallLogsRedirectedCallSelection, - is_complex=True, - ), - E( - "include_service_invocation_basic_call_type", - "includeServiceInvocationBasicCallType", - str, - is_array=True, - ), - E( - "include_service_invocation_call_category", - "includeServiceInvocationCallCategory", - str, - is_array=True, - ), - E( - "include_service_invocation_configurable_call_type", - "includeServiceInvocationConfigurableCallType", - str, - is_array=True, - ), - E( - "search_criteria_service_invocation_dialed_number", - "searchCriteriaServiceInvocationDialedNumber", - SearchCriteriaOutgoingDNorSIPURI, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_service_invocation_called_number", - "searchCriteriaServiceInvocationCalledNumber", - SearchCriteriaOutgoingDNorSIPURI, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_service_invocation_network_translated_number", - "searchCriteriaServiceInvocationNetworkTranslatedNumber", - SearchCriteriaOutgoingDNorSIPURI, - is_complex=True, - is_array=True, - ), - ) + return (E("user_in_trunk_group", "userInTrunkGroup", bool, is_required=True),) -class EnhancedCallLogsRedirectedNumberFilter20sp1(OCIType): +class SearchCriteriaExactUserNetworkClassOfService(SearchCriteria): """ - Filter criteria based on the transferred/forwarded number. + Criteria for searching for users with a specified network class of service. Attributes: - redirected_call (redirectedCall): redirectedCall *Optional* - include_service_invocation_basic_call_type (List[str]): - includeServiceInvocationBasicCallType *Optional* - include_service_invocation_call_category (List[str]): - includeServiceInvocationCallCategory *Optional* - include_service_invocation_configurable_call_type (List[str]): - includeServiceInvocationConfigurableCallType *Optional* - search_criteria_service_invocation_dialed_number - (List[searchCriteriaServiceInvocationDialedNumber]): - searchCriteriaServiceInvocationDialedNumber *Optional* - search_criteria_service_invocation_called_number - (List[searchCriteriaServiceInvocationCalledNumber]): - searchCriteriaServiceInvocationCalledNumber *Optional* - search_criteria_service_invocation_network_translated_number - (List[searchCriteriaServiceInvocationNetworkTranslatedNumber]): - searchCriteriaServiceInvocationNetworkTranslatedNumber *Optional* + network_class_of_service (str): networkClassOfService """ __slots__: List[str] = [ - "redirected_call", - "include_service_invocation_basic_call_type", - "include_service_invocation_call_category", - "include_service_invocation_configurable_call_type", - "search_criteria_service_invocation_dialed_number", - "search_criteria_service_invocation_called_number", - "search_criteria_service_invocation_network_translated_number", + "network_class_of_service", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( E( - "redirected_call", - "redirectedCall", - EnhancedCallLogsRedirectedCallSelection20sp1, - is_complex=True, - ), - E( - "include_service_invocation_basic_call_type", - "includeServiceInvocationBasicCallType", - str, - is_array=True, - ), - E( - "include_service_invocation_call_category", - "includeServiceInvocationCallCategory", - str, - is_array=True, - ), - E( - "include_service_invocation_configurable_call_type", - "includeServiceInvocationConfigurableCallType", + "network_class_of_service", + "networkClassOfService", str, - is_array=True, - ), - E( - "search_criteria_service_invocation_dialed_number", - "searchCriteriaServiceInvocationDialedNumber", - SearchCriteriaOutgoingDNorSIPURI, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_service_invocation_called_number", - "searchCriteriaServiceInvocationCalledNumber", - SearchCriteriaOutgoingDNorSIPURI, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_service_invocation_network_translated_number", - "searchCriteriaServiceInvocationNetworkTranslatedNumber", - SearchCriteriaOutgoingDNorSIPURI, - is_complex=True, - is_array=True, + is_required=True, ), ) -class EnhancedCallLogsRedirectedNumberFilter21(OCIType): +class SearchCriteriaExactUserRouteListAssigned(SearchCriteria): """ - Filter criteria based on the transferred/forwarded number. + Criteria for searching for users with/without Route List feature assigned. Attributes: - redirected_call (redirectedCall): redirectedCall *Optional* - include_service_invocation_basic_call_type (List[str]): - includeServiceInvocationBasicCallType *Optional* - include_service_invocation_call_category (List[str]): - includeServiceInvocationCallCategory *Optional* - include_service_invocation_configurable_call_type (List[str]): - includeServiceInvocationConfigurableCallType *Optional* - search_criteria_service_invocation_dialed_number - (List[searchCriteriaServiceInvocationDialedNumber]): - searchCriteriaServiceInvocationDialedNumber *Optional* - search_criteria_service_invocation_called_number - (List[searchCriteriaServiceInvocationCalledNumber]): - searchCriteriaServiceInvocationCalledNumber *Optional* - search_criteria_service_invocation_network_translated_number - (List[searchCriteriaServiceInvocationNetworkTranslatedNumber]): - searchCriteriaServiceInvocationNetworkTranslatedNumber *Optional* + route_list_assigned (bool): routeListAssigned """ __slots__: List[str] = [ - "redirected_call", - "include_service_invocation_basic_call_type", - "include_service_invocation_call_category", - "include_service_invocation_configurable_call_type", - "search_criteria_service_invocation_dialed_number", - "search_criteria_service_invocation_called_number", - "search_criteria_service_invocation_network_translated_number", + "route_list_assigned", ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return ( - E( - "redirected_call", - "redirectedCall", - EnhancedCallLogsRedirectedCallSelection21, - is_complex=True, - ), - E( - "include_service_invocation_basic_call_type", - "includeServiceInvocationBasicCallType", - str, - is_array=True, - ), - E( - "include_service_invocation_call_category", - "includeServiceInvocationCallCategory", - str, - is_array=True, - ), - E( - "include_service_invocation_configurable_call_type", - "includeServiceInvocationConfigurableCallType", - str, - is_array=True, - ), - E( - "search_criteria_service_invocation_dialed_number", - "searchCriteriaServiceInvocationDialedNumber", - SearchCriteriaOutgoingDNorSIPURI, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_service_invocation_called_number", - "searchCriteriaServiceInvocationCalledNumber", - SearchCriteriaOutgoingDNorSIPURI, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_service_invocation_network_translated_number", - "searchCriteriaServiceInvocationNetworkTranslatedNumber", - SearchCriteriaOutgoingDNorSIPURI, - is_complex=True, - is_array=True, - ), - ) + return (E("route_list_assigned", "routeListAssigned", bool, is_required=True),) -class EnhancedCallLogsRedirectedNumberFilter21sp1(OCIType): +class SearchCriteriaExactUserRouteListAssignment(SearchCriteria): """ - Filter criteria based on the transferred/forwarded number. + Criteria for searching for users with Route List feature assignment. Attributes: - redirected_call (redirectedCall): redirectedCall *Optional* - include_service_invocation_basic_call_type (List[str]): - includeServiceInvocationBasicCallType *Optional* - include_service_invocation_call_category (List[str]): - includeServiceInvocationCallCategory *Optional* - include_service_invocation_configurable_call_type (List[str]): - includeServiceInvocationConfigurableCallType *Optional* - search_criteria_service_invocation_dialed_number - (List[searchCriteriaServiceInvocationDialedNumber]): - searchCriteriaServiceInvocationDialedNumber *Optional* - search_criteria_service_invocation_called_number - (List[searchCriteriaServiceInvocationCalledNumber]): - searchCriteriaServiceInvocationCalledNumber *Optional* - search_criteria_service_invocation_network_translated_number - (List[searchCriteriaServiceInvocationNetworkTranslatedNumber]): - searchCriteriaServiceInvocationNetworkTranslatedNumber *Optional* + assigned (bool): assigned """ __slots__: List[str] = [ - "redirected_call", - "include_service_invocation_basic_call_type", - "include_service_invocation_call_category", - "include_service_invocation_configurable_call_type", - "search_criteria_service_invocation_dialed_number", - "search_criteria_service_invocation_called_number", - "search_criteria_service_invocation_network_translated_number", + "assigned", ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return ( - E( - "redirected_call", - "redirectedCall", - EnhancedCallLogsRedirectedCallSelection21sp1, - is_complex=True, - ), - E( - "include_service_invocation_basic_call_type", - "includeServiceInvocationBasicCallType", - str, - is_array=True, - ), - E( - "include_service_invocation_call_category", - "includeServiceInvocationCallCategory", - str, - is_array=True, - ), - E( - "include_service_invocation_configurable_call_type", - "includeServiceInvocationConfigurableCallType", - str, - is_array=True, - ), - E( - "search_criteria_service_invocation_dialed_number", - "searchCriteriaServiceInvocationDialedNumber", - SearchCriteriaOutgoingDNorSIPURI, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_service_invocation_called_number", - "searchCriteriaServiceInvocationCalledNumber", - SearchCriteriaOutgoingDNorSIPURI, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_service_invocation_network_translated_number", - "searchCriteriaServiceInvocationNetworkTranslatedNumber", - SearchCriteriaOutgoingDNorSIPURI, - is_complex=True, - is_array=True, - ), - ) + return (E("assigned", "assigned", bool, is_required=True),) -class EnhancedCallLogsRedirectedNumberFilter23(OCIType): +class SearchCriteriaExactUserType(SearchCriteria): """ - Filter criteria based on the transferred/forwarded number. + Criteria for searching for a particular User Type. Attributes: - redirected_call (redirectedCall): redirectedCall *Optional* - include_service_invocation_basic_call_type (List[str]): - includeServiceInvocationBasicCallType *Optional* - include_service_invocation_call_category (List[str]): - includeServiceInvocationCallCategory *Optional* - include_service_invocation_configurable_call_type (List[str]): - includeServiceInvocationConfigurableCallType *Optional* - search_criteria_service_invocation_dialed_number - (List[searchCriteriaServiceInvocationDialedNumber]): - searchCriteriaServiceInvocationDialedNumber *Optional* - search_criteria_service_invocation_called_number - (List[searchCriteriaServiceInvocationCalledNumber]): - searchCriteriaServiceInvocationCalledNumber *Optional* - search_criteria_service_invocation_network_translated_number - (List[searchCriteriaServiceInvocationNetworkTranslatedNumber]): - searchCriteriaServiceInvocationNetworkTranslatedNumber *Optional* + user_type (str): userType """ __slots__: List[str] = [ - "redirected_call", - "include_service_invocation_basic_call_type", - "include_service_invocation_call_category", - "include_service_invocation_configurable_call_type", - "search_criteria_service_invocation_dialed_number", - "search_criteria_service_invocation_called_number", - "search_criteria_service_invocation_network_translated_number", + "user_type", ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return ( - E( - "redirected_call", - "redirectedCall", - EnhancedCallLogsRedirectedCallSelection23, - is_complex=True, - ), - E( - "include_service_invocation_basic_call_type", - "includeServiceInvocationBasicCallType", - str, - is_array=True, - ), - E( - "include_service_invocation_call_category", - "includeServiceInvocationCallCategory", - str, - is_array=True, - ), - E( - "include_service_invocation_configurable_call_type", - "includeServiceInvocationConfigurableCallType", - str, - is_array=True, - ), - E( - "search_criteria_service_invocation_dialed_number", - "searchCriteriaServiceInvocationDialedNumber", - SearchCriteriaOutgoingDNorSIPURI, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_service_invocation_called_number", - "searchCriteriaServiceInvocationCalledNumber", - SearchCriteriaOutgoingDNorSIPURI, - is_complex=True, - is_array=True, - ), - E( - "search_criteria_service_invocation_network_translated_number", - "searchCriteriaServiceInvocationNetworkTranslatedNumber", - SearchCriteriaOutgoingDNorSIPURI, - is_complex=True, - is_array=True, - ), - ) + return (E("user_type", "userType", str, is_required=True),) -class EnterpriseAccessDevice(OCIType): +class SearchCriteriaExactVirtualOnNetCallTypeName(SearchCriteria): """ - Uniquely identifies an access device accessible for an enterprise. + Criteria for searching for a particular fully specified Virtual On-Net Call Type Name. - It could be a system level device, an enterprise level device or a group level device. Attributes: - access_device (accessDevice): accessDevice - group_id (str): groupId *Optional* + virtual_on_net_call_type_name (str): virtualOnNetCallTypeName """ __slots__: List[str] = [ - "access_device", - "group_id", + "virtual_on_net_call_type_name", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( E( - "access_device", - "accessDevice", - AccessDevice, - is_complex=True, - is_required=True, - ), - E("group_id", "groupId", str), + "virtual_on_net_call_type_name", + "virtualOnNetCallTypeName", + str, + is_required=True, + ), ) -class EnterpriseEnterpriseTrunkPriorityWeightedTrunkGroup(OCIType): +class SearchCriteriaExtension(SearchCriteria): """ - Trunk group details (order and weight) for each trunk group + Criteria for searching for an extension. + Attributes: - trunk_group (trunkGroup): trunkGroup - priority (int): priority - weight (int): weight + mode (str): mode + value (str): value + is_case_insensitive (bool): isCaseInsensitive """ __slots__: List[str] = [ - "trunk_group", - "priority", - "weight", + "mode", + "value", + "is_case_insensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E( - "trunk_group", - "trunkGroup", - EnterpriseTrunkTrunkGroupKey, - is_complex=True, - is_required=True, - ), - E("priority", "priority", int, is_required=True), - E("weight", "weight", int, is_required=True), + E("mode", "mode", str, is_required=True), + E("value", "value", str, is_required=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), ) -class EnterpriseTrunkNumberPrefix22(OCIType): +class SearchCriteriaForwardedToNumber(SearchCriteria): """ - Enterprise Trunk Number Prefix + Criteria for searching for a forwarded to number. + + This search criteria data type is only intended to be used by the commands introduced + by BW-2301. The commands are `EnterpriseUserCallForwardingSettingsGetListRequest()` + and `GroupUserCallForwardingSettingsGetListRequest()`. The following Call Forwarding + services are compatible for this search: Call Forwarding Always, Call Forwarding + Always Secondary, Call Forwarding Busy, Call Forwarding No Answer, Call Forwarding Not + Reachable, Call Forwarding Selective. Attributes: - number_prefix (str): numberPrefix - extension_range (extensionRange): extensionRange *Optional* + mode (str): mode + value (str): value + is_case_insensitive (bool): isCaseInsensitive """ __slots__: List[str] = [ - "number_prefix", - "extension_range", + "mode", + "value", + "is_case_insensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("number_prefix", "numberPrefix", str, is_required=True), - E("extension_range", "extensionRange", ExtensionRange17, is_complex=True), + E("mode", "mode", str, is_required=True), + E("value", "value", str, is_required=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), ) -class EnterpriseTrunkNumberPrefixModify(OCIType): +class SearchCriteriaGroupCommonMultiPartPhoneListName(SearchCriteria): """ - Enterprise Trunk Number Prefix for modify. + Criteria for searching for a multi-value name in a group common phone list. + Note: For this search criterion, the searchMode is always ‘Contains’ and the multi- + part search criteria are always AND’ed. Attributes: - number_prefix (str): numberPrefix - extension_range (extensionRange): extensionRange *Optional* + value (List[str]): value + is_case_insensitive (bool): isCaseInsensitive """ __slots__: List[str] = [ - "number_prefix", - "extension_range", + "value", + "is_case_insensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("number_prefix", "numberPrefix", str, is_required=True), - E("extension_range", "extensionRange", ExtensionRange17, is_complex=True), + E("value", "value", str, is_required=True, is_array=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), ) -class EnterpriseTrunkNumberRange(OCIType): +class SearchCriteriaGroupCommonPhoneListName(SearchCriteria): """ - Directory number range. + Criteria for searching for a name in a group common phone list. - The minimum and maximum values are inclusive. Attributes: - dn_range (dnRange): dnRange - extension_length (int): extensionLength *Optional* + mode (str): mode + value (str): value + is_case_insensitive (bool): isCaseInsensitive """ __slots__: List[str] = [ - "dn_range", - "extension_length", + "mode", + "value", + "is_case_insensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("dn_range", "dnRange", DNRange, is_complex=True, is_required=True), - E("extension_length", "extensionLength", int), + E("mode", "mode", str, is_required=True), + E("value", "value", str, is_required=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), ) -class EnterpriseTrunkPriorityWeightedTrunkGroup(OCIType): +class SearchCriteriaGroupCommonPhoneListNumber(SearchCriteria): """ - Trunk group details (order and weight) for each trunk group + Criteria for searching for a phone number in a group common phone list. + Attributes: - trunk_group (trunkGroup): trunkGroup - priority (int): priority - weight (int): weight + mode (str): mode + value (str): value + is_case_insensitive (bool): isCaseInsensitive """ __slots__: List[str] = [ - "trunk_group", - "priority", - "weight", + "mode", + "value", + "is_case_insensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E( - "trunk_group", - "trunkGroup", - EnterpriseTrunkTrunkGroupKey, - is_complex=True, - is_required=True, - ), - E("priority", "priority", int, is_required=True), - E("weight", "weight", int, is_required=True), + E("mode", "mode", str, is_required=True), + E("value", "value", str, is_required=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), ) -class ExecutiveCallFilteringCriteriaFromDnModify(OCIType): +class SearchCriteriaGroupExternalId(SearchCriteria): """ - The from dn criteria used within an executive call filtering criteria modify request. + Criteria for searching by a group's externalId. Attributes: - from_dn_criteria_selection (str): fromDnCriteriaSelection *Optional* - include_anonymous_callers (bool): includeAnonymousCallers *Optional* - include_unavailable_callers (bool): includeUnavailableCallers *Optional* - phone_number_list (phoneNumberList): phoneNumberList *Optional* + mode (str): mode + value (str): value """ __slots__: List[str] = [ - "from_dn_criteria_selection", - "include_anonymous_callers", - "include_unavailable_callers", - "phone_number_list", + "mode", + "value", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("from_dn_criteria_selection", "fromDnCriteriaSelection", str), - E("include_anonymous_callers", "includeAnonymousCallers", bool), - E("include_unavailable_callers", "includeUnavailableCallers", bool), - E( - "phone_number_list", - "phoneNumberList", - CriteriaReplacementDNList, - is_complex=True, - ), + E("mode", "mode", str, is_required=True), + E("value", "value", str, is_required=True), ) -class ExtendedFileResource(OCIType): +class SearchCriteriaGroupId(SearchCriteria): """ - Represents either an existing file for the application server to use, or the contents - of a file to transfer and an URL. + Criteria for searching for a group ID. Attributes: - file (file): file *Optional* - url (str): url *Optional* + mode (str): mode + value (str): value + is_case_insensitive (bool): isCaseInsensitive """ __slots__: List[str] = [ - "file", - "url", + "mode", + "value", + "is_case_insensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("file", "file", LabeledFileResource, is_complex=True), - E("url", "url", str), + E("mode", "mode", str, is_required=True), + E("value", "value", str, is_required=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), ) -class ExtendedMediaFileLevelResource20(OCIType): +class SearchCriteriaGroupLocationCode(SearchCriteria): """ - Represents either an existing file for the application server to use, or the contents - of a file to transfer and an URL. + Criteria for searching for a group location dialing code. Attributes: - file (file): file *Optional* - url (str): url *Optional* + mode (str): mode + value (str): value + is_case_insensitive (bool): isCaseInsensitive """ __slots__: List[str] = [ - "file", - "url", + "mode", + "value", + "is_case_insensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("file", "file", AnnouncementFileLevelKey, is_complex=True), - E("url", "url", str), + E("mode", "mode", str, is_required=True), + E("value", "value", str, is_required=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), ) -class ExtendedMediaFileResource(OCIType): +class SearchCriteriaGroupName(SearchCriteria): """ - Represents either an existing file for the application server to use, or the contents - of a file to transfer and an URL. + Criteria for searching for a group name. Attributes: - file (file): file *Optional* - url (str): url *Optional* + mode (str): mode + value (str): value + is_case_insensitive (bool): isCaseInsensitive """ __slots__: List[str] = [ - "file", - "url", + "mode", + "value", + "is_case_insensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("file", "file", LabeledMediaFileResource, is_complex=True), - E("url", "url", str), + E("mode", "mode", str, is_required=True), + E("value", "value", str, is_required=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), ) -class ExtendedMediaFileResource20(OCIType): +class SearchCriteriaHomeMscAddress(SearchCriteria): """ - Represents either an existing file for the application server to use, or the contents - of a file to transfer and an URL. + Criteria for searching for a system Home Network Msc Address. Attributes: - file (file): file *Optional* - url (str): url *Optional* + mode (str): mode + value (str): value + is_case_insensitive (bool): isCaseInsensitive """ __slots__: List[str] = [ - "file", - "url", + "mode", + "value", + "is_case_insensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("file", "file", AnnouncementFileKey, is_complex=True), - E("url", "url", str), + E("mode", "mode", str, is_required=True), + E("value", "value", str, is_required=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), ) -class GroupServiceAuthorization(OCIType): +class SearchCriteriaIMRN(SearchCriteria): """ - Authorize (with quantity) or unauthorize a group service. + Criteria for searching for an IMRN Number. Attributes: - service_name (str): serviceName - authorized_quantity (authorizedQuantity): authorizedQuantity *Optional* - unauthorized (bool): unauthorized *Optional* + mode (str): mode + value (str): value + is_case_insensitive (bool): isCaseInsensitive """ __slots__: List[str] = [ - "service_name", - "authorized_quantity", - "unauthorized", + "mode", + "value", + "is_case_insensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("service_name", "serviceName", str, is_required=True), - E( - "authorized_quantity", - "authorizedQuantity", - UnboundedPositiveInt, - is_complex=True, - ), - E("unauthorized", "unauthorized", bool), + E("mode", "mode", str, is_required=True), + E("value", "value", str, is_required=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), ) -class GroupServiceAuthorizationAndAssignment(OCIType): +class SearchCriteriaImpId(SearchCriteria): """ - Authorize (with quantity) a group service, and optionally assign the service. + Criteria for searching for a user's IMP Id. Attributes: - service_name (str): serviceName - authorized_quantity (authorizedQuantity): authorizedQuantity *Optional* - assign (bool): assign *Optional* + mode (str): mode + value (str): value + is_case_insensitive (bool): isCaseInsensitive """ __slots__: List[str] = [ - "service_name", - "authorized_quantity", - "assign", + "mode", + "value", + "is_case_insensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("service_name", "serviceName", str, is_required=True), - E( - "authorized_quantity", - "authorizedQuantity", - UnboundedPositiveInt, - is_complex=True, - ), - E("assign", "assign", bool), + E("mode", "mode", str, is_required=True), + E("value", "value", str, is_required=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), ) -class GroupSessionAdmissionControlGroupGetResponse21sp1V2(OCIType): +class SearchCriteriaLanguage(SearchCriteria): """ - Response to GroupSessionAdmissionControlGroupGetRequest21sp1V2. + Criteria for searching for a language. - Returns the profile information for the session admission control group. Attributes: - max_session (int): maxSession - max_user_originating_sessions (int): maxUserOriginatingSessions *Optional* - max_user_terminating_sessions (int): maxUserTerminatingSessions *Optional* - reserved_session (int): reservedSession - reserved_user_originating_sessions (int): reservedUserOriginatingSessions - *Optional* - reserved_user_terminating_sessions (int): reservedUserTerminatingSessions - *Optional* - default_group (bool): defaultGroup - count_intra_sac_group_sessions (bool): countIntraSACGroupSessions - devices (List[devices]): devices *Optional* - block_emergency_and_repair_calls_due_to_sac_limits (bool): - blockEmergencyAndRepairCallsDueToSACLimits - media_group_name (str): mediaGroupName *Optional* - access_info_pattern (str): accessInfoPattern *Optional* + mode (str): mode + value (str): value + is_case_insensitive (bool): isCaseInsensitive """ __slots__: List[str] = [ - "max_session", - "max_user_originating_sessions", - "max_user_terminating_sessions", - "reserved_session", - "reserved_user_originating_sessions", - "reserved_user_terminating_sessions", - "default_group", - "count_intra_sac_group_sessions", - "devices", - "block_emergency_and_repair_calls_due_to_sac_limits", - "media_group_name", - "access_info_pattern", + "mode", + "value", + "is_case_insensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("max_session", "maxSession", int, is_required=True), - E("max_user_originating_sessions", "maxUserOriginatingSessions", int), - E("max_user_terminating_sessions", "maxUserTerminatingSessions", int), - E("reserved_session", "reservedSession", int, is_required=True), - E( - "reserved_user_originating_sessions", - "reservedUserOriginatingSessions", - int, - ), - E( - "reserved_user_terminating_sessions", - "reservedUserTerminatingSessions", - int, - ), - E("default_group", "defaultGroup", bool, is_required=True), - E( - "count_intra_sac_group_sessions", - "countIntraSACGroupSessions", - bool, - is_required=True, - ), - E("devices", "devices", AccessDevice, is_complex=True, is_array=True), - E( - "block_emergency_and_repair_calls_due_to_sac_limits", - "blockEmergencyAndRepairCallsDueToSACLimits", - bool, - is_required=True, - ), - E("media_group_name", "mediaGroupName", str), - E("access_info_pattern", "accessInfoPattern", str), + E("mode", "mode", str, is_required=True), + E("value", "value", str, is_required=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), ) -class GroupTrunkGroupGetInstanceRequest14sp9A(OCIType): +class SearchCriteriaLinePortDomain(SearchCriteria): """ - Get a Trunk Group Instance's profile. + Criteria for searching for device line/port, or SIPURI domain part. - The response is either a GroupTrunkGroupGetInstanceResponse14sp9A or an - `ErrorResponse()`. The response contains a hosted user table with column headings: - "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name". Attributes: - trunk_group_key (trunkGroupKey): trunkGroupKey + mode (str): mode + value (str): value + is_case_insensitive (bool): isCaseInsensitive """ __slots__: List[str] = [ - "trunk_group_key", + "mode", + "value", + "is_case_insensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E( - "trunk_group_key", - "trunkGroupKey", - TrunkGroupKey, - is_complex=True, - is_required=True, - ), + E("mode", "mode", str, is_required=True), + E("value", "value", str, is_required=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), ) -class GroupTrunkGroupGetInstanceRequest17sp4V2(OCIType): +class SearchCriteriaLinePortUserPart(SearchCriteria): """ - Get a Trunk Group Instance's profile. + Criteria for searching for device line/port, or SIPURI user part. - The response is either a GroupTrunkGroupGetInstanceResponse17sp4V2 or an - `ErrorResponse()`. The response contains a hosted user table with column headings: - "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name". - Replaced by: `GroupTrunkGroupGetInstanceRequest19V2()` Attributes: - trunk_group_key (trunkGroupKey): trunkGroupKey + mode (str): mode + value (str): value + is_case_insensitive (bool): isCaseInsensitive """ __slots__: List[str] = [ - "trunk_group_key", + "mode", + "value", + "is_case_insensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E( - "trunk_group_key", - "trunkGroupKey", - TrunkGroupKey, - is_complex=True, - is_required=True, - ), + E("mode", "mode", str, is_required=True), + E("value", "value", str, is_required=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), ) -class GroupTrunkGroupGetInstanceRequest19sp1V2(OCIType): +class SearchCriteriaLocation(SearchCriteria): """ - Get a Trunk Group Instance's profile. + Criteria for searching for a Location. - The response is either a GroupTrunkGroupGetInstanceResponse19sp1V2 or an - `ErrorResponse()`. The response contains a hosted user table with column headings: - "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name", - "Phone Number", "Extension", "Department", "Email Address". Replaced by: - `GroupTrunkGroupGetInstanceRequest20sp1()` Attributes: - trunk_group_key (trunkGroupKey): trunkGroupKey + mode (str): mode + value (str): value + is_case_insensitive (bool): isCaseInsensitive """ __slots__: List[str] = [ - "trunk_group_key", + "mode", + "value", + "is_case_insensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E( - "trunk_group_key", - "trunkGroupKey", - TrunkGroupKey, - is_complex=True, - is_required=True, - ), + E("mode", "mode", str, is_required=True), + E("value", "value", str, is_required=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), ) -class GroupTrunkGroupGetInstanceResponse14sp9A(OCIType): +class SearchCriteriaLoginId(SearchCriteria): """ - Response to GroupTrunkGroupGetInstanceRequest14sp9A. + Criteria for searching for a Login Id. - Returns the profile information for the Trunk Group. Contains a hosted user table - with column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name", - "Hiragana First Name". Attributes: - pilot_user_id (str): pilotUserId *Optional* - department (department): department *Optional* - access_device (accessDevice): accessDevice *Optional* - max_active_calls (int): maxActiveCalls - max_incoming_calls (int): maxIncomingCalls *Optional* - max_outgoing_calls (int): maxOutgoingCalls *Optional* - enable_bursting (bool): enableBursting - bursting_max_active_calls (int): burstingMaxActiveCalls *Optional* - bursting_max_incoming_calls (int): burstingMaxIncomingCalls *Optional* - bursting_max_outgoing_calls (int): burstingMaxOutgoingCalls *Optional* - capacity_exceeded_action (str): capacityExceededAction *Optional* - capacity_exceeded_forward_address (str): capacityExceededForwardAddress *Optional* - capacity_exceeded_reroute_trunk_group_key (capacityExceededRerouteTrunkGroupKey): - capacityExceededRerouteTrunkGroupKey *Optional* - capacity_exceeded_trap_initial_calls (int): capacityExceededTrapInitialCalls - capacity_exceeded_trap_offset_calls (int): capacityExceededTrapOffsetCalls - unreachable_destination_action (str): unreachableDestinationAction *Optional* - unreachable_destination_forward_address (str): - unreachableDestinationForwardAddress *Optional* - unreachable_destination_reroute_trunk_group_key - (unreachableDestinationRerouteTrunkGroupKey): - unreachableDestinationRerouteTrunkGroupKey *Optional* - unreachable_destination_trap_initial_calls (int): - unreachableDestinationTrapInitialCalls - unreachable_destination_trap_offset_calls (int): - unreachableDestinationTrapOffsetCalls - invitation_timeout (int): invitationTimeout - require_authentication (bool): requireAuthentication - sip_authentication_user_name (str): sipAuthenticationUserName *Optional* - hosted_user_table (List(hostedUserTable)): hostedUserTable - *Table* array of - hostedUserTable named tuples *Optional* - trunk_group_identity (str): trunkGroupIdentity *Optional* - otg_dtg_identity (str): otgDtgIdentity *Optional* - include_trunk_group_identity (bool): includeTrunkGroupIdentity - include_dtg_identity (bool): includeDtgIdentity - enable_network_address_identity (bool): enableNetworkAddressIdentity - allow_unscreened_calls (bool): allowUnscreenedCalls - allow_unscreened_emergency_calls (bool): allowUnscreenedEmergencyCalls - pilot_user_calling_line_identity_policy (str): pilotUserCallingLineIdentityPolicy - pilot_user_charge_number_policy (str): pilotUserChargeNumberPolicy - call_forwarding_always_action (str): callForwardingAlwaysAction *Optional* - call_forwarding_always_forward_address (str): callForwardingAlwaysForwardAddress - *Optional* - call_forwarding_always_reroute_trunk_group_key - (callForwardingAlwaysRerouteTrunkGroupKey): - callForwardingAlwaysRerouteTrunkGroupKey *Optional* + mode (str): mode + value (str): value + is_case_insensitive (bool): isCaseInsensitive """ __slots__: List[str] = [ - "pilot_user_id", - "department", - "access_device", - "max_active_calls", - "max_incoming_calls", - "max_outgoing_calls", - "enable_bursting", - "bursting_max_active_calls", - "bursting_max_incoming_calls", - "bursting_max_outgoing_calls", - "capacity_exceeded_action", - "capacity_exceeded_forward_address", - "capacity_exceeded_reroute_trunk_group_key", - "capacity_exceeded_trap_initial_calls", - "capacity_exceeded_trap_offset_calls", - "unreachable_destination_action", - "unreachable_destination_forward_address", - "unreachable_destination_reroute_trunk_group_key", - "unreachable_destination_trap_initial_calls", - "unreachable_destination_trap_offset_calls", - "invitation_timeout", - "require_authentication", - "sip_authentication_user_name", - "hosted_user_table", - "trunk_group_identity", - "otg_dtg_identity", - "include_trunk_group_identity", - "include_dtg_identity", - "enable_network_address_identity", - "allow_unscreened_calls", - "allow_unscreened_emergency_calls", - "pilot_user_calling_line_identity_policy", - "pilot_user_charge_number_policy", - "call_forwarding_always_action", - "call_forwarding_always_forward_address", - "call_forwarding_always_reroute_trunk_group_key", + "mode", + "value", + "is_case_insensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("pilot_user_id", "pilotUserId", str), - E("department", "department", DepartmentKey, is_complex=True), - E("access_device", "accessDevice", AccessDevice, is_complex=True), - E("max_active_calls", "maxActiveCalls", int, is_required=True), - E("max_incoming_calls", "maxIncomingCalls", int), - E("max_outgoing_calls", "maxOutgoingCalls", int), - E("enable_bursting", "enableBursting", bool, is_required=True), - E("bursting_max_active_calls", "burstingMaxActiveCalls", int), - E("bursting_max_incoming_calls", "burstingMaxIncomingCalls", int), - E("bursting_max_outgoing_calls", "burstingMaxOutgoingCalls", int), - E("capacity_exceeded_action", "capacityExceededAction", str), - E( - "capacity_exceeded_forward_address", - "capacityExceededForwardAddress", - str, - ), - E( - "capacity_exceeded_reroute_trunk_group_key", - "capacityExceededRerouteTrunkGroupKey", - TrunkGroupKey, - is_complex=True, - ), - E( - "capacity_exceeded_trap_initial_calls", - "capacityExceededTrapInitialCalls", - int, - is_required=True, - ), - E( - "capacity_exceeded_trap_offset_calls", - "capacityExceededTrapOffsetCalls", - int, - is_required=True, - ), - E("unreachable_destination_action", "unreachableDestinationAction", str), - E( - "unreachable_destination_forward_address", - "unreachableDestinationForwardAddress", - str, - ), - E( - "unreachable_destination_reroute_trunk_group_key", - "unreachableDestinationRerouteTrunkGroupKey", - TrunkGroupKey, - is_complex=True, - ), - E( - "unreachable_destination_trap_initial_calls", - "unreachableDestinationTrapInitialCalls", - int, - is_required=True, - ), - E( - "unreachable_destination_trap_offset_calls", - "unreachableDestinationTrapOffsetCalls", - int, - is_required=True, - ), - E("invitation_timeout", "invitationTimeout", int, is_required=True), - E( - "require_authentication", - "requireAuthentication", - bool, - is_required=True, - ), - E("sip_authentication_user_name", "sipAuthenticationUserName", str), - E( - "hosted_user_table", - "hostedUserTable", - list, - is_complex=True, - is_table=True, - ), - E("trunk_group_identity", "trunkGroupIdentity", str), - E("otg_dtg_identity", "otgDtgIdentity", str), - E( - "include_trunk_group_identity", - "includeTrunkGroupIdentity", - bool, - is_required=True, - ), - E("include_dtg_identity", "includeDtgIdentity", bool, is_required=True), - E( - "enable_network_address_identity", - "enableNetworkAddressIdentity", - bool, - is_required=True, - ), - E("allow_unscreened_calls", "allowUnscreenedCalls", bool, is_required=True), - E( - "allow_unscreened_emergency_calls", - "allowUnscreenedEmergencyCalls", - bool, - is_required=True, - ), - E( - "pilot_user_calling_line_identity_policy", - "pilotUserCallingLineIdentityPolicy", - str, - is_required=True, - ), - E( - "pilot_user_charge_number_policy", - "pilotUserChargeNumberPolicy", - str, - is_required=True, - ), - E("call_forwarding_always_action", "callForwardingAlwaysAction", str), - E( - "call_forwarding_always_forward_address", - "callForwardingAlwaysForwardAddress", - str, - ), - E( - "call_forwarding_always_reroute_trunk_group_key", - "callForwardingAlwaysRerouteTrunkGroupKey", - TrunkGroupKey, - is_complex=True, - ), + E("mode", "mode", str, is_required=True), + E("value", "value", str, is_required=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), ) -class GroupTrunkGroupGetInstanceResponse17sp4V2(OCIType): +class SearchCriteriaMobilePhoneNumber(SearchCriteria): """ - Response to GroupTrunkGroupGetInstanceRequest17sp4V2. + Criteria for searching for a user's mobile phone number. - Returns the profile information for the Trunk Group. Contains a hosted user table - with column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name", - "Hiragana First Name". Replaced by: `GroupTrunkGroupGetInstanceResponse19V2()` Attributes: - pilot_user_id (str): pilotUserId *Optional* - department (department): department *Optional* - access_device (accessDevice): accessDevice *Optional* - max_active_calls (int): maxActiveCalls - max_incoming_calls (int): maxIncomingCalls *Optional* - max_outgoing_calls (int): maxOutgoingCalls *Optional* - enable_bursting (bool): enableBursting - bursting_max_active_calls (int): burstingMaxActiveCalls *Optional* - bursting_max_incoming_calls (int): burstingMaxIncomingCalls *Optional* - bursting_max_outgoing_calls (int): burstingMaxOutgoingCalls *Optional* - capacity_exceeded_action (str): capacityExceededAction *Optional* - capacity_exceeded_forward_address (str): capacityExceededForwardAddress *Optional* - capacity_exceeded_reroute_trunk_group_key (capacityExceededRerouteTrunkGroupKey): - capacityExceededRerouteTrunkGroupKey *Optional* - capacity_exceeded_trap_initial_calls (int): capacityExceededTrapInitialCalls - capacity_exceeded_trap_offset_calls (int): capacityExceededTrapOffsetCalls - unreachable_destination_action (str): unreachableDestinationAction *Optional* - unreachable_destination_forward_address (str): - unreachableDestinationForwardAddress *Optional* - unreachable_destination_reroute_trunk_group_key - (unreachableDestinationRerouteTrunkGroupKey): - unreachableDestinationRerouteTrunkGroupKey *Optional* - invitation_timeout (int): invitationTimeout - require_authentication (bool): requireAuthentication - sip_authentication_user_name (str): sipAuthenticationUserName *Optional* - hosted_user_table (List(hostedUserTable)): hostedUserTable - *Table* array of - hostedUserTable named tuples *Optional* - trunk_group_identity (str): trunkGroupIdentity *Optional* - otg_dtg_identity (str): otgDtgIdentity *Optional* - allow_termination_to_trunk_group_identity (bool): - allowTerminationToTrunkGroupIdentity - allow_termination_to_dtg_identity (bool): allowTerminationToDtgIdentity - include_trunk_group_identity (bool): includeTrunkGroupIdentity - include_dtg_identity (bool): includeDtgIdentity - include_trunk_group_identity_for_network_calls (bool): - includeTrunkGroupIdentityForNetworkCalls - include_otg_identity_for_network_calls (bool): includeOtgIdentityForNetworkCalls - enable_network_address_identity (bool): enableNetworkAddressIdentity - allow_unscreened_calls (bool): allowUnscreenedCalls - allow_unscreened_emergency_calls (bool): allowUnscreenedEmergencyCalls - pilot_user_calling_line_identity_policy (str): pilotUserCallingLineIdentityPolicy - pilot_user_charge_number_policy (str): pilotUserChargeNumberPolicy - call_forwarding_always_action (str): callForwardingAlwaysAction *Optional* - call_forwarding_always_forward_address (str): callForwardingAlwaysForwardAddress - *Optional* - call_forwarding_always_reroute_trunk_group_key - (callForwardingAlwaysRerouteTrunkGroupKey): - callForwardingAlwaysRerouteTrunkGroupKey *Optional* - peering_domain (str): peeringDomain *Optional* - route_to_peering_domain (bool): routeToPeeringDomain - prefix_enabled (bool): prefixEnabled - prefix (str): prefix *Optional* - stateful_rerouting_enabled (bool): statefulReroutingEnabled - send_continuous_options_message (bool): sendContinuousOptionsMessage - continuous_options_sending_interval_seconds (int): - continuousOptionsSendingIntervalSeconds - failure_options_sending_interval_seconds (int): - failureOptionsSendingIntervalSeconds - failure_threshold_counter (int): failureThresholdCounter - success_threshold_counter (int): successThresholdCounter - invite_failure_threshold_counter (int): inviteFailureThresholdCounter - invite_failure_threshold_window_seconds (int): inviteFailureThresholdWindowSeconds - trunk_group_state (str): trunkGroupState - pilot_user_calling_line_asserted_identity_policy (str): - pilotUserCallingLineAssertedIdentityPolicy - use_system_calling_line_asserted_identity_policy (bool): - useSystemCallingLineAssertedIdentityPolicy + mode (str): mode + value (str): value + is_case_insensitive (bool): isCaseInsensitive """ __slots__: List[str] = [ - "pilot_user_id", - "department", - "access_device", - "max_active_calls", - "max_incoming_calls", - "max_outgoing_calls", - "enable_bursting", - "bursting_max_active_calls", - "bursting_max_incoming_calls", - "bursting_max_outgoing_calls", - "capacity_exceeded_action", - "capacity_exceeded_forward_address", - "capacity_exceeded_reroute_trunk_group_key", - "capacity_exceeded_trap_initial_calls", - "capacity_exceeded_trap_offset_calls", - "unreachable_destination_action", - "unreachable_destination_forward_address", - "unreachable_destination_reroute_trunk_group_key", - "invitation_timeout", - "require_authentication", - "sip_authentication_user_name", - "hosted_user_table", - "trunk_group_identity", - "otg_dtg_identity", - "allow_termination_to_trunk_group_identity", - "allow_termination_to_dtg_identity", - "include_trunk_group_identity", - "include_dtg_identity", - "include_trunk_group_identity_for_network_calls", - "include_otg_identity_for_network_calls", - "enable_network_address_identity", - "allow_unscreened_calls", - "allow_unscreened_emergency_calls", - "pilot_user_calling_line_identity_policy", - "pilot_user_charge_number_policy", - "call_forwarding_always_action", - "call_forwarding_always_forward_address", - "call_forwarding_always_reroute_trunk_group_key", - "peering_domain", - "route_to_peering_domain", - "prefix_enabled", - "prefix", - "stateful_rerouting_enabled", - "send_continuous_options_message", - "continuous_options_sending_interval_seconds", - "failure_options_sending_interval_seconds", - "failure_threshold_counter", - "success_threshold_counter", - "invite_failure_threshold_counter", - "invite_failure_threshold_window_seconds", - "trunk_group_state", - "pilot_user_calling_line_asserted_identity_policy", - "use_system_calling_line_asserted_identity_policy", + "mode", + "value", + "is_case_insensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("pilot_user_id", "pilotUserId", str), - E("department", "department", DepartmentKey, is_complex=True), - E("access_device", "accessDevice", AccessDevice, is_complex=True), - E("max_active_calls", "maxActiveCalls", int, is_required=True), - E("max_incoming_calls", "maxIncomingCalls", int), - E("max_outgoing_calls", "maxOutgoingCalls", int), - E("enable_bursting", "enableBursting", bool, is_required=True), - E("bursting_max_active_calls", "burstingMaxActiveCalls", int), - E("bursting_max_incoming_calls", "burstingMaxIncomingCalls", int), - E("bursting_max_outgoing_calls", "burstingMaxOutgoingCalls", int), - E("capacity_exceeded_action", "capacityExceededAction", str), - E( - "capacity_exceeded_forward_address", - "capacityExceededForwardAddress", - str, - ), - E( - "capacity_exceeded_reroute_trunk_group_key", - "capacityExceededRerouteTrunkGroupKey", - TrunkGroupKey, - is_complex=True, - ), - E( - "capacity_exceeded_trap_initial_calls", - "capacityExceededTrapInitialCalls", - int, - is_required=True, - ), - E( - "capacity_exceeded_trap_offset_calls", - "capacityExceededTrapOffsetCalls", - int, - is_required=True, - ), - E("unreachable_destination_action", "unreachableDestinationAction", str), - E( - "unreachable_destination_forward_address", - "unreachableDestinationForwardAddress", - str, - ), - E( - "unreachable_destination_reroute_trunk_group_key", - "unreachableDestinationRerouteTrunkGroupKey", - TrunkGroupKey, - is_complex=True, - ), - E("invitation_timeout", "invitationTimeout", int, is_required=True), - E( - "require_authentication", - "requireAuthentication", - bool, - is_required=True, - ), - E("sip_authentication_user_name", "sipAuthenticationUserName", str), - E( - "hosted_user_table", - "hostedUserTable", - list, - is_complex=True, - is_table=True, - ), - E("trunk_group_identity", "trunkGroupIdentity", str), - E("otg_dtg_identity", "otgDtgIdentity", str), - E( - "allow_termination_to_trunk_group_identity", - "allowTerminationToTrunkGroupIdentity", - bool, - is_required=True, - ), - E( - "allow_termination_to_dtg_identity", - "allowTerminationToDtgIdentity", - bool, - is_required=True, - ), - E( - "include_trunk_group_identity", - "includeTrunkGroupIdentity", - bool, - is_required=True, - ), - E("include_dtg_identity", "includeDtgIdentity", bool, is_required=True), - E( - "include_trunk_group_identity_for_network_calls", - "includeTrunkGroupIdentityForNetworkCalls", - bool, - is_required=True, - ), - E( - "include_otg_identity_for_network_calls", - "includeOtgIdentityForNetworkCalls", - bool, - is_required=True, - ), - E( - "enable_network_address_identity", - "enableNetworkAddressIdentity", - bool, - is_required=True, - ), - E("allow_unscreened_calls", "allowUnscreenedCalls", bool, is_required=True), - E( - "allow_unscreened_emergency_calls", - "allowUnscreenedEmergencyCalls", - bool, - is_required=True, - ), - E( - "pilot_user_calling_line_identity_policy", - "pilotUserCallingLineIdentityPolicy", - str, - is_required=True, - ), - E( - "pilot_user_charge_number_policy", - "pilotUserChargeNumberPolicy", - str, - is_required=True, - ), - E("call_forwarding_always_action", "callForwardingAlwaysAction", str), - E( - "call_forwarding_always_forward_address", - "callForwardingAlwaysForwardAddress", - str, - ), - E( - "call_forwarding_always_reroute_trunk_group_key", - "callForwardingAlwaysRerouteTrunkGroupKey", - TrunkGroupKey, - is_complex=True, - ), - E("peering_domain", "peeringDomain", str), - E( - "route_to_peering_domain", - "routeToPeeringDomain", - bool, - is_required=True, - ), - E("prefix_enabled", "prefixEnabled", bool, is_required=True), - E("prefix", "prefix", str), - E( - "stateful_rerouting_enabled", - "statefulReroutingEnabled", - bool, - is_required=True, - ), - E( - "send_continuous_options_message", - "sendContinuousOptionsMessage", - bool, - is_required=True, - ), - E( - "continuous_options_sending_interval_seconds", - "continuousOptionsSendingIntervalSeconds", - int, - is_required=True, - ), - E( - "failure_options_sending_interval_seconds", - "failureOptionsSendingIntervalSeconds", - int, - is_required=True, - ), - E( - "failure_threshold_counter", - "failureThresholdCounter", - int, - is_required=True, - ), - E( - "success_threshold_counter", - "successThresholdCounter", - int, - is_required=True, - ), - E( - "invite_failure_threshold_counter", - "inviteFailureThresholdCounter", - int, - is_required=True, - ), - E( - "invite_failure_threshold_window_seconds", - "inviteFailureThresholdWindowSeconds", - int, - is_required=True, - ), - E("trunk_group_state", "trunkGroupState", str, is_required=True), - E( - "pilot_user_calling_line_asserted_identity_policy", - "pilotUserCallingLineAssertedIdentityPolicy", - str, - is_required=True, - ), - E( - "use_system_calling_line_asserted_identity_policy", - "useSystemCallingLineAssertedIdentityPolicy", - bool, - is_required=True, - ), + E("mode", "mode", str, is_required=True), + E("value", "value", str, is_required=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), ) -class GroupTrunkGroupGetInstanceResponse19sp1V2(OCIType): +class SearchCriteriaMobileSubscriberDirectoryNumber(SearchCriteria): """ - Response to GroupTrunkGroupGetInstanceRequest19sp1V2. + Criteria for searching for a BroadWorks Mobility Mobile Subscriber Directory Number. - Returns the profile information for the Trunk Group. Contains a hosted user table - with column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name", - "Hiragana First Name", "Phone Number", "Extension", "Department", "Email Address". - Replaced by: `GroupTrunkGroupGetInstanceResponse20sp1()` Attributes: - pilot_user_id (str): pilotUserId *Optional* - department (department): department *Optional* - access_device (accessDevice): accessDevice *Optional* - max_active_calls (int): maxActiveCalls - max_incoming_calls (int): maxIncomingCalls *Optional* - max_outgoing_calls (int): maxOutgoingCalls *Optional* - enable_bursting (bool): enableBursting - bursting_max_active_calls (int): burstingMaxActiveCalls *Optional* - bursting_max_incoming_calls (int): burstingMaxIncomingCalls *Optional* - bursting_max_outgoing_calls (int): burstingMaxOutgoingCalls *Optional* - capacity_exceeded_action (str): capacityExceededAction *Optional* - capacity_exceeded_forward_address (str): capacityExceededForwardAddress *Optional* - capacity_exceeded_reroute_trunk_group_key (capacityExceededRerouteTrunkGroupKey): - capacityExceededRerouteTrunkGroupKey *Optional* - capacity_exceeded_trap_initial_calls (int): capacityExceededTrapInitialCalls - capacity_exceeded_trap_offset_calls (int): capacityExceededTrapOffsetCalls - unreachable_destination_action (str): unreachableDestinationAction *Optional* - unreachable_destination_forward_address (str): - unreachableDestinationForwardAddress *Optional* - unreachable_destination_reroute_trunk_group_key - (unreachableDestinationRerouteTrunkGroupKey): - unreachableDestinationRerouteTrunkGroupKey *Optional* - invitation_timeout (int): invitationTimeout - require_authentication (bool): requireAuthentication - sip_authentication_user_name (str): sipAuthenticationUserName *Optional* - hosted_user_table (List(hostedUserTable)): hostedUserTable - *Table* array of - hostedUserTable named tuples *Optional* - trunk_group_identity (str): trunkGroupIdentity *Optional* - otg_dtg_identity (str): otgDtgIdentity *Optional* - allow_termination_to_trunk_group_identity (bool): - allowTerminationToTrunkGroupIdentity - allow_termination_to_dtg_identity (bool): allowTerminationToDtgIdentity - include_trunk_group_identity (bool): includeTrunkGroupIdentity - include_dtg_identity (bool): includeDtgIdentity - include_trunk_group_identity_for_network_calls (bool): - includeTrunkGroupIdentityForNetworkCalls - include_otg_identity_for_network_calls (bool): includeOtgIdentityForNetworkCalls - enable_network_address_identity (bool): enableNetworkAddressIdentity - allow_unscreened_calls (bool): allowUnscreenedCalls - allow_unscreened_emergency_calls (bool): allowUnscreenedEmergencyCalls - pilot_user_calling_line_identity_for_external_calls_policy (str): - pilotUserCallingLineIdentityForExternalCallsPolicy - pilot_user_charge_number_policy (str): pilotUserChargeNumberPolicy - call_forwarding_always_action (str): callForwardingAlwaysAction *Optional* - call_forwarding_always_forward_address (str): callForwardingAlwaysForwardAddress - *Optional* - call_forwarding_always_reroute_trunk_group_key - (callForwardingAlwaysRerouteTrunkGroupKey): - callForwardingAlwaysRerouteTrunkGroupKey *Optional* - peering_domain (str): peeringDomain *Optional* - route_to_peering_domain (bool): routeToPeeringDomain - prefix_enabled (bool): prefixEnabled - prefix (str): prefix *Optional* - stateful_rerouting_enabled (bool): statefulReroutingEnabled - send_continuous_options_message (bool): sendContinuousOptionsMessage - continuous_options_sending_interval_seconds (int): - continuousOptionsSendingIntervalSeconds - failure_options_sending_interval_seconds (int): - failureOptionsSendingIntervalSeconds - failure_threshold_counter (int): failureThresholdCounter - success_threshold_counter (int): successThresholdCounter - invite_failure_threshold_counter (int): inviteFailureThresholdCounter - invite_failure_threshold_window_seconds (int): inviteFailureThresholdWindowSeconds - trunk_group_state (str): trunkGroupState - pilot_user_calling_line_asserted_identity_policy (str): - pilotUserCallingLineAssertedIdentityPolicy - use_system_calling_line_asserted_identity_policy (bool): - useSystemCallingLineAssertedIdentityPolicy - total_active_incoming_calls (int): totalActiveIncomingCalls - total_active_outgoing_calls (int): totalActiveOutgoingCalls - pilot_user_call_optimization_policy (str): pilotUserCallOptimizationPolicy - clid_source_for_screened_calls_policy (str): clidSourceForScreenedCallsPolicy - use_system_clid_source_for_screened_calls_policy (bool): - useSystemCLIDSourceForScreenedCallsPolicy - user_lookup_policy (str): userLookupPolicy - use_system_user_lookup_policy (bool): useSystemUserLookupPolicy - pilot_user_calling_line_identity_for_emergency_calls_policy (str): - pilotUserCallingLineIdentityForEmergencyCallsPolicy + mode (str): mode + value (str): value + is_case_insensitive (bool): isCaseInsensitive + """ + + __slots__: List[str] = [ + "mode", + "value", + "is_case_insensitive", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("mode", "mode", str, is_required=True), + E("value", "value", str, is_required=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + ) + + +class SearchCriteriaMultiPartUserName(SearchCriteria): + """ + Criteria for searching for a user's full name. + + This search criterion will be compared against multiple combinations of first name and + last name: First Name + ‘ ‘ + Last Name Last Name + ‘ ‘ + First Name Last Name + ‘, ‘ + + First Name Hiragana Last Name + Hiragana First Name Note that when specific + conditions are met, VON users will be included in the search results. Note: For this + search criterion, the searchMode is always ‘Contains’ and the multi-part search + criteria are always AND’ed. + + Attributes: + value (List[str]): value + is_case_insensitive (bool): isCaseInsensitive + """ + + __slots__: List[str] = [ + "value", + "is_case_insensitive", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("value", "value", str, is_required=True, is_array=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + ) + + +class SearchCriteriaNetworkClassOfServiceName(SearchCriteria): + """ + Criteria for searching for a Network Class of Service name. + + + Attributes: + mode (str): mode + value (str): value + is_case_insensitive (bool): isCaseInsensitive + """ + + __slots__: List[str] = [ + "mode", + "value", + "is_case_insensitive", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("mode", "mode", str, is_required=True), + E("value", "value", str, is_required=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + ) + + +class SearchCriteriaNumberPortabilityQueryDigitPattern(SearchCriteria): + """ + Criteria for searching for digit pattern. + + + Attributes: + mode (str): mode + value (str): value + is_case_insensitive (bool): isCaseInsensitive + """ + + __slots__: List[str] = [ + "mode", + "value", + "is_case_insensitive", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("mode", "mode", str, is_required=True), + E("value", "value", str, is_required=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + ) + + +class SearchCriteriaNumberPortabilityStatus(SearchCriteria): + """ + Criteria for searching for number portability status. + + + Attributes: + mode (str): mode + value (str): value + is_case_insensitive (bool): isCaseInsensitive + """ + + __slots__: List[str] = [ + "mode", + "value", + "is_case_insensitive", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("mode", "mode", str, is_required=True), + E("value", "value", str, is_required=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + ) + + +class SearchCriteriaOutgoingDNorSIPURI(SearchCriteria): + """ + Criteria for searching for a phone number or SIPURI. + + + Attributes: + mode (str): mode + value (str): value + is_case_insensitive (bool): isCaseInsensitive + """ + + __slots__: List[str] = [ + "mode", + "value", + "is_case_insensitive", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("mode", "mode", str, is_required=True), + E("value", "value", str, is_required=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + ) + + +class SearchCriteriaPersonalAssistantExclusionNumber(SearchCriteria): + """ + Criteria for searching for Personal Assistant Exclusion Number. + + + Attributes: + mode (str): mode + value (str): value + is_case_insensitive (bool): isCaseInsensitive + """ + + __slots__: List[str] = [ + "mode", + "value", + "is_case_insensitive", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("mode", "mode", str, is_required=True), + E("value", "value", str, is_required=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + ) + + +class SearchCriteriaPersonalAssistantExclusionNumberDescription(SearchCriteria): + """ + Criteria for searching Personal Assistant Exclusion Number's Description. + + + Attributes: + mode (str): mode + value (str): value + is_case_insensitive (bool): isCaseInsensitive + """ + + __slots__: List[str] = [ + "mode", + "value", + "is_case_insensitive", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("mode", "mode", str, is_required=True), + E("value", "value", str, is_required=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + ) + + +class SearchCriteriaPhysicalLocation(SearchCriteria): + """ + Criteria for searching for a Physical Location. + + + Attributes: + mode (str): mode + value (str): value + is_case_insensitive (bool): isCaseInsensitive + """ + + __slots__: List[str] = [ + "mode", + "value", + "is_case_insensitive", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("mode", "mode", str, is_required=True), + E("value", "value", str, is_required=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + ) + + +class SearchCriteriaProfileServiceCode(SearchCriteria): + """ + Criteria for searching for a Service Code. + + + Attributes: + mode (str): mode + value (str): value + is_case_insensitive (bool): isCaseInsensitive + """ + + __slots__: List[str] = [ + "mode", + "value", + "is_case_insensitive", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("mode", "mode", str, is_required=True), + E("value", "value", str, is_required=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + ) + + +class SearchCriteriaProfileServiceCodeDescription(SearchCriteria): + """ + Criteria for searching for a Service Code description. + + + Attributes: + mode (str): mode + value (str): value + is_case_insensitive (bool): isCaseInsensitive + """ + + __slots__: List[str] = [ + "mode", + "value", + "is_case_insensitive", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("mode", "mode", str, is_required=True), + E("value", "value", str, is_required=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + ) + + +class SearchCriteriaReceptionistNote(SearchCriteria): + """ + Criteria for searching for Receptionist Notes. + + + Attributes: + mode (str): mode + value (str): value + is_case_insensitive (bool): isCaseInsensitive + """ + + __slots__: List[str] = [ + "mode", + "value", + "is_case_insensitive", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("mode", "mode", str, is_required=True), + E("value", "value", str, is_required=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + ) + + +class SearchCriteriaRegistrationURI(SearchCriteria): + """ + Criteria for searching for a RegistrationURI. + + + Attributes: + mode (str): mode + value (str): value + is_case_insensitive (bool): isCaseInsensitive + """ + + __slots__: List[str] = [ + "mode", + "value", + "is_case_insensitive", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("mode", "mode", str, is_required=True), + E("value", "value", str, is_required=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + ) + + +class SearchCriteriaResellerId(SearchCriteria): + """ + Criteria for searching for a reseller ID. + + + Attributes: + mode (str): mode + value (str): value + is_case_insensitive (bool): isCaseInsensitive + """ + + __slots__: List[str] = [ + "mode", + "value", + "is_case_insensitive", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("mode", "mode", str, is_required=True), + E("value", "value", str, is_required=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + ) + + +class SearchCriteriaResellerName(SearchCriteria): + """ + Criteria for searching for a reseller name. + + + Attributes: + mode (str): mode + value (str): value + is_case_insensitive (bool): isCaseInsensitive + """ + + __slots__: List[str] = [ + "mode", + "value", + "is_case_insensitive", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("mode", "mode", str, is_required=True), + E("value", "value", str, is_required=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + ) + + +class SearchCriteriaRoamingMscAddress(SearchCriteria): + """ + Criteria for searching for a system Roaming Network Msc Address. + + + Attributes: + mode (str): mode + value (str): value + is_case_insensitive (bool): isCaseInsensitive + """ + + __slots__: List[str] = [ + "mode", + "value", + "is_case_insensitive", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("mode", "mode", str, is_required=True), + E("value", "value", str, is_required=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + ) + + +class SearchCriteriaRoutePointName(SearchCriteria): + """ + Criteria for searching for a route point + + Attributes: + mode (str): mode + value (str): value + is_case_insensitive (bool): isCaseInsensitive + """ + + __slots__: List[str] = [ + "mode", + "value", + "is_case_insensitive", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("mode", "mode", str, is_required=True), + E("value", "value", str, is_required=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + ) + + +class SearchCriteriaSIPContact(SearchCriteria): + """ + Criteria for searching for a SIP Contact. + + + Attributes: + mode (str): mode + value (str): value + is_case_insensitive (bool): isCaseInsensitive + """ + + __slots__: List[str] = [ + "mode", + "value", + "is_case_insensitive", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("mode", "mode", str, is_required=True), + E("value", "value", str, is_required=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + ) + + +class SearchCriteriaScheduleName(SearchCriteria): + """ + Criteria for searching for a schedule name. + + + Attributes: + mode (str): mode + value (str): value + is_case_insensitive (bool): isCaseInsensitive + """ + + __slots__: List[str] = [ + "mode", + "value", + "is_case_insensitive", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("mode", "mode", str, is_required=True), + E("value", "value", str, is_required=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + ) + + +class SearchCriteriaServiceCode(SearchCriteria): + """ + Criteria for searching for a Service Code. + + + Attributes: + mode (str): mode + value (str): value + is_case_insensitive (bool): isCaseInsensitive + """ + + __slots__: List[str] = [ + "mode", + "value", + "is_case_insensitive", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("mode", "mode", str, is_required=True), + E("value", "value", str, is_required=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + ) + + +class SearchCriteriaServiceCodeDescription(SearchCriteria): + """ + Criteria for searching for a Service Code description. + + + Attributes: + mode (str): mode + value (str): value + is_case_insensitive (bool): isCaseInsensitive + """ + + __slots__: List[str] = [ + "mode", + "value", + "is_case_insensitive", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("mode", "mode", str, is_required=True), + E("value", "value", str, is_required=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + ) + + +class SearchCriteriaServiceInstanceName(SearchCriteria): + """ + Criteria for searching for a service instance name. + + + Attributes: + mode (str): mode + value (str): value + is_case_insensitive (bool): isCaseInsensitive + """ + + __slots__: List[str] = [ + "mode", + "value", + "is_case_insensitive", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("mode", "mode", str, is_required=True), + E("value", "value", str, is_required=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + ) + + +class SearchCriteriaServiceProviderId(SearchCriteria): + """ + Criteria for searching for a service provider ID. + + + Attributes: + mode (str): mode + value (str): value + is_case_insensitive (bool): isCaseInsensitive + """ + + __slots__: List[str] = [ + "mode", + "value", + "is_case_insensitive", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("mode", "mode", str, is_required=True), + E("value", "value", str, is_required=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + ) + + +class SearchCriteriaServiceProviderName(SearchCriteria): + """ + Criteria for searching for a service provider name. + + + Attributes: + mode (str): mode + value (str): value + is_case_insensitive (bool): isCaseInsensitive + """ + + __slots__: List[str] = [ + "mode", + "value", + "is_case_insensitive", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("mode", "mode", str, is_required=True), + E("value", "value", str, is_required=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + ) + + +class SearchCriteriaServiceProviderNumberPortabilityQueryDigitPattern(SearchCriteria): + """ + Criteria for searching for digit pattern. + + + Attributes: + mode (str): mode + value (str): value + is_case_insensitive (bool): isCaseInsensitive + """ + + __slots__: List[str] = [ + "mode", + "value", + "is_case_insensitive", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("mode", "mode", str, is_required=True), + E("value", "value", str, is_required=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + ) + + +class SearchCriteriaServiceStatus(SearchCriteria): + """ + Criteria for searching for services that are active or not. + + This search criteria data type is only intended to be used by the commands introduced + by BW-2301. The commands are `EnterpriseUserCallWaitingSettingsGetListRequest()` and + `GroupUserCallWaitingSettingsGetListRequest()`. + + Attributes: + is_active (bool): isActive + """ + + __slots__: List[str] = [ + "is_active", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return (E("is_active", "isActive", bool, is_required=True),) + + +class SearchCriteriaSystemServiceDn(SearchCriteria): + """ + Criteria for searching for a system service DN. + + + Attributes: + mode (str): mode + value (str): value + is_case_insensitive (bool): isCaseInsensitive """ __slots__: List[str] = [ - "pilot_user_id", - "department", - "access_device", - "max_active_calls", - "max_incoming_calls", - "max_outgoing_calls", - "enable_bursting", - "bursting_max_active_calls", - "bursting_max_incoming_calls", - "bursting_max_outgoing_calls", - "capacity_exceeded_action", - "capacity_exceeded_forward_address", - "capacity_exceeded_reroute_trunk_group_key", - "capacity_exceeded_trap_initial_calls", - "capacity_exceeded_trap_offset_calls", - "unreachable_destination_action", - "unreachable_destination_forward_address", - "unreachable_destination_reroute_trunk_group_key", - "invitation_timeout", - "require_authentication", - "sip_authentication_user_name", - "hosted_user_table", - "trunk_group_identity", - "otg_dtg_identity", - "allow_termination_to_trunk_group_identity", - "allow_termination_to_dtg_identity", - "include_trunk_group_identity", - "include_dtg_identity", - "include_trunk_group_identity_for_network_calls", - "include_otg_identity_for_network_calls", - "enable_network_address_identity", - "allow_unscreened_calls", - "allow_unscreened_emergency_calls", - "pilot_user_calling_line_identity_for_external_calls_policy", - "pilot_user_charge_number_policy", - "call_forwarding_always_action", - "call_forwarding_always_forward_address", - "call_forwarding_always_reroute_trunk_group_key", - "peering_domain", - "route_to_peering_domain", - "prefix_enabled", - "prefix", - "stateful_rerouting_enabled", - "send_continuous_options_message", - "continuous_options_sending_interval_seconds", - "failure_options_sending_interval_seconds", - "failure_threshold_counter", - "success_threshold_counter", - "invite_failure_threshold_counter", - "invite_failure_threshold_window_seconds", - "trunk_group_state", - "pilot_user_calling_line_asserted_identity_policy", - "use_system_calling_line_asserted_identity_policy", - "total_active_incoming_calls", - "total_active_outgoing_calls", - "pilot_user_call_optimization_policy", - "clid_source_for_screened_calls_policy", - "use_system_clid_source_for_screened_calls_policy", - "user_lookup_policy", - "use_system_user_lookup_policy", - "pilot_user_calling_line_identity_for_emergency_calls_policy", + "mode", + "value", + "is_case_insensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("pilot_user_id", "pilotUserId", str), - E("department", "department", DepartmentKey, is_complex=True), - E("access_device", "accessDevice", AccessDevice, is_complex=True), - E("max_active_calls", "maxActiveCalls", int, is_required=True), - E("max_incoming_calls", "maxIncomingCalls", int), - E("max_outgoing_calls", "maxOutgoingCalls", int), - E("enable_bursting", "enableBursting", bool, is_required=True), - E("bursting_max_active_calls", "burstingMaxActiveCalls", int), - E("bursting_max_incoming_calls", "burstingMaxIncomingCalls", int), - E("bursting_max_outgoing_calls", "burstingMaxOutgoingCalls", int), - E("capacity_exceeded_action", "capacityExceededAction", str), - E( - "capacity_exceeded_forward_address", - "capacityExceededForwardAddress", - str, - ), - E( - "capacity_exceeded_reroute_trunk_group_key", - "capacityExceededRerouteTrunkGroupKey", - TrunkGroupKey, - is_complex=True, - ), - E( - "capacity_exceeded_trap_initial_calls", - "capacityExceededTrapInitialCalls", - int, - is_required=True, - ), - E( - "capacity_exceeded_trap_offset_calls", - "capacityExceededTrapOffsetCalls", - int, - is_required=True, - ), - E("unreachable_destination_action", "unreachableDestinationAction", str), - E( - "unreachable_destination_forward_address", - "unreachableDestinationForwardAddress", - str, - ), - E( - "unreachable_destination_reroute_trunk_group_key", - "unreachableDestinationRerouteTrunkGroupKey", - TrunkGroupKey, - is_complex=True, - ), - E("invitation_timeout", "invitationTimeout", int, is_required=True), - E( - "require_authentication", - "requireAuthentication", - bool, - is_required=True, - ), - E("sip_authentication_user_name", "sipAuthenticationUserName", str), - E( - "hosted_user_table", - "hostedUserTable", - list, - is_complex=True, - is_table=True, - ), - E("trunk_group_identity", "trunkGroupIdentity", str), - E("otg_dtg_identity", "otgDtgIdentity", str), - E( - "allow_termination_to_trunk_group_identity", - "allowTerminationToTrunkGroupIdentity", - bool, - is_required=True, - ), - E( - "allow_termination_to_dtg_identity", - "allowTerminationToDtgIdentity", - bool, - is_required=True, - ), - E( - "include_trunk_group_identity", - "includeTrunkGroupIdentity", - bool, - is_required=True, - ), - E("include_dtg_identity", "includeDtgIdentity", bool, is_required=True), - E( - "include_trunk_group_identity_for_network_calls", - "includeTrunkGroupIdentityForNetworkCalls", - bool, - is_required=True, - ), - E( - "include_otg_identity_for_network_calls", - "includeOtgIdentityForNetworkCalls", - bool, - is_required=True, - ), - E( - "enable_network_address_identity", - "enableNetworkAddressIdentity", - bool, - is_required=True, - ), - E("allow_unscreened_calls", "allowUnscreenedCalls", bool, is_required=True), + E("mode", "mode", str, is_required=True), + E("value", "value", str, is_required=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + ) + + +class SearchCriteriaTitle(SearchCriteria): + """ + Criteria for searching for a user's title. + + + Attributes: + mode (str): mode + value (str): value + is_case_insensitive (bool): isCaseInsensitive + """ + + __slots__: List[str] = [ + "mode", + "value", + "is_case_insensitive", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("mode", "mode", str, is_required=True), + E("value", "value", str, is_required=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + ) + + +class SearchCriteriaTrunkGroupName(SearchCriteria): + """ + Criteria for searching for a trunk group + + Attributes: + mode (str): mode + value (str): value + is_case_insensitive (bool): isCaseInsensitive + """ + + __slots__: List[str] = [ + "mode", + "value", + "is_case_insensitive", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("mode", "mode", str, is_required=True), + E("value", "value", str, is_required=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + ) + + +class SearchCriteriaUserExternalId(SearchCriteria): + """ + Criteria for searching for a user's externalId. + + + Attributes: + mode (str): mode + value (str): value + """ + + __slots__: List[str] = [ + "mode", + "value", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("mode", "mode", str, is_required=True), + E("value", "value", str, is_required=True), + ) + + +class SearchCriteriaUserFirstName(SearchCriteria): + """ + Criteria for searching for a user's first name. + + + Attributes: + mode (str): mode + value (str): value + is_case_insensitive (bool): isCaseInsensitive + """ + + __slots__: List[str] = [ + "mode", + "value", + "is_case_insensitive", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("mode", "mode", str, is_required=True), + E("value", "value", str, is_required=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + ) + + +class SearchCriteriaUserHotlineContact(SearchCriteria): + """ + Criteria for searching for a user's hotline contact. + + + Attributes: + mode (str): mode + value (str): value + is_case_insensitive (bool): isCaseInsensitive + """ + + __slots__: List[str] = [ + "mode", + "value", + "is_case_insensitive", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("mode", "mode", str, is_required=True), + E("value", "value", str, is_required=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + ) + + +class SearchCriteriaUserId(SearchCriteria): + """ + Criteria for searching for a user's userId. + + + Attributes: + mode (str): mode + value (str): value + is_case_insensitive (bool): isCaseInsensitive + """ + + __slots__: List[str] = [ + "mode", + "value", + "is_case_insensitive", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("mode", "mode", str, is_required=True), + E("value", "value", str, is_required=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + ) + + +class SearchCriteriaUserLastName(SearchCriteria): + """ + Criteria for searching for a user's last name. + + + Attributes: + mode (str): mode + value (str): value + is_case_insensitive (bool): isCaseInsensitive + """ + + __slots__: List[str] = [ + "mode", + "value", + "is_case_insensitive", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("mode", "mode", str, is_required=True), + E("value", "value", str, is_required=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + ) + + +class SearchCriteriaUserName(SearchCriteria): + """ + Criteria for searching for a user's full name. + + This search criterion will be compared against multiple combinations of first name and + last name: First Name + ' ' + Last Name Last Name + ' ' + First Name Last Name + ', ' + + First Name Hiragana Last Name + ' ' + Hiragana First Name Note that when specific + conditions are met, VON users will be included in the search results. + + Attributes: + mode (str): mode + value (str): value + is_case_insensitive (bool): isCaseInsensitive + """ + + __slots__: List[str] = [ + "mode", + "value", + "is_case_insensitive", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("mode", "mode", str, is_required=True), + E("value", "value", str, is_required=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + ) + + +class SearchCriteriaUserPersonalMultiPartPhoneListName(SearchCriteria): + """ + Criteria for searching for a name in a user personal phone list. + + Note: For this search criterion, the searchMode is always ‘Contains’ and the multi- + part search criteria are always AND’ed. + + Attributes: + value (List[str]): value + is_case_insensitive (bool): isCaseInsensitive + """ + + __slots__: List[str] = [ + "value", + "is_case_insensitive", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("value", "value", str, is_required=True, is_array=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + ) + + +class SearchCriteriaUserPersonalPhoneListName(SearchCriteria): + """ + Criteria for searching for a name in a user personal phone list. + + + Attributes: + mode (str): mode + value (str): value + is_case_insensitive (bool): isCaseInsensitive + """ + + __slots__: List[str] = [ + "mode", + "value", + "is_case_insensitive", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("mode", "mode", str, is_required=True), + E("value", "value", str, is_required=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + ) + + +class SearchCriteriaUserPersonalPhoneListNumber(SearchCriteria): + """ + Criteria for searching for a phone number in a user personal phone list. + + + Attributes: + mode (str): mode + value (str): value + is_case_insensitive (bool): isCaseInsensitive + """ + + __slots__: List[str] = [ + "mode", + "value", + "is_case_insensitive", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("mode", "mode", str, is_required=True), + E("value", "value", str, is_required=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + ) + + +class SearchCriteriaUserPlaceType(SearchCriteria): + """ + Criteria for searching based on a user type – “User” or “Place”. + + + Attributes: + value (str): value + """ + + __slots__: List[str] = [ + "value", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return (E("value", "value", str, is_required=True),) + + +class SearchCriteriaYahooId(SearchCriteria): + """ + Criteria for searching for a user's yahoo id. + + + Attributes: + mode (str): mode + value (str): value + is_case_insensitive (bool): isCaseInsensitive + """ + + __slots__: List[str] = [ + "mode", + "value", + "is_case_insensitive", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("mode", "mode", str, is_required=True), + E("value", "value", str, is_required=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + ) + + +class SearchCriteriaZoneIPAddress(SearchCriteria): + """ + Criteria for searching for a system zone's IP Address. + + + Attributes: + mode (str): mode + value (str): value + is_case_insensitive (bool): isCaseInsensitive + """ + + __slots__: List[str] = [ + "mode", + "value", + "is_case_insensitive", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("mode", "mode", str, is_required=True), + E("value", "value", str, is_required=True), + E("is_case_insensitive", "isCaseInsensitive", bool, is_required=True), + ) + + +class SelectiveCallRejectionCriteriaCallTypeModify(OCIType): + """ + The call type criteria used within a modify request. + + + Attributes: + from_dn_criteria_selection (str): fromDnCriteriaSelection *Optional* + include_anonymous_callers (bool): includeAnonymousCallers *Optional* + include_unavailable_callers (bool): includeUnavailableCallers *Optional* + phone_number_list (phoneNumberList): phoneNumberList *Optional* + """ + + __slots__: List[str] = [ + "from_dn_criteria_selection", + "include_anonymous_callers", + "include_unavailable_callers", + "phone_number_list", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("from_dn_criteria_selection", "fromDnCriteriaSelection", str), + E("include_anonymous_callers", "includeAnonymousCallers", bool), + E("include_unavailable_callers", "includeUnavailableCallers", bool), E( - "allow_unscreened_emergency_calls", - "allowUnscreenedEmergencyCalls", - bool, - is_required=True, + "phone_number_list", + "phoneNumberList", + CriteriaReplacementDNList, + is_complex=True, ), + ) + + +class ServiceInstanceAddProfile(OCIType): + """ + Service Profile Information for group service. + + + Attributes: + name (str): name + calling_line_id_last_name (str): callingLineIdLastName + calling_line_id_first_name (str): callingLineIdFirstName + hiragana_last_name (str): hiraganaLastName *Optional* + hiragana_first_name (str): hiraganaFirstName *Optional* + phone_number (str): phoneNumber *Optional* + extension (str): extension *Optional* + password (str): password *Optional* + department (department): department *Optional* + language (str): language *Optional* + time_zone (str): timeZone *Optional* + alias (List[str]): alias *Optional* + public_user_identity (str): publicUserIdentity *Optional* + calling_line_id_phone_number (str): callingLineIdPhoneNumber *Optional* + """ + + __slots__: List[str] = [ + "name", + "calling_line_id_last_name", + "calling_line_id_first_name", + "hiragana_last_name", + "hiragana_first_name", + "phone_number", + "extension", + "password", + "department", + "language", + "time_zone", + "alias", + "public_user_identity", + "calling_line_id_phone_number", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("name", "name", str, is_required=True), E( - "pilot_user_calling_line_identity_for_external_calls_policy", - "pilotUserCallingLineIdentityForExternalCallsPolicy", + "calling_line_id_last_name", + "callingLineIdLastName", str, is_required=True, ), E( - "pilot_user_charge_number_policy", - "pilotUserChargeNumberPolicy", + "calling_line_id_first_name", + "callingLineIdFirstName", str, is_required=True, ), - E("call_forwarding_always_action", "callForwardingAlwaysAction", str), + E("hiragana_last_name", "hiraganaLastName", str), + E("hiragana_first_name", "hiraganaFirstName", str), + E("phone_number", "phoneNumber", str), + E("extension", "extension", str), + E("password", "password", str), + E("department", "department", DepartmentKey, is_complex=True), + E("language", "language", str), + E("time_zone", "timeZone", str), + E("alias", "alias", str, is_array=True), + E("public_user_identity", "publicUserIdentity", str), + E("calling_line_id_phone_number", "callingLineIdPhoneNumber", str), + ) + + +class ServiceInstanceAddProfileCallCenter(OCIType): + """ + Service Profile Information for a call center. + + Password is required. + + Attributes: + name (str): name + calling_line_id_last_name (str): callingLineIdLastName + calling_line_id_first_name (str): callingLineIdFirstName + hiragana_last_name (str): hiraganaLastName *Optional* + hiragana_first_name (str): hiraganaFirstName *Optional* + phone_number (str): phoneNumber *Optional* + extension (str): extension *Optional* + password (str): password + department (department): department *Optional* + language (str): language *Optional* + time_zone (str): timeZone *Optional* + alias (List[str]): alias *Optional* + public_user_identity (str): publicUserIdentity *Optional* + calling_line_id_phone_number (str): callingLineIdPhoneNumber *Optional* + """ + + __slots__: List[str] = [ + "name", + "calling_line_id_last_name", + "calling_line_id_first_name", + "hiragana_last_name", + "hiragana_first_name", + "phone_number", + "extension", + "password", + "department", + "language", + "time_zone", + "alias", + "public_user_identity", + "calling_line_id_phone_number", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("name", "name", str, is_required=True), E( - "call_forwarding_always_forward_address", - "callForwardingAlwaysForwardAddress", + "calling_line_id_last_name", + "callingLineIdLastName", str, - ), - E( - "call_forwarding_always_reroute_trunk_group_key", - "callForwardingAlwaysRerouteTrunkGroupKey", - TrunkGroupKey, - is_complex=True, - ), - E("peering_domain", "peeringDomain", str), - E( - "route_to_peering_domain", - "routeToPeeringDomain", - bool, - is_required=True, - ), - E("prefix_enabled", "prefixEnabled", bool, is_required=True), - E("prefix", "prefix", str), - E( - "stateful_rerouting_enabled", - "statefulReroutingEnabled", - bool, - is_required=True, - ), - E( - "send_continuous_options_message", - "sendContinuousOptionsMessage", - bool, - is_required=True, - ), - E( - "continuous_options_sending_interval_seconds", - "continuousOptionsSendingIntervalSeconds", - int, - is_required=True, - ), - E( - "failure_options_sending_interval_seconds", - "failureOptionsSendingIntervalSeconds", - int, - is_required=True, - ), - E( - "failure_threshold_counter", - "failureThresholdCounter", - int, - is_required=True, - ), - E( - "success_threshold_counter", - "successThresholdCounter", - int, - is_required=True, - ), - E( - "invite_failure_threshold_counter", - "inviteFailureThresholdCounter", - int, - is_required=True, - ), - E( - "invite_failure_threshold_window_seconds", - "inviteFailureThresholdWindowSeconds", - int, is_required=True, ), - E("trunk_group_state", "trunkGroupState", str, is_required=True), E( - "pilot_user_calling_line_asserted_identity_policy", - "pilotUserCallingLineAssertedIdentityPolicy", + "calling_line_id_first_name", + "callingLineIdFirstName", str, is_required=True, ), + E("hiragana_last_name", "hiraganaLastName", str), + E("hiragana_first_name", "hiraganaFirstName", str), + E("phone_number", "phoneNumber", str), + E("extension", "extension", str), + E("password", "password", str, is_required=True), + E("department", "department", DepartmentKey, is_complex=True), + E("language", "language", str), + E("time_zone", "timeZone", str), + E("alias", "alias", str, is_array=True), + E("public_user_identity", "publicUserIdentity", str), + E("calling_line_id_phone_number", "callingLineIdPhoneNumber", str), + ) + + +class ServiceInstanceAddProfileFlexibleSeatingHost(OCIType): + """ + Service Profile Information for a flexible seating host. + + + Attributes: + name (str): name + calling_line_id_last_name (str): callingLineIdLastName + calling_line_id_first_name (str): callingLineIdFirstName + hiragana_last_name (str): hiraganaLastName *Optional* + hiragana_first_name (str): hiraganaFirstName *Optional* + phone_number (str): phoneNumber *Optional* + extension (str): extension *Optional* + password (str): password *Optional* + department (department): department *Optional* + language (str): language *Optional* + time_zone (str): timeZone *Optional* + calling_line_id_phone_number (str): callingLineIdPhoneNumber *Optional* + """ + + __slots__: List[str] = [ + "name", + "calling_line_id_last_name", + "calling_line_id_first_name", + "hiragana_last_name", + "hiragana_first_name", + "phone_number", + "extension", + "password", + "department", + "language", + "time_zone", + "calling_line_id_phone_number", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("name", "name", str, is_required=True), E( - "use_system_calling_line_asserted_identity_policy", - "useSystemCallingLineAssertedIdentityPolicy", - bool, - is_required=True, - ), - E( - "total_active_incoming_calls", - "totalActiveIncomingCalls", - int, - is_required=True, - ), - E( - "total_active_outgoing_calls", - "totalActiveOutgoingCalls", - int, - is_required=True, - ), - E( - "pilot_user_call_optimization_policy", - "pilotUserCallOptimizationPolicy", + "calling_line_id_last_name", + "callingLineIdLastName", str, is_required=True, ), E( - "clid_source_for_screened_calls_policy", - "clidSourceForScreenedCallsPolicy", + "calling_line_id_first_name", + "callingLineIdFirstName", str, is_required=True, ), + E("hiragana_last_name", "hiraganaLastName", str), + E("hiragana_first_name", "hiraganaFirstName", str), + E("phone_number", "phoneNumber", str), + E("extension", "extension", str), + E("password", "password", str), + E("department", "department", DepartmentKey, is_complex=True), + E("language", "language", str), + E("time_zone", "timeZone", str), + E("calling_line_id_phone_number", "callingLineIdPhoneNumber", str), + ) + + +class ServiceInstanceAddProfileTrunkGroup(OCIType): + """ + Service Profile Information for a trunk group. + + The publicUserIdentity element is not part of ServiceInstanceAddProfileTrunkGroup. + + Attributes: + name (str): name + calling_line_id_last_name (str): callingLineIdLastName + calling_line_id_first_name (str): callingLineIdFirstName + hiragana_last_name (str): hiraganaLastName *Optional* + hiragana_first_name (str): hiraganaFirstName *Optional* + phone_number (str): phoneNumber *Optional* + extension (str): extension *Optional* + password (str): password *Optional* + department (department): department *Optional* + language (str): language *Optional* + time_zone (str): timeZone *Optional* + alias (List[str]): alias *Optional* + calling_line_id_phone_number (str): callingLineIdPhoneNumber *Optional* + """ + + __slots__: List[str] = [ + "name", + "calling_line_id_last_name", + "calling_line_id_first_name", + "hiragana_last_name", + "hiragana_first_name", + "phone_number", + "extension", + "password", + "department", + "language", + "time_zone", + "alias", + "calling_line_id_phone_number", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("name", "name", str, is_required=True), E( - "use_system_clid_source_for_screened_calls_policy", - "useSystemCLIDSourceForScreenedCallsPolicy", - bool, + "calling_line_id_last_name", + "callingLineIdLastName", + str, is_required=True, ), - E("user_lookup_policy", "userLookupPolicy", str, is_required=True), E( - "use_system_user_lookup_policy", - "useSystemUserLookupPolicy", - bool, + "calling_line_id_first_name", + "callingLineIdFirstName", + str, is_required=True, ), + E("hiragana_last_name", "hiraganaLastName", str), + E("hiragana_first_name", "hiraganaFirstName", str), + E("phone_number", "phoneNumber", str), + E("extension", "extension", str), + E("password", "password", str), + E("department", "department", DepartmentKey, is_complex=True), + E("language", "language", str), + E("time_zone", "timeZone", str), + E("alias", "alias", str, is_array=True), + E("calling_line_id_phone_number", "callingLineIdPhoneNumber", str), + ) + + +class ServiceInstanceModifyProfile(OCIType): + """ + Service Profile Information for group service used when modifying an existing service + instance. + + + Attributes: + name (str): name *Optional* + calling_line_id_last_name (str): callingLineIdLastName *Optional* + calling_line_id_first_name (str): callingLineIdFirstName *Optional* + hiragana_last_name (str): hiraganaLastName *Optional* + hiragana_first_name (str): hiraganaFirstName *Optional* + phone_number (str): phoneNumber *Optional* + extension (str): extension *Optional* + password (str): password *Optional* + department (department): department *Optional* + language (str): language *Optional* + time_zone (str): timeZone *Optional* + sip_alias_list (sipAliasList): sipAliasList *Optional* + public_user_identity (str): publicUserIdentity *Optional* + calling_line_id_phone_number (str): callingLineIdPhoneNumber *Optional* + """ + + __slots__: List[str] = [ + "name", + "calling_line_id_last_name", + "calling_line_id_first_name", + "hiragana_last_name", + "hiragana_first_name", + "phone_number", + "extension", + "password", + "department", + "language", + "time_zone", + "sip_alias_list", + "public_user_identity", + "calling_line_id_phone_number", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("name", "name", str), + E("calling_line_id_last_name", "callingLineIdLastName", str), + E("calling_line_id_first_name", "callingLineIdFirstName", str), + E("hiragana_last_name", "hiraganaLastName", str), + E("hiragana_first_name", "hiraganaFirstName", str), + E("phone_number", "phoneNumber", str), + E("extension", "extension", str), + E("password", "password", str), + E("department", "department", DepartmentKey, is_complex=True), + E("language", "language", str), + E("time_zone", "timeZone", str), E( - "pilot_user_calling_line_identity_for_emergency_calls_policy", - "pilotUserCallingLineIdentityForEmergencyCallsPolicy", - str, - is_required=True, + "sip_alias_list", + "sipAliasList", + ReplacementSIPAliasList, + is_complex=True, ), + E("public_user_identity", "publicUserIdentity", str), + E("calling_line_id_phone_number", "callingLineIdPhoneNumber", str), ) -class GroupTrunkGroupModifyInstanceRequest14sp9A(OCIType): +class ServiceInstanceModifyProfileFlexibleSeatingHost(OCIType): """ - Modify a Trunk Group Instance in a group. + Service Profile Information for a flexible seating host - The access device cannot be modified or cleared if there are any users assigned to the - Trunk Group. + Attributes: + name (str): name *Optional* + calling_line_id_last_name (str): callingLineIdLastName *Optional* + calling_line_id_first_name (str): callingLineIdFirstName *Optional* + hiragana_last_name (str): hiraganaLastName *Optional* + hiragana_first_name (str): hiraganaFirstName *Optional* + phone_number (str): phoneNumber *Optional* + extension (str): extension *Optional* + password (str): password *Optional* + department (department): department *Optional* + language (str): language *Optional* + time_zone (str): timeZone *Optional* + calling_line_id_phone_number (str): callingLineIdPhoneNumber *Optional* + """ + + __slots__: List[str] = [ + "name", + "calling_line_id_last_name", + "calling_line_id_first_name", + "hiragana_last_name", + "hiragana_first_name", + "phone_number", + "extension", + "password", + "department", + "language", + "time_zone", + "calling_line_id_phone_number", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("name", "name", str), + E("calling_line_id_last_name", "callingLineIdLastName", str), + E("calling_line_id_first_name", "callingLineIdFirstName", str), + E("hiragana_last_name", "hiraganaLastName", str), + E("hiragana_first_name", "hiraganaFirstName", str), + E("phone_number", "phoneNumber", str), + E("extension", "extension", str), + E("password", "password", str), + E("department", "department", DepartmentKey, is_complex=True), + E("language", "language", str), + E("time_zone", "timeZone", str), + E("calling_line_id_phone_number", "callingLineIdPhoneNumber", str), + ) + + +class ServiceInstanceModifyProfileTrunkGroup(OCIType): + """ + Service Profile Information for a trunk group used when modifying an existing service + instance. - The response is either a `SuccessResponse()` or an `ErrorResponse()`. Attributes: - trunk_group_key (trunkGroupKey): trunkGroupKey - new_name (str): newName *Optional* - pilot_user_id (str): pilotUserId *Optional* + name (str): name *Optional* + calling_line_id_last_name (str): callingLineIdLastName *Optional* + calling_line_id_first_name (str): callingLineIdFirstName *Optional* + hiragana_last_name (str): hiraganaLastName *Optional* + hiragana_first_name (str): hiraganaFirstName *Optional* + phone_number (str): phoneNumber *Optional* + extension (str): extension *Optional* + password (str): password *Optional* department (department): department *Optional* - access_device (accessDevice): accessDevice *Optional* - max_active_calls (int): maxActiveCalls *Optional* - max_incoming_calls (int): maxIncomingCalls *Optional* - max_outgoing_calls (int): maxOutgoingCalls *Optional* - enable_bursting (bool): enableBursting *Optional* - bursting_max_active_calls (int): burstingMaxActiveCalls *Optional* - bursting_max_incoming_calls (int): burstingMaxIncomingCalls *Optional* - bursting_max_outgoing_calls (int): burstingMaxOutgoingCalls *Optional* - capacity_exceeded_action (str): capacityExceededAction *Optional* - capacity_exceeded_forward_address (str): capacityExceededForwardAddress *Optional* - capacity_exceeded_reroute_trunk_group_key (capacityExceededRerouteTrunkGroupKey): - capacityExceededRerouteTrunkGroupKey *Optional* - capacity_exceeded_trap_initial_calls (int): capacityExceededTrapInitialCalls - *Optional* - capacity_exceeded_trap_offset_calls (int): capacityExceededTrapOffsetCalls - *Optional* - unreachable_destination_action (str): unreachableDestinationAction *Optional* - unreachable_destination_forward_address (str): - unreachableDestinationForwardAddress *Optional* - unreachable_destination_reroute_trunk_group_key - (unreachableDestinationRerouteTrunkGroupKey): - unreachableDestinationRerouteTrunkGroupKey *Optional* - unreachable_destination_trap_initial_calls (int): - unreachableDestinationTrapInitialCalls *Optional* - unreachable_destination_trap_offset_calls (int): - unreachableDestinationTrapOffsetCalls *Optional* - invitation_timeout (int): invitationTimeout *Optional* - require_authentication (bool): requireAuthentication *Optional* - sip_authentication_user_name (str): sipAuthenticationUserName *Optional* - sip_authentication_password (str): sipAuthenticationPassword *Optional* - hosted_user_id_list (hostedUserIdList): hostedUserIdList *Optional* - trunk_group_identity (str): trunkGroupIdentity *Optional* - otg_dtg_identity (str): otgDtgIdentity *Optional* - include_trunk_group_identity (bool): includeTrunkGroupIdentity *Optional* - include_dtg_identity (bool): includeDtgIdentity *Optional* - enable_network_address_identity (bool): enableNetworkAddressIdentity *Optional* - allow_unscreened_calls (bool): allowUnscreenedCalls *Optional* - allow_unscreened_emergency_calls (bool): allowUnscreenedEmergencyCalls *Optional* - pilot_user_calling_line_identity_policy (str): pilotUserCallingLineIdentityPolicy - *Optional* - pilot_user_charge_number_policy (str): pilotUserChargeNumberPolicy *Optional* - call_forwarding_always_action (str): callForwardingAlwaysAction *Optional* - call_forwarding_always_forward_address (str): callForwardingAlwaysForwardAddress - *Optional* - call_forwarding_always_reroute_trunk_group_key - (callForwardingAlwaysRerouteTrunkGroupKey): - callForwardingAlwaysRerouteTrunkGroupKey *Optional* + language (str): language *Optional* + time_zone (str): timeZone *Optional* + sip_alias_list (sipAliasList): sipAliasList *Optional* """ __slots__: List[str] = [ - "trunk_group_key", - "new_name", - "pilot_user_id", + "name", + "calling_line_id_last_name", + "calling_line_id_first_name", + "hiragana_last_name", + "hiragana_first_name", + "phone_number", + "extension", + "password", "department", - "access_device", - "max_active_calls", - "max_incoming_calls", - "max_outgoing_calls", - "enable_bursting", - "bursting_max_active_calls", - "bursting_max_incoming_calls", - "bursting_max_outgoing_calls", - "capacity_exceeded_action", - "capacity_exceeded_forward_address", - "capacity_exceeded_reroute_trunk_group_key", - "capacity_exceeded_trap_initial_calls", - "capacity_exceeded_trap_offset_calls", - "unreachable_destination_action", - "unreachable_destination_forward_address", - "unreachable_destination_reroute_trunk_group_key", - "unreachable_destination_trap_initial_calls", - "unreachable_destination_trap_offset_calls", - "invitation_timeout", - "require_authentication", - "sip_authentication_user_name", - "sip_authentication_password", - "hosted_user_id_list", - "trunk_group_identity", - "otg_dtg_identity", - "include_trunk_group_identity", - "include_dtg_identity", - "enable_network_address_identity", - "allow_unscreened_calls", - "allow_unscreened_emergency_calls", - "pilot_user_calling_line_identity_policy", - "pilot_user_charge_number_policy", - "call_forwarding_always_action", - "call_forwarding_always_forward_address", - "call_forwarding_always_reroute_trunk_group_key", + "language", + "time_zone", + "sip_alias_list", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E( - "trunk_group_key", - "trunkGroupKey", - TrunkGroupKey, - is_complex=True, - is_required=True, - ), - E("new_name", "newName", str), - E("pilot_user_id", "pilotUserId", str), + E("name", "name", str), + E("calling_line_id_last_name", "callingLineIdLastName", str), + E("calling_line_id_first_name", "callingLineIdFirstName", str), + E("hiragana_last_name", "hiraganaLastName", str), + E("hiragana_first_name", "hiraganaFirstName", str), + E("phone_number", "phoneNumber", str), + E("extension", "extension", str), + E("password", "password", str), E("department", "department", DepartmentKey, is_complex=True), - E("access_device", "accessDevice", AccessDevice, is_complex=True), - E("max_active_calls", "maxActiveCalls", int), - E("max_incoming_calls", "maxIncomingCalls", int), - E("max_outgoing_calls", "maxOutgoingCalls", int), - E("enable_bursting", "enableBursting", bool), - E("bursting_max_active_calls", "burstingMaxActiveCalls", int), - E("bursting_max_incoming_calls", "burstingMaxIncomingCalls", int), - E("bursting_max_outgoing_calls", "burstingMaxOutgoingCalls", int), - E("capacity_exceeded_action", "capacityExceededAction", str), - E( - "capacity_exceeded_forward_address", - "capacityExceededForwardAddress", - str, - ), - E( - "capacity_exceeded_reroute_trunk_group_key", - "capacityExceededRerouteTrunkGroupKey", - TrunkGroupKey, - is_complex=True, - ), - E( - "capacity_exceeded_trap_initial_calls", - "capacityExceededTrapInitialCalls", - int, - ), - E( - "capacity_exceeded_trap_offset_calls", - "capacityExceededTrapOffsetCalls", - int, - ), - E("unreachable_destination_action", "unreachableDestinationAction", str), - E( - "unreachable_destination_forward_address", - "unreachableDestinationForwardAddress", - str, - ), - E( - "unreachable_destination_reroute_trunk_group_key", - "unreachableDestinationRerouteTrunkGroupKey", - TrunkGroupKey, - is_complex=True, - ), - E( - "unreachable_destination_trap_initial_calls", - "unreachableDestinationTrapInitialCalls", - int, - ), - E( - "unreachable_destination_trap_offset_calls", - "unreachableDestinationTrapOffsetCalls", - int, - ), - E("invitation_timeout", "invitationTimeout", int), - E("require_authentication", "requireAuthentication", bool), - E("sip_authentication_user_name", "sipAuthenticationUserName", str), - E("sip_authentication_password", "sipAuthenticationPassword", str), - E( - "hosted_user_id_list", - "hostedUserIdList", - ReplacementUserIdList, - is_complex=True, - ), - E("trunk_group_identity", "trunkGroupIdentity", str), - E("otg_dtg_identity", "otgDtgIdentity", str), - E("include_trunk_group_identity", "includeTrunkGroupIdentity", bool), - E("include_dtg_identity", "includeDtgIdentity", bool), - E("enable_network_address_identity", "enableNetworkAddressIdentity", bool), - E("allow_unscreened_calls", "allowUnscreenedCalls", bool), - E( - "allow_unscreened_emergency_calls", - "allowUnscreenedEmergencyCalls", - bool, - ), - E( - "pilot_user_calling_line_identity_policy", - "pilotUserCallingLineIdentityPolicy", - str, - ), - E("pilot_user_charge_number_policy", "pilotUserChargeNumberPolicy", str), - E("call_forwarding_always_action", "callForwardingAlwaysAction", str), - E( - "call_forwarding_always_forward_address", - "callForwardingAlwaysForwardAddress", - str, - ), + E("language", "language", str), + E("time_zone", "timeZone", str), E( - "call_forwarding_always_reroute_trunk_group_key", - "callForwardingAlwaysRerouteTrunkGroupKey", - TrunkGroupKey, + "sip_alias_list", + "sipAliasList", + ReplacementSIPAliasList, is_complex=True, ), ) -class IncomingCallingPlanDepartmentPermissions(OCIType): +class ServiceInstanceReadProfile(OCIType): """ - Allows or disallows various types of incoming calls for a specified department. + Service Profile Information for group service. + It is identical to the ServiceInstanceAddProfile, but without the password. Prior to + release 14 this was called ServiceInstanceProfile. Attributes: - department_key (departmentKey): departmentKey - department_full_path_name (str): departmentFullPathName - allow_from_within_group (bool): allowFromWithinGroup - allow_from_outside_group (str): allowFromOutsideGroup - allow_collect_calls (bool): allowCollectCalls - digit_pattern_permission (List[digitPatternPermission]): digitPatternPermission - *Optional* + name (str): name + calling_line_id_last_name (str): callingLineIdLastName + calling_line_id_first_name (str): callingLineIdFirstName + hiragana_last_name (str): hiraganaLastName *Optional* + hiragana_first_name (str): hiraganaFirstName *Optional* + phone_number (str): phoneNumber *Optional* + extension (str): extension *Optional* + department (department): department *Optional* + language (str): language *Optional* + time_zone (str): timeZone *Optional* + time_zone_display_name (str): timeZoneDisplayName *Optional* + alias (List[str]): alias *Optional* + public_user_identity (str): publicUserIdentity *Optional* """ __slots__: List[str] = [ - "department_key", - "department_full_path_name", - "allow_from_within_group", - "allow_from_outside_group", - "allow_collect_calls", - "digit_pattern_permission", + "name", + "calling_line_id_last_name", + "calling_line_id_first_name", + "hiragana_last_name", + "hiragana_first_name", + "phone_number", + "extension", + "department", + "language", + "time_zone", + "time_zone_display_name", + "alias", + "public_user_identity", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( + E("name", "name", str, is_required=True), E( - "department_key", - "departmentKey", - DepartmentKey, - is_complex=True, - is_required=True, - ), - E( - "department_full_path_name", - "departmentFullPathName", + "calling_line_id_last_name", + "callingLineIdLastName", str, is_required=True, ), E( - "allow_from_within_group", - "allowFromWithinGroup", - bool, - is_required=True, - ), - E( - "allow_from_outside_group", - "allowFromOutsideGroup", + "calling_line_id_first_name", + "callingLineIdFirstName", str, is_required=True, ), - E("allow_collect_calls", "allowCollectCalls", bool, is_required=True), - E( - "digit_pattern_permission", - "digitPatternPermission", - IncomingCallingPlanDigitPatternPermission, - is_complex=True, - is_array=True, - ), + E("hiragana_last_name", "hiraganaLastName", str), + E("hiragana_first_name", "hiraganaFirstName", str), + E("phone_number", "phoneNumber", str), + E("extension", "extension", str), + E("department", "department", DepartmentKey, is_complex=True), + E("language", "language", str), + E("time_zone", "timeZone", str), + E("time_zone_display_name", "timeZoneDisplayName", str), + E("alias", "alias", str, is_array=True), + E("public_user_identity", "publicUserIdentity", str), ) -class IncomingCallingPlanDepartmentPermissionsModify(OCIType): +class ServiceInstanceReadProfile17(OCIType): """ - Allows or disallows various types of incoming calls for a specified department. + Service Profile Information for group service. - For use when modifing settings. + It is identical to the ServiceInstanceAddProfile, but without the password. Replaced + by: ServiceInstanceReadProfile17sp4 Attributes: - department_key (departmentKey): departmentKey - allow_from_within_group (bool): allowFromWithinGroup *Optional* - allow_from_outside_group (str): allowFromOutsideGroup *Optional* - allow_collect_calls (bool): allowCollectCalls *Optional* - digit_pattern_permission (List[digitPatternPermission]): digitPatternPermission - *Optional* + name (str): name + calling_line_id_last_name (str): callingLineIdLastName + calling_line_id_first_name (str): callingLineIdFirstName + hiragana_last_name (str): hiraganaLastName *Optional* + hiragana_first_name (str): hiraganaFirstName *Optional* + phone_number (str): phoneNumber *Optional* + extension (str): extension *Optional* + department (department): department *Optional* + language (str): language *Optional* + time_zone (str): timeZone *Optional* + time_zone_display_name (str): timeZoneDisplayName *Optional* + alias (List[str]): alias *Optional* + public_user_identity (str): publicUserIdentity *Optional* """ __slots__: List[str] = [ - "department_key", - "allow_from_within_group", - "allow_from_outside_group", - "allow_collect_calls", - "digit_pattern_permission", + "name", + "calling_line_id_last_name", + "calling_line_id_first_name", + "hiragana_last_name", + "hiragana_first_name", + "phone_number", + "extension", + "department", + "language", + "time_zone", + "time_zone_display_name", + "alias", + "public_user_identity", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( + E("name", "name", str, is_required=True), E( - "department_key", - "departmentKey", - DepartmentKey, - is_complex=True, + "calling_line_id_last_name", + "callingLineIdLastName", + str, is_required=True, ), - E("allow_from_within_group", "allowFromWithinGroup", bool), - E("allow_from_outside_group", "allowFromOutsideGroup", str), - E("allow_collect_calls", "allowCollectCalls", bool), E( - "digit_pattern_permission", - "digitPatternPermission", - IncomingCallingPlanDigitPatternPermission, - is_complex=True, - is_array=True, + "calling_line_id_first_name", + "callingLineIdFirstName", + str, + is_required=True, ), + E("hiragana_last_name", "hiraganaLastName", str), + E("hiragana_first_name", "hiraganaFirstName", str), + E("phone_number", "phoneNumber", str), + E("extension", "extension", str), + E("department", "department", DepartmentKey, is_complex=True), + E("language", "language", str), + E("time_zone", "timeZone", str), + E("time_zone_display_name", "timeZoneDisplayName", str), + E("alias", "alias", str, is_array=True), + E("public_user_identity", "publicUserIdentity", str), ) -class IncomingCallingPlanPermissions(OCIType): +class ServiceInstanceReadProfile17sp4(OCIType): """ - Allows or disallows various types of incoming calls for a user or group -- not any - particular department. + Service Profile Information for group service. + Replaced by: ServiceInstanceReadProfile19sp1 Attributes: - allow_from_within_group (bool): allowFromWithinGroup - allow_from_outside_group (str): allowFromOutsideGroup - allow_collect_calls (bool): allowCollectCalls - digit_pattern_permission (List[digitPatternPermission]): digitPatternPermission - *Optional* + name (str): name + calling_line_id_last_name (str): callingLineIdLastName + calling_line_id_first_name (str): callingLineIdFirstName + hiragana_last_name (str): hiraganaLastName *Optional* + hiragana_first_name (str): hiraganaFirstName *Optional* + phone_number (str): phoneNumber *Optional* + extension (str): extension *Optional* + country_code (str): countryCode *Optional* + national_prefix (str): nationalPrefix *Optional* + department (department): department *Optional* + language (str): language *Optional* + time_zone (str): timeZone *Optional* + time_zone_display_name (str): timeZoneDisplayName *Optional* + alias (List[str]): alias *Optional* + public_user_identity (str): publicUserIdentity *Optional* """ __slots__: List[str] = [ - "allow_from_within_group", - "allow_from_outside_group", - "allow_collect_calls", - "digit_pattern_permission", + "name", + "calling_line_id_last_name", + "calling_line_id_first_name", + "hiragana_last_name", + "hiragana_first_name", + "phone_number", + "extension", + "country_code", + "national_prefix", + "department", + "language", + "time_zone", + "time_zone_display_name", + "alias", + "public_user_identity", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( + E("name", "name", str, is_required=True), E( - "allow_from_within_group", - "allowFromWithinGroup", - bool, + "calling_line_id_last_name", + "callingLineIdLastName", + str, is_required=True, ), E( - "allow_from_outside_group", - "allowFromOutsideGroup", + "calling_line_id_first_name", + "callingLineIdFirstName", str, is_required=True, ), - E("allow_collect_calls", "allowCollectCalls", bool, is_required=True), - E( - "digit_pattern_permission", - "digitPatternPermission", - IncomingCallingPlanDigitPatternPermission, - is_complex=True, - is_array=True, - ), + E("hiragana_last_name", "hiraganaLastName", str), + E("hiragana_first_name", "hiraganaFirstName", str), + E("phone_number", "phoneNumber", str), + E("extension", "extension", str), + E("country_code", "countryCode", str), + E("national_prefix", "nationalPrefix", str), + E("department", "department", DepartmentKey, is_complex=True), + E("language", "language", str), + E("time_zone", "timeZone", str), + E("time_zone_display_name", "timeZoneDisplayName", str), + E("alias", "alias", str, is_array=True), + E("public_user_identity", "publicUserIdentity", str), ) -class IncomingCallingPlanPermissionsModify(OCIType): +class ServiceInstanceReadProfile19sp1(OCIType): """ - Allows or disallows various types of incoming calls for a user or group -- not any - particular department. + Service Profile Information for group service. - For use when modifing settings. + The callingLineIdPhoneNumber is no longer being formatted for display purpose. The + value is returned exactly the same as being stored. Attributes: - allow_from_within_group (bool): allowFromWithinGroup *Optional* - allow_from_outside_group (str): allowFromOutsideGroup *Optional* - allow_collect_calls (bool): allowCollectCalls *Optional* - digit_pattern_permission (List[digitPatternPermission]): digitPatternPermission - *Optional* + name (str): name + calling_line_id_last_name (str): callingLineIdLastName + calling_line_id_first_name (str): callingLineIdFirstName + hiragana_last_name (str): hiraganaLastName *Optional* + hiragana_first_name (str): hiraganaFirstName *Optional* + phone_number (str): phoneNumber *Optional* + extension (str): extension *Optional* + country_code (str): countryCode *Optional* + national_prefix (str): nationalPrefix *Optional* + department (department): department *Optional* + language (str): language *Optional* + time_zone (str): timeZone *Optional* + time_zone_display_name (str): timeZoneDisplayName *Optional* + alias (List[str]): alias *Optional* + public_user_identity (str): publicUserIdentity *Optional* + calling_line_id_phone_number (str): callingLineIdPhoneNumber *Optional* """ __slots__: List[str] = [ - "allow_from_within_group", - "allow_from_outside_group", - "allow_collect_calls", - "digit_pattern_permission", + "name", + "calling_line_id_last_name", + "calling_line_id_first_name", + "hiragana_last_name", + "hiragana_first_name", + "phone_number", + "extension", + "country_code", + "national_prefix", + "department", + "language", + "time_zone", + "time_zone_display_name", + "alias", + "public_user_identity", + "calling_line_id_phone_number", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("allow_from_within_group", "allowFromWithinGroup", bool), - E("allow_from_outside_group", "allowFromOutsideGroup", str), - E("allow_collect_calls", "allowCollectCalls", bool), + E("name", "name", str, is_required=True), E( - "digit_pattern_permission", - "digitPatternPermission", - IncomingCallingPlanDigitPatternPermission, - is_complex=True, - is_array=True, + "calling_line_id_last_name", + "callingLineIdLastName", + str, + is_required=True, + ), + E( + "calling_line_id_first_name", + "callingLineIdFirstName", + str, + is_required=True, ), + E("hiragana_last_name", "hiraganaLastName", str), + E("hiragana_first_name", "hiraganaFirstName", str), + E("phone_number", "phoneNumber", str), + E("extension", "extension", str), + E("country_code", "countryCode", str), + E("national_prefix", "nationalPrefix", str), + E("department", "department", DepartmentKey, is_complex=True), + E("language", "language", str), + E("time_zone", "timeZone", str), + E("time_zone_display_name", "timeZoneDisplayName", str), + E("alias", "alias", str, is_array=True), + E("public_user_identity", "publicUserIdentity", str), + E("calling_line_id_phone_number", "callingLineIdPhoneNumber", str), ) -class MWIDeliveryToMobileEndpointTemplateBody(OCIType): +class ServicePack(OCIType): """ - MWI Delivery To Mobile Endpoint template body. + The common Service Pack elements. Attributes: - line (List[line]): line + service_pack_name (str): servicePackName + service_pack_description (str): servicePackDescription *Optional* + is_available_for_use (bool): isAvailableForUse + service_pack_quantity (servicePackQuantity): servicePackQuantity + service_name (List[str]): serviceName *Optional* """ __slots__: List[str] = [ - "line", + "service_pack_name", + "service_pack_description", + "is_available_for_use", + "service_pack_quantity", + "service_name", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( + E("service_pack_name", "servicePackName", str, is_required=True), + E("service_pack_description", "servicePackDescription", str), + E("is_available_for_use", "isAvailableForUse", bool, is_required=True), E( - "line", - "line", - MWIDeliveryToMobileEndpointTemplateLine, + "service_pack_quantity", + "servicePackQuantity", + UnboundedPositiveInt, is_complex=True, is_required=True, - is_array=True, ), + E("service_name", "serviceName", str, is_array=True), ) -class OutgoingCallingPlanCallMeNowDepartmentPermissions(OCIType): +class ServicePackAuthorization(OCIType): """ - Outgoing Calling Plan for Call Me Now call permissions for a department. + Authorize (with quantity) or unauthorize a service pack. Attributes: - department_key (departmentKey): departmentKey - department_name (str): departmentName - permissions (permissions): permissions + service_pack_name (str): servicePackName + authorized_quantity (authorizedQuantity): authorizedQuantity *Optional* + unauthorized (bool): unauthorized *Optional* """ __slots__: List[str] = [ - "department_key", - "department_name", - "permissions", + "service_pack_name", + "authorized_quantity", + "unauthorized", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( + E("service_pack_name", "servicePackName", str, is_required=True), E( - "department_key", - "departmentKey", - DepartmentKey, - is_complex=True, - is_required=True, - ), - E("department_name", "departmentName", str, is_required=True), - E( - "permissions", - "permissions", - OutgoingCallingPlanCallMeNowPermissions, + "authorized_quantity", + "authorizedQuantity", + UnboundedPositiveInt, is_complex=True, - is_required=True, ), + E("unauthorized", "unauthorized", bool), ) -class OutgoingCallingPlanCallMeNowDepartmentPermissionsModify(OCIType): +class ServiceProviderCommunicationBarringProfileGetResponse19sp1V2(OCIType): """ - Modify outgoing Calling Plan for Call Me Now call permissions for a department. + Response to the ServiceProviderCommunicationBarringProfileGetRequest19sp1V2. + The response contains the Communication Barring Profile information. The incoming, + originating, redirecting and call me now rules are returned in ascending priority + order. The following elements are only used in AS data mode: callMeNowDefaultAction + callMeNowDefaultCallTimeout callMeNowRule applyToAttendedCallTransfers Attributes: - department_key (departmentKey): departmentKey - permissions (permissions): permissions + description (str): description *Optional* + originating_default_action (str): originatingDefaultAction + originating_default_treatment_id (str): originatingDefaultTreatmentId *Optional* + originating_default_transfer_number (str): originatingDefaultTransferNumber + *Optional* + originating_default_call_timeout (int): originatingDefaultCallTimeout *Optional* + originating_rule (List[originatingRule]): originatingRule *Optional* + redirecting_default_action (str): redirectingDefaultAction + redirecting_default_call_timeout (int): redirectingDefaultCallTimeout *Optional* + redirecting_rule (List[redirectingRule]): redirectingRule *Optional* + call_me_now_default_action (str): callMeNowDefaultAction + call_me_now_default_call_timeout (int): callMeNowDefaultCallTimeout *Optional* + call_me_now_rule (List[callMeNowRule]): callMeNowRule *Optional* + incoming_default_action (str): incomingDefaultAction + incoming_default_call_timeout (int): incomingDefaultCallTimeout *Optional* + incoming_rule (List[incomingRule]): incomingRule *Optional* + is_default (bool): isDefault + apply_to_attended_call_transfers (bool): applyToAttendedCallTransfers """ __slots__: List[str] = [ - "department_key", - "permissions", + "description", + "originating_default_action", + "originating_default_treatment_id", + "originating_default_transfer_number", + "originating_default_call_timeout", + "originating_rule", + "redirecting_default_action", + "redirecting_default_call_timeout", + "redirecting_rule", + "call_me_now_default_action", + "call_me_now_default_call_timeout", + "call_me_now_rule", + "incoming_default_action", + "incoming_default_call_timeout", + "incoming_rule", + "is_default", + "apply_to_attended_call_transfers", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( + E("description", "description", str), E( - "department_key", - "departmentKey", - DepartmentKey, + "originating_default_action", + "originatingDefaultAction", + str, + is_required=True, + ), + E("originating_default_treatment_id", "originatingDefaultTreatmentId", str), + E( + "originating_default_transfer_number", + "originatingDefaultTransferNumber", + str, + ), + E("originating_default_call_timeout", "originatingDefaultCallTimeout", int), + E( + "originating_rule", + "originatingRule", + ServiceProviderCommunicationBarringHierarchicalOriginatingRule, is_complex=True, + is_array=True, + ), + E( + "redirecting_default_action", + "redirectingDefaultAction", + str, is_required=True, ), + E("redirecting_default_call_timeout", "redirectingDefaultCallTimeout", int), E( - "permissions", - "permissions", - OutgoingCallingPlanCallMeNowPermissionsModify, + "redirecting_rule", + "redirectingRule", + ServiceProviderCommunicationBarringHierarchicalRedirectingRule, is_complex=True, + is_array=True, + ), + E( + "call_me_now_default_action", + "callMeNowDefaultAction", + str, is_required=True, ), - ) - - -class OutgoingCallingPlanDepartmentAuthorizationCodes(OCIType): - """ - Outgoing Calling Plan Authorization Code for a department. - - - Attributes: - department_key (departmentKey): departmentKey - department_name (str): departmentName - code_entry (List[codeEntry]): codeEntry *Optional* - """ - - __slots__: List[str] = [ - "department_key", - "department_name", - "code_entry", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( + E("call_me_now_default_call_timeout", "callMeNowDefaultCallTimeout", int), E( - "department_key", - "departmentKey", - DepartmentKey, + "call_me_now_rule", + "callMeNowRule", + ServiceProviderCommunicationBarringHierarchicalCallMeNowRule, is_complex=True, + is_array=True, + ), + E( + "incoming_default_action", + "incomingDefaultAction", + str, is_required=True, ), - E("department_name", "departmentName", str, is_required=True), + E("incoming_default_call_timeout", "incomingDefaultCallTimeout", int), E( - "code_entry", - "codeEntry", - OutgoingCallingPlanAuthorizationCodeEntry, + "incoming_rule", + "incomingRule", + CommunicationBarringIncomingRule19sp1, is_complex=True, is_array=True, ), + E("is_default", "isDefault", bool, is_required=True), + E( + "apply_to_attended_call_transfers", + "applyToAttendedCallTransfers", + bool, + is_required=True, + ), ) -class OutgoingCallingPlanDepartmentTransferNumbers(OCIType): +class ServiceProviderReplacementCommunicationBarringHierarchicalCallMeNowRuleList( + OCIType, +): """ - Outgoing Calling Plan transfer numbers for a department. + A list of Service Provider Communication Barring Hierarchical Call Me Now Rules that + replaces a previously configured list. + By convention, an element of this type may be set nill to clear the list. Attributes: - department_key (departmentKey): departmentKey - department_name (str): departmentName - transfer_numbers (transferNumbers): transferNumbers + rule (List[rule]): rule """ __slots__: List[str] = [ - "department_key", - "department_name", - "transfer_numbers", + "rule", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( E( - "department_key", - "departmentKey", - DepartmentKey, - is_complex=True, - is_required=True, - ), - E("department_name", "departmentName", str, is_required=True), - E( - "transfer_numbers", - "transferNumbers", - OutgoingCallingPlanTransferNumbers, + "rule", + "rule", + ServiceProviderCommunicationBarringHierarchicalCallMeNowRule, is_complex=True, is_required=True, + is_array=True, ), ) -class OutgoingCallingPlanDepartmentTransferNumbersModify(OCIType): +class ServiceProviderReplacementCommunicationBarringHierarchicalOriginatingRuleList( + OCIType, +): """ - Outgoing Calling Plan transfer numbers for a department. + A list of Service Provider Communication Barring Hierarchical Originating Rules that + replaces a previously configured list. + By convention, an element of this type may be set nill to clear the list. Attributes: - department_key (departmentKey): departmentKey - transfer_numbers (transferNumbers): transferNumbers *Optional* + rule (List[rule]): rule """ __slots__: List[str] = [ - "department_key", - "transfer_numbers", + "rule", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( E( - "department_key", - "departmentKey", - DepartmentKey, + "rule", + "rule", + ServiceProviderCommunicationBarringHierarchicalOriginatingRule, is_complex=True, is_required=True, - ), - E( - "transfer_numbers", - "transferNumbers", - OutgoingCallingPlanTransferNumbersModify, - is_complex=True, + is_array=True, ), ) -class OutgoingCallingPlanDigitPatternCallMeNowPermissions(OCIType): +class ServiceProviderReplacementCommunicationBarringHierarchicalRedirectingRuleList( + OCIType, +): """ - Outgoing Calling Plan Call Me Now call permissions for specified digit patterns. + A list of Service Provider Communication Barring Hierarchical Redirecting Rules that + replaces a previously configured list. + By convention, an element of this type may be set nill to clear the list. Attributes: - digit_pattern_permissions (List[digitPatternPermissions]): digitPatternPermissions + rule (List[rule]): rule """ __slots__: List[str] = [ - "digit_pattern_permissions", + "rule", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( E( - "digit_pattern_permissions", - "digitPatternPermissions", - OutgoingCallingPlanDigitPatternCallMeNowPermission, + "rule", + "rule", + ServiceProviderCommunicationBarringHierarchicalRedirectingRule, is_complex=True, is_required=True, is_array=True, @@ -28111,2076 +28759,1512 @@ def _elements(cls) -> Tuple[E, ...]: ) -class OutgoingCallingPlanDigitPatternOriginatingPermissions(OCIType): +class ShInterfaceUserIdDataEntry(OCIType): """ - Outgoing Calling Plan originating call permissions for specified digit patterns. + ShInterface User Id Data Entry. Attributes: - digit_pattern_permissions (List[digitPatternPermissions]): digitPatternPermissions + user_type (str): userType + public_user_identity (publicUserIdentity): publicUserIdentity + endpoint_type (str): endpointType + scscf_name (str): SCSCFName *Optional* + ims_user_state (str): IMSUserState """ __slots__: List[str] = [ - "digit_pattern_permissions", + "user_type", + "public_user_identity", + "endpoint_type", + "scscf_name", + "ims_user_state", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( + E("user_type", "userType", str, is_required=True), E( - "digit_pattern_permissions", - "digitPatternPermissions", - OutgoingCallingPlanDigitPatternOriginatingPermission, + "public_user_identity", + "publicUserIdentity", + PublicUserIdentity, is_complex=True, is_required=True, - is_array=True, ), + E("endpoint_type", "endpointType", str, is_required=True), + E("scscf_name", "SCSCFName", str), + E("ims_user_state", "IMSUserState", str, is_required=True), ) -class OutgoingCallingPlanDigitPatternRedirectingPermissions(OCIType): +class ShInterfaceUserIdDataEntry21sp1(OCIType): """ - Outgoing Calling Plan redirecting call permissions for specified digit patterns. + ShInterface User Id Data Entry. Attributes: - digit_pattern_permissions (List[digitPatternPermissions]): digitPatternPermissions + user_type (str): userType + public_user_identity (publicUserIdentity): publicUserIdentity + endpoint_type (str): endpointType + scscf_name (str): SCSCFName *Optional* + ims_user_state (str): IMSUserState """ __slots__: List[str] = [ - "digit_pattern_permissions", + "user_type", + "public_user_identity", + "endpoint_type", + "scscf_name", + "ims_user_state", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( + E("user_type", "userType", str, is_required=True), E( - "digit_pattern_permissions", - "digitPatternPermissions", - OutgoingCallingPlanDigitPatternRedirectingPermission, + "public_user_identity", + "publicUserIdentity", + PublicUserIdentity, is_complex=True, is_required=True, - is_array=True, ), + E("endpoint_type", "endpointType", str, is_required=True), + E("scscf_name", "SCSCFName", str), + E("ims_user_state", "IMSUserState", str, is_required=True), ) -class OutgoingCallingPlanGroupAuthorizationCodes(OCIType): +class ShInterfaceUserListEntry(OCIType): """ - Outgoing Calling Plan Authorization Code for the group default. + ShInterface User List Entry. Attributes: - code_entry (List[codeEntry]): codeEntry *Optional* + user_id (str): userId + user_type (str): userType + public_user_identity (publicUserIdentity): publicUserIdentity + endpoint_type (str): endpointType + scscf_name (str): SCSCFName *Optional* + ims_user_state (str): IMSUserState """ __slots__: List[str] = [ - "code_entry", + "user_id", + "user_type", + "public_user_identity", + "endpoint_type", + "scscf_name", + "ims_user_state", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( + E("user_id", "userId", str, is_required=True), + E("user_type", "userType", str, is_required=True), E( - "code_entry", - "codeEntry", - OutgoingCallingPlanAuthorizationCodeEntry, + "public_user_identity", + "publicUserIdentity", + PublicUserIdentity, is_complex=True, - is_array=True, + is_required=True, ), + E("endpoint_type", "endpointType", str, is_required=True), + E("scscf_name", "SCSCFName", str), + E("ims_user_state", "IMSUserState", str, is_required=True), ) -class OutgoingCallingPlanOriginatingDepartmentPermissions(OCIType): +class ShInterfaceUserListEntry21sp1(OCIType): """ - Outgoing Calling Plan originating call permissions for a department. + ShInterface User List Entry. Attributes: - department_key (departmentKey): departmentKey - department_name (str): departmentName - permissions (permissions): permissions + user_id (str): userId + user_type (str): userType + public_user_identity (publicUserIdentity): publicUserIdentity + endpoint_type (str): endpointType + scscf_name (str): SCSCFName *Optional* + ims_user_state (str): IMSUserState """ __slots__: List[str] = [ - "department_key", - "department_name", - "permissions", + "user_id", + "user_type", + "public_user_identity", + "endpoint_type", + "scscf_name", + "ims_user_state", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( + E("user_id", "userId", str, is_required=True), + E("user_type", "userType", str, is_required=True), E( - "department_key", - "departmentKey", - DepartmentKey, - is_complex=True, - is_required=True, - ), - E("department_name", "departmentName", str, is_required=True), - E( - "permissions", - "permissions", - OutgoingCallingPlanOriginatingPermissions, + "public_user_identity", + "publicUserIdentity", + PublicUserIdentity, is_complex=True, is_required=True, ), + E("endpoint_type", "endpointType", str, is_required=True), + E("scscf_name", "SCSCFName", str), + E("ims_user_state", "IMSUserState", str, is_required=True), ) -class OutgoingCallingPlanOriginatingDepartmentPermissionsModify(OCIType): +class SimultaneousRingReplacementNumberList(OCIType): """ - Outgoing Calling Plan originating call permissions for a department. + A list of Simultaneous Ring numbers that replaces a previously configured list. + By convention, an element of this type may be set nill to clear the list. Attributes: - department_key (departmentKey): departmentKey - permissions (permissions): permissions *Optional* + simultaneous_ring_number (List[simultaneousRingNumber]): simultaneousRingNumber """ __slots__: List[str] = [ - "department_key", - "permissions", + "simultaneous_ring_number", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( E( - "department_key", - "departmentKey", - DepartmentKey, + "simultaneous_ring_number", + "simultaneousRingNumber", + SimultaneousRingNumber, is_complex=True, is_required=True, - ), - E( - "permissions", - "permissions", - OutgoingCallingPlanOriginatingPermissionsModify, - is_complex=True, + is_array=True, ), ) -class OutgoingCallingPlanRedirectedDepartmentPermissions(OCIType): +class SortByAdminFirstName(SortCriteria): """ - Outgoing Calling Plan being forwarded/transferred permissions for a department. + The sort criteria specifies the administrator first name as the column for the sort, + whether the sort is ascending or descending, and whether the sort is case sensitive. Attributes: - department_key (departmentKey): departmentKey - department_name (str): departmentName - permissions (permissions): permissions + is_ascending (bool): isAscending + is_case_sensitive (bool): isCaseSensitive """ __slots__: List[str] = [ - "department_key", - "department_name", - "permissions", + "is_ascending", + "is_case_sensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E( - "department_key", - "departmentKey", - DepartmentKey, - is_complex=True, - is_required=True, - ), - E("department_name", "departmentName", str, is_required=True), - E( - "permissions", - "permissions", - OutgoingCallingPlanRedirectedPermissions, - is_complex=True, - is_required=True, - ), + E("is_ascending", "isAscending", bool, is_required=True), + E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), ) -class OutgoingCallingPlanRedirectedDepartmentPermissionsModify(OCIType): +class SortByAdminId(SortCriteria): """ - Outgoing Calling Plan being forwarded/transferred permissions for a department. + The sort criteria specifies the administrator id as the column for the sort, whether + the sort is ascending or descending, and whether the sort is case sensitive. Attributes: - department_key (departmentKey): departmentKey - permissions (permissions): permissions + is_ascending (bool): isAscending + is_case_sensitive (bool): isCaseSensitive """ __slots__: List[str] = [ - "department_key", - "permissions", + "is_ascending", + "is_case_sensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E( - "department_key", - "departmentKey", - DepartmentKey, - is_complex=True, - is_required=True, - ), - E( - "permissions", - "permissions", - OutgoingCallingPlanRedirectedPermissionsModify, - is_complex=True, - is_required=True, - ), + E("is_ascending", "isAscending", bool, is_required=True), + E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), ) -class OutgoingCallingPlanRedirectingDepartmentPermissions(OCIType): +class SortByAdminLastName(SortCriteria): """ - Outgoing Calling Plan initiating call forwards/transfer permissions for a department. + The sort criteria specifies the administrator last name as the column for the sort, + whether the sort is ascending or descending, and whether the sort is case sensitive. Attributes: - department_key (departmentKey): departmentKey - department_name (str): departmentName - permissions (permissions): permissions + is_ascending (bool): isAscending + is_case_sensitive (bool): isCaseSensitive """ __slots__: List[str] = [ - "department_key", - "department_name", - "permissions", + "is_ascending", + "is_case_sensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E( - "department_key", - "departmentKey", - DepartmentKey, - is_complex=True, - is_required=True, - ), - E("department_name", "departmentName", str, is_required=True), - E( - "permissions", - "permissions", - OutgoingCallingPlanRedirectingPermissions, - is_complex=True, - is_required=True, - ), + E("is_ascending", "isAscending", bool, is_required=True), + E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), ) -class OutgoingCallingPlanRedirectingDepartmentPermissionsModify(OCIType): +class SortByAgentThresholdProfile(SortCriteria): """ - Outgoing Calling Plan initiating call forwards/transfer permissions for a department. + The sort criteria specifies the call center agent threshold profile as the column for + the sort, whether the sort is ascending or descending, and whether the sort is case + sensitive. Attributes: - department_key (departmentKey): departmentKey - permissions (permissions): permissions + is_ascending (bool): isAscending + is_case_sensitive (bool): isCaseSensitive """ __slots__: List[str] = [ - "department_key", - "permissions", + "is_ascending", + "is_case_sensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E( - "department_key", - "departmentKey", - DepartmentKey, - is_complex=True, - is_required=True, - ), - E( - "permissions", - "permissions", - OutgoingCallingPlanRedirectingPermissionsModify, - is_complex=True, - is_required=True, - ), + E("is_ascending", "isAscending", bool, is_required=True), + E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), ) -class OutgoingPinholeDigitPlanDigitPatternCallMeNowPermissions(OCIType): +class SortByAnnouncementFileName(SortCriteria): """ - Outgoing Pinhole Digit Plan Call Me Now call permissions for specified digit patterns. + The sort criteria specifies the file name as the column for the sort, whether the sort + is ascending or descending, and whether the sort is case sensitive. Attributes: - digit_pattern_permissions (List[digitPatternPermissions]): digitPatternPermissions + is_ascending (bool): isAscending + is_case_sensitive (bool): isCaseSensitive """ __slots__: List[str] = [ - "digit_pattern_permissions", + "is_ascending", + "is_case_sensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E( - "digit_pattern_permissions", - "digitPatternPermissions", - OutgoingPinholeDigitPlanDigitPatternCallMeNowPermission, - is_complex=True, - is_required=True, - is_array=True, - ), + E("is_ascending", "isAscending", bool, is_required=True), + E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), ) -class OutgoingPinholeDigitPlanDigitPatternOriginatingPermissions(OCIType): +class SortByAnnouncementFileSize(SortCriteriaNumeric): """ - Outgoing Pinhole Digit Plan originating call permissions for specified digit patterns. + The sort criteria specifies the file size as the column for the sort, whether the sort + is ascending or descending, and whether the sort is case sensitive. Attributes: - digit_pattern_permissions (List[digitPatternPermissions]): digitPatternPermissions + is_ascending (bool): isAscending """ __slots__: List[str] = [ - "digit_pattern_permissions", + "is_ascending", ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return ( - E( - "digit_pattern_permissions", - "digitPatternPermissions", - OutgoingPinholeDigitPlanDigitPatternOriginatingPermission, - is_complex=True, - is_required=True, - is_array=True, - ), - ) + return (E("is_ascending", "isAscending", bool, is_required=True),) -class OutgoingPinholeDigitPlanDigitPatternRedirectingPermissions(OCIType): +class SortByCallCenterName(SortCriteria): """ - Outgoing Pinhole Digit Plan redirecting call permissions for specified digit patterns. + The sort criteria specifies the call center name as the column for the sort, whether + the sort is ascending or descending, and whether the sort is case sensitive. Attributes: - digit_pattern_permissions (List[digitPatternPermissions]): digitPatternPermissions + is_ascending (bool): isAscending + is_case_sensitive (bool): isCaseSensitive """ __slots__: List[str] = [ - "digit_pattern_permissions", + "is_ascending", + "is_case_sensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E( - "digit_pattern_permissions", - "digitPatternPermissions", - OutgoingPinholeDigitPlanDigitPatternRedirectingPermission, - is_complex=True, - is_required=True, - is_array=True, - ), + E("is_ascending", "isAscending", bool, is_required=True), + E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), ) -class PriorityAlertCriteriaFromDnModify(OCIType): +class SortByCallCenterType(SortCriteria): """ - The from dn criteria used within a modify request. + The sort criteria specifies the call center type as the column for the sort, whether + the sort is ascending or descending, and whether the sort is case sensitive. Attributes: - from_dn_criteria_selection (str): fromDnCriteriaSelection *Optional* - include_anonymous_callers (bool): includeAnonymousCallers *Optional* - include_unavailable_callers (bool): includeUnavailableCallers *Optional* - phone_number_list (phoneNumberList): phoneNumberList *Optional* + is_ascending (bool): isAscending + is_case_sensitive (bool): isCaseSensitive """ __slots__: List[str] = [ - "from_dn_criteria_selection", - "include_anonymous_callers", - "include_unavailable_callers", - "phone_number_list", + "is_ascending", + "is_case_sensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("from_dn_criteria_selection", "fromDnCriteriaSelection", str), - E("include_anonymous_callers", "includeAnonymousCallers", bool), - E("include_unavailable_callers", "includeUnavailableCallers", bool), - E( - "phone_number_list", - "phoneNumberList", - CriteriaReplacementDNList, - is_complex=True, - ), + E("is_ascending", "isAscending", bool, is_required=True), + E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), ) -class ProfileAndServiceDeviceEndpointInfo(OCIType): +class SortByCallParkName(SortCriteria): """ - Represents information about an endpoint device + The sort criteria specifies the call park name as the column for the sort, whether the + sort is ascending or descending, and whether the sort is case sensitive. + Attributes: - access_device (accessDevice): accessDevice - line_port (str): linePort - private_identity (str): privateIdentity *Optional* - access_device_mac_address (str): accessDeviceMacAddress *Optional* + is_ascending (bool): isAscending + is_case_sensitive (bool): isCaseSensitive """ __slots__: List[str] = [ - "access_device", - "line_port", - "private_identity", - "access_device_mac_address", + "is_ascending", + "is_case_sensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E( - "access_device", - "accessDevice", - AccessDevice, - is_complex=True, - is_required=True, - ), - E("line_port", "linePort", str, is_required=True), - E("private_identity", "privateIdentity", str), - E("access_device_mac_address", "accessDeviceMacAddress", str), + E("is_ascending", "isAscending", bool, is_required=True), + E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), ) -class ProfileAndServiceMusicOnHoldInfo(OCIType): +class SortByCallPickupName(SortCriteria): """ - This is the configuration parameters for Music On Hold service + The sort criteria specifies the call pickup name as the column for the sort, whether + the sort is ascending or descending, and whether the sort is case sensitive. + Attributes: - enable_video (bool): enableVideo - source (source): source - use_alternate_source_for_internal_calls (bool): useAlternateSourceForInternalCalls - internal_source (internalSource): internalSource *Optional* + is_ascending (bool): isAscending + is_case_sensitive (bool): isCaseSensitive """ __slots__: List[str] = [ - "enable_video", - "source", - "use_alternate_source_for_internal_calls", - "internal_source", + "is_ascending", + "is_case_sensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("enable_video", "enableVideo", bool, is_required=True), - E( - "source", - "source", - MusicOnHoldUserSourceRead16, - is_complex=True, - is_required=True, - ), - E( - "use_alternate_source_for_internal_calls", - "useAlternateSourceForInternalCalls", - bool, - is_required=True, - ), - E( - "internal_source", - "internalSource", - MusicOnHoldUserSourceRead16, - is_complex=True, - ), + E("is_ascending", "isAscending", bool, is_required=True), + E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), ) -class ProfileAndServiceSimultaneousRingPersonalInfo(OCIType): +class SortByDepartmentName(SortCriteria): """ - This is the configuration parameters for Simultaneous Ring Personal service Contains a - criteria table with column heading: "Is Active", "Criteria Name", "Time Schedule", - "Holiday Schedule", "Calls From" and "Blacklisted". + The sort criteria specifies the department name as the column for the sort, whether + the sort is ascending or descending, and whether the sort is case sensitive. - The "Calls From" column is a string containing call numbers Attributes: - is_active (bool): isActive - do_not_ring_if_on_call (bool): doNotRingIfOnCall - simultaneous_ring_number (List[simultaneousRingNumber]): simultaneousRingNumber - *Optional* - criteria_table (List(criteriaTable)): criteriaTable - *Table* array of - criteriaTable named tuples + is_ascending (bool): isAscending + is_case_sensitive (bool): isCaseSensitive """ __slots__: List[str] = [ - "is_active", - "do_not_ring_if_on_call", - "simultaneous_ring_number", - "criteria_table", + "is_ascending", + "is_case_sensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("is_active", "isActive", bool, is_required=True), - E("do_not_ring_if_on_call", "doNotRingIfOnCall", bool, is_required=True), - E( - "simultaneous_ring_number", - "simultaneousRingNumber", - SimultaneousRingNumber, - is_complex=True, - is_array=True, - ), - E( - "criteria_table", - "criteriaTable", - list, - is_complex=True, - is_required=True, - is_table=True, - ), + E("is_ascending", "isAscending", bool, is_required=True), + E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), ) -class ProfileAndServiceSpeedDial100Info(OCIType): +class SortByDeviceMACAddress(SortCriteria): """ - This is the configuration parameters for Speed Dial 100 service + The sort criteria specifies the device MAC address as the column for the sort, whether + the sort is ascending or descending, and whether the sort is case sensitive. + Attributes: - prefix (str): prefix *Optional* - speed_dial_entry (List[speedDialEntry]): speedDialEntry *Optional* + is_ascending (bool): isAscending + is_case_sensitive (bool): isCaseSensitive """ __slots__: List[str] = [ - "prefix", - "speed_dial_entry", + "is_ascending", + "is_case_sensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("prefix", "prefix", str), - E( - "speed_dial_entry", - "speedDialEntry", - SpeedDial100Entry, - is_complex=True, - is_array=True, - ), + E("is_ascending", "isAscending", bool, is_required=True), + E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), ) -class ProfileAndServiceSpeedDial8Info(OCIType): +class SortByDeviceName(SortCriteria): """ - This is the configuration parameters for Speed Dial 8 service + The sort criteria specifies the device name as the column for the sort, whether the + sort is ascending or descending, and whether the sort is case sensitive. + Attributes: - speed_dial_entry (List[speedDialEntry]): speedDialEntry *Optional* + is_ascending (bool): isAscending + is_case_sensitive (bool): isCaseSensitive """ __slots__: List[str] = [ - "speed_dial_entry", + "is_ascending", + "is_case_sensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E( - "speed_dial_entry", - "speedDialEntry", - SpeedDial8Entry, - is_complex=True, - is_array=True, - ), + E("is_ascending", "isAscending", bool, is_required=True), + E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), ) -class PushNotificationTokenData(OCIType): +class SortByDeviceNetAddress(SortCriteria): """ - ? The common push notification token elements. + The sort criteria specifies the device net address as the column for the sort, whether + the sort is ascending or descending, and whether the sort is case sensitive. Attributes: - push_notification_token (str): pushNotificationToken - push_notification_type (str): pushNotificationType - push_notification_event_data (List[pushNotificationEventData]): - pushNotificationEventData *Optional* + is_ascending (bool): isAscending + is_case_sensitive (bool): isCaseSensitive """ __slots__: List[str] = [ - "push_notification_token", - "push_notification_type", - "push_notification_event_data", + "is_ascending", + "is_case_sensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E( - "push_notification_token", - "pushNotificationToken", - str, - is_required=True, - ), - E("push_notification_type", "pushNotificationType", str, is_required=True), - E( - "push_notification_event_data", - "pushNotificationEventData", - PushNotificationEventData, - is_complex=True, - is_array=True, - ), + E("is_ascending", "isAscending", bool, is_required=True), + E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), ) -class ReceptionistContactUserAndNote(OCIType): +class SortByDeviceType(SortCriteria): """ - The Receptionist User (or VON User) and Receptionist Notes. + The sort criteria specifies the device type as the column for the sort, whether the + sort is ascending or descending, and whether the sort is case sensitive. Attributes: - contact_user_id (str): contactUserId *Optional* - von_user (vonUser): vonUser *Optional* - note (str): note + is_ascending (bool): isAscending + is_case_sensitive (bool): isCaseSensitive """ __slots__: List[str] = [ - "contact_user_id", - "von_user", - "note", + "is_ascending", + "is_case_sensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("contact_user_id", "contactUserId", str), - E("von_user", "vonUser", VirtualOnNetUserKey, is_complex=True), - E("note", "note", str, is_required=True), + E("is_ascending", "isAscending", bool, is_required=True), + E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), ) -class ReplacementAgentWeightList(OCIType): +class SortByDn(SortCriteria): """ - A list of agent userIds and hunt agent weights that replaces the previously configured - list. + The sort criteria specifies the DN as the column for the sort, whether the sort is + ascending or descending, and whether the sort is case sensitive. - By convention, an element of this type may be set nill to clear the list. Attributes: - agent_weight (List[agentWeight]): agentWeight + is_ascending (bool): isAscending + is_case_sensitive (bool): isCaseSensitive """ __slots__: List[str] = [ - "agent_weight", + "is_ascending", + "is_case_sensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E( - "agent_weight", - "agentWeight", - HuntAgentWeight, - is_complex=True, - is_required=True, - is_array=True, - ), + E("is_ascending", "isAscending", bool, is_required=True), + E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), ) -class ReplacementAlternateUserIdEntryList(OCIType): +class SortByDnActivated(SortCriteria): """ - A list of alternate user ids that that replaces a previously configured list. + The sort criteria specifies the dn activation status as the column for the sort, + whether the sort is ascending or descending, and whether the sort is case sensitive. - By convention, an element of this type may be set nill to clear the list. Attributes: - alternate_user_id (List[alternateUserId]): alternateUserId + is_ascending (bool): isAscending + is_case_sensitive (bool): isCaseSensitive """ __slots__: List[str] = [ - "alternate_user_id", + "is_ascending", + "is_case_sensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E( - "alternate_user_id", - "alternateUserId", - AlternateUserIdEntry, - is_complex=True, - is_required=True, - is_array=True, - ), + E("is_ascending", "isAscending", bool, is_required=True), + E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), ) -class ReplacementCallToNumberList(OCIType): +class SortByDnAvailable(SortCriteria): """ - A list of Call to Numbers that replaces a previously configured list. + The sort criteria specifies the dn availability as the column for the sort, whether + the sort is ascending or descending, and whether the sort is case sensitive. - By convention, an element of this type may be set nill to clear the list. For the - callToNumbers, the extension element is not used and the number element is only used - when the type is BroadWorks Mobility. Attributes: - call_to_number (List[callToNumber]): callToNumber + is_ascending (bool): isAscending + is_case_sensitive (bool): isCaseSensitive """ __slots__: List[str] = [ - "call_to_number", + "is_ascending", + "is_case_sensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E( - "call_to_number", - "callToNumber", - CallToNumber, - is_complex=True, - is_required=True, - is_array=True, - ), + E("is_ascending", "isAscending", bool, is_required=True), + E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), ) -class ReplacementCommunicationBarringCallMeNowRuleList(OCIType): +class SortByEmailAddress(SortCriteria): """ - A list of Communication Barring CallMeNow Rules that replaces a previously configured - list. + The sort criteria specifies the email as the column for the sort, whether the sort is + ascending or descending, and whether the sort is case sensitive. - By convention, an element of this type may be set nill to clear the list. Attributes: - rule (List[rule]): rule + is_ascending (bool): isAscending + is_case_sensitive (bool): isCaseSensitive """ __slots__: List[str] = [ - "rule", + "is_ascending", + "is_case_sensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E( - "rule", - "rule", - CommunicationBarringCallMeNowRule, - is_complex=True, - is_required=True, - is_array=True, - ), + E("is_ascending", "isAscending", bool, is_required=True), + E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), ) -class ReplacementCommunicationBarringIncomingRuleList(OCIType): +class SortByEnabled(SortCriteria): """ - A list of Communication Barring Incoming Rules that replaces a previously configured - list. + The sort criteria specifies the Broadworks Enabled Flag as the column for the sort, + whether the sort is ascending or descending, and whether the sort is case sensitive. - By convention, an element of this type may be set nill to clear the list. Attributes: - rule (List[rule]): rule + is_ascending (bool): isAscending + is_case_sensitive (bool): isCaseSensitive """ __slots__: List[str] = [ - "rule", + "is_ascending", + "is_case_sensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E( - "rule", - "rule", - CommunicationBarringIncomingRule, - is_complex=True, - is_required=True, - is_array=True, - ), + E("is_ascending", "isAscending", bool, is_required=True), + E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), ) -class ReplacementCommunicationBarringIncomingRuleList19sp1(OCIType): +class SortByEnterpriseCommonPhoneListName(SortCriteria): """ - A list of Communication Barring Incoming Rules that replaces a previously configured - list. + The sort criteria specifies the enterprise common phone list name as the column for + the sort, whether sort is ascending or descending, and whether the sort is case + sensitive. - By convention, an element of this type may be set nill to clear the list. Attributes: - rule (List[rule]): rule + is_ascending (bool): isAscending + is_case_sensitive (bool): isCaseSensitive """ __slots__: List[str] = [ - "rule", + "is_ascending", + "is_case_sensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E( - "rule", - "rule", - CommunicationBarringIncomingRule19sp1, - is_complex=True, - is_required=True, - is_array=True, - ), + E("is_ascending", "isAscending", bool, is_required=True), + E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), ) -class ReplacementCommunicationBarringOriginatingRuleList(OCIType): +class SortByEnterpriseCommonPhoneListNumber(SortCriteria): """ - A list of Communication Barring Originating Rules that replaces a previously - configured list. + The sort criteria specifies the enterprise common phone list number as as the column + for the sort, whether sort is ascending or descending, and whether the sort is case + sensitive. - By convention, an element of this type may be set nill to clear the list. Attributes: - rule (List[rule]): rule + is_ascending (bool): isAscending + is_case_sensitive (bool): isCaseSensitive """ __slots__: List[str] = [ - "rule", + "is_ascending", + "is_case_sensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E( - "rule", - "rule", - CommunicationBarringOriginatingRule, - is_complex=True, - is_required=True, - is_array=True, - ), + E("is_ascending", "isAscending", bool, is_required=True), + E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), ) -class ReplacementCommunicationBarringRedirectingRuleList(OCIType): +class SortByExtension(SortCriteria): """ - A list of Communication Barring Redirecting Rules that replaces a previously - configured list. + The sort criteria specifies the extension as the column for the sort, whether the sort + is ascending or descending, and whether the sort is case sensitive. - By convention, an element of this type may be set nill to clear the list. Attributes: - rule (List[rule]): rule + is_ascending (bool): isAscending + is_case_sensitive (bool): isCaseSensitive """ __slots__: List[str] = [ - "rule", + "is_ascending", + "is_case_sensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: - return ( - E( - "rule", - "rule", - CommunicationBarringRedirectingRule, - is_complex=True, - is_required=True, - is_array=True, - ), + return ( + E("is_ascending", "isAscending", bool, is_required=True), + E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), ) -class ReplacementContactList22(OCIType): +class SortByForwardedToNumber(SortCriteria): """ - A list of SIP contacts that replaces a previously configured list. + The sort criteria specifies the forwarded to phone number as the column for the sort, + whether the sort is ascending or descending, and whether the sort is case sensitive. - By convention, an element of this type may be set nill to clear the list. + This sort criteria data type is only intended to be used by the commands introduced by + BW-2301. The commands are `EnterpriseUserCallForwardingSettingsGetListRequest()` and + `GroupUserCallForwardingSettingsGetListRequest()`. The following Call Forwarding + services are compatible for this search: Call Forwarding Always, Call Forwarding + Always Secondary, Call Forwarding Busy, Call Forwarding No Answer, Call Forwarding Not + Reachable, Call Forwarding Selective. Attributes: - contact (List[contact]): contact + is_ascending (bool): isAscending + is_case_sensitive (bool): isCaseSensitive """ __slots__: List[str] = [ - "contact", + "is_ascending", + "is_case_sensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E( - "contact", - "contact", - SIPContactInfo, - is_complex=True, - is_required=True, - is_array=True, - ), + E("is_ascending", "isAscending", bool, is_required=True), + E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), ) -class ReplacementCustomContactDirectoryEntryList(OCIType): +class SortByGroupCommonPhoneListName(SortCriteria): """ - A list of userIds and/or Virtual On-Net user DNs that replaces a previously configured - list. + The sort criteria specifies the group common phone list name as the column for the + sort, whether the sort is ascending or descending, and whether the sort is case + sensitive. - By convention, an element of this type may be set nill to clear the list. Attributes: - entry (List[entry]): entry + is_ascending (bool): isAscending + is_case_sensitive (bool): isCaseSensitive """ __slots__: List[str] = [ - "entry", + "is_ascending", + "is_case_sensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E( - "entry", - "entry", - CustomContactDirectoryEntry, - is_complex=True, - is_required=True, - is_array=True, - ), + E("is_ascending", "isAscending", bool, is_required=True), + E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), ) -class ReplacementDeviceList(OCIType): +class SortByGroupCommonPhoneListNumber(SortCriteria): """ - A list of devices that replaces a previously configured list. + The sort criteria specifies the group common phone list number as the column for the + sort, whether sort is ascending or descending, and whether the sort is case sensitive. - By convention, an element of this type may be set nill to clear the list. Attributes: - device (List[device]): device + is_ascending (bool): isAscending + is_case_sensitive (bool): isCaseSensitive """ __slots__: List[str] = [ - "device", + "is_ascending", + "is_case_sensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E( - "device", - "device", - AccessDevice, - is_complex=True, - is_required=True, - is_array=True, - ), + E("is_ascending", "isAscending", bool, is_required=True), + E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), ) -class ReplacementEnterpriseEnterpriseTrunkTrunkGroupKeyList(OCIType): +class SortByGroupId(SortCriteria): """ - A list of Enterprise Trunk Krunk Group Keys that replaces a previously configured - list. + The sort criteria specifies the group id as the column for the sort, whether the sort + is ascending or descending, and whether the sort is case sensitive. - By convention, an element of this type may be set nill to clear the list. Attributes: - trunk_group (List[trunkGroup]): trunkGroup + is_ascending (bool): isAscending + is_case_sensitive (bool): isCaseSensitive """ __slots__: List[str] = [ - "trunk_group", + "is_ascending", + "is_case_sensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E( - "trunk_group", - "trunkGroup", - EnterpriseTrunkTrunkGroupKey, - is_complex=True, - is_required=True, - is_array=True, - ), + E("is_ascending", "isAscending", bool, is_required=True), + E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), ) -class ReplacementEnterpriseTrunkTrunkGroupKeyList(OCIType): +class SortByGroupLocationCode(SortCriteria): """ - A list of Enterprise Trunk Krunk Group Keys that replaces a previously configured - list. + The sort criteria specifies the group location code as the column for the sort, + whether the sort is ascending or descending, and whether the sort is case sensitive. - By convention, an element of this type may be set nill to clear the list. Attributes: - trunk_group_list (List[trunkGroupList]): trunkGroupList + is_ascending (bool): isAscending + is_case_sensitive (bool): isCaseSensitive """ __slots__: List[str] = [ - "trunk_group_list", + "is_ascending", + "is_case_sensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E( - "trunk_group_list", - "trunkGroupList", - EnterpriseTrunkTrunkGroupKey, - is_complex=True, - is_required=True, - is_array=True, - ), + E("is_ascending", "isAscending", bool, is_required=True), + E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), ) -class ReplacementGroupEnterpriseTrunkPriorityWeightedTrunkGroupList(OCIType): +class SortByGroupName(SortCriteria): """ - A list of enterprise trunk priority weighted trunk groups in a group that replaces a - previously configured list. + The sort criteria specifies the group name as the column for the sort, whether the + sort is ascending or descending, and whether the sort is case sensitive. - By convention, an element of this type may be set nill to clear the list. Attributes: - trunk_group (List[trunkGroup]): trunkGroup + is_ascending (bool): isAscending + is_case_sensitive (bool): isCaseSensitive """ __slots__: List[str] = [ - "trunk_group", + "is_ascending", + "is_case_sensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E( - "trunk_group", - "trunkGroup", - GroupEnterpriseTrunkPriorityWeightedTrunkGroup, - is_complex=True, - is_required=True, - is_array=True, - ), + E("is_ascending", "isAscending", bool, is_required=True), + E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), ) -class ScheduleEvents(OCIType): +class SortByHuntPolicy(SortCriteria): """ - Retrives all Holiday or Time Event details for a given schedulel Level. + The sort criteria specifies the call center hunt policy as the column for the sort, + whether the sort is ascending or descending, and whether the sort is case sensitive. Attributes: - eventname (str): eventname - start_date (str): startDate - all_day_event (bool): allDayEvent *Optional* - start_time (startTime): startTime *Optional* - end_time (endTime): endTime *Optional* - end_date (str): endDate - recurrence (recurrence): recurrence *Optional* + is_ascending (bool): isAscending + is_case_sensitive (bool): isCaseSensitive """ __slots__: List[str] = [ - "eventname", - "start_date", - "all_day_event", - "start_time", - "end_time", - "end_date", - "recurrence", + "is_ascending", + "is_case_sensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("eventname", "eventname", str, is_required=True), - E("start_date", "startDate", str, is_required=True), - E("all_day_event", "allDayEvent", bool), - E("start_time", "startTime", HourMinute, is_complex=True), - E("end_time", "endTime", HourMinute, is_complex=True), - E("end_date", "endDate", str, is_required=True), - E("recurrence", "recurrence", Recurrence, is_complex=True), + E("is_ascending", "isAscending", bool, is_required=True), + E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), ) -class ScheduleGlobalKey(OCIType): +class SortByImpId(SortCriteria): """ - Uniquely identifies Holiday and Time Schedules throughout all System, Service - Provider, Group and User level. + The sort criteria specifies the imp id as the column for the sort, whether the sort is + ascending or descending, and whether the sort is case sensitive. Attributes: - schedule_key (scheduleKey): scheduleKey - schedule_level (str): scheduleLevel + is_ascending (bool): isAscending + is_case_sensitive (bool): isCaseSensitive """ __slots__: List[str] = [ - "schedule_key", - "schedule_level", + "is_ascending", + "is_case_sensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E( - "schedule_key", - "scheduleKey", - ScheduleKey, - is_complex=True, - is_required=True, - ), - E("schedule_level", "scheduleLevel", str, is_required=True), + E("is_ascending", "isAscending", bool, is_required=True), + E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), ) -class SearchCriteriaComposedOrDnExtension(OCIType): +class SortByLocation(SortCriteria): """ - Criteria for searching for a DN OR an extension. + The sort criteria specifies the Broadworks Location as the column for the sort, + whether the sort is ascending or descending, and whether the sort is case sensitive. - Note: For this search criterion, the searchMode is always ‘Contains’ and the search - criteria are always OR’ed. Attributes: - value (value): value + is_ascending (bool): isAscending + is_case_sensitive (bool): isCaseSensitive """ __slots__: List[str] = [ - "value", + "is_ascending", + "is_case_sensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("value", "value", UserDNExtension, is_complex=True, is_required=True), + E("is_ascending", "isAscending", bool, is_required=True), + E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), ) -class SearchCriteriaExactCallCenterReportTemplateKey(OCIType): +class SortByMobileDirectoryNumber(SortCriteria): """ - Criteria for searching for a particular call center enhanced reporting report - template. + The sort criteria specifies the Mobile dn availability as the column for the sort, + whether the sort is ascending or descending, and whether the sort is case sensitive. Attributes: - report_template (reportTemplate): reportTemplate + is_ascending (bool): isAscending + is_case_sensitive (bool): isCaseSensitive """ __slots__: List[str] = [ - "report_template", + "is_ascending", + "is_case_sensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E( - "report_template", - "reportTemplate", - CallCenterReportTemplateKey, - is_complex=True, - is_required=True, - ), + E("is_ascending", "isAscending", bool, is_required=True), + E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), ) -class SearchCriteriaExactDnDepartment(OCIType): +class SortByMobilePhoneNumber(SortCriteria): """ - Criteria for searching for a particular fully specified DN's department. + The sort criteria specifies the mobile phone number as the column for the sort, + whether the sort is ascending or descending, and whether the sort is case sensitive. Attributes: - department_key (departmentKey): departmentKey + is_ascending (bool): isAscending + is_case_sensitive (bool): isCaseSensitive """ __slots__: List[str] = [ - "department_key", + "is_ascending", + "is_case_sensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E( - "department_key", - "departmentKey", - DepartmentKey, - is_complex=True, - is_required=True, - ), + E("is_ascending", "isAscending", bool, is_required=True), + E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), ) -class SearchCriteriaExactUserDepartment(OCIType): +class SortByReceptionistNote(SortCriteria): """ - Criteria for searching for a particular fully specified user's department. + The sort criteria specifies the Receptionist Notes as the column for the sort, whether + the sort is ascending or descending, and whether the sort is case sensitive. Attributes: - department_key (departmentKey): departmentKey + is_ascending (bool): isAscending + is_case_sensitive (bool): isCaseSensitive """ __slots__: List[str] = [ - "department_key", + "is_ascending", + "is_case_sensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E( - "department_key", - "departmentKey", - DepartmentKey, - is_complex=True, - is_required=True, - ), + E("is_ascending", "isAscending", bool, is_required=True), + E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), ) -class SelectiveCallRejectionCriteriaCallTypeModify(OCIType): +class SortByScheduleName(SortCriteria): """ - The call type criteria used within a modify request. + The sort criteria specifies the schedule name as the column for the sort, whether the + sort is ascending or descending, and whether the sort is case sensitive. Attributes: - from_dn_criteria_selection (str): fromDnCriteriaSelection *Optional* - include_anonymous_callers (bool): includeAnonymousCallers *Optional* - include_unavailable_callers (bool): includeUnavailableCallers *Optional* - phone_number_list (phoneNumberList): phoneNumberList *Optional* + is_ascending (bool): isAscending + is_case_sensitive (bool): isCaseSensitive """ __slots__: List[str] = [ - "from_dn_criteria_selection", - "include_anonymous_callers", - "include_unavailable_callers", - "phone_number_list", + "is_ascending", + "is_case_sensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("from_dn_criteria_selection", "fromDnCriteriaSelection", str), - E("include_anonymous_callers", "includeAnonymousCallers", bool), - E("include_unavailable_callers", "includeUnavailableCallers", bool), - E( - "phone_number_list", - "phoneNumberList", - CriteriaReplacementDNList, - is_complex=True, - ), + E("is_ascending", "isAscending", bool, is_required=True), + E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), ) -class ServiceInstanceAddProfile(OCIType): +class SortByServiceProviderId(SortCriteria): """ - Service Profile Information for group service. + The sort criteria specifies the service provider id as the column for the sort, + whether the sort is ascending or descending, and whether the sort is case sensitive. Attributes: - name (str): name - calling_line_id_last_name (str): callingLineIdLastName - calling_line_id_first_name (str): callingLineIdFirstName - hiragana_last_name (str): hiraganaLastName *Optional* - hiragana_first_name (str): hiraganaFirstName *Optional* - phone_number (str): phoneNumber *Optional* - extension (str): extension *Optional* - password (str): password *Optional* - department (department): department *Optional* - language (str): language *Optional* - time_zone (str): timeZone *Optional* - alias (List[str]): alias *Optional* - public_user_identity (str): publicUserIdentity *Optional* - calling_line_id_phone_number (str): callingLineIdPhoneNumber *Optional* + is_ascending (bool): isAscending + is_case_sensitive (bool): isCaseSensitive """ __slots__: List[str] = [ - "name", - "calling_line_id_last_name", - "calling_line_id_first_name", - "hiragana_last_name", - "hiragana_first_name", - "phone_number", - "extension", - "password", - "department", - "language", - "time_zone", - "alias", - "public_user_identity", - "calling_line_id_phone_number", + "is_ascending", + "is_case_sensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("name", "name", str, is_required=True), - E( - "calling_line_id_last_name", - "callingLineIdLastName", - str, - is_required=True, - ), - E( - "calling_line_id_first_name", - "callingLineIdFirstName", - str, - is_required=True, - ), - E("hiragana_last_name", "hiraganaLastName", str), - E("hiragana_first_name", "hiraganaFirstName", str), - E("phone_number", "phoneNumber", str), - E("extension", "extension", str), - E("password", "password", str), - E("department", "department", DepartmentKey, is_complex=True), - E("language", "language", str), - E("time_zone", "timeZone", str), - E("alias", "alias", str, is_array=True), - E("public_user_identity", "publicUserIdentity", str), - E("calling_line_id_phone_number", "callingLineIdPhoneNumber", str), + E("is_ascending", "isAscending", bool, is_required=True), + E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), ) -class ServiceInstanceAddProfileCallCenter(OCIType): +class SortByServiceProviderName(SortCriteria): """ - Service Profile Information for a call center. + The sort criteria specifies the service provider name as the column for the sort, + whether the sort is ascending or descending, and whether the sort is case sensitive. - Password is required. Attributes: - name (str): name - calling_line_id_last_name (str): callingLineIdLastName - calling_line_id_first_name (str): callingLineIdFirstName - hiragana_last_name (str): hiraganaLastName *Optional* - hiragana_first_name (str): hiraganaFirstName *Optional* - phone_number (str): phoneNumber *Optional* - extension (str): extension *Optional* - password (str): password - department (department): department *Optional* - language (str): language *Optional* - time_zone (str): timeZone *Optional* - alias (List[str]): alias *Optional* - public_user_identity (str): publicUserIdentity *Optional* - calling_line_id_phone_number (str): callingLineIdPhoneNumber *Optional* + is_ascending (bool): isAscending + is_case_sensitive (bool): isCaseSensitive """ __slots__: List[str] = [ - "name", - "calling_line_id_last_name", - "calling_line_id_first_name", - "hiragana_last_name", - "hiragana_first_name", - "phone_number", - "extension", - "password", - "department", - "language", - "time_zone", - "alias", - "public_user_identity", - "calling_line_id_phone_number", + "is_ascending", + "is_case_sensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("name", "name", str, is_required=True), - E( - "calling_line_id_last_name", - "callingLineIdLastName", - str, - is_required=True, - ), - E( - "calling_line_id_first_name", - "callingLineIdFirstName", - str, - is_required=True, - ), - E("hiragana_last_name", "hiraganaLastName", str), - E("hiragana_first_name", "hiraganaFirstName", str), - E("phone_number", "phoneNumber", str), - E("extension", "extension", str), - E("password", "password", str, is_required=True), - E("department", "department", DepartmentKey, is_complex=True), - E("language", "language", str), - E("time_zone", "timeZone", str), - E("alias", "alias", str, is_array=True), - E("public_user_identity", "publicUserIdentity", str), - E("calling_line_id_phone_number", "callingLineIdPhoneNumber", str), + E("is_ascending", "isAscending", bool, is_required=True), + E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), ) -class ServiceInstanceAddProfileFlexibleSeatingHost(OCIType): +class SortByServiceStatus(SortCriteria): """ - Service Profile Information for a flexible seating host. + The sort criteria specifies the service status as the column for the sort, whether the + sort is ascending or descending, and whether the sort is case sensitive. + This sort criteria data type is only intended to be used by the commands introduced by + BW-2301. The commands are `EnterpriseUserCallWaitingSettingsGetListRequest()`, + `GroupUserCallWaitingSettingsGetListRequest()`, + `EnterpriseUserHotelingGuestSettingsGetListRequest()`, and + `GroupUserHotelingGuestSettingsGetListRequest()`. Attributes: - name (str): name - calling_line_id_last_name (str): callingLineIdLastName - calling_line_id_first_name (str): callingLineIdFirstName - hiragana_last_name (str): hiraganaLastName *Optional* - hiragana_first_name (str): hiraganaFirstName *Optional* - phone_number (str): phoneNumber *Optional* - extension (str): extension *Optional* - password (str): password *Optional* - department (department): department *Optional* - language (str): language *Optional* - time_zone (str): timeZone *Optional* - calling_line_id_phone_number (str): callingLineIdPhoneNumber *Optional* + is_ascending (bool): isAscending + is_case_sensitive (bool): isCaseSensitive """ __slots__: List[str] = [ - "name", - "calling_line_id_last_name", - "calling_line_id_first_name", - "hiragana_last_name", - "hiragana_first_name", - "phone_number", - "extension", - "password", - "department", - "language", - "time_zone", - "calling_line_id_phone_number", + "is_ascending", + "is_case_sensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("name", "name", str, is_required=True), - E( - "calling_line_id_last_name", - "callingLineIdLastName", - str, - is_required=True, - ), - E( - "calling_line_id_first_name", - "callingLineIdFirstName", - str, - is_required=True, - ), - E("hiragana_last_name", "hiraganaLastName", str), - E("hiragana_first_name", "hiraganaFirstName", str), - E("phone_number", "phoneNumber", str), - E("extension", "extension", str), - E("password", "password", str), - E("department", "department", DepartmentKey, is_complex=True), - E("language", "language", str), - E("time_zone", "timeZone", str), - E("calling_line_id_phone_number", "callingLineIdPhoneNumber", str), + E("is_ascending", "isAscending", bool, is_required=True), + E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), ) -class ServiceInstanceAddProfileTrunkGroup(OCIType): +class SortByTrunkGroupName(SortCriteria): """ - Service Profile Information for a trunk group. + The sort criteria specifies the trunk group name as the column for the sort, whether + the sort is ascending or descending, and whether the sort is case sensitive. - The publicUserIdentity element is not part of ServiceInstanceAddProfileTrunkGroup. Attributes: - name (str): name - calling_line_id_last_name (str): callingLineIdLastName - calling_line_id_first_name (str): callingLineIdFirstName - hiragana_last_name (str): hiraganaLastName *Optional* - hiragana_first_name (str): hiraganaFirstName *Optional* - phone_number (str): phoneNumber *Optional* - extension (str): extension *Optional* - password (str): password *Optional* - department (department): department *Optional* - language (str): language *Optional* - time_zone (str): timeZone *Optional* - alias (List[str]): alias *Optional* - calling_line_id_phone_number (str): callingLineIdPhoneNumber *Optional* - """ - - __slots__: List[str] = [ - "name", - "calling_line_id_last_name", - "calling_line_id_first_name", - "hiragana_last_name", - "hiragana_first_name", - "phone_number", - "extension", - "password", - "department", - "language", - "time_zone", - "alias", - "calling_line_id_phone_number", + is_ascending (bool): isAscending + is_case_sensitive (bool): isCaseSensitive + """ + + __slots__: List[str] = [ + "is_ascending", + "is_case_sensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("name", "name", str, is_required=True), - E( - "calling_line_id_last_name", - "callingLineIdLastName", - str, - is_required=True, - ), - E( - "calling_line_id_first_name", - "callingLineIdFirstName", - str, - is_required=True, - ), - E("hiragana_last_name", "hiraganaLastName", str), - E("hiragana_first_name", "hiraganaFirstName", str), - E("phone_number", "phoneNumber", str), - E("extension", "extension", str), - E("password", "password", str), - E("department", "department", DepartmentKey, is_complex=True), - E("language", "language", str), - E("time_zone", "timeZone", str), - E("alias", "alias", str, is_array=True), - E("calling_line_id_phone_number", "callingLineIdPhoneNumber", str), + E("is_ascending", "isAscending", bool, is_required=True), + E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), ) -class ServiceInstanceModifyProfile(OCIType): +class SortByUserDepartment(SortCriteria): """ - Service Profile Information for group service used when modifying an existing service - instance. + The sort criteria specifies the user department name as the column for the sort, + whether the sort is ascending or descending, and whether the sort is case sensitive. Attributes: - name (str): name *Optional* - calling_line_id_last_name (str): callingLineIdLastName *Optional* - calling_line_id_first_name (str): callingLineIdFirstName *Optional* - hiragana_last_name (str): hiraganaLastName *Optional* - hiragana_first_name (str): hiraganaFirstName *Optional* - phone_number (str): phoneNumber *Optional* - extension (str): extension *Optional* - password (str): password *Optional* - department (department): department *Optional* - language (str): language *Optional* - time_zone (str): timeZone *Optional* - sip_alias_list (sipAliasList): sipAliasList *Optional* - public_user_identity (str): publicUserIdentity *Optional* - calling_line_id_phone_number (str): callingLineIdPhoneNumber *Optional* + is_ascending (bool): isAscending + is_case_sensitive (bool): isCaseSensitive """ __slots__: List[str] = [ - "name", - "calling_line_id_last_name", - "calling_line_id_first_name", - "hiragana_last_name", - "hiragana_first_name", - "phone_number", - "extension", - "password", - "department", - "language", - "time_zone", - "sip_alias_list", - "public_user_identity", - "calling_line_id_phone_number", + "is_ascending", + "is_case_sensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("name", "name", str), - E("calling_line_id_last_name", "callingLineIdLastName", str), - E("calling_line_id_first_name", "callingLineIdFirstName", str), - E("hiragana_last_name", "hiraganaLastName", str), - E("hiragana_first_name", "hiraganaFirstName", str), - E("phone_number", "phoneNumber", str), - E("extension", "extension", str), - E("password", "password", str), - E("department", "department", DepartmentKey, is_complex=True), - E("language", "language", str), - E("time_zone", "timeZone", str), - E( - "sip_alias_list", - "sipAliasList", - ReplacementSIPAliasList, - is_complex=True, - ), - E("public_user_identity", "publicUserIdentity", str), - E("calling_line_id_phone_number", "callingLineIdPhoneNumber", str), + E("is_ascending", "isAscending", bool, is_required=True), + E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), ) -class ServiceInstanceModifyProfileFlexibleSeatingHost(OCIType): +class SortByUserFirstName(SortCriteria): """ - Service Profile Information for a flexible seating host + The sort criteria specifies the user first name as the column for the sort, whether + the sort is ascending or descending, and whether the sort is case sensitive. + Attributes: - name (str): name *Optional* - calling_line_id_last_name (str): callingLineIdLastName *Optional* - calling_line_id_first_name (str): callingLineIdFirstName *Optional* - hiragana_last_name (str): hiraganaLastName *Optional* - hiragana_first_name (str): hiraganaFirstName *Optional* - phone_number (str): phoneNumber *Optional* - extension (str): extension *Optional* - password (str): password *Optional* - department (department): department *Optional* - language (str): language *Optional* - time_zone (str): timeZone *Optional* - calling_line_id_phone_number (str): callingLineIdPhoneNumber *Optional* + is_ascending (bool): isAscending + is_case_sensitive (bool): isCaseSensitive """ __slots__: List[str] = [ - "name", - "calling_line_id_last_name", - "calling_line_id_first_name", - "hiragana_last_name", - "hiragana_first_name", - "phone_number", - "extension", - "password", - "department", - "language", - "time_zone", - "calling_line_id_phone_number", + "is_ascending", + "is_case_sensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("name", "name", str), - E("calling_line_id_last_name", "callingLineIdLastName", str), - E("calling_line_id_first_name", "callingLineIdFirstName", str), - E("hiragana_last_name", "hiraganaLastName", str), - E("hiragana_first_name", "hiraganaFirstName", str), - E("phone_number", "phoneNumber", str), - E("extension", "extension", str), - E("password", "password", str), - E("department", "department", DepartmentKey, is_complex=True), - E("language", "language", str), - E("time_zone", "timeZone", str), - E("calling_line_id_phone_number", "callingLineIdPhoneNumber", str), + E("is_ascending", "isAscending", bool, is_required=True), + E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), ) -class ServiceInstanceModifyProfileTrunkGroup(OCIType): +class SortByUserId(SortCriteria): """ - Service Profile Information for a trunk group used when modifying an existing service - instance. + The sort criteria specifies the user id as the column for the sort, whether the sort + is ascending or descending, and whether the sort is case sensitive. Attributes: - name (str): name *Optional* - calling_line_id_last_name (str): callingLineIdLastName *Optional* - calling_line_id_first_name (str): callingLineIdFirstName *Optional* - hiragana_last_name (str): hiraganaLastName *Optional* - hiragana_first_name (str): hiraganaFirstName *Optional* - phone_number (str): phoneNumber *Optional* - extension (str): extension *Optional* - password (str): password *Optional* - department (department): department *Optional* - language (str): language *Optional* - time_zone (str): timeZone *Optional* - sip_alias_list (sipAliasList): sipAliasList *Optional* + is_ascending (bool): isAscending + is_case_sensitive (bool): isCaseSensitive """ __slots__: List[str] = [ - "name", - "calling_line_id_last_name", - "calling_line_id_first_name", - "hiragana_last_name", - "hiragana_first_name", - "phone_number", - "extension", - "password", - "department", - "language", - "time_zone", - "sip_alias_list", + "is_ascending", + "is_case_sensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("name", "name", str), - E("calling_line_id_last_name", "callingLineIdLastName", str), - E("calling_line_id_first_name", "callingLineIdFirstName", str), - E("hiragana_last_name", "hiraganaLastName", str), - E("hiragana_first_name", "hiraganaFirstName", str), - E("phone_number", "phoneNumber", str), - E("extension", "extension", str), - E("password", "password", str), - E("department", "department", DepartmentKey, is_complex=True), - E("language", "language", str), - E("time_zone", "timeZone", str), - E( - "sip_alias_list", - "sipAliasList", - ReplacementSIPAliasList, - is_complex=True, - ), + E("is_ascending", "isAscending", bool, is_required=True), + E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), ) -class ServiceInstanceReadProfile(OCIType): +class SortByUserLastName(SortCriteria): """ - Service Profile Information for group service. + The sort criteria specifies the user last name as the column for the sort, whether the + sort is ascending or descending, and whether the sort is case sensitive. - It is identical to the ServiceInstanceAddProfile, but without the password. Prior to - release 14 this was called ServiceInstanceProfile. Attributes: - name (str): name - calling_line_id_last_name (str): callingLineIdLastName - calling_line_id_first_name (str): callingLineIdFirstName - hiragana_last_name (str): hiraganaLastName *Optional* - hiragana_first_name (str): hiraganaFirstName *Optional* - phone_number (str): phoneNumber *Optional* - extension (str): extension *Optional* - department (department): department *Optional* - language (str): language *Optional* - time_zone (str): timeZone *Optional* - time_zone_display_name (str): timeZoneDisplayName *Optional* - alias (List[str]): alias *Optional* - public_user_identity (str): publicUserIdentity *Optional* + is_ascending (bool): isAscending + is_case_sensitive (bool): isCaseSensitive """ __slots__: List[str] = [ - "name", - "calling_line_id_last_name", - "calling_line_id_first_name", - "hiragana_last_name", - "hiragana_first_name", - "phone_number", - "extension", - "department", - "language", - "time_zone", - "time_zone_display_name", - "alias", - "public_user_identity", + "is_ascending", + "is_case_sensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("name", "name", str, is_required=True), - E( - "calling_line_id_last_name", - "callingLineIdLastName", - str, - is_required=True, - ), - E( - "calling_line_id_first_name", - "callingLineIdFirstName", - str, - is_required=True, - ), - E("hiragana_last_name", "hiraganaLastName", str), - E("hiragana_first_name", "hiraganaFirstName", str), - E("phone_number", "phoneNumber", str), - E("extension", "extension", str), - E("department", "department", DepartmentKey, is_complex=True), - E("language", "language", str), - E("time_zone", "timeZone", str), - E("time_zone_display_name", "timeZoneDisplayName", str), - E("alias", "alias", str, is_array=True), - E("public_user_identity", "publicUserIdentity", str), + E("is_ascending", "isAscending", bool, is_required=True), + E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), ) -class ServiceInstanceReadProfile17(OCIType): +class SortByUserPersonalPhoneListName(SortCriteria): """ - Service Profile Information for group service. + The sort criteria specifies the user personal phone list name as the column for the + sort, whether sort is ascending or descending, and whether the sort is case sensitive. - It is identical to the ServiceInstanceAddProfile, but without the password. Replaced - by: ServiceInstanceReadProfile17sp4 Attributes: - name (str): name - calling_line_id_last_name (str): callingLineIdLastName - calling_line_id_first_name (str): callingLineIdFirstName - hiragana_last_name (str): hiraganaLastName *Optional* - hiragana_first_name (str): hiraganaFirstName *Optional* - phone_number (str): phoneNumber *Optional* - extension (str): extension *Optional* - department (department): department *Optional* - language (str): language *Optional* - time_zone (str): timeZone *Optional* - time_zone_display_name (str): timeZoneDisplayName *Optional* - alias (List[str]): alias *Optional* - public_user_identity (str): publicUserIdentity *Optional* + is_ascending (bool): isAscending + is_case_sensitive (bool): isCaseSensitive """ __slots__: List[str] = [ - "name", - "calling_line_id_last_name", - "calling_line_id_first_name", - "hiragana_last_name", - "hiragana_first_name", - "phone_number", - "extension", - "department", - "language", - "time_zone", - "time_zone_display_name", - "alias", - "public_user_identity", + "is_ascending", + "is_case_sensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("name", "name", str, is_required=True), - E( - "calling_line_id_last_name", - "callingLineIdLastName", - str, - is_required=True, - ), - E( - "calling_line_id_first_name", - "callingLineIdFirstName", - str, - is_required=True, - ), - E("hiragana_last_name", "hiraganaLastName", str), - E("hiragana_first_name", "hiraganaFirstName", str), - E("phone_number", "phoneNumber", str), - E("extension", "extension", str), - E("department", "department", DepartmentKey, is_complex=True), - E("language", "language", str), - E("time_zone", "timeZone", str), - E("time_zone_display_name", "timeZoneDisplayName", str), - E("alias", "alias", str, is_array=True), - E("public_user_identity", "publicUserIdentity", str), + E("is_ascending", "isAscending", bool, is_required=True), + E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), ) -class ServiceInstanceReadProfile17sp4(OCIType): +class SortByUserPersonalPhoneListNumber(SortCriteria): """ - Service Profile Information for group service. + The sort criteria specifies the user personal phone list number as the column for the + sort, whether the sort is ascending or descending, and whether the sort is case + sensitive. - Replaced by: ServiceInstanceReadProfile19sp1 Attributes: - name (str): name - calling_line_id_last_name (str): callingLineIdLastName - calling_line_id_first_name (str): callingLineIdFirstName - hiragana_last_name (str): hiraganaLastName *Optional* - hiragana_first_name (str): hiraganaFirstName *Optional* - phone_number (str): phoneNumber *Optional* - extension (str): extension *Optional* - country_code (str): countryCode *Optional* - national_prefix (str): nationalPrefix *Optional* - department (department): department *Optional* - language (str): language *Optional* - time_zone (str): timeZone *Optional* - time_zone_display_name (str): timeZoneDisplayName *Optional* - alias (List[str]): alias *Optional* - public_user_identity (str): publicUserIdentity *Optional* + is_ascending (bool): isAscending + is_case_sensitive (bool): isCaseSensitive """ __slots__: List[str] = [ - "name", - "calling_line_id_last_name", - "calling_line_id_first_name", - "hiragana_last_name", - "hiragana_first_name", - "phone_number", - "extension", - "country_code", - "national_prefix", - "department", - "language", - "time_zone", - "time_zone_display_name", - "alias", - "public_user_identity", + "is_ascending", + "is_case_sensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("name", "name", str, is_required=True), - E( - "calling_line_id_last_name", - "callingLineIdLastName", - str, - is_required=True, - ), - E( - "calling_line_id_first_name", - "callingLineIdFirstName", - str, - is_required=True, - ), - E("hiragana_last_name", "hiraganaLastName", str), - E("hiragana_first_name", "hiraganaFirstName", str), - E("phone_number", "phoneNumber", str), - E("extension", "extension", str), - E("country_code", "countryCode", str), - E("national_prefix", "nationalPrefix", str), - E("department", "department", DepartmentKey, is_complex=True), - E("language", "language", str), - E("time_zone", "timeZone", str), - E("time_zone_display_name", "timeZoneDisplayName", str), - E("alias", "alias", str, is_array=True), - E("public_user_identity", "publicUserIdentity", str), + E("is_ascending", "isAscending", bool, is_required=True), + E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), ) -class ServiceInstanceReadProfile19sp1(OCIType): +class SortByYahooId(SortCriteria): """ - Service Profile Information for group service. + The sort criteria specifies the yahoo id as the column for the sort, whether the sort + is ascending or descending, and whether the sort is case sensitive. - The callingLineIdPhoneNumber is no longer being formatted for display purpose. The - value is returned exactly the same as being stored. Attributes: - name (str): name - calling_line_id_last_name (str): callingLineIdLastName - calling_line_id_first_name (str): callingLineIdFirstName - hiragana_last_name (str): hiraganaLastName *Optional* - hiragana_first_name (str): hiraganaFirstName *Optional* - phone_number (str): phoneNumber *Optional* - extension (str): extension *Optional* - country_code (str): countryCode *Optional* - national_prefix (str): nationalPrefix *Optional* - department (department): department *Optional* - language (str): language *Optional* - time_zone (str): timeZone *Optional* - time_zone_display_name (str): timeZoneDisplayName *Optional* - alias (List[str]): alias *Optional* - public_user_identity (str): publicUserIdentity *Optional* - calling_line_id_phone_number (str): callingLineIdPhoneNumber *Optional* + is_ascending (bool): isAscending + is_case_sensitive (bool): isCaseSensitive """ __slots__: List[str] = [ - "name", - "calling_line_id_last_name", - "calling_line_id_first_name", - "hiragana_last_name", - "hiragana_first_name", - "phone_number", - "extension", - "country_code", - "national_prefix", - "department", - "language", - "time_zone", - "time_zone_display_name", - "alias", - "public_user_identity", - "calling_line_id_phone_number", + "is_ascending", + "is_case_sensitive", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("name", "name", str, is_required=True), - E( - "calling_line_id_last_name", - "callingLineIdLastName", - str, - is_required=True, - ), - E( - "calling_line_id_first_name", - "callingLineIdFirstName", - str, - is_required=True, - ), - E("hiragana_last_name", "hiraganaLastName", str), - E("hiragana_first_name", "hiraganaFirstName", str), - E("phone_number", "phoneNumber", str), - E("extension", "extension", str), - E("country_code", "countryCode", str), - E("national_prefix", "nationalPrefix", str), - E("department", "department", DepartmentKey, is_complex=True), - E("language", "language", str), - E("time_zone", "timeZone", str), - E("time_zone_display_name", "timeZoneDisplayName", str), - E("alias", "alias", str, is_array=True), - E("public_user_identity", "publicUserIdentity", str), - E("calling_line_id_phone_number", "callingLineIdPhoneNumber", str), + E("is_ascending", "isAscending", bool, is_required=True), + E("is_case_sensitive", "isCaseSensitive", bool, is_required=True), ) -class ServicePack(OCIType): +class SystemCollaborateGetResponse20sp1V2(OCIType): """ - The common Service Pack elements. + Response to SystemCollaborateGetRequest20sp1V2. Attributes: - service_pack_name (str): servicePackName - service_pack_description (str): servicePackDescription *Optional* - is_available_for_use (bool): isAvailableForUse - service_pack_quantity (servicePackQuantity): servicePackQuantity - service_name (List[str]): serviceName *Optional* + collaborate_room_id_length (int): collaborateRoomIdLength + instant_room_idle_timeout_seconds (int): instantRoomIdleTimeoutSeconds + collaborate_room_maximum_duration_minutes (int): + collaborateRoomMaximumDurationMinutes + support_outdial (bool): supportOutdial + max_collaborate_room_participants (int): maxCollaborateRoomParticipants + collaborate_active_talker_refresh_interval_seconds (int): + collaborateActiveTalkerRefreshIntervalSeconds + terminate_collaborate_after_grace_period (bool): + terminateCollaborateAfterGracePeriod + collaborate_grace_period (collaborateGracePeriod): collaborateGracePeriod + enable_active_collaborate_notification (bool): enableActiveCollaborateNotification + collaborate_from_address (str): collaborateFromAddress *Optional* """ __slots__: List[str] = [ - "service_pack_name", - "service_pack_description", - "is_available_for_use", - "service_pack_quantity", - "service_name", + "collaborate_room_id_length", + "instant_room_idle_timeout_seconds", + "collaborate_room_maximum_duration_minutes", + "support_outdial", + "max_collaborate_room_participants", + "collaborate_active_talker_refresh_interval_seconds", + "terminate_collaborate_after_grace_period", + "collaborate_grace_period", + "enable_active_collaborate_notification", + "collaborate_from_address", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("service_pack_name", "servicePackName", str, is_required=True), - E("service_pack_description", "servicePackDescription", str), - E("is_available_for_use", "isAvailableForUse", bool, is_required=True), E( - "service_pack_quantity", - "servicePackQuantity", - UnboundedPositiveInt, + "collaborate_room_id_length", + "collaborateRoomIdLength", + int, + is_required=True, + ), + E( + "instant_room_idle_timeout_seconds", + "instantRoomIdleTimeoutSeconds", + int, + is_required=True, + ), + E( + "collaborate_room_maximum_duration_minutes", + "collaborateRoomMaximumDurationMinutes", + int, + is_required=True, + ), + E("support_outdial", "supportOutdial", bool, is_required=True), + E( + "max_collaborate_room_participants", + "maxCollaborateRoomParticipants", + int, + is_required=True, + ), + E( + "collaborate_active_talker_refresh_interval_seconds", + "collaborateActiveTalkerRefreshIntervalSeconds", + int, + is_required=True, + ), + E( + "terminate_collaborate_after_grace_period", + "terminateCollaborateAfterGracePeriod", + bool, + is_required=True, + ), + E( + "collaborate_grace_period", + "collaborateGracePeriod", + CollaborateGracePeriodDuration, is_complex=True, is_required=True, ), - E("service_name", "serviceName", str, is_array=True), + E( + "enable_active_collaborate_notification", + "enableActiveCollaborateNotification", + bool, + is_required=True, + ), + E("collaborate_from_address", "collaborateFromAddress", str), ) -class ServicePackAuthorization(OCIType): +class SystemCollaborateModifyRequest20sp1V2(OCIType): """ - Authorize (with quantity) or unauthorize a service pack. + Modify the system level data associated with collaborate services. + The response is either a `SuccessResponse()` or an `ErrorResponse()`. Attributes: - service_pack_name (str): servicePackName - authorized_quantity (authorizedQuantity): authorizedQuantity *Optional* - unauthorized (bool): unauthorized *Optional* + collaborate_room_id_length (int): collaborateRoomIdLength *Optional* + instant_room_idle_timeout_seconds (int): instantRoomIdleTimeoutSeconds *Optional* + collaborate_room_maximum_duration_minutes (int): + collaborateRoomMaximumDurationMinutes *Optional* + support_outdial (bool): supportOutdial *Optional* + max_collaborate_room_participants (int): maxCollaborateRoomParticipants *Optional* + collaborate_active_talker_refresh_interval_seconds (int): + collaborateActiveTalkerRefreshIntervalSeconds *Optional* + terminate_collaborate_after_grace_period (bool): + terminateCollaborateAfterGracePeriod *Optional* + collaborate_grace_period (collaborateGracePeriod): collaborateGracePeriod + *Optional* + enable_active_collaborate_notification (bool): enableActiveCollaborateNotification + *Optional* + collaborate_from_address (str): collaborateFromAddress *Optional* """ __slots__: List[str] = [ - "service_pack_name", - "authorized_quantity", - "unauthorized", + "collaborate_room_id_length", + "instant_room_idle_timeout_seconds", + "collaborate_room_maximum_duration_minutes", + "support_outdial", + "max_collaborate_room_participants", + "collaborate_active_talker_refresh_interval_seconds", + "terminate_collaborate_after_grace_period", + "collaborate_grace_period", + "enable_active_collaborate_notification", + "collaborate_from_address", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("service_pack_name", "servicePackName", str, is_required=True), + E("collaborate_room_id_length", "collaborateRoomIdLength", int), E( - "authorized_quantity", - "authorizedQuantity", - UnboundedPositiveInt, + "instant_room_idle_timeout_seconds", + "instantRoomIdleTimeoutSeconds", + int, + ), + E( + "collaborate_room_maximum_duration_minutes", + "collaborateRoomMaximumDurationMinutes", + int, + ), + E("support_outdial", "supportOutdial", bool), + E( + "max_collaborate_room_participants", + "maxCollaborateRoomParticipants", + int, + ), + E( + "collaborate_active_talker_refresh_interval_seconds", + "collaborateActiveTalkerRefreshIntervalSeconds", + int, + ), + E( + "terminate_collaborate_after_grace_period", + "terminateCollaborateAfterGracePeriod", + bool, + ), + E( + "collaborate_grace_period", + "collaborateGracePeriod", + CollaborateGracePeriodDuration, is_complex=True, ), - E("unauthorized", "unauthorized", bool), + E( + "enable_active_collaborate_notification", + "enableActiveCollaborateNotification", + bool, + ), + E("collaborate_from_address", "collaborateFromAddress", str), ) -class ServiceProviderCommunicationBarringProfileGetResponse19sp1V2(OCIType): +class SystemCommunicationBarringProfileGetResponse19sp1V2(OCIType): """ - Response to the ServiceProviderCommunicationBarringProfileGetRequest19sp1V2. + Response to the SystemCommunicationBarringProfileGetRequest19sp1V2. - The response contains the Communication Barring Profile information. The incoming, - originating, redirecting and call me now rules are returned in ascending priority - order. The following elements are only used in AS data mode: callMeNowDefaultAction - callMeNowDefaultCallTimeout callMeNowRule applyToAttendedCallTransfers + The response contains the Communication Barring Profile information. The incoming + rules are returned in ascending priority order. The following elements are only used + in AS data mode: callMeNowDefaultAction callMeNowDefaultCallTimeout callMeNowRule + applyToAttendedCallTransfers Attributes: description (str): description *Optional* @@ -30193,13 +30277,12 @@ class ServiceProviderCommunicationBarringProfileGetResponse19sp1V2(OCIType): redirecting_default_action (str): redirectingDefaultAction redirecting_default_call_timeout (int): redirectingDefaultCallTimeout *Optional* redirecting_rule (List[redirectingRule]): redirectingRule *Optional* - call_me_now_default_action (str): callMeNowDefaultAction - call_me_now_default_call_timeout (int): callMeNowDefaultCallTimeout *Optional* - call_me_now_rule (List[callMeNowRule]): callMeNowRule *Optional* incoming_default_action (str): incomingDefaultAction incoming_default_call_timeout (int): incomingDefaultCallTimeout *Optional* incoming_rule (List[incomingRule]): incomingRule *Optional* - is_default (bool): isDefault + call_me_now_default_action (str): callMeNowDefaultAction + call_me_now_default_call_timeout (int): callMeNowDefaultCallTimeout *Optional* + call_me_now_rule (List[callMeNowRule]): callMeNowRule *Optional* apply_to_attended_call_transfers (bool): applyToAttendedCallTransfers """ @@ -30213,13 +30296,12 @@ class ServiceProviderCommunicationBarringProfileGetResponse19sp1V2(OCIType): "redirecting_default_action", "redirecting_default_call_timeout", "redirecting_rule", - "call_me_now_default_action", - "call_me_now_default_call_timeout", - "call_me_now_rule", "incoming_default_action", "incoming_default_call_timeout", "incoming_rule", - "is_default", + "call_me_now_default_action", + "call_me_now_default_call_timeout", + "call_me_now_rule", "apply_to_attended_call_transfers", ] @@ -30243,7 +30325,7 @@ def _elements(cls) -> Tuple[E, ...]: E( "originating_rule", "originatingRule", - ServiceProviderCommunicationBarringHierarchicalOriginatingRule, + CommunicationBarringOriginatingRule, is_complex=True, is_array=True, ), @@ -30257,21 +30339,7 @@ def _elements(cls) -> Tuple[E, ...]: E( "redirecting_rule", "redirectingRule", - ServiceProviderCommunicationBarringHierarchicalRedirectingRule, - is_complex=True, - is_array=True, - ), - E( - "call_me_now_default_action", - "callMeNowDefaultAction", - str, - is_required=True, - ), - E("call_me_now_default_call_timeout", "callMeNowDefaultCallTimeout", int), - E( - "call_me_now_rule", - "callMeNowRule", - ServiceProviderCommunicationBarringHierarchicalCallMeNowRule, + CommunicationBarringRedirectingRule, is_complex=True, is_array=True, ), @@ -30289,5584 +30357,5520 @@ def _elements(cls) -> Tuple[E, ...]: is_complex=True, is_array=True, ), - E("is_default", "isDefault", bool, is_required=True), - E( - "apply_to_attended_call_transfers", - "applyToAttendedCallTransfers", - bool, - is_required=True, - ), - ) - - -class ServiceProviderReplacementCommunicationBarringHierarchicalCallMeNowRuleList( - OCIType, -): - """ - A list of Service Provider Communication Barring Hierarchical Call Me Now Rules that - replaces a previously configured list. - - By convention, an element of this type may be set nill to clear the list. - - Attributes: - rule (List[rule]): rule - """ - - __slots__: List[str] = [ - "rule", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E( - "rule", - "rule", - ServiceProviderCommunicationBarringHierarchicalCallMeNowRule, - is_complex=True, - is_required=True, - is_array=True, - ), - ) - - -class ServiceProviderReplacementCommunicationBarringHierarchicalOriginatingRuleList( - OCIType, -): - """ - A list of Service Provider Communication Barring Hierarchical Originating Rules that - replaces a previously configured list. - - By convention, an element of this type may be set nill to clear the list. - - Attributes: - rule (List[rule]): rule - """ - - __slots__: List[str] = [ - "rule", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( E( - "rule", - "rule", - ServiceProviderCommunicationBarringHierarchicalOriginatingRule, - is_complex=True, + "call_me_now_default_action", + "callMeNowDefaultAction", + str, is_required=True, - is_array=True, ), - ) - - -class ServiceProviderReplacementCommunicationBarringHierarchicalRedirectingRuleList( - OCIType, -): - """ - A list of Service Provider Communication Barring Hierarchical Redirecting Rules that - replaces a previously configured list. - - By convention, an element of this type may be set nill to clear the list. - - Attributes: - rule (List[rule]): rule - """ - - __slots__: List[str] = [ - "rule", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( + E("call_me_now_default_call_timeout", "callMeNowDefaultCallTimeout", int), E( - "rule", - "rule", - ServiceProviderCommunicationBarringHierarchicalRedirectingRule, + "call_me_now_rule", + "callMeNowRule", + CommunicationBarringCallMeNowRule, is_complex=True, - is_required=True, is_array=True, ), - ) - - -class ShInterfaceUserIdDataEntry(OCIType): - """ - ShInterface User Id Data Entry. - - - Attributes: - user_type (str): userType - public_user_identity (publicUserIdentity): publicUserIdentity - endpoint_type (str): endpointType - scscf_name (str): SCSCFName *Optional* - ims_user_state (str): IMSUserState - """ - - __slots__: List[str] = [ - "user_type", - "public_user_identity", - "endpoint_type", - "scscf_name", - "ims_user_state", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("user_type", "userType", str, is_required=True), - E( - "public_user_identity", - "publicUserIdentity", - PublicUserIdentity, - is_complex=True, - is_required=True, - ), - E("endpoint_type", "endpointType", str, is_required=True), - E("scscf_name", "SCSCFName", str), - E("ims_user_state", "IMSUserState", str, is_required=True), - ) - - -class ShInterfaceUserIdDataEntry21sp1(OCIType): - """ - ShInterface User Id Data Entry. - - - Attributes: - user_type (str): userType - public_user_identity (publicUserIdentity): publicUserIdentity - endpoint_type (str): endpointType - scscf_name (str): SCSCFName *Optional* - ims_user_state (str): IMSUserState - """ - - __slots__: List[str] = [ - "user_type", - "public_user_identity", - "endpoint_type", - "scscf_name", - "ims_user_state", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("user_type", "userType", str, is_required=True), - E( - "public_user_identity", - "publicUserIdentity", - PublicUserIdentity, - is_complex=True, - is_required=True, - ), - E("endpoint_type", "endpointType", str, is_required=True), - E("scscf_name", "SCSCFName", str), - E("ims_user_state", "IMSUserState", str, is_required=True), - ) - - -class ShInterfaceUserListEntry(OCIType): - """ - ShInterface User List Entry. - - - Attributes: - user_id (str): userId - user_type (str): userType - public_user_identity (publicUserIdentity): publicUserIdentity - endpoint_type (str): endpointType - scscf_name (str): SCSCFName *Optional* - ims_user_state (str): IMSUserState - """ - - __slots__: List[str] = [ - "user_id", - "user_type", - "public_user_identity", - "endpoint_type", - "scscf_name", - "ims_user_state", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("user_id", "userId", str, is_required=True), - E("user_type", "userType", str, is_required=True), E( - "public_user_identity", - "publicUserIdentity", - PublicUserIdentity, - is_complex=True, + "apply_to_attended_call_transfers", + "applyToAttendedCallTransfers", + bool, is_required=True, ), - E("endpoint_type", "endpointType", str, is_required=True), - E("scscf_name", "SCSCFName", str), - E("ims_user_state", "IMSUserState", str, is_required=True), ) -class ShInterfaceUserListEntry21sp1(OCIType): +class TreeDeviceInfo(OCIType): """ - ShInterface User List Entry. + Information related to a tree device. + A tree device is a device associated with a device type that has the option + supportLinks set to "Support Links from Devices". Many leaf devices can link to it. + When a tree device is created, it is assigned a system-wide unique linkId. Attributes: - user_id (str): userId - user_type (str): userType - public_user_identity (publicUserIdentity): publicUserIdentity - endpoint_type (str): endpointType - scscf_name (str): SCSCFName *Optional* - ims_user_state (str): IMSUserState + tree_device_key (treeDeviceKey): treeDeviceKey + link_id (str): linkId """ __slots__: List[str] = [ - "user_id", - "user_type", - "public_user_identity", - "endpoint_type", - "scscf_name", - "ims_user_state", + "tree_device_key", + "link_id", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("user_id", "userId", str, is_required=True), - E("user_type", "userType", str, is_required=True), E( - "public_user_identity", - "publicUserIdentity", - PublicUserIdentity, + "tree_device_key", + "treeDeviceKey", + AccessDeviceKey, is_complex=True, is_required=True, ), - E("endpoint_type", "endpointType", str, is_required=True), - E("scscf_name", "SCSCFName", str), - E("ims_user_state", "IMSUserState", str, is_required=True), + E("link_id", "linkId", str, is_required=True), ) -class SimultaneousRingReplacementNumberList(OCIType): +class TrunkAddressingAdd(OCIType): """ - A list of Simultaneous Ring numbers that replaces a previously configured list. + Trunk group endpoint. - By convention, an element of this type may be set nill to clear the list. Attributes: - simultaneous_ring_number (List[simultaneousRingNumber]): simultaneousRingNumber + trunk_group_device_endpoint (trunkGroupDeviceEndpoint): trunkGroupDeviceEndpoint + *Optional* + enterprise_trunk_name (str): enterpriseTrunkName *Optional* + alternate_trunk_identity (str): alternateTrunkIdentity *Optional* """ __slots__: List[str] = [ - "simultaneous_ring_number", + "trunk_group_device_endpoint", + "enterprise_trunk_name", + "alternate_trunk_identity", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( E( - "simultaneous_ring_number", - "simultaneousRingNumber", - SimultaneousRingNumber, + "trunk_group_device_endpoint", + "trunkGroupDeviceEndpoint", + TrunkGroupDeviceEndpointAdd, is_complex=True, - is_required=True, - is_array=True, ), + E("enterprise_trunk_name", "enterpriseTrunkName", str), + E("alternate_trunk_identity", "alternateTrunkIdentity", str), ) -class SortOrderEnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAssignmentPagedSortedList( - OCIType, -): +class TrunkAddressingModify(OCIType): """ - Used to sort the - `SortOrderEnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAssignmentPagedSortedListRequest()`. + Trunk group endpoint. Attributes: - sort_by_mobile_directory_number (sortByMobileDirectoryNumber): - sortByMobileDirectoryNumber *Optional* - sort_by_dn (sortByDn): sortByDn *Optional* - sort_by_department_name (sortByDepartmentName): sortByDepartmentName *Optional* - sort_by_user_id (sortByUserId): sortByUserId *Optional* - sort_by_user_first_name (sortByUserFirstName): sortByUserFirstName *Optional* - sort_by_user_last_name (sortByUserLastName): sortByUserLastName *Optional* - sort_by_extension (sortByExtension): sortByExtension *Optional* - sort_by_dn_available (sortByDnAvailable): sortByDnAvailable *Optional* + trunk_group_device_endpoint (trunkGroupDeviceEndpoint): trunkGroupDeviceEndpoint + *Optional* + enterprise_trunk_name (str): enterpriseTrunkName *Optional* + alternate_trunk_identity (str): alternateTrunkIdentity *Optional* """ __slots__: List[str] = [ - "sort_by_mobile_directory_number", - "sort_by_dn", - "sort_by_department_name", - "sort_by_user_id", - "sort_by_user_first_name", - "sort_by_user_last_name", - "sort_by_extension", - "sort_by_dn_available", + "trunk_group_device_endpoint", + "enterprise_trunk_name", + "alternate_trunk_identity", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( E( - "sort_by_mobile_directory_number", - "sortByMobileDirectoryNumber", - SortByMobileDirectoryNumber, - is_complex=True, - ), - E("sort_by_dn", "sortByDn", SortByDn, is_complex=True), - E( - "sort_by_department_name", - "sortByDepartmentName", - SortByDepartmentName, - is_complex=True, - ), - E("sort_by_user_id", "sortByUserId", SortByUserId, is_complex=True), - E( - "sort_by_user_first_name", - "sortByUserFirstName", - SortByUserFirstName, - is_complex=True, - ), - E( - "sort_by_user_last_name", - "sortByUserLastName", - SortByUserLastName, - is_complex=True, - ), - E("sort_by_extension", "sortByExtension", SortByExtension, is_complex=True), - E( - "sort_by_dn_available", - "sortByDnAvailable", - SortByDnAvailable, + "trunk_group_device_endpoint", + "trunkGroupDeviceEndpoint", + TrunkGroupDeviceEndpointModify, is_complex=True, ), + E("enterprise_trunk_name", "enterpriseTrunkName", str), + E("alternate_trunk_identity", "alternateTrunkIdentity", str), ) -class SortOrderEnterpriseCallCenterAgentThresholdProfileGetAvailableAgentPagedSortedList( - OCIType, -): +class TrunkAddressingMultipleContactAdd(OCIType): """ - Used to sort the - `EnterpriseCallCenterAgentThresholdProfileGetAvailableAgentPagedSortedListRequest()` - request. + Trunk group endpoint that can have multiple contacts. + alternateTrunkIdentityDomain is only used in XS mode and the AS when deployed in IMS + mode. Both alternateTrunkIdentity and AlternateTrunkIdentityDomain should be set at + the same time if one is set in XS mode. The following elements are only used in AS + data mode and are ignored in XS data mode: physicalLocation Attributes: - sort_by_user_id (sortByUserId): sortByUserId *Optional* - sort_by_user_last_name (sortByUserLastName): sortByUserLastName *Optional* - sort_by_user_first_name (sortByUserFirstName): sortByUserFirstName *Optional* - sort_by_dn (sortByDn): sortByDn *Optional* - sort_by_extension (sortByExtension): sortByExtension *Optional* - sort_by_department_name (sortByDepartmentName): sortByDepartmentName *Optional* - sort_by_email_address (sortByEmailAddress): sortByEmailAddress *Optional* - sort_by_agent_threshold_profile (sortByAgentThresholdProfile): - sortByAgentThresholdProfile *Optional* + trunk_group_device_endpoint (trunkGroupDeviceEndpoint): trunkGroupDeviceEndpoint + *Optional* + enterprise_trunk_name (str): enterpriseTrunkName *Optional* + alternate_trunk_identity (str): alternateTrunkIdentity *Optional* + alternate_trunk_identity_domain (str): alternateTrunkIdentityDomain *Optional* + physical_location (str): physicalLocation *Optional* """ __slots__: List[str] = [ - "sort_by_user_id", - "sort_by_user_last_name", - "sort_by_user_first_name", - "sort_by_dn", - "sort_by_extension", - "sort_by_department_name", - "sort_by_email_address", - "sort_by_agent_threshold_profile", + "trunk_group_device_endpoint", + "enterprise_trunk_name", + "alternate_trunk_identity", + "alternate_trunk_identity_domain", + "physical_location", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("sort_by_user_id", "sortByUserId", SortByUserId, is_complex=True), - E( - "sort_by_user_last_name", - "sortByUserLastName", - SortByUserLastName, - is_complex=True, - ), - E( - "sort_by_user_first_name", - "sortByUserFirstName", - SortByUserFirstName, - is_complex=True, - ), - E("sort_by_dn", "sortByDn", SortByDn, is_complex=True), - E("sort_by_extension", "sortByExtension", SortByExtension, is_complex=True), - E( - "sort_by_department_name", - "sortByDepartmentName", - SortByDepartmentName, - is_complex=True, - ), - E( - "sort_by_email_address", - "sortByEmailAddress", - SortByEmailAddress, - is_complex=True, - ), E( - "sort_by_agent_threshold_profile", - "sortByAgentThresholdProfile", - SortByAgentThresholdProfile, + "trunk_group_device_endpoint", + "trunkGroupDeviceEndpoint", + TrunkGroupDeviceMultipleContactEndpointAdd, is_complex=True, ), + E("enterprise_trunk_name", "enterpriseTrunkName", str), + E("alternate_trunk_identity", "alternateTrunkIdentity", str), + E("alternate_trunk_identity_domain", "alternateTrunkIdentityDomain", str), + E("physical_location", "physicalLocation", str), ) -class SortOrderEnterpriseCallCenterAgentThresholdProfileGetPagedSorted(OCIType): +class TrunkAddressingMultipleContactRead(OCIType): """ - Used to sort the `EnterpriseCallCenterAgentThresholdProfileGetPagedSortedRequest()` - request. + Trunk group endpoint that can have multiple contacts. + Replaced by: TrunkAddressingMultipleContactRead21 Attributes: - sort_by_user_id (sortByUserId): sortByUserId *Optional* - sort_by_user_last_name (sortByUserLastName): sortByUserLastName *Optional* - sort_by_user_first_name (sortByUserFirstName): sortByUserFirstName *Optional* - sort_by_dn (sortByDn): sortByDn *Optional* - sort_by_extension (sortByExtension): sortByExtension *Optional* - sort_by_department_name (sortByDepartmentName): sortByDepartmentName *Optional* - sort_by_email_address (sortByEmailAddress): sortByEmailAddress *Optional* + trunk_group_device_endpoint (trunkGroupDeviceEndpoint): trunkGroupDeviceEndpoint + *Optional* + enterprise_trunk_name (str): enterpriseTrunkName *Optional* + alternate_trunk_identity (str): alternateTrunkIdentity *Optional* """ __slots__: List[str] = [ - "sort_by_user_id", - "sort_by_user_last_name", - "sort_by_user_first_name", - "sort_by_dn", - "sort_by_extension", - "sort_by_department_name", - "sort_by_email_address", + "trunk_group_device_endpoint", + "enterprise_trunk_name", + "alternate_trunk_identity", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("sort_by_user_id", "sortByUserId", SortByUserId, is_complex=True), - E( - "sort_by_user_last_name", - "sortByUserLastName", - SortByUserLastName, - is_complex=True, - ), - E( - "sort_by_user_first_name", - "sortByUserFirstName", - SortByUserFirstName, - is_complex=True, - ), - E("sort_by_dn", "sortByDn", SortByDn, is_complex=True), - E("sort_by_extension", "sortByExtension", SortByExtension, is_complex=True), - E( - "sort_by_department_name", - "sortByDepartmentName", - SortByDepartmentName, - is_complex=True, - ), E( - "sort_by_email_address", - "sortByEmailAddress", - SortByEmailAddress, + "trunk_group_device_endpoint", + "trunkGroupDeviceEndpoint", + TrunkGroupDeviceMultipleContactEndpointRead, is_complex=True, ), + E("enterprise_trunk_name", "enterpriseTrunkName", str), + E("alternate_trunk_identity", "alternateTrunkIdentity", str), ) -class SortOrderEnterprisePhoneDirectoryGetPagedSortedList(OCIType): +class TrunkAddressingMultipleContactRead21(OCIType): """ - Used to sort the `EnterprisePhoneDirectoryGetPagedSortedListRequest()` request. + Trunk group endpoint that can have multiple contacts. + alternateTrunkIdentityDomain is only used in XS mode and the AS when deployed in IMS + mode. The following elements are only used in AS data mode and ignored in XS data + mode: alternateTrunkIdentityDomain Attributes: - sort_by_user_last_name (sortByUserLastName): sortByUserLastName *Optional* - sort_by_user_first_name (sortByUserFirstName): sortByUserFirstName *Optional* - sort_by_group_location_code (sortByGroupLocationCode): sortByGroupLocationCode - *Optional* - sort_by_mobile_phone_number (sortByMobilePhoneNumber): sortByMobilePhoneNumber + trunk_group_device_endpoint (trunkGroupDeviceEndpoint): trunkGroupDeviceEndpoint *Optional* - sort_by_email_address (sortByEmailAddress): sortByEmailAddress *Optional* - sort_by_department_name (sortByDepartmentName): sortByDepartmentName *Optional* - sort_by_group_name (sortByGroupName): sortByGroupName *Optional* - sort_by_yahoo_id (sortByYahooId): sortByYahooId *Optional* - sort_by_user_id (sortByUserId): sortByUserId *Optional* - sort_by_imp_id (sortByImpId): sortByImpId *Optional* + enterprise_trunk_name (str): enterpriseTrunkName *Optional* + alternate_trunk_identity (str): alternateTrunkIdentity *Optional* + alternate_trunk_identity_domain (str): alternateTrunkIdentityDomain *Optional* """ __slots__: List[str] = [ - "sort_by_user_last_name", - "sort_by_user_first_name", - "sort_by_group_location_code", - "sort_by_mobile_phone_number", - "sort_by_email_address", - "sort_by_department_name", - "sort_by_group_name", - "sort_by_yahoo_id", - "sort_by_user_id", - "sort_by_imp_id", + "trunk_group_device_endpoint", + "enterprise_trunk_name", + "alternate_trunk_identity", + "alternate_trunk_identity_domain", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( E( - "sort_by_user_last_name", - "sortByUserLastName", - SortByUserLastName, - is_complex=True, - ), - E( - "sort_by_user_first_name", - "sortByUserFirstName", - SortByUserFirstName, - is_complex=True, - ), - E( - "sort_by_group_location_code", - "sortByGroupLocationCode", - SortByGroupLocationCode, - is_complex=True, - ), - E( - "sort_by_mobile_phone_number", - "sortByMobilePhoneNumber", - SortByMobilePhoneNumber, - is_complex=True, - ), - E( - "sort_by_email_address", - "sortByEmailAddress", - SortByEmailAddress, - is_complex=True, - ), - E( - "sort_by_department_name", - "sortByDepartmentName", - SortByDepartmentName, - is_complex=True, - ), - E( - "sort_by_group_name", - "sortByGroupName", - SortByGroupName, + "trunk_group_device_endpoint", + "trunkGroupDeviceEndpoint", + TrunkGroupDeviceMultipleContactEndpointRead, is_complex=True, ), - E("sort_by_yahoo_id", "sortByYahooId", SortByYahooId, is_complex=True), - E("sort_by_user_id", "sortByUserId", SortByUserId, is_complex=True), - E("sort_by_imp_id", "sortByImpId", SortByImpId, is_complex=True), + E("enterprise_trunk_name", "enterpriseTrunkName", str), + E("alternate_trunk_identity", "alternateTrunkIdentity", str), + E("alternate_trunk_identity_domain", "alternateTrunkIdentityDomain", str), ) -class SortOrderGroupAccessDeviceGetPagedSortedList(OCIType): +class TrunkAddressingMultipleContactRead21sp1(OCIType): """ - Used to sort the `GroupAccessDeviceGetPagedSortedListRequest()` request. + Trunk group endpoint that can have multiple contacts. + alternateTrunkIdentityDomain is only used in XS mode and the AS when deployed in IMS + mode. The following elements are only used in AS data mode and are ignored in XS data + mode: physicalLocation Attributes: - sort_by_device_name (sortByDeviceName): sortByDeviceName *Optional* - sort_by_device_type (sortByDeviceType): sortByDeviceType *Optional* - sort_by_device_net_address (sortByDeviceNetAddress): sortByDeviceNetAddress - *Optional* - sort_by_device_mac_address (sortByDeviceMACAddress): sortByDeviceMACAddress + trunk_group_device_endpoint (trunkGroupDeviceEndpoint): trunkGroupDeviceEndpoint *Optional* + enterprise_trunk_name (str): enterpriseTrunkName *Optional* + alternate_trunk_identity (str): alternateTrunkIdentity *Optional* + alternate_trunk_identity_domain (str): alternateTrunkIdentityDomain *Optional* + physical_location (str): physicalLocation *Optional* """ __slots__: List[str] = [ - "sort_by_device_name", - "sort_by_device_type", - "sort_by_device_net_address", - "sort_by_device_mac_address", + "trunk_group_device_endpoint", + "enterprise_trunk_name", + "alternate_trunk_identity", + "alternate_trunk_identity_domain", + "physical_location", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( E( - "sort_by_device_name", - "sortByDeviceName", - SortByDeviceName, - is_complex=True, - ), - E( - "sort_by_device_type", - "sortByDeviceType", - SortByDeviceType, - is_complex=True, - ), - E( - "sort_by_device_net_address", - "sortByDeviceNetAddress", - SortByDeviceNetAddress, - is_complex=True, - ), - E( - "sort_by_device_mac_address", - "sortByDeviceMACAddress", - SortByDeviceMACAddress, + "trunk_group_device_endpoint", + "trunkGroupDeviceEndpoint", + TrunkGroupDeviceMultipleContactEndpointRead, is_complex=True, ), + E("enterprise_trunk_name", "enterpriseTrunkName", str), + E("alternate_trunk_identity", "alternateTrunkIdentity", str), + E("alternate_trunk_identity_domain", "alternateTrunkIdentityDomain", str), + E("physical_location", "physicalLocation", str), ) -class SortOrderGroupAdminGetPagedSortedList(OCIType): +class TrunkAddressingRead(OCIType): """ - Used to sort the `GroupAdminGetPagedSortedListRequest()` request. + Trunk group endpoint. Attributes: - sort_by_admin_id (sortByAdminId): sortByAdminId *Optional* - sort_by_admin_last_name (sortByAdminLastName): sortByAdminLastName *Optional* - sort_by_admin_first_name (sortByAdminFirstName): sortByAdminFirstName *Optional* + trunk_group_device_endpoint (trunkGroupDeviceEndpoint): trunkGroupDeviceEndpoint + *Optional* + enterprise_trunk_name (str): enterpriseTrunkName *Optional* + alternate_trunk_identity (str): alternateTrunkIdentity *Optional* """ __slots__: List[str] = [ - "sort_by_admin_id", - "sort_by_admin_last_name", - "sort_by_admin_first_name", + "trunk_group_device_endpoint", + "enterprise_trunk_name", + "alternate_trunk_identity", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("sort_by_admin_id", "sortByAdminId", SortByAdminId, is_complex=True), - E( - "sort_by_admin_last_name", - "sortByAdminLastName", - SortByAdminLastName, - is_complex=True, - ), E( - "sort_by_admin_first_name", - "sortByAdminFirstName", - SortByAdminFirstName, + "trunk_group_device_endpoint", + "trunkGroupDeviceEndpoint", + TrunkGroupDeviceEndpointRead14sp4, is_complex=True, ), + E("enterprise_trunk_name", "enterpriseTrunkName", str), + E("alternate_trunk_identity", "alternateTrunkIdentity", str), ) -class SortOrderGroupAutoAttendantGetInstancePagedSortedList(OCIType): +class TrunkGroupDeviceMultipleContactEndpointAdd22(OCIType): """ - Used to sort the `GroupAutoAttendantGetInstancePagedSortedListRequest()` request. + Trunk group device endpoint used in the context of modify that can have multiple + contacts. Attributes: - sort_by_user_id (sortByUserId): sortByUserId *Optional* - sort_by_user_last_name (sortByUserLastName): sortByUserLastName *Optional* - sort_by_dn (sortByDn): sortByDn *Optional* - sort_by_extension (sortByExtension): sortByExtension *Optional* + name (str): name + line_port (str): linePort + contact (List[contact]): contact *Optional* """ __slots__: List[str] = [ - "sort_by_user_id", - "sort_by_user_last_name", - "sort_by_dn", - "sort_by_extension", + "name", + "line_port", + "contact", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("sort_by_user_id", "sortByUserId", SortByUserId, is_complex=True), - E( - "sort_by_user_last_name", - "sortByUserLastName", - SortByUserLastName, - is_complex=True, - ), - E("sort_by_dn", "sortByDn", SortByDn, is_complex=True), - E("sort_by_extension", "sortByExtension", SortByExtension, is_complex=True), + E("name", "name", str, is_required=True), + E("line_port", "linePort", str, is_required=True), + E("contact", "contact", SIPContactInfo, is_complex=True, is_array=True), ) -class SortOrderGroupCallCenterAgentThresholdProfileGetAvailableAgentPagedSortedList( - OCIType, -): +class TrunkGroupDeviceMultipleContactEndpointModify(OCIType): """ - Used to sort the - `GroupCallCenterAgentThresholdProfileGetAvailableAgentPagedSortedListRequest()` - request. + Trunk group device endpoint used in the context of modify that can have multiple + contacts. Attributes: - sort_by_user_id (sortByUserId): sortByUserId *Optional* - sort_by_user_last_name (sortByUserLastName): sortByUserLastName *Optional* - sort_by_user_first_name (sortByUserFirstName): sortByUserFirstName *Optional* - sort_by_dn (sortByDn): sortByDn *Optional* - sort_by_extension (sortByExtension): sortByExtension *Optional* - sort_by_department_name (sortByDepartmentName): sortByDepartmentName *Optional* - sort_by_email_address (sortByEmailAddress): sortByEmailAddress *Optional* - sort_by_agent_threshold_profile (sortByAgentThresholdProfile): - sortByAgentThresholdProfile *Optional* + name (str): name *Optional* + line_port (str): linePort *Optional* + contact_list (contactList): contactList *Optional* """ __slots__: List[str] = [ - "sort_by_user_id", - "sort_by_user_last_name", - "sort_by_user_first_name", - "sort_by_dn", - "sort_by_extension", - "sort_by_department_name", - "sort_by_email_address", - "sort_by_agent_threshold_profile", + "name", + "line_port", + "contact_list", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("sort_by_user_id", "sortByUserId", SortByUserId, is_complex=True), - E( - "sort_by_user_last_name", - "sortByUserLastName", - SortByUserLastName, - is_complex=True, - ), - E( - "sort_by_user_first_name", - "sortByUserFirstName", - SortByUserFirstName, - is_complex=True, - ), - E("sort_by_dn", "sortByDn", SortByDn, is_complex=True), - E("sort_by_extension", "sortByExtension", SortByExtension, is_complex=True), - E( - "sort_by_department_name", - "sortByDepartmentName", - SortByDepartmentName, - is_complex=True, - ), - E( - "sort_by_email_address", - "sortByEmailAddress", - SortByEmailAddress, - is_complex=True, - ), - E( - "sort_by_agent_threshold_profile", - "sortByAgentThresholdProfile", - SortByAgentThresholdProfile, - is_complex=True, - ), + E("name", "name", str), + E("line_port", "linePort", str), + E("contact_list", "contactList", ReplacementContactList, is_complex=True), ) -class SortOrderGroupCallCenterAgentThresholdProfileGetPagedSorted(OCIType): +class TrunkGroupDeviceMultipleContactEndpointRead22(OCIType): """ - Used to sort the `GroupCallCenterAgentThresholdProfileGetPagedSortedRequest()` - request. + Trunk group device endpoint that can have multiple contacts. Attributes: - sort_by_user_id (sortByUserId): sortByUserId *Optional* - sort_by_user_last_name (sortByUserLastName): sortByUserLastName *Optional* - sort_by_user_first_name (sortByUserFirstName): sortByUserFirstName *Optional* - sort_by_dn (sortByDn): sortByDn *Optional* - sort_by_extension (sortByExtension): sortByExtension *Optional* - sort_by_department_name (sortByDepartmentName): sortByDepartmentName *Optional* - sort_by_email_address (sortByEmailAddress): sortByEmailAddress *Optional* + name (str): name + line_port (str): linePort + contact (List[contact]): contact *Optional* + static_registration_capable (bool): staticRegistrationCapable + use_domain (bool): useDomain + is_pilot_user (bool): isPilotUser """ __slots__: List[str] = [ - "sort_by_user_id", - "sort_by_user_last_name", - "sort_by_user_first_name", - "sort_by_dn", - "sort_by_extension", - "sort_by_department_name", - "sort_by_email_address", + "name", + "line_port", + "contact", + "static_registration_capable", + "use_domain", + "is_pilot_user", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("sort_by_user_id", "sortByUserId", SortByUserId, is_complex=True), - E( - "sort_by_user_last_name", - "sortByUserLastName", - SortByUserLastName, - is_complex=True, - ), - E( - "sort_by_user_first_name", - "sortByUserFirstName", - SortByUserFirstName, - is_complex=True, - ), - E("sort_by_dn", "sortByDn", SortByDn, is_complex=True), - E("sort_by_extension", "sortByExtension", SortByExtension, is_complex=True), - E( - "sort_by_department_name", - "sortByDepartmentName", - SortByDepartmentName, - is_complex=True, - ), + E("name", "name", str, is_required=True), + E("line_port", "linePort", str, is_required=True), + E("contact", "contact", SIPContactInfo, is_complex=True, is_array=True), E( - "sort_by_email_address", - "sortByEmailAddress", - SortByEmailAddress, - is_complex=True, + "static_registration_capable", + "staticRegistrationCapable", + bool, + is_required=True, ), + E("use_domain", "useDomain", bool, is_required=True), + E("is_pilot_user", "isPilotUser", bool, is_required=True), ) -class SortOrderGroupCallCenterGetAvailableAgentPagedSortedList(OCIType): +class TrunkGroupMultipleContactPilotUser(OCIType): """ - Used to sort the `GroupCallCenterGetAvailableAgentPagedSortedListRequest()` request. + Trunk Group pilot user information used when adding a Trunk Group. Attributes: - sort_by_user_id (sortByUserId): sortByUserId *Optional* - sort_by_user_last_name (sortByUserLastName): sortByUserLastName *Optional* - sort_by_user_first_name (sortByUserFirstName): sortByUserFirstName *Optional* - sort_by_dn (sortByDn): sortByDn *Optional* - sort_by_extension (sortByExtension): sortByExtension *Optional* - sort_by_department_name (sortByDepartmentName): sortByDepartmentName *Optional* - sort_by_email_address (sortByEmailAddress): sortByEmailAddress *Optional* + user_id (str): userId + last_name (str): lastName + first_name (str): firstName + calling_line_id_last_name (str): callingLineIdLastName + calling_line_id_first_name (str): callingLineIdFirstName + hiragana_last_name (str): hiraganaLastName *Optional* + hiragana_first_name (str): hiraganaFirstName *Optional* + password (str): password *Optional* + department (department): department *Optional* + language (str): language *Optional* + time_zone (str): timeZone *Optional* + line_port (str): linePort + contact (List[str]): contact *Optional* + calling_line_id_phone_number (str): callingLineIdPhoneNumber *Optional* """ __slots__: List[str] = [ - "sort_by_user_id", - "sort_by_user_last_name", - "sort_by_user_first_name", - "sort_by_dn", - "sort_by_extension", - "sort_by_department_name", - "sort_by_email_address", + "user_id", + "last_name", + "first_name", + "calling_line_id_last_name", + "calling_line_id_first_name", + "hiragana_last_name", + "hiragana_first_name", + "password", + "department", + "language", + "time_zone", + "line_port", + "contact", + "calling_line_id_phone_number", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("sort_by_user_id", "sortByUserId", SortByUserId, is_complex=True), - E( - "sort_by_user_last_name", - "sortByUserLastName", - SortByUserLastName, - is_complex=True, - ), - E( - "sort_by_user_first_name", - "sortByUserFirstName", - SortByUserFirstName, - is_complex=True, - ), - E("sort_by_dn", "sortByDn", SortByDn, is_complex=True), - E("sort_by_extension", "sortByExtension", SortByExtension, is_complex=True), - E( - "sort_by_department_name", - "sortByDepartmentName", - SortByDepartmentName, - is_complex=True, + E("user_id", "userId", str, is_required=True), + E("last_name", "lastName", str, is_required=True), + E("first_name", "firstName", str, is_required=True), + E( + "calling_line_id_last_name", + "callingLineIdLastName", + str, + is_required=True, ), E( - "sort_by_email_address", - "sortByEmailAddress", - SortByEmailAddress, - is_complex=True, + "calling_line_id_first_name", + "callingLineIdFirstName", + str, + is_required=True, ), + E("hiragana_last_name", "hiraganaLastName", str), + E("hiragana_first_name", "hiraganaFirstName", str), + E("password", "password", str), + E("department", "department", DepartmentKey, is_complex=True), + E("language", "language", str), + E("time_zone", "timeZone", str), + E("line_port", "linePort", str, is_required=True), + E("contact", "contact", str, is_array=True), + E("calling_line_id_phone_number", "callingLineIdPhoneNumber", str), ) -class SortOrderGroupCallCenterGetInstancePagedSortedList(OCIType): +class TrunkGroupMultipleContactPilotUser22(OCIType): """ - Used to sort the `GroupCallCenterGetInstancePagedSortedListRequest()` request. + Trunk Group pilot user information used when adding a Trunk Group. Attributes: - sort_by_user_id (sortByUserId): sortByUserId *Optional* - sort_by_call_center_name (sortByCallCenterName): sortByCallCenterName *Optional* - sort_by_dn (sortByDn): sortByDn *Optional* - sort_by_extension (sortByExtension): sortByExtension *Optional* - sort_by_department_name (sortByDepartmentName): sortByDepartmentName *Optional* - sort_by_hunt_policy (sortByHuntPolicy): sortByHuntPolicy *Optional* - sort_by_call_center_type (sortByCallCenterType): sortByCallCenterType *Optional* + user_id (str): userId + last_name (str): lastName + first_name (str): firstName + calling_line_id_last_name (str): callingLineIdLastName + calling_line_id_first_name (str): callingLineIdFirstName + hiragana_last_name (str): hiraganaLastName *Optional* + hiragana_first_name (str): hiraganaFirstName *Optional* + password (str): password *Optional* + department (department): department *Optional* + language (str): language *Optional* + time_zone (str): timeZone *Optional* + line_port (str): linePort + contact (List[contact]): contact *Optional* + calling_line_id_phone_number (str): callingLineIdPhoneNumber *Optional* """ __slots__: List[str] = [ - "sort_by_user_id", - "sort_by_call_center_name", - "sort_by_dn", - "sort_by_extension", - "sort_by_department_name", - "sort_by_hunt_policy", - "sort_by_call_center_type", + "user_id", + "last_name", + "first_name", + "calling_line_id_last_name", + "calling_line_id_first_name", + "hiragana_last_name", + "hiragana_first_name", + "password", + "department", + "language", + "time_zone", + "line_port", + "contact", + "calling_line_id_phone_number", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("sort_by_user_id", "sortByUserId", SortByUserId, is_complex=True), - E( - "sort_by_call_center_name", - "sortByCallCenterName", - SortByCallCenterName, - is_complex=True, - ), - E("sort_by_dn", "sortByDn", SortByDn, is_complex=True), - E("sort_by_extension", "sortByExtension", SortByExtension, is_complex=True), - E( - "sort_by_department_name", - "sortByDepartmentName", - SortByDepartmentName, - is_complex=True, - ), + E("user_id", "userId", str, is_required=True), + E("last_name", "lastName", str, is_required=True), + E("first_name", "firstName", str, is_required=True), E( - "sort_by_hunt_policy", - "sortByHuntPolicy", - SortByHuntPolicy, - is_complex=True, + "calling_line_id_last_name", + "callingLineIdLastName", + str, + is_required=True, ), E( - "sort_by_call_center_type", - "sortByCallCenterType", - SortByCallCenterType, - is_complex=True, + "calling_line_id_first_name", + "callingLineIdFirstName", + str, + is_required=True, ), + E("hiragana_last_name", "hiraganaLastName", str), + E("hiragana_first_name", "hiraganaFirstName", str), + E("password", "password", str), + E("department", "department", DepartmentKey, is_complex=True), + E("language", "language", str), + E("time_zone", "timeZone", str), + E("line_port", "linePort", str, is_required=True), + E("contact", "contact", SIPContactInfo, is_complex=True, is_array=True), + E("calling_line_id_phone_number", "callingLineIdPhoneNumber", str), ) -class SortOrderGroupCallParkGetAvailableAlternateRecallUserPagedSortedList(OCIType): +class TrunkGroupPilotUser(OCIType): """ - Used to sort the - `GroupCallParkGetAvailableAlternateRecallUserPagedSortedListRequest()` request. + Trunk Group pilot user information used when adding a Trunk Group. Attributes: - sort_by_user_id (sortByUserId): sortByUserId *Optional* - sort_by_user_last_name (sortByUserLastName): sortByUserLastName *Optional* - sort_by_user_first_name (sortByUserFirstName): sortByUserFirstName *Optional* - sort_by_dn (sortByDn): sortByDn *Optional* - sort_by_extension (sortByExtension): sortByExtension *Optional* - sort_by_department_name (sortByDepartmentName): sortByDepartmentName *Optional* + user_id (str): userId + last_name (str): lastName + first_name (str): firstName + calling_line_id_last_name (str): callingLineIdLastName + calling_line_id_first_name (str): callingLineIdFirstName + hiragana_last_name (str): hiraganaLastName *Optional* + hiragana_first_name (str): hiraganaFirstName *Optional* + password (str): password *Optional* + department (department): department *Optional* + language (str): language *Optional* + time_zone (str): timeZone *Optional* + line_port (str): linePort + contact (str): contact *Optional* """ __slots__: List[str] = [ - "sort_by_user_id", - "sort_by_user_last_name", - "sort_by_user_first_name", - "sort_by_dn", - "sort_by_extension", - "sort_by_department_name", + "user_id", + "last_name", + "first_name", + "calling_line_id_last_name", + "calling_line_id_first_name", + "hiragana_last_name", + "hiragana_first_name", + "password", + "department", + "language", + "time_zone", + "line_port", + "contact", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("sort_by_user_id", "sortByUserId", SortByUserId, is_complex=True), - E( - "sort_by_user_last_name", - "sortByUserLastName", - SortByUserLastName, - is_complex=True, - ), + E("user_id", "userId", str, is_required=True), + E("last_name", "lastName", str, is_required=True), + E("first_name", "firstName", str, is_required=True), E( - "sort_by_user_first_name", - "sortByUserFirstName", - SortByUserFirstName, - is_complex=True, + "calling_line_id_last_name", + "callingLineIdLastName", + str, + is_required=True, ), - E("sort_by_dn", "sortByDn", SortByDn, is_complex=True), - E("sort_by_extension", "sortByExtension", SortByExtension, is_complex=True), E( - "sort_by_department_name", - "sortByDepartmentName", - SortByDepartmentName, - is_complex=True, + "calling_line_id_first_name", + "callingLineIdFirstName", + str, + is_required=True, ), + E("hiragana_last_name", "hiraganaLastName", str), + E("hiragana_first_name", "hiraganaFirstName", str), + E("password", "password", str), + E("department", "department", DepartmentKey, is_complex=True), + E("language", "language", str), + E("time_zone", "timeZone", str), + E("line_port", "linePort", str, is_required=True), + E("contact", "contact", str), ) -class SortOrderGroupCallParkGetAvailableUserPagedSortedList(OCIType): +class UserServiceAuthorization(OCIType): """ - Used to sort the `GroupCallParkGetAvailableUserPagedSortedListRequest()` request. + Authorize (with quantity) or unauthorize a user service. Attributes: - sort_by_user_id (sortByUserId): sortByUserId *Optional* - sort_by_user_last_name (sortByUserLastName): sortByUserLastName *Optional* - sort_by_user_first_name (sortByUserFirstName): sortByUserFirstName *Optional* - sort_by_dn (sortByDn): sortByDn *Optional* - sort_by_extension (sortByExtension): sortByExtension *Optional* - sort_by_department_name (sortByDepartmentName): sortByDepartmentName *Optional* - sort_by_email_address (sortByEmailAddress): sortByEmailAddress *Optional* + service_name (str): serviceName + authorized_quantity (authorizedQuantity): authorizedQuantity *Optional* + unauthorized (bool): unauthorized *Optional* """ __slots__: List[str] = [ - "sort_by_user_id", - "sort_by_user_last_name", - "sort_by_user_first_name", - "sort_by_dn", - "sort_by_extension", - "sort_by_department_name", - "sort_by_email_address", + "service_name", + "authorized_quantity", + "unauthorized", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("sort_by_user_id", "sortByUserId", SortByUserId, is_complex=True), - E( - "sort_by_user_last_name", - "sortByUserLastName", - SortByUserLastName, - is_complex=True, - ), - E( - "sort_by_user_first_name", - "sortByUserFirstName", - SortByUserFirstName, - is_complex=True, - ), - E("sort_by_dn", "sortByDn", SortByDn, is_complex=True), - E("sort_by_extension", "sortByExtension", SortByExtension, is_complex=True), - E( - "sort_by_department_name", - "sortByDepartmentName", - SortByDepartmentName, - is_complex=True, - ), + E("service_name", "serviceName", str, is_required=True), E( - "sort_by_email_address", - "sortByEmailAddress", - SortByEmailAddress, + "authorized_quantity", + "authorizedQuantity", + UnboundedPositiveInt, is_complex=True, ), + E("unauthorized", "unauthorized", bool), ) -class SortOrderGroupCallPickupGetAvailableUserPagedSortedList(OCIType): +class VerifyTranslationAndRoutingParameters(OCIType): """ - Used to sort the `GroupCallPickupGetAvailableUserPagedSortedListRequest()` request. + Verification Translation and Routing parameters for creating a Verify Translation and + Routing request from parameters. Attributes: - sort_by_user_id (sortByUserId): sortByUserId *Optional* - sort_by_user_last_name (sortByUserLastName): sortByUserLastName *Optional* - sort_by_user_first_name (sortByUserFirstName): sortByUserFirstName *Optional* - sort_by_dn (sortByDn): sortByDn *Optional* - sort_by_extension (sortByExtension): sortByExtension *Optional* - sort_by_department_name (sortByDepartmentName): sortByDepartmentName *Optional* - sort_by_email_address (sortByEmailAddress): sortByEmailAddress *Optional* + origination (origination): origination + destination (str): destination + contact (str): contact *Optional* + diversion (str): diversion *Optional* """ __slots__: List[str] = [ - "sort_by_user_id", - "sort_by_user_last_name", - "sort_by_user_first_name", - "sort_by_dn", - "sort_by_extension", - "sort_by_department_name", - "sort_by_email_address", + "origination", + "destination", + "contact", + "diversion", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("sort_by_user_id", "sortByUserId", SortByUserId, is_complex=True), - E( - "sort_by_user_last_name", - "sortByUserLastName", - SortByUserLastName, - is_complex=True, - ), - E( - "sort_by_user_first_name", - "sortByUserFirstName", - SortByUserFirstName, - is_complex=True, - ), - E("sort_by_dn", "sortByDn", SortByDn, is_complex=True), - E("sort_by_extension", "sortByExtension", SortByExtension, is_complex=True), - E( - "sort_by_department_name", - "sortByDepartmentName", - SortByDepartmentName, - is_complex=True, - ), E( - "sort_by_email_address", - "sortByEmailAddress", - SortByEmailAddress, + "origination", + "origination", + VerifyTranslationAndRoutingOrigination, is_complex=True, + is_required=True, ), + E("destination", "destination", str, is_required=True), + E("contact", "contact", str), + E("diversion", "diversion", str), ) -class SortOrderGroupCallPickupGetInstancePagedSorted(OCIType): +class VirtualOnNetUserRange(OCIType): """ - Used to sort the `GroupCallPickupGetInstancePagedSortedRequest()` request. + Virtual On-Net User Range. Attributes: - sort_by_user_id (sortByUserId): sortByUserId *Optional* - sort_by_user_last_name (sortByUserLastName): sortByUserLastName *Optional* - sort_by_user_first_name (sortByUserFirstName): sortByUserFirstName *Optional* - sort_by_dn (sortByDn): sortByDn *Optional* - sort_by_extension (sortByExtension): sortByExtension *Optional* - sort_by_department_name (sortByDepartmentName): sortByDepartmentName *Optional* - sort_by_email_address (sortByEmailAddress): sortByEmailAddress *Optional* + dn_range (dnRange): dnRange + extension_range (extensionRange): extensionRange + first_name (str): firstName + last_name (str): lastName + calling_line_id_first_name (str): callingLineIdFirstName + calling_line_id_last_name (str): callingLineIdLastName + virtual_on_net_call_type_name (str): virtualOnNetCallTypeName """ __slots__: List[str] = [ - "sort_by_user_id", - "sort_by_user_last_name", - "sort_by_user_first_name", - "sort_by_dn", - "sort_by_extension", - "sort_by_department_name", - "sort_by_email_address", + "dn_range", + "extension_range", + "first_name", + "last_name", + "calling_line_id_first_name", + "calling_line_id_last_name", + "virtual_on_net_call_type_name", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("sort_by_user_id", "sortByUserId", SortByUserId, is_complex=True), + E("dn_range", "dnRange", DNRange, is_complex=True, is_required=True), E( - "sort_by_user_last_name", - "sortByUserLastName", - SortByUserLastName, + "extension_range", + "extensionRange", + ExtensionRange17, is_complex=True, + is_required=True, ), + E("first_name", "firstName", str, is_required=True), + E("last_name", "lastName", str, is_required=True), E( - "sort_by_user_first_name", - "sortByUserFirstName", - SortByUserFirstName, - is_complex=True, + "calling_line_id_first_name", + "callingLineIdFirstName", + str, + is_required=True, ), - E("sort_by_dn", "sortByDn", SortByDn, is_complex=True), - E("sort_by_extension", "sortByExtension", SortByExtension, is_complex=True), E( - "sort_by_department_name", - "sortByDepartmentName", - SortByDepartmentName, - is_complex=True, + "calling_line_id_last_name", + "callingLineIdLastName", + str, + is_required=True, ), E( - "sort_by_email_address", - "sortByEmailAddress", - SortByEmailAddress, - is_complex=True, + "virtual_on_net_call_type_name", + "virtualOnNetCallTypeName", + str, + is_required=True, ), ) -class SortOrderGroupCollaborateBridgeGetAvailableUserPagedSortedList(OCIType): +class VoiceMessagingAlternateNoAnswerGreetingModify(OCIType): """ - Used to sort the `GroupCollaborateBridgeGetAvailableUserPagedSortedListRequest()` - request. + The configuration of a alternate no answer greeting. + It is used when modifying a user's voice messaging greeting. Attributes: - sort_by_user_id (sortByUserId): sortByUserId *Optional* - sort_by_user_last_name (sortByUserLastName): sortByUserLastName *Optional* - sort_by_user_first_name (sortByUserFirstName): sortByUserFirstName *Optional* - sort_by_dn (sortByDn): sortByDn *Optional* - sort_by_extension (sortByExtension): sortByExtension *Optional* + name (str): name *Optional* + audio_file (audioFile): audioFile *Optional* + video_file (videoFile): videoFile *Optional* """ __slots__: List[str] = [ - "sort_by_user_id", - "sort_by_user_last_name", - "sort_by_user_first_name", - "sort_by_dn", - "sort_by_extension", + "name", + "audio_file", + "video_file", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("sort_by_user_id", "sortByUserId", SortByUserId, is_complex=True), - E( - "sort_by_user_last_name", - "sortByUserLastName", - SortByUserLastName, - is_complex=True, - ), - E( - "sort_by_user_first_name", - "sortByUserFirstName", - SortByUserFirstName, - is_complex=True, - ), - E("sort_by_dn", "sortByDn", SortByDn, is_complex=True), - E("sort_by_extension", "sortByExtension", SortByExtension, is_complex=True), + E("name", "name", str), + E("audio_file", "audioFile", LabeledFileResource, is_complex=True), + E("video_file", "videoFile", LabeledFileResource, is_complex=True), ) -class SortOrderGroupCollaborateBridgeGetInstancePagedSortedList(OCIType): +class VoiceMessagingAlternateNoAnswerGreetingModify16(OCIType): """ - Used to sort the `GroupCollaborateBridgeGetInstancePagedSortedListRequest()`. + The configuration of a alternate no answer greeting. + It is used when modifying a user's voice messaging greeting. Attributes: - sort_by_user_id (sortByUserId): sortByUserId *Optional* - sort_by_user_last_name (sortByUserLastName): sortByUserLastName *Optional* - sort_by_dn (sortByDn): sortByDn *Optional* - sort_by_extension (sortByExtension): sortByExtension *Optional* + name (str): name *Optional* + audio_file (audioFile): audioFile *Optional* + video_file (videoFile): videoFile *Optional* """ __slots__: List[str] = [ - "sort_by_user_id", - "sort_by_user_last_name", - "sort_by_dn", - "sort_by_extension", + "name", + "audio_file", + "video_file", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("sort_by_user_id", "sortByUserId", SortByUserId, is_complex=True), - E( - "sort_by_user_last_name", - "sortByUserLastName", - SortByUserLastName, - is_complex=True, - ), - E("sort_by_dn", "sortByDn", SortByDn, is_complex=True), - E("sort_by_extension", "sortByExtension", SortByExtension, is_complex=True), + E("name", "name", str), + E("audio_file", "audioFile", LabeledMediaFileResource, is_complex=True), + E("video_file", "videoFile", LabeledMediaFileResource, is_complex=True), ) -class SortOrderGroupDnGetAssignmentPagedSortedList(OCIType): - """ - Used to sort the `GroupDnGetAssignmentPagedSortedListRequest()` request. - - - Attributes: - sort_by_dn (sortByDn): sortByDn *Optional* - sort_by_department_name (sortByDepartmentName): sortByDepartmentName *Optional* - sort_by_dn_activated (sortByDnActivated): sortByDnActivated *Optional* - sort_by_dn_available (sortByDnAvailable): sortByDnAvailable *Optional* - sort_by_user_id (sortByUserId): sortByUserId *Optional* - sort_by_user_first_name (sortByUserFirstName): sortByUserFirstName *Optional* - sort_by_user_last_name (sortByUserLastName): sortByUserLastName *Optional* - sort_by_extension (sortByExtension): sortByExtension *Optional* - sort_by_email_address (sortByEmailAddress): sortByEmailAddress *Optional* +class VoiceMessagingAlternateNoAnswerGreetingModify20(OCIType): """ + The configuration of a alternate no answer greeting. - __slots__: List[str] = [ - "sort_by_dn", - "sort_by_department_name", - "sort_by_dn_activated", - "sort_by_dn_available", - "sort_by_user_id", - "sort_by_user_first_name", - "sort_by_user_last_name", - "sort_by_extension", - "sort_by_email_address", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("sort_by_dn", "sortByDn", SortByDn, is_complex=True), - E( - "sort_by_department_name", - "sortByDepartmentName", - SortByDepartmentName, - is_complex=True, - ), - E( - "sort_by_dn_activated", - "sortByDnActivated", - SortByDnActivated, - is_complex=True, - ), - E( - "sort_by_dn_available", - "sortByDnAvailable", - SortByDnAvailable, - is_complex=True, - ), - E("sort_by_user_id", "sortByUserId", SortByUserId, is_complex=True), - E( - "sort_by_user_first_name", - "sortByUserFirstName", - SortByUserFirstName, - is_complex=True, - ), - E( - "sort_by_user_last_name", - "sortByUserLastName", - SortByUserLastName, - is_complex=True, - ), - E("sort_by_extension", "sortByExtension", SortByExtension, is_complex=True), - E( - "sort_by_email_address", - "sortByEmailAddress", - SortByEmailAddress, - is_complex=True, - ), + It is used when modifying a user's voice messaging greeting. + + Attributes: + name (str): name *Optional* + audio_file (audioFile): audioFile *Optional* + video_file (videoFile): videoFile *Optional* + """ + + __slots__: List[str] = [ + "name", + "audio_file", + "video_file", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("name", "name", str), + E("audio_file", "audioFile", AnnouncementFileLevelKey, is_complex=True), + E("video_file", "videoFile", AnnouncementFileLevelKey, is_complex=True), ) -class SortOrderGroupGetListInServiceProviderPagedSortedList(OCIType): +class VoiceMessagingAlternateNoAnswerGreetingRead20(OCIType): """ - Used to sort the `GroupGetListInServiceProviderPagedSortedListRequest()` request. + The configuration of a alternate no answer greeting. + It is used when geting a user's voice messaging greeting. Attributes: - sort_by_group_id (sortByGroupId): sortByGroupId *Optional* - sort_by_group_name (sortByGroupName): sortByGroupName *Optional* + name (str): name + audio_file (audioFile): audioFile *Optional* + video_file (videoFile): videoFile *Optional* """ __slots__: List[str] = [ - "sort_by_group_id", - "sort_by_group_name", + "name", + "audio_file", + "video_file", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("sort_by_group_id", "sortByGroupId", SortByGroupId, is_complex=True), - E( - "sort_by_group_name", - "sortByGroupName", - SortByGroupName, - is_complex=True, - ), + E("name", "name", str, is_required=True), + E("audio_file", "audioFile", AnnouncementFileLevelKey, is_complex=True), + E("video_file", "videoFile", AnnouncementFileLevelKey, is_complex=True), ) -class SortOrderGroupHuntGroupGetAvailableUserPagedSortedList(OCIType): +class VoiceMessagingDistributionListModify(OCIType): """ - Used to sort the `GroupHuntGroupGetAvailableUserPagedSortedListRequest()` request. - + A list of voice mail distribution lists It is used when setting a user's voice + messaging distribution lists Attributes: - sort_by_user_id (sortByUserId): sortByUserId *Optional* - sort_by_user_last_name (sortByUserLastName): sortByUserLastName *Optional* - sort_by_user_first_name (sortByUserFirstName): sortByUserFirstName *Optional* - sort_by_dn (sortByDn): sortByDn *Optional* - sort_by_extension (sortByExtension): sortByExtension *Optional* + list_id (int): listId + description (str): description *Optional* + phone_number_list (phoneNumberList): phoneNumberList *Optional* """ __slots__: List[str] = [ - "sort_by_user_id", - "sort_by_user_last_name", - "sort_by_user_first_name", - "sort_by_dn", - "sort_by_extension", + "list_id", + "description", + "phone_number_list", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("sort_by_user_id", "sortByUserId", SortByUserId, is_complex=True), - E( - "sort_by_user_last_name", - "sortByUserLastName", - SortByUserLastName, - is_complex=True, - ), + E("list_id", "listId", int, is_required=True), + E("description", "description", str), E( - "sort_by_user_first_name", - "sortByUserFirstName", - SortByUserFirstName, + "phone_number_list", + "phoneNumberList", + ReplacementOutgoingDNorSIPURIList, is_complex=True, ), - E("sort_by_dn", "sortByDn", SortByDn, is_complex=True), - E("sort_by_extension", "sortByExtension", SortByExtension, is_complex=True), ) -class SortOrderGroupHuntGroupGetInstancePagedSortedList(OCIType): +class AccessDeviceMultipleContactEndpointModify22(OCIType): """ - Used to sort the `GroupHuntGroupGetInstancePagedSortedListRequest()` request. + Access device end point used in the context of modify that can have more than one + contact defined. + Only Static Registration capable devices may have more than one contact defined. Port + numbers are only used by devices with static line ordering. Attributes: - sort_by_user_id (sortByUserId): sortByUserId *Optional* - sort_by_user_last_name (sortByUserLastName): sortByUserLastName *Optional* - sort_by_dn (sortByDn): sortByDn *Optional* - sort_by_extension (sortByExtension): sortByExtension *Optional* + access_device (accessDevice): accessDevice *Optional* + line_port (str): linePort *Optional* + contact_list (contactList): contactList *Optional* + port_number (int): portNumber *Optional* """ __slots__: List[str] = [ - "sort_by_user_id", - "sort_by_user_last_name", - "sort_by_dn", - "sort_by_extension", + "access_device", + "line_port", + "contact_list", + "port_number", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("sort_by_user_id", "sortByUserId", SortByUserId, is_complex=True), - E( - "sort_by_user_last_name", - "sortByUserLastName", - SortByUserLastName, - is_complex=True, - ), - E("sort_by_dn", "sortByDn", SortByDn, is_complex=True), - E("sort_by_extension", "sortByExtension", SortByExtension, is_complex=True), + E("access_device", "accessDevice", AccessDevice, is_complex=True), + E("line_port", "linePort", str), + E("contact_list", "contactList", ReplacementContactList22, is_complex=True), + E("port_number", "portNumber", int), ) -class SortOrderGroupPhoneDirectoryGetPagedSortedList(OCIType): +class AccessDeviceMultipleIdentityAndContactEndpointModify22(OCIType): """ - Used to sort the `GroupPhoneDirectoryGetPagedSortedListRequest()` request. + Access device end point used in the context of modify that can have more than one + contact defined. + The endpoint is identified by its linePort (public Identity) and possibly a private + Identity. Only Static Registration capable devices may have more than one contact + defined. Port numbers are only used by devices with static line ordering. The + following elements are only used in XS data mode and ignored in AS data mode: + privateIdentity The following elements are only used in AS data mode and ignored in XS + data mode: useHotline hotlineContact Attributes: - sort_by_user_last_name (sortByUserLastName): sortByUserLastName *Optional* - sort_by_user_first_name (sortByUserFirstName): sortByUserFirstName *Optional* - sort_by_mobile_phone_number (sortByMobilePhoneNumber): sortByMobilePhoneNumber - *Optional* - sort_by_email_address (sortByEmailAddress): sortByEmailAddress *Optional* - sort_by_department_name (sortByDepartmentName): sortByDepartmentName *Optional* - sort_by_yahoo_id (sortByYahooId): sortByYahooId *Optional* - sort_by_user_id (sortByUserId): sortByUserId *Optional* - sort_by_imp_id (sortByImpId): sortByImpId *Optional* + access_device (accessDevice): accessDevice *Optional* + line_port (str): linePort *Optional* + private_identity (str): privateIdentity *Optional* + contact_list (contactList): contactList *Optional* + port_number (int): portNumber *Optional* + use_hotline (bool): useHotline *Optional* + hotline_contact (str): hotlineContact *Optional* """ __slots__: List[str] = [ - "sort_by_user_last_name", - "sort_by_user_first_name", - "sort_by_mobile_phone_number", - "sort_by_email_address", - "sort_by_department_name", - "sort_by_yahoo_id", - "sort_by_user_id", - "sort_by_imp_id", + "access_device", + "line_port", + "private_identity", + "contact_list", + "port_number", + "use_hotline", + "hotline_contact", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E( - "sort_by_user_last_name", - "sortByUserLastName", - SortByUserLastName, - is_complex=True, - ), - E( - "sort_by_user_first_name", - "sortByUserFirstName", - SortByUserFirstName, - is_complex=True, - ), - E( - "sort_by_mobile_phone_number", - "sortByMobilePhoneNumber", - SortByMobilePhoneNumber, - is_complex=True, - ), - E( - "sort_by_email_address", - "sortByEmailAddress", - SortByEmailAddress, - is_complex=True, - ), - E( - "sort_by_department_name", - "sortByDepartmentName", - SortByDepartmentName, - is_complex=True, - ), - E("sort_by_yahoo_id", "sortByYahooId", SortByYahooId, is_complex=True), - E("sort_by_user_id", "sortByUserId", SortByUserId, is_complex=True), - E("sort_by_imp_id", "sortByImpId", SortByImpId, is_complex=True), + E("access_device", "accessDevice", AccessDevice, is_complex=True), + E("line_port", "linePort", str), + E("private_identity", "privateIdentity", str), + E("contact_list", "contactList", ReplacementContactList22, is_complex=True), + E("port_number", "portNumber", int), + E("use_hotline", "useHotline", bool), + E("hotline_contact", "hotlineContact", str), ) -class SortOrderServiceProviderAdminGetPagedSortedList(OCIType): +class AutoAttendantKeyConfiguration(OCIType): """ - Used to sort the `ServiceProviderAdminGetPagedSortedListRequest()` request. + The configuration of a key for Auto Attendant. Attributes: - sort_by_admin_id (sortByAdminId): sortByAdminId *Optional* - sort_by_admin_last_name (sortByAdminLastName): sortByAdminLastName *Optional* - sort_by_admin_first_name (sortByAdminFirstName): sortByAdminFirstName *Optional* + key (str): key + entry (entry): entry """ __slots__: List[str] = [ - "sort_by_admin_id", - "sort_by_admin_last_name", - "sort_by_admin_first_name", + "key", + "entry", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("sort_by_admin_id", "sortByAdminId", SortByAdminId, is_complex=True), - E( - "sort_by_admin_last_name", - "sortByAdminLastName", - SortByAdminLastName, - is_complex=True, - ), + E("key", "key", str, is_required=True), E( - "sort_by_admin_first_name", - "sortByAdminFirstName", - SortByAdminFirstName, + "entry", + "entry", + AutoAttendantKeyConfigurationEntry, is_complex=True, + is_required=True, ), ) -class SortOrderServiceProviderGetPagedSortedList(OCIType): +class AutoAttendantKeyConfiguration19(OCIType): """ - Used to sort the `ServiceProviderGetPagedSortedListRequest()` request. + The configuration of a key for Auto Attendant. Attributes: - sort_by_service_provider_id (sortByServiceProviderId): sortByServiceProviderId - *Optional* - sort_by_service_provider_name (sortByServiceProviderName): - sortByServiceProviderName *Optional* + key (str): key + entry (entry): entry """ __slots__: List[str] = [ - "sort_by_service_provider_id", - "sort_by_service_provider_name", + "key", + "entry", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( + E("key", "key", str, is_required=True), E( - "sort_by_service_provider_id", - "sortByServiceProviderId", - SortByServiceProviderId, - is_complex=True, - ), - E( - "sort_by_service_provider_name", - "sortByServiceProviderName", - SortByServiceProviderName, + "entry", + "entry", + AutoAttendantKeyConfigurationEntry19, is_complex=True, + is_required=True, ), ) -class SortOrderUserGetListInGroupPagedSortedList(OCIType): +class AutoAttendantKeyConfiguration20(OCIType): """ - Used to sort the `UserGetListInGroupPagedSortedListRequest()` request. + The configuration of a key for Auto Attendant. Attributes: - sort_by_user_id (sortByUserId): sortByUserId *Optional* - sort_by_user_last_name (sortByUserLastName): sortByUserLastName *Optional* - sort_by_user_first_name (sortByUserFirstName): sortByUserFirstName *Optional* - sort_by_department_name (sortByDepartmentName): sortByDepartmentName *Optional* - sort_by_dn (sortByDn): sortByDn *Optional* - sort_by_extension (sortByExtension): sortByExtension *Optional* - sort_by_email_address (sortByEmailAddress): sortByEmailAddress *Optional* + key (str): key + entry (entry): entry """ __slots__: List[str] = [ - "sort_by_user_id", - "sort_by_user_last_name", - "sort_by_user_first_name", - "sort_by_department_name", - "sort_by_dn", - "sort_by_extension", - "sort_by_email_address", + "key", + "entry", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("sort_by_user_id", "sortByUserId", SortByUserId, is_complex=True), - E( - "sort_by_user_last_name", - "sortByUserLastName", - SortByUserLastName, - is_complex=True, - ), - E( - "sort_by_user_first_name", - "sortByUserFirstName", - SortByUserFirstName, - is_complex=True, - ), - E( - "sort_by_department_name", - "sortByDepartmentName", - SortByDepartmentName, - is_complex=True, - ), - E("sort_by_dn", "sortByDn", SortByDn, is_complex=True), - E("sort_by_extension", "sortByExtension", SortByExtension, is_complex=True), + E("key", "key", str, is_required=True), E( - "sort_by_email_address", - "sortByEmailAddress", - SortByEmailAddress, + "entry", + "entry", + AutoAttendantKeyConfigurationEntry20, is_complex=True, + is_required=True, ), ) -class SystemCollaborateGetResponse20sp1V2(OCIType): +class AutoAttendantKeyModifyConfiguration(OCIType): """ - Response to SystemCollaborateGetRequest20sp1V2. + The modify configuration of a key for Auto Attendant. Attributes: - collaborate_room_id_length (int): collaborateRoomIdLength - instant_room_idle_timeout_seconds (int): instantRoomIdleTimeoutSeconds - collaborate_room_maximum_duration_minutes (int): - collaborateRoomMaximumDurationMinutes - support_outdial (bool): supportOutdial - max_collaborate_room_participants (int): maxCollaborateRoomParticipants - collaborate_active_talker_refresh_interval_seconds (int): - collaborateActiveTalkerRefreshIntervalSeconds - terminate_collaborate_after_grace_period (bool): - terminateCollaborateAfterGracePeriod - collaborate_grace_period (collaborateGracePeriod): collaborateGracePeriod - enable_active_collaborate_notification (bool): enableActiveCollaborateNotification - collaborate_from_address (str): collaborateFromAddress *Optional* + key (str): key + entry (entry): entry """ __slots__: List[str] = [ - "collaborate_room_id_length", - "instant_room_idle_timeout_seconds", - "collaborate_room_maximum_duration_minutes", - "support_outdial", - "max_collaborate_room_participants", - "collaborate_active_talker_refresh_interval_seconds", - "terminate_collaborate_after_grace_period", - "collaborate_grace_period", - "enable_active_collaborate_notification", - "collaborate_from_address", + "key", + "entry", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( + E("key", "key", str, is_required=True), E( - "collaborate_room_id_length", - "collaborateRoomIdLength", - int, - is_required=True, - ), - E( - "instant_room_idle_timeout_seconds", - "instantRoomIdleTimeoutSeconds", - int, - is_required=True, - ), - E( - "collaborate_room_maximum_duration_minutes", - "collaborateRoomMaximumDurationMinutes", - int, - is_required=True, - ), - E("support_outdial", "supportOutdial", bool, is_required=True), - E( - "max_collaborate_room_participants", - "maxCollaborateRoomParticipants", - int, - is_required=True, - ), - E( - "collaborate_active_talker_refresh_interval_seconds", - "collaborateActiveTalkerRefreshIntervalSeconds", - int, - is_required=True, - ), - E( - "terminate_collaborate_after_grace_period", - "terminateCollaborateAfterGracePeriod", - bool, - is_required=True, - ), - E( - "collaborate_grace_period", - "collaborateGracePeriod", - CollaborateGracePeriodDuration, + "entry", + "entry", + AutoAttendantKeyConfigurationModifyEntry, is_complex=True, is_required=True, ), - E( - "enable_active_collaborate_notification", - "enableActiveCollaborateNotification", - bool, - is_required=True, - ), - E("collaborate_from_address", "collaborateFromAddress", str), ) -class SystemCollaborateModifyRequest20sp1V2(OCIType): +class AutoAttendantKeyModifyConfiguration20(OCIType): """ - Modify the system level data associated with collaborate services. + The modify configuration of a key for Auto Attendant. - The response is either a `SuccessResponse()` or an `ErrorResponse()`. Attributes: - collaborate_room_id_length (int): collaborateRoomIdLength *Optional* - instant_room_idle_timeout_seconds (int): instantRoomIdleTimeoutSeconds *Optional* - collaborate_room_maximum_duration_minutes (int): - collaborateRoomMaximumDurationMinutes *Optional* - support_outdial (bool): supportOutdial *Optional* - max_collaborate_room_participants (int): maxCollaborateRoomParticipants *Optional* - collaborate_active_talker_refresh_interval_seconds (int): - collaborateActiveTalkerRefreshIntervalSeconds *Optional* - terminate_collaborate_after_grace_period (bool): - terminateCollaborateAfterGracePeriod *Optional* - collaborate_grace_period (collaborateGracePeriod): collaborateGracePeriod - *Optional* - enable_active_collaborate_notification (bool): enableActiveCollaborateNotification - *Optional* - collaborate_from_address (str): collaborateFromAddress *Optional* + key (str): key + entry (entry): entry """ __slots__: List[str] = [ - "collaborate_room_id_length", - "instant_room_idle_timeout_seconds", - "collaborate_room_maximum_duration_minutes", - "support_outdial", - "max_collaborate_room_participants", - "collaborate_active_talker_refresh_interval_seconds", - "terminate_collaborate_after_grace_period", - "collaborate_grace_period", - "enable_active_collaborate_notification", - "collaborate_from_address", + "key", + "entry", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("collaborate_room_id_length", "collaborateRoomIdLength", int), - E( - "instant_room_idle_timeout_seconds", - "instantRoomIdleTimeoutSeconds", - int, - ), - E( - "collaborate_room_maximum_duration_minutes", - "collaborateRoomMaximumDurationMinutes", - int, - ), - E("support_outdial", "supportOutdial", bool), - E( - "max_collaborate_room_participants", - "maxCollaborateRoomParticipants", - int, - ), - E( - "collaborate_active_talker_refresh_interval_seconds", - "collaborateActiveTalkerRefreshIntervalSeconds", - int, - ), - E( - "terminate_collaborate_after_grace_period", - "terminateCollaborateAfterGracePeriod", - bool, - ), + E("key", "key", str, is_required=True), E( - "collaborate_grace_period", - "collaborateGracePeriod", - CollaborateGracePeriodDuration, + "entry", + "entry", + AutoAttendantKeyConfigurationModifyEntry20, is_complex=True, + is_required=True, ), - E( - "enable_active_collaborate_notification", - "enableActiveCollaborateNotification", - bool, - ), - E("collaborate_from_address", "collaborateFromAddress", str), ) -class SystemCommunicationBarringProfileGetResponse19sp1V2(OCIType): +class AutoAttendantKeyReadConfiguration20(OCIType): """ - Response to the SystemCommunicationBarringProfileGetRequest19sp1V2. + The read configuration of a key for Auto Attendant. - The response contains the Communication Barring Profile information. The incoming - rules are returned in ascending priority order. The following elements are only used - in AS data mode: callMeNowDefaultAction callMeNowDefaultCallTimeout callMeNowRule - applyToAttendedCallTransfers Attributes: - description (str): description *Optional* - originating_default_action (str): originatingDefaultAction - originating_default_treatment_id (str): originatingDefaultTreatmentId *Optional* - originating_default_transfer_number (str): originatingDefaultTransferNumber - *Optional* - originating_default_call_timeout (int): originatingDefaultCallTimeout *Optional* - originating_rule (List[originatingRule]): originatingRule *Optional* - redirecting_default_action (str): redirectingDefaultAction - redirecting_default_call_timeout (int): redirectingDefaultCallTimeout *Optional* - redirecting_rule (List[redirectingRule]): redirectingRule *Optional* - incoming_default_action (str): incomingDefaultAction - incoming_default_call_timeout (int): incomingDefaultCallTimeout *Optional* - incoming_rule (List[incomingRule]): incomingRule *Optional* - call_me_now_default_action (str): callMeNowDefaultAction - call_me_now_default_call_timeout (int): callMeNowDefaultCallTimeout *Optional* - call_me_now_rule (List[callMeNowRule]): callMeNowRule *Optional* - apply_to_attended_call_transfers (bool): applyToAttendedCallTransfers + key (str): key + entry (entry): entry """ - - __slots__: List[str] = [ - "description", - "originating_default_action", - "originating_default_treatment_id", - "originating_default_transfer_number", - "originating_default_call_timeout", - "originating_rule", - "redirecting_default_action", - "redirecting_default_call_timeout", - "redirecting_rule", - "incoming_default_action", - "incoming_default_call_timeout", - "incoming_rule", - "call_me_now_default_action", - "call_me_now_default_call_timeout", - "call_me_now_rule", - "apply_to_attended_call_transfers", + + __slots__: List[str] = [ + "key", + "entry", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("description", "description", str), - E( - "originating_default_action", - "originatingDefaultAction", - str, - is_required=True, - ), - E("originating_default_treatment_id", "originatingDefaultTreatmentId", str), - E( - "originating_default_transfer_number", - "originatingDefaultTransferNumber", - str, - ), - E("originating_default_call_timeout", "originatingDefaultCallTimeout", int), - E( - "originating_rule", - "originatingRule", - CommunicationBarringOriginatingRule, - is_complex=True, - is_array=True, - ), - E( - "redirecting_default_action", - "redirectingDefaultAction", - str, - is_required=True, - ), - E("redirecting_default_call_timeout", "redirectingDefaultCallTimeout", int), + E("key", "key", str, is_required=True), E( - "redirecting_rule", - "redirectingRule", - CommunicationBarringRedirectingRule, + "entry", + "entry", + AutoAttendantKeyConfigurationReadEntry20, is_complex=True, - is_array=True, - ), - E( - "incoming_default_action", - "incomingDefaultAction", - str, is_required=True, ), - E("incoming_default_call_timeout", "incomingDefaultCallTimeout", int), - E( - "incoming_rule", - "incomingRule", - CommunicationBarringIncomingRule19sp1, - is_complex=True, - is_array=True, - ), + ) + + +class AutoAttendantReadMenu19(OCIType): + """ + The configuration of the automated receptionist greeting prompt and dialing menu to be + used during after business hours. + + + Attributes: + announcement_selection (str): announcementSelection + audio_file_description (str): audioFileDescription *Optional* + audio_media_type (str): audioMediaType *Optional* + video_file_description (str): videoFileDescription *Optional* + video_media_type (str): videoMediaType *Optional* + enable_first_menu_level_extension_dialing (bool): + enableFirstMenuLevelExtensionDialing + key_configuration (List[keyConfiguration]): keyConfiguration *Optional* + """ + + __slots__: List[str] = [ + "announcement_selection", + "audio_file_description", + "audio_media_type", + "video_file_description", + "video_media_type", + "enable_first_menu_level_extension_dialing", + "key_configuration", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("announcement_selection", "announcementSelection", str, is_required=True), + E("audio_file_description", "audioFileDescription", str), + E("audio_media_type", "audioMediaType", str), + E("video_file_description", "videoFileDescription", str), + E("video_media_type", "videoMediaType", str), E( - "call_me_now_default_action", - "callMeNowDefaultAction", - str, + "enable_first_menu_level_extension_dialing", + "enableFirstMenuLevelExtensionDialing", + bool, is_required=True, ), - E("call_me_now_default_call_timeout", "callMeNowDefaultCallTimeout", int), E( - "call_me_now_rule", - "callMeNowRule", - CommunicationBarringCallMeNowRule, + "key_configuration", + "keyConfiguration", + AutoAttendantKeyReadConfiguration19, is_complex=True, is_array=True, ), - E( - "apply_to_attended_call_transfers", - "applyToAttendedCallTransfers", - bool, - is_required=True, - ), ) -class TreeDeviceInfo(OCIType): +class CPEDeviceModifyOptions(OCIType): """ - Information related to a tree device. + CPE device's options when used with a modify request. - A tree device is a device associated with a device type that has the option - supportLinks set to "Support Links from Devices". Many leaf devices can link to it. - When a tree device is created, it is assigned a system-wide unique linkId. + The following options are not changeable: configType systemFileName deviceFileFormat Attributes: - tree_device_key (treeDeviceKey): treeDeviceKey - link_id (str): linkId + enable_monitoring (bool): enableMonitoring *Optional* + reset_event (str): resetEvent *Optional* + device_management_device_type_options (deviceManagementDeviceTypeOptions): + deviceManagementDeviceTypeOptions *Optional* """ __slots__: List[str] = [ - "tree_device_key", - "link_id", + "enable_monitoring", + "reset_event", + "device_management_device_type_options", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( + E("enable_monitoring", "enableMonitoring", bool), + E("reset_event", "resetEvent", str), E( - "tree_device_key", - "treeDeviceKey", - AccessDeviceKey, + "device_management_device_type_options", + "deviceManagementDeviceTypeOptions", + DeviceManagementDeviceTypeModifyOptions, is_complex=True, - is_required=True, ), - E("link_id", "linkId", str, is_required=True), ) -class TrunkAddressingAdd(OCIType): +class CPEDeviceModifyOptions16(OCIType): """ - Trunk group endpoint. + CPE device's options when used with a modify request. + The following options are not changeable: configType systemFileName deviceFileFormat Attributes: - trunk_group_device_endpoint (trunkGroupDeviceEndpoint): trunkGroupDeviceEndpoint - *Optional* - enterprise_trunk_name (str): enterpriseTrunkName *Optional* - alternate_trunk_identity (str): alternateTrunkIdentity *Optional* + enable_monitoring (bool): enableMonitoring *Optional* + reset_event (str): resetEvent *Optional* + device_management_device_type_options (deviceManagementDeviceTypeOptions): + deviceManagementDeviceTypeOptions *Optional* """ __slots__: List[str] = [ - "trunk_group_device_endpoint", - "enterprise_trunk_name", - "alternate_trunk_identity", + "enable_monitoring", + "reset_event", + "device_management_device_type_options", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( + E("enable_monitoring", "enableMonitoring", bool), + E("reset_event", "resetEvent", str), E( - "trunk_group_device_endpoint", - "trunkGroupDeviceEndpoint", - TrunkGroupDeviceEndpointAdd, + "device_management_device_type_options", + "deviceManagementDeviceTypeOptions", + DeviceManagementDeviceTypeModifyOptions16, is_complex=True, ), - E("enterprise_trunk_name", "enterpriseTrunkName", str), - E("alternate_trunk_identity", "alternateTrunkIdentity", str), ) -class TrunkAddressingModify(OCIType): +class CPEDeviceModifyOptions16sp1(OCIType): """ - Trunk group endpoint. + CPE device's options when used with a modify request. + The following options are not changeable: configType systemFileName deviceFileFormat Attributes: - trunk_group_device_endpoint (trunkGroupDeviceEndpoint): trunkGroupDeviceEndpoint - *Optional* - enterprise_trunk_name (str): enterpriseTrunkName *Optional* - alternate_trunk_identity (str): alternateTrunkIdentity *Optional* + enable_monitoring (bool): enableMonitoring *Optional* + device_management_device_type_options (deviceManagementDeviceTypeOptions): + deviceManagementDeviceTypeOptions *Optional* """ __slots__: List[str] = [ - "trunk_group_device_endpoint", - "enterprise_trunk_name", - "alternate_trunk_identity", + "enable_monitoring", + "device_management_device_type_options", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( + E("enable_monitoring", "enableMonitoring", bool), E( - "trunk_group_device_endpoint", - "trunkGroupDeviceEndpoint", - TrunkGroupDeviceEndpointModify, + "device_management_device_type_options", + "deviceManagementDeviceTypeOptions", + DeviceManagementDeviceTypeModifyOptions16, is_complex=True, ), - E("enterprise_trunk_name", "enterpriseTrunkName", str), - E("alternate_trunk_identity", "alternateTrunkIdentity", str), ) -class TrunkAddressingMultipleContactAdd(OCIType): +class CPEDeviceModifyOptions22(OCIType): """ - Trunk group endpoint that can have multiple contacts. + CPE device's options when used with a modify request. - alternateTrunkIdentityDomain is only used in XS mode and the AS when deployed in IMS - mode. Both alternateTrunkIdentity and AlternateTrunkIdentityDomain should be set at - the same time if one is set in XS mode. The following elements are only used in AS - data mode and are ignored in XS data mode: physicalLocation + The following options are not changeable: configType systemFileName deviceFileFormat Attributes: - trunk_group_device_endpoint (trunkGroupDeviceEndpoint): trunkGroupDeviceEndpoint - *Optional* - enterprise_trunk_name (str): enterpriseTrunkName *Optional* - alternate_trunk_identity (str): alternateTrunkIdentity *Optional* - alternate_trunk_identity_domain (str): alternateTrunkIdentityDomain *Optional* - physical_location (str): physicalLocation *Optional* + enable_monitoring (bool): enableMonitoring *Optional* + device_management_device_type_options (deviceManagementDeviceTypeOptions): + deviceManagementDeviceTypeOptions *Optional* """ __slots__: List[str] = [ - "trunk_group_device_endpoint", - "enterprise_trunk_name", - "alternate_trunk_identity", - "alternate_trunk_identity_domain", - "physical_location", + "enable_monitoring", + "device_management_device_type_options", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( + E("enable_monitoring", "enableMonitoring", bool), E( - "trunk_group_device_endpoint", - "trunkGroupDeviceEndpoint", - TrunkGroupDeviceMultipleContactEndpointAdd, + "device_management_device_type_options", + "deviceManagementDeviceTypeOptions", + DeviceManagementDeviceTypeModifyOptions22, is_complex=True, ), - E("enterprise_trunk_name", "enterpriseTrunkName", str), - E("alternate_trunk_identity", "alternateTrunkIdentity", str), - E("alternate_trunk_identity_domain", "alternateTrunkIdentityDomain", str), - E("physical_location", "physicalLocation", str), ) -class TrunkAddressingMultipleContactRead(OCIType): +class CPEDeviceOptions14sp6(OCIType): """ - Trunk group endpoint that can have multiple contacts. + CPE device's options. - Replaced by: TrunkAddressingMultipleContactRead21 Attributes: - trunk_group_device_endpoint (trunkGroupDeviceEndpoint): trunkGroupDeviceEndpoint - *Optional* - enterprise_trunk_name (str): enterpriseTrunkName *Optional* - alternate_trunk_identity (str): alternateTrunkIdentity *Optional* + enable_monitoring (bool): enableMonitoring + reset_event (str): resetEvent *Optional* + config_type (str): configType + system_file_name (str): systemFileName *Optional* + device_file_format (str): deviceFileFormat *Optional* + device_management_device_type_options (deviceManagementDeviceTypeOptions): + deviceManagementDeviceTypeOptions *Optional* """ __slots__: List[str] = [ - "trunk_group_device_endpoint", - "enterprise_trunk_name", - "alternate_trunk_identity", + "enable_monitoring", + "reset_event", + "config_type", + "system_file_name", + "device_file_format", + "device_management_device_type_options", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( + E("enable_monitoring", "enableMonitoring", bool, is_required=True), + E("reset_event", "resetEvent", str), + E("config_type", "configType", str, is_required=True), + E("system_file_name", "systemFileName", str), + E("device_file_format", "deviceFileFormat", str), E( - "trunk_group_device_endpoint", - "trunkGroupDeviceEndpoint", - TrunkGroupDeviceMultipleContactEndpointRead, + "device_management_device_type_options", + "deviceManagementDeviceTypeOptions", + DeviceManagementDeviceTypeOptions, is_complex=True, ), - E("enterprise_trunk_name", "enterpriseTrunkName", str), - E("alternate_trunk_identity", "alternateTrunkIdentity", str), ) -class TrunkAddressingMultipleContactRead21(OCIType): +class CPEDeviceOptions16(OCIType): """ - Trunk group endpoint that can have multiple contacts. + CPE device's options. - alternateTrunkIdentityDomain is only used in XS mode and the AS when deployed in IMS - mode. The following elements are only used in AS data mode and ignored in XS data - mode: alternateTrunkIdentityDomain Attributes: - trunk_group_device_endpoint (trunkGroupDeviceEndpoint): trunkGroupDeviceEndpoint - *Optional* - enterprise_trunk_name (str): enterpriseTrunkName *Optional* - alternate_trunk_identity (str): alternateTrunkIdentity *Optional* - alternate_trunk_identity_domain (str): alternateTrunkIdentityDomain *Optional* + enable_monitoring (bool): enableMonitoring + reset_event (str): resetEvent *Optional* + config_type (str): configType + system_file_name (str): systemFileName *Optional* + device_file_format (str): deviceFileFormat *Optional* + device_management_device_type_options (deviceManagementDeviceTypeOptions): + deviceManagementDeviceTypeOptions *Optional* """ __slots__: List[str] = [ - "trunk_group_device_endpoint", - "enterprise_trunk_name", - "alternate_trunk_identity", - "alternate_trunk_identity_domain", + "enable_monitoring", + "reset_event", + "config_type", + "system_file_name", + "device_file_format", + "device_management_device_type_options", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( + E("enable_monitoring", "enableMonitoring", bool, is_required=True), + E("reset_event", "resetEvent", str), + E("config_type", "configType", str, is_required=True), + E("system_file_name", "systemFileName", str), + E("device_file_format", "deviceFileFormat", str), E( - "trunk_group_device_endpoint", - "trunkGroupDeviceEndpoint", - TrunkGroupDeviceMultipleContactEndpointRead, + "device_management_device_type_options", + "deviceManagementDeviceTypeOptions", + DeviceManagementDeviceTypeOptions16, is_complex=True, ), - E("enterprise_trunk_name", "enterpriseTrunkName", str), - E("alternate_trunk_identity", "alternateTrunkIdentity", str), - E("alternate_trunk_identity_domain", "alternateTrunkIdentityDomain", str), ) -class TrunkAddressingMultipleContactRead21sp1(OCIType): +class CPEDeviceOptions16sp1(OCIType): """ - Trunk group endpoint that can have multiple contacts. + CPE device's options. - alternateTrunkIdentityDomain is only used in XS mode and the AS when deployed in IMS - mode. The following elements are only used in AS data mode and are ignored in XS data - mode: physicalLocation + The field configType is optional to allow the use of field enableMonitoring for all + device types being managed or not ie. device configuration option equals to + DeviceManagement, or Legacy, or Not Supported). If the device configuration option is + set to "Not Supported", the value of configType is forced set to "None" regardless of + its current value. It is not allowed to add a device type with device configuration + option set to Device Management or Legacy when the configType is not set. Attributes: - trunk_group_device_endpoint (trunkGroupDeviceEndpoint): trunkGroupDeviceEndpoint - *Optional* - enterprise_trunk_name (str): enterpriseTrunkName *Optional* - alternate_trunk_identity (str): alternateTrunkIdentity *Optional* - alternate_trunk_identity_domain (str): alternateTrunkIdentityDomain *Optional* - physical_location (str): physicalLocation *Optional* + enable_monitoring (bool): enableMonitoring + config_type (str): configType *Optional* + system_file_name (str): systemFileName *Optional* + device_file_format (str): deviceFileFormat *Optional* + device_management_device_type_options (deviceManagementDeviceTypeOptions): + deviceManagementDeviceTypeOptions *Optional* """ __slots__: List[str] = [ - "trunk_group_device_endpoint", - "enterprise_trunk_name", - "alternate_trunk_identity", - "alternate_trunk_identity_domain", - "physical_location", + "enable_monitoring", + "config_type", + "system_file_name", + "device_file_format", + "device_management_device_type_options", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( + E("enable_monitoring", "enableMonitoring", bool, is_required=True), + E("config_type", "configType", str), + E("system_file_name", "systemFileName", str), + E("device_file_format", "deviceFileFormat", str), E( - "trunk_group_device_endpoint", - "trunkGroupDeviceEndpoint", - TrunkGroupDeviceMultipleContactEndpointRead, + "device_management_device_type_options", + "deviceManagementDeviceTypeOptions", + DeviceManagementDeviceTypeOptions16, is_complex=True, ), - E("enterprise_trunk_name", "enterpriseTrunkName", str), - E("alternate_trunk_identity", "alternateTrunkIdentity", str), - E("alternate_trunk_identity_domain", "alternateTrunkIdentityDomain", str), - E("physical_location", "physicalLocation", str), ) -class TrunkAddressingRead(OCIType): +class CPEDeviceOptions21sp1(OCIType): """ - Trunk group endpoint. + CPE device's options. + The field configType is optional to allow the use of field enableMonitoring for all + device types being managed or not ie. device configuration option equals to + DeviceManagement, or Legacy, or Not Supported). If the device configuration option is + set to "Not Supported", the value of configType is forced set to "None" regardless of + its current value. It is not allowed to add a device type with device configuration + option set to Device Management or Legacy when the configType is not set. Attributes: - trunk_group_device_endpoint (trunkGroupDeviceEndpoint): trunkGroupDeviceEndpoint - *Optional* - enterprise_trunk_name (str): enterpriseTrunkName *Optional* - alternate_trunk_identity (str): alternateTrunkIdentity *Optional* + enable_monitoring (bool): enableMonitoring + config_type (str): configType *Optional* + system_file_name (str): systemFileName *Optional* + device_file_format (str): deviceFileFormat *Optional* + device_management_device_type_options (deviceManagementDeviceTypeOptions): + deviceManagementDeviceTypeOptions *Optional* """ __slots__: List[str] = [ - "trunk_group_device_endpoint", - "enterprise_trunk_name", - "alternate_trunk_identity", + "enable_monitoring", + "config_type", + "system_file_name", + "device_file_format", + "device_management_device_type_options", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( + E("enable_monitoring", "enableMonitoring", bool, is_required=True), + E("config_type", "configType", str), + E("system_file_name", "systemFileName", str), + E("device_file_format", "deviceFileFormat", str), E( - "trunk_group_device_endpoint", - "trunkGroupDeviceEndpoint", - TrunkGroupDeviceEndpointRead14sp4, + "device_management_device_type_options", + "deviceManagementDeviceTypeOptions", + DeviceManagementDeviceTypeOptions21sp1, is_complex=True, ), - E("enterprise_trunk_name", "enterpriseTrunkName", str), - E("alternate_trunk_identity", "alternateTrunkIdentity", str), ) -class TrunkGroupDeviceMultipleContactEndpointAdd22(OCIType): +class CPEDeviceOptions22(OCIType): """ - Trunk group device endpoint used in the context of modify that can have multiple - contacts. + CPE device's options. + The field configType is optional to allow the use of field enableMonitoring for all + device types being managed or not ie. device configuration option equals to + DeviceManagement, or Legacy, or Not Supported). If the device configuration option is + set to "Not Supported", the value of configType is forced set to "None" regardless of + its current value. It is not allowed to add a device type with device configuration + option set to Device Management or Legacy when the configType is not set. Attributes: - name (str): name - line_port (str): linePort - contact (List[contact]): contact *Optional* + enable_monitoring (bool): enableMonitoring + config_type (str): configType *Optional* + system_file_name (str): systemFileName *Optional* + device_file_format (str): deviceFileFormat *Optional* + device_management_device_type_options (deviceManagementDeviceTypeOptions): + deviceManagementDeviceTypeOptions *Optional* """ __slots__: List[str] = [ - "name", - "line_port", - "contact", + "enable_monitoring", + "config_type", + "system_file_name", + "device_file_format", + "device_management_device_type_options", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("name", "name", str, is_required=True), - E("line_port", "linePort", str, is_required=True), - E("contact", "contact", SIPContactInfo, is_complex=True, is_array=True), + E("enable_monitoring", "enableMonitoring", bool, is_required=True), + E("config_type", "configType", str), + E("system_file_name", "systemFileName", str), + E("device_file_format", "deviceFileFormat", str), + E( + "device_management_device_type_options", + "deviceManagementDeviceTypeOptions", + DeviceManagementDeviceTypeOptions22, + is_complex=True, + ), ) -class TrunkGroupDeviceMultipleContactEndpointModify(OCIType): +class CPEDeviceOptions22V2(OCIType): """ - Trunk group device endpoint used in the context of modify that can have multiple - contacts. + CPE device's options. + The field configType is optional to allow the use of field enableMonitoring for all + device types being managed or not ie. device configuration option equals to + DeviceManagement, or Legacy, or Not Supported). If the device configuration option is + set to "Not Supported", the value of configType is forced set to "None" regardless of + its current value. It is not allowed to add a device type with device configuration + option set to Device Management or Legacy when the configType is not set. Attributes: - name (str): name *Optional* - line_port (str): linePort *Optional* - contact_list (contactList): contactList *Optional* + enable_monitoring (bool): enableMonitoring + config_type (str): configType *Optional* + system_file_name (str): systemFileName *Optional* + device_file_format (str): deviceFileFormat *Optional* + device_management_device_type_options (deviceManagementDeviceTypeOptions): + deviceManagementDeviceTypeOptions *Optional* """ __slots__: List[str] = [ - "name", - "line_port", - "contact_list", + "enable_monitoring", + "config_type", + "system_file_name", + "device_file_format", + "device_management_device_type_options", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("name", "name", str), - E("line_port", "linePort", str), - E("contact_list", "contactList", ReplacementContactList, is_complex=True), + E("enable_monitoring", "enableMonitoring", bool, is_required=True), + E("config_type", "configType", str), + E("system_file_name", "systemFileName", str), + E("device_file_format", "deviceFileFormat", str), + E( + "device_management_device_type_options", + "deviceManagementDeviceTypeOptions", + DeviceManagementDeviceTypeOptions22V2, + is_complex=True, + ), ) -class TrunkGroupDeviceMultipleContactEndpointRead22(OCIType): +class CPEDeviceOptions22V3(OCIType): """ - Trunk group device endpoint that can have multiple contacts. + CPE device's options. + The field configType is optional to allow the use of field enableMonitoring for all + device types being managed or not ie. device configuration option equals to + DeviceManagement, or Legacy, or Not Supported). If the device configuration option is + set to "Not Supported", the value of configType is forced set to "None" regardless of + its current value. It is not allowed to add a device type with device configuration + option set to Device Management or Legacy when the configType is not set. Attributes: - name (str): name - line_port (str): linePort - contact (List[contact]): contact *Optional* - static_registration_capable (bool): staticRegistrationCapable - use_domain (bool): useDomain - is_pilot_user (bool): isPilotUser - """ - - __slots__: List[str] = [ - "name", - "line_port", - "contact", - "static_registration_capable", - "use_domain", - "is_pilot_user", + enable_monitoring (bool): enableMonitoring + config_type (str): configType *Optional* + system_file_name (str): systemFileName *Optional* + device_file_format (str): deviceFileFormat *Optional* + device_management_device_type_options (deviceManagementDeviceTypeOptions): + deviceManagementDeviceTypeOptions *Optional* + """ + + __slots__: List[str] = [ + "enable_monitoring", + "config_type", + "system_file_name", + "device_file_format", + "device_management_device_type_options", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("name", "name", str, is_required=True), - E("line_port", "linePort", str, is_required=True), - E("contact", "contact", SIPContactInfo, is_complex=True, is_array=True), + E("enable_monitoring", "enableMonitoring", bool, is_required=True), + E("config_type", "configType", str), + E("system_file_name", "systemFileName", str), + E("device_file_format", "deviceFileFormat", str), E( - "static_registration_capable", - "staticRegistrationCapable", - bool, - is_required=True, + "device_management_device_type_options", + "deviceManagementDeviceTypeOptions", + DeviceManagementDeviceTypeOptions22V3, + is_complex=True, ), - E("use_domain", "useDomain", bool, is_required=True), - E("is_pilot_user", "isPilotUser", bool, is_required=True), ) -class TrunkGroupMultipleContactPilotUser(OCIType): +class CPEDeviceOptions22V4(OCIType): """ - Trunk Group pilot user information used when adding a Trunk Group. + CPE device's options. + The field configType is optional to allow the use of field enableMonitoring for all + device types being managed or not ie. device configuration option equals to + DeviceManagement, or Legacy, or Not Supported). If the device configuration option is + set to "Not Supported", the value of configType is forced set to "None" regardless of + its current value. It is not allowed to add a device type with device configuration + option set to Device Management or Legacy when the configType is not set. Attributes: - user_id (str): userId - last_name (str): lastName - first_name (str): firstName - calling_line_id_last_name (str): callingLineIdLastName - calling_line_id_first_name (str): callingLineIdFirstName - hiragana_last_name (str): hiraganaLastName *Optional* - hiragana_first_name (str): hiraganaFirstName *Optional* - password (str): password *Optional* - department (department): department *Optional* - language (str): language *Optional* - time_zone (str): timeZone *Optional* - line_port (str): linePort - contact (List[str]): contact *Optional* - calling_line_id_phone_number (str): callingLineIdPhoneNumber *Optional* + enable_monitoring (bool): enableMonitoring + config_type (str): configType *Optional* + system_file_name (str): systemFileName *Optional* + device_file_format (str): deviceFileFormat *Optional* + device_management_device_type_options (deviceManagementDeviceTypeOptions): + deviceManagementDeviceTypeOptions *Optional* """ __slots__: List[str] = [ - "user_id", - "last_name", - "first_name", - "calling_line_id_last_name", - "calling_line_id_first_name", - "hiragana_last_name", - "hiragana_first_name", - "password", - "department", - "language", - "time_zone", - "line_port", - "contact", - "calling_line_id_phone_number", + "enable_monitoring", + "config_type", + "system_file_name", + "device_file_format", + "device_management_device_type_options", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("user_id", "userId", str, is_required=True), - E("last_name", "lastName", str, is_required=True), - E("first_name", "firstName", str, is_required=True), - E( - "calling_line_id_last_name", - "callingLineIdLastName", - str, - is_required=True, - ), + E("enable_monitoring", "enableMonitoring", bool, is_required=True), + E("config_type", "configType", str), + E("system_file_name", "systemFileName", str), + E("device_file_format", "deviceFileFormat", str), E( - "calling_line_id_first_name", - "callingLineIdFirstName", - str, - is_required=True, + "device_management_device_type_options", + "deviceManagementDeviceTypeOptions", + DeviceManagementDeviceTypeOptions22V4, + is_complex=True, ), - E("hiragana_last_name", "hiraganaLastName", str), - E("hiragana_first_name", "hiraganaFirstName", str), - E("password", "password", str), - E("department", "department", DepartmentKey, is_complex=True), - E("language", "language", str), - E("time_zone", "timeZone", str), - E("line_port", "linePort", str, is_required=True), - E("contact", "contact", str, is_array=True), - E("calling_line_id_phone_number", "callingLineIdPhoneNumber", str), ) -class TrunkGroupMultipleContactPilotUser22(OCIType): +class CallCenterMediaOnHoldSourceModify16(OCIType): """ - Trunk Group pilot user information used when adding a Trunk Group. + Contains the call center media on hold source configuration. Attributes: - user_id (str): userId - last_name (str): lastName - first_name (str): firstName - calling_line_id_last_name (str): callingLineIdLastName - calling_line_id_first_name (str): callingLineIdFirstName - hiragana_last_name (str): hiraganaLastName *Optional* - hiragana_first_name (str): hiraganaFirstName *Optional* - password (str): password *Optional* - department (department): department *Optional* - language (str): language *Optional* - time_zone (str): timeZone *Optional* - line_port (str): linePort - contact (List[contact]): contact *Optional* - calling_line_id_phone_number (str): callingLineIdPhoneNumber *Optional* + audio_message_source_selection (str): audioMessageSourceSelection *Optional* + audio_file (audioFile): audioFile *Optional* + external_audio_source (externalAudioSource): externalAudioSource *Optional* + video_message_source_selection (str): videoMessageSourceSelection *Optional* + video_file (videoFile): videoFile *Optional* + external_video_source (externalVideoSource): externalVideoSource *Optional* """ __slots__: List[str] = [ - "user_id", - "last_name", - "first_name", - "calling_line_id_last_name", - "calling_line_id_first_name", - "hiragana_last_name", - "hiragana_first_name", - "password", - "department", - "language", - "time_zone", - "line_port", - "contact", - "calling_line_id_phone_number", + "audio_message_source_selection", + "audio_file", + "external_audio_source", + "video_message_source_selection", + "video_file", + "external_video_source", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("user_id", "userId", str, is_required=True), - E("last_name", "lastName", str, is_required=True), - E("first_name", "firstName", str, is_required=True), + E("audio_message_source_selection", "audioMessageSourceSelection", str), + E("audio_file", "audioFile", ExtendedMediaFileResource, is_complex=True), E( - "calling_line_id_last_name", - "callingLineIdLastName", - str, - is_required=True, + "external_audio_source", + "externalAudioSource", + AccessDeviceEndpointModify, + is_complex=True, ), + E("video_message_source_selection", "videoMessageSourceSelection", str), + E("video_file", "videoFile", ExtendedMediaFileResource, is_complex=True), E( - "calling_line_id_first_name", - "callingLineIdFirstName", - str, - is_required=True, + "external_video_source", + "externalVideoSource", + AccessDeviceEndpointModify, + is_complex=True, ), - E("hiragana_last_name", "hiraganaLastName", str), - E("hiragana_first_name", "hiraganaFirstName", str), - E("password", "password", str), - E("department", "department", DepartmentKey, is_complex=True), - E("language", "language", str), - E("time_zone", "timeZone", str), - E("line_port", "linePort", str, is_required=True), - E("contact", "contact", SIPContactInfo, is_complex=True, is_array=True), - E("calling_line_id_phone_number", "callingLineIdPhoneNumber", str), ) -class TrunkGroupPilotUser(OCIType): +class CallCenterMediaOnHoldSourceModify17(OCIType): """ - Trunk Group pilot user information used when adding a Trunk Group. + Contains the call center media on hold source configuration. Attributes: - user_id (str): userId - last_name (str): lastName - first_name (str): firstName - calling_line_id_last_name (str): callingLineIdLastName - calling_line_id_first_name (str): callingLineIdFirstName - hiragana_last_name (str): hiraganaLastName *Optional* - hiragana_first_name (str): hiraganaFirstName *Optional* - password (str): password *Optional* - department (department): department *Optional* - language (str): language *Optional* - time_zone (str): timeZone *Optional* - line_port (str): linePort - contact (str): contact *Optional* + audio_message_source_selection (str): audioMessageSourceSelection *Optional* + audio_url_list (audioUrlList): audioUrlList *Optional* + audio_file_list (audioFileList): audioFileList *Optional* + external_audio_source (externalAudioSource): externalAudioSource *Optional* + video_message_source_selection (str): videoMessageSourceSelection *Optional* + video_url_list (videoUrlList): videoUrlList *Optional* + video_file_list (videoFileList): videoFileList *Optional* + external_video_source (externalVideoSource): externalVideoSource *Optional* """ __slots__: List[str] = [ - "user_id", - "last_name", - "first_name", - "calling_line_id_last_name", - "calling_line_id_first_name", - "hiragana_last_name", - "hiragana_first_name", - "password", - "department", - "language", - "time_zone", - "line_port", - "contact", + "audio_message_source_selection", + "audio_url_list", + "audio_file_list", + "external_audio_source", + "video_message_source_selection", + "video_url_list", + "video_file_list", + "external_video_source", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("user_id", "userId", str, is_required=True), - E("last_name", "lastName", str, is_required=True), - E("first_name", "firstName", str, is_required=True), + E("audio_message_source_selection", "audioMessageSourceSelection", str), E( - "calling_line_id_last_name", - "callingLineIdLastName", - str, - is_required=True, + "audio_url_list", + "audioUrlList", + CallCenterAnnouncementURLListModify, + is_complex=True, ), E( - "calling_line_id_first_name", - "callingLineIdFirstName", - str, - is_required=True, + "audio_file_list", + "audioFileList", + CallCenterAnnouncementFileListModify, + is_complex=True, + ), + E( + "external_audio_source", + "externalAudioSource", + AccessDeviceEndpointModify, + is_complex=True, + ), + E("video_message_source_selection", "videoMessageSourceSelection", str), + E( + "video_url_list", + "videoUrlList", + CallCenterAnnouncementURLListModify, + is_complex=True, + ), + E( + "video_file_list", + "videoFileList", + CallCenterAnnouncementFileListModify, + is_complex=True, + ), + E( + "external_video_source", + "externalVideoSource", + AccessDeviceEndpointModify, + is_complex=True, ), - E("hiragana_last_name", "hiraganaLastName", str), - E("hiragana_first_name", "hiraganaFirstName", str), - E("password", "password", str), - E("department", "department", DepartmentKey, is_complex=True), - E("language", "language", str), - E("time_zone", "timeZone", str), - E("line_port", "linePort", str, is_required=True), - E("contact", "contact", str), ) -class UserServiceAuthorization(OCIType): +class CallCenterMediaOnHoldSourceModify20(OCIType): """ - Authorize (with quantity) or unauthorize a user service. + Contains the call center media on hold source configuration. Attributes: - service_name (str): serviceName - authorized_quantity (authorizedQuantity): authorizedQuantity *Optional* - unauthorized (bool): unauthorized *Optional* + audio_message_source_selection (str): audioMessageSourceSelection *Optional* + audio_url_list (audioUrlList): audioUrlList *Optional* + audio_file_list (audioFileList): audioFileList *Optional* + external_audio_source (externalAudioSource): externalAudioSource *Optional* + video_message_source_selection (str): videoMessageSourceSelection *Optional* + video_url_list (videoUrlList): videoUrlList *Optional* + video_file_list (videoFileList): videoFileList *Optional* + external_video_source (externalVideoSource): externalVideoSource *Optional* """ __slots__: List[str] = [ - "service_name", - "authorized_quantity", - "unauthorized", + "audio_message_source_selection", + "audio_url_list", + "audio_file_list", + "external_audio_source", + "video_message_source_selection", + "video_url_list", + "video_file_list", + "external_video_source", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("service_name", "serviceName", str, is_required=True), + E("audio_message_source_selection", "audioMessageSourceSelection", str), E( - "authorized_quantity", - "authorizedQuantity", - UnboundedPositiveInt, + "audio_url_list", + "audioUrlList", + CallCenterAnnouncementURLListModify, + is_complex=True, + ), + E( + "audio_file_list", + "audioFileList", + CallCenterAnnouncementFileListModify20, + is_complex=True, + ), + E( + "external_audio_source", + "externalAudioSource", + AccessDeviceEndpointModify, + is_complex=True, + ), + E("video_message_source_selection", "videoMessageSourceSelection", str), + E( + "video_url_list", + "videoUrlList", + CallCenterAnnouncementURLListModify, + is_complex=True, + ), + E( + "video_file_list", + "videoFileList", + CallCenterAnnouncementFileListModify20, + is_complex=True, + ), + E( + "external_video_source", + "externalVideoSource", + AccessDeviceEndpointModify, is_complex=True, ), - E("unauthorized", "unauthorized", bool), ) -class VerifyTranslationAndRoutingParameters(OCIType): +class CallCenterMediaOnHoldSourceRead16(OCIType): """ - Verification Translation and Routing parameters for creating a Verify Translation and - Routing request from parameters. + Contains the call center media on hold source configuration. Attributes: - origination (origination): origination - destination (str): destination - contact (str): contact *Optional* - diversion (str): diversion *Optional* + audio_message_source_selection (str): audioMessageSourceSelection + audio_file_url (str): audioFileUrl *Optional* + audio_file_description (str): audioFileDescription *Optional* + audio_file_media_type (str): audioFileMediaType *Optional* + external_audio_source (externalAudioSource): externalAudioSource *Optional* + video_message_source_selection (str): videoMessageSourceSelection *Optional* + video_file_url (str): videoFileUrl *Optional* + video_file_description (str): videoFileDescription *Optional* + video_file_media_type (str): videoFileMediaType *Optional* + external_video_source (externalVideoSource): externalVideoSource *Optional* """ __slots__: List[str] = [ - "origination", - "destination", - "contact", - "diversion", + "audio_message_source_selection", + "audio_file_url", + "audio_file_description", + "audio_file_media_type", + "external_audio_source", + "video_message_source_selection", + "video_file_url", + "video_file_description", + "video_file_media_type", + "external_video_source", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( E( - "origination", - "origination", - VerifyTranslationAndRoutingOrigination, - is_complex=True, + "audio_message_source_selection", + "audioMessageSourceSelection", + str, is_required=True, ), - E("destination", "destination", str, is_required=True), - E("contact", "contact", str), - E("diversion", "diversion", str), + E("audio_file_url", "audioFileUrl", str), + E("audio_file_description", "audioFileDescription", str), + E("audio_file_media_type", "audioFileMediaType", str), + E( + "external_audio_source", + "externalAudioSource", + AccessDeviceEndpointRead14, + is_complex=True, + ), + E("video_message_source_selection", "videoMessageSourceSelection", str), + E("video_file_url", "videoFileUrl", str), + E("video_file_description", "videoFileDescription", str), + E("video_file_media_type", "videoFileMediaType", str), + E( + "external_video_source", + "externalVideoSource", + AccessDeviceEndpointRead14, + is_complex=True, + ), ) -class VirtualOnNetUserRange(OCIType): +class CallCenterMediaOnHoldSourceRead17(OCIType): """ - Virtual On-Net User Range. + Contains the call center media on hold source configuration. + Replaced by: CallCenterMediaOnHoldSourceRead19. Attributes: - dn_range (dnRange): dnRange - extension_range (extensionRange): extensionRange - first_name (str): firstName - last_name (str): lastName - calling_line_id_first_name (str): callingLineIdFirstName - calling_line_id_last_name (str): callingLineIdLastName - virtual_on_net_call_type_name (str): virtualOnNetCallTypeName + audio_message_source_selection (str): audioMessageSourceSelection + audio_url_list (audioUrlList): audioUrlList *Optional* + audio_file_list (audioFileList): audioFileList *Optional* + audio_media_type_list (audioMediaTypeList): audioMediaTypeList *Optional* + external_audio_source (externalAudioSource): externalAudioSource *Optional* + video_message_source_selection (str): videoMessageSourceSelection *Optional* + video_url_list (videoUrlList): videoUrlList *Optional* + video_file_list (videoFileList): videoFileList *Optional* + video_media_type_list (videoMediaTypeList): videoMediaTypeList *Optional* + external_video_source (externalVideoSource): externalVideoSource *Optional* """ __slots__: List[str] = [ - "dn_range", - "extension_range", - "first_name", - "last_name", - "calling_line_id_first_name", - "calling_line_id_last_name", - "virtual_on_net_call_type_name", + "audio_message_source_selection", + "audio_url_list", + "audio_file_list", + "audio_media_type_list", + "external_audio_source", + "video_message_source_selection", + "video_url_list", + "video_file_list", + "video_media_type_list", + "external_video_source", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("dn_range", "dnRange", DNRange, is_complex=True, is_required=True), E( - "extension_range", - "extensionRange", - ExtensionRange17, - is_complex=True, + "audio_message_source_selection", + "audioMessageSourceSelection", + str, is_required=True, ), - E("first_name", "firstName", str, is_required=True), - E("last_name", "lastName", str, is_required=True), E( - "calling_line_id_first_name", - "callingLineIdFirstName", - str, - is_required=True, + "audio_url_list", + "audioUrlList", + CallCenterAnnouncementURLList, + is_complex=True, ), E( - "calling_line_id_last_name", - "callingLineIdLastName", - str, - is_required=True, + "audio_file_list", + "audioFileList", + CallCenterAnnouncementDescriptionList, + is_complex=True, ), E( - "virtual_on_net_call_type_name", - "virtualOnNetCallTypeName", - str, - is_required=True, + "audio_media_type_list", + "audioMediaTypeList", + CallCenterAnnouncementMediaFileTypeList, + is_complex=True, + ), + E( + "external_audio_source", + "externalAudioSource", + AccessDeviceEndpointRead14, + is_complex=True, + ), + E("video_message_source_selection", "videoMessageSourceSelection", str), + E( + "video_url_list", + "videoUrlList", + CallCenterAnnouncementURLList, + is_complex=True, + ), + E( + "video_file_list", + "videoFileList", + CallCenterAnnouncementDescriptionList, + is_complex=True, + ), + E( + "video_media_type_list", + "videoMediaTypeList", + CallCenterAnnouncementMediaFileTypeList, + is_complex=True, + ), + E( + "external_video_source", + "externalVideoSource", + AccessDeviceEndpointRead14, + is_complex=True, ), ) -class VoiceMessagingAlternateNoAnswerGreetingModify(OCIType): +class CallCenterMediaOnHoldSourceRead19(OCIType): """ - The configuration of a alternate no answer greeting. + Contains the call center media on hold source configuration. - It is used when modifying a user's voice messaging greeting. Attributes: - name (str): name *Optional* - audio_file (audioFile): audioFile *Optional* - video_file (videoFile): videoFile *Optional* + audio_message_source_selection (str): audioMessageSourceSelection + audio_url_list (audioUrlList): audioUrlList *Optional* + audio_file_list (audioFileList): audioFileList *Optional* + audio_media_type_list (audioMediaTypeList): audioMediaTypeList *Optional* + external_audio_source (externalAudioSource): externalAudioSource *Optional* + video_message_source_selection (str): videoMessageSourceSelection *Optional* + video_url_list (videoUrlList): videoUrlList *Optional* + video_file_list (videoFileList): videoFileList *Optional* + video_media_type_list (videoMediaTypeList): videoMediaTypeList *Optional* + external_video_source (externalVideoSource): externalVideoSource *Optional* """ __slots__: List[str] = [ - "name", - "audio_file", - "video_file", + "audio_message_source_selection", + "audio_url_list", + "audio_file_list", + "audio_media_type_list", + "external_audio_source", + "video_message_source_selection", + "video_url_list", + "video_file_list", + "video_media_type_list", + "external_video_source", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("name", "name", str), - E("audio_file", "audioFile", LabeledFileResource, is_complex=True), - E("video_file", "videoFile", LabeledFileResource, is_complex=True), + E( + "audio_message_source_selection", + "audioMessageSourceSelection", + str, + is_required=True, + ), + E( + "audio_url_list", + "audioUrlList", + CallCenterAnnouncementURLList, + is_complex=True, + ), + E( + "audio_file_list", + "audioFileList", + CallCenterAnnouncementDescriptionList, + is_complex=True, + ), + E( + "audio_media_type_list", + "audioMediaTypeList", + CallCenterAnnouncementMediaFileTypeList, + is_complex=True, + ), + E( + "external_audio_source", + "externalAudioSource", + AccessDeviceEndpointWithPortNumberRead, + is_complex=True, + ), + E("video_message_source_selection", "videoMessageSourceSelection", str), + E( + "video_url_list", + "videoUrlList", + CallCenterAnnouncementURLList, + is_complex=True, + ), + E( + "video_file_list", + "videoFileList", + CallCenterAnnouncementDescriptionList, + is_complex=True, + ), + E( + "video_media_type_list", + "videoMediaTypeList", + CallCenterAnnouncementMediaFileTypeList, + is_complex=True, + ), + E( + "external_video_source", + "externalVideoSource", + AccessDeviceEndpointWithPortNumberRead, + is_complex=True, + ), ) -class VoiceMessagingAlternateNoAnswerGreetingModify16(OCIType): +class CallCenterMediaOnHoldSourceRead20(OCIType): """ - The configuration of a alternate no answer greeting. + Contains the call center media on hold source configuration. - It is used when modifying a user's voice messaging greeting. Attributes: - name (str): name *Optional* - audio_file (audioFile): audioFile *Optional* - video_file (videoFile): videoFile *Optional* + audio_message_source_selection (str): audioMessageSourceSelection + audio_url_list (audioUrlList): audioUrlList *Optional* + audio_file_list (audioFileList): audioFileList *Optional* + external_audio_source (externalAudioSource): externalAudioSource *Optional* + video_message_source_selection (str): videoMessageSourceSelection *Optional* + video_url_list (videoUrlList): videoUrlList *Optional* + video_file_list (videoFileList): videoFileList *Optional* + external_video_source (externalVideoSource): externalVideoSource *Optional* """ __slots__: List[str] = [ - "name", - "audio_file", - "video_file", + "audio_message_source_selection", + "audio_url_list", + "audio_file_list", + "external_audio_source", + "video_message_source_selection", + "video_url_list", + "video_file_list", + "external_video_source", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("name", "name", str), - E("audio_file", "audioFile", LabeledMediaFileResource, is_complex=True), - E("video_file", "videoFile", LabeledMediaFileResource, is_complex=True), + E( + "audio_message_source_selection", + "audioMessageSourceSelection", + str, + is_required=True, + ), + E( + "audio_url_list", + "audioUrlList", + CallCenterAnnouncementURLList, + is_complex=True, + ), + E( + "audio_file_list", + "audioFileList", + CallCenterAnnouncementFileListRead20, + is_complex=True, + ), + E( + "external_audio_source", + "externalAudioSource", + AccessDeviceEndpointWithPortNumberRead, + is_complex=True, + ), + E("video_message_source_selection", "videoMessageSourceSelection", str), + E( + "video_url_list", + "videoUrlList", + CallCenterAnnouncementURLList, + is_complex=True, + ), + E( + "video_file_list", + "videoFileList", + CallCenterAnnouncementFileListRead20, + is_complex=True, + ), + E( + "external_video_source", + "externalVideoSource", + AccessDeviceEndpointWithPortNumberRead, + is_complex=True, + ), ) -class VoiceMessagingAlternateNoAnswerGreetingModify20(OCIType): +class CallCenterMediaOnHoldSourceRead22(OCIType): """ - The configuration of a alternate no answer greeting. + Contains the call center media on hold source configuration. - It is used when modifying a user's voice messaging greeting. Attributes: - name (str): name *Optional* - audio_file (audioFile): audioFile *Optional* - video_file (videoFile): videoFile *Optional* + audio_message_source_selection (str): audioMessageSourceSelection + audio_url_list (audioUrlList): audioUrlList *Optional* + audio_file_list (audioFileList): audioFileList *Optional* + external_audio_source (externalAudioSource): externalAudioSource *Optional* + video_message_source_selection (str): videoMessageSourceSelection *Optional* + video_url_list (videoUrlList): videoUrlList *Optional* + video_file_list (videoFileList): videoFileList *Optional* + external_video_source (externalVideoSource): externalVideoSource *Optional* """ __slots__: List[str] = [ - "name", - "audio_file", - "video_file", + "audio_message_source_selection", + "audio_url_list", + "audio_file_list", + "external_audio_source", + "video_message_source_selection", + "video_url_list", + "video_file_list", + "external_video_source", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("name", "name", str), - E("audio_file", "audioFile", AnnouncementFileLevelKey, is_complex=True), - E("video_file", "videoFile", AnnouncementFileLevelKey, is_complex=True), + E( + "audio_message_source_selection", + "audioMessageSourceSelection", + str, + is_required=True, + ), + E( + "audio_url_list", + "audioUrlList", + CallCenterAnnouncementURLList, + is_complex=True, + ), + E( + "audio_file_list", + "audioFileList", + CallCenterAnnouncementFileListRead20, + is_complex=True, + ), + E( + "external_audio_source", + "externalAudioSource", + AccessDeviceEndpointWithPortNumberRead22, + is_complex=True, + ), + E("video_message_source_selection", "videoMessageSourceSelection", str), + E( + "video_url_list", + "videoUrlList", + CallCenterAnnouncementURLList, + is_complex=True, + ), + E( + "video_file_list", + "videoFileList", + CallCenterAnnouncementFileListRead20, + is_complex=True, + ), + E( + "external_video_source", + "externalVideoSource", + AccessDeviceEndpointWithPortNumberRead22, + is_complex=True, + ), ) -class VoiceMessagingAlternateNoAnswerGreetingRead20(OCIType): +class CallCenterReportInterval(OCIType): """ - The configuration of a alternate no answer greeting. + Report interval for call center enhanced reporting scheduled reports. - It is used when geting a user's voice messaging greeting. Attributes: - name (str): name - audio_file (audioFile): audioFile *Optional* - video_file (videoFile): videoFile *Optional* + dates (dates): dates *Optional* + current (current): current *Optional* + past (past): past *Optional* """ __slots__: List[str] = [ - "name", - "audio_file", - "video_file", + "dates", + "current", + "past", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("name", "name", str, is_required=True), - E("audio_file", "audioFile", AnnouncementFileLevelKey, is_complex=True), - E("video_file", "videoFile", AnnouncementFileLevelKey, is_complex=True), + E("dates", "dates", CallCenterReportIntervalDates, is_complex=True), + E("current", "current", CallCenterReportCurrentInterval, is_complex=True), + E("past", "past", CallCenterReportPastInterval, is_complex=True), ) -class VoiceMessagingDistributionListModify(OCIType): +class CallCenterReportSchedule(OCIType): """ - A list of voice mail distribution lists It is used when setting a user's voice - messaging distribution lists + A schedule for call center enhanced reporting scheduled report. + + It can either be a fixed time schedule or recurring schedule Attributes: - list_id (int): listId - description (str): description *Optional* - phone_number_list (phoneNumberList): phoneNumberList *Optional* + schedule_time (scheduleTime): scheduleTime *Optional* + recurrence (recurrence): recurrence *Optional* """ __slots__: List[str] = [ - "list_id", - "description", - "phone_number_list", + "schedule_time", + "recurrence", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("list_id", "listId", int, is_required=True), - E("description", "description", str), E( - "phone_number_list", - "phoneNumberList", - ReplacementOutgoingDNorSIPURIList, + "schedule_time", + "scheduleTime", + CallCenterReportScheduleTime, + is_complex=True, + ), + E( + "recurrence", + "recurrence", + CallCenterReportScheduleRecurrence, is_complex=True, ), ) -class AccessDeviceMultipleContactEndpointModify22(OCIType): +class ConsolidatedGroupProperties(OCIType): """ - Access device end point used in the context of modify that can have more than one - contact defined. - - Only Static Registration capable devices may have more than one contact defined. Port - numbers are only used by devices with static line ordering. Attributes: - access_device (accessDevice): accessDevice *Optional* - line_port (str): linePort *Optional* - contact_list (contactList): contactList *Optional* - port_number (int): portNumber *Optional* + default_domain (str): defaultDomain + user_limit (int): userLimit + group_name (str): groupName *Optional* + calling_line_id_name (str): callingLineIdName *Optional* + time_zone (str): timeZone *Optional* + location_dialing_code (str): locationDialingCode *Optional* + contact (contact): contact *Optional* + address (address): address *Optional* + network_class_of_service (List[str]): networkClassOfService *Optional* + default_network_class_of_service (defaultNetworkClassOfService): + defaultNetworkClassOfService *Optional* + group_service (List[groupService]): groupService *Optional* + service_policy (str): servicePolicy *Optional* """ __slots__: List[str] = [ - "access_device", - "line_port", - "contact_list", - "port_number", + "default_domain", + "user_limit", + "group_name", + "calling_line_id_name", + "time_zone", + "location_dialing_code", + "contact", + "address", + "network_class_of_service", + "default_network_class_of_service", + "group_service", + "service_policy", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("access_device", "accessDevice", AccessDevice, is_complex=True), - E("line_port", "linePort", str), - E("contact_list", "contactList", ReplacementContactList22, is_complex=True), - E("port_number", "portNumber", int), + E("default_domain", "defaultDomain", str, is_required=True), + E("user_limit", "userLimit", int, is_required=True), + E("group_name", "groupName", str), + E("calling_line_id_name", "callingLineIdName", str), + E("time_zone", "timeZone", str), + E("location_dialing_code", "locationDialingCode", str), + E("contact", "contact", Contact, is_complex=True), + E("address", "address", StreetAddress, is_complex=True), + E("network_class_of_service", "networkClassOfService", str, is_array=True), + E( + "default_network_class_of_service", + "defaultNetworkClassOfService", + DefaultNetworkClassOfService, + is_complex=True, + ), + E( + "group_service", + "groupService", + ConsolidatedGroupServiceAssignment, + is_complex=True, + is_array=True, + ), + E("service_policy", "servicePolicy", str), ) -class AccessDeviceMultipleIdentityAndContactEndpointModify22(OCIType): +class EnhancedCallLogsNumberFilter(OCIType): """ - Access device end point used in the context of modify that can have more than one - contact defined. + Filter criteria based on the called number or number called. - The endpoint is identified by its linePort (public Identity) and possibly a private - Identity. Only Static Registration capable devices may have more than one contact - defined. Port numbers are only used by devices with static line ordering. The - following elements are only used in XS data mode and ignored in AS data mode: - privateIdentity The following elements are only used in AS data mode and ignored in XS - data mode: useHotline hotlineContact Attributes: - access_device (accessDevice): accessDevice *Optional* - line_port (str): linePort *Optional* - private_identity (str): privateIdentity *Optional* - contact_list (contactList): contactList *Optional* - port_number (int): portNumber *Optional* - use_hotline (bool): useHotline *Optional* - hotline_contact (str): hotlineContact *Optional* + include_basic_call_type (List[str]): includeBasicCallType *Optional* + include_call_category (List[str]): includeCallCategory *Optional* + include_configurable_call_type (List[str]): includeConfigurableCallType *Optional* + search_criteria_dialed_number (List[searchCriteriaDialedNumber]): + searchCriteriaDialedNumber *Optional* + search_criteria_called_number (List[searchCriteriaCalledNumber]): + searchCriteriaCalledNumber *Optional* + search_criteria_network_translated_number + (List[searchCriteriaNetworkTranslatedNumber]): + searchCriteriaNetworkTranslatedNumber *Optional* + search_criteria_calling_presentation_number + (List[searchCriteriaCallingPresentationNumber]): + searchCriteriaCallingPresentationNumber *Optional* """ __slots__: List[str] = [ - "access_device", - "line_port", - "private_identity", - "contact_list", - "port_number", - "use_hotline", - "hotline_contact", + "include_basic_call_type", + "include_call_category", + "include_configurable_call_type", + "search_criteria_dialed_number", + "search_criteria_called_number", + "search_criteria_network_translated_number", + "search_criteria_calling_presentation_number", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("access_device", "accessDevice", AccessDevice, is_complex=True), - E("line_port", "linePort", str), - E("private_identity", "privateIdentity", str), - E("contact_list", "contactList", ReplacementContactList22, is_complex=True), - E("port_number", "portNumber", int), - E("use_hotline", "useHotline", bool), - E("hotline_contact", "hotlineContact", str), + E("include_basic_call_type", "includeBasicCallType", str, is_array=True), + E("include_call_category", "includeCallCategory", str, is_array=True), + E( + "include_configurable_call_type", + "includeConfigurableCallType", + str, + is_array=True, + ), + E( + "search_criteria_dialed_number", + "searchCriteriaDialedNumber", + SearchCriteriaOutgoingDNorSIPURI, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_called_number", + "searchCriteriaCalledNumber", + SearchCriteriaOutgoingDNorSIPURI, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_network_translated_number", + "searchCriteriaNetworkTranslatedNumber", + SearchCriteriaOutgoingDNorSIPURI, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_calling_presentation_number", + "searchCriteriaCallingPresentationNumber", + SearchCriteriaOutgoingDNorSIPURI, + is_complex=True, + is_array=True, + ), ) -class AutoAttendantKeyConfiguration(OCIType): +class EnhancedCallLogsRedirectedNumberFilter(OCIType): """ - The configuration of a key for Auto Attendant. + Filter criteria based on the transferred/forwarded number. Attributes: - key (str): key - entry (entry): entry + redirected_call (redirectedCall): redirectedCall *Optional* + include_service_invocation_basic_call_type (List[str]): + includeServiceInvocationBasicCallType *Optional* + include_service_invocation_call_category (List[str]): + includeServiceInvocationCallCategory *Optional* + include_service_invocation_configurable_call_type (List[str]): + includeServiceInvocationConfigurableCallType *Optional* + search_criteria_service_invocation_dialed_number + (List[searchCriteriaServiceInvocationDialedNumber]): + searchCriteriaServiceInvocationDialedNumber *Optional* + search_criteria_service_invocation_called_number + (List[searchCriteriaServiceInvocationCalledNumber]): + searchCriteriaServiceInvocationCalledNumber *Optional* + search_criteria_service_invocation_network_translated_number + (List[searchCriteriaServiceInvocationNetworkTranslatedNumber]): + searchCriteriaServiceInvocationNetworkTranslatedNumber *Optional* """ __slots__: List[str] = [ - "key", - "entry", + "redirected_call", + "include_service_invocation_basic_call_type", + "include_service_invocation_call_category", + "include_service_invocation_configurable_call_type", + "search_criteria_service_invocation_dialed_number", + "search_criteria_service_invocation_called_number", + "search_criteria_service_invocation_network_translated_number", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("key", "key", str, is_required=True), E( - "entry", - "entry", - AutoAttendantKeyConfigurationEntry, + "redirected_call", + "redirectedCall", + EnhancedCallLogsRedirectedCallSelection, + is_complex=True, + ), + E( + "include_service_invocation_basic_call_type", + "includeServiceInvocationBasicCallType", + str, + is_array=True, + ), + E( + "include_service_invocation_call_category", + "includeServiceInvocationCallCategory", + str, + is_array=True, + ), + E( + "include_service_invocation_configurable_call_type", + "includeServiceInvocationConfigurableCallType", + str, + is_array=True, + ), + E( + "search_criteria_service_invocation_dialed_number", + "searchCriteriaServiceInvocationDialedNumber", + SearchCriteriaOutgoingDNorSIPURI, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_service_invocation_called_number", + "searchCriteriaServiceInvocationCalledNumber", + SearchCriteriaOutgoingDNorSIPURI, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_service_invocation_network_translated_number", + "searchCriteriaServiceInvocationNetworkTranslatedNumber", + SearchCriteriaOutgoingDNorSIPURI, is_complex=True, - is_required=True, + is_array=True, ), ) -class AutoAttendantKeyConfiguration19(OCIType): +class EnhancedCallLogsRedirectedNumberFilter20sp1(OCIType): """ - The configuration of a key for Auto Attendant. + Filter criteria based on the transferred/forwarded number. Attributes: - key (str): key - entry (entry): entry + redirected_call (redirectedCall): redirectedCall *Optional* + include_service_invocation_basic_call_type (List[str]): + includeServiceInvocationBasicCallType *Optional* + include_service_invocation_call_category (List[str]): + includeServiceInvocationCallCategory *Optional* + include_service_invocation_configurable_call_type (List[str]): + includeServiceInvocationConfigurableCallType *Optional* + search_criteria_service_invocation_dialed_number + (List[searchCriteriaServiceInvocationDialedNumber]): + searchCriteriaServiceInvocationDialedNumber *Optional* + search_criteria_service_invocation_called_number + (List[searchCriteriaServiceInvocationCalledNumber]): + searchCriteriaServiceInvocationCalledNumber *Optional* + search_criteria_service_invocation_network_translated_number + (List[searchCriteriaServiceInvocationNetworkTranslatedNumber]): + searchCriteriaServiceInvocationNetworkTranslatedNumber *Optional* """ __slots__: List[str] = [ - "key", - "entry", + "redirected_call", + "include_service_invocation_basic_call_type", + "include_service_invocation_call_category", + "include_service_invocation_configurable_call_type", + "search_criteria_service_invocation_dialed_number", + "search_criteria_service_invocation_called_number", + "search_criteria_service_invocation_network_translated_number", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("key", "key", str, is_required=True), E( - "entry", - "entry", - AutoAttendantKeyConfigurationEntry19, + "redirected_call", + "redirectedCall", + EnhancedCallLogsRedirectedCallSelection20sp1, is_complex=True, - is_required=True, ), - ) - - -class AutoAttendantKeyConfiguration20(OCIType): - """ - The configuration of a key for Auto Attendant. - - - Attributes: - key (str): key - entry (entry): entry - """ - - __slots__: List[str] = [ - "key", - "entry", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("key", "key", str, is_required=True), E( - "entry", - "entry", - AutoAttendantKeyConfigurationEntry20, + "include_service_invocation_basic_call_type", + "includeServiceInvocationBasicCallType", + str, + is_array=True, + ), + E( + "include_service_invocation_call_category", + "includeServiceInvocationCallCategory", + str, + is_array=True, + ), + E( + "include_service_invocation_configurable_call_type", + "includeServiceInvocationConfigurableCallType", + str, + is_array=True, + ), + E( + "search_criteria_service_invocation_dialed_number", + "searchCriteriaServiceInvocationDialedNumber", + SearchCriteriaOutgoingDNorSIPURI, is_complex=True, - is_required=True, + is_array=True, + ), + E( + "search_criteria_service_invocation_called_number", + "searchCriteriaServiceInvocationCalledNumber", + SearchCriteriaOutgoingDNorSIPURI, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_service_invocation_network_translated_number", + "searchCriteriaServiceInvocationNetworkTranslatedNumber", + SearchCriteriaOutgoingDNorSIPURI, + is_complex=True, + is_array=True, ), ) -class AutoAttendantKeyModifyConfiguration(OCIType): +class EnhancedCallLogsRedirectedNumberFilter21(OCIType): """ - The modify configuration of a key for Auto Attendant. + Filter criteria based on the transferred/forwarded number. Attributes: - key (str): key - entry (entry): entry + redirected_call (redirectedCall): redirectedCall *Optional* + include_service_invocation_basic_call_type (List[str]): + includeServiceInvocationBasicCallType *Optional* + include_service_invocation_call_category (List[str]): + includeServiceInvocationCallCategory *Optional* + include_service_invocation_configurable_call_type (List[str]): + includeServiceInvocationConfigurableCallType *Optional* + search_criteria_service_invocation_dialed_number + (List[searchCriteriaServiceInvocationDialedNumber]): + searchCriteriaServiceInvocationDialedNumber *Optional* + search_criteria_service_invocation_called_number + (List[searchCriteriaServiceInvocationCalledNumber]): + searchCriteriaServiceInvocationCalledNumber *Optional* + search_criteria_service_invocation_network_translated_number + (List[searchCriteriaServiceInvocationNetworkTranslatedNumber]): + searchCriteriaServiceInvocationNetworkTranslatedNumber *Optional* """ __slots__: List[str] = [ - "key", - "entry", + "redirected_call", + "include_service_invocation_basic_call_type", + "include_service_invocation_call_category", + "include_service_invocation_configurable_call_type", + "search_criteria_service_invocation_dialed_number", + "search_criteria_service_invocation_called_number", + "search_criteria_service_invocation_network_translated_number", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("key", "key", str, is_required=True), E( - "entry", - "entry", - AutoAttendantKeyConfigurationModifyEntry, + "redirected_call", + "redirectedCall", + EnhancedCallLogsRedirectedCallSelection21, is_complex=True, - is_required=True, + ), + E( + "include_service_invocation_basic_call_type", + "includeServiceInvocationBasicCallType", + str, + is_array=True, + ), + E( + "include_service_invocation_call_category", + "includeServiceInvocationCallCategory", + str, + is_array=True, + ), + E( + "include_service_invocation_configurable_call_type", + "includeServiceInvocationConfigurableCallType", + str, + is_array=True, + ), + E( + "search_criteria_service_invocation_dialed_number", + "searchCriteriaServiceInvocationDialedNumber", + SearchCriteriaOutgoingDNorSIPURI, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_service_invocation_called_number", + "searchCriteriaServiceInvocationCalledNumber", + SearchCriteriaOutgoingDNorSIPURI, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_service_invocation_network_translated_number", + "searchCriteriaServiceInvocationNetworkTranslatedNumber", + SearchCriteriaOutgoingDNorSIPURI, + is_complex=True, + is_array=True, ), ) -class AutoAttendantKeyModifyConfiguration20(OCIType): +class EnhancedCallLogsRedirectedNumberFilter21sp1(OCIType): """ - The modify configuration of a key for Auto Attendant. + Filter criteria based on the transferred/forwarded number. Attributes: - key (str): key - entry (entry): entry + redirected_call (redirectedCall): redirectedCall *Optional* + include_service_invocation_basic_call_type (List[str]): + includeServiceInvocationBasicCallType *Optional* + include_service_invocation_call_category (List[str]): + includeServiceInvocationCallCategory *Optional* + include_service_invocation_configurable_call_type (List[str]): + includeServiceInvocationConfigurableCallType *Optional* + search_criteria_service_invocation_dialed_number + (List[searchCriteriaServiceInvocationDialedNumber]): + searchCriteriaServiceInvocationDialedNumber *Optional* + search_criteria_service_invocation_called_number + (List[searchCriteriaServiceInvocationCalledNumber]): + searchCriteriaServiceInvocationCalledNumber *Optional* + search_criteria_service_invocation_network_translated_number + (List[searchCriteriaServiceInvocationNetworkTranslatedNumber]): + searchCriteriaServiceInvocationNetworkTranslatedNumber *Optional* """ __slots__: List[str] = [ - "key", - "entry", + "redirected_call", + "include_service_invocation_basic_call_type", + "include_service_invocation_call_category", + "include_service_invocation_configurable_call_type", + "search_criteria_service_invocation_dialed_number", + "search_criteria_service_invocation_called_number", + "search_criteria_service_invocation_network_translated_number", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("key", "key", str, is_required=True), E( - "entry", - "entry", - AutoAttendantKeyConfigurationModifyEntry20, + "redirected_call", + "redirectedCall", + EnhancedCallLogsRedirectedCallSelection21sp1, is_complex=True, - is_required=True, + ), + E( + "include_service_invocation_basic_call_type", + "includeServiceInvocationBasicCallType", + str, + is_array=True, + ), + E( + "include_service_invocation_call_category", + "includeServiceInvocationCallCategory", + str, + is_array=True, + ), + E( + "include_service_invocation_configurable_call_type", + "includeServiceInvocationConfigurableCallType", + str, + is_array=True, + ), + E( + "search_criteria_service_invocation_dialed_number", + "searchCriteriaServiceInvocationDialedNumber", + SearchCriteriaOutgoingDNorSIPURI, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_service_invocation_called_number", + "searchCriteriaServiceInvocationCalledNumber", + SearchCriteriaOutgoingDNorSIPURI, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_service_invocation_network_translated_number", + "searchCriteriaServiceInvocationNetworkTranslatedNumber", + SearchCriteriaOutgoingDNorSIPURI, + is_complex=True, + is_array=True, ), ) -class AutoAttendantKeyReadConfiguration20(OCIType): +class EnhancedCallLogsRedirectedNumberFilter23(OCIType): """ - The read configuration of a key for Auto Attendant. + Filter criteria based on the transferred/forwarded number. Attributes: - key (str): key - entry (entry): entry + redirected_call (redirectedCall): redirectedCall *Optional* + include_service_invocation_basic_call_type (List[str]): + includeServiceInvocationBasicCallType *Optional* + include_service_invocation_call_category (List[str]): + includeServiceInvocationCallCategory *Optional* + include_service_invocation_configurable_call_type (List[str]): + includeServiceInvocationConfigurableCallType *Optional* + search_criteria_service_invocation_dialed_number + (List[searchCriteriaServiceInvocationDialedNumber]): + searchCriteriaServiceInvocationDialedNumber *Optional* + search_criteria_service_invocation_called_number + (List[searchCriteriaServiceInvocationCalledNumber]): + searchCriteriaServiceInvocationCalledNumber *Optional* + search_criteria_service_invocation_network_translated_number + (List[searchCriteriaServiceInvocationNetworkTranslatedNumber]): + searchCriteriaServiceInvocationNetworkTranslatedNumber *Optional* """ __slots__: List[str] = [ - "key", - "entry", + "redirected_call", + "include_service_invocation_basic_call_type", + "include_service_invocation_call_category", + "include_service_invocation_configurable_call_type", + "search_criteria_service_invocation_dialed_number", + "search_criteria_service_invocation_called_number", + "search_criteria_service_invocation_network_translated_number", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("key", "key", str, is_required=True), E( - "entry", - "entry", - AutoAttendantKeyConfigurationReadEntry20, + "redirected_call", + "redirectedCall", + EnhancedCallLogsRedirectedCallSelection23, is_complex=True, - is_required=True, + ), + E( + "include_service_invocation_basic_call_type", + "includeServiceInvocationBasicCallType", + str, + is_array=True, + ), + E( + "include_service_invocation_call_category", + "includeServiceInvocationCallCategory", + str, + is_array=True, + ), + E( + "include_service_invocation_configurable_call_type", + "includeServiceInvocationConfigurableCallType", + str, + is_array=True, + ), + E( + "search_criteria_service_invocation_dialed_number", + "searchCriteriaServiceInvocationDialedNumber", + SearchCriteriaOutgoingDNorSIPURI, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_service_invocation_called_number", + "searchCriteriaServiceInvocationCalledNumber", + SearchCriteriaOutgoingDNorSIPURI, + is_complex=True, + is_array=True, + ), + E( + "search_criteria_service_invocation_network_translated_number", + "searchCriteriaServiceInvocationNetworkTranslatedNumber", + SearchCriteriaOutgoingDNorSIPURI, + is_complex=True, + is_array=True, ), ) -class AutoAttendantReadMenu19(OCIType): +class EnterpriseSessionAdmissionControlGroupGetResponse21sp1V2(OCIType): """ - The configuration of the automated receptionist greeting prompt and dialing menu to be - used during after business hours. + Response to EnterpriseSessionAdmissionControlGroupGetRequest21sp1V2. + Returns the profile information for the session admission control group. Attributes: - announcement_selection (str): announcementSelection - audio_file_description (str): audioFileDescription *Optional* - audio_media_type (str): audioMediaType *Optional* - video_file_description (str): videoFileDescription *Optional* - video_media_type (str): videoMediaType *Optional* - enable_first_menu_level_extension_dialing (bool): - enableFirstMenuLevelExtensionDialing - key_configuration (List[keyConfiguration]): keyConfiguration *Optional* + max_session (int): maxSession + max_user_originating_sessions (int): maxUserOriginatingSessions *Optional* + max_user_terminating_sessions (int): maxUserTerminatingSessions *Optional* + reserved_session (int): reservedSession + reserved_user_originating_sessions (int): reservedUserOriginatingSessions + *Optional* + reserved_user_terminating_sessions (int): reservedUserTerminatingSessions + *Optional* + default_group (bool): defaultGroup + count_intra_sac_group_sessions (bool): countIntraSACGroupSessions + devices (List[devices]): devices *Optional* + block_emergency_and_repair_calls_due_to_sac_limits (bool): + blockEmergencyAndRepairCallsDueToSACLimits + media_group_name (str): mediaGroupName *Optional* + access_info_pattern (str): accessInfoPattern *Optional* """ __slots__: List[str] = [ - "announcement_selection", - "audio_file_description", - "audio_media_type", - "video_file_description", - "video_media_type", - "enable_first_menu_level_extension_dialing", - "key_configuration", + "max_session", + "max_user_originating_sessions", + "max_user_terminating_sessions", + "reserved_session", + "reserved_user_originating_sessions", + "reserved_user_terminating_sessions", + "default_group", + "count_intra_sac_group_sessions", + "devices", + "block_emergency_and_repair_calls_due_to_sac_limits", + "media_group_name", + "access_info_pattern", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("announcement_selection", "announcementSelection", str, is_required=True), - E("audio_file_description", "audioFileDescription", str), - E("audio_media_type", "audioMediaType", str), - E("video_file_description", "videoFileDescription", str), - E("video_media_type", "videoMediaType", str), + E("max_session", "maxSession", int, is_required=True), + E("max_user_originating_sessions", "maxUserOriginatingSessions", int), + E("max_user_terminating_sessions", "maxUserTerminatingSessions", int), + E("reserved_session", "reservedSession", int, is_required=True), E( - "enable_first_menu_level_extension_dialing", - "enableFirstMenuLevelExtensionDialing", + "reserved_user_originating_sessions", + "reservedUserOriginatingSessions", + int, + ), + E( + "reserved_user_terminating_sessions", + "reservedUserTerminatingSessions", + int, + ), + E("default_group", "defaultGroup", bool, is_required=True), + E( + "count_intra_sac_group_sessions", + "countIntraSACGroupSessions", bool, is_required=True, ), E( - "key_configuration", - "keyConfiguration", - AutoAttendantKeyReadConfiguration19, + "devices", + "devices", + EnterpriseAccessDevice, is_complex=True, is_array=True, ), + E( + "block_emergency_and_repair_calls_due_to_sac_limits", + "blockEmergencyAndRepairCallsDueToSACLimits", + bool, + is_required=True, + ), + E("media_group_name", "mediaGroupName", str), + E("access_info_pattern", "accessInfoPattern", str), ) -class CPEDeviceModifyOptions(OCIType): +class GroupHuntGroupAddInstanceRequest17sp1V1(OCIType): """ - CPE device's options when used with a modify request. + Add a Hunt Group instance to a group. - The following options are not changeable: configType systemFileName deviceFileFormat + The domain is required in the serviceUserId. + + The response is either `SuccessResponse()` or `ErrorResponse()`. The following + elements are only used in XS data mode: allowMembersToControlGroupBusy, use value + "false" in AS data mode enableGroupBusy, use value "false" in AS data mode Attributes: - enable_monitoring (bool): enableMonitoring *Optional* - reset_event (str): resetEvent *Optional* - device_management_device_type_options (deviceManagementDeviceTypeOptions): - deviceManagementDeviceTypeOptions *Optional* + service_provider_id (str): serviceProviderId + group_id (str): groupId + service_user_id (str): serviceUserId + service_instance_profile (serviceInstanceProfile): serviceInstanceProfile + policy (str): policy + hunt_after_no_answer (bool): huntAfterNoAnswer + no_answer_number_of_rings (int): noAnswerNumberOfRings + forward_after_timeout (bool): forwardAfterTimeout + forward_timeout_seconds (int): forwardTimeoutSeconds + forward_to_phone_number (str): forwardToPhoneNumber *Optional* + agent_user_id (List[str]): agentUserId *Optional* + allow_call_waiting_for_agents (bool): allowCallWaitingForAgents + allow_members_to_control_group_busy (bool): allowMembersToControlGroupBusy + enable_group_busy (bool): enableGroupBusy """ __slots__: List[str] = [ - "enable_monitoring", - "reset_event", - "device_management_device_type_options", + "service_provider_id", + "group_id", + "service_user_id", + "service_instance_profile", + "policy", + "hunt_after_no_answer", + "no_answer_number_of_rings", + "forward_after_timeout", + "forward_timeout_seconds", + "forward_to_phone_number", + "agent_user_id", + "allow_call_waiting_for_agents", + "allow_members_to_control_group_busy", + "enable_group_busy", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("enable_monitoring", "enableMonitoring", bool), - E("reset_event", "resetEvent", str), + E("service_provider_id", "serviceProviderId", str, is_required=True), + E("group_id", "groupId", str, is_required=True), + E("service_user_id", "serviceUserId", str, is_required=True), E( - "device_management_device_type_options", - "deviceManagementDeviceTypeOptions", - DeviceManagementDeviceTypeModifyOptions, + "service_instance_profile", + "serviceInstanceProfile", + ServiceInstanceAddProfile, is_complex=True, + is_required=True, + ), + E("policy", "policy", str, is_required=True), + E("hunt_after_no_answer", "huntAfterNoAnswer", bool, is_required=True), + E( + "no_answer_number_of_rings", + "noAnswerNumberOfRings", + int, + is_required=True, + ), + E("forward_after_timeout", "forwardAfterTimeout", bool, is_required=True), + E( + "forward_timeout_seconds", + "forwardTimeoutSeconds", + int, + is_required=True, + ), + E("forward_to_phone_number", "forwardToPhoneNumber", str), + E("agent_user_id", "agentUserId", str, is_array=True), + E( + "allow_call_waiting_for_agents", + "allowCallWaitingForAgents", + bool, + is_required=True, + ), + E( + "allow_members_to_control_group_busy", + "allowMembersToControlGroupBusy", + bool, + is_required=True, ), + E("enable_group_busy", "enableGroupBusy", bool, is_required=True), ) -class CPEDeviceModifyOptions16(OCIType): +class GroupHuntGroupGetInstanceResponse17sp1V1(OCIType): """ - CPE device's options when used with a modify request. + Response to GroupHuntGroupGetInstanceRequest17sp1V1. - The following options are not changeable: configType systemFileName deviceFileFormat + Contains the service profile information and a table of assigned users. The table has + column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana + First Name", "Weight". The following elements are only used in XS data mode: + allowMembersToControlGroupBusy enableGroupBusy Attributes: - enable_monitoring (bool): enableMonitoring *Optional* - reset_event (str): resetEvent *Optional* - device_management_device_type_options (deviceManagementDeviceTypeOptions): - deviceManagementDeviceTypeOptions *Optional* + service_instance_profile (serviceInstanceProfile): serviceInstanceProfile + policy (str): policy + hunt_after_no_answer (bool): huntAfterNoAnswer + no_answer_number_of_rings (int): noAnswerNumberOfRings + forward_after_timeout (bool): forwardAfterTimeout + forward_timeout_seconds (int): forwardTimeoutSeconds + forward_to_phone_number (str): forwardToPhoneNumber *Optional* + agent_user_table (List(agentUserTable)): agentUserTable - *Table* array of + agentUserTable named tuples + allow_call_waiting_for_agents (bool): allowCallWaitingForAgents + allow_members_to_control_group_busy (bool): allowMembersToControlGroupBusy + enable_group_busy (bool): enableGroupBusy """ __slots__: List[str] = [ - "enable_monitoring", - "reset_event", - "device_management_device_type_options", + "service_instance_profile", + "policy", + "hunt_after_no_answer", + "no_answer_number_of_rings", + "forward_after_timeout", + "forward_timeout_seconds", + "forward_to_phone_number", + "agent_user_table", + "allow_call_waiting_for_agents", + "allow_members_to_control_group_busy", + "enable_group_busy", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("enable_monitoring", "enableMonitoring", bool), - E("reset_event", "resetEvent", str), E( - "device_management_device_type_options", - "deviceManagementDeviceTypeOptions", - DeviceManagementDeviceTypeModifyOptions16, + "service_instance_profile", + "serviceInstanceProfile", + ServiceInstanceReadProfile17, + is_complex=True, + is_required=True, + ), + E("policy", "policy", str, is_required=True), + E("hunt_after_no_answer", "huntAfterNoAnswer", bool, is_required=True), + E( + "no_answer_number_of_rings", + "noAnswerNumberOfRings", + int, + is_required=True, + ), + E("forward_after_timeout", "forwardAfterTimeout", bool, is_required=True), + E( + "forward_timeout_seconds", + "forwardTimeoutSeconds", + int, + is_required=True, + ), + E("forward_to_phone_number", "forwardToPhoneNumber", str), + E( + "agent_user_table", + "agentUserTable", + list, is_complex=True, + is_required=True, + is_table=True, + ), + E( + "allow_call_waiting_for_agents", + "allowCallWaitingForAgents", + bool, + is_required=True, + ), + E( + "allow_members_to_control_group_busy", + "allowMembersToControlGroupBusy", + bool, + is_required=True, ), + E("enable_group_busy", "enableGroupBusy", bool, is_required=True), ) -class CPEDeviceModifyOptions16sp1(OCIType): +class GroupTrunkGroupAddInstanceRequest14sp9A(OCIType): """ - CPE device's options when used with a modify request. + Add a Trunk Group instance to a group. - The following options are not changeable: configType systemFileName deviceFileFormat + The response is either a `SuccessResponse()` or an `ErrorResponse()`. Attributes: - enable_monitoring (bool): enableMonitoring *Optional* - device_management_device_type_options (deviceManagementDeviceTypeOptions): - deviceManagementDeviceTypeOptions *Optional* + service_provider_id (str): serviceProviderId + group_id (str): groupId + name (str): name + pilot_user (pilotUser): pilotUser *Optional* + department (department): department *Optional* + access_device (accessDevice): accessDevice *Optional* + max_active_calls (int): maxActiveCalls + max_incoming_calls (int): maxIncomingCalls *Optional* + max_outgoing_calls (int): maxOutgoingCalls *Optional* + enable_bursting (bool): enableBursting + bursting_max_active_calls (int): burstingMaxActiveCalls *Optional* + bursting_max_incoming_calls (int): burstingMaxIncomingCalls *Optional* + bursting_max_outgoing_calls (int): burstingMaxOutgoingCalls *Optional* + capacity_exceeded_action (str): capacityExceededAction *Optional* + capacity_exceeded_forward_address (str): capacityExceededForwardAddress *Optional* + capacity_exceeded_reroute_trunk_group_key (capacityExceededRerouteTrunkGroupKey): + capacityExceededRerouteTrunkGroupKey *Optional* + capacity_exceeded_trap_initial_calls (int): capacityExceededTrapInitialCalls + capacity_exceeded_trap_offset_calls (int): capacityExceededTrapOffsetCalls + unreachable_destination_action (str): unreachableDestinationAction *Optional* + unreachable_destination_forward_address (str): + unreachableDestinationForwardAddress *Optional* + unreachable_destination_reroute_trunk_group_key + (unreachableDestinationRerouteTrunkGroupKey): + unreachableDestinationRerouteTrunkGroupKey *Optional* + unreachable_destination_trap_initial_calls (int): + unreachableDestinationTrapInitialCalls + unreachable_destination_trap_offset_calls (int): + unreachableDestinationTrapOffsetCalls + invitation_timeout (int): invitationTimeout + require_authentication (bool): requireAuthentication + sip_authentication_user_name (str): sipAuthenticationUserName *Optional* + sip_authentication_password (str): sipAuthenticationPassword *Optional* + hosted_user_id (List[str]): hostedUserId *Optional* + trunk_group_identity (str): trunkGroupIdentity *Optional* + otg_dtg_identity (str): otgDtgIdentity *Optional* + include_trunk_group_identity (bool): includeTrunkGroupIdentity + include_dtg_identity (bool): includeDtgIdentity + enable_network_address_identity (bool): enableNetworkAddressIdentity + allow_unscreened_calls (bool): allowUnscreenedCalls + allow_unscreened_emergency_calls (bool): allowUnscreenedEmergencyCalls + pilot_user_calling_line_identity_policy (str): pilotUserCallingLineIdentityPolicy + pilot_user_charge_number_policy (str): pilotUserChargeNumberPolicy + call_forwarding_always_action (str): callForwardingAlwaysAction *Optional* + call_forwarding_always_forward_address (str): callForwardingAlwaysForwardAddress + *Optional* + call_forwarding_always_reroute_trunk_group_key + (callForwardingAlwaysRerouteTrunkGroupKey): + callForwardingAlwaysRerouteTrunkGroupKey *Optional* """ __slots__: List[str] = [ - "enable_monitoring", - "device_management_device_type_options", + "service_provider_id", + "group_id", + "name", + "pilot_user", + "department", + "access_device", + "max_active_calls", + "max_incoming_calls", + "max_outgoing_calls", + "enable_bursting", + "bursting_max_active_calls", + "bursting_max_incoming_calls", + "bursting_max_outgoing_calls", + "capacity_exceeded_action", + "capacity_exceeded_forward_address", + "capacity_exceeded_reroute_trunk_group_key", + "capacity_exceeded_trap_initial_calls", + "capacity_exceeded_trap_offset_calls", + "unreachable_destination_action", + "unreachable_destination_forward_address", + "unreachable_destination_reroute_trunk_group_key", + "unreachable_destination_trap_initial_calls", + "unreachable_destination_trap_offset_calls", + "invitation_timeout", + "require_authentication", + "sip_authentication_user_name", + "sip_authentication_password", + "hosted_user_id", + "trunk_group_identity", + "otg_dtg_identity", + "include_trunk_group_identity", + "include_dtg_identity", + "enable_network_address_identity", + "allow_unscreened_calls", + "allow_unscreened_emergency_calls", + "pilot_user_calling_line_identity_policy", + "pilot_user_charge_number_policy", + "call_forwarding_always_action", + "call_forwarding_always_forward_address", + "call_forwarding_always_reroute_trunk_group_key", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("enable_monitoring", "enableMonitoring", bool), + E("service_provider_id", "serviceProviderId", str, is_required=True), + E("group_id", "groupId", str, is_required=True), + E("name", "name", str, is_required=True), + E("pilot_user", "pilotUser", TrunkGroupPilotUser, is_complex=True), + E("department", "department", DepartmentKey, is_complex=True), + E("access_device", "accessDevice", AccessDevice, is_complex=True), + E("max_active_calls", "maxActiveCalls", int, is_required=True), + E("max_incoming_calls", "maxIncomingCalls", int), + E("max_outgoing_calls", "maxOutgoingCalls", int), + E("enable_bursting", "enableBursting", bool, is_required=True), + E("bursting_max_active_calls", "burstingMaxActiveCalls", int), + E("bursting_max_incoming_calls", "burstingMaxIncomingCalls", int), + E("bursting_max_outgoing_calls", "burstingMaxOutgoingCalls", int), + E("capacity_exceeded_action", "capacityExceededAction", str), E( - "device_management_device_type_options", - "deviceManagementDeviceTypeOptions", - DeviceManagementDeviceTypeModifyOptions16, + "capacity_exceeded_forward_address", + "capacityExceededForwardAddress", + str, + ), + E( + "capacity_exceeded_reroute_trunk_group_key", + "capacityExceededRerouteTrunkGroupKey", + TrunkGroupKey, + is_complex=True, + ), + E( + "capacity_exceeded_trap_initial_calls", + "capacityExceededTrapInitialCalls", + int, + is_required=True, + ), + E( + "capacity_exceeded_trap_offset_calls", + "capacityExceededTrapOffsetCalls", + int, + is_required=True, + ), + E("unreachable_destination_action", "unreachableDestinationAction", str), + E( + "unreachable_destination_forward_address", + "unreachableDestinationForwardAddress", + str, + ), + E( + "unreachable_destination_reroute_trunk_group_key", + "unreachableDestinationRerouteTrunkGroupKey", + TrunkGroupKey, + is_complex=True, + ), + E( + "unreachable_destination_trap_initial_calls", + "unreachableDestinationTrapInitialCalls", + int, + is_required=True, + ), + E( + "unreachable_destination_trap_offset_calls", + "unreachableDestinationTrapOffsetCalls", + int, + is_required=True, + ), + E("invitation_timeout", "invitationTimeout", int, is_required=True), + E( + "require_authentication", + "requireAuthentication", + bool, + is_required=True, + ), + E("sip_authentication_user_name", "sipAuthenticationUserName", str), + E("sip_authentication_password", "sipAuthenticationPassword", str), + E("hosted_user_id", "hostedUserId", str, is_array=True), + E("trunk_group_identity", "trunkGroupIdentity", str), + E("otg_dtg_identity", "otgDtgIdentity", str), + E( + "include_trunk_group_identity", + "includeTrunkGroupIdentity", + bool, + is_required=True, + ), + E("include_dtg_identity", "includeDtgIdentity", bool, is_required=True), + E( + "enable_network_address_identity", + "enableNetworkAddressIdentity", + bool, + is_required=True, + ), + E("allow_unscreened_calls", "allowUnscreenedCalls", bool, is_required=True), + E( + "allow_unscreened_emergency_calls", + "allowUnscreenedEmergencyCalls", + bool, + is_required=True, + ), + E( + "pilot_user_calling_line_identity_policy", + "pilotUserCallingLineIdentityPolicy", + str, + is_required=True, + ), + E( + "pilot_user_charge_number_policy", + "pilotUserChargeNumberPolicy", + str, + is_required=True, + ), + E("call_forwarding_always_action", "callForwardingAlwaysAction", str), + E( + "call_forwarding_always_forward_address", + "callForwardingAlwaysForwardAddress", + str, + ), + E( + "call_forwarding_always_reroute_trunk_group_key", + "callForwardingAlwaysRerouteTrunkGroupKey", + TrunkGroupKey, is_complex=True, ), ) -class CPEDeviceModifyOptions22(OCIType): +class OutgoingCallingPlanDigitPatternCallMeNowDepartmentPermissions(OCIType): """ - CPE device's options when used with a modify request. + Outgoing Calling Plan Call Me Now call permissions for specified digit patterns. - The following options are not changeable: configType systemFileName deviceFileFormat Attributes: - enable_monitoring (bool): enableMonitoring *Optional* - device_management_device_type_options (deviceManagementDeviceTypeOptions): - deviceManagementDeviceTypeOptions *Optional* + department_key (departmentKey): departmentKey + department_name (str): departmentName + digit_pattern_permissions (digitPatternPermissions): digitPatternPermissions """ __slots__: List[str] = [ - "enable_monitoring", - "device_management_device_type_options", + "department_key", + "department_name", + "digit_pattern_permissions", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("enable_monitoring", "enableMonitoring", bool), E( - "device_management_device_type_options", - "deviceManagementDeviceTypeOptions", - DeviceManagementDeviceTypeModifyOptions22, + "department_key", + "departmentKey", + DepartmentKey, + is_complex=True, + is_required=True, + ), + E("department_name", "departmentName", str, is_required=True), + E( + "digit_pattern_permissions", + "digitPatternPermissions", + OutgoingCallingPlanDigitPatternCallMeNowPermissions, is_complex=True, + is_required=True, ), ) -class CPEDeviceOptions14sp6(OCIType): +class OutgoingCallingPlanDigitPatternCallMeNowDepartmentPermissionsModify(OCIType): """ - CPE device's options. + Modify outgoing Calling Plan Call Me Now call permissions for specified digit + patterns. Attributes: - enable_monitoring (bool): enableMonitoring - reset_event (str): resetEvent *Optional* - config_type (str): configType - system_file_name (str): systemFileName *Optional* - device_file_format (str): deviceFileFormat *Optional* - device_management_device_type_options (deviceManagementDeviceTypeOptions): - deviceManagementDeviceTypeOptions *Optional* + department_key (departmentKey): departmentKey + digit_pattern_permissions (digitPatternPermissions): digitPatternPermissions """ __slots__: List[str] = [ - "enable_monitoring", - "reset_event", - "config_type", - "system_file_name", - "device_file_format", - "device_management_device_type_options", + "department_key", + "digit_pattern_permissions", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("enable_monitoring", "enableMonitoring", bool, is_required=True), - E("reset_event", "resetEvent", str), - E("config_type", "configType", str, is_required=True), - E("system_file_name", "systemFileName", str), - E("device_file_format", "deviceFileFormat", str), E( - "device_management_device_type_options", - "deviceManagementDeviceTypeOptions", - DeviceManagementDeviceTypeOptions, + "department_key", + "departmentKey", + DepartmentKey, + is_complex=True, + is_required=True, + ), + E( + "digit_pattern_permissions", + "digitPatternPermissions", + OutgoingCallingPlanDigitPatternCallMeNowPermissions, is_complex=True, + is_required=True, ), ) -class CPEDeviceOptions16(OCIType): +class OutgoingCallingPlanDigitPatternOriginatingDepartmentPermissions(OCIType): """ - CPE device's options. + Outgoing Calling Plan originating call permissions for specified digit patterns. Attributes: - enable_monitoring (bool): enableMonitoring - reset_event (str): resetEvent *Optional* - config_type (str): configType - system_file_name (str): systemFileName *Optional* - device_file_format (str): deviceFileFormat *Optional* - device_management_device_type_options (deviceManagementDeviceTypeOptions): - deviceManagementDeviceTypeOptions *Optional* + department_key (departmentKey): departmentKey + department_name (str): departmentName + digit_pattern_permissions (digitPatternPermissions): digitPatternPermissions """ __slots__: List[str] = [ - "enable_monitoring", - "reset_event", - "config_type", - "system_file_name", - "device_file_format", - "device_management_device_type_options", + "department_key", + "department_name", + "digit_pattern_permissions", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("enable_monitoring", "enableMonitoring", bool, is_required=True), - E("reset_event", "resetEvent", str), - E("config_type", "configType", str, is_required=True), - E("system_file_name", "systemFileName", str), - E("device_file_format", "deviceFileFormat", str), E( - "device_management_device_type_options", - "deviceManagementDeviceTypeOptions", - DeviceManagementDeviceTypeOptions16, + "department_key", + "departmentKey", + DepartmentKey, is_complex=True, + is_required=True, + ), + E("department_name", "departmentName", str, is_required=True), + E( + "digit_pattern_permissions", + "digitPatternPermissions", + OutgoingCallingPlanDigitPatternOriginatingPermissions, + is_complex=True, + is_required=True, ), ) -class CPEDeviceOptions16sp1(OCIType): +class OutgoingCallingPlanDigitPatternOriginatingDepartmentPermissionsModify(OCIType): """ - CPE device's options. + Modify outgoing Calling Plan originating call permissions for specified digit + patterns. - The field configType is optional to allow the use of field enableMonitoring for all - device types being managed or not ie. device configuration option equals to - DeviceManagement, or Legacy, or Not Supported). If the device configuration option is - set to "Not Supported", the value of configType is forced set to "None" regardless of - its current value. It is not allowed to add a device type with device configuration - option set to Device Management or Legacy when the configType is not set. Attributes: - enable_monitoring (bool): enableMonitoring - config_type (str): configType *Optional* - system_file_name (str): systemFileName *Optional* - device_file_format (str): deviceFileFormat *Optional* - device_management_device_type_options (deviceManagementDeviceTypeOptions): - deviceManagementDeviceTypeOptions *Optional* + department_key (departmentKey): departmentKey + digit_pattern_permissions (digitPatternPermissions): digitPatternPermissions """ __slots__: List[str] = [ - "enable_monitoring", - "config_type", - "system_file_name", - "device_file_format", - "device_management_device_type_options", + "department_key", + "digit_pattern_permissions", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("enable_monitoring", "enableMonitoring", bool, is_required=True), - E("config_type", "configType", str), - E("system_file_name", "systemFileName", str), - E("device_file_format", "deviceFileFormat", str), E( - "device_management_device_type_options", - "deviceManagementDeviceTypeOptions", - DeviceManagementDeviceTypeOptions16, + "department_key", + "departmentKey", + DepartmentKey, + is_complex=True, + is_required=True, + ), + E( + "digit_pattern_permissions", + "digitPatternPermissions", + OutgoingCallingPlanDigitPatternOriginatingPermissions, is_complex=True, + is_required=True, ), ) -class CPEDeviceOptions21sp1(OCIType): +class OutgoingCallingPlanDigitPatternRedirectingDepartmentPermissions(OCIType): """ - CPE device's options. + Outgoing Calling Plan redirecting call permissions for specified digit patterns. - The field configType is optional to allow the use of field enableMonitoring for all - device types being managed or not ie. device configuration option equals to - DeviceManagement, or Legacy, or Not Supported). If the device configuration option is - set to "Not Supported", the value of configType is forced set to "None" regardless of - its current value. It is not allowed to add a device type with device configuration - option set to Device Management or Legacy when the configType is not set. Attributes: - enable_monitoring (bool): enableMonitoring - config_type (str): configType *Optional* - system_file_name (str): systemFileName *Optional* - device_file_format (str): deviceFileFormat *Optional* - device_management_device_type_options (deviceManagementDeviceTypeOptions): - deviceManagementDeviceTypeOptions *Optional* + department_key (departmentKey): departmentKey + department_name (str): departmentName + digit_pattern_permissions (digitPatternPermissions): digitPatternPermissions """ __slots__: List[str] = [ - "enable_monitoring", - "config_type", - "system_file_name", - "device_file_format", - "device_management_device_type_options", + "department_key", + "department_name", + "digit_pattern_permissions", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("enable_monitoring", "enableMonitoring", bool, is_required=True), - E("config_type", "configType", str), - E("system_file_name", "systemFileName", str), - E("device_file_format", "deviceFileFormat", str), E( - "device_management_device_type_options", - "deviceManagementDeviceTypeOptions", - DeviceManagementDeviceTypeOptions21sp1, + "department_key", + "departmentKey", + DepartmentKey, + is_complex=True, + is_required=True, + ), + E("department_name", "departmentName", str, is_required=True), + E( + "digit_pattern_permissions", + "digitPatternPermissions", + OutgoingCallingPlanDigitPatternRedirectingPermissions, is_complex=True, + is_required=True, ), ) -class CPEDeviceOptions22(OCIType): +class OutgoingCallingPlanDigitPatternRedirectingDepartmentPermissionsModify(OCIType): """ - CPE device's options. + Modify outgoing Calling Plan redirecting call permissions for specified digit + patterns. - The field configType is optional to allow the use of field enableMonitoring for all - device types being managed or not ie. device configuration option equals to - DeviceManagement, or Legacy, or Not Supported). If the device configuration option is - set to "Not Supported", the value of configType is forced set to "None" regardless of - its current value. It is not allowed to add a device type with device configuration - option set to Device Management or Legacy when the configType is not set. Attributes: - enable_monitoring (bool): enableMonitoring - config_type (str): configType *Optional* - system_file_name (str): systemFileName *Optional* - device_file_format (str): deviceFileFormat *Optional* - device_management_device_type_options (deviceManagementDeviceTypeOptions): - deviceManagementDeviceTypeOptions *Optional* + department_key (departmentKey): departmentKey + digit_pattern_permissions (digitPatternPermissions): digitPatternPermissions """ __slots__: List[str] = [ - "enable_monitoring", - "config_type", - "system_file_name", - "device_file_format", - "device_management_device_type_options", + "department_key", + "digit_pattern_permissions", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("enable_monitoring", "enableMonitoring", bool, is_required=True), - E("config_type", "configType", str), - E("system_file_name", "systemFileName", str), - E("device_file_format", "deviceFileFormat", str), E( - "device_management_device_type_options", - "deviceManagementDeviceTypeOptions", - DeviceManagementDeviceTypeOptions22, + "department_key", + "departmentKey", + DepartmentKey, + is_complex=True, + is_required=True, + ), + E( + "digit_pattern_permissions", + "digitPatternPermissions", + OutgoingCallingPlanDigitPatternRedirectingPermissions, is_complex=True, + is_required=True, ), ) -class CPEDeviceOptions22V2(OCIType): +class OutgoingPinholeDigitPlanDigitPatternCallMeNowDepartmentPermissions(OCIType): """ - CPE device's options. + Outgoing Pinhole Digit Plan Call Me Now call permissions for a department. - The field configType is optional to allow the use of field enableMonitoring for all - device types being managed or not ie. device configuration option equals to - DeviceManagement, or Legacy, or Not Supported). If the device configuration option is - set to "Not Supported", the value of configType is forced set to "None" regardless of - its current value. It is not allowed to add a device type with device configuration - option set to Device Management or Legacy when the configType is not set. Attributes: - enable_monitoring (bool): enableMonitoring - config_type (str): configType *Optional* - system_file_name (str): systemFileName *Optional* - device_file_format (str): deviceFileFormat *Optional* - device_management_device_type_options (deviceManagementDeviceTypeOptions): - deviceManagementDeviceTypeOptions *Optional* + department_key (departmentKey): departmentKey + department_name (str): departmentName + permissions (permissions): permissions """ __slots__: List[str] = [ - "enable_monitoring", - "config_type", - "system_file_name", - "device_file_format", - "device_management_device_type_options", + "department_key", + "department_name", + "permissions", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("enable_monitoring", "enableMonitoring", bool, is_required=True), - E("config_type", "configType", str), - E("system_file_name", "systemFileName", str), - E("device_file_format", "deviceFileFormat", str), E( - "device_management_device_type_options", - "deviceManagementDeviceTypeOptions", - DeviceManagementDeviceTypeOptions22V2, + "department_key", + "departmentKey", + DepartmentKey, + is_complex=True, + is_required=True, + ), + E("department_name", "departmentName", str, is_required=True), + E( + "permissions", + "permissions", + OutgoingPinholeDigitPlanDigitPatternCallMeNowPermissions, is_complex=True, + is_required=True, ), ) -class CPEDeviceOptions22V3(OCIType): +class OutgoingPinholeDigitPlanDigitPatternCallMeNowDepartmentPermissionsModify(OCIType): """ - CPE device's options. + Modify Outgoing Pinhole Digit Plan Call Me Now call permissions for specified digit + patterns. - The field configType is optional to allow the use of field enableMonitoring for all - device types being managed or not ie. device configuration option equals to - DeviceManagement, or Legacy, or Not Supported). If the device configuration option is - set to "Not Supported", the value of configType is forced set to "None" regardless of - its current value. It is not allowed to add a device type with device configuration - option set to Device Management or Legacy when the configType is not set. Attributes: - enable_monitoring (bool): enableMonitoring - config_type (str): configType *Optional* - system_file_name (str): systemFileName *Optional* - device_file_format (str): deviceFileFormat *Optional* - device_management_device_type_options (deviceManagementDeviceTypeOptions): - deviceManagementDeviceTypeOptions *Optional* + department_key (departmentKey): departmentKey + digit_pattern_permissions (digitPatternPermissions): digitPatternPermissions """ __slots__: List[str] = [ - "enable_monitoring", - "config_type", - "system_file_name", - "device_file_format", - "device_management_device_type_options", + "department_key", + "digit_pattern_permissions", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("enable_monitoring", "enableMonitoring", bool, is_required=True), - E("config_type", "configType", str), - E("system_file_name", "systemFileName", str), - E("device_file_format", "deviceFileFormat", str), E( - "device_management_device_type_options", - "deviceManagementDeviceTypeOptions", - DeviceManagementDeviceTypeOptions22V3, + "department_key", + "departmentKey", + DepartmentKey, + is_complex=True, + is_required=True, + ), + E( + "digit_pattern_permissions", + "digitPatternPermissions", + OutgoingPinholeDigitPlanDigitPatternCallMeNowPermissions, is_complex=True, + is_required=True, ), ) -class CPEDeviceOptions22V4(OCIType): +class OutgoingPinholeDigitPlanDigitPatternOriginatingDepartmentPermissions(OCIType): """ - CPE device's options. + Outgoing Pinhole Digit Plan department originating call permissions for specified + digit patterns. - The field configType is optional to allow the use of field enableMonitoring for all - device types being managed or not ie. device configuration option equals to - DeviceManagement, or Legacy, or Not Supported). If the device configuration option is - set to "Not Supported", the value of configType is forced set to "None" regardless of - its current value. It is not allowed to add a device type with device configuration - option set to Device Management or Legacy when the configType is not set. Attributes: - enable_monitoring (bool): enableMonitoring - config_type (str): configType *Optional* - system_file_name (str): systemFileName *Optional* - device_file_format (str): deviceFileFormat *Optional* - device_management_device_type_options (deviceManagementDeviceTypeOptions): - deviceManagementDeviceTypeOptions *Optional* + department_key (departmentKey): departmentKey + department_name (str): departmentName + digit_pattern_permissions (digitPatternPermissions): digitPatternPermissions """ __slots__: List[str] = [ - "enable_monitoring", - "config_type", - "system_file_name", - "device_file_format", - "device_management_device_type_options", + "department_key", + "department_name", + "digit_pattern_permissions", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("enable_monitoring", "enableMonitoring", bool, is_required=True), - E("config_type", "configType", str), - E("system_file_name", "systemFileName", str), - E("device_file_format", "deviceFileFormat", str), E( - "device_management_device_type_options", - "deviceManagementDeviceTypeOptions", - DeviceManagementDeviceTypeOptions22V4, + "department_key", + "departmentKey", + DepartmentKey, + is_complex=True, + is_required=True, + ), + E("department_name", "departmentName", str, is_required=True), + E( + "digit_pattern_permissions", + "digitPatternPermissions", + OutgoingPinholeDigitPlanDigitPatternOriginatingPermissions, is_complex=True, + is_required=True, ), ) -class CallCenterMediaOnHoldSourceModify16(OCIType): +class OutgoingPinholeDigitPlanDigitPatternOriginatingDepartmentPermissionsModify( + OCIType, +): """ - Contains the call center media on hold source configuration. + Modify Outgoing Pinhole Digit Plan originating call permissions for specified digit + patterns. Attributes: - audio_message_source_selection (str): audioMessageSourceSelection *Optional* - audio_file (audioFile): audioFile *Optional* - external_audio_source (externalAudioSource): externalAudioSource *Optional* - video_message_source_selection (str): videoMessageSourceSelection *Optional* - video_file (videoFile): videoFile *Optional* - external_video_source (externalVideoSource): externalVideoSource *Optional* + department_key (departmentKey): departmentKey + digit_pattern_permissions (digitPatternPermissions): digitPatternPermissions """ __slots__: List[str] = [ - "audio_message_source_selection", - "audio_file", - "external_audio_source", - "video_message_source_selection", - "video_file", - "external_video_source", + "department_key", + "digit_pattern_permissions", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("audio_message_source_selection", "audioMessageSourceSelection", str), - E("audio_file", "audioFile", ExtendedMediaFileResource, is_complex=True), E( - "external_audio_source", - "externalAudioSource", - AccessDeviceEndpointModify, + "department_key", + "departmentKey", + DepartmentKey, is_complex=True, + is_required=True, ), - E("video_message_source_selection", "videoMessageSourceSelection", str), - E("video_file", "videoFile", ExtendedMediaFileResource, is_complex=True), E( - "external_video_source", - "externalVideoSource", - AccessDeviceEndpointModify, + "digit_pattern_permissions", + "digitPatternPermissions", + OutgoingPinholeDigitPlanDigitPatternOriginatingPermissions, is_complex=True, + is_required=True, ), ) -class CallCenterMediaOnHoldSourceModify17(OCIType): +class OutgoingPinholeDigitPlanDigitPatternRedirectingDepartmentPermissions(OCIType): """ - Contains the call center media on hold source configuration. + Outgoing Pinhole Digit Plan initiating call forwards/transfer permissions for a + department. Attributes: - audio_message_source_selection (str): audioMessageSourceSelection *Optional* - audio_url_list (audioUrlList): audioUrlList *Optional* - audio_file_list (audioFileList): audioFileList *Optional* - external_audio_source (externalAudioSource): externalAudioSource *Optional* - video_message_source_selection (str): videoMessageSourceSelection *Optional* - video_url_list (videoUrlList): videoUrlList *Optional* - video_file_list (videoFileList): videoFileList *Optional* - external_video_source (externalVideoSource): externalVideoSource *Optional* + department_key (departmentKey): departmentKey + department_name (str): departmentName + permissions (permissions): permissions """ __slots__: List[str] = [ - "audio_message_source_selection", - "audio_url_list", - "audio_file_list", - "external_audio_source", - "video_message_source_selection", - "video_url_list", - "video_file_list", - "external_video_source", + "department_key", + "department_name", + "permissions", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("audio_message_source_selection", "audioMessageSourceSelection", str), - E( - "audio_url_list", - "audioUrlList", - CallCenterAnnouncementURLListModify, - is_complex=True, - ), - E( - "audio_file_list", - "audioFileList", - CallCenterAnnouncementFileListModify, - is_complex=True, - ), - E( - "external_audio_source", - "externalAudioSource", - AccessDeviceEndpointModify, - is_complex=True, - ), - E("video_message_source_selection", "videoMessageSourceSelection", str), E( - "video_url_list", - "videoUrlList", - CallCenterAnnouncementURLListModify, - is_complex=True, - ), - E( - "video_file_list", - "videoFileList", - CallCenterAnnouncementFileListModify, + "department_key", + "departmentKey", + DepartmentKey, is_complex=True, + is_required=True, ), + E("department_name", "departmentName", str, is_required=True), E( - "external_video_source", - "externalVideoSource", - AccessDeviceEndpointModify, + "permissions", + "permissions", + OutgoingPinholeDigitPlanDigitPatternRedirectingPermissions, is_complex=True, + is_required=True, ), ) -class CallCenterMediaOnHoldSourceModify20(OCIType): +class OutgoingPinholeDigitPlanDigitPatternRedirectingDepartmentPermissionsModify( + OCIType, +): """ - Contains the call center media on hold source configuration. + Modify Outgoing Pinhole Digit Plan redirecting call permissions for specified digit + patterns. Attributes: - audio_message_source_selection (str): audioMessageSourceSelection *Optional* - audio_url_list (audioUrlList): audioUrlList *Optional* - audio_file_list (audioFileList): audioFileList *Optional* - external_audio_source (externalAudioSource): externalAudioSource *Optional* - video_message_source_selection (str): videoMessageSourceSelection *Optional* - video_url_list (videoUrlList): videoUrlList *Optional* - video_file_list (videoFileList): videoFileList *Optional* - external_video_source (externalVideoSource): externalVideoSource *Optional* + department_key (departmentKey): departmentKey + digit_pattern_permissions (digitPatternPermissions): digitPatternPermissions """ __slots__: List[str] = [ - "audio_message_source_selection", - "audio_url_list", - "audio_file_list", - "external_audio_source", - "video_message_source_selection", - "video_url_list", - "video_file_list", - "external_video_source", + "department_key", + "digit_pattern_permissions", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("audio_message_source_selection", "audioMessageSourceSelection", str), - E( - "audio_url_list", - "audioUrlList", - CallCenterAnnouncementURLListModify, - is_complex=True, - ), - E( - "audio_file_list", - "audioFileList", - CallCenterAnnouncementFileListModify20, - is_complex=True, - ), - E( - "external_audio_source", - "externalAudioSource", - AccessDeviceEndpointModify, - is_complex=True, - ), - E("video_message_source_selection", "videoMessageSourceSelection", str), - E( - "video_url_list", - "videoUrlList", - CallCenterAnnouncementURLListModify, - is_complex=True, - ), E( - "video_file_list", - "videoFileList", - CallCenterAnnouncementFileListModify20, + "department_key", + "departmentKey", + DepartmentKey, is_complex=True, + is_required=True, ), E( - "external_video_source", - "externalVideoSource", - AccessDeviceEndpointModify, + "digit_pattern_permissions", + "digitPatternPermissions", + OutgoingPinholeDigitPlanDigitPatternRedirectingPermissions, is_complex=True, + is_required=True, ), ) -class CallCenterMediaOnHoldSourceRead16(OCIType): +class PushNotificationRegistrationData(OCIType): """ - Contains the call center media on hold source configuration. + ? The common push notification registration elements. Attributes: - audio_message_source_selection (str): audioMessageSourceSelection - audio_file_url (str): audioFileUrl *Optional* - audio_file_description (str): audioFileDescription *Optional* - audio_file_media_type (str): audioFileMediaType *Optional* - external_audio_source (externalAudioSource): externalAudioSource *Optional* - video_message_source_selection (str): videoMessageSourceSelection *Optional* - video_file_url (str): videoFileUrl *Optional* - video_file_description (str): videoFileDescription *Optional* - video_file_media_type (str): videoFileMediaType *Optional* - external_video_source (externalVideoSource): externalVideoSource *Optional* + registration_id (str): registrationId + application_id (str): applicationId + application_version (str): applicationVersion + device_os_type (str): deviceOsType + device_version (str): deviceVersion + timestamp (str): timestamp + push_notification_client_version (str): pushNotificationClientVersion + push_notification_token_data (List[pushNotificationTokenData]): + pushNotificationTokenData *Optional* """ __slots__: List[str] = [ - "audio_message_source_selection", - "audio_file_url", - "audio_file_description", - "audio_file_media_type", - "external_audio_source", - "video_message_source_selection", - "video_file_url", - "video_file_description", - "video_file_media_type", - "external_video_source", + "registration_id", + "application_id", + "application_version", + "device_os_type", + "device_version", + "timestamp", + "push_notification_client_version", + "push_notification_token_data", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( + E("registration_id", "registrationId", str, is_required=True), + E("application_id", "applicationId", str, is_required=True), + E("application_version", "applicationVersion", str, is_required=True), + E("device_os_type", "deviceOsType", str, is_required=True), + E("device_version", "deviceVersion", str, is_required=True), + E("timestamp", "timestamp", str, is_required=True), E( - "audio_message_source_selection", - "audioMessageSourceSelection", + "push_notification_client_version", + "pushNotificationClientVersion", str, is_required=True, ), - E("audio_file_url", "audioFileUrl", str), - E("audio_file_description", "audioFileDescription", str), - E("audio_file_media_type", "audioFileMediaType", str), - E( - "external_audio_source", - "externalAudioSource", - AccessDeviceEndpointRead14, - is_complex=True, - ), - E("video_message_source_selection", "videoMessageSourceSelection", str), - E("video_file_url", "videoFileUrl", str), - E("video_file_description", "videoFileDescription", str), - E("video_file_media_type", "videoFileMediaType", str), E( - "external_video_source", - "externalVideoSource", - AccessDeviceEndpointRead14, + "push_notification_token_data", + "pushNotificationTokenData", + PushNotificationTokenData, is_complex=True, + is_array=True, ), ) -class CallCenterMediaOnHoldSourceRead17(OCIType): +class ReplacementCombinedGroupServiceAuthorizationList(OCIType): """ - Contains the call center media on hold source configuration. + A list of group services that replaces a previously authorized group services. - Replaced by: CallCenterMediaOnHoldSourceRead19. Attributes: - audio_message_source_selection (str): audioMessageSourceSelection - audio_url_list (audioUrlList): audioUrlList *Optional* - audio_file_list (audioFileList): audioFileList *Optional* - audio_media_type_list (audioMediaTypeList): audioMediaTypeList *Optional* - external_audio_source (externalAudioSource): externalAudioSource *Optional* - video_message_source_selection (str): videoMessageSourceSelection *Optional* - video_url_list (videoUrlList): videoUrlList *Optional* - video_file_list (videoFileList): videoFileList *Optional* - video_media_type_list (videoMediaTypeList): videoMediaTypeList *Optional* - external_video_source (externalVideoSource): externalVideoSource *Optional* + group_service_authorization (List[groupServiceAuthorization]): + groupServiceAuthorization """ __slots__: List[str] = [ - "audio_message_source_selection", - "audio_url_list", - "audio_file_list", - "audio_media_type_list", - "external_audio_source", - "video_message_source_selection", - "video_url_list", - "video_file_list", - "video_media_type_list", - "external_video_source", + "group_service_authorization", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E( - "audio_message_source_selection", - "audioMessageSourceSelection", - str, - is_required=True, - ), - E( - "audio_url_list", - "audioUrlList", - CallCenterAnnouncementURLList, - is_complex=True, - ), - E( - "audio_file_list", - "audioFileList", - CallCenterAnnouncementDescriptionList, - is_complex=True, - ), - E( - "audio_media_type_list", - "audioMediaTypeList", - CallCenterAnnouncementMediaFileTypeList, - is_complex=True, - ), - E( - "external_audio_source", - "externalAudioSource", - AccessDeviceEndpointRead14, - is_complex=True, - ), - E("video_message_source_selection", "videoMessageSourceSelection", str), - E( - "video_url_list", - "videoUrlList", - CallCenterAnnouncementURLList, - is_complex=True, - ), - E( - "video_file_list", - "videoFileList", - CallCenterAnnouncementDescriptionList, - is_complex=True, - ), - E( - "video_media_type_list", - "videoMediaTypeList", - CallCenterAnnouncementMediaFileTypeList, - is_complex=True, - ), - E( - "external_video_source", - "externalVideoSource", - AccessDeviceEndpointRead14, + E( + "group_service_authorization", + "groupServiceAuthorization", + CombinedGroupServiceAuthorization, is_complex=True, + is_required=True, + is_array=True, ), ) -class CallCenterMediaOnHoldSourceRead19(OCIType): +class ReplacementCombinedServicePackAssignmentList(OCIType): """ - Contains the call center media on hold source configuration. + A list of service packs that replaces existing service packs assgined to the user. + If a service pack is already assigned to the user, the service quantitiy will be + updated if included. Attributes: - audio_message_source_selection (str): audioMessageSourceSelection - audio_url_list (audioUrlList): audioUrlList *Optional* - audio_file_list (audioFileList): audioFileList *Optional* - audio_media_type_list (audioMediaTypeList): audioMediaTypeList *Optional* - external_audio_source (externalAudioSource): externalAudioSource *Optional* - video_message_source_selection (str): videoMessageSourceSelection *Optional* - video_url_list (videoUrlList): videoUrlList *Optional* - video_file_list (videoFileList): videoFileList *Optional* - video_media_type_list (videoMediaTypeList): videoMediaTypeList *Optional* - external_video_source (externalVideoSource): externalVideoSource *Optional* + service_pack (List[servicePack]): servicePack """ __slots__: List[str] = [ - "audio_message_source_selection", - "audio_url_list", - "audio_file_list", - "audio_media_type_list", - "external_audio_source", - "video_message_source_selection", - "video_url_list", - "video_file_list", - "video_media_type_list", - "external_video_source", + "service_pack", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( E( - "audio_message_source_selection", - "audioMessageSourceSelection", - str, - is_required=True, - ), - E( - "audio_url_list", - "audioUrlList", - CallCenterAnnouncementURLList, - is_complex=True, - ), - E( - "audio_file_list", - "audioFileList", - CallCenterAnnouncementDescriptionList, - is_complex=True, - ), - E( - "audio_media_type_list", - "audioMediaTypeList", - CallCenterAnnouncementMediaFileTypeList, - is_complex=True, - ), - E( - "external_audio_source", - "externalAudioSource", - AccessDeviceEndpointWithPortNumberRead, - is_complex=True, - ), - E("video_message_source_selection", "videoMessageSourceSelection", str), - E( - "video_url_list", - "videoUrlList", - CallCenterAnnouncementURLList, - is_complex=True, - ), - E( - "video_file_list", - "videoFileList", - CallCenterAnnouncementDescriptionList, - is_complex=True, - ), - E( - "video_media_type_list", - "videoMediaTypeList", - CallCenterAnnouncementMediaFileTypeList, - is_complex=True, - ), - E( - "external_video_source", - "externalVideoSource", - AccessDeviceEndpointWithPortNumberRead, + "service_pack", + "servicePack", + CombinedServicePackAssignment, is_complex=True, + is_required=True, + is_array=True, ), ) -class CallCenterMediaOnHoldSourceRead20(OCIType): +class ReplacementCombinedServicePackAuthorizationList(OCIType): """ - Contains the call center media on hold source configuration. + A list of service packs that replaces previously authorized service packs. Attributes: - audio_message_source_selection (str): audioMessageSourceSelection - audio_url_list (audioUrlList): audioUrlList *Optional* - audio_file_list (audioFileList): audioFileList *Optional* - external_audio_source (externalAudioSource): externalAudioSource *Optional* - video_message_source_selection (str): videoMessageSourceSelection *Optional* - video_url_list (videoUrlList): videoUrlList *Optional* - video_file_list (videoFileList): videoFileList *Optional* - external_video_source (externalVideoSource): externalVideoSource *Optional* + service_pack_authorization (List[servicePackAuthorization]): + servicePackAuthorization """ __slots__: List[str] = [ - "audio_message_source_selection", - "audio_url_list", - "audio_file_list", - "external_audio_source", - "video_message_source_selection", - "video_url_list", - "video_file_list", - "external_video_source", + "service_pack_authorization", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( E( - "audio_message_source_selection", - "audioMessageSourceSelection", - str, - is_required=True, - ), - E( - "audio_url_list", - "audioUrlList", - CallCenterAnnouncementURLList, - is_complex=True, - ), - E( - "audio_file_list", - "audioFileList", - CallCenterAnnouncementFileListRead20, - is_complex=True, - ), - E( - "external_audio_source", - "externalAudioSource", - AccessDeviceEndpointWithPortNumberRead, - is_complex=True, - ), - E("video_message_source_selection", "videoMessageSourceSelection", str), - E( - "video_url_list", - "videoUrlList", - CallCenterAnnouncementURLList, - is_complex=True, - ), - E( - "video_file_list", - "videoFileList", - CallCenterAnnouncementFileListRead20, - is_complex=True, - ), - E( - "external_video_source", - "externalVideoSource", - AccessDeviceEndpointWithPortNumberRead, + "service_pack_authorization", + "servicePackAuthorization", + CombinedServicePackAuthorization, is_complex=True, + is_required=True, + is_array=True, ), ) -class CallCenterMediaOnHoldSourceRead22(OCIType): +class ReplacementCombinedSharedCallAppearanceAccessDeviceMultipleIdentityEndpointList( + OCIType, +): """ - Contains the call center media on hold source configuration. + A list of shared call appearance endpoints that replaces existing endpoints. Attributes: - audio_message_source_selection (str): audioMessageSourceSelection - audio_url_list (audioUrlList): audioUrlList *Optional* - audio_file_list (audioFileList): audioFileList *Optional* - external_audio_source (externalAudioSource): externalAudioSource *Optional* - video_message_source_selection (str): videoMessageSourceSelection *Optional* - video_url_list (videoUrlList): videoUrlList *Optional* - video_file_list (videoFileList): videoFileList *Optional* - external_video_source (externalVideoSource): externalVideoSource *Optional* + shared_call_appearance_access_device_endpoint + (List[sharedCallAppearanceAccessDeviceEndpoint]): + sharedCallAppearanceAccessDeviceEndpoint """ __slots__: List[str] = [ - "audio_message_source_selection", - "audio_url_list", - "audio_file_list", - "external_audio_source", - "video_message_source_selection", - "video_url_list", - "video_file_list", - "external_video_source", + "shared_call_appearance_access_device_endpoint", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( E( - "audio_message_source_selection", - "audioMessageSourceSelection", - str, - is_required=True, - ), - E( - "audio_url_list", - "audioUrlList", - CallCenterAnnouncementURLList, - is_complex=True, - ), - E( - "audio_file_list", - "audioFileList", - CallCenterAnnouncementFileListRead20, - is_complex=True, - ), - E( - "external_audio_source", - "externalAudioSource", - AccessDeviceEndpointWithPortNumberRead22, - is_complex=True, - ), - E("video_message_source_selection", "videoMessageSourceSelection", str), - E( - "video_url_list", - "videoUrlList", - CallCenterAnnouncementURLList, - is_complex=True, - ), - E( - "video_file_list", - "videoFileList", - CallCenterAnnouncementFileListRead20, - is_complex=True, - ), - E( - "external_video_source", - "externalVideoSource", - AccessDeviceEndpointWithPortNumberRead22, + "shared_call_appearance_access_device_endpoint", + "sharedCallAppearanceAccessDeviceEndpoint", + CombinedSharedCallAppearanceAccessDeviceMultipleIdentityEndpoint, is_complex=True, + is_required=True, + is_array=True, ), ) -class CallCenterReportInterval(OCIType): +class ReplacementCombinedUserServiceAssignmentList(OCIType): """ - Report interval for call center enhanced reporting scheduled reports. + A list of user services that replaces existing user services assgined to the user. + If a service is already assigned to the user, the service quantitiy will be updated if + included. Attributes: - dates (dates): dates *Optional* - current (current): current *Optional* - past (past): past *Optional* + service_name (List[serviceName]): serviceName """ __slots__: List[str] = [ - "dates", - "current", - "past", + "service_name", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("dates", "dates", CallCenterReportIntervalDates, is_complex=True), - E("current", "current", CallCenterReportCurrentInterval, is_complex=True), - E("past", "past", CallCenterReportPastInterval, is_complex=True), + E( + "service_name", + "serviceName", + CombinedUserServiceAssignment, + is_complex=True, + is_required=True, + is_array=True, + ), ) -class CallCenterReportSchedule(OCIType): +class ReplacementCombinedUserServiceAuthorizationList(OCIType): """ - A schedule for call center enhanced reporting scheduled report. + A list of user services that replaces a previously authorized user services. - It can either be a fixed time schedule or recurring schedule Attributes: - schedule_time (scheduleTime): scheduleTime *Optional* - recurrence (recurrence): recurrence *Optional* + user_service_authorization (List[userServiceAuthorization]): + userServiceAuthorization """ __slots__: List[str] = [ - "schedule_time", - "recurrence", + "user_service_authorization", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( E( - "schedule_time", - "scheduleTime", - CallCenterReportScheduleTime, + "user_service_authorization", + "userServiceAuthorization", + CombinedUserServiceAuthorization, is_complex=True, + is_required=True, + is_array=True, ), + ) + + +class ReplacementConsolidatedServicePackAssignmentList(OCIType): + """ + A list of service packs that replaces existing service packs assigned to the user. + + If a service pack is not authorized to the group, the service will be authorized. The + authorizedQuantity will be used if provided; otherwise, the service quantity will be + set to unlimited. The command will fail if the authorized Quantity set at the service + provider is insufficient If a service pack is already authorized to the group, the + service quantity will be ignored if included. + + Attributes: + service_pack (List[servicePack]): servicePack + """ + + __slots__: List[str] = [ + "service_pack", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( E( - "recurrence", - "recurrence", - CallCenterReportScheduleRecurrence, + "service_pack", + "servicePack", + ConsolidatedServicePackAssignment, is_complex=True, + is_required=True, + is_array=True, ), ) -class ConsolidatedGroupProperties(OCIType): +class ReplacementConsolidatedSharedCallAppearanceAccessDeviceMultipleIdentityEndpointList( + OCIType, +): """ + A list of shared call appearance endpoints that replaces existing endpoints. + Attributes: - default_domain (str): defaultDomain - user_limit (int): userLimit - group_name (str): groupName *Optional* - calling_line_id_name (str): callingLineIdName *Optional* - time_zone (str): timeZone *Optional* - location_dialing_code (str): locationDialingCode *Optional* - contact (contact): contact *Optional* - address (address): address *Optional* - network_class_of_service (List[str]): networkClassOfService *Optional* - default_network_class_of_service (defaultNetworkClassOfService): - defaultNetworkClassOfService *Optional* - group_service (List[groupService]): groupService *Optional* - service_policy (str): servicePolicy *Optional* + shared_call_appearance_access_device_endpoint + (List[sharedCallAppearanceAccessDeviceEndpoint]): + sharedCallAppearanceAccessDeviceEndpoint """ __slots__: List[str] = [ - "default_domain", - "user_limit", - "group_name", - "calling_line_id_name", - "time_zone", - "location_dialing_code", - "contact", - "address", - "network_class_of_service", - "default_network_class_of_service", - "group_service", - "service_policy", + "shared_call_appearance_access_device_endpoint", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("default_domain", "defaultDomain", str, is_required=True), - E("user_limit", "userLimit", int, is_required=True), - E("group_name", "groupName", str), - E("calling_line_id_name", "callingLineIdName", str), - E("time_zone", "timeZone", str), - E("location_dialing_code", "locationDialingCode", str), - E("contact", "contact", Contact, is_complex=True), - E("address", "address", StreetAddress, is_complex=True), - E("network_class_of_service", "networkClassOfService", str, is_array=True), E( - "default_network_class_of_service", - "defaultNetworkClassOfService", - DefaultNetworkClassOfService, + "shared_call_appearance_access_device_endpoint", + "sharedCallAppearanceAccessDeviceEndpoint", + ConsolidatedSharedCallAppearanceAccessDeviceMultipleIdentityEndpoint, is_complex=True, + is_required=True, + is_array=True, ), + ) + + +class ReplacementConsolidatedSharedCallAppearanceAccessDeviceMultipleIdentityEndpointList22( + OCIType, +): + """ + A list of shared call appearance endpoints that replaces existing endpoints. + + + Attributes: + shared_call_appearance_access_device_endpoint + (List[sharedCallAppearanceAccessDeviceEndpoint]): + sharedCallAppearanceAccessDeviceEndpoint + """ + + __slots__: List[str] = [ + "shared_call_appearance_access_device_endpoint", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( E( - "group_service", - "groupService", - ConsolidatedGroupServiceAssignment, + "shared_call_appearance_access_device_endpoint", + "sharedCallAppearanceAccessDeviceEndpoint", + ConsolidatedSharedCallAppearanceAccessDeviceMultipleIdentityEndpointAdd22, is_complex=True, + is_required=True, is_array=True, ), - E("service_policy", "servicePolicy", str), ) -class EnterpriseSessionAdmissionControlGroupGetResponse21sp1V2(OCIType): +class ReplacementConsolidatedUserServiceAssignmentList(OCIType): """ - Response to EnterpriseSessionAdmissionControlGroupGetRequest21sp1V2. + A list of user services that replaces existing user services assigned to the user. - Returns the profile information for the session admission control group. + If a service is not authorized to the group, the service will be authorized. The + authorizedQuantity will be used if provided; otherwise, the service quantity will be + set to unlimited. The command will fail if the authorized Quantity set at the service + provider is insufficient. If a service is already authorized to the group, the + service quantity will be ignored if included. Attributes: - max_session (int): maxSession - max_user_originating_sessions (int): maxUserOriginatingSessions *Optional* - max_user_terminating_sessions (int): maxUserTerminatingSessions *Optional* - reserved_session (int): reservedSession - reserved_user_originating_sessions (int): reservedUserOriginatingSessions - *Optional* - reserved_user_terminating_sessions (int): reservedUserTerminatingSessions - *Optional* - default_group (bool): defaultGroup - count_intra_sac_group_sessions (bool): countIntraSACGroupSessions - devices (List[devices]): devices *Optional* - block_emergency_and_repair_calls_due_to_sac_limits (bool): - blockEmergencyAndRepairCallsDueToSACLimits - media_group_name (str): mediaGroupName *Optional* - access_info_pattern (str): accessInfoPattern *Optional* + user_service_service_name (List[userServiceServiceName]): userServiceServiceName """ __slots__: List[str] = [ - "max_session", - "max_user_originating_sessions", - "max_user_terminating_sessions", - "reserved_session", - "reserved_user_originating_sessions", - "reserved_user_terminating_sessions", - "default_group", - "count_intra_sac_group_sessions", - "devices", - "block_emergency_and_repair_calls_due_to_sac_limits", - "media_group_name", - "access_info_pattern", + "user_service_service_name", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("max_session", "maxSession", int, is_required=True), - E("max_user_originating_sessions", "maxUserOriginatingSessions", int), - E("max_user_terminating_sessions", "maxUserTerminatingSessions", int), - E("reserved_session", "reservedSession", int, is_required=True), - E( - "reserved_user_originating_sessions", - "reservedUserOriginatingSessions", - int, - ), - E( - "reserved_user_terminating_sessions", - "reservedUserTerminatingSessions", - int, - ), - E("default_group", "defaultGroup", bool, is_required=True), E( - "count_intra_sac_group_sessions", - "countIntraSACGroupSessions", - bool, + "user_service_service_name", + "userServiceServiceName", + ConsolidatedUserServiceAssignment, + is_complex=True, is_required=True, + is_array=True, ), + ) + + +class ReplacementEnterpriseDeviceList(OCIType): + """ + A list of enterprise accessible devices that replaces a previously configured list. + + By convention, an element of this type may be set nill to clear the list. + + Attributes: + device (List[device]): device + """ + + __slots__: List[str] = [ + "device", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( E( - "devices", - "devices", + "device", + "device", EnterpriseAccessDevice, is_complex=True, - is_array=True, - ), - E( - "block_emergency_and_repair_calls_due_to_sac_limits", - "blockEmergencyAndRepairCallsDueToSACLimits", - bool, is_required=True, + is_array=True, ), - E("media_group_name", "mediaGroupName", str), - E("access_info_pattern", "accessInfoPattern", str), ) -class GroupHuntGroupAddInstanceRequest17sp1V1(OCIType): +class ReplacementEnterpriseEnterpriseTrunkPriorityWeightedTrunkGroupList(OCIType): """ - Add a Hunt Group instance to a group. - - The domain is required in the serviceUserId. - - The response is either `SuccessResponse()` or `ErrorResponse()`. The following - elements are only used in XS data mode: allowMembersToControlGroupBusy, use value - "false" in AS data mode enableGroupBusy, use value "false" in AS data mode + A list of enterprise trunk priority weighted trunk groups that replaces a previously + configured list. - Attributes: - service_provider_id (str): serviceProviderId - group_id (str): groupId - service_user_id (str): serviceUserId - service_instance_profile (serviceInstanceProfile): serviceInstanceProfile - policy (str): policy - hunt_after_no_answer (bool): huntAfterNoAnswer - no_answer_number_of_rings (int): noAnswerNumberOfRings - forward_after_timeout (bool): forwardAfterTimeout - forward_timeout_seconds (int): forwardTimeoutSeconds - forward_to_phone_number (str): forwardToPhoneNumber *Optional* - agent_user_id (List[str]): agentUserId *Optional* - allow_call_waiting_for_agents (bool): allowCallWaitingForAgents - allow_members_to_control_group_busy (bool): allowMembersToControlGroupBusy - enable_group_busy (bool): enableGroupBusy + By convention, an element of this type may be set nill to clear the list. + + Attributes: + trunk_group (List[trunkGroup]): trunkGroup """ __slots__: List[str] = [ - "service_provider_id", - "group_id", - "service_user_id", - "service_instance_profile", - "policy", - "hunt_after_no_answer", - "no_answer_number_of_rings", - "forward_after_timeout", - "forward_timeout_seconds", - "forward_to_phone_number", - "agent_user_id", - "allow_call_waiting_for_agents", - "allow_members_to_control_group_busy", - "enable_group_busy", + "trunk_group", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("service_provider_id", "serviceProviderId", str, is_required=True), - E("group_id", "groupId", str, is_required=True), - E("service_user_id", "serviceUserId", str, is_required=True), E( - "service_instance_profile", - "serviceInstanceProfile", - ServiceInstanceAddProfile, + "trunk_group", + "trunkGroup", + EnterpriseEnterpriseTrunkPriorityWeightedTrunkGroup, is_complex=True, is_required=True, + is_array=True, ), - E("policy", "policy", str, is_required=True), - E("hunt_after_no_answer", "huntAfterNoAnswer", bool, is_required=True), - E( - "no_answer_number_of_rings", - "noAnswerNumberOfRings", - int, - is_required=True, - ), - E("forward_after_timeout", "forwardAfterTimeout", bool, is_required=True), - E( - "forward_timeout_seconds", - "forwardTimeoutSeconds", - int, - is_required=True, - ), - E("forward_to_phone_number", "forwardToPhoneNumber", str), - E("agent_user_id", "agentUserId", str, is_array=True), - E( - "allow_call_waiting_for_agents", - "allowCallWaitingForAgents", - bool, - is_required=True, - ), - E( - "allow_members_to_control_group_busy", - "allowMembersToControlGroupBusy", - bool, - is_required=True, - ), - E("enable_group_busy", "enableGroupBusy", bool, is_required=True), ) -class GroupHuntGroupGetInstanceResponse17sp1V1(OCIType): +class SortOrderEnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAssignmentPagedSortedList( + OCIType, +): """ - Response to GroupHuntGroupGetInstanceRequest17sp1V1. + Used to sort the + `SortOrderEnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAssignmentPagedSortedListRequest()`. - Contains the service profile information and a table of assigned users. The table has - column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana - First Name", "Weight". The following elements are only used in XS data mode: - allowMembersToControlGroupBusy enableGroupBusy Attributes: - service_instance_profile (serviceInstanceProfile): serviceInstanceProfile - policy (str): policy - hunt_after_no_answer (bool): huntAfterNoAnswer - no_answer_number_of_rings (int): noAnswerNumberOfRings - forward_after_timeout (bool): forwardAfterTimeout - forward_timeout_seconds (int): forwardTimeoutSeconds - forward_to_phone_number (str): forwardToPhoneNumber *Optional* - agent_user_table (List(agentUserTable)): agentUserTable - *Table* array of - agentUserTable named tuples - allow_call_waiting_for_agents (bool): allowCallWaitingForAgents - allow_members_to_control_group_busy (bool): allowMembersToControlGroupBusy - enable_group_busy (bool): enableGroupBusy + sort_by_mobile_directory_number (sortByMobileDirectoryNumber): + sortByMobileDirectoryNumber *Optional* + sort_by_dn (sortByDn): sortByDn *Optional* + sort_by_department_name (sortByDepartmentName): sortByDepartmentName *Optional* + sort_by_user_id (sortByUserId): sortByUserId *Optional* + sort_by_user_first_name (sortByUserFirstName): sortByUserFirstName *Optional* + sort_by_user_last_name (sortByUserLastName): sortByUserLastName *Optional* + sort_by_extension (sortByExtension): sortByExtension *Optional* + sort_by_dn_available (sortByDnAvailable): sortByDnAvailable *Optional* """ __slots__: List[str] = [ - "service_instance_profile", - "policy", - "hunt_after_no_answer", - "no_answer_number_of_rings", - "forward_after_timeout", - "forward_timeout_seconds", - "forward_to_phone_number", - "agent_user_table", - "allow_call_waiting_for_agents", - "allow_members_to_control_group_busy", - "enable_group_busy", + "sort_by_mobile_directory_number", + "sort_by_dn", + "sort_by_department_name", + "sort_by_user_id", + "sort_by_user_first_name", + "sort_by_user_last_name", + "sort_by_extension", + "sort_by_dn_available", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( E( - "service_instance_profile", - "serviceInstanceProfile", - ServiceInstanceReadProfile17, + "sort_by_mobile_directory_number", + "sortByMobileDirectoryNumber", + SortByMobileDirectoryNumber, is_complex=True, - is_required=True, - ), - E("policy", "policy", str, is_required=True), - E("hunt_after_no_answer", "huntAfterNoAnswer", bool, is_required=True), - E( - "no_answer_number_of_rings", - "noAnswerNumberOfRings", - int, - is_required=True, ), - E("forward_after_timeout", "forwardAfterTimeout", bool, is_required=True), + E("sort_by_dn", "sortByDn", SortByDn, is_complex=True), E( - "forward_timeout_seconds", - "forwardTimeoutSeconds", - int, - is_required=True, + "sort_by_department_name", + "sortByDepartmentName", + SortByDepartmentName, + is_complex=True, ), - E("forward_to_phone_number", "forwardToPhoneNumber", str), + E("sort_by_user_id", "sortByUserId", SortByUserId, is_complex=True), E( - "agent_user_table", - "agentUserTable", - list, + "sort_by_user_first_name", + "sortByUserFirstName", + SortByUserFirstName, is_complex=True, - is_required=True, - is_table=True, ), E( - "allow_call_waiting_for_agents", - "allowCallWaitingForAgents", - bool, - is_required=True, + "sort_by_user_last_name", + "sortByUserLastName", + SortByUserLastName, + is_complex=True, ), + E("sort_by_extension", "sortByExtension", SortByExtension, is_complex=True), E( - "allow_members_to_control_group_busy", - "allowMembersToControlGroupBusy", - bool, - is_required=True, + "sort_by_dn_available", + "sortByDnAvailable", + SortByDnAvailable, + is_complex=True, ), - E("enable_group_busy", "enableGroupBusy", bool, is_required=True), ) -class GroupTrunkGroupAddInstanceRequest14sp9A(OCIType): +class SortOrderEnterpriseCallCenterAgentThresholdProfileGetAvailableAgentPagedSortedList( + OCIType, +): """ - Add a Trunk Group instance to a group. + Used to sort the + `EnterpriseCallCenterAgentThresholdProfileGetAvailableAgentPagedSortedListRequest()` + request. - The response is either a `SuccessResponse()` or an `ErrorResponse()`. Attributes: - service_provider_id (str): serviceProviderId - group_id (str): groupId - name (str): name - pilot_user (pilotUser): pilotUser *Optional* - department (department): department *Optional* - access_device (accessDevice): accessDevice *Optional* - max_active_calls (int): maxActiveCalls - max_incoming_calls (int): maxIncomingCalls *Optional* - max_outgoing_calls (int): maxOutgoingCalls *Optional* - enable_bursting (bool): enableBursting - bursting_max_active_calls (int): burstingMaxActiveCalls *Optional* - bursting_max_incoming_calls (int): burstingMaxIncomingCalls *Optional* - bursting_max_outgoing_calls (int): burstingMaxOutgoingCalls *Optional* - capacity_exceeded_action (str): capacityExceededAction *Optional* - capacity_exceeded_forward_address (str): capacityExceededForwardAddress *Optional* - capacity_exceeded_reroute_trunk_group_key (capacityExceededRerouteTrunkGroupKey): - capacityExceededRerouteTrunkGroupKey *Optional* - capacity_exceeded_trap_initial_calls (int): capacityExceededTrapInitialCalls - capacity_exceeded_trap_offset_calls (int): capacityExceededTrapOffsetCalls - unreachable_destination_action (str): unreachableDestinationAction *Optional* - unreachable_destination_forward_address (str): - unreachableDestinationForwardAddress *Optional* - unreachable_destination_reroute_trunk_group_key - (unreachableDestinationRerouteTrunkGroupKey): - unreachableDestinationRerouteTrunkGroupKey *Optional* - unreachable_destination_trap_initial_calls (int): - unreachableDestinationTrapInitialCalls - unreachable_destination_trap_offset_calls (int): - unreachableDestinationTrapOffsetCalls - invitation_timeout (int): invitationTimeout - require_authentication (bool): requireAuthentication - sip_authentication_user_name (str): sipAuthenticationUserName *Optional* - sip_authentication_password (str): sipAuthenticationPassword *Optional* - hosted_user_id (List[str]): hostedUserId *Optional* - trunk_group_identity (str): trunkGroupIdentity *Optional* - otg_dtg_identity (str): otgDtgIdentity *Optional* - include_trunk_group_identity (bool): includeTrunkGroupIdentity - include_dtg_identity (bool): includeDtgIdentity - enable_network_address_identity (bool): enableNetworkAddressIdentity - allow_unscreened_calls (bool): allowUnscreenedCalls - allow_unscreened_emergency_calls (bool): allowUnscreenedEmergencyCalls - pilot_user_calling_line_identity_policy (str): pilotUserCallingLineIdentityPolicy - pilot_user_charge_number_policy (str): pilotUserChargeNumberPolicy - call_forwarding_always_action (str): callForwardingAlwaysAction *Optional* - call_forwarding_always_forward_address (str): callForwardingAlwaysForwardAddress - *Optional* - call_forwarding_always_reroute_trunk_group_key - (callForwardingAlwaysRerouteTrunkGroupKey): - callForwardingAlwaysRerouteTrunkGroupKey *Optional* + sort_by_user_id (sortByUserId): sortByUserId *Optional* + sort_by_user_last_name (sortByUserLastName): sortByUserLastName *Optional* + sort_by_user_first_name (sortByUserFirstName): sortByUserFirstName *Optional* + sort_by_dn (sortByDn): sortByDn *Optional* + sort_by_extension (sortByExtension): sortByExtension *Optional* + sort_by_department_name (sortByDepartmentName): sortByDepartmentName *Optional* + sort_by_email_address (sortByEmailAddress): sortByEmailAddress *Optional* + sort_by_agent_threshold_profile (sortByAgentThresholdProfile): + sortByAgentThresholdProfile *Optional* """ __slots__: List[str] = [ - "service_provider_id", - "group_id", - "name", - "pilot_user", - "department", - "access_device", - "max_active_calls", - "max_incoming_calls", - "max_outgoing_calls", - "enable_bursting", - "bursting_max_active_calls", - "bursting_max_incoming_calls", - "bursting_max_outgoing_calls", - "capacity_exceeded_action", - "capacity_exceeded_forward_address", - "capacity_exceeded_reroute_trunk_group_key", - "capacity_exceeded_trap_initial_calls", - "capacity_exceeded_trap_offset_calls", - "unreachable_destination_action", - "unreachable_destination_forward_address", - "unreachable_destination_reroute_trunk_group_key", - "unreachable_destination_trap_initial_calls", - "unreachable_destination_trap_offset_calls", - "invitation_timeout", - "require_authentication", - "sip_authentication_user_name", - "sip_authentication_password", - "hosted_user_id", - "trunk_group_identity", - "otg_dtg_identity", - "include_trunk_group_identity", - "include_dtg_identity", - "enable_network_address_identity", - "allow_unscreened_calls", - "allow_unscreened_emergency_calls", - "pilot_user_calling_line_identity_policy", - "pilot_user_charge_number_policy", - "call_forwarding_always_action", - "call_forwarding_always_forward_address", - "call_forwarding_always_reroute_trunk_group_key", + "sort_by_user_id", + "sort_by_user_last_name", + "sort_by_user_first_name", + "sort_by_dn", + "sort_by_extension", + "sort_by_department_name", + "sort_by_email_address", + "sort_by_agent_threshold_profile", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("service_provider_id", "serviceProviderId", str, is_required=True), - E("group_id", "groupId", str, is_required=True), - E("name", "name", str, is_required=True), - E("pilot_user", "pilotUser", TrunkGroupPilotUser, is_complex=True), - E("department", "department", DepartmentKey, is_complex=True), - E("access_device", "accessDevice", AccessDevice, is_complex=True), - E("max_active_calls", "maxActiveCalls", int, is_required=True), - E("max_incoming_calls", "maxIncomingCalls", int), - E("max_outgoing_calls", "maxOutgoingCalls", int), - E("enable_bursting", "enableBursting", bool, is_required=True), - E("bursting_max_active_calls", "burstingMaxActiveCalls", int), - E("bursting_max_incoming_calls", "burstingMaxIncomingCalls", int), - E("bursting_max_outgoing_calls", "burstingMaxOutgoingCalls", int), - E("capacity_exceeded_action", "capacityExceededAction", str), - E( - "capacity_exceeded_forward_address", - "capacityExceededForwardAddress", - str, - ), + E("sort_by_user_id", "sortByUserId", SortByUserId, is_complex=True), E( - "capacity_exceeded_reroute_trunk_group_key", - "capacityExceededRerouteTrunkGroupKey", - TrunkGroupKey, + "sort_by_user_last_name", + "sortByUserLastName", + SortByUserLastName, is_complex=True, ), E( - "capacity_exceeded_trap_initial_calls", - "capacityExceededTrapInitialCalls", - int, - is_required=True, - ), - E( - "capacity_exceeded_trap_offset_calls", - "capacityExceededTrapOffsetCalls", - int, - is_required=True, - ), - E("unreachable_destination_action", "unreachableDestinationAction", str), - E( - "unreachable_destination_forward_address", - "unreachableDestinationForwardAddress", - str, - ), - E( - "unreachable_destination_reroute_trunk_group_key", - "unreachableDestinationRerouteTrunkGroupKey", - TrunkGroupKey, + "sort_by_user_first_name", + "sortByUserFirstName", + SortByUserFirstName, is_complex=True, ), + E("sort_by_dn", "sortByDn", SortByDn, is_complex=True), + E("sort_by_extension", "sortByExtension", SortByExtension, is_complex=True), E( - "unreachable_destination_trap_initial_calls", - "unreachableDestinationTrapInitialCalls", - int, - is_required=True, - ), - E( - "unreachable_destination_trap_offset_calls", - "unreachableDestinationTrapOffsetCalls", - int, - is_required=True, - ), - E("invitation_timeout", "invitationTimeout", int, is_required=True), - E( - "require_authentication", - "requireAuthentication", - bool, - is_required=True, - ), - E("sip_authentication_user_name", "sipAuthenticationUserName", str), - E("sip_authentication_password", "sipAuthenticationPassword", str), - E("hosted_user_id", "hostedUserId", str, is_array=True), - E("trunk_group_identity", "trunkGroupIdentity", str), - E("otg_dtg_identity", "otgDtgIdentity", str), - E( - "include_trunk_group_identity", - "includeTrunkGroupIdentity", - bool, - is_required=True, - ), - E("include_dtg_identity", "includeDtgIdentity", bool, is_required=True), - E( - "enable_network_address_identity", - "enableNetworkAddressIdentity", - bool, - is_required=True, - ), - E("allow_unscreened_calls", "allowUnscreenedCalls", bool, is_required=True), - E( - "allow_unscreened_emergency_calls", - "allowUnscreenedEmergencyCalls", - bool, - is_required=True, - ), - E( - "pilot_user_calling_line_identity_policy", - "pilotUserCallingLineIdentityPolicy", - str, - is_required=True, - ), - E( - "pilot_user_charge_number_policy", - "pilotUserChargeNumberPolicy", - str, - is_required=True, + "sort_by_department_name", + "sortByDepartmentName", + SortByDepartmentName, + is_complex=True, ), - E("call_forwarding_always_action", "callForwardingAlwaysAction", str), E( - "call_forwarding_always_forward_address", - "callForwardingAlwaysForwardAddress", - str, + "sort_by_email_address", + "sortByEmailAddress", + SortByEmailAddress, + is_complex=True, ), E( - "call_forwarding_always_reroute_trunk_group_key", - "callForwardingAlwaysRerouteTrunkGroupKey", - TrunkGroupKey, + "sort_by_agent_threshold_profile", + "sortByAgentThresholdProfile", + SortByAgentThresholdProfile, is_complex=True, ), ) -class OutgoingCallingPlanDigitPatternCallMeNowDepartmentPermissions(OCIType): +class SortOrderEnterpriseCallCenterAgentThresholdProfileGetPagedSorted(OCIType): """ - Outgoing Calling Plan Call Me Now call permissions for specified digit patterns. + Used to sort the `EnterpriseCallCenterAgentThresholdProfileGetPagedSortedRequest()` + request. Attributes: - department_key (departmentKey): departmentKey - department_name (str): departmentName - digit_pattern_permissions (digitPatternPermissions): digitPatternPermissions + sort_by_user_id (sortByUserId): sortByUserId *Optional* + sort_by_user_last_name (sortByUserLastName): sortByUserLastName *Optional* + sort_by_user_first_name (sortByUserFirstName): sortByUserFirstName *Optional* + sort_by_dn (sortByDn): sortByDn *Optional* + sort_by_extension (sortByExtension): sortByExtension *Optional* + sort_by_department_name (sortByDepartmentName): sortByDepartmentName *Optional* + sort_by_email_address (sortByEmailAddress): sortByEmailAddress *Optional* """ __slots__: List[str] = [ - "department_key", - "department_name", - "digit_pattern_permissions", + "sort_by_user_id", + "sort_by_user_last_name", + "sort_by_user_first_name", + "sort_by_dn", + "sort_by_extension", + "sort_by_department_name", + "sort_by_email_address", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( + E("sort_by_user_id", "sortByUserId", SortByUserId, is_complex=True), E( - "department_key", - "departmentKey", - DepartmentKey, + "sort_by_user_last_name", + "sortByUserLastName", + SortByUserLastName, is_complex=True, - is_required=True, ), - E("department_name", "departmentName", str, is_required=True), E( - "digit_pattern_permissions", - "digitPatternPermissions", - OutgoingCallingPlanDigitPatternCallMeNowPermissions, + "sort_by_user_first_name", + "sortByUserFirstName", + SortByUserFirstName, + is_complex=True, + ), + E("sort_by_dn", "sortByDn", SortByDn, is_complex=True), + E("sort_by_extension", "sortByExtension", SortByExtension, is_complex=True), + E( + "sort_by_department_name", + "sortByDepartmentName", + SortByDepartmentName, + is_complex=True, + ), + E( + "sort_by_email_address", + "sortByEmailAddress", + SortByEmailAddress, is_complex=True, - is_required=True, ), ) -class OutgoingCallingPlanDigitPatternCallMeNowDepartmentPermissionsModify(OCIType): +class SortOrderEnterprisePhoneDirectoryGetPagedSortedList(OCIType): """ - Modify outgoing Calling Plan Call Me Now call permissions for specified digit - patterns. + Used to sort the `EnterprisePhoneDirectoryGetPagedSortedListRequest()` request. Attributes: - department_key (departmentKey): departmentKey - digit_pattern_permissions (digitPatternPermissions): digitPatternPermissions + sort_by_user_last_name (sortByUserLastName): sortByUserLastName *Optional* + sort_by_user_first_name (sortByUserFirstName): sortByUserFirstName *Optional* + sort_by_group_location_code (sortByGroupLocationCode): sortByGroupLocationCode + *Optional* + sort_by_mobile_phone_number (sortByMobilePhoneNumber): sortByMobilePhoneNumber + *Optional* + sort_by_email_address (sortByEmailAddress): sortByEmailAddress *Optional* + sort_by_department_name (sortByDepartmentName): sortByDepartmentName *Optional* + sort_by_group_name (sortByGroupName): sortByGroupName *Optional* + sort_by_yahoo_id (sortByYahooId): sortByYahooId *Optional* + sort_by_user_id (sortByUserId): sortByUserId *Optional* + sort_by_imp_id (sortByImpId): sortByImpId *Optional* """ __slots__: List[str] = [ - "department_key", - "digit_pattern_permissions", + "sort_by_user_last_name", + "sort_by_user_first_name", + "sort_by_group_location_code", + "sort_by_mobile_phone_number", + "sort_by_email_address", + "sort_by_department_name", + "sort_by_group_name", + "sort_by_yahoo_id", + "sort_by_user_id", + "sort_by_imp_id", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( E( - "department_key", - "departmentKey", - DepartmentKey, + "sort_by_user_last_name", + "sortByUserLastName", + SortByUserLastName, + is_complex=True, + ), + E( + "sort_by_user_first_name", + "sortByUserFirstName", + SortByUserFirstName, + is_complex=True, + ), + E( + "sort_by_group_location_code", + "sortByGroupLocationCode", + SortByGroupLocationCode, + is_complex=True, + ), + E( + "sort_by_mobile_phone_number", + "sortByMobilePhoneNumber", + SortByMobilePhoneNumber, + is_complex=True, + ), + E( + "sort_by_email_address", + "sortByEmailAddress", + SortByEmailAddress, + is_complex=True, + ), + E( + "sort_by_department_name", + "sortByDepartmentName", + SortByDepartmentName, is_complex=True, - is_required=True, ), E( - "digit_pattern_permissions", - "digitPatternPermissions", - OutgoingCallingPlanDigitPatternCallMeNowPermissions, + "sort_by_group_name", + "sortByGroupName", + SortByGroupName, is_complex=True, - is_required=True, ), + E("sort_by_yahoo_id", "sortByYahooId", SortByYahooId, is_complex=True), + E("sort_by_user_id", "sortByUserId", SortByUserId, is_complex=True), + E("sort_by_imp_id", "sortByImpId", SortByImpId, is_complex=True), ) -class OutgoingCallingPlanDigitPatternOriginatingDepartmentPermissions(OCIType): +class SortOrderGroupAccessDeviceGetPagedSortedList(OCIType): """ - Outgoing Calling Plan originating call permissions for specified digit patterns. + Used to sort the `GroupAccessDeviceGetPagedSortedListRequest()` request. Attributes: - department_key (departmentKey): departmentKey - department_name (str): departmentName - digit_pattern_permissions (digitPatternPermissions): digitPatternPermissions + sort_by_device_name (sortByDeviceName): sortByDeviceName *Optional* + sort_by_device_type (sortByDeviceType): sortByDeviceType *Optional* + sort_by_device_net_address (sortByDeviceNetAddress): sortByDeviceNetAddress + *Optional* + sort_by_device_mac_address (sortByDeviceMACAddress): sortByDeviceMACAddress + *Optional* """ __slots__: List[str] = [ - "department_key", - "department_name", - "digit_pattern_permissions", + "sort_by_device_name", + "sort_by_device_type", + "sort_by_device_net_address", + "sort_by_device_mac_address", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( E( - "department_key", - "departmentKey", - DepartmentKey, + "sort_by_device_name", + "sortByDeviceName", + SortByDeviceName, is_complex=True, - is_required=True, ), - E("department_name", "departmentName", str, is_required=True), E( - "digit_pattern_permissions", - "digitPatternPermissions", - OutgoingCallingPlanDigitPatternOriginatingPermissions, + "sort_by_device_type", + "sortByDeviceType", + SortByDeviceType, is_complex=True, - is_required=True, ), - ) - - -class OutgoingCallingPlanDigitPatternOriginatingDepartmentPermissionsModify(OCIType): - """ - Modify outgoing Calling Plan originating call permissions for specified digit - patterns. - - - Attributes: - department_key (departmentKey): departmentKey - digit_pattern_permissions (digitPatternPermissions): digitPatternPermissions - """ - - __slots__: List[str] = [ - "department_key", - "digit_pattern_permissions", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( E( - "department_key", - "departmentKey", - DepartmentKey, + "sort_by_device_net_address", + "sortByDeviceNetAddress", + SortByDeviceNetAddress, is_complex=True, - is_required=True, ), E( - "digit_pattern_permissions", - "digitPatternPermissions", - OutgoingCallingPlanDigitPatternOriginatingPermissions, + "sort_by_device_mac_address", + "sortByDeviceMACAddress", + SortByDeviceMACAddress, is_complex=True, - is_required=True, ), ) -class OutgoingCallingPlanDigitPatternRedirectingDepartmentPermissions(OCIType): +class SortOrderGroupAdminGetPagedSortedList(OCIType): """ - Outgoing Calling Plan redirecting call permissions for specified digit patterns. + Used to sort the `GroupAdminGetPagedSortedListRequest()` request. Attributes: - department_key (departmentKey): departmentKey - department_name (str): departmentName - digit_pattern_permissions (digitPatternPermissions): digitPatternPermissions + sort_by_admin_id (sortByAdminId): sortByAdminId *Optional* + sort_by_admin_last_name (sortByAdminLastName): sortByAdminLastName *Optional* + sort_by_admin_first_name (sortByAdminFirstName): sortByAdminFirstName *Optional* """ __slots__: List[str] = [ - "department_key", - "department_name", - "digit_pattern_permissions", + "sort_by_admin_id", + "sort_by_admin_last_name", + "sort_by_admin_first_name", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( + E("sort_by_admin_id", "sortByAdminId", SortByAdminId, is_complex=True), E( - "department_key", - "departmentKey", - DepartmentKey, + "sort_by_admin_last_name", + "sortByAdminLastName", + SortByAdminLastName, is_complex=True, - is_required=True, ), - E("department_name", "departmentName", str, is_required=True), E( - "digit_pattern_permissions", - "digitPatternPermissions", - OutgoingCallingPlanDigitPatternRedirectingPermissions, + "sort_by_admin_first_name", + "sortByAdminFirstName", + SortByAdminFirstName, is_complex=True, - is_required=True, ), ) -class OutgoingCallingPlanDigitPatternRedirectingDepartmentPermissionsModify(OCIType): +class SortOrderGroupAutoAttendantGetInstancePagedSortedList(OCIType): """ - Modify outgoing Calling Plan redirecting call permissions for specified digit - patterns. + Used to sort the `GroupAutoAttendantGetInstancePagedSortedListRequest()` request. Attributes: - department_key (departmentKey): departmentKey - digit_pattern_permissions (digitPatternPermissions): digitPatternPermissions + sort_by_user_id (sortByUserId): sortByUserId *Optional* + sort_by_user_last_name (sortByUserLastName): sortByUserLastName *Optional* + sort_by_dn (sortByDn): sortByDn *Optional* + sort_by_extension (sortByExtension): sortByExtension *Optional* """ __slots__: List[str] = [ - "department_key", - "digit_pattern_permissions", + "sort_by_user_id", + "sort_by_user_last_name", + "sort_by_dn", + "sort_by_extension", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( + E("sort_by_user_id", "sortByUserId", SortByUserId, is_complex=True), E( - "department_key", - "departmentKey", - DepartmentKey, - is_complex=True, - is_required=True, - ), - E( - "digit_pattern_permissions", - "digitPatternPermissions", - OutgoingCallingPlanDigitPatternRedirectingPermissions, + "sort_by_user_last_name", + "sortByUserLastName", + SortByUserLastName, is_complex=True, - is_required=True, ), + E("sort_by_dn", "sortByDn", SortByDn, is_complex=True), + E("sort_by_extension", "sortByExtension", SortByExtension, is_complex=True), ) -class OutgoingPinholeDigitPlanDigitPatternCallMeNowDepartmentPermissions(OCIType): +class SortOrderGroupCallCenterAgentThresholdProfileGetAvailableAgentPagedSortedList( + OCIType, +): """ - Outgoing Pinhole Digit Plan Call Me Now call permissions for a department. + Used to sort the + `GroupCallCenterAgentThresholdProfileGetAvailableAgentPagedSortedListRequest()` + request. Attributes: - department_key (departmentKey): departmentKey - department_name (str): departmentName - permissions (permissions): permissions + sort_by_user_id (sortByUserId): sortByUserId *Optional* + sort_by_user_last_name (sortByUserLastName): sortByUserLastName *Optional* + sort_by_user_first_name (sortByUserFirstName): sortByUserFirstName *Optional* + sort_by_dn (sortByDn): sortByDn *Optional* + sort_by_extension (sortByExtension): sortByExtension *Optional* + sort_by_department_name (sortByDepartmentName): sortByDepartmentName *Optional* + sort_by_email_address (sortByEmailAddress): sortByEmailAddress *Optional* + sort_by_agent_threshold_profile (sortByAgentThresholdProfile): + sortByAgentThresholdProfile *Optional* """ __slots__: List[str] = [ - "department_key", - "department_name", - "permissions", + "sort_by_user_id", + "sort_by_user_last_name", + "sort_by_user_first_name", + "sort_by_dn", + "sort_by_extension", + "sort_by_department_name", + "sort_by_email_address", + "sort_by_agent_threshold_profile", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( + E("sort_by_user_id", "sortByUserId", SortByUserId, is_complex=True), E( - "department_key", - "departmentKey", - DepartmentKey, + "sort_by_user_last_name", + "sortByUserLastName", + SortByUserLastName, is_complex=True, - is_required=True, ), - E("department_name", "departmentName", str, is_required=True), E( - "permissions", - "permissions", - OutgoingPinholeDigitPlanDigitPatternCallMeNowPermissions, + "sort_by_user_first_name", + "sortByUserFirstName", + SortByUserFirstName, is_complex=True, - is_required=True, ), - ) - - -class OutgoingPinholeDigitPlanDigitPatternCallMeNowDepartmentPermissionsModify(OCIType): - """ - Modify Outgoing Pinhole Digit Plan Call Me Now call permissions for specified digit - patterns. - - - Attributes: - department_key (departmentKey): departmentKey - digit_pattern_permissions (digitPatternPermissions): digitPatternPermissions - """ - - __slots__: List[str] = [ - "department_key", - "digit_pattern_permissions", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( + E("sort_by_dn", "sortByDn", SortByDn, is_complex=True), + E("sort_by_extension", "sortByExtension", SortByExtension, is_complex=True), E( - "department_key", - "departmentKey", - DepartmentKey, + "sort_by_department_name", + "sortByDepartmentName", + SortByDepartmentName, is_complex=True, - is_required=True, ), E( - "digit_pattern_permissions", - "digitPatternPermissions", - OutgoingPinholeDigitPlanDigitPatternCallMeNowPermissions, + "sort_by_email_address", + "sortByEmailAddress", + SortByEmailAddress, + is_complex=True, + ), + E( + "sort_by_agent_threshold_profile", + "sortByAgentThresholdProfile", + SortByAgentThresholdProfile, is_complex=True, - is_required=True, ), ) -class OutgoingPinholeDigitPlanDigitPatternOriginatingDepartmentPermissions(OCIType): +class SortOrderGroupCallCenterAgentThresholdProfileGetPagedSorted(OCIType): """ - Outgoing Pinhole Digit Plan department originating call permissions for specified - digit patterns. + Used to sort the `GroupCallCenterAgentThresholdProfileGetPagedSortedRequest()` + request. Attributes: - department_key (departmentKey): departmentKey - department_name (str): departmentName - digit_pattern_permissions (digitPatternPermissions): digitPatternPermissions + sort_by_user_id (sortByUserId): sortByUserId *Optional* + sort_by_user_last_name (sortByUserLastName): sortByUserLastName *Optional* + sort_by_user_first_name (sortByUserFirstName): sortByUserFirstName *Optional* + sort_by_dn (sortByDn): sortByDn *Optional* + sort_by_extension (sortByExtension): sortByExtension *Optional* + sort_by_department_name (sortByDepartmentName): sortByDepartmentName *Optional* + sort_by_email_address (sortByEmailAddress): sortByEmailAddress *Optional* """ __slots__: List[str] = [ - "department_key", - "department_name", - "digit_pattern_permissions", + "sort_by_user_id", + "sort_by_user_last_name", + "sort_by_user_first_name", + "sort_by_dn", + "sort_by_extension", + "sort_by_department_name", + "sort_by_email_address", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( + E("sort_by_user_id", "sortByUserId", SortByUserId, is_complex=True), E( - "department_key", - "departmentKey", - DepartmentKey, + "sort_by_user_last_name", + "sortByUserLastName", + SortByUserLastName, is_complex=True, - is_required=True, ), - E("department_name", "departmentName", str, is_required=True), E( - "digit_pattern_permissions", - "digitPatternPermissions", - OutgoingPinholeDigitPlanDigitPatternOriginatingPermissions, + "sort_by_user_first_name", + "sortByUserFirstName", + SortByUserFirstName, + is_complex=True, + ), + E("sort_by_dn", "sortByDn", SortByDn, is_complex=True), + E("sort_by_extension", "sortByExtension", SortByExtension, is_complex=True), + E( + "sort_by_department_name", + "sortByDepartmentName", + SortByDepartmentName, + is_complex=True, + ), + E( + "sort_by_email_address", + "sortByEmailAddress", + SortByEmailAddress, is_complex=True, - is_required=True, ), ) -class OutgoingPinholeDigitPlanDigitPatternOriginatingDepartmentPermissionsModify( - OCIType, -): +class SortOrderGroupCallCenterGetAvailableAgentPagedSortedList(OCIType): """ - Modify Outgoing Pinhole Digit Plan originating call permissions for specified digit - patterns. + Used to sort the `GroupCallCenterGetAvailableAgentPagedSortedListRequest()` request. Attributes: - department_key (departmentKey): departmentKey - digit_pattern_permissions (digitPatternPermissions): digitPatternPermissions + sort_by_user_id (sortByUserId): sortByUserId *Optional* + sort_by_user_last_name (sortByUserLastName): sortByUserLastName *Optional* + sort_by_user_first_name (sortByUserFirstName): sortByUserFirstName *Optional* + sort_by_dn (sortByDn): sortByDn *Optional* + sort_by_extension (sortByExtension): sortByExtension *Optional* + sort_by_department_name (sortByDepartmentName): sortByDepartmentName *Optional* + sort_by_email_address (sortByEmailAddress): sortByEmailAddress *Optional* """ __slots__: List[str] = [ - "department_key", - "digit_pattern_permissions", + "sort_by_user_id", + "sort_by_user_last_name", + "sort_by_user_first_name", + "sort_by_dn", + "sort_by_extension", + "sort_by_department_name", + "sort_by_email_address", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( + E("sort_by_user_id", "sortByUserId", SortByUserId, is_complex=True), E( - "department_key", - "departmentKey", - DepartmentKey, + "sort_by_user_last_name", + "sortByUserLastName", + SortByUserLastName, is_complex=True, - is_required=True, ), E( - "digit_pattern_permissions", - "digitPatternPermissions", - OutgoingPinholeDigitPlanDigitPatternOriginatingPermissions, + "sort_by_user_first_name", + "sortByUserFirstName", + SortByUserFirstName, + is_complex=True, + ), + E("sort_by_dn", "sortByDn", SortByDn, is_complex=True), + E("sort_by_extension", "sortByExtension", SortByExtension, is_complex=True), + E( + "sort_by_department_name", + "sortByDepartmentName", + SortByDepartmentName, + is_complex=True, + ), + E( + "sort_by_email_address", + "sortByEmailAddress", + SortByEmailAddress, is_complex=True, - is_required=True, ), ) -class OutgoingPinholeDigitPlanDigitPatternRedirectingDepartmentPermissions(OCIType): +class SortOrderGroupCallCenterGetInstancePagedSortedList(OCIType): """ - Outgoing Pinhole Digit Plan initiating call forwards/transfer permissions for a - department. + Used to sort the `GroupCallCenterGetInstancePagedSortedListRequest()` request. Attributes: - department_key (departmentKey): departmentKey - department_name (str): departmentName - permissions (permissions): permissions + sort_by_user_id (sortByUserId): sortByUserId *Optional* + sort_by_call_center_name (sortByCallCenterName): sortByCallCenterName *Optional* + sort_by_dn (sortByDn): sortByDn *Optional* + sort_by_extension (sortByExtension): sortByExtension *Optional* + sort_by_department_name (sortByDepartmentName): sortByDepartmentName *Optional* + sort_by_hunt_policy (sortByHuntPolicy): sortByHuntPolicy *Optional* + sort_by_call_center_type (sortByCallCenterType): sortByCallCenterType *Optional* """ __slots__: List[str] = [ - "department_key", - "department_name", - "permissions", + "sort_by_user_id", + "sort_by_call_center_name", + "sort_by_dn", + "sort_by_extension", + "sort_by_department_name", + "sort_by_hunt_policy", + "sort_by_call_center_type", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( + E("sort_by_user_id", "sortByUserId", SortByUserId, is_complex=True), E( - "department_key", - "departmentKey", - DepartmentKey, + "sort_by_call_center_name", + "sortByCallCenterName", + SortByCallCenterName, is_complex=True, - is_required=True, ), - E("department_name", "departmentName", str, is_required=True), + E("sort_by_dn", "sortByDn", SortByDn, is_complex=True), + E("sort_by_extension", "sortByExtension", SortByExtension, is_complex=True), E( - "permissions", - "permissions", - OutgoingPinholeDigitPlanDigitPatternRedirectingPermissions, + "sort_by_department_name", + "sortByDepartmentName", + SortByDepartmentName, + is_complex=True, + ), + E( + "sort_by_hunt_policy", + "sortByHuntPolicy", + SortByHuntPolicy, + is_complex=True, + ), + E( + "sort_by_call_center_type", + "sortByCallCenterType", + SortByCallCenterType, is_complex=True, - is_required=True, ), ) -class OutgoingPinholeDigitPlanDigitPatternRedirectingDepartmentPermissionsModify( - OCIType, -): +class SortOrderGroupCallParkGetAvailableAlternateRecallUserPagedSortedList(OCIType): """ - Modify Outgoing Pinhole Digit Plan redirecting call permissions for specified digit - patterns. + Used to sort the + `GroupCallParkGetAvailableAlternateRecallUserPagedSortedListRequest()` request. Attributes: - department_key (departmentKey): departmentKey - digit_pattern_permissions (digitPatternPermissions): digitPatternPermissions + sort_by_user_id (sortByUserId): sortByUserId *Optional* + sort_by_user_last_name (sortByUserLastName): sortByUserLastName *Optional* + sort_by_user_first_name (sortByUserFirstName): sortByUserFirstName *Optional* + sort_by_dn (sortByDn): sortByDn *Optional* + sort_by_extension (sortByExtension): sortByExtension *Optional* + sort_by_department_name (sortByDepartmentName): sortByDepartmentName *Optional* """ __slots__: List[str] = [ - "department_key", - "digit_pattern_permissions", + "sort_by_user_id", + "sort_by_user_last_name", + "sort_by_user_first_name", + "sort_by_dn", + "sort_by_extension", + "sort_by_department_name", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( + E("sort_by_user_id", "sortByUserId", SortByUserId, is_complex=True), E( - "department_key", - "departmentKey", - DepartmentKey, + "sort_by_user_last_name", + "sortByUserLastName", + SortByUserLastName, is_complex=True, - is_required=True, ), E( - "digit_pattern_permissions", - "digitPatternPermissions", - OutgoingPinholeDigitPlanDigitPatternRedirectingPermissions, + "sort_by_user_first_name", + "sortByUserFirstName", + SortByUserFirstName, + is_complex=True, + ), + E("sort_by_dn", "sortByDn", SortByDn, is_complex=True), + E("sort_by_extension", "sortByExtension", SortByExtension, is_complex=True), + E( + "sort_by_department_name", + "sortByDepartmentName", + SortByDepartmentName, is_complex=True, - is_required=True, ), ) -class PushNotificationRegistrationData(OCIType): +class SortOrderGroupCallParkGetAvailableUserPagedSortedList(OCIType): """ - ? The common push notification registration elements. + Used to sort the `GroupCallParkGetAvailableUserPagedSortedListRequest()` request. Attributes: - registration_id (str): registrationId - application_id (str): applicationId - application_version (str): applicationVersion - device_os_type (str): deviceOsType - device_version (str): deviceVersion - timestamp (str): timestamp - push_notification_client_version (str): pushNotificationClientVersion - push_notification_token_data (List[pushNotificationTokenData]): - pushNotificationTokenData *Optional* + sort_by_user_id (sortByUserId): sortByUserId *Optional* + sort_by_user_last_name (sortByUserLastName): sortByUserLastName *Optional* + sort_by_user_first_name (sortByUserFirstName): sortByUserFirstName *Optional* + sort_by_dn (sortByDn): sortByDn *Optional* + sort_by_extension (sortByExtension): sortByExtension *Optional* + sort_by_department_name (sortByDepartmentName): sortByDepartmentName *Optional* + sort_by_email_address (sortByEmailAddress): sortByEmailAddress *Optional* """ __slots__: List[str] = [ - "registration_id", - "application_id", - "application_version", - "device_os_type", - "device_version", - "timestamp", - "push_notification_client_version", - "push_notification_token_data", + "sort_by_user_id", + "sort_by_user_last_name", + "sort_by_user_first_name", + "sort_by_dn", + "sort_by_extension", + "sort_by_department_name", + "sort_by_email_address", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( - E("registration_id", "registrationId", str, is_required=True), - E("application_id", "applicationId", str, is_required=True), - E("application_version", "applicationVersion", str, is_required=True), - E("device_os_type", "deviceOsType", str, is_required=True), - E("device_version", "deviceVersion", str, is_required=True), - E("timestamp", "timestamp", str, is_required=True), + E("sort_by_user_id", "sortByUserId", SortByUserId, is_complex=True), + E( + "sort_by_user_last_name", + "sortByUserLastName", + SortByUserLastName, + is_complex=True, + ), + E( + "sort_by_user_first_name", + "sortByUserFirstName", + SortByUserFirstName, + is_complex=True, + ), + E("sort_by_dn", "sortByDn", SortByDn, is_complex=True), + E("sort_by_extension", "sortByExtension", SortByExtension, is_complex=True), E( - "push_notification_client_version", - "pushNotificationClientVersion", - str, - is_required=True, + "sort_by_department_name", + "sortByDepartmentName", + SortByDepartmentName, + is_complex=True, ), E( - "push_notification_token_data", - "pushNotificationTokenData", - PushNotificationTokenData, + "sort_by_email_address", + "sortByEmailAddress", + SortByEmailAddress, is_complex=True, - is_array=True, ), ) -class ReplacementCombinedGroupServiceAuthorizationList(OCIType): +class SortOrderGroupCallPickupGetAvailableUserPagedSortedList(OCIType): """ - A list of group services that replaces a previously authorized group services. + Used to sort the `GroupCallPickupGetAvailableUserPagedSortedListRequest()` request. Attributes: - group_service_authorization (List[groupServiceAuthorization]): - groupServiceAuthorization + sort_by_user_id (sortByUserId): sortByUserId *Optional* + sort_by_user_last_name (sortByUserLastName): sortByUserLastName *Optional* + sort_by_user_first_name (sortByUserFirstName): sortByUserFirstName *Optional* + sort_by_dn (sortByDn): sortByDn *Optional* + sort_by_extension (sortByExtension): sortByExtension *Optional* + sort_by_department_name (sortByDepartmentName): sortByDepartmentName *Optional* + sort_by_email_address (sortByEmailAddress): sortByEmailAddress *Optional* """ __slots__: List[str] = [ - "group_service_authorization", + "sort_by_user_id", + "sort_by_user_last_name", + "sort_by_user_first_name", + "sort_by_dn", + "sort_by_extension", + "sort_by_department_name", + "sort_by_email_address", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( + E("sort_by_user_id", "sortByUserId", SortByUserId, is_complex=True), E( - "group_service_authorization", - "groupServiceAuthorization", - CombinedGroupServiceAuthorization, + "sort_by_user_last_name", + "sortByUserLastName", + SortByUserLastName, + is_complex=True, + ), + E( + "sort_by_user_first_name", + "sortByUserFirstName", + SortByUserFirstName, + is_complex=True, + ), + E("sort_by_dn", "sortByDn", SortByDn, is_complex=True), + E("sort_by_extension", "sortByExtension", SortByExtension, is_complex=True), + E( + "sort_by_department_name", + "sortByDepartmentName", + SortByDepartmentName, + is_complex=True, + ), + E( + "sort_by_email_address", + "sortByEmailAddress", + SortByEmailAddress, is_complex=True, - is_required=True, - is_array=True, ), ) -class ReplacementCombinedServicePackAssignmentList(OCIType): +class SortOrderGroupCallPickupGetInstancePagedSorted(OCIType): """ - A list of service packs that replaces existing service packs assgined to the user. + Used to sort the `GroupCallPickupGetInstancePagedSortedRequest()` request. - If a service pack is already assigned to the user, the service quantitiy will be - updated if included. Attributes: - service_pack (List[servicePack]): servicePack + sort_by_user_id (sortByUserId): sortByUserId *Optional* + sort_by_user_last_name (sortByUserLastName): sortByUserLastName *Optional* + sort_by_user_first_name (sortByUserFirstName): sortByUserFirstName *Optional* + sort_by_dn (sortByDn): sortByDn *Optional* + sort_by_extension (sortByExtension): sortByExtension *Optional* + sort_by_department_name (sortByDepartmentName): sortByDepartmentName *Optional* + sort_by_email_address (sortByEmailAddress): sortByEmailAddress *Optional* """ __slots__: List[str] = [ - "service_pack", + "sort_by_user_id", + "sort_by_user_last_name", + "sort_by_user_first_name", + "sort_by_dn", + "sort_by_extension", + "sort_by_department_name", + "sort_by_email_address", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( + E("sort_by_user_id", "sortByUserId", SortByUserId, is_complex=True), E( - "service_pack", - "servicePack", - CombinedServicePackAssignment, + "sort_by_user_last_name", + "sortByUserLastName", + SortByUserLastName, + is_complex=True, + ), + E( + "sort_by_user_first_name", + "sortByUserFirstName", + SortByUserFirstName, + is_complex=True, + ), + E("sort_by_dn", "sortByDn", SortByDn, is_complex=True), + E("sort_by_extension", "sortByExtension", SortByExtension, is_complex=True), + E( + "sort_by_department_name", + "sortByDepartmentName", + SortByDepartmentName, + is_complex=True, + ), + E( + "sort_by_email_address", + "sortByEmailAddress", + SortByEmailAddress, is_complex=True, - is_required=True, - is_array=True, ), ) -class ReplacementCombinedServicePackAuthorizationList(OCIType): +class SortOrderGroupCollaborateBridgeGetAvailableUserPagedSortedList(OCIType): """ - A list of service packs that replaces previously authorized service packs. + Used to sort the `GroupCollaborateBridgeGetAvailableUserPagedSortedListRequest()` + request. Attributes: - service_pack_authorization (List[servicePackAuthorization]): - servicePackAuthorization + sort_by_user_id (sortByUserId): sortByUserId *Optional* + sort_by_user_last_name (sortByUserLastName): sortByUserLastName *Optional* + sort_by_user_first_name (sortByUserFirstName): sortByUserFirstName *Optional* + sort_by_dn (sortByDn): sortByDn *Optional* + sort_by_extension (sortByExtension): sortByExtension *Optional* """ __slots__: List[str] = [ - "service_pack_authorization", + "sort_by_user_id", + "sort_by_user_last_name", + "sort_by_user_first_name", + "sort_by_dn", + "sort_by_extension", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( + E("sort_by_user_id", "sortByUserId", SortByUserId, is_complex=True), E( - "service_pack_authorization", - "servicePackAuthorization", - CombinedServicePackAuthorization, + "sort_by_user_last_name", + "sortByUserLastName", + SortByUserLastName, + is_complex=True, + ), + E( + "sort_by_user_first_name", + "sortByUserFirstName", + SortByUserFirstName, is_complex=True, - is_required=True, - is_array=True, ), + E("sort_by_dn", "sortByDn", SortByDn, is_complex=True), + E("sort_by_extension", "sortByExtension", SortByExtension, is_complex=True), ) -class ReplacementCombinedSharedCallAppearanceAccessDeviceMultipleIdentityEndpointList( - OCIType, -): +class SortOrderGroupCollaborateBridgeGetInstancePagedSortedList(OCIType): """ - A list of shared call appearance endpoints that replaces existing endpoints. + Used to sort the `GroupCollaborateBridgeGetInstancePagedSortedListRequest()`. Attributes: - shared_call_appearance_access_device_endpoint - (List[sharedCallAppearanceAccessDeviceEndpoint]): - sharedCallAppearanceAccessDeviceEndpoint + sort_by_user_id (sortByUserId): sortByUserId *Optional* + sort_by_user_last_name (sortByUserLastName): sortByUserLastName *Optional* + sort_by_dn (sortByDn): sortByDn *Optional* + sort_by_extension (sortByExtension): sortByExtension *Optional* """ __slots__: List[str] = [ - "shared_call_appearance_access_device_endpoint", + "sort_by_user_id", + "sort_by_user_last_name", + "sort_by_dn", + "sort_by_extension", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( + E("sort_by_user_id", "sortByUserId", SortByUserId, is_complex=True), E( - "shared_call_appearance_access_device_endpoint", - "sharedCallAppearanceAccessDeviceEndpoint", - CombinedSharedCallAppearanceAccessDeviceMultipleIdentityEndpoint, + "sort_by_user_last_name", + "sortByUserLastName", + SortByUserLastName, is_complex=True, - is_required=True, - is_array=True, ), + E("sort_by_dn", "sortByDn", SortByDn, is_complex=True), + E("sort_by_extension", "sortByExtension", SortByExtension, is_complex=True), ) -class ReplacementCombinedUserServiceAssignmentList(OCIType): +class SortOrderGroupDnGetAssignmentPagedSortedList(OCIType): """ - A list of user services that replaces existing user services assgined to the user. + Used to sort the `GroupDnGetAssignmentPagedSortedListRequest()` request. - If a service is already assigned to the user, the service quantitiy will be updated if - included. Attributes: - service_name (List[serviceName]): serviceName + sort_by_dn (sortByDn): sortByDn *Optional* + sort_by_department_name (sortByDepartmentName): sortByDepartmentName *Optional* + sort_by_dn_activated (sortByDnActivated): sortByDnActivated *Optional* + sort_by_dn_available (sortByDnAvailable): sortByDnAvailable *Optional* + sort_by_user_id (sortByUserId): sortByUserId *Optional* + sort_by_user_first_name (sortByUserFirstName): sortByUserFirstName *Optional* + sort_by_user_last_name (sortByUserLastName): sortByUserLastName *Optional* + sort_by_extension (sortByExtension): sortByExtension *Optional* + sort_by_email_address (sortByEmailAddress): sortByEmailAddress *Optional* """ __slots__: List[str] = [ - "service_name", + "sort_by_dn", + "sort_by_department_name", + "sort_by_dn_activated", + "sort_by_dn_available", + "sort_by_user_id", + "sort_by_user_first_name", + "sort_by_user_last_name", + "sort_by_extension", + "sort_by_email_address", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( + E("sort_by_dn", "sortByDn", SortByDn, is_complex=True), E( - "service_name", - "serviceName", - CombinedUserServiceAssignment, + "sort_by_department_name", + "sortByDepartmentName", + SortByDepartmentName, + is_complex=True, + ), + E( + "sort_by_dn_activated", + "sortByDnActivated", + SortByDnActivated, + is_complex=True, + ), + E( + "sort_by_dn_available", + "sortByDnAvailable", + SortByDnAvailable, + is_complex=True, + ), + E("sort_by_user_id", "sortByUserId", SortByUserId, is_complex=True), + E( + "sort_by_user_first_name", + "sortByUserFirstName", + SortByUserFirstName, + is_complex=True, + ), + E( + "sort_by_user_last_name", + "sortByUserLastName", + SortByUserLastName, + is_complex=True, + ), + E("sort_by_extension", "sortByExtension", SortByExtension, is_complex=True), + E( + "sort_by_email_address", + "sortByEmailAddress", + SortByEmailAddress, is_complex=True, - is_required=True, - is_array=True, ), ) -class ReplacementCombinedUserServiceAuthorizationList(OCIType): +class SortOrderGroupGetListInServiceProviderPagedSortedList(OCIType): """ - A list of user services that replaces a previously authorized user services. + Used to sort the `GroupGetListInServiceProviderPagedSortedListRequest()` request. Attributes: - user_service_authorization (List[userServiceAuthorization]): - userServiceAuthorization + sort_by_group_id (sortByGroupId): sortByGroupId *Optional* + sort_by_group_name (sortByGroupName): sortByGroupName *Optional* """ __slots__: List[str] = [ - "user_service_authorization", + "sort_by_group_id", + "sort_by_group_name", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( + E("sort_by_group_id", "sortByGroupId", SortByGroupId, is_complex=True), E( - "user_service_authorization", - "userServiceAuthorization", - CombinedUserServiceAuthorization, + "sort_by_group_name", + "sortByGroupName", + SortByGroupName, is_complex=True, - is_required=True, - is_array=True, ), ) -class ReplacementConsolidatedServicePackAssignmentList(OCIType): +class SortOrderGroupHuntGroupGetAvailableUserPagedSortedList(OCIType): """ - A list of service packs that replaces existing service packs assigned to the user. + Used to sort the `GroupHuntGroupGetAvailableUserPagedSortedListRequest()` request. - If a service pack is not authorized to the group, the service will be authorized. The - authorizedQuantity will be used if provided; otherwise, the service quantity will be - set to unlimited. The command will fail if the authorized Quantity set at the service - provider is insufficient If a service pack is already authorized to the group, the - service quantity will be ignored if included. Attributes: - service_pack (List[servicePack]): servicePack + sort_by_user_id (sortByUserId): sortByUserId *Optional* + sort_by_user_last_name (sortByUserLastName): sortByUserLastName *Optional* + sort_by_user_first_name (sortByUserFirstName): sortByUserFirstName *Optional* + sort_by_dn (sortByDn): sortByDn *Optional* + sort_by_extension (sortByExtension): sortByExtension *Optional* """ __slots__: List[str] = [ - "service_pack", + "sort_by_user_id", + "sort_by_user_last_name", + "sort_by_user_first_name", + "sort_by_dn", + "sort_by_extension", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( + E("sort_by_user_id", "sortByUserId", SortByUserId, is_complex=True), E( - "service_pack", - "servicePack", - ConsolidatedServicePackAssignment, + "sort_by_user_last_name", + "sortByUserLastName", + SortByUserLastName, + is_complex=True, + ), + E( + "sort_by_user_first_name", + "sortByUserFirstName", + SortByUserFirstName, is_complex=True, - is_required=True, - is_array=True, ), + E("sort_by_dn", "sortByDn", SortByDn, is_complex=True), + E("sort_by_extension", "sortByExtension", SortByExtension, is_complex=True), ) -class ReplacementConsolidatedSharedCallAppearanceAccessDeviceMultipleIdentityEndpointList( - OCIType, -): +class SortOrderGroupHuntGroupGetInstancePagedSortedList(OCIType): """ - A list of shared call appearance endpoints that replaces existing endpoints. + Used to sort the `GroupHuntGroupGetInstancePagedSortedListRequest()` request. Attributes: - shared_call_appearance_access_device_endpoint - (List[sharedCallAppearanceAccessDeviceEndpoint]): - sharedCallAppearanceAccessDeviceEndpoint + sort_by_user_id (sortByUserId): sortByUserId *Optional* + sort_by_user_last_name (sortByUserLastName): sortByUserLastName *Optional* + sort_by_dn (sortByDn): sortByDn *Optional* + sort_by_extension (sortByExtension): sortByExtension *Optional* """ __slots__: List[str] = [ - "shared_call_appearance_access_device_endpoint", + "sort_by_user_id", + "sort_by_user_last_name", + "sort_by_dn", + "sort_by_extension", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( + E("sort_by_user_id", "sortByUserId", SortByUserId, is_complex=True), E( - "shared_call_appearance_access_device_endpoint", - "sharedCallAppearanceAccessDeviceEndpoint", - ConsolidatedSharedCallAppearanceAccessDeviceMultipleIdentityEndpoint, + "sort_by_user_last_name", + "sortByUserLastName", + SortByUserLastName, is_complex=True, - is_required=True, - is_array=True, ), + E("sort_by_dn", "sortByDn", SortByDn, is_complex=True), + E("sort_by_extension", "sortByExtension", SortByExtension, is_complex=True), ) -class ReplacementConsolidatedSharedCallAppearanceAccessDeviceMultipleIdentityEndpointList22( - OCIType, -): +class SortOrderGroupPhoneDirectoryGetPagedSortedList(OCIType): """ - A list of shared call appearance endpoints that replaces existing endpoints. + Used to sort the `GroupPhoneDirectoryGetPagedSortedListRequest()` request. Attributes: - shared_call_appearance_access_device_endpoint - (List[sharedCallAppearanceAccessDeviceEndpoint]): - sharedCallAppearanceAccessDeviceEndpoint + sort_by_user_last_name (sortByUserLastName): sortByUserLastName *Optional* + sort_by_user_first_name (sortByUserFirstName): sortByUserFirstName *Optional* + sort_by_mobile_phone_number (sortByMobilePhoneNumber): sortByMobilePhoneNumber + *Optional* + sort_by_email_address (sortByEmailAddress): sortByEmailAddress *Optional* + sort_by_department_name (sortByDepartmentName): sortByDepartmentName *Optional* + sort_by_yahoo_id (sortByYahooId): sortByYahooId *Optional* + sort_by_user_id (sortByUserId): sortByUserId *Optional* + sort_by_imp_id (sortByImpId): sortByImpId *Optional* """ __slots__: List[str] = [ - "shared_call_appearance_access_device_endpoint", + "sort_by_user_last_name", + "sort_by_user_first_name", + "sort_by_mobile_phone_number", + "sort_by_email_address", + "sort_by_department_name", + "sort_by_yahoo_id", + "sort_by_user_id", + "sort_by_imp_id", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( E( - "shared_call_appearance_access_device_endpoint", - "sharedCallAppearanceAccessDeviceEndpoint", - ConsolidatedSharedCallAppearanceAccessDeviceMultipleIdentityEndpointAdd22, + "sort_by_user_last_name", + "sortByUserLastName", + SortByUserLastName, + is_complex=True, + ), + E( + "sort_by_user_first_name", + "sortByUserFirstName", + SortByUserFirstName, + is_complex=True, + ), + E( + "sort_by_mobile_phone_number", + "sortByMobilePhoneNumber", + SortByMobilePhoneNumber, + is_complex=True, + ), + E( + "sort_by_email_address", + "sortByEmailAddress", + SortByEmailAddress, + is_complex=True, + ), + E( + "sort_by_department_name", + "sortByDepartmentName", + SortByDepartmentName, is_complex=True, - is_required=True, - is_array=True, ), + E("sort_by_yahoo_id", "sortByYahooId", SortByYahooId, is_complex=True), + E("sort_by_user_id", "sortByUserId", SortByUserId, is_complex=True), + E("sort_by_imp_id", "sortByImpId", SortByImpId, is_complex=True), ) -class ReplacementConsolidatedUserServiceAssignmentList(OCIType): +class SortOrderServiceProviderAdminGetPagedSortedList(OCIType): """ - A list of user services that replaces existing user services assigned to the user. + Used to sort the `ServiceProviderAdminGetPagedSortedListRequest()` request. - If a service is not authorized to the group, the service will be authorized. The - authorizedQuantity will be used if provided; otherwise, the service quantity will be - set to unlimited. The command will fail if the authorized Quantity set at the service - provider is insufficient. If a service is already authorized to the group, the - service quantity will be ignored if included. Attributes: - user_service_service_name (List[userServiceServiceName]): userServiceServiceName + sort_by_admin_id (sortByAdminId): sortByAdminId *Optional* + sort_by_admin_last_name (sortByAdminLastName): sortByAdminLastName *Optional* + sort_by_admin_first_name (sortByAdminFirstName): sortByAdminFirstName *Optional* """ __slots__: List[str] = [ - "user_service_service_name", + "sort_by_admin_id", + "sort_by_admin_last_name", + "sort_by_admin_first_name", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( + E("sort_by_admin_id", "sortByAdminId", SortByAdminId, is_complex=True), E( - "user_service_service_name", - "userServiceServiceName", - ConsolidatedUserServiceAssignment, + "sort_by_admin_last_name", + "sortByAdminLastName", + SortByAdminLastName, + is_complex=True, + ), + E( + "sort_by_admin_first_name", + "sortByAdminFirstName", + SortByAdminFirstName, is_complex=True, - is_required=True, - is_array=True, ), ) -class ReplacementEnterpriseDeviceList(OCIType): +class SortOrderServiceProviderGetPagedSortedList(OCIType): """ - A list of enterprise accessible devices that replaces a previously configured list. + Used to sort the `ServiceProviderGetPagedSortedListRequest()` request. - By convention, an element of this type may be set nill to clear the list. Attributes: - device (List[device]): device + sort_by_service_provider_id (sortByServiceProviderId): sortByServiceProviderId + *Optional* + sort_by_service_provider_name (sortByServiceProviderName): + sortByServiceProviderName *Optional* """ __slots__: List[str] = [ - "device", + "sort_by_service_provider_id", + "sort_by_service_provider_name", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( E( - "device", - "device", - EnterpriseAccessDevice, + "sort_by_service_provider_id", + "sortByServiceProviderId", + SortByServiceProviderId, + is_complex=True, + ), + E( + "sort_by_service_provider_name", + "sortByServiceProviderName", + SortByServiceProviderName, is_complex=True, - is_required=True, - is_array=True, ), ) -class ReplacementEnterpriseEnterpriseTrunkPriorityWeightedTrunkGroupList(OCIType): +class SortOrderUserGetListInGroupPagedSortedList(OCIType): """ - A list of enterprise trunk priority weighted trunk groups that replaces a previously - configured list. + Used to sort the `UserGetListInGroupPagedSortedListRequest()` request. - By convention, an element of this type may be set nill to clear the list. Attributes: - trunk_group (List[trunkGroup]): trunkGroup + sort_by_user_id (sortByUserId): sortByUserId *Optional* + sort_by_user_last_name (sortByUserLastName): sortByUserLastName *Optional* + sort_by_user_first_name (sortByUserFirstName): sortByUserFirstName *Optional* + sort_by_department_name (sortByDepartmentName): sortByDepartmentName *Optional* + sort_by_dn (sortByDn): sortByDn *Optional* + sort_by_extension (sortByExtension): sortByExtension *Optional* + sort_by_email_address (sortByEmailAddress): sortByEmailAddress *Optional* """ __slots__: List[str] = [ - "trunk_group", + "sort_by_user_id", + "sort_by_user_last_name", + "sort_by_user_first_name", + "sort_by_department_name", + "sort_by_dn", + "sort_by_extension", + "sort_by_email_address", ] @classmethod def _elements(cls) -> Tuple[E, ...]: return ( + E("sort_by_user_id", "sortByUserId", SortByUserId, is_complex=True), E( - "trunk_group", - "trunkGroup", - EnterpriseEnterpriseTrunkPriorityWeightedTrunkGroup, + "sort_by_user_last_name", + "sortByUserLastName", + SortByUserLastName, + is_complex=True, + ), + E( + "sort_by_user_first_name", + "sortByUserFirstName", + SortByUserFirstName, + is_complex=True, + ), + E( + "sort_by_department_name", + "sortByDepartmentName", + SortByDepartmentName, + is_complex=True, + ), + E("sort_by_dn", "sortByDn", SortByDn, is_complex=True), + E("sort_by_extension", "sortByExtension", SortByExtension, is_complex=True), + E( + "sort_by_email_address", + "sortByEmailAddress", + SortByEmailAddress, is_complex=True, - is_required=True, - is_array=True, ), ) @@ -36762,188 +36766,6 @@ def _elements(cls) -> Tuple[E, ...]: ) -class UserEnhancedCallLogsGetListRequest17sp4V2(OCIType): - """ - Request user's call logs. - - If the callLogType is not specified, all types of calls logs (placed, received, - missed) are returned. The filters "dateTimeRange", "numberFilter", - "redirectedNumberFilter", "accountAuthorizationCodeFilter" - "callAuthorizationCodeFilter" and "subscriberType" are ignored if call logs are stored - in CDS. When "ReceivedOrMissed" is specified as "callLogType" and call logs are stored - in CDS, all call logs including placed will be returned. It is possible to restrict - the number of rows returned using responsePagingControl. If responsePagingControl is - not specified, the value of Enhanced Call Logs system parameter - maxNonPagedResponseSize will control the maximum number of call logs can be returned. - - The response is either a UserEnhancedCallLogsGetListResponse17sp4V2 or an - `ErrorResponse()`. The following elements are only used in AS data mode and not - returned in XS data mode: callAuthorizationCodeFilter - - Attributes: - user_id (str): userId - call_log_type (str): callLogType *Optional* - date_time_range (dateTimeRange): dateTimeRange - number_filter (numberFilter): numberFilter *Optional* - redirected_number_filter (redirectedNumberFilter): redirectedNumberFilter - *Optional* - account_authorization_code_filter (accountAuthorizationCodeFilter): - accountAuthorizationCodeFilter *Optional* - call_authorization_code_filter (callAuthorizationCodeFilter): - callAuthorizationCodeFilter *Optional* - subscriber_type (str): subscriberType *Optional* - response_paging_control (responsePagingControl): responsePagingControl *Optional* - """ - - __slots__: List[str] = [ - "user_id", - "call_log_type", - "date_time_range", - "number_filter", - "redirected_number_filter", - "account_authorization_code_filter", - "call_authorization_code_filter", - "subscriber_type", - "response_paging_control", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("user_id", "userId", str, is_required=True), - E("call_log_type", "callLogType", str), - E( - "date_time_range", - "dateTimeRange", - EnhancedCallLogsTimeRange, - is_complex=True, - is_required=True, - ), - E( - "number_filter", - "numberFilter", - EnhancedCallLogsNumberFilter, - is_complex=True, - ), - E( - "redirected_number_filter", - "redirectedNumberFilter", - EnhancedCallLogsRedirectedNumberFilter, - is_complex=True, - ), - E( - "account_authorization_code_filter", - "accountAuthorizationCodeFilter", - EnhancedCallLogsAccountAuthorizationCodeFilter, - is_complex=True, - ), - E( - "call_authorization_code_filter", - "callAuthorizationCodeFilter", - EnhancedCallLogsCallAuthorizationCodeFilter, - is_complex=True, - ), - E("subscriber_type", "subscriberType", str), - E( - "response_paging_control", - "responsePagingControl", - ResponsePagingControl, - is_complex=True, - ), - ) - - -class UserEnhancedCallLogsGetListRequest21sp1V2(OCIType): - """ - Request user's call logs. - - If the callLogType is not specified, all types of calls logs (placed, received, - missed) are returned. The filters "dateTimeRange", "numberFilter", - "redirectedNumberFilter", "accountAuthorizationCodeFilter" - "callAuthorizationCodeFilter" and "subscriberType" are ignored if call logs are stored - in CDS. When "ReceivedOrMissed" is specified as "callLogType" and call logs are stored - in CDS, all call logs including placed will be returned. It is possible to restrict - the number of rows returned using responsePagingControl. If responsePagingControl is - not specified, the value of Enhanced Call Logs system parameter - maxNonPagedResponseSize will control the maximum number of call logs can be returned. - - The response is either a UserEnhancedCallLogsGetListResponse21sp1V2 or an - `ErrorResponse()`. The following elements are only used in AS data mode and ignored in - XS data mode: callAuthorizationCodeFilter - - Attributes: - user_id (str): userId - call_log_type (str): callLogType *Optional* - date_time_range (dateTimeRange): dateTimeRange - number_filter (numberFilter): numberFilter *Optional* - redirected_number_filter (redirectedNumberFilter): redirectedNumberFilter - *Optional* - account_authorization_code_filter (accountAuthorizationCodeFilter): - accountAuthorizationCodeFilter *Optional* - call_authorization_code_filter (callAuthorizationCodeFilter): - callAuthorizationCodeFilter *Optional* - subscriber_type (str): subscriberType *Optional* - response_paging_control (responsePagingControl): responsePagingControl *Optional* - """ - - __slots__: List[str] = [ - "user_id", - "call_log_type", - "date_time_range", - "number_filter", - "redirected_number_filter", - "account_authorization_code_filter", - "call_authorization_code_filter", - "subscriber_type", - "response_paging_control", - ] - - @classmethod - def _elements(cls) -> Tuple[E, ...]: - return ( - E("user_id", "userId", str, is_required=True), - E("call_log_type", "callLogType", str), - E( - "date_time_range", - "dateTimeRange", - EnhancedCallLogsTimeRange, - is_complex=True, - is_required=True, - ), - E( - "number_filter", - "numberFilter", - EnhancedCallLogsNumberFilter, - is_complex=True, - ), - E( - "redirected_number_filter", - "redirectedNumberFilter", - EnhancedCallLogsRedirectedNumberFilter21sp1, - is_complex=True, - ), - E( - "account_authorization_code_filter", - "accountAuthorizationCodeFilter", - EnhancedCallLogsAccountAuthorizationCodeFilter, - is_complex=True, - ), - E( - "call_authorization_code_filter", - "callAuthorizationCodeFilter", - EnhancedCallLogsCallAuthorizationCodeFilter, - is_complex=True, - ), - E("subscriber_type", "subscriberType", str), - E( - "response_paging_control", - "responsePagingControl", - ResponsePagingControl, - is_complex=True, - ), - ) - - class UserGetResponse21sp1V2(OCIType): """ Response to UserGetRequest21sp1V2. @@ -38117,4 +37939,186 @@ def _elements(cls) -> Tuple[E, ...]: ) +class UserEnhancedCallLogsGetListRequest17sp4V2(OCIType): + """ + Request user's call logs. + + If the callLogType is not specified, all types of calls logs (placed, received, + missed) are returned. The filters "dateTimeRange", "numberFilter", + "redirectedNumberFilter", "accountAuthorizationCodeFilter" + "callAuthorizationCodeFilter" and "subscriberType" are ignored if call logs are stored + in CDS. When "ReceivedOrMissed" is specified as "callLogType" and call logs are stored + in CDS, all call logs including placed will be returned. It is possible to restrict + the number of rows returned using responsePagingControl. If responsePagingControl is + not specified, the value of Enhanced Call Logs system parameter + maxNonPagedResponseSize will control the maximum number of call logs can be returned. + + The response is either a UserEnhancedCallLogsGetListResponse17sp4V2 or an + `ErrorResponse()`. The following elements are only used in AS data mode and not + returned in XS data mode: callAuthorizationCodeFilter + + Attributes: + user_id (str): userId + call_log_type (str): callLogType *Optional* + date_time_range (dateTimeRange): dateTimeRange + number_filter (numberFilter): numberFilter *Optional* + redirected_number_filter (redirectedNumberFilter): redirectedNumberFilter + *Optional* + account_authorization_code_filter (accountAuthorizationCodeFilter): + accountAuthorizationCodeFilter *Optional* + call_authorization_code_filter (callAuthorizationCodeFilter): + callAuthorizationCodeFilter *Optional* + subscriber_type (str): subscriberType *Optional* + response_paging_control (responsePagingControl): responsePagingControl *Optional* + """ + + __slots__: List[str] = [ + "user_id", + "call_log_type", + "date_time_range", + "number_filter", + "redirected_number_filter", + "account_authorization_code_filter", + "call_authorization_code_filter", + "subscriber_type", + "response_paging_control", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("user_id", "userId", str, is_required=True), + E("call_log_type", "callLogType", str), + E( + "date_time_range", + "dateTimeRange", + EnhancedCallLogsTimeRange, + is_complex=True, + is_required=True, + ), + E( + "number_filter", + "numberFilter", + EnhancedCallLogsNumberFilter, + is_complex=True, + ), + E( + "redirected_number_filter", + "redirectedNumberFilter", + EnhancedCallLogsRedirectedNumberFilter, + is_complex=True, + ), + E( + "account_authorization_code_filter", + "accountAuthorizationCodeFilter", + EnhancedCallLogsAccountAuthorizationCodeFilter, + is_complex=True, + ), + E( + "call_authorization_code_filter", + "callAuthorizationCodeFilter", + EnhancedCallLogsCallAuthorizationCodeFilter, + is_complex=True, + ), + E("subscriber_type", "subscriberType", str), + E( + "response_paging_control", + "responsePagingControl", + ResponsePagingControl, + is_complex=True, + ), + ) + + +class UserEnhancedCallLogsGetListRequest21sp1V2(OCIType): + """ + Request user's call logs. + + If the callLogType is not specified, all types of calls logs (placed, received, + missed) are returned. The filters "dateTimeRange", "numberFilter", + "redirectedNumberFilter", "accountAuthorizationCodeFilter" + "callAuthorizationCodeFilter" and "subscriberType" are ignored if call logs are stored + in CDS. When "ReceivedOrMissed" is specified as "callLogType" and call logs are stored + in CDS, all call logs including placed will be returned. It is possible to restrict + the number of rows returned using responsePagingControl. If responsePagingControl is + not specified, the value of Enhanced Call Logs system parameter + maxNonPagedResponseSize will control the maximum number of call logs can be returned. + + The response is either a UserEnhancedCallLogsGetListResponse21sp1V2 or an + `ErrorResponse()`. The following elements are only used in AS data mode and ignored in + XS data mode: callAuthorizationCodeFilter + + Attributes: + user_id (str): userId + call_log_type (str): callLogType *Optional* + date_time_range (dateTimeRange): dateTimeRange + number_filter (numberFilter): numberFilter *Optional* + redirected_number_filter (redirectedNumberFilter): redirectedNumberFilter + *Optional* + account_authorization_code_filter (accountAuthorizationCodeFilter): + accountAuthorizationCodeFilter *Optional* + call_authorization_code_filter (callAuthorizationCodeFilter): + callAuthorizationCodeFilter *Optional* + subscriber_type (str): subscriberType *Optional* + response_paging_control (responsePagingControl): responsePagingControl *Optional* + """ + + __slots__: List[str] = [ + "user_id", + "call_log_type", + "date_time_range", + "number_filter", + "redirected_number_filter", + "account_authorization_code_filter", + "call_authorization_code_filter", + "subscriber_type", + "response_paging_control", + ] + + @classmethod + def _elements(cls) -> Tuple[E, ...]: + return ( + E("user_id", "userId", str, is_required=True), + E("call_log_type", "callLogType", str), + E( + "date_time_range", + "dateTimeRange", + EnhancedCallLogsTimeRange, + is_complex=True, + is_required=True, + ), + E( + "number_filter", + "numberFilter", + EnhancedCallLogsNumberFilter, + is_complex=True, + ), + E( + "redirected_number_filter", + "redirectedNumberFilter", + EnhancedCallLogsRedirectedNumberFilter21sp1, + is_complex=True, + ), + E( + "account_authorization_code_filter", + "accountAuthorizationCodeFilter", + EnhancedCallLogsAccountAuthorizationCodeFilter, + is_complex=True, + ), + E( + "call_authorization_code_filter", + "callAuthorizationCodeFilter", + EnhancedCallLogsCallAuthorizationCodeFilter, + is_complex=True, + ), + E("subscriber_type", "subscriberType", str), + E( + "response_paging_control", + "responsePagingControl", + ResponsePagingControl, + is_complex=True, + ), + ) + + # end diff --git a/docs/api/requests.md b/docs/api/requests.md index 4729a39..50c2f8c 100644 --- a/docs/api/requests.md +++ b/docs/api/requests.md @@ -1,7 +1,7 @@ # Requests @@ -48948,66 +48948,6 @@ The response is either a `SuccessResponse()` or an `ErrorResponse()`. -## `EnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAvailablePagedSortedListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Request a list of available Mobile Subscriber Directory Numbers not yet assigned to -any user. - -If the responsePagingControl element is not provided, the paging startIndex will be -set to 1 by default, and the responsePageSize will be set to the maximum -ResponsePageSize by default. If no sortOrder is included the response is sorted by -Mobile Number ascending by default. Multiple search criteria are logically ANDed -together unless the searchCriteriaModeOr option is included. Then the search criteria -are logically ORed together. - -The response is either -`EnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAvailablePagedSortedListResponse()` -or `ErrorResponse()`. Replaced by: -`EnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAvailablePagedSortedListRequest22()` - -**Attributes:** - -|Name |Type |Description | -|---------------------------------------------------|--------------------------------------------------------|---------------------------------------------------------| -|service_provider_id |str |serviceProviderId | -|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | -|sort_by_mobile_directory_number |OCI.sortByMobileDirectoryNumber |sortByMobileDirectoryNumber *Optional* | -|search_criteria_mobile_subscriber_directory_number |List[OCI.searchCriteriaMobileSubscriberDirectoryNumber] |searchCriteriaMobileSubscriberDirectoryNumber *Optional* | -|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | -
- - -## `EnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAvailablePagedSortedListRequest22`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Request a list of available Mobile Subscriber Directory Numbers not yet assigned to -any user. - -If the responsePagingControl element is not provided, the paging startIndex will be -set to 1 by default, and the responsePageSize will be set to the maximum -ResponsePageSize by default. If no sortOrder is included the response is sorted by -Mobile Number ascending by default. Multiple search criteria are logically ANDed -together unless the searchCriteriaModeOr option is included. Then the search criteria -are logically ORed together. - -The response is either -`EnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAvailablePagedSortedListResponse22()` -or `ErrorResponse()`. - -**Attributes:** - -|Name |Type |Description | -|---------------------------------------------------|--------------------------------------------------------|---------------------------------------------------------| -|service_provider_id |str |serviceProviderId | -|include_total_number_of_rows |bool |includeTotalNumberOfRows *Optional* | -|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | -|sort_by_mobile_directory_number |OCI.sortByMobileDirectoryNumber |sortByMobileDirectoryNumber *Optional* | -|search_criteria_mobile_subscriber_directory_number |List[OCI.searchCriteriaMobileSubscriberDirectoryNumber] |searchCriteriaMobileSubscriberDirectoryNumber *Optional* | -|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | -
- - ## `EnterpriseCallCenterAgentThresholdProfileModifyRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -49081,53 +49021,6 @@ The response is either a `SuccessResponse()` or an `ErrorResponse()`.
-## `EnterpriseCallCenterCurrentAndPastAgentGetListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Request to all the current and past agents in the enterprise. - -The searchCriteriaExactUserGroup does not apply to past agents. - -The response is either `EnterpriseCallCenterCurrentAndPastAgentGetListResponse()` or -`ErrorResponse()`. - -**Attributes:** - -|Name |Type |Description | -|---------------------------------|--------------------------------------|----------------------------------------| -|service_provider_id |str |serviceProviderId | -|response_size_limit |int |responseSizeLimit *Optional* | -|search_criteria_user_last_name |List[OCI.searchCriteriaUserLastName] |searchCriteriaUserLastName *Optional* | -|search_criteria_user_first_name |List[OCI.searchCriteriaUserFirstName] |searchCriteriaUserFirstName *Optional* | -|search_criteria_exact_user_group |OCI.searchCriteriaExactUserGroup |searchCriteriaExactUserGroup *Optional* | -|search_criteria_user_id |List[OCI.searchCriteriaUserId] |searchCriteriaUserId *Optional* | -|search_criteria_dn |List[OCI.searchCriteriaDn] |searchCriteriaDn *Optional* | -|search_criteria_extension |List[OCI.searchCriteriaExtension] |searchCriteriaExtension *Optional* | -
- - -## `EnterpriseCallCenterCurrentAndPastCallCenterGetListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Request to get all the current and past call centers for the enterprise. - -The searchCriteriaExactUserGroup does not apply to past call centers. - -The response is either `EnterpriseCallCenterCurrentAndPastCallCenterGetListResponse()` -or `ErrorResponse()`. - -**Attributes:** - -|Name |Type |Description | -|---------------------------------|---------------------------------|----------------------------------------| -|service_provider_id |str |serviceProviderId | -|is_premium_only |bool |isPremiumOnly *Optional* | -|response_size_limit |int |responseSizeLimit *Optional* | -|search_criteria_exact_user_group |OCI.searchCriteriaExactUserGroup |searchCriteriaExactUserGroup *Optional* | -|search_criteria_call_center_name |OCI.searchCriteriaCallCenterName |searchCriteriaCallCenterName *Optional* | -
- - ## `EnterpriseCallCenterEnhancedReportingBrandingModifyRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -49234,32 +49127,6 @@ The response is either a `SuccessResponse()` or an `ErrorResponse()`.
-## `EnterpriseCommonPhoneListGetListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Get an enterprise's common phone list. - -The response is either a `EnterpriseCommonPhoneListGetListResponse()` or an -`ErrorResponse()`. The search can be done using multiple criterion. If the -searchCriteriaModeOr is present, any result matching any one criteria is included in -the results. Otherwise, only results matching all the search criterion are included -in the results. If no search criteria is specified, all results are returned. -Specifying searchCriteriaModeOr without any search criteria results in an -`ErrorResponse()`. In all cases, if a responseSizeLimit is specified and the number of -matching results is more than this limit, then an `ErrorResponse()` is returned. - -**Attributes:** - -|Name |Type |Description | -|----------------------------------------------------|--------------------------------------------------------|---------------------------------------------------------| -|service_provider_id |str |serviceProviderId | -|response_size_limit |int |responseSizeLimit *Optional* | -|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | -|search_criteria_enterprise_common_phone_list_name |List[OCI.searchCriteriaEnterpriseCommonPhoneListName] |searchCriteriaEnterpriseCommonPhoneListName *Optional* | -|search_criteria_enterprise_common_phone_list_number |List[OCI.searchCriteriaEnterpriseCommonPhoneListNumber] |searchCriteriaEnterpriseCommonPhoneListNumber *Optional* | -
- - ## `EnterpriseCommunicationBarringAuthorizationCodeAddListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -49276,165 +49143,6 @@ The response is either a `SuccessResponse()` or an `ErrorResponse()`.
-## `EnterpriseCommunicationBarringAuthorizationCodeGetListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Get a list of Communication Barring Authorization Codes in an enterprise. - -The response is either -`EnterpriseCommunicationBarringAuthorizationCodeGetListResponse()` or -`ErrorResponse()`. - -**Attributes:** - -|Name |Type |Description | -|---------------------------------------------------------------------|-------------------------------------------------------------------------|--------------------------------------------------------------------------| -|service_provider_id |str |serviceProviderId | -|response_size_limit |int |responseSizeLimit *Optional* | -|search_criteria_communication_barring_authorization_code |List[OCI.searchCriteriaCommunicationBarringAuthorizationCode] |searchCriteriaCommunicationBarringAuthorizationCode *Optional* | -|search_criteria_communication_barring_authorization_code_description |List[OCI.searchCriteriaCommunicationBarringAuthorizationCodeDescription] |searchCriteriaCommunicationBarringAuthorizationCodeDescription *Optional* | -|search_criteria_network_class_of_service_name |List[OCI.searchCriteriaNetworkClassOfServiceName] |searchCriteriaNetworkClassOfServiceName *Optional* | -
- - -## `EnterpriseDepartmentAddRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Add a department to enterprise. - -The response is either a `SuccessResponse()` or an `ErrorResponse()`. - -**Attributes:** - -|Name |Type |Description | -|----------------------|------------------------|-------------------------------| -|enterprise_id |str |enterpriseId | -|department_name |str |departmentName | -|parent_department_key |OCI.parentDepartmentKey |parentDepartmentKey *Optional* | -
- - -## `EnterpriseDepartmentModifyRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Modify a department of an enterprise. - -The response is either a `SuccessResponse()` or an `ErrorResponse()`. - -**Attributes:** - -|Name |Type |Description | -|--------------------------|---------------------------|----------------------------------| -|enterprise_id |str |enterpriseId | -|department_name |str |departmentName | -|new_department_name |str |newDepartmentName *Optional* | -|new_parent_department_key |OCI.newParentDepartmentKey |newParentDepartmentKey *Optional* | -
- - -## `EnterpriseEnterpriseTrunkGetAvailableTrunkGroupListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Request to get the list of all available trunk groups defined in an enterprise. - -It is possible to search by various criteria to restrict the number of rows returned. -Multiple search criteria are logically ANDed together. - -The response is either a -`EnterpriseEnterpriseTrunkGetAvailableTrunkGroupListResponse()` or an -`ErrorResponse()`. - -**Attributes:** - -|Name |Type |Description | -|---------------------------------|---------------------------------------|----------------------------------------| -|service_provider_id |str |serviceProviderId | -|response_size_limit |int |responseSizeLimit *Optional* | -|search_criteria_trunk_group_name |List[OCI.searchCriteriaTrunkGroupName] |searchCriteriaTrunkGroupName *Optional* | -|search_criteria_group_id |List[OCI.searchCriteriaGroupId] |searchCriteriaGroupId *Optional* | -
- - -## `EnterpriseLocalGatewayGetPagedSortedListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Get a list of local gateways defined within an enterprise. - -Only the local gateways having device associated are returned. If the -responsePagingControl element is not provided, the paging startIndex will be set to 1 -by default, and the responsePageSize will be set to the maximum ResponsePageSize by -default. If no sortOrder is included the response is sorted by Trunk group name -ascending by default. Multiple search criteria are logically ANDed together unless -the searchCriteriaModeOr option is included. Then the search criteria are logically -ORed together. - -The response is either a `EnterpriseLocalGatewayGetPagedSortedListResponse()` or an -`ErrorResponse()`. - -**Attributes:** - -|Name |Type |Description | -|---------------------------------|---------------------------------------|----------------------------------------| -|service_provider_id |str |serviceProviderId | -|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | -|sort_by_trunk_group_name |OCI.sortByTrunkGroupName |sortByTrunkGroupName *Optional* | -|search_criteria_trunk_group_name |List[OCI.searchCriteriaTrunkGroupName] |searchCriteriaTrunkGroupName *Optional* | -|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | -
- - -## `EnterpriseSessionAdmissionControlGetAvailableDeviceListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Request to get the list of devices can be assigned to session admission control group -for the enterprise. - -The response is either an -`EnterpriseSessionAdmissionControlGetAvailableDeviceListResponse()` or an -`ErrorResponse()`. - -**Attributes:** - -|Name |Type |Description | -|-----------------------------------|-----------------------------------------|------------------------------------------| -|service_provider_id |str |serviceProviderId | -|response_size_limit |int |responseSizeLimit *Optional* | -|search_criteria_device_name |List[OCI.searchCriteriaDeviceName] |searchCriteriaDeviceName *Optional* | -|search_criteria_device_mac_address |List[OCI.searchCriteriaDeviceMACAddress] |searchCriteriaDeviceMACAddress *Optional* | -|search_criteria_device_net_address |List[OCI.searchCriteriaDeviceNetAddress] |searchCriteriaDeviceNetAddress *Optional* | -|search_criteria_group_id |List[OCI.searchCriteriaGroupId] |searchCriteriaGroupId *Optional* | -|search_criteria_exact_device_type |OCI.searchCriteriaExactDeviceType |searchCriteriaExactDeviceType *Optional* | -|search_criteria_exact_device_level |OCI.searchCriteriaExactDeviceLevel |searchCriteriaExactDeviceLevel *Optional* | -
- - -## `EnterpriseVirtualOnNetEnterpriseExtensionsGetUserListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Request the list of Virtual On-Net users in an Enterprise. - -It is possible to search by various criteria to restrict the number of rows returned. -Multiple search criteria are logically ANDed together. - -The response is either a -`EnterpriseVirtualOnNetEnterpriseExtensionsGetUserListResponse()` or an -`ErrorResponse()`. - -**Attributes:** - -|Name |Type |Description | -|----------------------------------------------------|------------------------------------------------|-------------------------------------------------------| -|service_provider_id |str |serviceProviderId | -|response_size_limit |int |responseSizeLimit *Optional* | -|search_criteria_user_last_name |List[OCI.searchCriteriaUserLastName] |searchCriteriaUserLastName *Optional* | -|search_criteria_user_first_name |List[OCI.searchCriteriaUserFirstName] |searchCriteriaUserFirstName *Optional* | -|search_criteria_dn |List[OCI.searchCriteriaDn] |searchCriteriaDn *Optional* | -|search_criteria_group_location_code |List[OCI.searchCriteriaGroupLocationCode] |searchCriteriaGroupLocationCode *Optional* | -|search_criteria_extension |List[OCI.searchCriteriaExtension] |searchCriteriaExtension *Optional* | -|search_criteria_exact_virtual_on_net_call_type_name |OCI.searchCriteriaExactVirtualOnNetCallTypeName |searchCriteriaExactVirtualOnNetCallTypeName *Optional* | -
- - ## `EnterpriseVoiceVPNAddPolicyRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -49458,28 +49166,6 @@ The response is either a `SuccessResponse()` or an `ErrorResponse()`.
-## `EnterpriseVoiceVPNGetPolicyListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Request the list of Voice VPN locations. - -It is possible to search by various criteria to restrict the number of rows returned. -Multiple search criteria are logically ANDed together. - -The response is either a `EnterpriseVoiceVPNGetPolicyListResponse()` or an -`ErrorResponse()`. - -**Attributes:** - -|Name |Type |Description | -|---------------------------------------|------------------------------------------|----------------------------------------------| -|service_provider_id |str |serviceProviderId | -|response_size_limit |int |responseSizeLimit *Optional* | -|search_criteria_group_location_code |List[OCI.searchCriteriaGroupLocationCode] |searchCriteriaGroupLocationCode *Optional* | -|search_criteria_exact_policy_selection |OCI.searchCriteriaExactPolicySelection |searchCriteriaExactPolicySelection *Optional* | -
- - ## `EnterpriseVoiceVPNModifyPolicyRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -49696,73 +49382,6 @@ The response is either a `SuccessResponse()` or an `ErrorResponse()`.
-## `GroupAccessDeviceGetListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Requests the list of access devices in a group. - -The following elements are only used in AS data mode and ignored in XS data mode: -groupExternalId - -The response is either `GroupAccessDeviceGetListResponse()` or `ErrorResponse()`. - -**Attributes:** - -|Name |Type |Description | -|--------------------------------------|--------------------------------------------|---------------------------------------------| -|service_provider_id |str |serviceProviderId *Optional* | -|group_id |str |groupId *Optional* | -|group_external_id |str |groupExternalId *Optional* | -|response_size_limit |int |responseSizeLimit *Optional* | -|search_criteria_device_name |List[OCI.searchCriteriaDeviceName] |searchCriteriaDeviceName *Optional* | -|search_criteria_device_mac_address |List[OCI.searchCriteriaDeviceMACAddress] |searchCriteriaDeviceMACAddress *Optional* | -|search_criteria_device_net_address |List[OCI.searchCriteriaDeviceNetAddress] |searchCriteriaDeviceNetAddress *Optional* | -|search_criteria_exact_device_type |OCI.searchCriteriaExactDeviceType |searchCriteriaExactDeviceType *Optional* | -|search_criteria_access_device_version |List[OCI.searchCriteriaAccessDeviceVersion] |searchCriteriaAccessDeviceVersion *Optional* | -
- - -## `GroupAccessDeviceGetPagedSortedListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Requests the list of access devices in a group. - -The response is either `GroupAccessDeviceGetPagedSortedListResponse()` or -`ErrorResponse()`. If no sortOrder is included, the response is sorted by Device Name -ascending by default. If the responsePagingControl element is not provided, the -paging startIndex will be set to 1 by default, and the responsePageSize will be set to -the maximum responsePageSize by default. Multiple search criteria are logically ANDed -together unless the searchCriteriaModeOr option is included. Then the search criteria -are logically ORed together. The getVisualDeviceManagementAPIDevicesOnly element can -only be set when CloudPBX is licenced. If the getVisualDeviceManagementAPIDevicesOnly -element is not set, all devices are returned with Visual Device Management API flag -set to empty. If the getVisualDeviceManagementAPIDevicesOnly element is set to true, -only SIP devices supporting Visual Device Management API are returned. If the -getVisualDeviceManagementAPIDevicesOnly element is set to false, all SIP devices are -returned with their current Visual Device Management API flag value. Replaced by -`GroupAccessDeviceGetPagedSortedListRequest22()`. - -**Attributes:** - -|Name |Type |Description | -|----------------------------------------------|--------------------------------------------|---------------------------------------------------| -|service_provider_id |str |serviceProviderId | -|group_id |str |groupId | -|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | -|sort_by_device_name |OCI.sortByDeviceName |sortByDeviceName *Optional* | -|sort_by_device_type |OCI.sortByDeviceType |sortByDeviceType *Optional* | -|sort_by_device_net_address |OCI.sortByDeviceNetAddress |sortByDeviceNetAddress *Optional* | -|sort_by_device_mac_address |OCI.sortByDeviceMACAddress |sortByDeviceMACAddress *Optional* | -|search_criteria_device_name |List[OCI.searchCriteriaDeviceName] |searchCriteriaDeviceName *Optional* | -|search_criteria_device_mac_address |List[OCI.searchCriteriaDeviceMACAddress] |searchCriteriaDeviceMACAddress *Optional* | -|search_criteria_device_net_address |List[OCI.searchCriteriaDeviceNetAddress] |searchCriteriaDeviceNetAddress *Optional* | -|search_criteria_exact_device_type |List[OCI.searchCriteriaExactDeviceType] |searchCriteriaExactDeviceType *Optional* | -|search_criteria_access_device_version |List[OCI.searchCriteriaAccessDeviceVersion] |searchCriteriaAccessDeviceVersion *Optional* | -|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | -|get_visual_device_management_api_devices_only |bool |getVisualDeviceManagementAPIDevicesOnly *Optional* | -
- - ## `GroupAccessDeviceLinkDeviceListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -50001,64 +49620,6 @@ announcementFileExternalId The response is either a `SuccessResponse()` or an
-## `GroupAnnouncementFileGetListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Get the list of available announcement files for a Group. - -The following elements are only used in AS data mode and ignored in XS data mode: -groupExternalId - -The response is either a `GroupAnnouncementFileGetListResponse()` or an -`ErrorResponse()`. - -**Attributes:** - -|Name |Type |Description | -|---------------------------------------|---------------------------------------------|----------------------------------------------| -|service_provider_id |str |serviceProviderId *Optional* | -|group_id |str |groupId *Optional* | -|group_external_id |str |groupExternalId *Optional* | -|announcement_file_type |str |announcementFileType *Optional* | -|include_announcement_table |bool |includeAnnouncementTable | -|response_size_limit |int |responseSizeLimit *Optional* | -|search_criteria_announcement_file_name |List[OCI.searchCriteriaAnnouncementFileName] |searchCriteriaAnnouncementFileName *Optional* | -
- - -## `GroupAnnouncementFileGetPagedSortedListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Get the list of available announcement files for a Group. - -If the responsePagingControl element is not provided, the paging startIndex will be -set to 1 by default, and the responsePageSize will be set to the maximum -responsePageSize by default. If no sortOrder is included, the response is sorted by -Name ascending by default. Multiple search criteria are logically ANDed together -unless the searchCriteriaModeOr option is included. Then the search criteria are -logically ORed together. The following elements are only used in AS data mode and -ignored in XS data mode: groupExternalId - -The response is either a `GroupAnnouncementFileGetPagedSortedListResponse()` or an -`ErrorResponse()`. - -**Attributes:** - -|Name |Type |Description | -|---------------------------------------------|---------------------------------------------|---------------------------------------------------| -|service_provider_id |str |serviceProviderId *Optional* | -|group_id |str |groupId *Optional* | -|group_external_id |str |groupExternalId *Optional* | -|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | -|sort_by_announcement_file_name |OCI.sortByAnnouncementFileName |sortByAnnouncementFileName *Optional* | -|sort_by_announcement_file_size |OCI.sortByAnnouncementFileSize |sortByAnnouncementFileSize *Optional* | -|search_criteria_announcement_file_name |List[OCI.searchCriteriaAnnouncementFileName] |searchCriteriaAnnouncementFileName *Optional* | -|search_criteria_exact_announcement_file_type |OCI.searchCriteriaExactAnnouncementFileType |searchCriteriaExactAnnouncementFileType *Optional* | -|search_criteria_exact_media_file_type |List[OCI.searchCriteriaExactMediaFileType] |searchCriteriaExactMediaFileType *Optional* | -|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | -
- - ## `GroupAnnouncementFileGetRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -50343,49 +49904,6 @@ The response is either a `SuccessResponse()` or an `ErrorResponse()`.
-## `GroupCallCenterCurrentAndPastAgentGetListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Request to get all the current and past agents for the group. - -The response is either `GroupCallCenterCurrentAndPastAgentGetListResponse()` or -`ErrorResponse()`. - -**Attributes:** - -|Name |Type |Description | -|--------------------------------|--------------------------------------|---------------------------------------| -|service_provider_id |str |serviceProviderId | -|group_id |str |groupId | -|response_size_limit |int |responseSizeLimit *Optional* | -|search_criteria_user_last_name |List[OCI.searchCriteriaUserLastName] |searchCriteriaUserLastName *Optional* | -|search_criteria_user_first_name |List[OCI.searchCriteriaUserFirstName] |searchCriteriaUserFirstName *Optional* | -|search_criteria_user_id |List[OCI.searchCriteriaUserId] |searchCriteriaUserId *Optional* | -|search_criteria_dn |List[OCI.searchCriteriaDn] |searchCriteriaDn *Optional* | -|search_criteria_extension |List[OCI.searchCriteriaExtension] |searchCriteriaExtension *Optional* | -
- - -## `GroupCallCenterCurrentAndPastCallCenterGetListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Request to get all the current and past call centers for the group. - -The response is either `GroupCallCenterCurrentAndPastCallCenterGetListResponse()` or -`ErrorResponse()`. - -**Attributes:** - -|Name |Type |Description | -|---------------------------------|---------------------------------|----------------------------------------| -|service_provider_id |str |serviceProviderId | -|is_premium_only |bool |isPremiumOnly *Optional* | -|group_id |str |groupId | -|response_size_limit |int |responseSizeLimit *Optional* | -|search_criteria_call_center_name |OCI.searchCriteriaCallCenterName |searchCriteriaCallCenterName *Optional* | -
- - ## `GroupCallCenterDeleteDNISRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -50477,43 +49995,6 @@ The response is either a `SuccessResponse()` or an `ErrorResponse()`.
-## `GroupCallCenterGetAgentPagedSortedListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Get a list of agents assigned to a call center. - -If the responsePagingControl element is not provided, the paging startIndex will be -set to 1 by default, and the responsePageSize will be set to the maximum -ResponsePageSize by default. It is possible to search by various criteria to restrict -the number of rows returned. Multiple search criteria are logically ANDed together -unless the searchCriteriaModeOr option is included. Then the search criteria are -logically ORed together. `ErrorResponse()` is returned if -searchCriteriaExactUserGroup or searchCriteriaExactSkillLevel have multiple entries -and searchCriteriaModeOr is not included. Sorting is done on either a priority basis -or a skill basis depending on the type of call center. - -The response is either a `GroupCallCenterGetAgentPagedSortedListResponse()` or an -`ErrorResponse()`. - -**Attributes:** - -|Name |Type |Description | -|----------------------------------|----------------------------------------|-----------------------------------------| -|service_user_id |str |serviceUserId | -|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | -|search_criteria_user_id |List[OCI.searchCriteriaUserId] |searchCriteriaUserId *Optional* | -|search_criteria_user_last_name |List[OCI.searchCriteriaUserLastName] |searchCriteriaUserLastName *Optional* | -|search_criteria_user_first_name |List[OCI.searchCriteriaUserFirstName] |searchCriteriaUserFirstName *Optional* | -|search_criteria_dn |List[OCI.searchCriteriaDn] |searchCriteriaDn *Optional* | -|search_criteria_extension |List[OCI.searchCriteriaExtension] |searchCriteriaExtension *Optional* | -|search_criteria_department_name |List[OCI.searchCriteriaDepartmentName] |searchCriteriaDepartmentName *Optional* | -|search_criteria_email_address |List[OCI.searchCriteriaEmailAddress] |searchCriteriaEmailAddress *Optional* | -|search_criteria_exact_skill_level |List[OCI.searchCriteriaExactSkillLevel] |searchCriteriaExactSkillLevel *Optional* | -|search_criteria_exact_user_group |List[OCI.searchCriteriaExactUserGroup] |searchCriteriaExactUserGroup *Optional* | -|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | -
- - ## `GroupCallCenterGetDNISAgentListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -50872,69 +50353,6 @@ Replaced By: `GroupCallCenterModifySupervisorListRequest16()`
-## `GroupCallParkGetInstancePagedSortedListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Request to get a list of Call Park group instances within a group. - -If the responsePagingControl element is not provided, the paging startIndex will be -set to 1 by default, and the responsePageSize will be set to the maximum -ResponsePageSize by default. It is possible to search by various criteria to restrict -the number of rows returned. Multiple search criteria are logically ANDed together -unless the searchCriteriaModeOr option is included. Then the search criteria are -logically ORed together. - -The response is either `GroupCallParkGetInstancePagedSortedListResponse()` or -`ErrorResponse()`. - -**Attributes:** - -|Name |Type |Description | -|-------------------------------|-------------------------------------|--------------------------------------| -|service_provider_id |str |serviceProviderId | -|group_id |str |groupId | -|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | -|sort_by_call_park_name |OCI.sortByCallParkName |sortByCallParkName *Optional* | -|search_criteria_call_park_name |List[OCI.searchCriteriaCallParkName] |searchCriteriaCallParkName *Optional* | -|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | -
- - -## `GroupCallParkGetInstancePagedSortedRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Gets a Call Park group. - -If the responsePagingControl element is not provided, the paging startIndex will be -set to 1 by default, and the responsePageSize will be set to the maximum -ResponsePageSize by default. It is possible to search by various criteria to restrict -the number of rows returned. The sort order is based on the user order provided when -creating or modifying the call park instance. Multiple search criteria are logically -ANDed together unless the searchCriteriaModeOr option is included. Then the search -criteria are logically ORed together. - -The response is either `GroupCallParkGetInstancePagedSortedResponse()` or -`ErrorResponse()`. - -**Attributes:** - -|Name |Type |Description | -|--------------------------------|---------------------------------------|----------------------------------------| -|service_provider_id |str |serviceProviderId | -|group_id |str |groupId | -|name |str |name | -|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | -|search_criteria_user_id |List[OCI.searchCriteriaUserId] |searchCriteriaUserId *Optional* | -|search_criteria_user_last_name |List[OCI.searchCriteriaUserLastName] |searchCriteriaUserLastName *Optional* | -|search_criteria_user_first_name |List[OCI.searchCriteriaUserFirstName] |searchCriteriaUserFirstName *Optional* | -|search_criteria_dn |List[OCI.searchCriteriaDn] |searchCriteriaDn *Optional* | -|search_criteria_extension |List[OCI.searchCriteriaExtension] |searchCriteriaExtension *Optional* | -|search_criteria_department_name |List[OCI.searchCriteriaDepartmentName] |searchCriteriaDepartmentName *Optional* | -|search_criteria_email_address |List[OCI.searchCriteriaEmailAddress] |searchCriteriaEmailAddress *Optional* | -|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | -
- - ## `GroupCallParkModifyInstanceRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -50959,34 +50377,6 @@ The response is either `SuccessResponse()` or `ErrorResponse()`.
-## `GroupCallPickupGetInstancePagedSortedListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Request to get a list of Call Pickup instances within a group. - -If the responsePagingControl element is not provided, the paging startIndex will be -set to 1 by default, and the responsePageSize will be set to the maximum -ResponsePageSize by default. It is possible to search by various criteria to restrict -the number of rows returned. Multiple search criteria are logically ANDed together -unless the searchCriteriaModeOr option is included. Then the search criteria are -logically ORed together. - -The response is either `GroupCallPickupGetInstancePagedSortedListResponse()` or -`ErrorResponse()`. - -**Attributes:** - -|Name |Type |Description | -|---------------------------------|---------------------------------------|----------------------------------------| -|service_provider_id |str |serviceProviderId | -|group_id |str |groupId | -|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | -|sort_by_call_pickup_name |OCI.sortByCallPickupName |sortByCallPickupName *Optional* | -|search_criteria_call_pickup_name |List[OCI.searchCriteriaCallPickupName] |searchCriteriaCallPickupName *Optional* | -|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | -
- - ## `GroupCallPickupModifyInstanceRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -51025,33 +50415,6 @@ The response is either a `SuccessResponse()` or an `ErrorResponse()`.
-## `GroupCommonPhoneListGetListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Get a group's common phone list. - -The response is either a `GroupCommonPhoneListGetListResponse()` or an -`ErrorResponse()`. The search can be done using multiple criterion. If the -searchCriteriaModeOr is present, any result matching any one criteria is included in -the results. Otherwise, only results matching all the search criterion are included -in the results. If no search criteria is specified, all results are returned. -Specifying searchCriteriaModeOr without any search criteria results in an -`ErrorResponse()`. In all cases, if a responseSizeLimit is specified and the number of -matching results is more than this limit, then an `ErrorResponse()` is returned. - -**Attributes:** - -|Name |Type |Description | -|-----------------------------------------------|---------------------------------------------------|----------------------------------------------------| -|service_provider_id |str |serviceProviderId | -|group_id |str |groupId | -|response_size_limit |int |responseSizeLimit *Optional* | -|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | -|search_criteria_group_common_phone_list_name |List[OCI.searchCriteriaGroupCommonPhoneListName] |searchCriteriaGroupCommonPhoneListName *Optional* | -|search_criteria_group_common_phone_list_number |List[OCI.searchCriteriaGroupCommonPhoneListNumber] |searchCriteriaGroupCommonPhoneListNumber *Optional* | -
- - ## `GroupCommunicationBarringAuthorizationCodeAddListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -51087,28 +50450,6 @@ The response is either a `SuccessResponse()` or an `ErrorResponse()`.
-## `GroupCommunicationBarringAuthorizationCodeGetListRequest21sp1`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Get a list of Communication Barring Authorization Codes for a group. - -The response is either -`GroupCommunicationBarringAuthorizationCodeGetListResponse21sp1()` or -`ErrorResponse()`. - -**Attributes:** - -|Name |Type |Description | -|---------------------------------------------------------------------|-------------------------------------------------------------------------|--------------------------------------------------------------------------| -|service_provider_id |str |serviceProviderId | -|group_id |str |groupId | -|response_size_limit |int |responseSizeLimit *Optional* | -|search_criteria_communication_barring_authorization_code |List[OCI.searchCriteriaCommunicationBarringAuthorizationCode] |searchCriteriaCommunicationBarringAuthorizationCode *Optional* | -|search_criteria_communication_barring_authorization_code_description |List[OCI.searchCriteriaCommunicationBarringAuthorizationCodeDescription] |searchCriteriaCommunicationBarringAuthorizationCodeDescription *Optional* | -|search_criteria_network_class_of_service_name |List[OCI.searchCriteriaNetworkClassOfServiceName] |searchCriteriaNetworkClassOfServiceName *Optional* | -
- - ## `GroupCommunicationBarringProfileModifyListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -51209,42 +50550,6 @@ elements are only used in AS data mode: callingLineIdName caliingLineIdPhoneNumb
-## `GroupDepartmentAdminAddRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Add a department administrator to a group department. - -The response is either a `SuccessResponse()` or an `ErrorResponse()`. - -**Attributes:** - -|Name |Type |Description | -|---------------|------------------|---------------------| -|department_key |OCI.departmentKey |departmentKey | -|user_id |str |userId | -|first_name |str |firstName *Optional* | -|last_name |str |lastName *Optional* | -|password |str |password *Optional* | -|language |str |language *Optional* | -
- - -## `GroupDepartmentAdminGetListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Get a list of department administrators for the department. - -The response is either a `GroupDepartmentAdminGetListResponse()` or an -`ErrorResponse()`. - -**Attributes:** - -|Name |Type |Description | -|---------------|------------------|--------------| -|department_key |OCI.departmentKey |departmentKey | -
- - ## `GroupDepartmentModifyRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -51267,64 +50572,6 @@ elements are only used in AS data mode: callingLineIdName caliingLineIdPhoneNumb
-## `GroupDeviceManagementEventGetListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Request device management's events for a specific queue. - -It is possible to restrict the number of rows returned using responseSizeLimit. If -eventQueueType is not specified, the events from all the event queues are returned. - -The response is either a `GroupDeviceManagementEventGetListResponse()` or an -`ErrorResponse()`. - -**Attributes:** - -|Name |Type |Description | -|----------------------------------------------------------------------------|----------------------------------------------------------------------|-----------------------------------------------------------------------------| -|service_provider_id |str |serviceProviderId | -|group_id |str |groupId | -|event_queue_type |str |eventQueueType *Optional* | -|response_size_limit |int |responseSizeLimit *Optional* | -|search_criteria_exact_device_management_event_status_in_progress_or_pending |OCI.searchCriteriaExactDeviceManagementEventStatusInProgressOrPending |searchCriteriaExactDeviceManagementEventStatusInProgressOrPending *Optional* | -|search_criteria_exact_device_management_event_status_completed |OCI.searchCriteriaExactDeviceManagementEventStatusCompleted |searchCriteriaExactDeviceManagementEventStatusCompleted *Optional* | -|search_criteria_exact_device_management_event_action |OCI.searchCriteriaExactDeviceManagementEventAction |searchCriteriaExactDeviceManagementEventAction *Optional* | -|search_criteria_exact_device_management_event_level |OCI.searchCriteriaExactDeviceManagementEventLevel |searchCriteriaExactDeviceManagementEventLevel *Optional* | -|search_criteria_exact_device_management_event_type |OCI.searchCriteriaExactDeviceManagementEventType |searchCriteriaExactDeviceManagementEventType *Optional* | -|search_criteria_device_management_event_additional_info |List[OCI.searchCriteriaDeviceManagementEventAdditionalInfo] |searchCriteriaDeviceManagementEventAdditionalInfo *Optional* | -|search_criteria_device_management_event_login_id |List[OCI.searchCriteriaDeviceManagementEventLoginId] |searchCriteriaDeviceManagementEventLoginId *Optional* | -
- - -## `GroupDeviceManagementEventGetListRequest22`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Request device management's events for a specific queue. - -It is possible to restrict the number of rows returned using responseSizeLimit. If -eventQueueType is not specified, the events from all the event queues are returned. - -The response is either a `GroupDeviceManagementEventGetListResponse22()` or an -`ErrorResponse()`. - -**Attributes:** - -|Name |Type |Description | -|----------------------------------------------------------------------------|----------------------------------------------------------------------|-----------------------------------------------------------------------------| -|service_provider_id |str |serviceProviderId | -|group_id |str |groupId | -|event_queue_type |str |eventQueueType *Optional* | -|response_size_limit |int |responseSizeLimit *Optional* | -|search_criteria_exact_device_management_event_status_in_progress_or_pending |OCI.searchCriteriaExactDeviceManagementEventStatusInProgressOrPending |searchCriteriaExactDeviceManagementEventStatusInProgressOrPending *Optional* | -|search_criteria_exact_device_management_event_status_completed |OCI.searchCriteriaExactDeviceManagementEventStatusCompleted |searchCriteriaExactDeviceManagementEventStatusCompleted *Optional* | -|search_criteria_exact_device_management_event_action |OCI.searchCriteriaExactDeviceManagementEventAction |searchCriteriaExactDeviceManagementEventAction *Optional* | -|search_criteria_exact_device_management_event_level |OCI.searchCriteriaExactDeviceManagementEventLevel |searchCriteriaExactDeviceManagementEventLevel *Optional* | -|search_criteria_exact_device_management_event_type |OCI.searchCriteriaExactDeviceManagementEventType |searchCriteriaExactDeviceManagementEventType *Optional* | -|search_criteria_device_management_event_additional_info |List[OCI.searchCriteriaDeviceManagementEventAdditionalInfo] |searchCriteriaDeviceManagementEventAdditionalInfo *Optional* | -|search_criteria_device_management_event_login_id |List[OCI.searchCriteriaDeviceManagementEventLoginId] |searchCriteriaDeviceManagementEventLoginId *Optional* | -
- - ## `GroupDeviceTypeFileModifyRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -51579,28 +50826,6 @@ The response is either a `SuccessResponse()` or an `ErrorResponse()`.
-## `GroupEnterpriseTrunkGetAvailableTrunkGroupListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Request to get the list of all available trunk groups defined in a group. - -It is possible to search by various criteria to restrict the number of rows returned. -Multiple search criteria are logically ANDed together. - -The response is either a `GroupEnterpriseTrunkGetAvailableTrunkGroupListResponse()` or -an `ErrorResponse()`. - -**Attributes:** - -|Name |Type |Description | -|---------------------------------|---------------------------------------|----------------------------------------| -|service_provider_id |str |serviceProviderId | -|group_id |str |groupId | -|response_size_limit |int |responseSizeLimit *Optional* | -|search_criteria_trunk_group_name |List[OCI.searchCriteriaTrunkGroupName] |searchCriteriaTrunkGroupName *Optional* | -
- - ## `GroupExchangeIntegrationModifyRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -51787,54 +51012,6 @@ The response is either `SuccessResponse()` or `ErrorResponse()`.
-## `GroupGetListInServiceProviderRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Request the list of groups in a service provider or enterprise. - -It is possible to search by various criteria to restrict the number of rows returned. -Multiple search criteria are logically ANDed together. - -The response is either a `GroupGetListInServiceProviderResponse()` or an -`ErrorResponse()`. - -**Attributes:** - -|Name |Type |Description | -|---------------------------|----------------------------------|-----------------------------------| -|service_provider_id |str |serviceProviderId | -|response_size_limit |int |responseSizeLimit *Optional* | -|search_criteria_group_id |List[OCI.searchCriteriaGroupId] |searchCriteriaGroupId *Optional* | -|search_criteria_group_name |List[OCI.searchCriteriaGroupName] |searchCriteriaGroupName *Optional* | -
- - -## `GroupGetListInSystemRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Request the list of groups in the system. - -It is possible to search by various criteria to restrict the number of rows returned. -Multiple search criteria are logically ANDed together. If reseller administrator -sends the request, searchCriteriaResellerId is ignored. All the groups in the -administrator's reseller meeting the search criteria are returned. - -The response is either a `GroupGetListInSystemResponse()` or an `ErrorResponse()`. The -following data elements are only used in AS data mode: searchCriteriaResellerId - -**Attributes:** - -|Name |Type |Description | -|---------------------------------------|------------------------------------------|----------------------------------------------| -|response_size_limit |int |responseSizeLimit *Optional* | -|search_criteria_group_id |List[OCI.searchCriteriaGroupId] |searchCriteriaGroupId *Optional* | -|search_criteria_group_name |List[OCI.searchCriteriaGroupName] |searchCriteriaGroupName *Optional* | -|search_criteria_exact_service_provider |OCI.searchCriteriaExactServiceProvider |searchCriteriaExactServiceProvider *Optional* | -|search_criteria_service_provider_id |List[OCI.searchCriteriaServiceProviderId] |searchCriteriaServiceProviderId *Optional* | -|search_criteria_reseller_id |List[OCI.searchCriteriaResellerId] |searchCriteriaResellerId *Optional* | -
- - ## `GroupGroupNightForwardingModifyRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -52917,28 +52094,6 @@ The response is either a `SuccessResponse()` or an `ErrorResponse()`.
-## `GroupRoutePointExternalSystemGetAssignedRoutePointListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Request a list of route points within in a group that have a given external system -assigned. - -The response is either -`GroupRoutePointExternalSystemGetAssignedRoutePointListResponse()` or -`ErrorResponse()`. - -**Attributes:** - -|Name |Type |Description | -|---------------------------------|---------------------------------------|----------------------------------------| -|service_provider_id |str |serviceProviderId | -|group_id |str |groupId | -|external_system |str |externalSystem | -|response_size_limit |int |responseSizeLimit *Optional* | -|search_criteria_route_point_name |List[OCI.searchCriteriaRoutePointName] |searchCriteriaRoutePointName *Optional* | -
- - ## `GroupRoutePointGetDNISAgentListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -53032,28 +52187,6 @@ The response is either a `GroupRoutePointGetDNISResponse()` or an `ErrorResponse
-## `GroupRoutePointGetInstanceListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Get a list of Route Point instances within a group. - -It is possible to search by various criteria to restrict the number of rows returned. - -The response is either `GroupRoutePointGetInstanceListResponse()` or -`ErrorResponse()`. It is possible to get the instances within a specified department. - -**Attributes:** - -|Name |Type |Description | -|---------------------------------|---------------------------------------|----------------------------------------| -|service_provider_id |str |serviceProviderId | -|group_id |str |groupId | -|group_department_name |str |groupDepartmentName *Optional* | -|response_size_limit |int |responseSizeLimit *Optional* | -|search_criteria_route_point_name |List[OCI.searchCriteriaRoutePointName] |searchCriteriaRoutePointName *Optional* | -
- - ## `GroupRoutePointModifyActiveInstanceListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -53230,34 +52363,6 @@ The response is either a `GroupScheduleGetEventResponse()` or an `ErrorResponse(
-## `GroupScheduleGetPagedSortedListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Get the list of schedules viewable by a group. - -The response is either a `GroupScheduleGetPagedSortedListResponse()` or an -`ErrorResponse()`. If no sortOrder is included, the response is sorted by Name -ascending by default. If the responsePagingControl element is not provided, the -paging startIndex will be set to 1 by default, and the responsePageSize will be set to -the maximum responsePageSize by default. Multiple search criteria are logically ANDed -together unless the searchCriteriaModeOr option is included. Then the search criteria -are logically ORed together. - -**Attributes:** - -|Name |Type |Description | -|-------------------------------------|-------------------------------------------|--------------------------------------------| -|service_provider_id |str |serviceProviderId | -|group_id |str |groupId | -|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | -|sort_by_schedule_name |OCI.sortByScheduleName |sortByScheduleName *Optional* | -|search_criteria_schedule_name |List[OCI.searchCriteriaScheduleName] |searchCriteriaScheduleName *Optional* | -|search_criteria_exact_schedule_type |List[OCI.searchCriteriaExactScheduleType] |searchCriteriaExactScheduleType *Optional* | -|search_criteria_exact_schedule_level |List[OCI.searchCriteriaExactScheduleLevel] |searchCriteriaExactScheduleLevel *Optional* | -|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | -
- - ## `GroupScheduleModifyEventRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -53342,31 +52447,6 @@ The response is either `SuccessResponse()` or `ErrorResponse()`.
-## `GroupSessionAdmissionControlGetAvailableDeviceListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Request to get the list of devices can be assigned to session admission control group -for the group. - -The response is either an -`GroupSessionAdmissionControlGetAvailableDeviceListResponse()` or an -`ErrorResponse()`. - -**Attributes:** - -|Name |Type |Description | -|-----------------------------------|-----------------------------------------|------------------------------------------| -|service_provider_id |str |serviceProviderId | -|group_id |str |groupId | -|response_size_limit |int |responseSizeLimit *Optional* | -|search_criteria_device_name |List[OCI.searchCriteriaDeviceName] |searchCriteriaDeviceName *Optional* | -|search_criteria_device_mac_address |List[OCI.searchCriteriaDeviceMACAddress] |searchCriteriaDeviceMACAddress *Optional* | -|search_criteria_device_net_address |List[OCI.searchCriteriaDeviceNetAddress] |searchCriteriaDeviceNetAddress *Optional* | -|search_criteria_exact_device_type |OCI.searchCriteriaExactDeviceType |searchCriteriaExactDeviceType *Optional* | -|search_criteria_exact_device_level |OCI.searchCriteriaExactDeviceLevel |searchCriteriaExactDeviceLevel *Optional* | -
- - ## `GroupSessionAdmissionControlGroupAddDeviceListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -54320,32 +53400,6 @@ The response is either `GroupTrunkGroupUserCreationTaskGetResponse14sp4()` or
-## `GroupVirtualOnNetEnterpriseExtensionsGetUserListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Request the list of Virtual On-Net users in a Group. - -It is possible to search by various criteria to restrict the number of rows returned. -Multiple search criteria are logically ANDed together. - -The response is either a `GroupVirtualOnNetEnterpriseExtensionsGetUserListResponse()` -or an `ErrorResponse()`. - -**Attributes:** - -|Name |Type |Description | -|----------------------------------------------------|------------------------------------------------|-------------------------------------------------------| -|service_provider_id |str |serviceProviderId | -|group_id |str |groupId | -|response_size_limit |int |responseSizeLimit *Optional* | -|search_criteria_user_last_name |List[OCI.searchCriteriaUserLastName] |searchCriteriaUserLastName *Optional* | -|search_criteria_user_first_name |List[OCI.searchCriteriaUserFirstName] |searchCriteriaUserFirstName *Optional* | -|search_criteria_dn |List[OCI.searchCriteriaDn] |searchCriteriaDn *Optional* | -|search_criteria_extension |List[OCI.searchCriteriaExtension] |searchCriteriaExtension *Optional* | -|search_criteria_exact_virtual_on_net_call_type_name |OCI.searchCriteriaExactVirtualOnNetCallTypeName |searchCriteriaExactVirtualOnNetCallTypeName *Optional* | -
- - ## `GroupVoiceMessagingGroupModifyVoicePortalBrandingRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -54443,30 +53497,6 @@ The response is either a `SuccessResponse()` or an `ErrorResponse()`.
-## `GroupXsiPolicyProfileGetAssignedUserListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Get a list of user within a group that have a given user Xsi policy profile assigned. - -The response is either a `GroupXsiPolicyProfileGetAssignedUserListResponse()` or an -`ErrorResponse()`. - -**Attributes:** - -|Name |Type |Description | -|--------------------------------|--------------------------------------|---------------------------------------| -|service_provider_id |str |serviceProviderId | -|group_id |str |groupId | -|xsi_policy_profile |OCI.xsiPolicyProfile |xsiPolicyProfile | -|response_size_limit |int |responseSizeLimit *Optional* | -|search_criteria_user_id |List[OCI.searchCriteriaUserId] |searchCriteriaUserId *Optional* | -|search_criteria_user_last_name |List[OCI.searchCriteriaUserLastName] |searchCriteriaUserLastName *Optional* | -|search_criteria_user_first_name |List[OCI.searchCriteriaUserFirstName] |searchCriteriaUserFirstName *Optional* | -|search_criteria_dn |List[OCI.searchCriteriaDn] |searchCriteriaDn *Optional* | -|search_criteria_extension |List[OCI.searchCriteriaExtension] |searchCriteriaExtension *Optional* | -
- - ## `GroupXsiPolicyProfileUnassignListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -54506,26 +53536,6 @@ The response is either `PasswordGenerateResponse()` or `ErrorResponse()`.
-## `ResellerGetListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Request a list of resellers in the system. - -It is possible to search by various criteria to restrict the number of rows returned. -Multiple search criteria are logically ANDed together. - -The response is either a `ResellerGetListResponse()` or an `ErrorResponse()`. - -**Attributes:** - -|Name |Type |Description | -|------------------------------|-------------------------------------|--------------------------------------| -|response_size_limit |int |responseSizeLimit *Optional* | -|search_criteria_reseller_id |List[OCI.searchCriteriaResellerId] |searchCriteriaResellerId *Optional* | -|search_criteria_reseller_name |List[OCI.searchCriteriaResellerName] |searchCriteriaResellerName *Optional* | -
- - ## `ResellerNetworkClassOfServiceAssignListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -54545,28 +53555,6 @@ The response is either a `SuccessResponse()` or an `ErrorResponse()`.
-## `ResellerNetworkClassOfServiceGetAssignedServiceProviderListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Get a list of service provider/enterprises within a reseller that have a given Network -Class of Service assigned. - -The response is either a -`ResellerNetworkClassOfServiceGetAssignedServiceProviderListResponse()` or an -`ErorResponse()`. - -**Attributes:** - -|Name |Type |Description | -|--------------------------------------|--------------------------------------------|---------------------------------------------| -|reseller_id |str |resellerId | -|network_class_of_service |str |networkClassOfService | -|response_size_limit |int |responseSizeLimit *Optional* | -|search_criteria_service_provider_id |List[OCI.searchCriteriaServiceProviderId] |searchCriteriaServiceProviderId *Optional* | -|search_criteria_service_provider_name |List[OCI.searchCriteriaServiceProviderName] |searchCriteriaServiceProviderName *Optional* | -
- - ## `ResellerNetworkClassOfServiceUnassignListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -54621,29 +53609,6 @@ The response is either a `SuccessResponse()` or an `ErrorResponse()`.
-## `ResellerXsiPolicyProfileGetAssignedServiceProviderListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Get a list of service provider/enterprises within a reseller that have a given Service -provider Xsi policy profile assigned. - -The response is either a -`ResellerXsiPolichProfileGetAssignedServiceProviderListResponse()` or an -`ErrorResponse()`. - -**Attributes:** - -|Name |Type |Description | -|----------------------------------------|--------------------------------------------|-----------------------------------------------| -|reseller_id |str |resellerId | -|xsi_policy_profile |OCI.xsiPolicyProfile |xsiPolicyProfile | -|response_size_limit |int |responseSizeLimit *Optional* | -|search_criteria_service_provider_id |List[OCI.searchCriteriaServiceProviderId] |searchCriteriaServiceProviderId *Optional* | -|search_criteria_service_provider_name |List[OCI.searchCriteriaServiceProviderName] |searchCriteriaServiceProviderName *Optional* | -|search_criteria_exact_organization_type |OCI.searchCriteriaExactOrganizationType |searchCriteriaExactOrganizationType *Optional* | -
- - ## `ResellerXsiPolicyProfileUnassignListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -54830,71 +53795,6 @@ The response is either a `SuccessResponse()` or an `ErrorResponse()`.
-## `ServiceProviderAccessDeviceGetListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Requests the list of access devices in a service provider. - -The following elements are only used in AS data mode and ignored in XS data mode: -serviceProviderExternalId - -The response is either `ServiceProviderAccessDeviceGetListResponse()` or -`ErrorResponse()`. - -**Attributes:** - -|Name |Type |Description | -|--------------------------------------|--------------------------------------------|---------------------------------------------| -|service_provider_id |str |serviceProviderId *Optional* | -|service_provider_external_id |str |serviceProviderExternalId *Optional* | -|response_size_limit |int |responseSizeLimit *Optional* | -|search_criteria_device_name |List[OCI.searchCriteriaDeviceName] |searchCriteriaDeviceName *Optional* | -|search_criteria_device_mac_address |List[OCI.searchCriteriaDeviceMACAddress] |searchCriteriaDeviceMACAddress *Optional* | -|search_criteria_device_net_address |List[OCI.searchCriteriaDeviceNetAddress] |searchCriteriaDeviceNetAddress *Optional* | -|search_criteria_exact_device_type |OCI.searchCriteriaExactDeviceType |searchCriteriaExactDeviceType *Optional* | -|search_criteria_access_device_version |List[OCI.searchCriteriaAccessDeviceVersion] |searchCriteriaAccessDeviceVersion *Optional* | -
- - -## `ServiceProviderAccessDeviceGetPagedSortedListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Requests the list of service provider level access devices. - -The response is either `ServiceProviderAccessDeviceGetPagedSortedListResponse()` or -`ErrorResponse()`. If no sortOrder is included, the response is sorted by Device Name -ascending by default. If the responsePagingControl element is not provided, the -paging startIndex will be set to 1 by default, and the responsePageSize will be set to -the maximum responsePageSize by default. Multiple search criteria are logically ANDed -together unless the searchCriteriaModeOr option is included. Then the search criteria -are logically ORed together. The getVisualDeviceManagementAPIDevicesOnly element can -only be set when CloudPBX is licenced. If the getVisualDeviceManagementAPIDevicesOnly -element is not set, all devices are returned with Visual Device Management API flag -set to empty. If the getVisualDeviceManagementAPIDevicesOnly element is set to true, -only SIP devices supporting Visual Device Management API are returned. If the -getVisualDeviceManagementAPIDevicesOnly element is set to false, all SIP devices are -returned with their current Visual Device Management API flag value. - -**Attributes:** - -|Name |Type |Description | -|----------------------------------------------|--------------------------------------------|---------------------------------------------------| -|service_provider_id |str |serviceProviderId | -|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | -|sort_by_device_name |OCI.sortByDeviceName |sortByDeviceName *Optional* | -|sort_by_device_type |OCI.sortByDeviceType |sortByDeviceType *Optional* | -|sort_by_device_net_address |OCI.sortByDeviceNetAddress |sortByDeviceNetAddress *Optional* | -|sort_by_device_mac_address |OCI.sortByDeviceMACAddress |sortByDeviceMACAddress *Optional* | -|search_criteria_device_name |List[OCI.searchCriteriaDeviceName] |searchCriteriaDeviceName *Optional* | -|search_criteria_device_mac_address |List[OCI.searchCriteriaDeviceMACAddress] |searchCriteriaDeviceMACAddress *Optional* | -|search_criteria_device_net_address |List[OCI.searchCriteriaDeviceNetAddress] |searchCriteriaDeviceNetAddress *Optional* | -|search_criteria_exact_device_type |List[OCI.searchCriteriaExactDeviceType] |searchCriteriaExactDeviceType *Optional* | -|search_criteria_access_device_version |List[OCI.searchCriteriaAccessDeviceVersion] |searchCriteriaAccessDeviceVersion *Optional* | -|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | -|get_visual_device_management_api_devices_only |bool |getVisualDeviceManagementAPIDevicesOnly *Optional* | -
- - ## `ServiceProviderAccessDeviceLinkDeviceListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -55082,30 +53982,6 @@ The response is either a `SuccessResponse()` or an `ErrorResponse()`.
-## `ServiceProviderBroadWorksMobilityMobileSubscriberDirectoryNumberGetSummaryListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Request a summary table of all Mobile Subscriber Directory Numbers in a service -provider. - -This command is applicable only for service providers and will fail for enterprises. - -The response is either -`ServiceProviderBroadWorksMobilityMobileSubscriberDirectoryNumberGetSummaryListResponse()` -or `ErrorResponse()`. - -**Attributes:** - -|Name |Type |Description | -|---------------------------------------------------|--------------------------------------------------------|---------------------------------------------------------| -|service_provider_id |str |serviceProviderId | -|response_size_limit |int |responseSizeLimit *Optional* | -|search_criteria_mobile_subscriber_directory_number |List[OCI.searchCriteriaMobileSubscriberDirectoryNumber] |searchCriteriaMobileSubscriberDirectoryNumber *Optional* | -|search_criteria_group_id |List[OCI.searchCriteriaGroupId] |searchCriteriaGroupId *Optional* | -|search_criteria_exact_mobile_network |OCI.searchCriteriaExactMobileNetwork |searchCriteriaExactMobileNetwork *Optional* | -
- - ## `ServiceProviderCPEConfigSetConfigFileRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -55124,26 +54000,6 @@ configFile is set to nil, the configuration file defined at the parent level is
-## `ServiceProviderCommunicationBarringDigitPatternCriteriaGetPatternListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Get an existing Digit Pattern Criteria. - -The response is either a -`ServiceProviderCommunicationBarringDigitPatternCriteriaGetPatternListResponse()` or -an `ErrorResponse()`. - -**Attributes:** - -|Name |Type |Description | -|------------------------------|-------------------------------------|--------------------------------------| -|service_provider_id |str |serviceProviderId | -|name |str |name | -|response_size_limit |int |responseSizeLimit *Optional* | -|search_criteria_digit_pattern |List[OCI.searchCriteriaDigitPattern] |searchCriteriaDigitPattern *Optional* | -
- - ## `ServiceProviderCommunicationBarringProfileAddRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -55256,85 +54112,6 @@ use value "false" in XS data mode
-## `ServiceProviderCommunicationBarringProfileGetAssignedGroupListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Get a list of groups within a service provider that have a given Communication Barring -Profile assigned. - -The response is either a -`ServiceProviderCommunicationBarringProfileGetAssignedGroupListResponse()` or an -`ErorResponse()`. - -**Attributes:** - -|Name |Type |Description | -|---------------------------|----------------------------------|-----------------------------------| -|service_provider_id |str |serviceProviderId | -|profile |str |profile | -|response_size_limit |int |responseSizeLimit *Optional* | -|search_criteria_group_id |List[OCI.searchCriteriaGroupId] |searchCriteriaGroupId *Optional* | -|search_criteria_group_name |List[OCI.searchCriteriaGroupName] |searchCriteriaGroupName *Optional* | -
- - -## `ServiceProviderDeviceManagementEventGetListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Request device management's events for a specific queue. - -It is possible to restrict the number of rows returned using responseSizeLimit. If -eventQueueType is not specified, the events from all the event queues are returned. - -The response is either a `ServiceProviderDeviceManagementEventGetListResponse()` or an -`ErrorResponse()`. Deprecated by: -`ServiceProviderDeviceManagementEventGetListRequest22()`. - -**Attributes:** - -|Name |Type |Description | -|----------------------------------------------------------------------------|----------------------------------------------------------------------|-----------------------------------------------------------------------------| -|service_provider_id |str |serviceProviderId | -|event_queue_type |str |eventQueueType *Optional* | -|response_size_limit |int |responseSizeLimit *Optional* | -|search_criteria_exact_device_management_event_status_in_progress_or_pending |OCI.searchCriteriaExactDeviceManagementEventStatusInProgressOrPending |searchCriteriaExactDeviceManagementEventStatusInProgressOrPending *Optional* | -|search_criteria_exact_device_management_event_status_completed |OCI.searchCriteriaExactDeviceManagementEventStatusCompleted |searchCriteriaExactDeviceManagementEventStatusCompleted *Optional* | -|search_criteria_exact_device_management_event_action |OCI.searchCriteriaExactDeviceManagementEventAction |searchCriteriaExactDeviceManagementEventAction *Optional* | -|search_criteria_exact_device_management_event_level |OCI.searchCriteriaExactDeviceManagementEventLevel |searchCriteriaExactDeviceManagementEventLevel *Optional* | -|search_criteria_exact_device_management_event_type |OCI.searchCriteriaExactDeviceManagementEventType |searchCriteriaExactDeviceManagementEventType *Optional* | -|search_criteria_device_management_event_additional_info |List[OCI.searchCriteriaDeviceManagementEventAdditionalInfo] |searchCriteriaDeviceManagementEventAdditionalInfo *Optional* | -|search_criteria_device_management_event_login_id |List[OCI.searchCriteriaDeviceManagementEventLoginId] |searchCriteriaDeviceManagementEventLoginId *Optional* | -
- - -## `ServiceProviderDeviceManagementEventGetListRequest22`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Request device management's events for a specific queue. - -It is possible to restrict the number of rows returned using responseSizeLimit. If -eventQueueType is not specified, the events from all the event queues are returned. - -The response is either a `ServiceProviderDeviceManagementEventGetListResponse22()` or -an `ErrorResponse()`. - -**Attributes:** - -|Name |Type |Description | -|----------------------------------------------------------------------------|----------------------------------------------------------------------|-----------------------------------------------------------------------------| -|service_provider_id |str |serviceProviderId | -|event_queue_type |str |eventQueueType *Optional* | -|response_size_limit |int |responseSizeLimit *Optional* | -|search_criteria_exact_device_management_event_status_in_progress_or_pending |OCI.searchCriteriaExactDeviceManagementEventStatusInProgressOrPending |searchCriteriaExactDeviceManagementEventStatusInProgressOrPending *Optional* | -|search_criteria_exact_device_management_event_status_completed |OCI.searchCriteriaExactDeviceManagementEventStatusCompleted |searchCriteriaExactDeviceManagementEventStatusCompleted *Optional* | -|search_criteria_exact_device_management_event_action |OCI.searchCriteriaExactDeviceManagementEventAction |searchCriteriaExactDeviceManagementEventAction *Optional* | -|search_criteria_exact_device_management_event_level |OCI.searchCriteriaExactDeviceManagementEventLevel |searchCriteriaExactDeviceManagementEventLevel *Optional* | -|search_criteria_exact_device_management_event_type |OCI.searchCriteriaExactDeviceManagementEventType |searchCriteriaExactDeviceManagementEventType *Optional* | -|search_criteria_device_management_event_additional_info |List[OCI.searchCriteriaDeviceManagementEventAdditionalInfo] |searchCriteriaDeviceManagementEventAdditionalInfo *Optional* | -|search_criteria_device_management_event_login_id |List[OCI.searchCriteriaDeviceManagementEventLoginId] |searchCriteriaDeviceManagementEventLoginId *Optional* | -
- - ## `ServiceProviderDeviceTypeFileModifyRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -55441,73 +54218,6 @@ The response is either `SuccessResponse()` or `ErrorResponse()`.
-## `ServiceProviderDnGetSummaryListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Request a summary table of all DNs in a service provider. - -Dns assigned to the IMRN pool are not listed in the response. The search can be done -using multiple criteria. Only results matching all the search criteria are included -in the results. - -The response is either `ServiceProviderDnGetSummaryListResponse()` or -`ErrorResponse()`. The following elements are only used in XS data mode and ignored in -AS data mode: searchCriteriaDn, searchCriteriaGroupId - -**Attributes:** - -|Name |Type |Description | -|-------------------------|--------------------------------|---------------------------------| -|service_provider_id |str |serviceProviderId | -|search_criteria_group_id |List[OCI.searchCriteriaGroupId] |searchCriteriaGroupId *Optional* | -|search_criteria_dn |List[OCI.searchCriteriaDn] |searchCriteriaDn *Optional* | -
- - -## `ServiceProviderDomainGetAssignedGroupListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Requests a list of groups within a service provider that have a given domain assigned. - -It is possible to search by various criteria to restrict the number of rows returned. -Multiple search criteria are logically ANDed together. - -The response is either a `ServiceProviderDomainGetAssignedGroupListResponse()` or an -`ErrorResponse()`. - -**Attributes:** - -|Name |Type |Description | -|---------------------------|----------------------------------|-----------------------------------| -|service_provider_id |str |serviceProviderId | -|domain |str |domain | -|response_size_limit |int |responseSizeLimit *Optional* | -|search_criteria_group_id |List[OCI.searchCriteriaGroupId] |searchCriteriaGroupId *Optional* | -|search_criteria_group_name |List[OCI.searchCriteriaGroupName] |searchCriteriaGroupName *Optional* | -
- - -## `ServiceProviderDomainGetAssignedListRequest22`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Requests the list of all matching domains assigned to a service provider . - -The response is either `ServiceProviderDomainGetAssignedListResponse22()` or -`ErrorResponse()`. The following elements are only used in AS data mode and will be -ignored in XS data mode: responseSizeLimit searchCriteriaDomainName -searchCriteriaExactDomainLevel - -**Attributes:** - -|Name |Type |Description | -|-----------------------------------|-----------------------------------|------------------------------------------| -|service_provider_id |str |serviceProviderId | -|response_size_limit |int |responseSizeLimit *Optional* | -|search_criteria_domain_name |List[OCI.searchCriteriaDomainName] |searchCriteriaDomainName *Optional* | -|search_criteria_exact_domain_level |OCI.searchCriteriaExactDomainLevel |searchCriteriaExactDomainLevel *Optional* | -
- - ## `ServiceProviderFeatureAccessCodeModifyListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -55561,31 +54271,6 @@ the "Call Recording" FAC name is changed to "Call Recording - Start".
-## `ServiceProviderGetListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Request a list of service providers and/or enterprises in the system. - -It is possible to search by various criteria to restrict the number of rows returned. -Multiple search criteria are logically ANDed together. If reseller administrator -sends the request, searchCriteriaResellerId is ignored. Service providers/enterprise -within the administrator's reseller meeting the search criteria are returned. - -The response is either a `ServiceProviderGetListResponse()` or an `ErrorResponse()`. -The following data elements are only used in AS data mode: searchCriteriaResellerId - -**Attributes:** - -|Name |Type |Description | -|--------------------------------------|--------------------------------------------|---------------------------------------------| -|is_enterprise |bool |isEnterprise *Optional* | -|response_size_limit |int |responseSizeLimit *Optional* | -|search_criteria_service_provider_id |List[OCI.searchCriteriaServiceProviderId] |searchCriteriaServiceProviderId *Optional* | -|search_criteria_service_provider_name |List[OCI.searchCriteriaServiceProviderName] |searchCriteriaServiceProviderName *Optional* | -|search_criteria_reseller_id |List[OCI.searchCriteriaResellerId] |searchCriteriaResellerId *Optional* | -
- - ## `ServiceProviderIMRNAssignListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -55728,28 +54413,6 @@ The response is either a `SuccessResponse()` or an `ErrorResponse()`.
-## `ServiceProviderNetworkClassOfServiceGetAssignedGroupListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Get a list of groups within a service provider that have a given Network Class of -Service assigned. - -The response is either a -`ServiceProviderNetworkClassOfServiceGetAssignedGroupListResponse()` or an -`ErorResponse()`. - -**Attributes:** - -|Name |Type |Description | -|---------------------------|----------------------------------|-----------------------------------| -|service_provider_id |str |serviceProviderId | -|network_class_of_service |str |networkClassOfService | -|response_size_limit |int |responseSizeLimit *Optional* | -|search_criteria_group_id |List[OCI.searchCriteriaGroupId] |searchCriteriaGroupId *Optional* | -|search_criteria_group_name |List[OCI.searchCriteriaGroupName] |searchCriteriaGroupName *Optional* | -
- - ## `ServiceProviderNetworkClassOfServiceUnassignListRequest21`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -55771,46 +54434,6 @@ The response is either a `SuccessResponse()` or an `ErrorResponse()`.
-## `ServiceProviderNumberPortabilityQueryGetRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Request to get the Service Provider Number Portability Query Digit Pattern Trigger -List information. - -The response is either a `ServiceProviderNumberPortabilityQueryGetResponse()` or an -`ErrorResponse()`. - -**Attributes:** - -|Name |Type |Description | -|------------------------------------------------------------------------|--------------------------------------------------------------------------|---------------------------------------------------------------------------| -|service_provider_id |str |serviceProviderId | -|include_digit_patterns |bool |includeDigitPatterns | -|search_criteria_service_provider_number_portability_query_digit_pattern |List[OCI.searchCriteriaServiceProviderNumberPortabilityQueryDigitPattern] |searchCriteriaServiceProviderNumberPortabilityQueryDigitPattern *Optional* | -|response_size_limit |int |responseSizeLimit *Optional* | -
- - -## `ServiceProviderOfficeZoneGetAssignedGroupListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Get a list of groups within a service provider that have a given Office Zone assigned. - -The response is either a `ServiceProviderOfficeZoneGetAssignedGroupListResponse()` or -an `ErrorResponse()`. - -**Attributes:** - -|Name |Type |Description | -|---------------------------|----------------------------------|-----------------------------------| -|service_provider_id |str |serviceProviderId | -|office_zone_name |str |officeZoneName | -|response_size_limit |int |responseSizeLimit *Optional* | -|search_criteria_group_id |List[OCI.searchCriteriaGroupId] |searchCriteriaGroupId *Optional* | -|search_criteria_group_name |List[OCI.searchCriteriaGroupName] |searchCriteriaGroupName *Optional* | -
- - ## `ServiceProviderRouteListEnterpriseTrunkNumberRangeAddListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -55843,31 +54466,6 @@ Modify a list of number ranges in a service provider The response is either
-## `ServiceProviderRoutePointExternalSystemGetAssignedGroupListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Requests a list of groups within a service provider that have a given external system -assigned. - -It is possible to search by various criteria to restrict the number of rows returned. -Multiple search criteria are logically ANDed together. - -The response is either a -`ServiceProviderRoutePointExternalSystemGetAssignedGroupListResponse()` or an -`ErrorResponse()`. - -**Attributes:** - -|Name |Type |Description | -|---------------------------|----------------------------------|-----------------------------------| -|service_provider_id |str |serviceProviderId | -|external_system |str |externalSystem | -|response_size_limit |int |responseSizeLimit *Optional* | -|search_criteria_group_id |List[OCI.searchCriteriaGroupId] |searchCriteriaGroupId *Optional* | -|search_criteria_group_name |List[OCI.searchCriteriaGroupName] |searchCriteriaGroupName *Optional* | -
- - ## `ServiceProviderScheduleAddEventRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -56043,26 +54641,6 @@ The response is either `SuccessResponse()` or `ErrorResponse()`.
-## `ServiceProviderServicePackMigrationTaskGetAvailableGroupListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Requests a list of groups to migrate. - -The response is either -`ServiceProviderServicePackMigrationTaskGetAvailabeGroupListResponse()` or -`ErrorResponse()`. - -**Attributes:** - -|Name |Type |Description | -|---------------------------|----------------------------------|-----------------------------------| -|service_provider_id |str |serviceProviderId | -|response_size_limit |int |responseSizeLimit *Optional* | -|search_criteria_group_id |List[OCI.searchCriteriaGroupId] |searchCriteriaGroupId *Optional* | -|search_criteria_group_name |List[OCI.searchCriteriaGroupName] |searchCriteriaGroupName *Optional* | -
- - ## `ServiceProviderServicePackMigrationTaskModifyAssignmentListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -56226,28 +54804,6 @@ The response is either a `SuccessResponse()` or an `ErrorResponse()`.
-## `ServiceProviderXsiPolicyProfileGetAssignedGroupListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Get a list of group within a service provider that have a given group Xsi policy -profile assigned. - -The response is either a -`ServiceProviderXsiPolicyProfileGetAssignedGroupListResponse()` or an -`ErrorResponse()`. - -**Attributes:** - -|Name |Type |Description | -|---------------------------|----------------------------------|-----------------------------------| -|service_provider_id |str |serviceProviderId | -|xsi_policy_profile |OCI.xsiPolicyProfile |xsiPolicyProfile | -|response_size_limit |int |responseSizeLimit *Optional* | -|search_criteria_group_id |List[OCI.searchCriteriaGroupId] |searchCriteriaGroupId *Optional* | -|search_criteria_group_name |List[OCI.searchCriteriaGroupName] |searchCriteriaGroupName *Optional* | -
- - ## `ServiceProviderXsiPolicyProfileUnassignListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -56471,162 +55027,6 @@ The response is either a `SuccessResponse()` or an `ErrorResponse()`.
-## `SystemAccessDeviceGetAllRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Requests the list of all access devices in the entire system. - -Prior to release 14, this functionality was provided with the -`SystemAccessDeviceGetListRequest14()`. If reseller administrator sends the request, -searchCriteriaResellerId is ignored. All the device profiles in the administrator's -reseller meeting the search criteria are returned. - -The response is either `SystemAccessDeviceGetAllResponse()` or `ErrorResponse()`. The -following data elements are only used in AS data mode: searchCriteriaResellerId - -**Attributes:** - -|Name |Type |Description | -|----------------------------------------------|---------------------------------------------|----------------------------------------------------| -|response_size_limit |int |responseSizeLimit *Optional* | -|search_criteria_device_name |List[OCI.searchCriteriaDeviceName] |searchCriteriaDeviceName *Optional* | -|search_criteria_device_mac_address |List[OCI.searchCriteriaDeviceMACAddress] |searchCriteriaDeviceMACAddress *Optional* | -|search_criteria_device_net_address |List[OCI.searchCriteriaDeviceNetAddress] |searchCriteriaDeviceNetAddress *Optional* | -|search_criteria_group_id |List[OCI.searchCriteriaGroupId] |searchCriteriaGroupId *Optional* | -|search_criteria_exact_device_type |OCI.searchCriteriaExactDeviceType |searchCriteriaExactDeviceType *Optional* | -|search_criteria_exact_device_service_provider |OCI.searchCriteriaExactDeviceServiceProvider |searchCriteriaExactDeviceServiceProvider *Optional* | -|search_criteria_service_provider_id |List[OCI.searchCriteriaServiceProviderId] |searchCriteriaServiceProviderId *Optional* | -|search_criteria_reseller_id |List[OCI.searchCriteriaResellerId] |searchCriteriaResellerId *Optional* | -
- - -## `SystemAccessDeviceGetListRequest14`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Requests the list of access devices defined at the System-level. - -Prior to release 14, this command requested a list of all devices in the entire -system. That functionality is now moved to the `SystemAccessDeviceGetAllRequest()`. - -The response is either `SystemAccessDeviceGetListResponse14()` or `ErrorResponse()`. - -**Attributes:** - -|Name |Type |Description | -|--------------------------------------|--------------------------------------------|---------------------------------------------| -|response_size_limit |int |responseSizeLimit *Optional* | -|search_criteria_device_name |List[OCI.searchCriteriaDeviceName] |searchCriteriaDeviceName *Optional* | -|search_criteria_device_mac_address |List[OCI.searchCriteriaDeviceMACAddress] |searchCriteriaDeviceMACAddress *Optional* | -|search_criteria_device_net_address |List[OCI.searchCriteriaDeviceNetAddress] |searchCriteriaDeviceNetAddress *Optional* | -|search_criteria_exact_device_type |OCI.searchCriteriaExactDeviceType |searchCriteriaExactDeviceType *Optional* | -|search_criteria_access_device_version |List[OCI.searchCriteriaAccessDeviceVersion] |searchCriteriaAccessDeviceVersion *Optional* | -
- - -## `SystemAccessDeviceGetPagedSortedListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Requests the list of system-level access devices. - -The response is either `SystemAccessDeviceGetPagedSortedListResponse()` or -`ErrorResponse()`. If no sortOrder is included, the response is sorted by Device Name -ascending by default. If the responsePagingControl element is not provided, the -paging startIndex will be set to 1 by default, and the responsePageSize will be set to -the maximum responsePageSize by default. Multiple search criteria are logically ANDed -together unless the searchCriteriaModeOr option is included. Then the search criteria -are logically ORed together. The getVisualDeviceManagementAPIDevicesOnly element can -only be set when CloudPBX is licenced. If the getVisualDeviceManagementAPIDevicesOnly -element is not set, all devices are returned with Visual Device Management API flag -set to empty. If the getVisualDeviceManagementAPIDevicesOnly element is set to true, -only SIP devices supporting Visual Device Management API are returned. If the -getVisualDeviceManagementAPIDevicesOnly element is set to false, all SIP devices are -returned with their current Visual Device Management API flag value. - -**Attributes:** - -|Name |Type |Description | -|----------------------------------------------|--------------------------------------------|---------------------------------------------------| -|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | -|sort_by_device_name |OCI.sortByDeviceName |sortByDeviceName *Optional* | -|sort_by_device_type |OCI.sortByDeviceType |sortByDeviceType *Optional* | -|sort_by_device_net_address |OCI.sortByDeviceNetAddress |sortByDeviceNetAddress *Optional* | -|sort_by_device_mac_address |OCI.sortByDeviceMACAddress |sortByDeviceMACAddress *Optional* | -|search_criteria_device_name |List[OCI.searchCriteriaDeviceName] |searchCriteriaDeviceName *Optional* | -|search_criteria_device_mac_address |List[OCI.searchCriteriaDeviceMACAddress] |searchCriteriaDeviceMACAddress *Optional* | -|search_criteria_device_net_address |List[OCI.searchCriteriaDeviceNetAddress] |searchCriteriaDeviceNetAddress *Optional* | -|search_criteria_exact_device_type |List[OCI.searchCriteriaExactDeviceType] |searchCriteriaExactDeviceType *Optional* | -|search_criteria_access_device_version |List[OCI.searchCriteriaAccessDeviceVersion] |searchCriteriaAccessDeviceVersion *Optional* | -|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | -|get_visual_device_management_api_devices_only |bool |getVisualDeviceManagementAPIDevicesOnly *Optional* | -
- - -## `SystemAccessDeviceGetUserListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Requests the users associated with a specified system access device. - -The response is either `SystemAccessDeviceGetUserListResponse()` or `ErrorResponse()`. -The following elements are only used in XS data mode and ignored in AS data mode: -searchCriteriaAccessDeviceEndpointPrivateIdentity Replaced by: -`SystemAccessDeviceGetUserListRequest21sp1()` in AS data mode. - -**Attributes:** - -|Name |Type |Description | -|--------------------------------------------------------|------------------------------------------------------------|-------------------------------------------------------------| -|device_name |str |deviceName | -|response_size_limit |int |responseSizeLimit *Optional* | -|search_criteria_line_port_user_part |List[OCI.searchCriteriaLinePortUserPart] |searchCriteriaLinePortUserPart *Optional* | -|search_criteria_line_port_domain |List[OCI.searchCriteriaLinePortDomain] |searchCriteriaLinePortDomain *Optional* | -|search_criteria_user_last_name |List[OCI.searchCriteriaUserLastName] |searchCriteriaUserLastName *Optional* | -|search_criteria_user_first_name |List[OCI.searchCriteriaUserFirstName] |searchCriteriaUserFirstName *Optional* | -|search_criteria_dn |List[OCI.searchCriteriaDn] |searchCriteriaDn *Optional* | -|search_criteria_user_id |List[OCI.searchCriteriaUserId] |searchCriteriaUserId *Optional* | -|search_criteria_group_id |List[OCI.searchCriteriaGroupId] |searchCriteriaGroupId *Optional* | -|search_criteria_exact_service_provider |OCI.searchCriteriaExactServiceProvider |searchCriteriaExactServiceProvider *Optional* | -|search_criteria_service_provider_id |List[OCI.searchCriteriaServiceProviderId] |searchCriteriaServiceProviderId *Optional* | -|search_criteria_exact_endpoint_type |OCI.searchCriteriaExactEndpointType |searchCriteriaExactEndpointType *Optional* | -|search_criteria_exact_user_type |OCI.searchCriteriaExactUserType |searchCriteriaExactUserType *Optional* | -|search_criteria_extension |List[OCI.searchCriteriaExtension] |searchCriteriaExtension *Optional* | -|search_criteria_exact_port_number |OCI.searchCriteriaExactPortNumber |searchCriteriaExactPortNumber *Optional* | -|search_criteria_access_device_endpoint_private_identity |List[OCI.searchCriteriaAccessDeviceEndpointPrivateIdentity] |searchCriteriaAccessDeviceEndpointPrivateIdentity *Optional* | -
- - -## `SystemAccessDeviceGetUserListRequest21sp1`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Requests the users associated with a specified system access device. - -The response is either `SystemAccessDeviceGetUserListResponse21sp1()` or -`ErrorResponse()`. The following elements are only used in XS data mode and ignored in -AS data mode: searchCriteriaAccessDeviceEndpointPrivateIdentity - -**Attributes:** - -|Name |Type |Description | -|--------------------------------------------------------|------------------------------------------------------------|-------------------------------------------------------------| -|device_name |str |deviceName | -|response_size_limit |int |responseSizeLimit *Optional* | -|search_criteria_line_port_user_part |List[OCI.searchCriteriaLinePortUserPart] |searchCriteriaLinePortUserPart *Optional* | -|search_criteria_line_port_domain |List[OCI.searchCriteriaLinePortDomain] |searchCriteriaLinePortDomain *Optional* | -|search_criteria_user_last_name |List[OCI.searchCriteriaUserLastName] |searchCriteriaUserLastName *Optional* | -|search_criteria_user_first_name |List[OCI.searchCriteriaUserFirstName] |searchCriteriaUserFirstName *Optional* | -|search_criteria_dn |List[OCI.searchCriteriaDn] |searchCriteriaDn *Optional* | -|search_criteria_user_id |List[OCI.searchCriteriaUserId] |searchCriteriaUserId *Optional* | -|search_criteria_group_id |List[OCI.searchCriteriaGroupId] |searchCriteriaGroupId *Optional* | -|search_criteria_exact_service_provider |OCI.searchCriteriaExactServiceProvider |searchCriteriaExactServiceProvider *Optional* | -|search_criteria_service_provider_id |List[OCI.searchCriteriaServiceProviderId] |searchCriteriaServiceProviderId *Optional* | -|search_criteria_exact_endpoint_type |OCI.searchCriteriaExactEndpointType |searchCriteriaExactEndpointType *Optional* | -|search_criteria_exact_user_type |OCI.searchCriteriaExactUserType |searchCriteriaExactUserType *Optional* | -|search_criteria_extension |List[OCI.searchCriteriaExtension] |searchCriteriaExtension *Optional* | -|search_criteria_exact_port_number |OCI.searchCriteriaExactPortNumber |searchCriteriaExactPortNumber *Optional* | -|search_criteria_access_device_endpoint_private_identity |List[OCI.searchCriteriaAccessDeviceEndpointPrivateIdentity] |searchCriteriaAccessDeviceEndpointPrivateIdentity *Optional* | -|search_criteria_user_hotline_contact |List[OCI.searchCriteriaUserHotlineContact] |searchCriteriaUserHotlineContact *Optional* | -
- - ## `SystemAccessDeviceLinkDeviceListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -56739,31 +55139,6 @@ The response is either a `SuccessResponse()` or an `ErrorResponse()`.
-## `SystemAlternateUserIdGetListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Request to get the list of alternate user ids. - -If reseller administrator sends the request, searchCriteriaResellerId is ignored. All -the alternate user ids in the administrator's reseller meeting the search criteria are -returned. - -The response is either `SystemAlternateUserIdGetListResponse()` or `ErrorResponse()`. -The following data elements are only used in AS data mode: searchCriteriaResellerId - -**Attributes:** - -|Name |Type |Description | -|------------------------------------|------------------------------------------|-------------------------------------------| -|response_size_limit |int |responseSizeLimit *Optional* | -|search_criteria_alternate_user_id |List[OCI.searchCriteriaAlternateUserId] |searchCriteriaAlternateUserId *Optional* | -|search_criteria_user_id |List[OCI.searchCriteriaUserId] |searchCriteriaUserId *Optional* | -|search_criteria_group_id |List[OCI.searchCriteriaGroupId] |searchCriteriaGroupId *Optional* | -|search_criteria_service_provider_id |List[OCI.searchCriteriaServiceProviderId] |searchCriteriaServiceProviderId *Optional* | -|search_criteria_reseller_id |List[OCI.searchCriteriaResellerId] |searchCriteriaResellerId *Optional* | -
- - ## `SystemAutomaticCollectCallPrefixDigitsAddListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -56853,90 +55228,6 @@ The response is either a `SuccessResponse()` or `ErrorResponse()`.
-## `SystemBroadWorksMobilityGeographicalPoolIMRNGetListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Get a list of BroadWorks Mobility IMRN numbers from a geographical pool. - -The response is either a -`SystemBroadWorksMobilityGeographicalPoolIMRNGetListResponse()` or an -`ErrorResponse()`. - -**Attributes:** - -|Name |Type |Description | -|-----------------------|-----------------------------|------------------------------| -|geographical_pool_name |str |geographicalPoolName | -|search_criteria_imrn |List[OCI.searchCriteriaIMRN] |searchCriteriaIMRN *Optional* | -
- - -## `SystemBroadWorksMobilityGetIMRNListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Request to get the list of BroadWorks Mobility IMRN numbers defined in the system. - -The response is either a `SystemBroadWorksMobilityGetIMRNListResponse()` or an -`ErrorResponse()`. - -**Attributes:** - -|Name |Type |Description | -|---------------------|-----------------------------|------------------------------| -|search_criteria_imrn |List[OCI.searchCriteriaIMRN] |searchCriteriaIMRN *Optional* | -
- - -## `SystemBroadWorksMobilityGetMobileNetworkIMRNListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Get a list of BroadWorks Mobility IMRN numbers from a Mobile Network. - -The response is either a `SystemBroadWorksMobilityGetMobileNetworkIMRNListResponse()` -or an `ErrorResponse()`. - -**Attributes:** - -|Name |Type |Description | -|---------------------|-----------------------------|------------------------------| -|mobile_network_name |str |mobileNetworkName | -|search_criteria_imrn |List[OCI.searchCriteriaIMRN] |searchCriteriaIMRN *Optional* | -
- - -## `SystemBroadWorksMobilityMobileSubscriberDirectoryNumberGetSummaryListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Request a summary table of all Mobile Subscriber Directory Numbers in a system. - -If reseller administrator sends the request, searchCriteriaResellerId is ignored. All -the mobile subscriber directory numbers in the administrator's reseller meeting the -search criteria are returned. - -The response is either -`SystemBroadWorksMobilityMobileSubscriberDirectoryNumberGetSummaryListResponse()` or -`ErrorResponse()`. The following data elements are only used in AS data mode: -searchCriteriaResellerId - -**Attributes:** - -|Name |Type |Description | -|---------------------------------------------------|--------------------------------------------------------|---------------------------------------------------------| -|response_size_limit |int |responseSizeLimit *Optional* | -|search_criteria_mobile_subscriber_directory_number |List[OCI.searchCriteriaMobileSubscriberDirectoryNumber] |searchCriteriaMobileSubscriberDirectoryNumber *Optional* | -|search_criteria_exact_mobile_network |OCI.searchCriteriaExactMobileNetwork |searchCriteriaExactMobileNetwork *Optional* | -|search_criteria_service_provider_id |List[OCI.searchCriteriaServiceProviderId] |searchCriteriaServiceProviderId *Optional* | -|search_criteria_exact_organization_type |OCI.searchCriteriaExactOrganizationType |searchCriteriaExactOrganizationType *Optional* | -|search_criteria_group_id |List[OCI.searchCriteriaGroupId] |searchCriteriaGroupId *Optional* | -|search_criteria_user_id |List[OCI.searchCriteriaUserId] |searchCriteriaUserId *Optional* | -|search_criteria_user_last_name |List[OCI.searchCriteriaUserLastName] |searchCriteriaUserLastName *Optional* | -|search_criteria_user_first_name |List[OCI.searchCriteriaUserFirstName] |searchCriteriaUserFirstName *Optional* | -|search_criteria_dn |List[OCI.searchCriteriaDn] |searchCriteriaDn *Optional* | -|search_criteria_extension |List[OCI.searchCriteriaExtension] |searchCriteriaExtension *Optional* | -|search_criteria_reseller_id |List[OCI.searchCriteriaResellerId] |searchCriteriaResellerId *Optional* | -
- - ## `SystemCallCenterEnhancedReportingBrandingModifyRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -57007,77 +55298,6 @@ The response is either a `SuccessResponse()` or an `ErrorResponse()`.
-## `SystemCallCenterEnhancedReportingScheduledReportGetActiveListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Request to get the list of all active call center reporting scheduled reports in the -system. - -The response is either a -`SystemCallCenterEnhancedReportingScheduledReportGetActiveListResponse()` or an -`ErrorResponse()`. - -**Attributes:** - -|Name |Type |Description | -|-------------------------------------------------------------------------|--------------------------------------------------------------------|---------------------------------------------------------------------------| -|response_size_limit |int |responseSizeLimit *Optional* | -|search_criteria_call_center_scheduled_report_name |List[OCI.searchCriteriaCallCenterScheduledReportName] |searchCriteriaCallCenterScheduledReportName *Optional* | -|search_criteria_group_id |List[OCI.searchCriteriaGroupId] |searchCriteriaGroupId *Optional* | -|search_criteria_exact_call_center_scheduled_report_service_provider |OCI.searchCriteriaExactCallCenterScheduledReportServiceProvider |searchCriteriaExactCallCenterScheduledReportServiceProvider *Optional* | -|search_criteria_service_provider_id |List[OCI.searchCriteriaServiceProviderId] |searchCriteriaServiceProviderId *Optional* | -|search_criteria_exact_call_center_scheduled_report_created_by_supervisor |OCI.searchCriteriaExactCallCenterScheduledReportCreatedBySupervisor |searchCriteriaExactCallCenterScheduledReportCreatedBySupervisor *Optional* | -|search_criteria_call_center_report_template_name |List[OCI.searchCriteriaCallCenterReportTemplateName] |searchCriteriaCallCenterReportTemplateName *Optional* | -
- - -## `SystemCallCenterEnhancedReportingScheduledReportGetCompletedListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Request to get the list of all completed call center reporting scheduled reports in -the system. - -The response is either a -`SystemCallCenterEnhancedReportingScheduledReportGetCompletedListResponse()` or an -`ErrorResponse()`. - -**Attributes:** - -|Name |Type |Description | -|-------------------------------------------------------------------------|--------------------------------------------------------------------|---------------------------------------------------------------------------| -|response_size_limit |int |responseSizeLimit *Optional* | -|search_criteria_call_center_scheduled_report_name |List[OCI.searchCriteriaCallCenterScheduledReportName] |searchCriteriaCallCenterScheduledReportName *Optional* | -|search_criteria_group_id |List[OCI.searchCriteriaGroupId] |searchCriteriaGroupId *Optional* | -|search_criteria_exact_call_center_scheduled_report_service_provider |OCI.searchCriteriaExactCallCenterScheduledReportServiceProvider |searchCriteriaExactCallCenterScheduledReportServiceProvider *Optional* | -|search_criteria_service_provider_id |List[OCI.searchCriteriaServiceProviderId] |searchCriteriaServiceProviderId *Optional* | -|search_criteria_exact_call_center_scheduled_report_created_by_supervisor |OCI.searchCriteriaExactCallCenterScheduledReportCreatedBySupervisor |searchCriteriaExactCallCenterScheduledReportCreatedBySupervisor *Optional* | -|search_criteria_call_center_report_template_name |List[OCI.searchCriteriaCallCenterReportTemplateName] |searchCriteriaCallCenterReportTemplateName *Optional* | -
- - -## `SystemCallCenterEnhancedReportingScheduledReportGetListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Request to get the list of all call center reporting scheduled reports in the system. - -The response is either an -`SystemCallCenterEnhancedReportingScheduledReportGetListResponse()` or an -`ErrorResponse()`. - -**Attributes:** - -|Name |Type |Description | -|-------------------------------------------------------------------------|--------------------------------------------------------------------|---------------------------------------------------------------------------| -|response_size_limit |int |responseSizeLimit *Optional* | -|search_criteria_call_center_scheduled_report_name |List[OCI.searchCriteriaCallCenterScheduledReportName] |searchCriteriaCallCenterScheduledReportName *Optional* | -|search_criteria_group_id |List[OCI.searchCriteriaGroupId] |searchCriteriaGroupId *Optional* | -|search_criteria_exact_call_center_scheduled_report_service_provider |OCI.searchCriteriaExactCallCenterScheduledReportServiceProvider |searchCriteriaExactCallCenterScheduledReportServiceProvider *Optional* | -|search_criteria_service_provider_id |List[OCI.searchCriteriaServiceProviderId] |searchCriteriaServiceProviderId *Optional* | -|search_criteria_exact_call_center_scheduled_report_created_by_supervisor |OCI.searchCriteriaExactCallCenterScheduledReportCreatedBySupervisor |searchCriteriaExactCallCenterScheduledReportCreatedBySupervisor *Optional* | -|search_criteria_call_center_report_template_name |List[OCI.searchCriteriaCallCenterReportTemplateName] |searchCriteriaCallCenterReportTemplateName *Optional* | -
- - ## `SystemCallProcessingPolicyProfileModifyRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -57133,34 +55353,6 @@ The response is either a `SuccessResponse()` or an `ErrorResponse()`.
-## `SystemClassmarkGetUtilizationListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Get the list of all users associated with a Class Mark in system. - -It is possible to search by various criteria. Multiple search criteria are logically -ANDed together. - -The response is either a `SystemClassmarkGetUtilizationListResponse()` or an -`ErrorResponse()`. - -**Attributes:** - -|Name |Type |Description | -|------------------------------------------|------------------------------------------|------------------------------------------------| -|classmark |str |classmark | -|response_size_limit |int |responseSizeLimit *Optional* | -|search_criteria_group_id |List[OCI.searchCriteriaGroupId] |searchCriteriaGroupId *Optional* | -|search_criteria_exact_service_provider_id |OCI.searchCriteriaExactServiceProviderId |searchCriteriaExactServiceProviderId *Optional* | -|search_criteria_service_provider_id |List[OCI.searchCriteriaServiceProviderId] |searchCriteriaServiceProviderId *Optional* | -|search_criteria_user_first_name |List[OCI.searchCriteriaUserFirstName] |searchCriteriaUserFirstName *Optional* | -|search_criteria_user_last_name |List[OCI.searchCriteriaUserLastName] |searchCriteriaUserLastName *Optional* | -|search_criteria_dn |List[OCI.searchCriteriaDn] |searchCriteriaDn *Optional* | -|search_criteria_user_id |List[OCI.searchCriteriaUserId] |searchCriteriaUserId *Optional* | -|search_criteria_extension |List[OCI.searchCriteriaExtension] |searchCriteriaExtension *Optional* | -
- - ## `SystemCollaborateModifyRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -57271,25 +55463,6 @@ The response is either a `SuccessResponse()` or an `ErrorResponse()`.
-## `SystemCommunicationBarringDigitPatternCriteriaGetPatternListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Get an existing Digit Pattern Criteria. - -The response is either a -`SystemCommunicationBarringDigitPatternCriteriaGetPatternListResponse()` or an -`ErrorResponse()`. - -**Attributes:** - -|Name |Type |Description | -|------------------------------|-------------------------------------|--------------------------------------| -|name |str |name | -|response_size_limit |int |responseSizeLimit *Optional* | -|search_criteria_digit_pattern |List[OCI.searchCriteriaDigitPattern] |searchCriteriaDigitPattern *Optional* | -
- - ## `SystemCommunicationBarringIncomingCriteriaModifyRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -57441,28 +55614,6 @@ use value "false" in XS data mode
-## `SystemDeviceFamilyGetListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Request to get the list of device family managed by the Device Management System. - -If includeSystemLevel is specified, all system level device families and the reseller -device families matching search criteria are returned even when -searchCriteriaResellerId is specified. If reseller administrator sends the request, -searchCriteriaResellerId is ignored and automatically set to the administrator's -reseller. - -The response is either `SystemDeviceFamilyGetListResponse()` or `ErrorResponse()`. - -**Attributes:** - -|Name |Type |Description | -|----------------------------|-----------------------------------|------------------------------------| -|include_system_level |bool |includeSystemLevel *Optional* | -|search_criteria_reseller_id |List[OCI.searchCriteriaResellerId] |searchCriteriaResellerId *Optional* | -
- - ## `SystemDeviceFamilyModifyRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -57497,60 +55648,6 @@ The response is either a `SuccessResponse()` or an `ErrorResponse()`.
-## `SystemDeviceManagementEventGetListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Request device management's events for a specific queue. - -It is possible to restrict the number of rows returned using responseSizeLimit. If -eventQueueType is not specified, the events from all the event queues are returned. - -The response is either a `SystemDeviceManagementEventGetListResponse()` or an -`ErrorResponse()`. Deprecated by: `SystemDeviceManagementEventGetListRequest22()`. - -**Attributes:** - -|Name |Type |Description | -|----------------------------------------------------------------------------|----------------------------------------------------------------------|-----------------------------------------------------------------------------| -|event_queue_type |str |eventQueueType *Optional* | -|response_size_limit |int |responseSizeLimit *Optional* | -|search_criteria_exact_device_management_event_status_in_progress_or_pending |OCI.searchCriteriaExactDeviceManagementEventStatusInProgressOrPending |searchCriteriaExactDeviceManagementEventStatusInProgressOrPending *Optional* | -|search_criteria_exact_device_management_event_status_completed |OCI.searchCriteriaExactDeviceManagementEventStatusCompleted |searchCriteriaExactDeviceManagementEventStatusCompleted *Optional* | -|search_criteria_exact_device_management_event_action |OCI.searchCriteriaExactDeviceManagementEventAction |searchCriteriaExactDeviceManagementEventAction *Optional* | -|search_criteria_exact_device_management_event_level |OCI.searchCriteriaExactDeviceManagementEventLevel |searchCriteriaExactDeviceManagementEventLevel *Optional* | -|search_criteria_exact_device_management_event_type |OCI.searchCriteriaExactDeviceManagementEventType |searchCriteriaExactDeviceManagementEventType *Optional* | -|search_criteria_device_management_event_additional_info |List[OCI.searchCriteriaDeviceManagementEventAdditionalInfo] |searchCriteriaDeviceManagementEventAdditionalInfo *Optional* | -|search_criteria_device_management_event_login_id |List[OCI.searchCriteriaDeviceManagementEventLoginId] |searchCriteriaDeviceManagementEventLoginId *Optional* | -
- - -## `SystemDeviceManagementEventGetListRequest22`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Request device management's events for a specific queue. - -It is possible to restrict the number of rows returned using responseSizeLimit. If -eventQueueType is not specified, the events from all the event queues are returned. - -The response is either a `SystemDeviceManagementEventGetListResponse22()` or an -`ErrorResponse()`. - -**Attributes:** - -|Name |Type |Description | -|----------------------------------------------------------------------------|----------------------------------------------------------------------|-----------------------------------------------------------------------------| -|event_queue_type |str |eventQueueType *Optional* | -|response_size_limit |int |responseSizeLimit *Optional* | -|search_criteria_exact_device_management_event_status_in_progress_or_pending |OCI.searchCriteriaExactDeviceManagementEventStatusInProgressOrPending |searchCriteriaExactDeviceManagementEventStatusInProgressOrPending *Optional* | -|search_criteria_exact_device_management_event_status_completed |OCI.searchCriteriaExactDeviceManagementEventStatusCompleted |searchCriteriaExactDeviceManagementEventStatusCompleted *Optional* | -|search_criteria_exact_device_management_event_action |OCI.searchCriteriaExactDeviceManagementEventAction |searchCriteriaExactDeviceManagementEventAction *Optional* | -|search_criteria_exact_device_management_event_level |OCI.searchCriteriaExactDeviceManagementEventLevel |searchCriteriaExactDeviceManagementEventLevel *Optional* | -|search_criteria_exact_device_management_event_type |OCI.searchCriteriaExactDeviceManagementEventType |searchCriteriaExactDeviceManagementEventType *Optional* | -|search_criteria_device_management_event_additional_info |List[OCI.searchCriteriaDeviceManagementEventAdditionalInfo] |searchCriteriaDeviceManagementEventAdditionalInfo *Optional* | -|search_criteria_device_management_event_login_id |List[OCI.searchCriteriaDeviceManagementEventLoginId] |searchCriteriaDeviceManagementEventLoginId *Optional* | -
- - ## `SystemDeviceManagementTagSetImportDryRunRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -57637,27 +55734,6 @@ The response is either a `SuccessResponse()` or an `ErrorResponse()`.
-## `SystemDeviceProfileAuthenticationLockoutGetRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Request to get device password authentication lockout data in the system. - -The response is either a `SystemDeviceProfileAuthenticationLockoutGetResponse()` or an -`ErrorResponse()`. - -**Attributes:** - -|Name |Type |Description | -|----------------------------------------|------------------------------------------|-----------------------------------------------| -|response_size_limit |int |responseSizeLimit *Optional* | -|search_criteria_service_provider_id |List[OCI.searchCriteriaServiceProviderId] |searchCriteriaServiceProviderId *Optional* | -|search_criteria_exact_organization_type |OCI.searchCriteriaExactOrganizationType |searchCriteriaExactOrganizationType *Optional* | -|search_criteria_group_id |List[OCI.searchCriteriaGroupId] |searchCriteriaGroupId *Optional* | -|search_criteria_device_name |List[OCI.searchCriteriaDeviceName] |searchCriteriaDeviceName *Optional* | -|search_criteria_exact_device_type |OCI.searchCriteriaExactDeviceType |searchCriteriaExactDeviceType *Optional* | -
- - ## `SystemDeviceTypeImportDryRunRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -57758,96 +55834,6 @@ The response is either a `SuccessResponse()` or an `ErrorResponse()`.
-## `SystemDnGetSummaryListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Request a summary table of all DNs in the system. - -If resellerId is specified, the DNs assigned to the enterprises/service providers -within the reseller are returned. If reseller administrator sends the request and -resellerId is not specified, the administrator's resellerId is used. The search can -be done using multiple criteria. Only results matching all the search criteria are -included in the results. - -The response is either `SystemDnGetSummaryListResponse()` or `ErrorResponse()`. The -following data elements are only used in AS data mode: resellerId The following -elements are only used in XS data mode and ignored in AS data mode: searchCriteriaDn, -searchCriteriaServiceProviderId, searchCriteriaExactOrganizationType - -**Attributes:** - -|Name |Type |Description | -|----------------------------------------|------------------------------------------|-----------------------------------------------| -|reseller_id |str |resellerId *Optional* | -|search_criteria_dn |List[OCI.searchCriteriaDn] |searchCriteriaDn *Optional* | -|search_criteria_service_provider_id |List[OCI.searchCriteriaServiceProviderId] |searchCriteriaServiceProviderId *Optional* | -|search_criteria_exact_organization_type |OCI.searchCriteriaExactOrganizationType |searchCriteriaExactOrganizationType *Optional* | -
- - -## `SystemDomainGetListRequest22V2`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Requests the list of all matching system-level domains and all matching reseller level -domains. - -If excludeReseller is specified, returns all matching system-level domain names only. -If resellerId is specified, returns all matching system-level domain names and the -given reseller's domains. If reseller administrator sends the request and resellerId -is not specified, the administrator's resellerId is used. - -The response is either `SystemDomainGetListResponse22V2()` or `ErrorResponse()`. The -following elements are only used in AS data mode and will be ingored in XS data mode: -includeReseller resellerId responseSizeLimit searchCriteriaDomainName -searchCriteriaResellerId searchCriteriaExactDomainLevel - -**Attributes:** - -|Name |Type |Description | -|-----------------------------------|-----------------------------------|------------------------------------------| -|exclude_reseller |bool |excludeReseller *Optional* | -|reseller_id |str |resellerId *Optional* | -|response_size_limit |int |responseSizeLimit *Optional* | -|search_criteria_domain_name |List[OCI.searchCriteriaDomainName] |searchCriteriaDomainName *Optional* | -|search_criteria_reseller_id |List[OCI.searchCriteriaResellerId] |searchCriteriaResellerId *Optional* | -|search_criteria_exact_domain_level |OCI.searchCriteriaExactDomainLevel |searchCriteriaExactDomainLevel *Optional* | -
- - -## `SystemEndpointGetListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Request to search endpoints in the system. - -If reseller administrator sends the request, searchCriteriaResellerId is ignored. All -endpoints in the administrator's reseller meeting the search criteria are returned. - -The response is either `SystemEndpointGetListResponse()` or `ErrorResponse()`. The -following data elements are only used in AS data mode: searchCriteriaResellerId - -**Attributes:** - -|Name |Type |Description | -|----------------------------------------|------------------------------------------|-----------------------------------------------| -|response_size_limit |int |responseSizeLimit *Optional* | -|search_criteria_service_provider_id |List[OCI.searchCriteriaServiceProviderId] |searchCriteriaServiceProviderId *Optional* | -|search_criteria_exact_organization_type |OCI.searchCriteriaExactOrganizationType |searchCriteriaExactOrganizationType *Optional* | -|search_criteria_group_id |List[OCI.searchCriteriaGroupId] |searchCriteriaGroupId *Optional* | -|search_criteria_line_port_user_part |List[OCI.searchCriteriaLinePortUserPart] |searchCriteriaLinePortUserPart *Optional* | -|search_criteria_line_port_domain |List[OCI.searchCriteriaLinePortDomain] |searchCriteriaLinePortDomain *Optional* | -|search_criteria_user_last_name |List[OCI.searchCriteriaUserLastName] |searchCriteriaUserLastName *Optional* | -|search_criteria_user_first_name |List[OCI.searchCriteriaUserFirstName] |searchCriteriaUserFirstName *Optional* | -|search_criteria_user_id |List[OCI.searchCriteriaUserId] |searchCriteriaUserId *Optional* | -|search_criteria_dn |List[OCI.searchCriteriaDn] |searchCriteriaDn *Optional* | -|search_criteria_extension |List[OCI.searchCriteriaExtension] |searchCriteriaExtension *Optional* | -|search_criteria_device_type |List[OCI.searchCriteriaDeviceType] |searchCriteriaDeviceType *Optional* | -|search_criteria_device_name |List[OCI.searchCriteriaDeviceName] |searchCriteriaDeviceName *Optional* | -|search_criteria_device_mac_address |List[OCI.searchCriteriaDeviceMACAddress] |searchCriteriaDeviceMACAddress *Optional* | -|search_criteria_device_net_address |List[OCI.searchCriteriaDeviceNetAddress] |searchCriteriaDeviceNetAddress *Optional* | -|search_criteria_reseller_id |List[OCI.searchCriteriaResellerId] |searchCriteriaResellerId *Optional* | -
- - ## `SystemFeatureAccessCodeModifyListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -57958,93 +55944,6 @@ The response is either `SuccessResponse()` or `ErrorResponse()`.
-## `SystemGetRegistrationContactListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Get the list of registration contacts. - -This request handles all levels of administration privileges. The content of the -response will only contain items within the scope of the requester's login id. At the -system level any of the choice parameters may be specified to filter the registrations -listed. At the reseller level, the resellerId must be specified. ResellerId is not -valid at service provider, group or user level. At the service provider level the -serviceProviderId must be specified for the service provider and group options. When -using the userId or linePort options the specified value must be valid for that -service provider login. At the group level the servicProviderId and the groupId must -be specified for the group option. When using the userId or linePort options the -specified value must be valid for that group login. The serviceProviderId option is -not valid at the group level. At the user level when using the userId or linePort -options the specified value must be valid for that user login. The serviceProviderId -and groupId options are not valid at the user level. - -The response is either `SystemGetRegistrationContactListResponse()` or -`ErrorResponse()`. The following elements are only used in AS data mode: resellerId - -**Attributes:** - -|Name |Type |Description | -|---------------------------------|----------------------------------------|-----------------------------------------| -|reseller_id |str |resellerId *Optional* | -|service_provider_id |str |serviceProviderId *Optional* | -|svc_provider_id |str |svcProviderId *Optional* | -|group_id |str |groupId *Optional* | -|user_id |str |userId *Optional* | -|line_port |str |linePort *Optional* | -|device_level |str |deviceLevel *Optional* | -|device_name |str |deviceName *Optional* | -|device_type |str |deviceType *Optional* | -|search_criteria_registration_uri |List[OCI.searchCriteriaRegistrationURI] |searchCriteriaRegistrationURI *Optional* | -|search_criteria_sip_contact |List[OCI.searchCriteriaSIPContact] |searchCriteriaSIPContact *Optional* | -|endpoint_type |str |endpointType *Optional* | -|expired |bool |expired *Optional* | -
- - -## `SystemGetRegistrationContactListRequest21sp1`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Get the list of registration contacts. - -This request handles all levels of administration privileges. The content of the -response will only contain items within the scope of the requester's login id. At the -system level any of the choice parameters may be specified to filter the registrations -listed. At the reseller level, the resellerId must be specified. ResellerId is not -valid at service provider, group or user level. At the service provider level the -serviceProviderId must be specified for the service provider and group options. When -using the userId or linePort options the specified value must be valid for that -service provider login. At the group level the servicProviderId and the groupId must -be specified for the group option. When using the userId or linePort options the -specified value must be valid for that group login. The serviceProviderId option is -not valid at the group level. At the user level when using the userId or linePort -options the specified value must be valid for that user login. The serviceProviderId -and groupId options are not valid at the user level. - -The response is either `SystemGetRegistrationContactListResponse21sp1()` or -`ErrorResponse()`. The RegistrationEndpointType21sp1 is sent in response The Endpoint -Type column contains one of the enumerated RegistrationEndpointType21sp1 values. The -value Mobility in Endpoint Type column is only applicable in AS data mode. The -following elements are only used in AS data mode: resellerId - -**Attributes:** - -|Name |Type |Description | -|---------------------------------|----------------------------------------|-----------------------------------------| -|reseller_id |str |resellerId *Optional* | -|service_provider_id |str |serviceProviderId *Optional* | -|svc_provider_id |str |svcProviderId *Optional* | -|group_id |str |groupId *Optional* | -|user_id |str |userId *Optional* | -|line_port |str |linePort *Optional* | -|device_level |str |deviceLevel *Optional* | -|device_name |str |deviceName *Optional* | -|device_type |str |deviceType *Optional* | -|search_criteria_registration_uri |List[OCI.searchCriteriaRegistrationURI] |searchCriteriaRegistrationURI *Optional* | -|search_criteria_sip_contact |List[OCI.searchCriteriaSIPContact] |searchCriteriaSIPContact *Optional* | -|endpoint_type |str |endpointType *Optional* | -|expired |bool |expired *Optional* | -
- - ## `SystemHolidayScheduleAddRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -58116,22 +56015,6 @@ The response is either a `SuccessResponse()` or an `ErrorResponse()`.
-## `SystemHomeNetworkGetListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Get the list of all Home Networks. - -The response is either a `SystemHomeNetworkGetListResponse()` or an `ErrorResponse()`. - -**Attributes:** - -|Name |Type |Description | -|---------------------------------|---------------------------------------|----------------------------------------| -|response_size_limit |int |responseSizeLimit *Optional* | -|search_criteria_home_msc_address |List[OCI.searchCriteriaHomeMscAddress] |searchCriteriaHomeMscAddress *Optional* | -
- - ## `SystemInterceptUserAddDnListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -58253,24 +56136,6 @@ The response is either a `SuccessResponse()` or an `ErrorResponse()`.
-## `SystemNumberPortabilityQueryDigitPatternGetListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Request to get the System Number Portability Query Digit Pattern List information. - -The response is either a `SystemNumberPortabilityQueryDigitPatternGetListResponse()` -or an `ErrorResponse()`. - -**Attributes:** - -|Name |Type |Description | -|-------------------------------------------------------|-----------------------------------------------------------|------------------------------------------------------------| -|search_criteria_number_portability_query_digit_pattern |List[OCI.searchCriteriaNumberPortabilityQueryDigitPattern] |searchCriteriaNumberPortabilityQueryDigitPattern *Optional* | -|search_criteria_number_portability_status |List[OCI.searchCriteriaNumberPortabilityStatus] |searchCriteriaNumberPortabilityStatus *Optional* | -|response_size_limit |int |responseSizeLimit *Optional* | -
- - ## `SystemOfficeZoneModifyRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -58290,73 +56155,6 @@ The response is either a `SuccessResponse()` or an `ErrorResponse()`.
-## `SystemPreferredCarrierGetGroupListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Requests a list of groups using the specified carrier. - -It is possible to restrict the number of rows returned by specifying various search -criteria. Multiple search criteria are logically ANDed together. - -The response is either a `SystemPreferredCarrierGetGroupListResponse()` or an -`ErrorResponse()`. - -**Attributes:** - -|Name |Type |Description | -|---------------------------------------|------------------------------------------|----------------------------------------------| -|carrier |str |carrier | -|response_size_limit |int |responseSizeLimit *Optional* | -|search_criteria_group_id |List[OCI.searchCriteriaGroupId] |searchCriteriaGroupId *Optional* | -|search_criteria_group_name |List[OCI.searchCriteriaGroupName] |searchCriteriaGroupName *Optional* | -|search_criteria_exact_service_provider |OCI.searchCriteriaExactServiceProvider |searchCriteriaExactServiceProvider *Optional* | -|search_criteria_service_provider_id |List[OCI.searchCriteriaServiceProviderId] |searchCriteriaServiceProviderId *Optional* | -
- - -## `SystemPreferredCarrierGetUserListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Requests a list of users using the specified carrier. - -It is possible to restrict the number of rows returned by specifying various search -criteria. Multiple search criteria are logically ANDed together. - -The response is either a `SystemPreferreredCarrierGetUserListResponse()` or an -`ErrorResponse()`. - -**Attributes:** - -|Name |Type |Description | -|--------------------------------|--------------------------------------|---------------------------------------| -|carrier |str |carrier | -|response_size_limit |int |responseSizeLimit *Optional* | -|search_criteria_user_last_name |List[OCI.searchCriteriaUserLastName] |searchCriteriaUserLastName *Optional* | -|search_criteria_user_first_name |List[OCI.searchCriteriaUserFirstName] |searchCriteriaUserFirstName *Optional* | -|search_criteria_dn |List[OCI.searchCriteriaDn] |searchCriteriaDn *Optional* | -|search_criteria_email_address |List[OCI.searchCriteriaEmailAddress] |searchCriteriaEmailAddress *Optional* | -|search_criteria_user_id |List[OCI.searchCriteriaUserId] |searchCriteriaUserId *Optional* | -|search_criteria_extension |List[OCI.searchCriteriaExtension] |searchCriteriaExtension *Optional* | -
- - -## `SystemRoamingNetworkGetListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Get the list of all Roaming Networks. - -The response is either a `SystemRoamingNetworkGetListResponse()` or an -`ErrorResponse()`. - -**Attributes:** - -|Name |Type |Description | -|------------------------------------|------------------------------------------|-------------------------------------------| -|response_size_limit |int |responseSizeLimit *Optional* | -|search_criteria_roaming_msc_address |List[OCI.searchCriteriaRoamingMscAddress] |searchCriteriaRoamingMscAddress *Optional* | -
- - ## `SystemSIPAuthenticationEndpointLockoutClearRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -58372,30 +56170,6 @@ The response is either a `SuccessResponse()` or an `ErrorResponse()`.
-## `SystemSIPAuthenticationEndpointLockoutGetRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Request to get sip authentication endpoint lockout data in the system. - -The response is either a `SystemSIPAuthenticationEndpointLockoutGetResponse()` or an -`ErrorResponse()`. - -**Attributes:** - -|Name |Type |Description | -|----------------------------------------|------------------------------------------|-----------------------------------------------| -|response_size_limit |int |responseSizeLimit *Optional* | -|search_criteria_service_provider_id |List[OCI.searchCriteriaServiceProviderId] |searchCriteriaServiceProviderId *Optional* | -|search_criteria_exact_organization_type |OCI.searchCriteriaExactOrganizationType |searchCriteriaExactOrganizationType *Optional* | -|search_criteria_group_id |List[OCI.searchCriteriaGroupId] |searchCriteriaGroupId *Optional* | -|search_criteria_line_port_user_part |List[OCI.searchCriteriaLinePortUserPart] |searchCriteriaLinePortUserPart *Optional* | -|search_criteria_line_port_domain |List[OCI.searchCriteriaLinePortDomain] |searchCriteriaLinePortDomain *Optional* | -|search_criteria_user_last_name |List[OCI.searchCriteriaUserLastName] |searchCriteriaUserLastName *Optional* | -|search_criteria_user_first_name |List[OCI.searchCriteriaUserFirstName] |searchCriteriaUserFirstName *Optional* | -|search_criteria_user_id |List[OCI.searchCriteriaUserId] |searchCriteriaUserId *Optional* | -
- - ## `SystemSIPAuthenticationTrunkGroupLockoutClearRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -58411,26 +56185,6 @@ The response is either a `SuccessResponse()` or an `ErrorResponse()`.
-## `SystemSIPAuthenticationTrunkGroupLockoutGetRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Request to get sip authentication trunk group lockout data in the system. - -The response is either a `SystemSIPAuthenticationTrunkGroupLockoutGetResponse()` or an -`ErrorResponse()`. - -**Attributes:** - -|Name |Type |Description | -|----------------------------------------|------------------------------------------|-----------------------------------------------| -|response_size_limit |int |responseSizeLimit *Optional* | -|search_criteria_service_provider_id |List[OCI.searchCriteriaServiceProviderId] |searchCriteriaServiceProviderId *Optional* | -|search_criteria_exact_organization_type |OCI.searchCriteriaExactOrganizationType |searchCriteriaExactOrganizationType *Optional* | -|search_criteria_group_id |List[OCI.searchCriteriaGroupId] |searchCriteriaGroupId *Optional* | -|search_criteria_trunk_group_name |List[OCI.searchCriteriaTrunkGroupName] |searchCriteriaTrunkGroupName *Optional* | -
- - ## `SystemSIPDeviceTypeAddRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -58912,36 +56666,6 @@ true, macInCert will be reset to false.
-## `SystemSIPDeviceTypeGetListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Request to get the list of sip device types in the system. - -If includeSystemLevel is specified, all system level device types and the reseller -device types matching search criteria are returned even when searchCriteriaResellerId -is specified. If reseller administrator sends the request, searchCriteriaResellerId -is ignored. All system level device types and the device types in the administrator's -reseller meeting the search criteria are returned. See Also: -`SystemDeviceTypeGetAvailableListRequest22()` in AS data mode, -`SystemDeviceTypeGetAvailableListRequest19()` in XS data mode. - -The response is either `SystemSIPDeviceTypeGetListResponse()` or `ErrorResponse()`. -The following data elements are only used in AS data mode and ignored in XS data mode: -searchCriteriaExactDeviceTypeConfigurationOptionType - -**Attributes:** - -|Name |Type |Description | -|---------------------------------------------|---------------------------------------------------|----------------------------------------------------| -|response_size_limit |int |responseSizeLimit *Optional* | -|search_criteria_device_type |List[OCI.searchCriteriaDeviceType] |searchCriteriaDeviceType *Optional* | -|search_criteria_exact_signaling_address_type |OCI.searchCriteriaExactSignalingAddressType |searchCriteriaExactSignalingAddressType *Optional* | -|search_criteria_reseller_id |List[OCI.searchCriteriaResellerId] |searchCriteriaResellerId *Optional* | -|search_criteria_device_configuration_options |List[OCI.searchCriteriaDeviceConfigurationOptions] |searchCriteriaDeviceConfigurationOptions *Optional* | -|include_system_level |bool |includeSystemLevel *Optional* | -
- - ## `SystemSIPDeviceTypeLanguageMappingModifyRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -59106,53 +56830,6 @@ Add a new Security Classification The response is either a `SuccessResponse()` o
-## `SystemSecurityClassificationGetClassificationTrunkGroupUsageListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Get a list of users that currently have the specified Security Classification -assigned. - -The response is either -`SystemSecurityClassificationGetClassificationTrunkGroupUsageListResponse()` or -`ErrorResponse()`. - -**Attributes:** - -|Name |Type |Description | -|----------------------------------------|------------------------------------------|-----------------------------------------------| -|security_classification |str |securityClassification | -|response_size_limit |int |responseSizeLimit *Optional* | -|search_criteria_trunk_group_name |List[OCI.searchCriteriaTrunkGroupName] |searchCriteriaTrunkGroupName *Optional* | -|search_criteria_group_id |List[OCI.searchCriteriaGroupId] |searchCriteriaGroupId *Optional* | -|search_criteria_service_provider_id |List[OCI.searchCriteriaServiceProviderId] |searchCriteriaServiceProviderId *Optional* | -|search_criteria_exact_organization_type |OCI.searchCriteriaExactOrganizationType |searchCriteriaExactOrganizationType *Optional* | -
- - -## `SystemSecurityClassificationGetClassificationUserUsageListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Get a list of users that currently have the specified Security Classification -assigned. - -The response is either -`SystemSecurityClassificationGetClassificationUserUsageListResponse()` or -`ErrorResponse()`. - -**Attributes:** - -|Name |Type |Description | -|--------------------------------|--------------------------------------|---------------------------------------| -|security_classification |str |securityClassification | -|response_size_limit |int |responseSizeLimit *Optional* | -|search_criteria_user_id |List[OCI.searchCriteriaUserId] |searchCriteriaUserId *Optional* | -|search_criteria_user_last_name |List[OCI.searchCriteriaUserLastName] |searchCriteriaUserLastName *Optional* | -|search_criteria_user_first_name |List[OCI.searchCriteriaUserFirstName] |searchCriteriaUserFirstName *Optional* | -|search_criteria_dn |List[OCI.searchCriteriaDn] |searchCriteriaDn *Optional* | -|search_criteria_extension |List[OCI.searchCriteriaExtension] |searchCriteriaExtension *Optional* | -
- - ## `SystemSecurityClassificationModifyClassificationRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -59187,26 +56864,6 @@ The response is either a `SuccessResponse()` or an `ErrorResponse()`.
-## `SystemServiceCodeGetListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Request to get all service codes that have been defined in the system. - -It is possible to search by various criteria to restrict the number of rows returned. -Multiple search criteria are logically ANDed together. - -The response is either `SystemServiceCodeGetListResponse()` or `ErrorResponse()`. - -**Attributes:** - -|Name |Type |Description | -|-----------------------------------------|-----------------------------------------------|------------------------------------------------| -|response_size_limit |int |responseSizeLimit *Optional* | -|search_criteria_service_code |List[OCI.searchCriteriaServiceCode] |searchCriteriaServiceCode *Optional* | -|search_criteria_service_code_description |List[OCI.searchCriteriaServiceCodeDescription] |searchCriteriaServiceCodeDescription *Optional* | -
- - ## `SystemSystemServiceDnAddListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -59342,23 +56999,6 @@ networkClassOfService
-## `SystemThirdPartyVoiceMailSupportGetDnListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Request to get a list of ThirdPartyVoiceMailSupport User DN's defined in the system. - -The response is either a `SystemThirdPartyVoiceMailSupportGetDnListResponse()` or an -`ErrorResponse()`. The search can be done using multiple criterion. - -**Attributes:** - -|Name |Type |Description | -|----------------------------------|----------------------------------------|-----------------------------------------| -|response_size_limit |int |responseSizeLimit *Optional* | -|search_criteria_system_service_dn |List[OCI.searchCriteriaSystemServiceDn] |searchCriteriaSystemServiceDn *Optional* | -
- - ## `SystemTimeScheduleAddRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -59430,23 +57070,6 @@ The response is either a `SuccessResponse()` or an `ErrorResponse()`.
-## `SystemTwoStageDialingGetDnListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Request to get a list of Two Stage Dialing dns defined in the system. - -The response is either a `SystemTwoStageDialingGetDnListResponse()` or an -`ErrorResponse()`. - -**Attributes:** - -|Name |Type |Description | -|----------------------------------|----------------------------------------|-----------------------------------------| -|response_size_limit |int |responseSizeLimit *Optional* | -|search_criteria_system_service_dn |List[OCI.searchCriteriaSystemServiceDn] |searchCriteriaSystemServiceDn *Optional* | -
- - ## `SystemXsiApplicationIdAddListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -59477,28 +57100,6 @@ The response is either a `SuccessResponse()` or an `ErrorResponse()`.
-## `SystemXsiPolicyProfileGetAssignedServiceProviderListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Get usage of specific policy profile. - -The response is either a -`SystemXsiPolicyProfileGetAssignedServiceProviderListResponse()` or an -`ErrorResponse()`. - -**Attributes:** - -|Name |Type |Description | -|----------------------------------------|--------------------------------------------|-----------------------------------------------| -|xsi_policy_profile |OCI.xsiPolicyProfile |xsiPolicyProfile | -|response_size_limit |int |responseSizeLimit *Optional* | -|search_criteria_service_provider_id |List[OCI.searchCriteriaServiceProviderId] |searchCriteriaServiceProviderId *Optional* | -|search_criteria_service_provider_name |List[OCI.searchCriteriaServiceProviderName] |searchCriteriaServiceProviderName *Optional* | -|search_criteria_exact_organization_type |OCI.searchCriteriaExactOrganizationType |searchCriteriaExactOrganizationType *Optional* | -|search_criteria_reseller_id |List[OCI.searchCriteriaResellerId] |searchCriteriaResellerId *Optional* | -
- - ## `SystemXsiPolicyProfileGetRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -59588,42 +57189,6 @@ Replaced by: `SystemZoneNetAddressDeleteListRequest()`
-## `SystemZoneCallingRestrictionsNetAddressGetListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Gets a list of IP Addresses and/or Ranges assigned to a zone Response is -`SystemZoneCallingRestrictionsNetAddressGetListResponse()`. - -Replaced by: `SystemZoneNetAddressGetListRequest()` - -**Attributes:** - -|Name |Type |Description | -|--------------------------------|--------------------------------------|---------------------------------------| -|zone_name |str |zoneName | -|response_size_limit |int |responseSizeLimit *Optional* | -|search_criteria_zone_ip_address |List[OCI.searchCriteriaZoneIPAddress] |searchCriteriaZoneIPAddress *Optional* | -
- - -## `SystemZoneLocationBasedPhysicalLocationGetListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Gets a list of physical locations assigned to a zone. - -Response is `SystemZoneLocationBasedPhysicalLocationGetListResponse()` or an -`ErrorResponse()`. - -**Attributes:** - -|Name |Type |Description | -|----------------------------------|-----------------------------------------|------------------------------------------| -|zone_name |str |zoneName | -|response_size_limit |int |responseSizeLimit *Optional* | -|search_criteria_physical_location |List[OCI.searchCriteriaPhysicalLocation] |searchCriteriaPhysicalLocation *Optional* | -
- - ## `SystemZoneNetAddressAddListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -59658,23 +57223,6 @@ Deletes a list of IP addresses from a zone The response is `SuccessResponse()` o
-## `SystemZoneNetAddressGetListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Gets a list of IP Addresses and/or Ranges assigned to a zone. - -Response is `SystemZoneNetAddressGetListResponse()` or an `ErrorResponse()`. - -**Attributes:** - -|Name |Type |Description | -|--------------------------------|--------------------------------------|---------------------------------------| -|zone_name |str |zoneName | -|response_size_limit |int |responseSizeLimit *Optional* | -|search_criteria_zone_ip_address |List[OCI.searchCriteriaZoneIPAddress] |searchCriteriaZoneIPAddress *Optional* | -
- - ## `UserAccessDeviceFileGetListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -59827,56 +57375,6 @@ announcementFileExternalId The response is either a `SuccessResponse()` or an
-## `UserAnnouncementFileGetListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Get the list of announcement names with associated media type and filesize for a User -and given Announcement Repository Type The response is either a -`UserAnnouncementFileGetListResponse()` or an `ErrorResponse()`. - - -**Attributes:** - -|Name |Type |Description | -|---------------------------------------|---------------------------------------------|----------------------------------------------| -|user_id |str |userId | -|announcement_file_type |str |announcementFileType *Optional* | -|include_announcement_table |bool |includeAnnouncementTable | -|response_size_limit |int |responseSizeLimit *Optional* | -|search_criteria_announcement_file_name |List[OCI.searchCriteriaAnnouncementFileName] |searchCriteriaAnnouncementFileName *Optional* | -
- - -## `UserAnnouncementFileGetPagedSortedListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Get the list of announcement files for a user. - -If the responsePagingControl element is not provided, the paging startIndex will be -set to 1 by default, and the responsePageSize will be set to the maximum -responsePageSize by default. If no sortOrder is provided, the response is sorted by -Name ascending by default. Multiple search criteria are logically ANDed together -unless the searchCriteriaModeOr option is included. Then the search criteria are -logically ORed together. - -The response is either a `UserAnnouncementFileGetPagedSortedListResponse()` or an -`ErrorResponse()`. - -**Attributes:** - -|Name |Type |Description | -|---------------------------------------------|---------------------------------------------|---------------------------------------------------| -|user_id |str |userId | -|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | -|sort_by_announcement_file_name |OCI.sortByAnnouncementFileName |sortByAnnouncementFileName *Optional* | -|sort_by_announcement_file_size |OCI.sortByAnnouncementFileSize |sortByAnnouncementFileSize *Optional* | -|search_criteria_announcement_file_name |List[OCI.searchCriteriaAnnouncementFileName] |searchCriteriaAnnouncementFileName *Optional* | -|search_criteria_exact_announcement_file_type |OCI.searchCriteriaExactAnnouncementFileType |searchCriteriaExactAnnouncementFileType *Optional* | -|search_criteria_exact_media_file_type |List[OCI.searchCriteriaExactMediaFileType] |searchCriteriaExactMediaFileType *Optional* | -|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | -
- - ## `UserAnnouncementFileGetRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -59983,31 +57481,6 @@ The response is either a `SuccessResponse()` or an `ErrorResponse()`.
-## `UserBroadWorksAnywhereGetPhoneNumberPagedSortedListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Get the list of all the BroadWorks Anywhere phone numbers for the user. - -If no sortOrder is included the response is sorted by Phone Number ascending by -default. - -The response is either a -`UserBroadWorksAnywhereGetPhoneNumberPagedSortedListResponse()` or an -`ErrorResponse()`. - -**Attributes:** - -|Name |Type |Description | -|---------------------------------------|---------------------------------------|----------------------------------------------| -|user_id |str |userId | -|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | -|sort_by_location |OCI.sortByLocation |sortByLocation *Optional* | -|sort_by_enabled |OCI.sortByEnabled |sortByEnabled *Optional* | -|search_criteria_location |List[OCI.searchCriteriaLocation] |searchCriteriaLocation *Optional* | -|search_criteria_exact_location_enabled |OCI.searchCriteriaExactLocationEnabled |searchCriteriaExactLocationEnabled *Optional* | -
- - ## `UserBroadWorksAnywhereModifyPhoneNumberRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -60164,37 +57637,6 @@ The response is either a
-## `UserCallCenterGetAvailableCallCenterPagedSortedListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-This request gets a list of all call centers which the user can be assigned to as an -agent. - -Some of the call centers may already have the user as an agent. It is the clients -responsibility to discard the call centers that the user is already an agent of. If -the responsePagingControl element is not provided, the paging startIndex will be set -to 1 by default, and the responsePageSize will be set to the maximum ResponsePageSize -by default. It is possible to search by various criteria to restrict the number of -rows returned. Multiple search criteria are logically ANDed together unless the -searchCriteriaModeOr option is included. Then the search criteria are logically ORed -together. - -The response is either a -`UserCallCenterGetAvailableCallCenterPagedSortedListResponse()` or an -`ErrorResponse()`. - -**Attributes:** - -|Name |Type |Description | -|------------------------|-------------------------------|---------------------------------| -|user_id |str |userId | -|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | -|sort_by_user_id |OCI.sortByUserId |sortByUserId *Optional* | -|search_criteria_user_id |List[OCI.searchCriteriaUserId] |searchCriteriaUserId *Optional* | -|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | -
- - ## `UserCallCenterModifyAvailabilityListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -60677,36 +58119,6 @@ The response is either a `UserEnhancedCallLogsGetListResponse16()` or an
-## `UserEnterpriseCommonPhoneListGetPagedSortedListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Get an enterprise's common phone list for a user. - -The response is either a `UserEnterpriseCommonPhoneListGetPagedSortedListResponse()` -or an `ErrorResponse()`. The search can be done using multiple criterion. If the -searchCriteriaModeOr is present, any result matching any one criteria is included in -the results. Otherwise, only results matching all the search criterion are included -in the results. If no search criteria is specified, all results are returned. -Specifying searchCriteriaModeOr without any search criteria results in an -`ErrorResponse()`. The sort can be done on the name or the number in the common phone -list. The following elements are only used in AS data mode and ignored in XS data -mode: searchCriteriaEnterpriseCommonMultiPartPhoneListName - -**Attributes:** - -|Name |Type |Description | -|-------------------------------------------------------------|---------------------------------------------------------------|----------------------------------------------------------------| -|user_id |str |userId | -|response_paging_control |OCI.responsePagingControl |responsePagingControl | -|sort_by_enterprise_common_phone_list_number |OCI.sortByEnterpriseCommonPhoneListNumber |sortByEnterpriseCommonPhoneListNumber *Optional* | -|sort_by_enterprise_common_phone_list_name |OCI.sortByEnterpriseCommonPhoneListName |sortByEnterpriseCommonPhoneListName *Optional* | -|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | -|search_criteria_enterprise_common_phone_list_name |List[OCI.searchCriteriaEnterpriseCommonPhoneListName] |searchCriteriaEnterpriseCommonPhoneListName *Optional* | -|search_criteria_enterprise_common_phone_list_number |List[OCI.searchCriteriaEnterpriseCommonPhoneListNumber] |searchCriteriaEnterpriseCommonPhoneListNumber *Optional* | -|search_criteria_enterprise_common_multi_part_phone_list_name |List[OCI.searchCriteriaEnterpriseCommonMultiPartPhoneListName] |searchCriteriaEnterpriseCommonMultiPartPhoneListName *Optional* | -
- - ## `UserExecutiveAddFilteringSelectiveCriteriaRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -60824,140 +58236,6 @@ The response is either a `SuccessResponse()` or an `ErrorResponse()`.
-## `UserGetListInSystemRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Request the list of users in the system. - -It is possible to search by various criteria to restrict the number of rows returned. -Multiple search criteria are logically ANDed together. If reseller administrator -sends the request, searchCriteriaResellerId is ignored. All the users in the -administrator's reseller meeting the search criteria are returned. - -The response is either a `UserGetListInSystemResponse()` or an `ErrorResponse()`. The -following data elements are only used in AS data mode: searchCriteriaResellerId - -**Attributes:** - -|Name |Type |Description | -|----------------------------------------------------|-------------------------------------------------|--------------------------------------------------------| -|response_size_limit |int |responseSizeLimit *Optional* | -|search_criteria_user_last_name |List[OCI.searchCriteriaUserLastName] |searchCriteriaUserLastName *Optional* | -|search_criteria_user_first_name |List[OCI.searchCriteriaUserFirstName] |searchCriteriaUserFirstName *Optional* | -|search_criteria_dn |List[OCI.searchCriteriaDn] |searchCriteriaDn *Optional* | -|search_criteria_email_address |List[OCI.searchCriteriaEmailAddress] |searchCriteriaEmailAddress *Optional* | -|search_criteria_group_id |List[OCI.searchCriteriaGroupId] |searchCriteriaGroupId *Optional* | -|search_criteria_exact_service_provider |OCI.searchCriteriaExactServiceProvider |searchCriteriaExactServiceProvider *Optional* | -|search_criteria_service_provider_id |List[OCI.searchCriteriaServiceProviderId] |searchCriteriaServiceProviderId *Optional* | -|search_criteria_exact_user_in_trunk_group |OCI.searchCriteriaExactUserInTrunkGroup |searchCriteriaExactUserInTrunkGroup *Optional* | -|search_criteria_exact_user_network_class_of_service |OCI.searchCriteriaExactUserNetworkClassOfService |searchCriteriaExactUserNetworkClassOfService *Optional* | -|search_criteria_user_id |List[OCI.searchCriteriaUserId] |searchCriteriaUserId *Optional* | -|search_criteria_extension |List[OCI.searchCriteriaExtension] |searchCriteriaExtension *Optional* | -|search_criteria_reseller_id |List[OCI.searchCriteriaResellerId] |searchCriteriaResellerId *Optional* | -
- - -## `UserGetServiceInstanceListInSystemRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Request the list of Service Instances in the system. - -It is possible to search by various criteria to restrict the number of rows returned. -Multiple search criteria are logically ANDed together. If reseller administrator -sends the request, searchCriteriaResellerId is ignored. All the service instances in -the administrator's reseller meeting the search criteria are returned. - -The response is either a `UserGetServiceInstanceListInSystemResponse()` or an -`ErrorResponse()`. The following data elements are only used in AS data mode: -searchCriteriaResellerId - -**Attributes:** - -|Name |Type |Description | -|---------------------------------------|------------------------------------------|----------------------------------------------| -|response_size_limit |int |responseSizeLimit *Optional* | -|search_criteria_exact_service_type |OCI.searchCriteriaExactServiceType |searchCriteriaExactServiceType *Optional* | -|search_criteria_user_id |List[OCI.searchCriteriaUserId] |searchCriteriaUserId *Optional* | -|search_criteria_user_last_name |List[OCI.searchCriteriaUserLastName] |searchCriteriaUserLastName *Optional* | -|search_criteria_dn |List[OCI.searchCriteriaDn] |searchCriteriaDn *Optional* | -|search_criteria_extension |List[OCI.searchCriteriaExtension] |searchCriteriaExtension *Optional* | -|search_criteria_group_id |List[OCI.searchCriteriaGroupId] |searchCriteriaGroupId *Optional* | -|search_criteria_exact_service_provider |OCI.searchCriteriaExactServiceProvider |searchCriteriaExactServiceProvider *Optional* | -|search_criteria_service_provider_id |List[OCI.searchCriteriaServiceProviderId] |searchCriteriaServiceProviderId *Optional* | -|search_criteria_reseller_id |List[OCI.searchCriteriaResellerId] |searchCriteriaResellerId *Optional* | -
- - -## `UserGroupCommonPhoneListGetPagedSortedListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Get a user's group's common phone list. - -The response is either a `UserGroupCommonPhoneListGetPagedSortedListResponse()` or an -`ErrorResponse()`. The search can be done using multiple criterion. If the -searchCriteriaModeOr is present, any result matching any one criteria is included in -the results. Otherwise, only results matching all the search criterion are included -in the results. If no search criteria is specified, all results are returned. -Specifying searchCriteriaModeOr without any search criteria results in an -`ErrorResponse()`. The sort can be done on the name or the number in the common phone -list. The following elements are only used in AS data mode and ignored in XS data -mode: searchCriteriaGroupCommonMultiPartPhoneListName - -**Attributes:** - -|Name |Type |Description | -|--------------------------------------------------------|----------------------------------------------------------|-----------------------------------------------------------| -|user_id |str |userId | -|response_paging_control |OCI.responsePagingControl |responsePagingControl | -|sort_by_group_common_phone_list_number |OCI.sortByGroupCommonPhoneListNumber |sortByGroupCommonPhoneListNumber *Optional* | -|sort_by_group_common_phone_list_name |OCI.sortByGroupCommonPhoneListName |sortByGroupCommonPhoneListName *Optional* | -|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | -|search_criteria_group_common_phone_list_name |List[OCI.searchCriteriaGroupCommonPhoneListName] |searchCriteriaGroupCommonPhoneListName *Optional* | -|search_criteria_group_common_phone_list_number |List[OCI.searchCriteriaGroupCommonPhoneListNumber] |searchCriteriaGroupCommonPhoneListNumber *Optional* | -|search_criteria_group_common_multi_part_phone_list_name |List[OCI.searchCriteriaGroupCommonMultiPartPhoneListName] |searchCriteriaGroupCommonMultiPartPhoneListName *Optional* | -
- - -## `UserGroupCustomContactDirectoryGetPagedSortedListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Gets a Custom Contact Directory in a group. - -The response is either `UserGroupCustomContactDirectoryGetPagedSortedListResponse()` -or `ErrorResponse()`. The search can be done using multiple criterion. If the -searchCriteriaModeOr is present, any result matching any one criteria is included in -the results. Otherwise, only results matching all the search criterion are included -in the results. If no search criteria is specified, all results are returned. -Specifying searchCriteriaModeOr without any search criteria results in an -`ErrorResponse()`. The sort can be done on the user last name, first name, department, -or contact notes. The Receptionist Note column is only populated, if the user sending -the request is a the owner of this Receptionist Note and a Note exists. - -**Attributes:** - -|Name |Type |Description | -|------------------------------------|------------------------------------------|-------------------------------------------| -|user_id |str |userId | -|name |str |name | -|response_paging_control |OCI.responsePagingControl |responsePagingControl | -|sort_by_user_last_name |OCI.sortByUserLastName |sortByUserLastName *Optional* | -|sort_by_user_first_name |OCI.sortByUserFirstName |sortByUserFirstName *Optional* | -|sort_by_user_department |OCI.sortByUserDepartment |sortByUserDepartment *Optional* | -|sort_by_receptionist_note |OCI.sortByReceptionistNote |sortByReceptionistNote *Optional* | -|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | -|search_criteria_user_last_name |List[OCI.searchCriteriaUserLastName] |searchCriteriaUserLastName *Optional* | -|search_criteria_user_first_name |List[OCI.searchCriteriaUserFirstName] |searchCriteriaUserFirstName *Optional* | -|search_criteria_dn |List[OCI.searchCriteriaDn] |searchCriteriaDn *Optional* | -|search_criteria_extension |List[OCI.searchCriteriaExtension] |searchCriteriaExtension *Optional* | -|search_criteria_mobile_phone_number |List[OCI.searchCriteriaMobilePhoneNumber] |searchCriteriaMobilePhoneNumber *Optional* | -|search_criteria_user_id |List[OCI.searchCriteriaUserId] |searchCriteriaUserId *Optional* | -|search_criteria_department_name |List[OCI.searchCriteriaDepartmentName] |searchCriteriaDepartmentName *Optional* | -|search_criteria_imp_id |List[OCI.searchCriteriaImpId] |searchCriteriaImpId *Optional* | -|search_criteria_title |List[OCI.searchCriteriaTitle] |searchCriteriaTitle *Optional* | -|search_criteria_receptionist_note |List[OCI.searchCriteriaReceptionistNote] |searchCriteriaReceptionistNote *Optional* | -
- - ## `UserHolidayScheduleAddRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -61766,25 +59044,6 @@ The response is either a `SuccessResponse()` or an `ErrorResponse()`.
-## `UserPersonalAssistantExclusionNumberGetListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Request to get the User Personal Assistant Exclusion Number List information. - -The response is either a userPersonalAssistantExclusionNumberGetListResponse or an -`ErrorResponse()`. - -**Attributes:** - -|Name |Type |Description | -|----------------------------------------------------------------|--------------------------------------------------------------------|---------------------------------------------------------------------| -|user_id |str |userId | -|search_criteria_personal_assistant_exclusion_number |List[OCI.searchCriteriaPersonalAssistantExclusionNumber] |searchCriteriaPersonalAssistantExclusionNumber *Optional* | -|search_criteria_personal_assistant_exclusion_number_description |List[OCI.searchCriteriaPersonalAssistantExclusionNumberDescription] |searchCriteriaPersonalAssistantExclusionNumberDescription *Optional* | -|response_size_limit |int |responseSizeLimit *Optional* | -
- - ## `UserPersonalPhoneListAddListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -61801,114 +59060,6 @@ The response is either a `SuccessResponse()` or an `ErrorResponse()`.
-## `UserPersonalPhoneListGetListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Get a user's personal phone list. - -The response is either a `UserPersonalPhoneListGetListResponse()` or an -`ErrorResponse()`. The search can be done using multiple criterion. If the -searchCriteriaModeOr is present, any result matching any one criteria is included in -the results. Otherwise, only results matching all the search criterion are included -in the results. If no search criteria is specified, all results are returned. -Specifying searchCriteriaModeOr without any search criteria results in an -`ErrorResponse()`. In all cases, if a responseSizeLimit is specified and the number of -matching results is more than this limit, then an `ErrorResponse()` is returned. - -**Attributes:** - -|Name |Type |Description | -|------------------------------------------------|----------------------------------------------------|-----------------------------------------------------| -|user_id |str |userId | -|response_size_limit |int |responseSizeLimit *Optional* | -|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | -|search_criteria_user_personal_phone_list_name |List[OCI.searchCriteriaUserPersonalPhoneListName] |searchCriteriaUserPersonalPhoneListName *Optional* | -|search_criteria_user_personal_phone_list_number |List[OCI.searchCriteriaUserPersonalPhoneListNumber] |searchCriteriaUserPersonalPhoneListNumber *Optional* | -
- - -## `UserPersonalPhoneListGetPagedSortedListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Get a user's personal phone list. - -The response is either a `UserPersonalPhoneListGetPagedSortedListResponse()` or an -`ErrorResponse()`. The search can be done using multiple criterion. If the -searchCriteriaModeOr is present, any result matching any one criteria is included in -the results. Otherwise, only results matching all the search criterion are included -in the results. If no search criteria is specified, all results are returned. -Specifying searchCriteriaModeOr without any search criteria results in an -`ErrorResponse()`. The sort can done by the personal phone list number or name. The -following elements are only used in AS data mode and ignored in XS data mode: -searchCriteriaUserPersonalMultiPartPhoneListName - -**Attributes:** - -|Name |Type |Description | -|---------------------------------------------------------|-----------------------------------------------------------|------------------------------------------------------------| -|user_id |str |userId | -|response_paging_control |OCI.responsePagingControl |responsePagingControl | -|sort_by_user_personal_phone_list_number |OCI.sortByUserPersonalPhoneListNumber |sortByUserPersonalPhoneListNumber *Optional* | -|sort_by_user_personal_phone_list_name |OCI.sortByUserPersonalPhoneListName |sortByUserPersonalPhoneListName *Optional* | -|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | -|search_criteria_user_personal_phone_list_name |List[OCI.searchCriteriaUserPersonalPhoneListName] |searchCriteriaUserPersonalPhoneListName *Optional* | -|search_criteria_user_personal_phone_list_number |List[OCI.searchCriteriaUserPersonalPhoneListNumber] |searchCriteriaUserPersonalPhoneListNumber *Optional* | -|search_criteria_user_personal_multi_part_phone_list_name |List[OCI.searchCriteriaUserPersonalMultiPartPhoneListName] |searchCriteriaUserPersonalMultiPartPhoneListName *Optional* | -
- - -## `UserPhoneDirectoryGetPagedSortedListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Request a table containing the phone directory for a user. - -Setting isEnterpriseRequested to true will return enterprise directory members in the -response if the user is in an enterprise. Otherwise, just the group directory members -for a user are returned in the response. - -The response is either `UserPhoneDirectoryGetPagedSortedListResponse()` or -`ErrorResponse()`. The search can be done using multiple criteria. If the -searchCriteriaModeOr is present, any result matching any one criteria is included in -the results. Otherwise, only results matching all the search criteria are included in -the results. If no search criteria is specified, all results are returned. -Specifying searchCriteriaModeOr without any search criteria results in an -`ErrorResponse()`. The sort can be performed on user last name, first name, -department, or receptionist note. The Receptionist Note column is only populated, if -the user sending the request is the owner of the Receptionist Note and a Note exists. -The following elements are only used in AS data mode and ignored in XS data mode: -searchCriteriaMultiPartName - -**Attributes:** - -|Name |Type |Description | -|------------------------------------|------------------------------------------|-------------------------------------------| -|user_id |str |userId | -|is_enterprise_info_requested |bool |isEnterpriseInfoRequested | -|response_paging_control |OCI.responsePagingControl |responsePagingControl | -|sort_by_user_last_name |OCI.sortByUserLastName |sortByUserLastName *Optional* | -|sort_by_user_first_name |OCI.sortByUserFirstName |sortByUserFirstName *Optional* | -|sort_by_user_department |OCI.sortByUserDepartment |sortByUserDepartment *Optional* | -|sort_by_receptionist_note |OCI.sortByReceptionistNote |sortByReceptionistNote *Optional* | -|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | -|search_criteria_user_last_name |List[OCI.searchCriteriaUserLastName] |searchCriteriaUserLastName *Optional* | -|search_criteria_user_first_name |List[OCI.searchCriteriaUserFirstName] |searchCriteriaUserFirstName *Optional* | -|search_criteria_user_name |List[OCI.searchCriteriaUserName] |searchCriteriaUserName *Optional* | -|search_criteria_dn |List[OCI.searchCriteriaDn] |searchCriteriaDn *Optional* | -|search_criteria_group_location_code |List[OCI.searchCriteriaGroupLocationCode] |searchCriteriaGroupLocationCode *Optional* | -|search_criteria_extension |List[OCI.searchCriteriaExtension] |searchCriteriaExtension *Optional* | -|search_criteria_mobile_phone_number |List[OCI.searchCriteriaMobilePhoneNumber] |searchCriteriaMobilePhoneNumber *Optional* | -|search_criteria_email_address |List[OCI.searchCriteriaEmailAddress] |searchCriteriaEmailAddress *Optional* | -|search_criteria_yahoo_id |List[OCI.searchCriteriaYahooId] |searchCriteriaYahooId *Optional* | -|search_criteria_exact_user_group |OCI.searchCriteriaExactUserGroup |searchCriteriaExactUserGroup *Optional* | -|search_criteria_department_name |List[OCI.searchCriteriaDepartmentName] |searchCriteriaDepartmentName *Optional* | -|search_criteria_user_id |List[OCI.searchCriteriaUserId] |searchCriteriaUserId *Optional* | -|search_criteria_imp_id |List[OCI.searchCriteriaImpId] |searchCriteriaImpId *Optional* | -|search_criteria_title |List[OCI.searchCriteriaTitle] |searchCriteriaTitle *Optional* | -|search_criteria_receptionist_note |List[OCI.searchCriteriaReceptionistNote] |searchCriteriaReceptionistNote *Optional* | -|search_criteria_multi_part_name |List[OCI.searchCriteriaMultiPartName] |searchCriteriaMultiPartName *Optional* | -
- - ## `UserPolycomPhoneServicesGetRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -62218,36 +59369,6 @@ The response is either a `UserScheduleGetEventResponse()` or an `ErrorResponse()
-## `UserScheduleGetPagedSortedListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Get the list of schedules viewable by a User. - -The list can be filtered by schedule name, schedule type, and schedule level. - -The response is either a `UserScheduleGetPagedSortedListResponse()` or an -`ErrorResponse()`. This command is authorized to user who is Executive-Assistant of -the Executive. If no sortOrder is included, the response is sorted by Name ascending -by default. If the responsePagingControl element is not provided, the paging -startIndex will be set to 1 by default, and the responsePageSize will be set to the -maximum responsePageSize by default. Multiple search criteria are logically ANDed -together unless the searchCriteriaModeOr option is included. Then the search criteria -are logically ORed together. - -**Attributes:** - -|Name |Type |Description | -|-------------------------------------|-------------------------------------------|--------------------------------------------| -|user_id |str |userId | -|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | -|sort_by_schedule_name |OCI.sortByScheduleName |sortByScheduleName *Optional* | -|search_criteria_schedule_name |List[OCI.searchCriteriaScheduleName] |searchCriteriaScheduleName *Optional* | -|search_criteria_exact_schedule_type |List[OCI.searchCriteriaExactScheduleType] |searchCriteriaExactScheduleType *Optional* | -|search_criteria_exact_schedule_level |List[OCI.searchCriteriaExactScheduleLevel] |searchCriteriaExactScheduleLevel *Optional* | -|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | -
- - ## `UserScheduleModifyEventRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -62880,23 +60001,23 @@ or `ErrorResponse()`.
-## `EnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAssignmentPagedSortedListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) +## `EnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAvailablePagedSortedListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
-Request a summary table of all Mobile Subscriber Directory Numbers in an enterprise. +Request a list of available Mobile Subscriber Directory Numbers not yet assigned to +any user. If the responsePagingControl element is not provided, the paging startIndex will be set to 1 by default, and the responsePageSize will be set to the maximum ResponsePageSize by default. If no sortOrder is included the response is sorted by Mobile Number ascending by default. Multiple search criteria are logically ANDed together unless the searchCriteriaModeOr option is included. Then the search criteria -are logically ORed together. The department in both the search criteria and sort by -fields refer to the department of the user. +are logically ORed together. The response is either -`EnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAssignmentPagedSortedListResponse()` +`EnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAvailablePagedSortedListResponse()` or `ErrorResponse()`. Replaced by: -`EnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAssignmentPagedSortedListRequest22()` +`EnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAvailablePagedSortedListRequest22()` **Attributes:** @@ -62904,36 +60025,27 @@ or `ErrorResponse()`. Replaced by: |---------------------------------------------------|--------------------------------------------------------|---------------------------------------------------------| |service_provider_id |str |serviceProviderId | |response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | -|sort_order |List[OCI.sortOrder] |sortOrder *Optional* | +|sort_by_mobile_directory_number |OCI.sortByMobileDirectoryNumber |sortByMobileDirectoryNumber *Optional* | |search_criteria_mobile_subscriber_directory_number |List[OCI.searchCriteriaMobileSubscriberDirectoryNumber] |searchCriteriaMobileSubscriberDirectoryNumber *Optional* | -|search_criteria_group_id |List[OCI.searchCriteriaGroupId] |searchCriteriaGroupId *Optional* | -|search_criteria_user_id |List[OCI.searchCriteriaUserId] |searchCriteriaUserId *Optional* | -|search_criteria_user_last_name |List[OCI.searchCriteriaUserLastName] |searchCriteriaUserLastName *Optional* | -|search_criteria_user_first_name |List[OCI.searchCriteriaUserFirstName] |searchCriteriaUserFirstName *Optional* | -|search_criteria_dn |List[OCI.searchCriteriaDn] |searchCriteriaDn *Optional* | -|search_criteria_extension |List[OCI.searchCriteriaExtension] |searchCriteriaExtension *Optional* | -|search_criteria_department_name |List[OCI.searchCriteriaDepartmentName] |searchCriteriaDepartmentName *Optional* | -|search_criteria_exact_mobile_network |List[OCI.searchCriteriaExactMobileNetwork] |searchCriteriaExactMobileNetwork *Optional* | -|search_criteria_exact_mobile_dn_availability |OCI.searchCriteriaExactMobileDnAvailability |searchCriteriaExactMobileDnAvailability *Optional* | |search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* |
-## `EnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAssignmentPagedSortedListRequest22`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) +## `EnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAvailablePagedSortedListRequest22`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
-Request a summary table of all Mobile Subscriber Directory Numbers in an enterprise. +Request a list of available Mobile Subscriber Directory Numbers not yet assigned to +any user. If the responsePagingControl element is not provided, the paging startIndex will be set to 1 by default, and the responsePageSize will be set to the maximum ResponsePageSize by default. If no sortOrder is included the response is sorted by Mobile Number ascending by default. Multiple search criteria are logically ANDed together unless the searchCriteriaModeOr option is included. Then the search criteria -are logically ORed together. The department in both the search criteria and sort by -fields refer to the department of the user. +are logically ORed together. The response is either -`EnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAssignmentPagedSortedListResponse22()` +`EnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAvailablePagedSortedListResponse22()` or `ErrorResponse()`. **Attributes:** @@ -62943,17 +60055,8 @@ or `ErrorResponse()`. |service_provider_id |str |serviceProviderId | |include_total_number_of_rows |bool |includeTotalNumberOfRows *Optional* | |response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | -|sort_order |List[OCI.sortOrder] |sortOrder *Optional* | +|sort_by_mobile_directory_number |OCI.sortByMobileDirectoryNumber |sortByMobileDirectoryNumber *Optional* | |search_criteria_mobile_subscriber_directory_number |List[OCI.searchCriteriaMobileSubscriberDirectoryNumber] |searchCriteriaMobileSubscriberDirectoryNumber *Optional* | -|search_criteria_group_id |List[OCI.searchCriteriaGroupId] |searchCriteriaGroupId *Optional* | -|search_criteria_user_id |List[OCI.searchCriteriaUserId] |searchCriteriaUserId *Optional* | -|search_criteria_user_last_name |List[OCI.searchCriteriaUserLastName] |searchCriteriaUserLastName *Optional* | -|search_criteria_user_first_name |List[OCI.searchCriteriaUserFirstName] |searchCriteriaUserFirstName *Optional* | -|search_criteria_dn |List[OCI.searchCriteriaDn] |searchCriteriaDn *Optional* | -|search_criteria_extension |List[OCI.searchCriteriaExtension] |searchCriteriaExtension *Optional* | -|search_criteria_department_name |List[OCI.searchCriteriaDepartmentName] |searchCriteriaDepartmentName *Optional* | -|search_criteria_exact_mobile_network |List[OCI.searchCriteriaExactMobileNetwork] |searchCriteriaExactMobileNetwork *Optional* | -|search_criteria_exact_mobile_dn_availability |OCI.searchCriteriaExactMobileDnAvailability |searchCriteriaExactMobileDnAvailability *Optional* | |search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* |
@@ -63024,91 +60127,50 @@ The response is either a -## `EnterpriseCallCenterAgentThresholdProfileGetAvailableAgentPagedSortedListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) +## `EnterpriseCallCenterCurrentAndPastAgentGetListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
-Get the list of all Agents in the Enterprise that can be assigned to a given Call -Center Agent Threshold Profile in an Enterprise. +Request to all the current and past agents in the enterprise. -An agent is available to be assigned to a given Agent Threshold Profile if it is a -Call Center Standard or Call Center Premium agent and the agent is not yet assigned to -the profile. If the responsePagingControl element is not provided, the paging -startIndex will be set to 1 by default, and the responsePageSize will be set to the -maximum ResponsePageSize by default. It is possible to search by various criteria to -restrict the number of rows returned. The available agent list for a new Call Center -Agent Threshold profile can be obtained by not setting the -excludeAgentsAssignedToProfileName. When the excludeAgentsAssignedToProfileName is -specified, all agents already assigned to the specified profile are not included in -the response, even if the search criterion element searchCriteriaAgentThresholdProfile -is specified using the same profile name. If no sortOrder is included the response is -sorted by User Id ascending by default. Multiple search criteria are logically ANDed -together unless the searchCriteriaModeOr option is included. Then the search criteria -are logically ORed together. `ErrorResponse()` is returned if -searchCriteriaExactUserGroup has multiple entries and searchCriteriaModeOr is not -included. +The searchCriteriaExactUserGroup does not apply to past agents. -The response is either a -`EnterpriseCallCenterAgentThresholdProfileGetAvailableAgentPagedSortedListResponse()` -or an `ErrorResponse()`. +The response is either `EnterpriseCallCenterCurrentAndPastAgentGetListResponse()` or +`ErrorResponse()`. **Attributes:** -|Name |Type |Description | -|----------------------------------------|----------------------------------------------|-----------------------------------------------| -|service_provider_id |str |serviceProviderId | -|exclude_agents_assigned_to_profile_name |str |excludeAgentsAssignedToProfileName *Optional* | -|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | -|sort_order |List[OCI.sortOrder] |sortOrder *Optional* | -|search_criteria_user_id |List[OCI.searchCriteriaUserId] |searchCriteriaUserId *Optional* | -|search_criteria_user_last_name |List[OCI.searchCriteriaUserLastName] |searchCriteriaUserLastName *Optional* | -|search_criteria_user_first_name |List[OCI.searchCriteriaUserFirstName] |searchCriteriaUserFirstName *Optional* | -|search_criteria_dn |List[OCI.searchCriteriaDn] |searchCriteriaDn *Optional* | -|search_criteria_extension |List[OCI.searchCriteriaExtension] |searchCriteriaExtension *Optional* | -|search_criteria_department_name |List[OCI.searchCriteriaDepartmentName] |searchCriteriaDepartmentName *Optional* | -|search_criteria_email_address |List[OCI.searchCriteriaEmailAddress] |searchCriteriaEmailAddress *Optional* | -|search_criteria_agent_threshold_profile |List[OCI.searchCriteriaAgentThresholdProfile] |searchCriteriaAgentThresholdProfile *Optional* | -|search_criteria_exact_user_group |List[OCI.searchCriteriaExactUserGroup] |searchCriteriaExactUserGroup *Optional* | -|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | +|Name |Type |Description | +|---------------------------------|--------------------------------------|----------------------------------------| +|service_provider_id |str |serviceProviderId | +|response_size_limit |int |responseSizeLimit *Optional* | +|search_criteria_user_last_name |List[OCI.searchCriteriaUserLastName] |searchCriteriaUserLastName *Optional* | +|search_criteria_user_first_name |List[OCI.searchCriteriaUserFirstName] |searchCriteriaUserFirstName *Optional* | +|search_criteria_exact_user_group |OCI.searchCriteriaExactUserGroup |searchCriteriaExactUserGroup *Optional* | +|search_criteria_user_id |List[OCI.searchCriteriaUserId] |searchCriteriaUserId *Optional* | +|search_criteria_dn |List[OCI.searchCriteriaDn] |searchCriteriaDn *Optional* | +|search_criteria_extension |List[OCI.searchCriteriaExtension] |searchCriteriaExtension *Optional* |
-## `EnterpriseCallCenterAgentThresholdProfileGetPagedSortedRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) +## `EnterpriseCallCenterCurrentAndPastCallCenterGetListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
-Gets an existing specified Call Center Agent Threshold Profile in an Enterprise. +Request to get all the current and past call centers for the enterprise. -The agentTable is what the search, sort, and pagination fields apply to. If the -responsePagingControl element is not provided, the paging startIndex will be set to 1 -by default, and the responsePageSize will be set to the maximum ResponsePageSize by -default. It is possible to search by various criteria to restrict the number of rows -returned. If no sortOrder is included the response is sorted by User Id ascending by -default. Multiple search criteria are logically ANDed together unless the -searchCriteriaModeOr option is included. Then the search criteria are logically ORed -together. `ErrorResponse()` is returned if searchCriteriaExactUserGroup has multiple -entries and searchCriteriaModeOr is not included. +The searchCriteriaExactUserGroup does not apply to past call centers. -The response is either a -`EnterpriseCallCenterAgentThresholdProfileGetPagedSortedResponse()` or an -`ErrorResponse()`. +The response is either `EnterpriseCallCenterCurrentAndPastCallCenterGetListResponse()` +or `ErrorResponse()`. **Attributes:** -|Name |Type |Description | -|---------------------------------|---------------------------------------|----------------------------------------| -|service_provider_id |str |serviceProviderId | -|profile_name |str |profileName | -|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | -|sort_order |List[OCI.sortOrder] |sortOrder *Optional* | -|search_criteria_user_id |List[OCI.searchCriteriaUserId] |searchCriteriaUserId *Optional* | -|search_criteria_user_last_name |List[OCI.searchCriteriaUserLastName] |searchCriteriaUserLastName *Optional* | -|search_criteria_user_first_name |List[OCI.searchCriteriaUserFirstName] |searchCriteriaUserFirstName *Optional* | -|search_criteria_dn |List[OCI.searchCriteriaDn] |searchCriteriaDn *Optional* | -|search_criteria_extension |List[OCI.searchCriteriaExtension] |searchCriteriaExtension *Optional* | -|search_criteria_department_name |List[OCI.searchCriteriaDepartmentName] |searchCriteriaDepartmentName *Optional* | -|search_criteria_exact_user_group |List[OCI.searchCriteriaExactUserGroup] |searchCriteriaExactUserGroup *Optional* | -|search_criteria_group_name |List[OCI.searchCriteriaGroupName] |searchCriteriaGroupName *Optional* | -|search_criteria_email_address |List[OCI.searchCriteriaEmailAddress] |searchCriteriaEmailAddress *Optional* | -|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | +|Name |Type |Description | +|---------------------------------|---------------------------------|----------------------------------------| +|service_provider_id |str |serviceProviderId | +|is_premium_only |bool |isPremiumOnly *Optional* | +|response_size_limit |int |responseSizeLimit *Optional* | +|search_criteria_exact_user_group |OCI.searchCriteriaExactUserGroup |searchCriteriaExactUserGroup *Optional* | +|search_criteria_call_center_name |OCI.searchCriteriaCallCenterName |searchCriteriaCallCenterName *Optional* |
@@ -63177,6 +60239,111 @@ The response is either an +## `EnterpriseCommonPhoneListGetListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Get an enterprise's common phone list. + +The response is either a `EnterpriseCommonPhoneListGetListResponse()` or an +`ErrorResponse()`. The search can be done using multiple criterion. If the +searchCriteriaModeOr is present, any result matching any one criteria is included in +the results. Otherwise, only results matching all the search criterion are included +in the results. If no search criteria is specified, all results are returned. +Specifying searchCriteriaModeOr without any search criteria results in an +`ErrorResponse()`. In all cases, if a responseSizeLimit is specified and the number of +matching results is more than this limit, then an `ErrorResponse()` is returned. + +**Attributes:** + +|Name |Type |Description | +|----------------------------------------------------|--------------------------------------------------------|---------------------------------------------------------| +|service_provider_id |str |serviceProviderId | +|response_size_limit |int |responseSizeLimit *Optional* | +|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | +|search_criteria_enterprise_common_phone_list_name |List[OCI.searchCriteriaEnterpriseCommonPhoneListName] |searchCriteriaEnterpriseCommonPhoneListName *Optional* | +|search_criteria_enterprise_common_phone_list_number |List[OCI.searchCriteriaEnterpriseCommonPhoneListNumber] |searchCriteriaEnterpriseCommonPhoneListNumber *Optional* | +
+ + +## `EnterpriseCommunicationBarringAuthorizationCodeGetListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Get a list of Communication Barring Authorization Codes in an enterprise. + +The response is either +`EnterpriseCommunicationBarringAuthorizationCodeGetListResponse()` or +`ErrorResponse()`. + +**Attributes:** + +|Name |Type |Description | +|---------------------------------------------------------------------|-------------------------------------------------------------------------|--------------------------------------------------------------------------| +|service_provider_id |str |serviceProviderId | +|response_size_limit |int |responseSizeLimit *Optional* | +|search_criteria_communication_barring_authorization_code |List[OCI.searchCriteriaCommunicationBarringAuthorizationCode] |searchCriteriaCommunicationBarringAuthorizationCode *Optional* | +|search_criteria_communication_barring_authorization_code_description |List[OCI.searchCriteriaCommunicationBarringAuthorizationCodeDescription] |searchCriteriaCommunicationBarringAuthorizationCodeDescription *Optional* | +|search_criteria_network_class_of_service_name |List[OCI.searchCriteriaNetworkClassOfServiceName] |searchCriteriaNetworkClassOfServiceName *Optional* | +
+ + +## `EnterpriseDepartmentAddRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Add a department to enterprise. + +The response is either a `SuccessResponse()` or an `ErrorResponse()`. + +**Attributes:** + +|Name |Type |Description | +|----------------------|------------------------|-------------------------------| +|enterprise_id |str |enterpriseId | +|department_name |str |departmentName | +|parent_department_key |OCI.parentDepartmentKey |parentDepartmentKey *Optional* | +
+ + +## `EnterpriseDepartmentModifyRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Modify a department of an enterprise. + +The response is either a `SuccessResponse()` or an `ErrorResponse()`. + +**Attributes:** + +|Name |Type |Description | +|--------------------------|---------------------------|----------------------------------| +|enterprise_id |str |enterpriseId | +|department_name |str |departmentName | +|new_department_name |str |newDepartmentName *Optional* | +|new_parent_department_key |OCI.newParentDepartmentKey |newParentDepartmentKey *Optional* | +
+ + +## `EnterpriseEnterpriseTrunkGetAvailableTrunkGroupListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Request to get the list of all available trunk groups defined in an enterprise. + +It is possible to search by various criteria to restrict the number of rows returned. +Multiple search criteria are logically ANDed together. + +The response is either a +`EnterpriseEnterpriseTrunkGetAvailableTrunkGroupListResponse()` or an +`ErrorResponse()`. + +**Attributes:** + +|Name |Type |Description | +|---------------------------------|---------------------------------------|----------------------------------------| +|service_provider_id |str |serviceProviderId | +|response_size_limit |int |responseSizeLimit *Optional* | +|search_criteria_trunk_group_name |List[OCI.searchCriteriaTrunkGroupName] |searchCriteriaTrunkGroupName *Optional* | +|search_criteria_group_id |List[OCI.searchCriteriaGroupId] |searchCriteriaGroupId *Optional* | +
+ + ## `EnterpriseEnterpriseTrunkGetAvailableUserListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -63239,6 +60406,34 @@ The response is either a `EnterpriseEnterpriseTrunkGetUserListResponse()` or an
+## `EnterpriseLocalGatewayGetPagedSortedListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Get a list of local gateways defined within an enterprise. + +Only the local gateways having device associated are returned. If the +responsePagingControl element is not provided, the paging startIndex will be set to 1 +by default, and the responsePageSize will be set to the maximum ResponsePageSize by +default. If no sortOrder is included the response is sorted by Trunk group name +ascending by default. Multiple search criteria are logically ANDed together unless +the searchCriteriaModeOr option is included. Then the search criteria are logically +ORed together. + +The response is either a `EnterpriseLocalGatewayGetPagedSortedListResponse()` or an +`ErrorResponse()`. + +**Attributes:** + +|Name |Type |Description | +|---------------------------------|---------------------------------------|----------------------------------------| +|service_provider_id |str |serviceProviderId | +|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | +|sort_by_trunk_group_name |OCI.sortByTrunkGroupName |sortByTrunkGroupName *Optional* | +|search_criteria_trunk_group_name |List[OCI.searchCriteriaTrunkGroupName] |searchCriteriaTrunkGroupName *Optional* | +|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | +
+ + ## `EnterprisePhoneDirectoryGetListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -63408,53 +60603,6 @@ Replaced By: `EnterprisePhoneDirectoryGetPagedSortedListRequest()`
-## `EnterprisePhoneDirectoryGetPagedSortedListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Request a table containing the phone directory for an enterprise. - -The directory includes all users in the enterprise and all entries in the enterprise -common phone list. If the responsePagingControl element is not provided, the paging -startIndex will be set to 1 by default, and the responsePageSize will be set to the -maximum ResponsePageSize by default. It is possible to search by various criteria to -restrict the number of rows returned. If no sortOrder is included the response is -sorted by User Id ascending with a secondary sort by User Last Name ascending by -default. Multiple search criteria are logically ANDed together unless the -searchCriteriaModeOr option is included. Then the search criteria are logically ORed -together. `ErrorResponse()` is returned if searchCriteriaExactUserGroup or -searchCriteriaExactUserDepartment have multiple entries and searchCriteriaModeOr is -not included The following elements are only used in AS data mode and ignored in -Amplify and XS data mode: "sortByImpId" "searchCriteriaImpId" - -The response is either `EnterprisePhoneDirectoryGetPagedSortedListResponse()` or -`ErrorResponse()`. - -**Attributes:** - -|Name |Type |Description | -|--------------------------------------|------------------------------------------|---------------------------------------------| -|enterprise_id |str |enterpriseId | -|is_extended_info_requested |bool |isExtendedInfoRequested | -|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | -|sort_order |List[OCI.sortOrder] |sortOrder *Optional* | -|search_criteria_user_last_name |List[OCI.searchCriteriaUserLastName] |searchCriteriaUserLastName *Optional* | -|search_criteria_user_first_name |List[OCI.searchCriteriaUserFirstName] |searchCriteriaUserFirstName *Optional* | -|search_criteria_dn |List[OCI.searchCriteriaDn] |searchCriteriaDn *Optional* | -|search_criteria_group_location_code |List[OCI.searchCriteriaGroupLocationCode] |searchCriteriaGroupLocationCode *Optional* | -|search_criteria_extension |List[OCI.searchCriteriaExtension] |searchCriteriaExtension *Optional* | -|search_criteria_mobile_phone_number |List[OCI.searchCriteriaMobilePhoneNumber] |searchCriteriaMobilePhoneNumber *Optional* | -|search_criteria_email_address |List[OCI.searchCriteriaEmailAddress] |searchCriteriaEmailAddress *Optional* | -|search_criteria_exact_user_department |OCI.searchCriteriaExactUserDepartment |searchCriteriaExactUserDepartment *Optional* | -|search_criteria_department_name |List[OCI.searchCriteriaDepartmentName] |searchCriteriaDepartmentName *Optional* | -|search_criteria_exact_user_group |OCI.searchCriteriaExactUserGroup |searchCriteriaExactUserGroup *Optional* | -|search_criteria_group_name |List[OCI.searchCriteriaGroupName] |searchCriteriaGroupName *Optional* | -|search_criteria_yahoo_id |List[OCI.searchCriteriaYahooId] |searchCriteriaYahooId *Optional* | -|search_criteria_user_id |List[OCI.searchCriteriaUserId] |searchCriteriaUserId *Optional* | -|search_criteria_imp_id |List[OCI.searchCriteriaImpId] |searchCriteriaImpId *Optional* | -|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | -
- - ## `EnterprisePreAlertingAnnouncementModifyRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -63476,6 +60624,31 @@ The response is either a `SuccessResponse()` or an `ErrorResponse()`.
+## `EnterpriseSessionAdmissionControlGetAvailableDeviceListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Request to get the list of devices can be assigned to session admission control group +for the enterprise. + +The response is either an +`EnterpriseSessionAdmissionControlGetAvailableDeviceListResponse()` or an +`ErrorResponse()`. + +**Attributes:** + +|Name |Type |Description | +|-----------------------------------|-----------------------------------------|------------------------------------------| +|service_provider_id |str |serviceProviderId | +|response_size_limit |int |responseSizeLimit *Optional* | +|search_criteria_device_name |List[OCI.searchCriteriaDeviceName] |searchCriteriaDeviceName *Optional* | +|search_criteria_device_mac_address |List[OCI.searchCriteriaDeviceMACAddress] |searchCriteriaDeviceMACAddress *Optional* | +|search_criteria_device_net_address |List[OCI.searchCriteriaDeviceNetAddress] |searchCriteriaDeviceNetAddress *Optional* | +|search_criteria_group_id |List[OCI.searchCriteriaGroupId] |searchCriteriaGroupId *Optional* | +|search_criteria_exact_device_type |OCI.searchCriteriaExactDeviceType |searchCriteriaExactDeviceType *Optional* | +|search_criteria_exact_device_level |OCI.searchCriteriaExactDeviceLevel |searchCriteriaExactDeviceLevel *Optional* | +
+ + ## `EnterpriseSessionAdmissionControlGroupAddDeviceListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -63726,7 +60899,82 @@ returned.
-## `GroupAccessDeviceGetPagedSortedListRequest22`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) +## `EnterpriseVirtualOnNetEnterpriseExtensionsGetUserListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Request the list of Virtual On-Net users in an Enterprise. + +It is possible to search by various criteria to restrict the number of rows returned. +Multiple search criteria are logically ANDed together. + +The response is either a +`EnterpriseVirtualOnNetEnterpriseExtensionsGetUserListResponse()` or an +`ErrorResponse()`. + +**Attributes:** + +|Name |Type |Description | +|----------------------------------------------------|------------------------------------------------|-------------------------------------------------------| +|service_provider_id |str |serviceProviderId | +|response_size_limit |int |responseSizeLimit *Optional* | +|search_criteria_user_last_name |List[OCI.searchCriteriaUserLastName] |searchCriteriaUserLastName *Optional* | +|search_criteria_user_first_name |List[OCI.searchCriteriaUserFirstName] |searchCriteriaUserFirstName *Optional* | +|search_criteria_dn |List[OCI.searchCriteriaDn] |searchCriteriaDn *Optional* | +|search_criteria_group_location_code |List[OCI.searchCriteriaGroupLocationCode] |searchCriteriaGroupLocationCode *Optional* | +|search_criteria_extension |List[OCI.searchCriteriaExtension] |searchCriteriaExtension *Optional* | +|search_criteria_exact_virtual_on_net_call_type_name |OCI.searchCriteriaExactVirtualOnNetCallTypeName |searchCriteriaExactVirtualOnNetCallTypeName *Optional* | +
+ + +## `EnterpriseVoiceVPNGetPolicyListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Request the list of Voice VPN locations. + +It is possible to search by various criteria to restrict the number of rows returned. +Multiple search criteria are logically ANDed together. + +The response is either a `EnterpriseVoiceVPNGetPolicyListResponse()` or an +`ErrorResponse()`. + +**Attributes:** + +|Name |Type |Description | +|---------------------------------------|------------------------------------------|----------------------------------------------| +|service_provider_id |str |serviceProviderId | +|response_size_limit |int |responseSizeLimit *Optional* | +|search_criteria_group_location_code |List[OCI.searchCriteriaGroupLocationCode] |searchCriteriaGroupLocationCode *Optional* | +|search_criteria_exact_policy_selection |OCI.searchCriteriaExactPolicySelection |searchCriteriaExactPolicySelection *Optional* | +
+ + +## `GroupAccessDeviceGetListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Requests the list of access devices in a group. + +The following elements are only used in AS data mode and ignored in XS data mode: +groupExternalId + +The response is either `GroupAccessDeviceGetListResponse()` or `ErrorResponse()`. + +**Attributes:** + +|Name |Type |Description | +|--------------------------------------|--------------------------------------------|---------------------------------------------| +|service_provider_id |str |serviceProviderId *Optional* | +|group_id |str |groupId *Optional* | +|group_external_id |str |groupExternalId *Optional* | +|response_size_limit |int |responseSizeLimit *Optional* | +|search_criteria_device_name |List[OCI.searchCriteriaDeviceName] |searchCriteriaDeviceName *Optional* | +|search_criteria_device_mac_address |List[OCI.searchCriteriaDeviceMACAddress] |searchCriteriaDeviceMACAddress *Optional* | +|search_criteria_device_net_address |List[OCI.searchCriteriaDeviceNetAddress] |searchCriteriaDeviceNetAddress *Optional* | +|search_criteria_exact_device_type |OCI.searchCriteriaExactDeviceType |searchCriteriaExactDeviceType *Optional* | +|search_criteria_access_device_version |List[OCI.searchCriteriaAccessDeviceVersion] |searchCriteriaAccessDeviceVersion *Optional* | +
+ + +## `GroupAccessDeviceGetPagedSortedListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
Requests the list of access devices in a group. @@ -63743,7 +60991,8 @@ element is not set, all devices are returned with Visual Device Management API f set to empty. If the getVisualDeviceManagementAPIDevicesOnly element is set to true, only SIP devices supporting Visual Device Management API are returned. If the getVisualDeviceManagementAPIDevicesOnly element is set to false, all SIP devices are -returned with their current Visual Device Management API flag value. +returned with their current Visual Device Management API flag value. Replaced by +`GroupAccessDeviceGetPagedSortedListRequest22()`. **Attributes:** @@ -63751,9 +61000,11 @@ returned with their current Visual Device Management API flag value. |----------------------------------------------|--------------------------------------------|---------------------------------------------------| |service_provider_id |str |serviceProviderId | |group_id |str |groupId | -|include_total_number_of_rows |bool |includeTotalNumberOfRows *Optional* | |response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | -|sort_order |List[OCI.sortOrder] |sortOrder *Optional* | +|sort_by_device_name |OCI.sortByDeviceName |sortByDeviceName *Optional* | +|sort_by_device_type |OCI.sortByDeviceType |sortByDeviceType *Optional* | +|sort_by_device_net_address |OCI.sortByDeviceNetAddress |sortByDeviceNetAddress *Optional* | +|sort_by_device_mac_address |OCI.sortByDeviceMACAddress |sortByDeviceMACAddress *Optional* | |search_criteria_device_name |List[OCI.searchCriteriaDeviceName] |searchCriteriaDeviceName *Optional* | |search_criteria_device_mac_address |List[OCI.searchCriteriaDeviceMACAddress] |searchCriteriaDeviceMACAddress *Optional* | |search_criteria_device_net_address |List[OCI.searchCriteriaDeviceNetAddress] |searchCriteriaDeviceNetAddress *Optional* | @@ -63854,69 +61105,61 @@ or `ErrorResponse()`.
-## `GroupAdminGetPagedSortedListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) +## `GroupAnnouncementFileGetListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
-Get a list of group and department administrators within the group. +Get the list of available announcement files for a Group. -The response is either a `GroupAdminGetPagedSortedListResponse()` or an -`ErrorResponse()`. If no sort criterion is included, the response is sorted by -administrator id ascending by default. If the responsePagingControl element is not -provided, the paging startIndex will be set to 1 by default, and the responsePageSize -will be set to the maximum responsePageSize by default. Multiple search criteria are -logically ANDed together unless the searchCriteriaModeOr option is included. Then the -search criteria are logically ORed together. +The following elements are only used in AS data mode and ignored in XS data mode: +groupExternalId + +The response is either a `GroupAnnouncementFileGetListResponse()` or an +`ErrorResponse()`. **Attributes:** -|Name |Type |Description | -|---------------------------------------|--------------------------------------------|---------------------------------------------| -|service_provider_id |str |serviceProviderId | -|group_id |str |groupId | -|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | -|sort_order |List[OCI.sortOrder] |sortOrder *Optional* | -|search_criteria_admin_id |List[OCI.searchCriteriaAdminId] |searchCriteriaAdminId *Optional* | -|search_criteria_admin_last_name |List[OCI.searchCriteriaAdminLastName] |searchCriteriaAdminLastName *Optional* | -|search_criteria_admin_first_name |List[OCI.searchCriteriaAdminFirstName] |searchCriteriaAdminFirstName *Optional* | -|search_criteria_exact_group_admin_type |List[OCI.searchCriteriaExactGroupAdminType] |searchCriteriaExactGroupAdminType *Optional* | -|search_criteria_language |List[OCI.searchCriteriaLanguage] |searchCriteriaLanguage *Optional* | -|search_criteria_department_name |List[OCI.searchCriteriaDepartmentName] |searchCriteriaDepartmentName *Optional* | -|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | +|Name |Type |Description | +|---------------------------------------|---------------------------------------------|----------------------------------------------| +|service_provider_id |str |serviceProviderId *Optional* | +|group_id |str |groupId *Optional* | +|group_external_id |str |groupExternalId *Optional* | +|announcement_file_type |str |announcementFileType *Optional* | +|include_announcement_table |bool |includeAnnouncementTable | +|response_size_limit |int |responseSizeLimit *Optional* | +|search_criteria_announcement_file_name |List[OCI.searchCriteriaAnnouncementFileName] |searchCriteriaAnnouncementFileName *Optional* |
-## `GroupAutoAttendantGetInstancePagedSortedListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) +## `GroupAnnouncementFileGetPagedSortedListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
-Get a list of Auto Attendant instances within a group. +Get the list of available announcement files for a Group. -The response is either `GroupAutoAttendantGetInstancePagedSortedListResponse()` or -`ErrorResponse()`. If no sortOrder is included the response is sorted by Name -ascending by default. A limitation to the search by DN activation exists when the -Number Activation mode is set to Off. In this case DNs not assigned to users are -never returned by queries with the "dnActivationSearchCriteria" included. If the -responsePagingControl element is not provided, the paging startIndex will be set to 1 -by default, and the responsePageSize will be set to the maximum responsePageSize by -default. Multiple search criteria are logically ANDed together unless the -searchCriteriaModeOr option is included. Then the search criteria are logically ORed -together. +If the responsePagingControl element is not provided, the paging startIndex will be +set to 1 by default, and the responsePageSize will be set to the maximum +responsePageSize by default. If no sortOrder is included, the response is sorted by +Name ascending by default. Multiple search criteria are logically ANDed together +unless the searchCriteriaModeOr option is included. Then the search criteria are +logically ORed together. The following elements are only used in AS data mode and +ignored in XS data mode: groupExternalId + +The response is either a `GroupAnnouncementFileGetPagedSortedListResponse()` or an +`ErrorResponse()`. **Attributes:** -|Name |Type |Description | -|------------------------------------------|-----------------------------------------|------------------------------------------------| -|service_provider_id |str |serviceProviderId | -|group_id |str |groupId | -|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | -|sort_order |List[OCI.sortOrder] |sortOrder *Optional* | -|search_criteria_user_id |List[OCI.searchCriteriaUserId] |searchCriteriaUserId *Optional* | -|search_criteria_user_last_name |List[OCI.searchCriteriaUserLastName] |searchCriteriaUserLastName *Optional* | -|search_criteria_dn |List[OCI.searchCriteriaDn] |searchCriteriaDn *Optional* | -|search_criteria_extension |List[OCI.searchCriteriaExtension] |searchCriteriaExtension *Optional* | -|search_criteria_exact_dn_activation |OCI.searchCriteriaExactDnActivation |searchCriteriaExactDnActivation *Optional* | -|search_criteria_service_status |OCI.searchCriteriaServiceStatus |searchCriteriaServiceStatus *Optional* | -|search_criteria_exact_auto_attendant_type |OCI.searchCriteriaExactAutoAttendantType |searchCriteriaExactAutoAttendantType *Optional* | -|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | +|Name |Type |Description | +|---------------------------------------------|---------------------------------------------|---------------------------------------------------| +|service_provider_id |str |serviceProviderId *Optional* | +|group_id |str |groupId *Optional* | +|group_external_id |str |groupExternalId *Optional* | +|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | +|sort_by_announcement_file_name |OCI.sortByAnnouncementFileName |sortByAnnouncementFileName *Optional* | +|sort_by_announcement_file_size |OCI.sortByAnnouncementFileSize |sortByAnnouncementFileSize *Optional* | +|search_criteria_announcement_file_name |List[OCI.searchCriteriaAnnouncementFileName] |searchCriteriaAnnouncementFileName *Optional* | +|search_criteria_exact_announcement_file_type |OCI.searchCriteriaExactAnnouncementFileType |searchCriteriaExactAnnouncementFileType *Optional* | +|search_criteria_exact_media_file_type |List[OCI.searchCriteriaExactMediaFileType] |searchCriteriaExactMediaFileType *Optional* | +|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* |
@@ -64470,89 +61713,6 @@ The response is either a -## `GroupCallCenterAgentThresholdProfileGetAvailableAgentPagedSortedListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Get the list of all Agents in the Group that can be assigned to a given Call Center -Agent Threshold Profile in a Group. - -An agent is available to be assigned to a given Agent Threshold Profile if it is a -Call Center Standard or Call Center Premium agent and the agent is not yet assigned to -the profile. If the responsePagingControl element is not provided, the paging -startIndex will be set to 1 by default, and the responsePageSize will be set to the -maximum ResponsePageSize by default. It is possible to search by various criteria to -restrict the number of rows returned. The available agent list for a new Call Center -Agent Threshold profile can be obtained by not setting the -excludeAgentsAssignedToProfileName. When the excludeAgentsAssignedToProfileName is -specified, all agents already assigned to the specified profile are not included in -the response, even if the search criterion element searchCriteriaAgentThresholdProfile -is specified using the same profile name. If no sortOrder is included the response is -sorted by User Id ascending by default. Multiple search criteria are logically ANDed -together unless the searchCriteriaModeOr option is included. Then the search criteria -are logically ORed together. - -The response is either a -`GroupCallCenterAgentThresholdProfileGetAvailableAgentPagedSortedListResponse()` or an -`ErrorResponse()`. - -**Attributes:** - -|Name |Type |Description | -|----------------------------------------|----------------------------------------------|-----------------------------------------------| -|service_provider_id |str |serviceProviderId | -|group_id |str |groupId | -|exclude_agents_assigned_to_profile_name |str |excludeAgentsAssignedToProfileName *Optional* | -|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | -|sort_order |List[OCI.sortOrder] |sortOrder *Optional* | -|search_criteria_user_id |List[OCI.searchCriteriaUserId] |searchCriteriaUserId *Optional* | -|search_criteria_user_last_name |List[OCI.searchCriteriaUserLastName] |searchCriteriaUserLastName *Optional* | -|search_criteria_user_first_name |List[OCI.searchCriteriaUserFirstName] |searchCriteriaUserFirstName *Optional* | -|search_criteria_dn |List[OCI.searchCriteriaDn] |searchCriteriaDn *Optional* | -|search_criteria_extension |List[OCI.searchCriteriaExtension] |searchCriteriaExtension *Optional* | -|search_criteria_department_name |List[OCI.searchCriteriaDepartmentName] |searchCriteriaDepartmentName *Optional* | -|search_criteria_email_address |List[OCI.searchCriteriaEmailAddress] |searchCriteriaEmailAddress *Optional* | -|search_criteria_agent_threshold_profile |List[OCI.searchCriteriaAgentThresholdProfile] |searchCriteriaAgentThresholdProfile *Optional* | -|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | -
- - -## `GroupCallCenterAgentThresholdProfileGetPagedSortedRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Gets an existing non-default Call Center Agent Threshold Profile in a Group. - -If the responsePagingControl element is not provided, the paging startIndex will be -set to 1 by default, and the responsePageSize will be set to the maximum -ResponsePageSize by default. It is possible to search by various criteria to restrict -the number of rows returned. If no sortOrder is included the response is sorted by -User Id ascending by default. Multiple search criteria are logically ANDed together -unless the searchCriteriaModeOr option is included. Then the search criteria are -logically ORed together. - -The response is either a -`GroupCallCenterAgentThresholdProfileGetPagedSortedResponse()` or an -`ErrorResponse()`. - -**Attributes:** - -|Name |Type |Description | -|--------------------------------|---------------------------------------|----------------------------------------| -|service_provider_id |str |serviceProviderId | -|group_id |str |groupId | -|profile_name |str |profileName | -|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | -|sort_order |List[OCI.sortOrder] |sortOrder *Optional* | -|search_criteria_user_id |List[OCI.searchCriteriaUserId] |searchCriteriaUserId *Optional* | -|search_criteria_user_last_name |List[OCI.searchCriteriaUserLastName] |searchCriteriaUserLastName *Optional* | -|search_criteria_user_first_name |List[OCI.searchCriteriaUserFirstName] |searchCriteriaUserFirstName *Optional* | -|search_criteria_dn |List[OCI.searchCriteriaDn] |searchCriteriaDn *Optional* | -|search_criteria_extension |List[OCI.searchCriteriaExtension] |searchCriteriaExtension *Optional* | -|search_criteria_department_name |List[OCI.searchCriteriaDepartmentName] |searchCriteriaDepartmentName *Optional* | -|search_criteria_email_address |List[OCI.searchCriteriaEmailAddress] |searchCriteriaEmailAddress *Optional* | -|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | -
- - ## `GroupCallCenterComfortMessageBypassModifyRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -64626,6 +61786,49 @@ The response is either a `SuccessResponse()` or an `ErrorResponse()`.
+## `GroupCallCenterCurrentAndPastAgentGetListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Request to get all the current and past agents for the group. + +The response is either `GroupCallCenterCurrentAndPastAgentGetListResponse()` or +`ErrorResponse()`. + +**Attributes:** + +|Name |Type |Description | +|--------------------------------|--------------------------------------|---------------------------------------| +|service_provider_id |str |serviceProviderId | +|group_id |str |groupId | +|response_size_limit |int |responseSizeLimit *Optional* | +|search_criteria_user_last_name |List[OCI.searchCriteriaUserLastName] |searchCriteriaUserLastName *Optional* | +|search_criteria_user_first_name |List[OCI.searchCriteriaUserFirstName] |searchCriteriaUserFirstName *Optional* | +|search_criteria_user_id |List[OCI.searchCriteriaUserId] |searchCriteriaUserId *Optional* | +|search_criteria_dn |List[OCI.searchCriteriaDn] |searchCriteriaDn *Optional* | +|search_criteria_extension |List[OCI.searchCriteriaExtension] |searchCriteriaExtension *Optional* | +
+ + +## `GroupCallCenterCurrentAndPastCallCenterGetListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Request to get all the current and past call centers for the group. + +The response is either `GroupCallCenterCurrentAndPastCallCenterGetListResponse()` or +`ErrorResponse()`. + +**Attributes:** + +|Name |Type |Description | +|---------------------------------|---------------------------------|----------------------------------------| +|service_provider_id |str |serviceProviderId | +|is_premium_only |bool |isPremiumOnly *Optional* | +|group_id |str |groupId | +|response_size_limit |int |responseSizeLimit *Optional* | +|search_criteria_call_center_name |OCI.searchCriteriaCallCenterName |searchCriteriaCallCenterName *Optional* | +
+ + ## `GroupCallCenterEnhancedReportingScheduledReportGetActiveListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -64792,6 +61995,43 @@ XS data mode: searchCriteriaExactSkillLevel
+## `GroupCallCenterGetAgentPagedSortedListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Get a list of agents assigned to a call center. + +If the responsePagingControl element is not provided, the paging startIndex will be +set to 1 by default, and the responsePageSize will be set to the maximum +ResponsePageSize by default. It is possible to search by various criteria to restrict +the number of rows returned. Multiple search criteria are logically ANDed together +unless the searchCriteriaModeOr option is included. Then the search criteria are +logically ORed together. `ErrorResponse()` is returned if +searchCriteriaExactUserGroup or searchCriteriaExactSkillLevel have multiple entries +and searchCriteriaModeOr is not included. Sorting is done on either a priority basis +or a skill basis depending on the type of call center. + +The response is either a `GroupCallCenterGetAgentPagedSortedListResponse()` or an +`ErrorResponse()`. + +**Attributes:** + +|Name |Type |Description | +|----------------------------------|----------------------------------------|-----------------------------------------| +|service_user_id |str |serviceUserId | +|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | +|search_criteria_user_id |List[OCI.searchCriteriaUserId] |searchCriteriaUserId *Optional* | +|search_criteria_user_last_name |List[OCI.searchCriteriaUserLastName] |searchCriteriaUserLastName *Optional* | +|search_criteria_user_first_name |List[OCI.searchCriteriaUserFirstName] |searchCriteriaUserFirstName *Optional* | +|search_criteria_dn |List[OCI.searchCriteriaDn] |searchCriteriaDn *Optional* | +|search_criteria_extension |List[OCI.searchCriteriaExtension] |searchCriteriaExtension *Optional* | +|search_criteria_department_name |List[OCI.searchCriteriaDepartmentName] |searchCriteriaDepartmentName *Optional* | +|search_criteria_email_address |List[OCI.searchCriteriaEmailAddress] |searchCriteriaEmailAddress *Optional* | +|search_criteria_exact_skill_level |List[OCI.searchCriteriaExactSkillLevel] |searchCriteriaExactSkillLevel *Optional* | +|search_criteria_exact_user_group |List[OCI.searchCriteriaExactUserGroup] |searchCriteriaExactUserGroup *Optional* | +|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | +
+ + ## `GroupCallCenterGetAvailableAgentListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -64821,46 +62061,6 @@ The response is either `GroupCallCenterGetAvailableAgentListResponse()` or
-## `GroupCallCenterGetAvailableAgentPagedSortedListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Get a list of users that can be assigned as agents to a given type of Call Center. - -Searching for users by group only makes sense when the call center is part of an -Enterprise. If the responsePagingControl element is not provided, the paging -startIndex will be set to 1 by default, and the responsePageSize will be set to the -maximum ResponsePageSize by default. It is possible to search by various criteria to -restrict the number of rows returned. If no sortOrder is included the response is -sorted by User Id ascending by default. Multiple search criteria are logically ANDed -together unless the searchCriteriaModeOr option is included. Then the search criteria -are logically ORed together. `ErrorResponse()` is returned if -searchCriteriaExactUserGroup has multiple entries and searchCriteriaModeOr is not -included. - -The response is either `GroupCallCenterGetAvailableAgentPagedSortedListResponse()` or -`ErrorResponse()`. - -**Attributes:** - -|Name |Type |Description | -|---------------------------------|---------------------------------------|----------------------------------------| -|service_provider_id |str |serviceProviderId | -|group_id |str |groupId | -|call_center_type |str |callCenterType | -|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | -|sort_order |List[OCI.sortOrder] |sortOrder *Optional* | -|search_criteria_user_id |List[OCI.searchCriteriaUserId] |searchCriteriaUserId *Optional* | -|search_criteria_user_last_name |List[OCI.searchCriteriaUserLastName] |searchCriteriaUserLastName *Optional* | -|search_criteria_user_first_name |List[OCI.searchCriteriaUserFirstName] |searchCriteriaUserFirstName *Optional* | -|search_criteria_dn |List[OCI.searchCriteriaDn] |searchCriteriaDn *Optional* | -|search_criteria_extension |List[OCI.searchCriteriaExtension] |searchCriteriaExtension *Optional* | -|search_criteria_department_name |List[OCI.searchCriteriaDepartmentName] |searchCriteriaDepartmentName *Optional* | -|search_criteria_email_address |List[OCI.searchCriteriaEmailAddress] |searchCriteriaEmailAddress *Optional* | -|search_criteria_exact_user_group |List[OCI.searchCriteriaExactUserGroup] |searchCriteriaExactUserGroup *Optional* | -|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | -
- - ## `GroupCallCenterGetAvailableSupervisorListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -64917,43 +62117,6 @@ Replaced By: `GroupCallCenterGetAvailableAgentListRequest()` and
-## `GroupCallCenterGetInstancePagedSortedListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Get a list of Call Center instances within a group. - -The response is either `GroupCallCenterGetInstancePagedSortedListResponse()` or -`ErrorResponse()`. It is possible to get the instances within a specified department. -If the responsePagingControl element is not provided, the paging startIndex will be -set to 1 by default, and the responsePageSize will be set to the maximum -ResponsePageSize by default. It is possible to search by various criteria to restrict -the number of rows returned. If no sortOrder is included the response is sorted by -User Id ascending by default. Multiple search criteria are logically ANDed together -unless the searchCriteriaModeOr option is included. Then the search criteria are -logically ORed together. `ErrorResponse()` is returned if -searchCriteriaExactHuntPolicy or searchCriteriaExactCallCenterType have multiple -entries and searchCriteriaModeOr is not include. - -**Attributes:** - -|Name |Type |Description | -|---------------------------------------|--------------------------------------------|---------------------------------------------| -|service_provider_id |str |serviceProviderId | -|group_id |str |groupId | -|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | -|sort_order |List[OCI.sortOrder] |sortOrder *Optional* | -|search_criteria_user_id |List[OCI.searchCriteriaUserId] |searchCriteriaUserId *Optional* | -|search_criteria_call_center_name |List[OCI.searchCriteriaCallCenterName] |searchCriteriaCallCenterName *Optional* | -|search_criteria_dn |List[OCI.searchCriteriaDn] |searchCriteriaDn *Optional* | -|search_criteria_extension |List[OCI.searchCriteriaExtension] |searchCriteriaExtension *Optional* | -|search_criteria_department_name |List[OCI.searchCriteriaDepartmentName] |searchCriteriaDepartmentName *Optional* | -|search_criteria_service_status |OCI.searchCriteriaServiceStatus |searchCriteriaServiceStatus *Optional* | -|search_criteria_exact_hunt_policy |List[OCI.searchCriteriaExactHuntPolicy] |searchCriteriaExactHuntPolicy *Optional* | -|search_criteria_exact_call_center_type |List[OCI.searchCriteriaExactCallCenterType] |searchCriteriaExactCallCenterType *Optional* | -|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | -
- - ## `GroupCallCenterHolidayServiceModifyRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -65624,41 +62787,6 @@ The response is either `GroupCallParkGetAvailableAlternateRecallUserListResponse
-## `GroupCallParkGetAvailableAlternateRecallUserPagedSortedListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Get a list of hunt groups that are available to select as an alternate recall user. - -If the responsePagingControl element is not provided, the paging startIndex will be -set to 1 by default, and the responsePageSize will be set to the maximum -ResponsePageSize by default. It is possible to search by various criteria to restrict -the number of rows returned. If no sortOrder is included the response is sorted by -User Id ascending by default. Multiple search criteria are logically ANDed together -unless the searchCriteriaModeOr option is included. Then the search criteria are -logically ORed together. - -The response is either -`GroupCallParkGetAvailableAlternateRecallUserPagedSortedListResponse()` or -`ErrorResponse()`. - -**Attributes:** - -|Name |Type |Description | -|--------------------------------|---------------------------------------|----------------------------------------| -|service_provider_id |str |serviceProviderId | -|group_id |str |groupId | -|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | -|sort_order |List[OCI.sortOrder] |sortOrder *Optional* | -|search_criteria_user_id |List[OCI.searchCriteriaUserId] |searchCriteriaUserId *Optional* | -|search_criteria_user_last_name |List[OCI.searchCriteriaUserLastName] |searchCriteriaUserLastName *Optional* | -|search_criteria_user_first_name |List[OCI.searchCriteriaUserFirstName] |searchCriteriaUserFirstName *Optional* | -|search_criteria_dn |List[OCI.searchCriteriaDn] |searchCriteriaDn *Optional* | -|search_criteria_extension |List[OCI.searchCriteriaExtension] |searchCriteriaExtension *Optional* | -|search_criteria_department_name |List[OCI.searchCriteriaDepartmentName] |searchCriteriaDepartmentName *Optional* | -|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | -
- - ## `GroupCallParkGetAvailableUserListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -65687,21 +62815,48 @@ The response is either `GroupCallParkGetAvailableUserListResponse()` or
-## `GroupCallParkGetAvailableUserPagedSortedListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) +## `GroupCallParkGetInstancePagedSortedListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
-Get a list of users that can be assigned to a Call Park group. +Request to get a list of Call Park group instances within a group. -The available user list for a new Call Park group can be obtained by not setting the -name. If the responsePagingControl element is not provided, the paging startIndex -will be set to 1 by default, and the responsePageSize will be set to the maximum +If the responsePagingControl element is not provided, the paging startIndex will be +set to 1 by default, and the responsePageSize will be set to the maximum ResponsePageSize by default. It is possible to search by various criteria to restrict -the number of rows returned. If no sortOrder is included the response is sorted by -User Id ascending by default. Multiple search criteria are logically ANDed together +the number of rows returned. Multiple search criteria are logically ANDed together unless the searchCriteriaModeOr option is included. Then the search criteria are logically ORed together. -The response is either `GroupCallParkGetAvailableUserPagedSortedListResponse()` or +The response is either `GroupCallParkGetInstancePagedSortedListResponse()` or +`ErrorResponse()`. + +**Attributes:** + +|Name |Type |Description | +|-------------------------------|-------------------------------------|--------------------------------------| +|service_provider_id |str |serviceProviderId | +|group_id |str |groupId | +|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | +|sort_by_call_park_name |OCI.sortByCallParkName |sortByCallParkName *Optional* | +|search_criteria_call_park_name |List[OCI.searchCriteriaCallParkName] |searchCriteriaCallParkName *Optional* | +|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | +
+ + +## `GroupCallParkGetInstancePagedSortedRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Gets a Call Park group. + +If the responsePagingControl element is not provided, the paging startIndex will be +set to 1 by default, and the responsePageSize will be set to the maximum +ResponsePageSize by default. It is possible to search by various criteria to restrict +the number of rows returned. The sort order is based on the user order provided when +creating or modifying the call park instance. Multiple search criteria are logically +ANDed together unless the searchCriteriaModeOr option is included. Then the search +criteria are logically ORed together. + +The response is either `GroupCallParkGetInstancePagedSortedResponse()` or `ErrorResponse()`. **Attributes:** @@ -65710,9 +62865,8 @@ The response is either `GroupCallParkGetAvailableUserPagedSortedListResponse()` |--------------------------------|---------------------------------------|----------------------------------------| |service_provider_id |str |serviceProviderId | |group_id |str |groupId | -|name |str |name *Optional* | +|name |str |name | |response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | -|sort_order |List[OCI.sortOrder] |sortOrder *Optional* | |search_criteria_user_id |List[OCI.searchCriteriaUserId] |searchCriteriaUserId *Optional* | |search_criteria_user_last_name |List[OCI.searchCriteriaUserLastName] |searchCriteriaUserLastName *Optional* | |search_criteria_user_first_name |List[OCI.searchCriteriaUserFirstName] |searchCriteriaUserFirstName *Optional* | @@ -65752,76 +62906,31 @@ The response is either `GroupCallPickupGetAvailableUserListResponse()` or
-## `GroupCallPickupGetAvailableUserPagedSortedListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Get a list of users that can be assigned to a Call Pickup group. - -The available user list for a new Call Pickup group can be obtained by not setting the -name. If the responsePagingControl element is not provided, the paging startIndex -will be set to 1 by default, and the responsePageSize will be set to the maximum -ResponsePageSize by default. It is possible to search by various criteria to restrict -the number of rows returned. If no sortOrder is included the response is sorted by -User Id ascending by default. Multiple search criteria are logically ANDed together -unless the searchCriteriaModeOr option is included. Then the search criteria are -logically ORed together. - -The response is either `GroupCallPickupGetAvailableUserPagedSortedListResponse()` or -`ErrorResponse()`. - -**Attributes:** - -|Name |Type |Description | -|--------------------------------|---------------------------------------|----------------------------------------| -|service_provider_id |str |serviceProviderId | -|group_id |str |groupId | -|name |str |name *Optional* | -|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | -|sort_order |List[OCI.sortOrder] |sortOrder *Optional* | -|search_criteria_user_id |List[OCI.searchCriteriaUserId] |searchCriteriaUserId *Optional* | -|search_criteria_user_last_name |List[OCI.searchCriteriaUserLastName] |searchCriteriaUserLastName *Optional* | -|search_criteria_user_first_name |List[OCI.searchCriteriaUserFirstName] |searchCriteriaUserFirstName *Optional* | -|search_criteria_dn |List[OCI.searchCriteriaDn] |searchCriteriaDn *Optional* | -|search_criteria_extension |List[OCI.searchCriteriaExtension] |searchCriteriaExtension *Optional* | -|search_criteria_department_name |List[OCI.searchCriteriaDepartmentName] |searchCriteriaDepartmentName *Optional* | -|search_criteria_email_address |List[OCI.searchCriteriaEmailAddress] |searchCriteriaEmailAddress *Optional* | -|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | -
- - -## `GroupCallPickupGetInstancePagedSortedRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) +## `GroupCallPickupGetInstancePagedSortedListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
-Gets a Call Pickup group. +Request to get a list of Call Pickup instances within a group. If the responsePagingControl element is not provided, the paging startIndex will be set to 1 by default, and the responsePageSize will be set to the maximum ResponsePageSize by default. It is possible to search by various criteria to restrict the number of rows returned. Multiple search criteria are logically ANDed together unless the searchCriteriaModeOr option is included. Then the search criteria are -logically ORed together. If no sortOrder is included the response is sorted by User -Id ascending by default. +logically ORed together. -The response is either `GroupCallPickupGetInstancePagedSortedResponse()` or +The response is either `GroupCallPickupGetInstancePagedSortedListResponse()` or `ErrorResponse()`. **Attributes:** -|Name |Type |Description | -|--------------------------------|---------------------------------------|----------------------------------------| -|service_provider_id |str |serviceProviderId | -|group_id |str |groupId | -|name |str |name | -|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | -|sort_order |List[OCI.sortOrder] |sortOrder *Optional* | -|search_criteria_user_id |List[OCI.searchCriteriaUserId] |searchCriteriaUserId *Optional* | -|search_criteria_user_last_name |List[OCI.searchCriteriaUserLastName] |searchCriteriaUserLastName *Optional* | -|search_criteria_user_first_name |List[OCI.searchCriteriaUserFirstName] |searchCriteriaUserFirstName *Optional* | -|search_criteria_dn |List[OCI.searchCriteriaDn] |searchCriteriaDn *Optional* | -|search_criteria_extension |List[OCI.searchCriteriaExtension] |searchCriteriaExtension *Optional* | -|search_criteria_department_name |List[OCI.searchCriteriaDepartmentName] |searchCriteriaDepartmentName *Optional* | -|search_criteria_email_address |List[OCI.searchCriteriaEmailAddress] |searchCriteriaEmailAddress *Optional* | -|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | +|Name |Type |Description | +|---------------------------------|---------------------------------------|----------------------------------------| +|service_provider_id |str |serviceProviderId | +|group_id |str |groupId | +|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | +|sort_by_call_pickup_name |OCI.sortByCallPickupName |sortByCallPickupName *Optional* | +|search_criteria_call_pickup_name |List[OCI.searchCriteriaCallPickupName] |searchCriteriaCallPickupName *Optional* | +|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* |
@@ -65939,76 +63048,6 @@ The response is either `GroupCollaborateBridgeGetAvailableUserListResponse()` or -## `GroupCollaborateBridgeGetAvailableUserPagedSortedListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Get a list of users with the Collaborate – Audio service assigned that can be assigned -to a collaborate bridge. - -For an Enterprise Group this will include all users in the group’s enterprise. The -searchCriteriaGroupId parameter is only applicable for enterprise groups. If no -sortOrder is included the response is sorted by Last Name ascending by default. A -limitation to the search by DN activation exists when the Number Activation mode is -set to Off. In this case DNs not assigned to users are never returned by queries with -the "dnActivationSearchCriteria" included. Multiple search criteria are logically -ANDed together unless the searchCriteriaModeOr option is included. Then the search -criteria are logically ORed together. - -The response is either -`GroupCollaborateBridgeGetAvailableUserPagedSortedListResponse()` or -`ErrorResponse()`. - -**Attributes:** - -|Name |Type |Description | -|------------------------------------|---------------------------------------|-------------------------------------------| -|service_provider_id |str |serviceProviderId | -|group_id |str |groupId | -|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | -|sort_order |List[OCI.sortOrder] |sortOrder *Optional* | -|search_criteria_user_last_name |List[OCI.searchCriteriaUserLastName] |searchCriteriaUserLastName *Optional* | -|search_criteria_user_first_name |List[OCI.searchCriteriaUserFirstName] |searchCriteriaUserFirstName *Optional* | -|search_criteria_department_name |List[OCI.searchCriteriaDepartmentName] |searchCriteriaDepartmentName *Optional* | -|search_criteria_group_id |List[OCI.searchCriteriaGroupId] |searchCriteriaGroupId *Optional* | -|search_criteria_user_id |List[OCI.searchCriteriaUserId] |searchCriteriaUserId *Optional* | -|search_criteria_dn |List[OCI.searchCriteriaDn] |searchCriteriaDn *Optional* | -|search_criteria_extension |List[OCI.searchCriteriaExtension] |searchCriteriaExtension *Optional* | -|search_criteria_exact_dn_activation |OCI.searchCriteriaExactDnActivation |searchCriteriaExactDnActivation *Optional* | -|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | -
- - -## `GroupCollaborateBridgeGetInstancePagedSortedListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Get a list of collaborate bridges within a group. - -The response is either `GroupCollaborateBridgeGetInstancePagedSortedListResponse()` or -`ErrorResponse()`. If the responsePagingControl element is not provided, the paging -startIndex will be set to 1 by default, and the responsePageSize will be set to the -maximum responsePageSize by default. If no sortOrder is included the response is -sorted by Name ascending by default. . Multiple search criteria are logically ANDed -together unless the searchCriteriaModeOr option is included. Then the search criteria -are logically ORed together. - -**Attributes:** - -|Name |Type |Description | -|------------------------------------|---------------------------------------|-------------------------------------------| -|service_provider_id |str |serviceProviderId | -|group_id |str |groupId | -|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | -|sort_order |List[OCI.sortOrder] |sortOrder *Optional* | -|search_criteria_user_last_name |List[OCI.searchCriteriaUserLastName] |searchCriteriaUserLastName *Optional* | -|search_criteria_department_name |List[OCI.searchCriteriaDepartmentName] |searchCriteriaDepartmentName *Optional* | -|search_criteria_user_id |List[OCI.searchCriteriaUserId] |searchCriteriaUserId *Optional* | -|search_criteria_dn |List[OCI.searchCriteriaDn] |searchCriteriaDn *Optional* | -|search_criteria_extension |List[OCI.searchCriteriaExtension] |searchCriteriaExtension *Optional* | -|search_criteria_exact_dn_activation |OCI.searchCriteriaExactDnActivation |searchCriteriaExactDnActivation *Optional* | -|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | -
- - ## `GroupCollaborateBridgeModifyInstanceRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -66060,6 +63099,55 @@ The response is either `SuccessResponse()` or `ErrorResponse()`.
+## `GroupCommonPhoneListGetListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Get a group's common phone list. + +The response is either a `GroupCommonPhoneListGetListResponse()` or an +`ErrorResponse()`. The search can be done using multiple criterion. If the +searchCriteriaModeOr is present, any result matching any one criteria is included in +the results. Otherwise, only results matching all the search criterion are included +in the results. If no search criteria is specified, all results are returned. +Specifying searchCriteriaModeOr without any search criteria results in an +`ErrorResponse()`. In all cases, if a responseSizeLimit is specified and the number of +matching results is more than this limit, then an `ErrorResponse()` is returned. + +**Attributes:** + +|Name |Type |Description | +|-----------------------------------------------|---------------------------------------------------|----------------------------------------------------| +|service_provider_id |str |serviceProviderId | +|group_id |str |groupId | +|response_size_limit |int |responseSizeLimit *Optional* | +|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | +|search_criteria_group_common_phone_list_name |List[OCI.searchCriteriaGroupCommonPhoneListName] |searchCriteriaGroupCommonPhoneListName *Optional* | +|search_criteria_group_common_phone_list_number |List[OCI.searchCriteriaGroupCommonPhoneListNumber] |searchCriteriaGroupCommonPhoneListNumber *Optional* | +
+ + +## `GroupCommunicationBarringAuthorizationCodeGetListRequest21sp1`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Get a list of Communication Barring Authorization Codes for a group. + +The response is either +`GroupCommunicationBarringAuthorizationCodeGetListResponse21sp1()` or +`ErrorResponse()`. + +**Attributes:** + +|Name |Type |Description | +|---------------------------------------------------------------------|-------------------------------------------------------------------------|--------------------------------------------------------------------------| +|service_provider_id |str |serviceProviderId | +|group_id |str |groupId | +|response_size_limit |int |responseSizeLimit *Optional* | +|search_criteria_communication_barring_authorization_code |List[OCI.searchCriteriaCommunicationBarringAuthorizationCode] |searchCriteriaCommunicationBarringAuthorizationCode *Optional* | +|search_criteria_communication_barring_authorization_code_description |List[OCI.searchCriteriaCommunicationBarringAuthorizationCodeDescription] |searchCriteriaCommunicationBarringAuthorizationCodeDescription *Optional* | +|search_criteria_network_class_of_service_name |List[OCI.searchCriteriaNetworkClassOfServiceName] |searchCriteriaNetworkClassOfServiceName *Optional* | +
+ + ## `GroupConsolidatedAddRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -66379,6 +63467,100 @@ The response is either a `SuccessResponse()` or an `ErrorResponse()`.
+## `GroupDepartmentAdminAddRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Add a department administrator to a group department. + +The response is either a `SuccessResponse()` or an `ErrorResponse()`. + +**Attributes:** + +|Name |Type |Description | +|---------------|------------------|---------------------| +|department_key |OCI.departmentKey |departmentKey | +|user_id |str |userId | +|first_name |str |firstName *Optional* | +|last_name |str |lastName *Optional* | +|password |str |password *Optional* | +|language |str |language *Optional* | +
+ + +## `GroupDepartmentAdminGetListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Get a list of department administrators for the department. + +The response is either a `GroupDepartmentAdminGetListResponse()` or an +`ErrorResponse()`. + +**Attributes:** + +|Name |Type |Description | +|---------------|------------------|--------------| +|department_key |OCI.departmentKey |departmentKey | +
+ + +## `GroupDeviceManagementEventGetListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Request device management's events for a specific queue. + +It is possible to restrict the number of rows returned using responseSizeLimit. If +eventQueueType is not specified, the events from all the event queues are returned. + +The response is either a `GroupDeviceManagementEventGetListResponse()` or an +`ErrorResponse()`. + +**Attributes:** + +|Name |Type |Description | +|----------------------------------------------------------------------------|----------------------------------------------------------------------|-----------------------------------------------------------------------------| +|service_provider_id |str |serviceProviderId | +|group_id |str |groupId | +|event_queue_type |str |eventQueueType *Optional* | +|response_size_limit |int |responseSizeLimit *Optional* | +|search_criteria_exact_device_management_event_status_in_progress_or_pending |OCI.searchCriteriaExactDeviceManagementEventStatusInProgressOrPending |searchCriteriaExactDeviceManagementEventStatusInProgressOrPending *Optional* | +|search_criteria_exact_device_management_event_status_completed |OCI.searchCriteriaExactDeviceManagementEventStatusCompleted |searchCriteriaExactDeviceManagementEventStatusCompleted *Optional* | +|search_criteria_exact_device_management_event_action |OCI.searchCriteriaExactDeviceManagementEventAction |searchCriteriaExactDeviceManagementEventAction *Optional* | +|search_criteria_exact_device_management_event_level |OCI.searchCriteriaExactDeviceManagementEventLevel |searchCriteriaExactDeviceManagementEventLevel *Optional* | +|search_criteria_exact_device_management_event_type |OCI.searchCriteriaExactDeviceManagementEventType |searchCriteriaExactDeviceManagementEventType *Optional* | +|search_criteria_device_management_event_additional_info |List[OCI.searchCriteriaDeviceManagementEventAdditionalInfo] |searchCriteriaDeviceManagementEventAdditionalInfo *Optional* | +|search_criteria_device_management_event_login_id |List[OCI.searchCriteriaDeviceManagementEventLoginId] |searchCriteriaDeviceManagementEventLoginId *Optional* | +
+ + +## `GroupDeviceManagementEventGetListRequest22`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Request device management's events for a specific queue. + +It is possible to restrict the number of rows returned using responseSizeLimit. If +eventQueueType is not specified, the events from all the event queues are returned. + +The response is either a `GroupDeviceManagementEventGetListResponse22()` or an +`ErrorResponse()`. + +**Attributes:** + +|Name |Type |Description | +|----------------------------------------------------------------------------|----------------------------------------------------------------------|-----------------------------------------------------------------------------| +|service_provider_id |str |serviceProviderId | +|group_id |str |groupId | +|event_queue_type |str |eventQueueType *Optional* | +|response_size_limit |int |responseSizeLimit *Optional* | +|search_criteria_exact_device_management_event_status_in_progress_or_pending |OCI.searchCriteriaExactDeviceManagementEventStatusInProgressOrPending |searchCriteriaExactDeviceManagementEventStatusInProgressOrPending *Optional* | +|search_criteria_exact_device_management_event_status_completed |OCI.searchCriteriaExactDeviceManagementEventStatusCompleted |searchCriteriaExactDeviceManagementEventStatusCompleted *Optional* | +|search_criteria_exact_device_management_event_action |OCI.searchCriteriaExactDeviceManagementEventAction |searchCriteriaExactDeviceManagementEventAction *Optional* | +|search_criteria_exact_device_management_event_level |OCI.searchCriteriaExactDeviceManagementEventLevel |searchCriteriaExactDeviceManagementEventLevel *Optional* | +|search_criteria_exact_device_management_event_type |OCI.searchCriteriaExactDeviceManagementEventType |searchCriteriaExactDeviceManagementEventType *Optional* | +|search_criteria_device_management_event_additional_info |List[OCI.searchCriteriaDeviceManagementEventAdditionalInfo] |searchCriteriaDeviceManagementEventAdditionalInfo *Optional* | +|search_criteria_device_management_event_login_id |List[OCI.searchCriteriaDeviceManagementEventLoginId] |searchCriteriaDeviceManagementEventLoginId *Optional* | +
+ + ## `GroupDnGetAssignmentListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -66434,49 +63616,6 @@ The response is either a `GroupDnGetAssignmentListResponse18()` or an
-## `GroupDnGetAssignmentPagedSortedListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Get the list of assigned and unassigned DNs in a group. - -Each DN can be assigned to a user and/or department. Ranges of DNs with identical -assignment and activation properties are coalesced to a single table row entry. Dns -assigned to the IMRN pool are not listed in the response. If the -responsePagingControl element is not provided, the paging startIndex will be set to 1 -by default, and the responsePageSize will be set to the maximum ResponsePageSize by -default. If no sortOrder is included the response is sorted by Phone Number by -default. Multiple search criteria are logically ANDed together unless the -searchCriteriaModeOr option is included. Then the search criterion are logically ORed -together. The department in both the search criteria and sort by fields refer to the -department to which the dn belongs. A limitation to the search by DN activation -exists when the Number Activation mode is set to Off. In this case DNs not assigned -to users are never returned by queries with the "dnActivationSearchCriteria" included. - -The response is either a `GroupDnGetAssignmentPagedSortedListResponse()` or an -`ErrorResponse()`. - -**Attributes:** - -|Name |Type |Description | -|--------------------------------------|---------------------------------------|---------------------------------------------| -|service_provider_id |str |serviceProviderId | -|group_id |str |groupId | -|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | -|sort_order |List[OCI.sortOrder] |sortOrder *Optional* | -|search_criteria_dn |List[OCI.searchCriteriaDn] |searchCriteriaDn *Optional* | -|search_criteria_department_name |List[OCI.searchCriteriaDepartmentName] |searchCriteriaDepartmentName *Optional* | -|search_criteria_exact_dn_activation |OCI.searchCriteriaExactDnActivation |searchCriteriaExactDnActivation *Optional* | -|search_criteria_exact_dn_availability |OCI.searchCriteriaExactDnAvailability |searchCriteriaExactDnAvailability *Optional* | -|search_criteria_user_id |List[OCI.searchCriteriaUserId] |searchCriteriaUserId *Optional* | -|search_criteria_user_first_name |List[OCI.searchCriteriaUserFirstName] |searchCriteriaUserFirstName *Optional* | -|search_criteria_user_last_name |List[OCI.searchCriteriaUserLastName] |searchCriteriaUserLastName *Optional* | -|search_criteria_exact_user_type |List[OCI.searchCriteriaExactUserType] |searchCriteriaExactUserType *Optional* | -|search_criteria_extension |List[OCI.searchCriteriaExtension] |searchCriteriaExtension *Optional* | -|search_criteria_email_address |List[OCI.searchCriteriaEmailAddress] |searchCriteriaEmailAddress *Optional* | -|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | -
- - ## `GroupDomainGetAssignedUserListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -66532,6 +63671,28 @@ The response is either `GroupEndpointGetListResponse()` or `ErrorResponse()`.
+## `GroupEnterpriseTrunkGetAvailableTrunkGroupListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Request to get the list of all available trunk groups defined in a group. + +It is possible to search by various criteria to restrict the number of rows returned. +Multiple search criteria are logically ANDed together. + +The response is either a `GroupEnterpriseTrunkGetAvailableTrunkGroupListResponse()` or +an `ErrorResponse()`. + +**Attributes:** + +|Name |Type |Description | +|---------------------------------|---------------------------------------|----------------------------------------| +|service_provider_id |str |serviceProviderId | +|group_id |str |groupId | +|response_size_limit |int |responseSizeLimit *Optional* | +|search_criteria_trunk_group_name |List[OCI.searchCriteriaTrunkGroupName] |searchCriteriaTrunkGroupName *Optional* | +
+ + ## `GroupEnterpriseTrunkGetAvailableUserListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -66771,30 +63932,51 @@ The response is either `SuccessResponse()` or `ErrorResponse()`. Replaced by:
-## `GroupGetListInServiceProviderPagedSortedListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) +## `GroupGetListInServiceProviderRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
Request the list of groups in a service provider or enterprise. -If no sortOrder is included, the response is sorted by Group Id ascending by default. +It is possible to search by various criteria to restrict the number of rows returned. +Multiple search criteria are logically ANDed together. -The response is either a `GroupGetListInServiceProviderPagedSortedListResponse()` or -an `ErrorResponse()`. If the responsePagingControl element is not provided, the paging -startIndex will be set to 1 by default, and the responsePageSize will be set to the -maximum responsePageSize by default. Multiple search criteria are logically ANDed -together unless the searchCriteriaModeOr option is included. Then the search criteria -are logically ORed together. +The response is either a `GroupGetListInServiceProviderResponse()` or an +`ErrorResponse()`. **Attributes:** |Name |Type |Description | |---------------------------|----------------------------------|-----------------------------------| |service_provider_id |str |serviceProviderId | -|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | -|sort_order |List[OCI.sortOrder] |sortOrder *Optional* | +|response_size_limit |int |responseSizeLimit *Optional* | |search_criteria_group_id |List[OCI.searchCriteriaGroupId] |searchCriteriaGroupId *Optional* | |search_criteria_group_name |List[OCI.searchCriteriaGroupName] |searchCriteriaGroupName *Optional* | -|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | +
+ + +## `GroupGetListInSystemRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Request the list of groups in the system. + +It is possible to search by various criteria to restrict the number of rows returned. +Multiple search criteria are logically ANDed together. If reseller administrator +sends the request, searchCriteriaResellerId is ignored. All the groups in the +administrator's reseller meeting the search criteria are returned. + +The response is either a `GroupGetListInSystemResponse()` or an `ErrorResponse()`. The +following data elements are only used in AS data mode: searchCriteriaResellerId + +**Attributes:** + +|Name |Type |Description | +|---------------------------------------|------------------------------------------|----------------------------------------------| +|response_size_limit |int |responseSizeLimit *Optional* | +|search_criteria_group_id |List[OCI.searchCriteriaGroupId] |searchCriteriaGroupId *Optional* | +|search_criteria_group_name |List[OCI.searchCriteriaGroupName] |searchCriteriaGroupName *Optional* | +|search_criteria_exact_service_provider |OCI.searchCriteriaExactServiceProvider |searchCriteriaExactServiceProvider *Optional* | +|search_criteria_service_provider_id |List[OCI.searchCriteriaServiceProviderId] |searchCriteriaServiceProviderId *Optional* | +|search_criteria_reseller_id |List[OCI.searchCriteriaResellerId] |searchCriteriaResellerId *Optional* |
@@ -67151,78 +64333,6 @@ The response is either `GroupHuntGroupGetAvailableUserListResponse()` or -## `GroupHuntGroupGetAvailableUserPagedSortedListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Get a list of users that can be assigned to a Hunt Group group. - -Searching for users by group only makes sense when the hunt group is part of an -Enterprise. A limitation to the search by DN activation exists when the Number -Activation mode is set to Off. In this case DNs not assigned to users are never -returned by queries with the "dnActivationSearchCriteria" included. - -The response is either `GroupHuntGroupGetAvailableUserPagedSortedListResponse()` or -`ErrorResponse()`. If no sortOrder is included, the response is sorted by User Id -ascending by default. If the responsePagingControl element is not provided, the -paging startIndex will be set to 1 by default, and the responsePageSize will be set to -the maximum responsePageSize by default. Multiple search criteria are logically ANDed -together unless the searchCriteriaModeOr option is included. Then the search criteria -are logically ORed together. - -**Attributes:** - -|Name |Type |Description | -|------------------------------------|---------------------------------------|-------------------------------------------| -|service_provider_id |str |serviceProviderId | -|group_id |str |groupId | -|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | -|sort_order |List[OCI.sortOrder] |sortOrder *Optional* | -|search_criteria_user_last_name |List[OCI.searchCriteriaUserLastName] |searchCriteriaUserLastName *Optional* | -|search_criteria_user_first_name |List[OCI.searchCriteriaUserFirstName] |searchCriteriaUserFirstName *Optional* | -|search_criteria_department_name |List[OCI.searchCriteriaDepartmentName] |searchCriteriaDepartmentName *Optional* | -|search_criteria_group_id |List[OCI.searchCriteriaGroupId] |searchCriteriaGroupId *Optional* | -|search_criteria_user_id |List[OCI.searchCriteriaUserId] |searchCriteriaUserId *Optional* | -|search_criteria_dn |List[OCI.searchCriteriaDn] |searchCriteriaDn *Optional* | -|search_criteria_extension |List[OCI.searchCriteriaExtension] |searchCriteriaExtension *Optional* | -|search_criteria_exact_dn_activation |OCI.searchCriteriaExactDnActivation |searchCriteriaExactDnActivation *Optional* | -|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | -
- - -## `GroupHuntGroupGetInstancePagedSortedListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Get a list of Hunt Group instances within a group. - -The response is either `GroupHuntGroupGetInstancePagedSortedListResponse()` or -`ErrorResponse()`. It is possible to get the instances within a specified department. -The department in both the search criteria and sort by fields refer to the department -to which the dn belongs. If no sortOrder is included, the response is sorted by User -Id ascending by default. If the responsePagingControl element is not provided, the -paging startIndex will be set to 1 by default, and the responsePageSize will be set to -the maximum responsePageSize by default. Multiple search criteria are logically ANDed -together unless the searchCriteriaModeOr option is included. Then the search criteria -are logically ORed together. - -**Attributes:** - -|Name |Type |Description | -|------------------------------------|---------------------------------------|-------------------------------------------| -|service_provider_id |str |serviceProviderId | -|group_id |str |groupId | -|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | -|sort_order |List[OCI.sortOrder] |sortOrder *Optional* | -|search_criteria_user_last_name |List[OCI.searchCriteriaUserLastName] |searchCriteriaUserLastName *Optional* | -|search_criteria_department_name |List[OCI.searchCriteriaDepartmentName] |searchCriteriaDepartmentName *Optional* | -|search_criteria_user_id |List[OCI.searchCriteriaUserId] |searchCriteriaUserId *Optional* | -|search_criteria_dn |List[OCI.searchCriteriaDn] |searchCriteriaDn *Optional* | -|search_criteria_extension |List[OCI.searchCriteriaExtension] |searchCriteriaExtension *Optional* | -|search_criteria_exact_dn_activation |OCI.searchCriteriaExactDnActivation |searchCriteriaExactDnActivation *Optional* | -|search_criteria_service_status |OCI.searchCriteriaServiceStatus |searchCriteriaServiceStatus *Optional* | -|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | -
- - ## `GroupHuntGroupModifyInstanceRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -67938,57 +65048,6 @@ Replaced By: `GroupPhoneDirectoryGetPagedSortedListRequest()`
-## `GroupPhoneDirectoryGetPagedSortedListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Request a table containing the phone directory for a group. - -The directory includes all users in the group and all entries in the group common -phone list. If the specified group is part of an enterprise, the directory includes -all users in the enterprise and all entries in the enterprise common phone list and -the common phone list of the specified group. If the specified group is part of a -service provider, the directory includes all users in the group and all entries in the -common phone list of the specified group. If the responsePagingControl element is not -provided, the paging startIndex will be set to 1 by default, and the responsePageSize -will be set to the maximum ResponsePageSize by default. It is possible to search by -various criteria to restrict the number of rows returned. If no sortOrder is included -the response is sorted by User Id ascending with a secondary sort by User Last Name -ascending by default. Multiple search criteria are logically ANDed together unless -the searchCriteriaModeOr option is included. Then the search criteria are logically -ORed together. `ErrorResponse()` is returned if searchCriteriaExactUserGroup or -searchCriteriaExactUserDepartment have multiple entries and searchCriteriaModeOr is -not included. The following elements are only used in AS data mode and ignored in -Amplify and XS data mode: "sortByImpId" "searchCriteriaImpId" - -The response is either `GroupPhoneDirectoryGetPagedSortedListResponse()` or -`ErrorResponse()`. - -**Attributes:** - -|Name |Type |Description | -|--------------------------------------|------------------------------------------|---------------------------------------------| -|service_provider_id |str |serviceProviderId | -|group_id |str |groupId | -|is_extended_info_requested |bool |isExtendedInfoRequested | -|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | -|sort_order |List[OCI.sortOrder] |sortOrder *Optional* | -|search_criteria_user_last_name |List[OCI.searchCriteriaUserLastName] |searchCriteriaUserLastName *Optional* | -|search_criteria_user_first_name |List[OCI.searchCriteriaUserFirstName] |searchCriteriaUserFirstName *Optional* | -|search_criteria_dn |List[OCI.searchCriteriaDn] |searchCriteriaDn *Optional* | -|search_criteria_group_location_code |List[OCI.searchCriteriaGroupLocationCode] |searchCriteriaGroupLocationCode *Optional* | -|search_criteria_extension |List[OCI.searchCriteriaExtension] |searchCriteriaExtension *Optional* | -|search_criteria_mobile_phone_number |List[OCI.searchCriteriaMobilePhoneNumber] |searchCriteriaMobilePhoneNumber *Optional* | -|search_criteria_email_address |List[OCI.searchCriteriaEmailAddress] |searchCriteriaEmailAddress *Optional* | -|search_criteria_exact_user_department |OCI.searchCriteriaExactUserDepartment |searchCriteriaExactUserDepartment *Optional* | -|search_criteria_department_name |List[OCI.searchCriteriaDepartmentName] |searchCriteriaDepartmentName *Optional* | -|search_criteria_exact_user_group |OCI.searchCriteriaExactUserGroup |searchCriteriaExactUserGroup *Optional* | -|search_criteria_yahoo_id |List[OCI.searchCriteriaYahooId] |searchCriteriaYahooId *Optional* | -|search_criteria_user_id |List[OCI.searchCriteriaUserId] |searchCriteriaUserId *Optional* | -|search_criteria_imp_id |List[OCI.searchCriteriaImpId] |searchCriteriaImpId *Optional* | -|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | -
- - ## `GroupPreAlertingAnnouncementModifyRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -68150,31 +65209,29 @@ callAdmissionTimerSeconds, use value ‘3’ in XS data mode.
-## `GroupRoutePointForcedForwardingModifyRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) +## `GroupRoutePointExternalSystemGetAssignedRoutePointListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
-Modify a route point's forced forwarding settings. +Request a list of route points within in a group that have a given external system +assigned. -The response is either a `SuccessResponse()` or an `ErrorResponse()`. +The response is either +`GroupRoutePointExternalSystemGetAssignedRoutePointListResponse()` or +`ErrorResponse()`. **Attributes:** -|Name |Type |Description | -|------------------------------------|------------------|--------------------------------------------| -|service_user_id |str |serviceUserId | -|is_active |bool |isActive *Optional* | -|forward_to_phone_number |str |forwardToPhoneNumber *Optional* | -|play_announcement_before_forwarding |bool |playAnnouncementBeforeForwarding *Optional* | -|audio_message_selection |str |audioMessageSelection *Optional* | -|audio_url_list |OCI.audioUrlList |audioUrlList *Optional* | -|audio_file_list |OCI.audioFileList |audioFileList *Optional* | -|video_message_selection |str |videoMessageSelection *Optional* | -|video_url_list |OCI.videoUrlList |videoUrlList *Optional* | -|video_file_list |OCI.videoFileList |videoFileList *Optional* | +|Name |Type |Description | +|---------------------------------|---------------------------------------|----------------------------------------| +|service_provider_id |str |serviceProviderId | +|group_id |str |groupId | +|external_system |str |externalSystem | +|response_size_limit |int |responseSizeLimit *Optional* | +|search_criteria_route_point_name |List[OCI.searchCriteriaRoutePointName] |searchCriteriaRoutePointName *Optional* |
-## `GroupRoutePointForcedForwardingModifyRequest20`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) +## `GroupRoutePointForcedForwardingModifyRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
Modify a route point's forced forwarding settings. @@ -68198,6 +65255,52 @@ The response is either a `SuccessResponse()` or an `ErrorResponse()`.
+## `GroupRoutePointForcedForwardingModifyRequest20`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Modify a route point's forced forwarding settings. + +The response is either a `SuccessResponse()` or an `ErrorResponse()`. + +**Attributes:** + +|Name |Type |Description | +|------------------------------------|------------------|--------------------------------------------| +|service_user_id |str |serviceUserId | +|is_active |bool |isActive *Optional* | +|forward_to_phone_number |str |forwardToPhoneNumber *Optional* | +|play_announcement_before_forwarding |bool |playAnnouncementBeforeForwarding *Optional* | +|audio_message_selection |str |audioMessageSelection *Optional* | +|audio_url_list |OCI.audioUrlList |audioUrlList *Optional* | +|audio_file_list |OCI.audioFileList |audioFileList *Optional* | +|video_message_selection |str |videoMessageSelection *Optional* | +|video_url_list |OCI.videoUrlList |videoUrlList *Optional* | +|video_file_list |OCI.videoFileList |videoFileList *Optional* | +
+ + +## `GroupRoutePointGetInstanceListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Get a list of Route Point instances within a group. + +It is possible to search by various criteria to restrict the number of rows returned. + +The response is either `GroupRoutePointGetInstanceListResponse()` or +`ErrorResponse()`. It is possible to get the instances within a specified department. + +**Attributes:** + +|Name |Type |Description | +|---------------------------------|---------------------------------------|----------------------------------------| +|service_provider_id |str |serviceProviderId | +|group_id |str |groupId | +|group_department_name |str |groupDepartmentName *Optional* | +|response_size_limit |int |responseSizeLimit *Optional* | +|search_criteria_route_point_name |List[OCI.searchCriteriaRoutePointName] |searchCriteriaRoutePointName *Optional* | +
+ + ## `GroupRoutePointHolidayServiceModifyRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -68499,6 +65602,34 @@ The response is either a `SuccessResponse()` or an `ErrorResponse()`.
+## `GroupScheduleGetPagedSortedListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Get the list of schedules viewable by a group. + +The response is either a `GroupScheduleGetPagedSortedListResponse()` or an +`ErrorResponse()`. If no sortOrder is included, the response is sorted by Name +ascending by default. If the responsePagingControl element is not provided, the +paging startIndex will be set to 1 by default, and the responsePageSize will be set to +the maximum responsePageSize by default. Multiple search criteria are logically ANDed +together unless the searchCriteriaModeOr option is included. Then the search criteria +are logically ORed together. + +**Attributes:** + +|Name |Type |Description | +|-------------------------------------|-------------------------------------------|--------------------------------------------| +|service_provider_id |str |serviceProviderId | +|group_id |str |groupId | +|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | +|sort_by_schedule_name |OCI.sortByScheduleName |sortByScheduleName *Optional* | +|search_criteria_schedule_name |List[OCI.searchCriteriaScheduleName] |searchCriteriaScheduleName *Optional* | +|search_criteria_exact_schedule_type |List[OCI.searchCriteriaExactScheduleType] |searchCriteriaExactScheduleType *Optional* | +|search_criteria_exact_schedule_level |List[OCI.searchCriteriaExactScheduleLevel] |searchCriteriaExactScheduleLevel *Optional* | +|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | +
+ + ## `GroupSeriesCompletionGetAvailableUserListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -68548,6 +65679,31 @@ The response is either `SuccessResponse()` or `ErrorResponse()`.
+## `GroupSessionAdmissionControlGetAvailableDeviceListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Request to get the list of devices can be assigned to session admission control group +for the group. + +The response is either an +`GroupSessionAdmissionControlGetAvailableDeviceListResponse()` or an +`ErrorResponse()`. + +**Attributes:** + +|Name |Type |Description | +|-----------------------------------|-----------------------------------------|------------------------------------------| +|service_provider_id |str |serviceProviderId | +|group_id |str |groupId | +|response_size_limit |int |responseSizeLimit *Optional* | +|search_criteria_device_name |List[OCI.searchCriteriaDeviceName] |searchCriteriaDeviceName *Optional* | +|search_criteria_device_mac_address |List[OCI.searchCriteriaDeviceMACAddress] |searchCriteriaDeviceMACAddress *Optional* | +|search_criteria_device_net_address |List[OCI.searchCriteriaDeviceNetAddress] |searchCriteriaDeviceNetAddress *Optional* | +|search_criteria_exact_device_type |OCI.searchCriteriaExactDeviceType |searchCriteriaExactDeviceType *Optional* | +|search_criteria_exact_device_level |OCI.searchCriteriaExactDeviceLevel |searchCriteriaExactDeviceLevel *Optional* | +
+ + ## `GroupSessionAdmissionControlGroupModifyRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -69735,6 +66891,32 @@ The response is either a `SuccessResponse()` or an `ErrorResponse()`.
+## `GroupVirtualOnNetEnterpriseExtensionsGetUserListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Request the list of Virtual On-Net users in a Group. + +It is possible to search by various criteria to restrict the number of rows returned. +Multiple search criteria are logically ANDed together. + +The response is either a `GroupVirtualOnNetEnterpriseExtensionsGetUserListResponse()` +or an `ErrorResponse()`. + +**Attributes:** + +|Name |Type |Description | +|----------------------------------------------------|------------------------------------------------|-------------------------------------------------------| +|service_provider_id |str |serviceProviderId | +|group_id |str |groupId | +|response_size_limit |int |responseSizeLimit *Optional* | +|search_criteria_user_last_name |List[OCI.searchCriteriaUserLastName] |searchCriteriaUserLastName *Optional* | +|search_criteria_user_first_name |List[OCI.searchCriteriaUserFirstName] |searchCriteriaUserFirstName *Optional* | +|search_criteria_dn |List[OCI.searchCriteriaDn] |searchCriteriaDn *Optional* | +|search_criteria_extension |List[OCI.searchCriteriaExtension] |searchCriteriaExtension *Optional* | +|search_criteria_exact_virtual_on_net_call_type_name |OCI.searchCriteriaExactVirtualOnNetCallTypeName |searchCriteriaExactVirtualOnNetCallTypeName *Optional* | +
+ + ## `GroupVoiceMessagingGroupConsolidatedModifyVoicePortalRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -69851,6 +67033,160 @@ The response is either `SuccessResponse()` or `ErrorResponse()`.
+## `GroupXsiPolicyProfileGetAssignedUserListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Get a list of user within a group that have a given user Xsi policy profile assigned. + +The response is either a `GroupXsiPolicyProfileGetAssignedUserListResponse()` or an +`ErrorResponse()`. + +**Attributes:** + +|Name |Type |Description | +|--------------------------------|--------------------------------------|---------------------------------------| +|service_provider_id |str |serviceProviderId | +|group_id |str |groupId | +|xsi_policy_profile |OCI.xsiPolicyProfile |xsiPolicyProfile | +|response_size_limit |int |responseSizeLimit *Optional* | +|search_criteria_user_id |List[OCI.searchCriteriaUserId] |searchCriteriaUserId *Optional* | +|search_criteria_user_last_name |List[OCI.searchCriteriaUserLastName] |searchCriteriaUserLastName *Optional* | +|search_criteria_user_first_name |List[OCI.searchCriteriaUserFirstName] |searchCriteriaUserFirstName *Optional* | +|search_criteria_dn |List[OCI.searchCriteriaDn] |searchCriteriaDn *Optional* | +|search_criteria_extension |List[OCI.searchCriteriaExtension] |searchCriteriaExtension *Optional* | +
+ + +## `ResellerGetListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Request a list of resellers in the system. + +It is possible to search by various criteria to restrict the number of rows returned. +Multiple search criteria are logically ANDed together. + +The response is either a `ResellerGetListResponse()` or an `ErrorResponse()`. + +**Attributes:** + +|Name |Type |Description | +|------------------------------|-------------------------------------|--------------------------------------| +|response_size_limit |int |responseSizeLimit *Optional* | +|search_criteria_reseller_id |List[OCI.searchCriteriaResellerId] |searchCriteriaResellerId *Optional* | +|search_criteria_reseller_name |List[OCI.searchCriteriaResellerName] |searchCriteriaResellerName *Optional* | +
+ + +## `ResellerNetworkClassOfServiceGetAssignedServiceProviderListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Get a list of service provider/enterprises within a reseller that have a given Network +Class of Service assigned. + +The response is either a +`ResellerNetworkClassOfServiceGetAssignedServiceProviderListResponse()` or an +`ErorResponse()`. + +**Attributes:** + +|Name |Type |Description | +|--------------------------------------|--------------------------------------------|---------------------------------------------| +|reseller_id |str |resellerId | +|network_class_of_service |str |networkClassOfService | +|response_size_limit |int |responseSizeLimit *Optional* | +|search_criteria_service_provider_id |List[OCI.searchCriteriaServiceProviderId] |searchCriteriaServiceProviderId *Optional* | +|search_criteria_service_provider_name |List[OCI.searchCriteriaServiceProviderName] |searchCriteriaServiceProviderName *Optional* | +
+ + +## `ResellerXsiPolicyProfileGetAssignedServiceProviderListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Get a list of service provider/enterprises within a reseller that have a given Service +provider Xsi policy profile assigned. + +The response is either a +`ResellerXsiPolichProfileGetAssignedServiceProviderListResponse()` or an +`ErrorResponse()`. + +**Attributes:** + +|Name |Type |Description | +|----------------------------------------|--------------------------------------------|-----------------------------------------------| +|reseller_id |str |resellerId | +|xsi_policy_profile |OCI.xsiPolicyProfile |xsiPolicyProfile | +|response_size_limit |int |responseSizeLimit *Optional* | +|search_criteria_service_provider_id |List[OCI.searchCriteriaServiceProviderId] |searchCriteriaServiceProviderId *Optional* | +|search_criteria_service_provider_name |List[OCI.searchCriteriaServiceProviderName] |searchCriteriaServiceProviderName *Optional* | +|search_criteria_exact_organization_type |OCI.searchCriteriaExactOrganizationType |searchCriteriaExactOrganizationType *Optional* | +
+ + +## `ServiceProviderAccessDeviceGetListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Requests the list of access devices in a service provider. + +The following elements are only used in AS data mode and ignored in XS data mode: +serviceProviderExternalId + +The response is either `ServiceProviderAccessDeviceGetListResponse()` or +`ErrorResponse()`. + +**Attributes:** + +|Name |Type |Description | +|--------------------------------------|--------------------------------------------|---------------------------------------------| +|service_provider_id |str |serviceProviderId *Optional* | +|service_provider_external_id |str |serviceProviderExternalId *Optional* | +|response_size_limit |int |responseSizeLimit *Optional* | +|search_criteria_device_name |List[OCI.searchCriteriaDeviceName] |searchCriteriaDeviceName *Optional* | +|search_criteria_device_mac_address |List[OCI.searchCriteriaDeviceMACAddress] |searchCriteriaDeviceMACAddress *Optional* | +|search_criteria_device_net_address |List[OCI.searchCriteriaDeviceNetAddress] |searchCriteriaDeviceNetAddress *Optional* | +|search_criteria_exact_device_type |OCI.searchCriteriaExactDeviceType |searchCriteriaExactDeviceType *Optional* | +|search_criteria_access_device_version |List[OCI.searchCriteriaAccessDeviceVersion] |searchCriteriaAccessDeviceVersion *Optional* | +
+ + +## `ServiceProviderAccessDeviceGetPagedSortedListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Requests the list of service provider level access devices. + +The response is either `ServiceProviderAccessDeviceGetPagedSortedListResponse()` or +`ErrorResponse()`. If no sortOrder is included, the response is sorted by Device Name +ascending by default. If the responsePagingControl element is not provided, the +paging startIndex will be set to 1 by default, and the responsePageSize will be set to +the maximum responsePageSize by default. Multiple search criteria are logically ANDed +together unless the searchCriteriaModeOr option is included. Then the search criteria +are logically ORed together. The getVisualDeviceManagementAPIDevicesOnly element can +only be set when CloudPBX is licenced. If the getVisualDeviceManagementAPIDevicesOnly +element is not set, all devices are returned with Visual Device Management API flag +set to empty. If the getVisualDeviceManagementAPIDevicesOnly element is set to true, +only SIP devices supporting Visual Device Management API are returned. If the +getVisualDeviceManagementAPIDevicesOnly element is set to false, all SIP devices are +returned with their current Visual Device Management API flag value. + +**Attributes:** + +|Name |Type |Description | +|----------------------------------------------|--------------------------------------------|---------------------------------------------------| +|service_provider_id |str |serviceProviderId | +|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | +|sort_by_device_name |OCI.sortByDeviceName |sortByDeviceName *Optional* | +|sort_by_device_type |OCI.sortByDeviceType |sortByDeviceType *Optional* | +|sort_by_device_net_address |OCI.sortByDeviceNetAddress |sortByDeviceNetAddress *Optional* | +|sort_by_device_mac_address |OCI.sortByDeviceMACAddress |sortByDeviceMACAddress *Optional* | +|search_criteria_device_name |List[OCI.searchCriteriaDeviceName] |searchCriteriaDeviceName *Optional* | +|search_criteria_device_mac_address |List[OCI.searchCriteriaDeviceMACAddress] |searchCriteriaDeviceMACAddress *Optional* | +|search_criteria_device_net_address |List[OCI.searchCriteriaDeviceNetAddress] |searchCriteriaDeviceNetAddress *Optional* | +|search_criteria_exact_device_type |List[OCI.searchCriteriaExactDeviceType] |searchCriteriaExactDeviceType *Optional* | +|search_criteria_access_device_version |List[OCI.searchCriteriaAccessDeviceVersion] |searchCriteriaAccessDeviceVersion *Optional* | +|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | +|get_visual_device_management_api_devices_only |bool |getVisualDeviceManagementAPIDevicesOnly *Optional* | +
+ + ## `ServiceProviderAccessDeviceGetUserListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -69917,342 +67253,1560 @@ AS data mode: searchCriteriaAccessDeviceEndpointPrivateIdentity
-## `ServiceProviderAdminGetPagedSortedListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) +## `ServiceProviderBroadWorksMobilityMobileSubscriberDirectoryNumberGetSummaryListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Request a summary table of all Mobile Subscriber Directory Numbers in a service +provider. + +This command is applicable only for service providers and will fail for enterprises. + +The response is either +`ServiceProviderBroadWorksMobilityMobileSubscriberDirectoryNumberGetSummaryListResponse()` +or `ErrorResponse()`. + +**Attributes:** + +|Name |Type |Description | +|---------------------------------------------------|--------------------------------------------------------|---------------------------------------------------------| +|service_provider_id |str |serviceProviderId | +|response_size_limit |int |responseSizeLimit *Optional* | +|search_criteria_mobile_subscriber_directory_number |List[OCI.searchCriteriaMobileSubscriberDirectoryNumber] |searchCriteriaMobileSubscriberDirectoryNumber *Optional* | +|search_criteria_group_id |List[OCI.searchCriteriaGroupId] |searchCriteriaGroupId *Optional* | +|search_criteria_exact_mobile_network |OCI.searchCriteriaExactMobileNetwork |searchCriteriaExactMobileNetwork *Optional* | +
+ + +## `ServiceProviderCommunicationBarringDigitPatternCriteriaGetPatternListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Get an existing Digit Pattern Criteria. + +The response is either a +`ServiceProviderCommunicationBarringDigitPatternCriteriaGetPatternListResponse()` or +an `ErrorResponse()`. + +**Attributes:** + +|Name |Type |Description | +|------------------------------|-------------------------------------|--------------------------------------| +|service_provider_id |str |serviceProviderId | +|name |str |name | +|response_size_limit |int |responseSizeLimit *Optional* | +|search_criteria_digit_pattern |List[OCI.searchCriteriaDigitPattern] |searchCriteriaDigitPattern *Optional* | +
+ + +## `ServiceProviderCommunicationBarringProfileGetAssignedGroupListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Get a list of groups within a service provider that have a given Communication Barring +Profile assigned. + +The response is either a +`ServiceProviderCommunicationBarringProfileGetAssignedGroupListResponse()` or an +`ErorResponse()`. + +**Attributes:** + +|Name |Type |Description | +|---------------------------|----------------------------------|-----------------------------------| +|service_provider_id |str |serviceProviderId | +|profile |str |profile | +|response_size_limit |int |responseSizeLimit *Optional* | +|search_criteria_group_id |List[OCI.searchCriteriaGroupId] |searchCriteriaGroupId *Optional* | +|search_criteria_group_name |List[OCI.searchCriteriaGroupName] |searchCriteriaGroupName *Optional* | +
+ + +## `ServiceProviderCommunicationBarringProfileModifyRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Modify an existing Communication Barring Profile. + +The priorities for OriginatingRules, RedirectingRules, CallMeNowRules and +IncomingRules are requantized to consecutive integers as part of the modify. + +The response is either a `SuccessResponse()` or an `ErrorResponse()`. The following +elements are only used in AS data mode: callMeNowDefaultAction +callMeNowDefaultCallTimeout callMeNowRule applyToAttendedCallTransfers + +**Attributes:** + +|Name |Type |Description | +|------------------------------------|--------------------|--------------------------------------------| +|service_provider_id |str |serviceProviderId | +|name |str |name | +|new_name |str |newName *Optional* | +|description |str |description *Optional* | +|originating_default_action |str |originatingDefaultAction *Optional* | +|originating_default_treatment_id |str |originatingDefaultTreatmentId *Optional* | +|originating_default_transfer_number |str |originatingDefaultTransferNumber *Optional* | +|originating_default_call_timeout |int |originatingDefaultCallTimeout *Optional* | +|originating_rule |OCI.originatingRule |originatingRule *Optional* | +|redirecting_default_action |str |redirectingDefaultAction *Optional* | +|redirecting_default_call_timeout |int |redirectingDefaultCallTimeout *Optional* | +|redirecting_rule |OCI.redirectingRule |redirectingRule *Optional* | +|call_me_now_default_action |str |callMeNowDefaultAction *Optional* | +|call_me_now_default_call_timeout |int |callMeNowDefaultCallTimeout *Optional* | +|call_me_now_rule |OCI.callMeNowRule |callMeNowRule *Optional* | +|incoming_default_action |str |incomingDefaultAction *Optional* | +|incoming_default_call_timeout |int |incomingDefaultCallTimeout *Optional* | +|incoming_rule |OCI.incomingRule |incomingRule *Optional* | +|become_default |bool |becomeDefault *Optional* | +|apply_to_attended_call_transfers |bool |applyToAttendedCallTransfers *Optional* | +
+ + +## `ServiceProviderConsolidatedAddRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Add a service provider or enterprise. + +The response is either a `SuccessResponse()` or an `ErrorResponse()`. The following +elements are only used in AS data mode and ignored in XS data mode: +serviceProviderExtenalId The following elements are only used in Amplify data mode and +ignored in AS and XS data mode: servicePolicy, callProcessingSliceId, +provisioningSliceId, subscriberPartition. When the callProcessingSliceId or +provisioningSliceId is not specified in the AmplifyDataMode, the default slice Id is +assigned to the service provider. Only Provisioning admin and above can change the +callProcessingSliceId, provisioningSliceId, andsubscriberPartition. The following +elements are only used in Amplify and XS data mode and ignored in AS data mode: +preferredDataCenter. Only Provisioning admin and above can change the +preferredDataCenter. The following data elements are only used in AS data mode: +resellerId resellerName The following behavior is only applicable in CloudPBX: - when +new resellerId, that does not exist in the system, is specified, the new Reseller is +created the given resellerId and resellerName (if provided) and enterprise/Service +Provider is moved to the newly created Reseller. resellerName element is ignored if +the reseller the service provider is being moved to already exists. The following +elements are optional for the service provider. If the elements are included, they +will be either added, authorized, or modified on the service provider. Should any of +the following elements be rejected to due existing system settings, the service +provider will not be added and the response will be an `ErrorResponse()`: domain admin +groupServiceAuthorization userServiceAuthorization servicePack phoneNumber dnRange +routingProfile meetMeConferencingAllocatedPorts trunkGroupMaxActiveCalls +trunkGroupBurstingMaxActiveCalls voiceMessagingGroupSettings +voiceMessagingVoicePortalScope When a group or user service is included that is not +activated or is not licensed, the response will be an `ErrorResponse()`. + +**Attributes:** + +|Name |Type |Description | +|-----------------------------------------|-------------------------------------|-----------------------------------------------| +|is_enterprise |bool |isEnterprise *Optional* | +|use_custom_routing_profile |bool |useCustomRoutingProfile *Optional* | +|service_provider_id |str |serviceProviderId *Optional* | +|service_provider_external_id |str |serviceProviderExternalId *Optional* | +|default_domain |str |defaultDomain | +|service_provider_name |str |serviceProviderName *Optional* | +|support_email |str |supportEmail *Optional* | +|contact |OCI.contact |contact *Optional* | +|address |OCI.address |address *Optional* | +|service_policy |str |servicePolicy *Optional* | +|call_processing_slice_id |str |callProcessingSliceId *Optional* | +|provisioning_slice_id |str |provisioningSliceId *Optional* | +|subscriber_partition |str |subscriberPartition *Optional* | +|preferred_data_center |str |preferredDataCenter *Optional* | +|reseller_id |str |resellerId *Optional* | +|reseller_name |str |resellerName *Optional* | +|domain |List[str] |domain *Optional* | +|admin |List[OCI.admin] |admin *Optional* | +|group_service_authorization |List[OCI.groupServiceAuthorization] |groupServiceAuthorization *Optional* | +|user_service_authorization |List[OCI.userServiceAuthorization] |userServiceAuthorization *Optional* | +|service_pack |List[OCI.servicePack] |servicePack *Optional* | +|phone_number |List[str] |phoneNumber *Optional* | +|dn_range |List[OCI.dnRange] |dnRange *Optional* | +|routing_profile |str |routingProfile *Optional* | +|meet_me_conferencing_allocated_ports |OCI.meetMeConferencingAllocatedPorts |meetMeConferencingAllocatedPorts *Optional* | +|trunk_group_max_active_calls |OCI.trunkGroupMaxActiveCalls |trunkGroupMaxActiveCalls *Optional* | +|trunk_group_bursting_max_active_calls |OCI.trunkGroupBurstingMaxActiveCalls |trunkGroupBurstingMaxActiveCalls *Optional* | +|voice_messaging_group_settings |OCI.voiceMessagingGroupSettings |voiceMessagingGroupSettings *Optional* | +|voice_messaging_group_voice_portal_scope |str |voiceMessagingGroupVoicePortalScope *Optional* | +
+ + +## `ServiceProviderDeviceManagementEventGetListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Request device management's events for a specific queue. + +It is possible to restrict the number of rows returned using responseSizeLimit. If +eventQueueType is not specified, the events from all the event queues are returned. + +The response is either a `ServiceProviderDeviceManagementEventGetListResponse()` or an +`ErrorResponse()`. Deprecated by: +`ServiceProviderDeviceManagementEventGetListRequest22()`. + +**Attributes:** + +|Name |Type |Description | +|----------------------------------------------------------------------------|----------------------------------------------------------------------|-----------------------------------------------------------------------------| +|service_provider_id |str |serviceProviderId | +|event_queue_type |str |eventQueueType *Optional* | +|response_size_limit |int |responseSizeLimit *Optional* | +|search_criteria_exact_device_management_event_status_in_progress_or_pending |OCI.searchCriteriaExactDeviceManagementEventStatusInProgressOrPending |searchCriteriaExactDeviceManagementEventStatusInProgressOrPending *Optional* | +|search_criteria_exact_device_management_event_status_completed |OCI.searchCriteriaExactDeviceManagementEventStatusCompleted |searchCriteriaExactDeviceManagementEventStatusCompleted *Optional* | +|search_criteria_exact_device_management_event_action |OCI.searchCriteriaExactDeviceManagementEventAction |searchCriteriaExactDeviceManagementEventAction *Optional* | +|search_criteria_exact_device_management_event_level |OCI.searchCriteriaExactDeviceManagementEventLevel |searchCriteriaExactDeviceManagementEventLevel *Optional* | +|search_criteria_exact_device_management_event_type |OCI.searchCriteriaExactDeviceManagementEventType |searchCriteriaExactDeviceManagementEventType *Optional* | +|search_criteria_device_management_event_additional_info |List[OCI.searchCriteriaDeviceManagementEventAdditionalInfo] |searchCriteriaDeviceManagementEventAdditionalInfo *Optional* | +|search_criteria_device_management_event_login_id |List[OCI.searchCriteriaDeviceManagementEventLoginId] |searchCriteriaDeviceManagementEventLoginId *Optional* | +
+ + +## `ServiceProviderDeviceManagementEventGetListRequest22`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Request device management's events for a specific queue. + +It is possible to restrict the number of rows returned using responseSizeLimit. If +eventQueueType is not specified, the events from all the event queues are returned. + +The response is either a `ServiceProviderDeviceManagementEventGetListResponse22()` or +an `ErrorResponse()`. + +**Attributes:** + +|Name |Type |Description | +|----------------------------------------------------------------------------|----------------------------------------------------------------------|-----------------------------------------------------------------------------| +|service_provider_id |str |serviceProviderId | +|event_queue_type |str |eventQueueType *Optional* | +|response_size_limit |int |responseSizeLimit *Optional* | +|search_criteria_exact_device_management_event_status_in_progress_or_pending |OCI.searchCriteriaExactDeviceManagementEventStatusInProgressOrPending |searchCriteriaExactDeviceManagementEventStatusInProgressOrPending *Optional* | +|search_criteria_exact_device_management_event_status_completed |OCI.searchCriteriaExactDeviceManagementEventStatusCompleted |searchCriteriaExactDeviceManagementEventStatusCompleted *Optional* | +|search_criteria_exact_device_management_event_action |OCI.searchCriteriaExactDeviceManagementEventAction |searchCriteriaExactDeviceManagementEventAction *Optional* | +|search_criteria_exact_device_management_event_level |OCI.searchCriteriaExactDeviceManagementEventLevel |searchCriteriaExactDeviceManagementEventLevel *Optional* | +|search_criteria_exact_device_management_event_type |OCI.searchCriteriaExactDeviceManagementEventType |searchCriteriaExactDeviceManagementEventType *Optional* | +|search_criteria_device_management_event_additional_info |List[OCI.searchCriteriaDeviceManagementEventAdditionalInfo] |searchCriteriaDeviceManagementEventAdditionalInfo *Optional* | +|search_criteria_device_management_event_login_id |List[OCI.searchCriteriaDeviceManagementEventLoginId] |searchCriteriaDeviceManagementEventLoginId *Optional* | +
+ + +## `ServiceProviderDnGetSummaryListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Request a summary table of all DNs in a service provider. + +Dns assigned to the IMRN pool are not listed in the response. The search can be done +using multiple criteria. Only results matching all the search criteria are included +in the results. + +The response is either `ServiceProviderDnGetSummaryListResponse()` or +`ErrorResponse()`. The following elements are only used in XS data mode and ignored in +AS data mode: searchCriteriaDn, searchCriteriaGroupId + +**Attributes:** + +|Name |Type |Description | +|-------------------------|--------------------------------|---------------------------------| +|service_provider_id |str |serviceProviderId | +|search_criteria_group_id |List[OCI.searchCriteriaGroupId] |searchCriteriaGroupId *Optional* | +|search_criteria_dn |List[OCI.searchCriteriaDn] |searchCriteriaDn *Optional* | +
+ + +## `ServiceProviderDomainGetAssignedGroupListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Requests a list of groups within a service provider that have a given domain assigned. + +It is possible to search by various criteria to restrict the number of rows returned. +Multiple search criteria are logically ANDed together. + +The response is either a `ServiceProviderDomainGetAssignedGroupListResponse()` or an +`ErrorResponse()`. + +**Attributes:** + +|Name |Type |Description | +|---------------------------|----------------------------------|-----------------------------------| +|service_provider_id |str |serviceProviderId | +|domain |str |domain | +|response_size_limit |int |responseSizeLimit *Optional* | +|search_criteria_group_id |List[OCI.searchCriteriaGroupId] |searchCriteriaGroupId *Optional* | +|search_criteria_group_name |List[OCI.searchCriteriaGroupName] |searchCriteriaGroupName *Optional* | +
+ + +## `ServiceProviderDomainGetAssignedListRequest22`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Requests the list of all matching domains assigned to a service provider . + +The response is either `ServiceProviderDomainGetAssignedListResponse22()` or +`ErrorResponse()`. The following elements are only used in AS data mode and will be +ignored in XS data mode: responseSizeLimit searchCriteriaDomainName +searchCriteriaExactDomainLevel + +**Attributes:** + +|Name |Type |Description | +|-----------------------------------|-----------------------------------|------------------------------------------| +|service_provider_id |str |serviceProviderId | +|response_size_limit |int |responseSizeLimit *Optional* | +|search_criteria_domain_name |List[OCI.searchCriteriaDomainName] |searchCriteriaDomainName *Optional* | +|search_criteria_exact_domain_level |OCI.searchCriteriaExactDomainLevel |searchCriteriaExactDomainLevel *Optional* | +
+ + +## `ServiceProviderEndpointGetListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Request to search endpoints in the service provider/enterprise. + +The response is either `ServiceProviderEndpointGetListResponse()` or +`ErrorResponse()`. + +**Attributes:** + +|Name |Type |Description | +|--------------------------------------|-----------------------------------------|---------------------------------------------| +|service_provider_id |str |serviceProviderId | +|response_size_limit |int |responseSizeLimit *Optional* | +|search_criteria_group_id |List[OCI.searchCriteriaGroupId] |searchCriteriaGroupId *Optional* | +|search_criteria_line_port_user_part |List[OCI.searchCriteriaLinePortUserPart] |searchCriteriaLinePortUserPart *Optional* | +|search_criteria_line_port_domain |List[OCI.searchCriteriaLinePortDomain] |searchCriteriaLinePortDomain *Optional* | +|search_criteria_user_last_name |List[OCI.searchCriteriaUserLastName] |searchCriteriaUserLastName *Optional* | +|search_criteria_user_first_name |List[OCI.searchCriteriaUserFirstName] |searchCriteriaUserFirstName *Optional* | +|search_criteria_user_id |List[OCI.searchCriteriaUserId] |searchCriteriaUserId *Optional* | +|search_criteria_dn |List[OCI.searchCriteriaDn] |searchCriteriaDn *Optional* | +|search_criteria_extension |List[OCI.searchCriteriaExtension] |searchCriteriaExtension *Optional* | +|search_criteria_device_type |List[OCI.searchCriteriaDeviceType] |searchCriteriaDeviceType *Optional* | +|search_criteria_device_name |List[OCI.searchCriteriaDeviceName] |searchCriteriaDeviceName *Optional* | +|search_criteria_device_mac_address |List[OCI.searchCriteriaDeviceMACAddress] |searchCriteriaDeviceMACAddress *Optional* | +|search_criteria_device_net_address |List[OCI.searchCriteriaDeviceNetAddress] |searchCriteriaDeviceNetAddress *Optional* | +|search_criteria_exact_user_department |OCI.searchCriteriaExactUserDepartment |searchCriteriaExactUserDepartment *Optional* | +
+ + +## `ServiceProviderGetListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Request a list of service providers and/or enterprises in the system. + +It is possible to search by various criteria to restrict the number of rows returned. +Multiple search criteria are logically ANDed together. If reseller administrator +sends the request, searchCriteriaResellerId is ignored. Service providers/enterprise +within the administrator's reseller meeting the search criteria are returned. + +The response is either a `ServiceProviderGetListResponse()` or an `ErrorResponse()`. +The following data elements are only used in AS data mode: searchCriteriaResellerId + +**Attributes:** + +|Name |Type |Description | +|--------------------------------------|--------------------------------------------|---------------------------------------------| +|is_enterprise |bool |isEnterprise *Optional* | +|response_size_limit |int |responseSizeLimit *Optional* | +|search_criteria_service_provider_id |List[OCI.searchCriteriaServiceProviderId] |searchCriteriaServiceProviderId *Optional* | +|search_criteria_service_provider_name |List[OCI.searchCriteriaServiceProviderName] |searchCriteriaServiceProviderName *Optional* | +|search_criteria_reseller_id |List[OCI.searchCriteriaResellerId] |searchCriteriaResellerId *Optional* | +
+ + +## `ServiceProviderMWIDeliveryToMobileEndpointCustomTemplateAddRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Create a MWI Delivery to Mobile Endpoint Custom Template. + +The response is either a `SuccessResponse()` or an `ErrorResponse()`. + +**Attributes:** + +|Name |Type |Description | +|--------------------|-----------------|------------------| +|service_provider_id |str |serviceProviderId | +|language |str |language | +|type |str |type | +|is_enabled |bool |isEnabled | +|template_body |OCI.templateBody |templateBody | +
+ + +## `ServiceProviderMWIDeliveryToMobileEndpointCustomTemplateModifyRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Modify a MWI Delivery to Mobile Endpoint Custom Template. + +The response is either a `SuccessResponse()` or an `ErrorResponse()`. + +**Attributes:** + +|Name |Type |Description | +|--------------------|-----------------|------------------------| +|service_provider_id |str |serviceProviderId | +|language |str |language | +|type |str |type | +|is_enabled |bool |isEnabled *Optional* | +|template_body |OCI.templateBody |templateBody *Optional* | +
+ + +## `ServiceProviderNetworkClassOfServiceGetAssignedGroupListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Get a list of groups within a service provider that have a given Network Class of +Service assigned. + +The response is either a +`ServiceProviderNetworkClassOfServiceGetAssignedGroupListResponse()` or an +`ErorResponse()`. + +**Attributes:** + +|Name |Type |Description | +|---------------------------|----------------------------------|-----------------------------------| +|service_provider_id |str |serviceProviderId | +|network_class_of_service |str |networkClassOfService | +|response_size_limit |int |responseSizeLimit *Optional* | +|search_criteria_group_id |List[OCI.searchCriteriaGroupId] |searchCriteriaGroupId *Optional* | +|search_criteria_group_name |List[OCI.searchCriteriaGroupName] |searchCriteriaGroupName *Optional* | +
+ + +## `ServiceProviderNumberPortabilityQueryGetRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Request to get the Service Provider Number Portability Query Digit Pattern Trigger +List information. + +The response is either a `ServiceProviderNumberPortabilityQueryGetResponse()` or an +`ErrorResponse()`. + +**Attributes:** + +|Name |Type |Description | +|------------------------------------------------------------------------|--------------------------------------------------------------------------|---------------------------------------------------------------------------| +|service_provider_id |str |serviceProviderId | +|include_digit_patterns |bool |includeDigitPatterns | +|search_criteria_service_provider_number_portability_query_digit_pattern |List[OCI.searchCriteriaServiceProviderNumberPortabilityQueryDigitPattern] |searchCriteriaServiceProviderNumberPortabilityQueryDigitPattern *Optional* | +|response_size_limit |int |responseSizeLimit *Optional* | +
+ + +## `ServiceProviderOfficeZoneGetAssignedGroupListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Get a list of groups within a service provider that have a given Office Zone assigned. + +The response is either a `ServiceProviderOfficeZoneGetAssignedGroupListResponse()` or +an `ErrorResponse()`. + +**Attributes:** + +|Name |Type |Description | +|---------------------------|----------------------------------|-----------------------------------| +|service_provider_id |str |serviceProviderId | +|office_zone_name |str |officeZoneName | +|response_size_limit |int |responseSizeLimit *Optional* | +|search_criteria_group_id |List[OCI.searchCriteriaGroupId] |searchCriteriaGroupId *Optional* | +|search_criteria_group_name |List[OCI.searchCriteriaGroupName] |searchCriteriaGroupName *Optional* | +
+ + +## `ServiceProviderRouteListEnterpriseTrunkNumberPrefixAddListRequest22`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Add number prefixes to a service provider. + +The response is either `SuccessResponse()` or `ErrorResponse()`. + +**Attributes:** + +|Name |Type |Description | +|--------------------|-----------------|------------------| +|service_provider_id |str |serviceProviderId | +|prefix |List[OCI.prefix] |prefix | +
+ + +## `ServiceProviderRouteListEnterpriseTrunkNumberPrefixModifyListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Modify a list of number prefixes in a service provider. + +The response is either `SuccessResponse()` or `ErrorResponse()`. + +**Attributes:** + +|Name |Type |Description | +|--------------------|-----------------------|------------------------| +|service_provider_id |str |serviceProviderId | +|number_prefix |List[OCI.numberPrefix] |numberPrefix *Optional* | +
+ + +## `ServiceProviderRouteListEnterpriseTrunkNumberRangeAddListRequest22`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Add number ranges to a service provider. + +The response is either `SuccessResponse()` or `ErrorResponse()`. + +**Attributes:** + +|Name |Type |Description | +|--------------------|----------------------|------------------| +|service_provider_id |str |serviceProviderId | +|number_range |List[OCI.numberRange] |numberRange | +
+ + +## `ServiceProviderRoutePointExternalSystemGetAssignedGroupListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Requests a list of groups within a service provider that have a given external system +assigned. + +It is possible to search by various criteria to restrict the number of rows returned. +Multiple search criteria are logically ANDed together. + +The response is either a +`ServiceProviderRoutePointExternalSystemGetAssignedGroupListResponse()` or an +`ErrorResponse()`. + +**Attributes:** + +|Name |Type |Description | +|---------------------------|----------------------------------|-----------------------------------| +|service_provider_id |str |serviceProviderId | +|external_system |str |externalSystem | +|response_size_limit |int |responseSizeLimit *Optional* | +|search_criteria_group_id |List[OCI.searchCriteriaGroupId] |searchCriteriaGroupId *Optional* | +|search_criteria_group_name |List[OCI.searchCriteriaGroupName] |searchCriteriaGroupName *Optional* | +
+ + +## `ServiceProviderServiceModifyAuthorizationListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Requests to change the service provider's service authorization status. + +The boolean flags are used to authorize or unauthorize services. + +The response is either `SuccessResponse()` or `ErrorResponse()`. + +**Attributes:** + +|Name |Type |Description | +|----------------------------|------------------------------------|-------------------------------------| +|service_provider_id |str |serviceProviderId | +|group_service_authorization |List[OCI.groupServiceAuthorization] |groupServiceAuthorization *Optional* | +|user_service_authorization |List[OCI.userServiceAuthorization] |userServiceAuthorization *Optional* | +
+ + +## `ServiceProviderServicePackMigrationTaskGetAvailableGroupListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Requests a list of groups to migrate. + +The response is either +`ServiceProviderServicePackMigrationTaskGetAvailabeGroupListResponse()` or +`ErrorResponse()`. + +**Attributes:** + +|Name |Type |Description | +|---------------------------|----------------------------------|-----------------------------------| +|service_provider_id |str |serviceProviderId | +|response_size_limit |int |responseSizeLimit *Optional* | +|search_criteria_group_id |List[OCI.searchCriteriaGroupId] |searchCriteriaGroupId *Optional* | +|search_criteria_group_name |List[OCI.searchCriteriaGroupName] |searchCriteriaGroupName *Optional* | +
+ + +## `ServiceProviderXsiPolicyProfileGetAssignedGroupListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Get a list of group within a service provider that have a given group Xsi policy +profile assigned. + +The response is either a +`ServiceProviderXsiPolicyProfileGetAssignedGroupListResponse()` or an +`ErrorResponse()`. + +**Attributes:** + +|Name |Type |Description | +|---------------------------|----------------------------------|-----------------------------------| +|service_provider_id |str |serviceProviderId | +|xsi_policy_profile |OCI.xsiPolicyProfile |xsiPolicyProfile | +|response_size_limit |int |responseSizeLimit *Optional* | +|search_criteria_group_id |List[OCI.searchCriteriaGroupId] |searchCriteriaGroupId *Optional* | +|search_criteria_group_name |List[OCI.searchCriteriaGroupName] |searchCriteriaGroupName *Optional* | +
+ + +## `SystemAccessDeviceGetAllRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Requests the list of all access devices in the entire system. + +Prior to release 14, this functionality was provided with the +`SystemAccessDeviceGetListRequest14()`. If reseller administrator sends the request, +searchCriteriaResellerId is ignored. All the device profiles in the administrator's +reseller meeting the search criteria are returned. + +The response is either `SystemAccessDeviceGetAllResponse()` or `ErrorResponse()`. The +following data elements are only used in AS data mode: searchCriteriaResellerId + +**Attributes:** + +|Name |Type |Description | +|----------------------------------------------|---------------------------------------------|----------------------------------------------------| +|response_size_limit |int |responseSizeLimit *Optional* | +|search_criteria_device_name |List[OCI.searchCriteriaDeviceName] |searchCriteriaDeviceName *Optional* | +|search_criteria_device_mac_address |List[OCI.searchCriteriaDeviceMACAddress] |searchCriteriaDeviceMACAddress *Optional* | +|search_criteria_device_net_address |List[OCI.searchCriteriaDeviceNetAddress] |searchCriteriaDeviceNetAddress *Optional* | +|search_criteria_group_id |List[OCI.searchCriteriaGroupId] |searchCriteriaGroupId *Optional* | +|search_criteria_exact_device_type |OCI.searchCriteriaExactDeviceType |searchCriteriaExactDeviceType *Optional* | +|search_criteria_exact_device_service_provider |OCI.searchCriteriaExactDeviceServiceProvider |searchCriteriaExactDeviceServiceProvider *Optional* | +|search_criteria_service_provider_id |List[OCI.searchCriteriaServiceProviderId] |searchCriteriaServiceProviderId *Optional* | +|search_criteria_reseller_id |List[OCI.searchCriteriaResellerId] |searchCriteriaResellerId *Optional* | +
+ + +## `SystemAccessDeviceGetListRequest14`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Requests the list of access devices defined at the System-level. + +Prior to release 14, this command requested a list of all devices in the entire +system. That functionality is now moved to the `SystemAccessDeviceGetAllRequest()`. + +The response is either `SystemAccessDeviceGetListResponse14()` or `ErrorResponse()`. + +**Attributes:** + +|Name |Type |Description | +|--------------------------------------|--------------------------------------------|---------------------------------------------| +|response_size_limit |int |responseSizeLimit *Optional* | +|search_criteria_device_name |List[OCI.searchCriteriaDeviceName] |searchCriteriaDeviceName *Optional* | +|search_criteria_device_mac_address |List[OCI.searchCriteriaDeviceMACAddress] |searchCriteriaDeviceMACAddress *Optional* | +|search_criteria_device_net_address |List[OCI.searchCriteriaDeviceNetAddress] |searchCriteriaDeviceNetAddress *Optional* | +|search_criteria_exact_device_type |OCI.searchCriteriaExactDeviceType |searchCriteriaExactDeviceType *Optional* | +|search_criteria_access_device_version |List[OCI.searchCriteriaAccessDeviceVersion] |searchCriteriaAccessDeviceVersion *Optional* | +
+ + +## `SystemAccessDeviceGetPagedSortedListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Requests the list of system-level access devices. + +The response is either `SystemAccessDeviceGetPagedSortedListResponse()` or +`ErrorResponse()`. If no sortOrder is included, the response is sorted by Device Name +ascending by default. If the responsePagingControl element is not provided, the +paging startIndex will be set to 1 by default, and the responsePageSize will be set to +the maximum responsePageSize by default. Multiple search criteria are logically ANDed +together unless the searchCriteriaModeOr option is included. Then the search criteria +are logically ORed together. The getVisualDeviceManagementAPIDevicesOnly element can +only be set when CloudPBX is licenced. If the getVisualDeviceManagementAPIDevicesOnly +element is not set, all devices are returned with Visual Device Management API flag +set to empty. If the getVisualDeviceManagementAPIDevicesOnly element is set to true, +only SIP devices supporting Visual Device Management API are returned. If the +getVisualDeviceManagementAPIDevicesOnly element is set to false, all SIP devices are +returned with their current Visual Device Management API flag value. + +**Attributes:** + +|Name |Type |Description | +|----------------------------------------------|--------------------------------------------|---------------------------------------------------| +|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | +|sort_by_device_name |OCI.sortByDeviceName |sortByDeviceName *Optional* | +|sort_by_device_type |OCI.sortByDeviceType |sortByDeviceType *Optional* | +|sort_by_device_net_address |OCI.sortByDeviceNetAddress |sortByDeviceNetAddress *Optional* | +|sort_by_device_mac_address |OCI.sortByDeviceMACAddress |sortByDeviceMACAddress *Optional* | +|search_criteria_device_name |List[OCI.searchCriteriaDeviceName] |searchCriteriaDeviceName *Optional* | +|search_criteria_device_mac_address |List[OCI.searchCriteriaDeviceMACAddress] |searchCriteriaDeviceMACAddress *Optional* | +|search_criteria_device_net_address |List[OCI.searchCriteriaDeviceNetAddress] |searchCriteriaDeviceNetAddress *Optional* | +|search_criteria_exact_device_type |List[OCI.searchCriteriaExactDeviceType] |searchCriteriaExactDeviceType *Optional* | +|search_criteria_access_device_version |List[OCI.searchCriteriaAccessDeviceVersion] |searchCriteriaAccessDeviceVersion *Optional* | +|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | +|get_visual_device_management_api_devices_only |bool |getVisualDeviceManagementAPIDevicesOnly *Optional* | +
+ + +## `SystemAccessDeviceGetUserListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Requests the users associated with a specified system access device. + +The response is either `SystemAccessDeviceGetUserListResponse()` or `ErrorResponse()`. +The following elements are only used in XS data mode and ignored in AS data mode: +searchCriteriaAccessDeviceEndpointPrivateIdentity Replaced by: +`SystemAccessDeviceGetUserListRequest21sp1()` in AS data mode. + +**Attributes:** + +|Name |Type |Description | +|--------------------------------------------------------|------------------------------------------------------------|-------------------------------------------------------------| +|device_name |str |deviceName | +|response_size_limit |int |responseSizeLimit *Optional* | +|search_criteria_line_port_user_part |List[OCI.searchCriteriaLinePortUserPart] |searchCriteriaLinePortUserPart *Optional* | +|search_criteria_line_port_domain |List[OCI.searchCriteriaLinePortDomain] |searchCriteriaLinePortDomain *Optional* | +|search_criteria_user_last_name |List[OCI.searchCriteriaUserLastName] |searchCriteriaUserLastName *Optional* | +|search_criteria_user_first_name |List[OCI.searchCriteriaUserFirstName] |searchCriteriaUserFirstName *Optional* | +|search_criteria_dn |List[OCI.searchCriteriaDn] |searchCriteriaDn *Optional* | +|search_criteria_user_id |List[OCI.searchCriteriaUserId] |searchCriteriaUserId *Optional* | +|search_criteria_group_id |List[OCI.searchCriteriaGroupId] |searchCriteriaGroupId *Optional* | +|search_criteria_exact_service_provider |OCI.searchCriteriaExactServiceProvider |searchCriteriaExactServiceProvider *Optional* | +|search_criteria_service_provider_id |List[OCI.searchCriteriaServiceProviderId] |searchCriteriaServiceProviderId *Optional* | +|search_criteria_exact_endpoint_type |OCI.searchCriteriaExactEndpointType |searchCriteriaExactEndpointType *Optional* | +|search_criteria_exact_user_type |OCI.searchCriteriaExactUserType |searchCriteriaExactUserType *Optional* | +|search_criteria_extension |List[OCI.searchCriteriaExtension] |searchCriteriaExtension *Optional* | +|search_criteria_exact_port_number |OCI.searchCriteriaExactPortNumber |searchCriteriaExactPortNumber *Optional* | +|search_criteria_access_device_endpoint_private_identity |List[OCI.searchCriteriaAccessDeviceEndpointPrivateIdentity] |searchCriteriaAccessDeviceEndpointPrivateIdentity *Optional* | +
+ + +## `SystemAccessDeviceGetUserListRequest21sp1`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Requests the users associated with a specified system access device. + +The response is either `SystemAccessDeviceGetUserListResponse21sp1()` or +`ErrorResponse()`. The following elements are only used in XS data mode and ignored in +AS data mode: searchCriteriaAccessDeviceEndpointPrivateIdentity + +**Attributes:** + +|Name |Type |Description | +|--------------------------------------------------------|------------------------------------------------------------|-------------------------------------------------------------| +|device_name |str |deviceName | +|response_size_limit |int |responseSizeLimit *Optional* | +|search_criteria_line_port_user_part |List[OCI.searchCriteriaLinePortUserPart] |searchCriteriaLinePortUserPart *Optional* | +|search_criteria_line_port_domain |List[OCI.searchCriteriaLinePortDomain] |searchCriteriaLinePortDomain *Optional* | +|search_criteria_user_last_name |List[OCI.searchCriteriaUserLastName] |searchCriteriaUserLastName *Optional* | +|search_criteria_user_first_name |List[OCI.searchCriteriaUserFirstName] |searchCriteriaUserFirstName *Optional* | +|search_criteria_dn |List[OCI.searchCriteriaDn] |searchCriteriaDn *Optional* | +|search_criteria_user_id |List[OCI.searchCriteriaUserId] |searchCriteriaUserId *Optional* | +|search_criteria_group_id |List[OCI.searchCriteriaGroupId] |searchCriteriaGroupId *Optional* | +|search_criteria_exact_service_provider |OCI.searchCriteriaExactServiceProvider |searchCriteriaExactServiceProvider *Optional* | +|search_criteria_service_provider_id |List[OCI.searchCriteriaServiceProviderId] |searchCriteriaServiceProviderId *Optional* | +|search_criteria_exact_endpoint_type |OCI.searchCriteriaExactEndpointType |searchCriteriaExactEndpointType *Optional* | +|search_criteria_exact_user_type |OCI.searchCriteriaExactUserType |searchCriteriaExactUserType *Optional* | +|search_criteria_extension |List[OCI.searchCriteriaExtension] |searchCriteriaExtension *Optional* | +|search_criteria_exact_port_number |OCI.searchCriteriaExactPortNumber |searchCriteriaExactPortNumber *Optional* | +|search_criteria_access_device_endpoint_private_identity |List[OCI.searchCriteriaAccessDeviceEndpointPrivateIdentity] |searchCriteriaAccessDeviceEndpointPrivateIdentity *Optional* | +|search_criteria_user_hotline_contact |List[OCI.searchCriteriaUserHotlineContact] |searchCriteriaUserHotlineContact *Optional* | +
+ + +## `SystemAlternateUserIdGetListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Request to get the list of alternate user ids. + +If reseller administrator sends the request, searchCriteriaResellerId is ignored. All +the alternate user ids in the administrator's reseller meeting the search criteria are +returned. + +The response is either `SystemAlternateUserIdGetListResponse()` or `ErrorResponse()`. +The following data elements are only used in AS data mode: searchCriteriaResellerId + +**Attributes:** + +|Name |Type |Description | +|------------------------------------|------------------------------------------|-------------------------------------------| +|response_size_limit |int |responseSizeLimit *Optional* | +|search_criteria_alternate_user_id |List[OCI.searchCriteriaAlternateUserId] |searchCriteriaAlternateUserId *Optional* | +|search_criteria_user_id |List[OCI.searchCriteriaUserId] |searchCriteriaUserId *Optional* | +|search_criteria_group_id |List[OCI.searchCriteriaGroupId] |searchCriteriaGroupId *Optional* | +|search_criteria_service_provider_id |List[OCI.searchCriteriaServiceProviderId] |searchCriteriaServiceProviderId *Optional* | +|search_criteria_reseller_id |List[OCI.searchCriteriaResellerId] |searchCriteriaResellerId *Optional* | +
+ + +## `SystemBroadWorksMobilityGeographicalPoolIMRNGetListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Get a list of BroadWorks Mobility IMRN numbers from a geographical pool. + +The response is either a +`SystemBroadWorksMobilityGeographicalPoolIMRNGetListResponse()` or an +`ErrorResponse()`. + +**Attributes:** + +|Name |Type |Description | +|-----------------------|-----------------------------|------------------------------| +|geographical_pool_name |str |geographicalPoolName | +|search_criteria_imrn |List[OCI.searchCriteriaIMRN] |searchCriteriaIMRN *Optional* | +
+ + +## `SystemBroadWorksMobilityGetIMRNListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Request to get the list of BroadWorks Mobility IMRN numbers defined in the system. + +The response is either a `SystemBroadWorksMobilityGetIMRNListResponse()` or an +`ErrorResponse()`. + +**Attributes:** + +|Name |Type |Description | +|---------------------|-----------------------------|------------------------------| +|search_criteria_imrn |List[OCI.searchCriteriaIMRN] |searchCriteriaIMRN *Optional* | +
+ + +## `SystemBroadWorksMobilityGetMobileNetworkIMRNListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
-Get a list of service provider administrators. +Get a list of BroadWorks Mobility IMRN numbers from a Mobile Network. -The response is either a `ServiceProviderAdminGetPagedSortedListResponse()` or an -`ErrorResponse()`. If no sortOrder is included, the response is sorted by -Administrator ID ascending by default. If the responsePagingControl element is not -provided, the paging startIndex will be set to 1 by default, and the responsePageSize -will be set to the maximum responsePageSize by default. Multiple search criteria are -logically ANDed together unless the searchCriteriaModeOr option is included. Then the -search criteria are logically ORed together. +The response is either a `SystemBroadWorksMobilityGetMobileNetworkIMRNListResponse()` +or an `ErrorResponse()`. **Attributes:** -|Name |Type |Description | -|--------------------------------------------------|------------------------------------------------------|-------------------------------------------------------| -|service_provider_id |str |serviceProviderId | -|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | -|sort_order |List[OCI.sortOrder] |sortOrder *Optional* | -|search_criteria_admin_id |List[OCI.searchCriteriaAdminId] |searchCriteriaAdminId *Optional* | -|search_criteria_admin_last_name |List[OCI.searchCriteriaAdminLastName] |searchCriteriaAdminLastName *Optional* | -|search_criteria_admin_first_name |List[OCI.searchCriteriaAdminFirstName] |searchCriteriaAdminFirstName *Optional* | -|search_criteria_exact_service_provider_admin_type |List[OCI.searchCriteriaExactServiceProviderAdminType] |searchCriteriaExactServiceProviderAdminType *Optional* | -|search_criteria_language |List[OCI.searchCriteriaLanguage] |searchCriteriaLanguage *Optional* | -|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | +|Name |Type |Description | +|---------------------|-----------------------------|------------------------------| +|mobile_network_name |str |mobileNetworkName | +|search_criteria_imrn |List[OCI.searchCriteriaIMRN] |searchCriteriaIMRN *Optional* | +
+ + +## `SystemBroadWorksMobilityMobileSubscriberDirectoryNumberGetSummaryListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Request a summary table of all Mobile Subscriber Directory Numbers in a system. + +If reseller administrator sends the request, searchCriteriaResellerId is ignored. All +the mobile subscriber directory numbers in the administrator's reseller meeting the +search criteria are returned. + +The response is either +`SystemBroadWorksMobilityMobileSubscriberDirectoryNumberGetSummaryListResponse()` or +`ErrorResponse()`. The following data elements are only used in AS data mode: +searchCriteriaResellerId + +**Attributes:** + +|Name |Type |Description | +|---------------------------------------------------|--------------------------------------------------------|---------------------------------------------------------| +|response_size_limit |int |responseSizeLimit *Optional* | +|search_criteria_mobile_subscriber_directory_number |List[OCI.searchCriteriaMobileSubscriberDirectoryNumber] |searchCriteriaMobileSubscriberDirectoryNumber *Optional* | +|search_criteria_exact_mobile_network |OCI.searchCriteriaExactMobileNetwork |searchCriteriaExactMobileNetwork *Optional* | +|search_criteria_service_provider_id |List[OCI.searchCriteriaServiceProviderId] |searchCriteriaServiceProviderId *Optional* | +|search_criteria_exact_organization_type |OCI.searchCriteriaExactOrganizationType |searchCriteriaExactOrganizationType *Optional* | +|search_criteria_group_id |List[OCI.searchCriteriaGroupId] |searchCriteriaGroupId *Optional* | +|search_criteria_user_id |List[OCI.searchCriteriaUserId] |searchCriteriaUserId *Optional* | +|search_criteria_user_last_name |List[OCI.searchCriteriaUserLastName] |searchCriteriaUserLastName *Optional* | +|search_criteria_user_first_name |List[OCI.searchCriteriaUserFirstName] |searchCriteriaUserFirstName *Optional* | +|search_criteria_dn |List[OCI.searchCriteriaDn] |searchCriteriaDn *Optional* | +|search_criteria_extension |List[OCI.searchCriteriaExtension] |searchCriteriaExtension *Optional* | +|search_criteria_reseller_id |List[OCI.searchCriteriaResellerId] |searchCriteriaResellerId *Optional* | +
+ + +## `SystemCallCenterEnhancedReportingScheduledReportGetActiveListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Request to get the list of all active call center reporting scheduled reports in the +system. + +The response is either a +`SystemCallCenterEnhancedReportingScheduledReportGetActiveListResponse()` or an +`ErrorResponse()`. + +**Attributes:** + +|Name |Type |Description | +|-------------------------------------------------------------------------|--------------------------------------------------------------------|---------------------------------------------------------------------------| +|response_size_limit |int |responseSizeLimit *Optional* | +|search_criteria_call_center_scheduled_report_name |List[OCI.searchCriteriaCallCenterScheduledReportName] |searchCriteriaCallCenterScheduledReportName *Optional* | +|search_criteria_group_id |List[OCI.searchCriteriaGroupId] |searchCriteriaGroupId *Optional* | +|search_criteria_exact_call_center_scheduled_report_service_provider |OCI.searchCriteriaExactCallCenterScheduledReportServiceProvider |searchCriteriaExactCallCenterScheduledReportServiceProvider *Optional* | +|search_criteria_service_provider_id |List[OCI.searchCriteriaServiceProviderId] |searchCriteriaServiceProviderId *Optional* | +|search_criteria_exact_call_center_scheduled_report_created_by_supervisor |OCI.searchCriteriaExactCallCenterScheduledReportCreatedBySupervisor |searchCriteriaExactCallCenterScheduledReportCreatedBySupervisor *Optional* | +|search_criteria_call_center_report_template_name |List[OCI.searchCriteriaCallCenterReportTemplateName] |searchCriteriaCallCenterReportTemplateName *Optional* | +
+ + +## `SystemCallCenterEnhancedReportingScheduledReportGetCompletedListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Request to get the list of all completed call center reporting scheduled reports in +the system. + +The response is either a +`SystemCallCenterEnhancedReportingScheduledReportGetCompletedListResponse()` or an +`ErrorResponse()`. + +**Attributes:** + +|Name |Type |Description | +|-------------------------------------------------------------------------|--------------------------------------------------------------------|---------------------------------------------------------------------------| +|response_size_limit |int |responseSizeLimit *Optional* | +|search_criteria_call_center_scheduled_report_name |List[OCI.searchCriteriaCallCenterScheduledReportName] |searchCriteriaCallCenterScheduledReportName *Optional* | +|search_criteria_group_id |List[OCI.searchCriteriaGroupId] |searchCriteriaGroupId *Optional* | +|search_criteria_exact_call_center_scheduled_report_service_provider |OCI.searchCriteriaExactCallCenterScheduledReportServiceProvider |searchCriteriaExactCallCenterScheduledReportServiceProvider *Optional* | +|search_criteria_service_provider_id |List[OCI.searchCriteriaServiceProviderId] |searchCriteriaServiceProviderId *Optional* | +|search_criteria_exact_call_center_scheduled_report_created_by_supervisor |OCI.searchCriteriaExactCallCenterScheduledReportCreatedBySupervisor |searchCriteriaExactCallCenterScheduledReportCreatedBySupervisor *Optional* | +|search_criteria_call_center_report_template_name |List[OCI.searchCriteriaCallCenterReportTemplateName] |searchCriteriaCallCenterReportTemplateName *Optional* | +
+ + +## `SystemCallCenterEnhancedReportingScheduledReportGetListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Request to get the list of all call center reporting scheduled reports in the system. + +The response is either an +`SystemCallCenterEnhancedReportingScheduledReportGetListResponse()` or an +`ErrorResponse()`. + +**Attributes:** + +|Name |Type |Description | +|-------------------------------------------------------------------------|--------------------------------------------------------------------|---------------------------------------------------------------------------| +|response_size_limit |int |responseSizeLimit *Optional* | +|search_criteria_call_center_scheduled_report_name |List[OCI.searchCriteriaCallCenterScheduledReportName] |searchCriteriaCallCenterScheduledReportName *Optional* | +|search_criteria_group_id |List[OCI.searchCriteriaGroupId] |searchCriteriaGroupId *Optional* | +|search_criteria_exact_call_center_scheduled_report_service_provider |OCI.searchCriteriaExactCallCenterScheduledReportServiceProvider |searchCriteriaExactCallCenterScheduledReportServiceProvider *Optional* | +|search_criteria_service_provider_id |List[OCI.searchCriteriaServiceProviderId] |searchCriteriaServiceProviderId *Optional* | +|search_criteria_exact_call_center_scheduled_report_created_by_supervisor |OCI.searchCriteriaExactCallCenterScheduledReportCreatedBySupervisor |searchCriteriaExactCallCenterScheduledReportCreatedBySupervisor *Optional* | +|search_criteria_call_center_report_template_name |List[OCI.searchCriteriaCallCenterReportTemplateName] |searchCriteriaCallCenterReportTemplateName *Optional* | +
+ + +## `SystemClassmarkGetUtilizationListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Get the list of all users associated with a Class Mark in system. + +It is possible to search by various criteria. Multiple search criteria are logically +ANDed together. + +The response is either a `SystemClassmarkGetUtilizationListResponse()` or an +`ErrorResponse()`. + +**Attributes:** + +|Name |Type |Description | +|------------------------------------------|------------------------------------------|------------------------------------------------| +|classmark |str |classmark | +|response_size_limit |int |responseSizeLimit *Optional* | +|search_criteria_group_id |List[OCI.searchCriteriaGroupId] |searchCriteriaGroupId *Optional* | +|search_criteria_exact_service_provider_id |OCI.searchCriteriaExactServiceProviderId |searchCriteriaExactServiceProviderId *Optional* | +|search_criteria_service_provider_id |List[OCI.searchCriteriaServiceProviderId] |searchCriteriaServiceProviderId *Optional* | +|search_criteria_user_first_name |List[OCI.searchCriteriaUserFirstName] |searchCriteriaUserFirstName *Optional* | +|search_criteria_user_last_name |List[OCI.searchCriteriaUserLastName] |searchCriteriaUserLastName *Optional* | +|search_criteria_dn |List[OCI.searchCriteriaDn] |searchCriteriaDn *Optional* | +|search_criteria_user_id |List[OCI.searchCriteriaUserId] |searchCriteriaUserId *Optional* | +|search_criteria_extension |List[OCI.searchCriteriaExtension] |searchCriteriaExtension *Optional* | +
+ + +## `SystemCommunicationBarringDigitPatternCriteriaGetPatternListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Get an existing Digit Pattern Criteria. + +The response is either a +`SystemCommunicationBarringDigitPatternCriteriaGetPatternListResponse()` or an +`ErrorResponse()`. + +**Attributes:** + +|Name |Type |Description | +|------------------------------|-------------------------------------|--------------------------------------| +|name |str |name | +|response_size_limit |int |responseSizeLimit *Optional* | +|search_criteria_digit_pattern |List[OCI.searchCriteriaDigitPattern] |searchCriteriaDigitPattern *Optional* | +
+ + +## `SystemCommunicationBarringProfileModifyRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Modify an existing Communication Barring Profile. + +When the originatingDefaultAction is not Treatment, originatingDefaultTreatmentId will +be automatically cleared. Also when the action of originatingRule is not Treatment, +treatmentId will be automatically cleared for the rule. The priorities for +IncomingRules are requantized to consecutive integers as part of the modify. + +The response is either a `SuccessResponse()` or an `ErrorResponse()`. The following +elements are only used in AS data mode: callMeNowDefaultAction +callMeNowDefaultCallTimeout callMeNowRule applyToAttendedCallTransfers + +**Attributes:** + +|Name |Type |Description | +|------------------------------------|--------------------|--------------------------------------------| +|name |str |name | +|new_name |str |newName *Optional* | +|description |str |description *Optional* | +|originating_default_action |str |originatingDefaultAction *Optional* | +|originating_default_treatment_id |str |originatingDefaultTreatmentId *Optional* | +|originating_default_transfer_number |str |originatingDefaultTransferNumber *Optional* | +|originating_default_call_timeout |int |originatingDefaultCallTimeout *Optional* | +|originating_rule |OCI.originatingRule |originatingRule *Optional* | +|redirecting_default_action |str |redirectingDefaultAction *Optional* | +|redirecting_default_call_timeout |int |redirectingDefaultCallTimeout *Optional* | +|redirecting_rule |OCI.redirectingRule |redirectingRule *Optional* | +|incoming_default_action |str |incomingDefaultAction *Optional* | +|incoming_default_call_timeout |int |incomingDefaultCallTimeout *Optional* | +|incoming_rule |OCI.incomingRule |incomingRule *Optional* | +|call_me_now_default_action |str |callMeNowDefaultAction *Optional* | +|call_me_now_default_call_timeout |int |callMeNowDefaultCallTimeout *Optional* | +|call_me_now_rule |OCI.callMeNowRule |callMeNowRule *Optional* | +|apply_to_attended_call_transfers |bool |applyToAttendedCallTransfers *Optional* | +
+ + +## `SystemDeviceFamilyGetListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Request to get the list of device family managed by the Device Management System. + +If includeSystemLevel is specified, all system level device families and the reseller +device families matching search criteria are returned even when +searchCriteriaResellerId is specified. If reseller administrator sends the request, +searchCriteriaResellerId is ignored and automatically set to the administrator's +reseller. + +The response is either `SystemDeviceFamilyGetListResponse()` or `ErrorResponse()`. + +**Attributes:** + +|Name |Type |Description | +|----------------------------|-----------------------------------|------------------------------------| +|include_system_level |bool |includeSystemLevel *Optional* | +|search_criteria_reseller_id |List[OCI.searchCriteriaResellerId] |searchCriteriaResellerId *Optional* | +
+ + +## `SystemDeviceManagementEventGetListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Request device management's events for a specific queue. + +It is possible to restrict the number of rows returned using responseSizeLimit. If +eventQueueType is not specified, the events from all the event queues are returned. + +The response is either a `SystemDeviceManagementEventGetListResponse()` or an +`ErrorResponse()`. Deprecated by: `SystemDeviceManagementEventGetListRequest22()`. + +**Attributes:** + +|Name |Type |Description | +|----------------------------------------------------------------------------|----------------------------------------------------------------------|-----------------------------------------------------------------------------| +|event_queue_type |str |eventQueueType *Optional* | +|response_size_limit |int |responseSizeLimit *Optional* | +|search_criteria_exact_device_management_event_status_in_progress_or_pending |OCI.searchCriteriaExactDeviceManagementEventStatusInProgressOrPending |searchCriteriaExactDeviceManagementEventStatusInProgressOrPending *Optional* | +|search_criteria_exact_device_management_event_status_completed |OCI.searchCriteriaExactDeviceManagementEventStatusCompleted |searchCriteriaExactDeviceManagementEventStatusCompleted *Optional* | +|search_criteria_exact_device_management_event_action |OCI.searchCriteriaExactDeviceManagementEventAction |searchCriteriaExactDeviceManagementEventAction *Optional* | +|search_criteria_exact_device_management_event_level |OCI.searchCriteriaExactDeviceManagementEventLevel |searchCriteriaExactDeviceManagementEventLevel *Optional* | +|search_criteria_exact_device_management_event_type |OCI.searchCriteriaExactDeviceManagementEventType |searchCriteriaExactDeviceManagementEventType *Optional* | +|search_criteria_device_management_event_additional_info |List[OCI.searchCriteriaDeviceManagementEventAdditionalInfo] |searchCriteriaDeviceManagementEventAdditionalInfo *Optional* | +|search_criteria_device_management_event_login_id |List[OCI.searchCriteriaDeviceManagementEventLoginId] |searchCriteriaDeviceManagementEventLoginId *Optional* | +
+ + +## `SystemDeviceManagementEventGetListRequest22`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Request device management's events for a specific queue. + +It is possible to restrict the number of rows returned using responseSizeLimit. If +eventQueueType is not specified, the events from all the event queues are returned. + +The response is either a `SystemDeviceManagementEventGetListResponse22()` or an +`ErrorResponse()`. + +**Attributes:** + +|Name |Type |Description | +|----------------------------------------------------------------------------|----------------------------------------------------------------------|-----------------------------------------------------------------------------| +|event_queue_type |str |eventQueueType *Optional* | +|response_size_limit |int |responseSizeLimit *Optional* | +|search_criteria_exact_device_management_event_status_in_progress_or_pending |OCI.searchCriteriaExactDeviceManagementEventStatusInProgressOrPending |searchCriteriaExactDeviceManagementEventStatusInProgressOrPending *Optional* | +|search_criteria_exact_device_management_event_status_completed |OCI.searchCriteriaExactDeviceManagementEventStatusCompleted |searchCriteriaExactDeviceManagementEventStatusCompleted *Optional* | +|search_criteria_exact_device_management_event_action |OCI.searchCriteriaExactDeviceManagementEventAction |searchCriteriaExactDeviceManagementEventAction *Optional* | +|search_criteria_exact_device_management_event_level |OCI.searchCriteriaExactDeviceManagementEventLevel |searchCriteriaExactDeviceManagementEventLevel *Optional* | +|search_criteria_exact_device_management_event_type |OCI.searchCriteriaExactDeviceManagementEventType |searchCriteriaExactDeviceManagementEventType *Optional* | +|search_criteria_device_management_event_additional_info |List[OCI.searchCriteriaDeviceManagementEventAdditionalInfo] |searchCriteriaDeviceManagementEventAdditionalInfo *Optional* | +|search_criteria_device_management_event_login_id |List[OCI.searchCriteriaDeviceManagementEventLoginId] |searchCriteriaDeviceManagementEventLoginId *Optional* | +
+ + +## `SystemDeviceProfileAuthenticationLockoutGetRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Request to get device password authentication lockout data in the system. + +The response is either a `SystemDeviceProfileAuthenticationLockoutGetResponse()` or an +`ErrorResponse()`. + +**Attributes:** + +|Name |Type |Description | +|----------------------------------------|------------------------------------------|-----------------------------------------------| +|response_size_limit |int |responseSizeLimit *Optional* | +|search_criteria_service_provider_id |List[OCI.searchCriteriaServiceProviderId] |searchCriteriaServiceProviderId *Optional* | +|search_criteria_exact_organization_type |OCI.searchCriteriaExactOrganizationType |searchCriteriaExactOrganizationType *Optional* | +|search_criteria_group_id |List[OCI.searchCriteriaGroupId] |searchCriteriaGroupId *Optional* | +|search_criteria_device_name |List[OCI.searchCriteriaDeviceName] |searchCriteriaDeviceName *Optional* | +|search_criteria_exact_device_type |OCI.searchCriteriaExactDeviceType |searchCriteriaExactDeviceType *Optional* | +
+ + +## `SystemDnGetSummaryListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Request a summary table of all DNs in the system. + +If resellerId is specified, the DNs assigned to the enterprises/service providers +within the reseller are returned. If reseller administrator sends the request and +resellerId is not specified, the administrator's resellerId is used. The search can +be done using multiple criteria. Only results matching all the search criteria are +included in the results. + +The response is either `SystemDnGetSummaryListResponse()` or `ErrorResponse()`. The +following data elements are only used in AS data mode: resellerId The following +elements are only used in XS data mode and ignored in AS data mode: searchCriteriaDn, +searchCriteriaServiceProviderId, searchCriteriaExactOrganizationType + +**Attributes:** + +|Name |Type |Description | +|----------------------------------------|------------------------------------------|-----------------------------------------------| +|reseller_id |str |resellerId *Optional* | +|search_criteria_dn |List[OCI.searchCriteriaDn] |searchCriteriaDn *Optional* | +|search_criteria_service_provider_id |List[OCI.searchCriteriaServiceProviderId] |searchCriteriaServiceProviderId *Optional* | +|search_criteria_exact_organization_type |OCI.searchCriteriaExactOrganizationType |searchCriteriaExactOrganizationType *Optional* | +
+ + +## `SystemDomainGetListRequest22V2`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Requests the list of all matching system-level domains and all matching reseller level +domains. + +If excludeReseller is specified, returns all matching system-level domain names only. +If resellerId is specified, returns all matching system-level domain names and the +given reseller's domains. If reseller administrator sends the request and resellerId +is not specified, the administrator's resellerId is used. + +The response is either `SystemDomainGetListResponse22V2()` or `ErrorResponse()`. The +following elements are only used in AS data mode and will be ingored in XS data mode: +includeReseller resellerId responseSizeLimit searchCriteriaDomainName +searchCriteriaResellerId searchCriteriaExactDomainLevel + +**Attributes:** + +|Name |Type |Description | +|-----------------------------------|-----------------------------------|------------------------------------------| +|exclude_reseller |bool |excludeReseller *Optional* | +|reseller_id |str |resellerId *Optional* | +|response_size_limit |int |responseSizeLimit *Optional* | +|search_criteria_domain_name |List[OCI.searchCriteriaDomainName] |searchCriteriaDomainName *Optional* | +|search_criteria_reseller_id |List[OCI.searchCriteriaResellerId] |searchCriteriaResellerId *Optional* | +|search_criteria_exact_domain_level |OCI.searchCriteriaExactDomainLevel |searchCriteriaExactDomainLevel *Optional* | +
+ + +## `SystemEndpointGetListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Request to search endpoints in the system. + +If reseller administrator sends the request, searchCriteriaResellerId is ignored. All +endpoints in the administrator's reseller meeting the search criteria are returned. + +The response is either `SystemEndpointGetListResponse()` or `ErrorResponse()`. The +following data elements are only used in AS data mode: searchCriteriaResellerId + +**Attributes:** + +|Name |Type |Description | +|----------------------------------------|------------------------------------------|-----------------------------------------------| +|response_size_limit |int |responseSizeLimit *Optional* | +|search_criteria_service_provider_id |List[OCI.searchCriteriaServiceProviderId] |searchCriteriaServiceProviderId *Optional* | +|search_criteria_exact_organization_type |OCI.searchCriteriaExactOrganizationType |searchCriteriaExactOrganizationType *Optional* | +|search_criteria_group_id |List[OCI.searchCriteriaGroupId] |searchCriteriaGroupId *Optional* | +|search_criteria_line_port_user_part |List[OCI.searchCriteriaLinePortUserPart] |searchCriteriaLinePortUserPart *Optional* | +|search_criteria_line_port_domain |List[OCI.searchCriteriaLinePortDomain] |searchCriteriaLinePortDomain *Optional* | +|search_criteria_user_last_name |List[OCI.searchCriteriaUserLastName] |searchCriteriaUserLastName *Optional* | +|search_criteria_user_first_name |List[OCI.searchCriteriaUserFirstName] |searchCriteriaUserFirstName *Optional* | +|search_criteria_user_id |List[OCI.searchCriteriaUserId] |searchCriteriaUserId *Optional* | +|search_criteria_dn |List[OCI.searchCriteriaDn] |searchCriteriaDn *Optional* | +|search_criteria_extension |List[OCI.searchCriteriaExtension] |searchCriteriaExtension *Optional* | +|search_criteria_device_type |List[OCI.searchCriteriaDeviceType] |searchCriteriaDeviceType *Optional* | +|search_criteria_device_name |List[OCI.searchCriteriaDeviceName] |searchCriteriaDeviceName *Optional* | +|search_criteria_device_mac_address |List[OCI.searchCriteriaDeviceMACAddress] |searchCriteriaDeviceMACAddress *Optional* | +|search_criteria_device_net_address |List[OCI.searchCriteriaDeviceNetAddress] |searchCriteriaDeviceNetAddress *Optional* | +|search_criteria_reseller_id |List[OCI.searchCriteriaResellerId] |searchCriteriaResellerId *Optional* | +
+ + +## `SystemGetRegistrationContactListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Get the list of registration contacts. + +This request handles all levels of administration privileges. The content of the +response will only contain items within the scope of the requester's login id. At the +system level any of the choice parameters may be specified to filter the registrations +listed. At the reseller level, the resellerId must be specified. ResellerId is not +valid at service provider, group or user level. At the service provider level the +serviceProviderId must be specified for the service provider and group options. When +using the userId or linePort options the specified value must be valid for that +service provider login. At the group level the servicProviderId and the groupId must +be specified for the group option. When using the userId or linePort options the +specified value must be valid for that group login. The serviceProviderId option is +not valid at the group level. At the user level when using the userId or linePort +options the specified value must be valid for that user login. The serviceProviderId +and groupId options are not valid at the user level. + +The response is either `SystemGetRegistrationContactListResponse()` or +`ErrorResponse()`. The following elements are only used in AS data mode: resellerId + +**Attributes:** + +|Name |Type |Description | +|---------------------------------|----------------------------------------|-----------------------------------------| +|reseller_id |str |resellerId *Optional* | +|service_provider_id |str |serviceProviderId *Optional* | +|svc_provider_id |str |svcProviderId *Optional* | +|group_id |str |groupId *Optional* | +|user_id |str |userId *Optional* | +|line_port |str |linePort *Optional* | +|device_level |str |deviceLevel *Optional* | +|device_name |str |deviceName *Optional* | +|device_type |str |deviceType *Optional* | +|search_criteria_registration_uri |List[OCI.searchCriteriaRegistrationURI] |searchCriteriaRegistrationURI *Optional* | +|search_criteria_sip_contact |List[OCI.searchCriteriaSIPContact] |searchCriteriaSIPContact *Optional* | +|endpoint_type |str |endpointType *Optional* | +|expired |bool |expired *Optional* | +
+ + +## `SystemGetRegistrationContactListRequest21sp1`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Get the list of registration contacts. + +This request handles all levels of administration privileges. The content of the +response will only contain items within the scope of the requester's login id. At the +system level any of the choice parameters may be specified to filter the registrations +listed. At the reseller level, the resellerId must be specified. ResellerId is not +valid at service provider, group or user level. At the service provider level the +serviceProviderId must be specified for the service provider and group options. When +using the userId or linePort options the specified value must be valid for that +service provider login. At the group level the servicProviderId and the groupId must +be specified for the group option. When using the userId or linePort options the +specified value must be valid for that group login. The serviceProviderId option is +not valid at the group level. At the user level when using the userId or linePort +options the specified value must be valid for that user login. The serviceProviderId +and groupId options are not valid at the user level. + +The response is either `SystemGetRegistrationContactListResponse21sp1()` or +`ErrorResponse()`. The RegistrationEndpointType21sp1 is sent in response The Endpoint +Type column contains one of the enumerated RegistrationEndpointType21sp1 values. The +value Mobility in Endpoint Type column is only applicable in AS data mode. The +following elements are only used in AS data mode: resellerId + +**Attributes:** + +|Name |Type |Description | +|---------------------------------|----------------------------------------|-----------------------------------------| +|reseller_id |str |resellerId *Optional* | +|service_provider_id |str |serviceProviderId *Optional* | +|svc_provider_id |str |svcProviderId *Optional* | +|group_id |str |groupId *Optional* | +|user_id |str |userId *Optional* | +|line_port |str |linePort *Optional* | +|device_level |str |deviceLevel *Optional* | +|device_name |str |deviceName *Optional* | +|device_type |str |deviceType *Optional* | +|search_criteria_registration_uri |List[OCI.searchCriteriaRegistrationURI] |searchCriteriaRegistrationURI *Optional* | +|search_criteria_sip_contact |List[OCI.searchCriteriaSIPContact] |searchCriteriaSIPContact *Optional* | +|endpoint_type |str |endpointType *Optional* | +|expired |bool |expired *Optional* | +
+ + +## `SystemHomeNetworkGetListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Get the list of all Home Networks. + +The response is either a `SystemHomeNetworkGetListResponse()` or an `ErrorResponse()`. + +**Attributes:** + +|Name |Type |Description | +|---------------------------------|---------------------------------------|----------------------------------------| +|response_size_limit |int |responseSizeLimit *Optional* | +|search_criteria_home_msc_address |List[OCI.searchCriteriaHomeMscAddress] |searchCriteriaHomeMscAddress *Optional* | +
+ + +## `SystemNumberPortabilityQueryDigitPatternGetListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Request to get the System Number Portability Query Digit Pattern List information. + +The response is either a `SystemNumberPortabilityQueryDigitPatternGetListResponse()` +or an `ErrorResponse()`. + +**Attributes:** + +|Name |Type |Description | +|-------------------------------------------------------|-----------------------------------------------------------|------------------------------------------------------------| +|search_criteria_number_portability_query_digit_pattern |List[OCI.searchCriteriaNumberPortabilityQueryDigitPattern] |searchCriteriaNumberPortabilityQueryDigitPattern *Optional* | +|search_criteria_number_portability_status |List[OCI.searchCriteriaNumberPortabilityStatus] |searchCriteriaNumberPortabilityStatus *Optional* | +|response_size_limit |int |responseSizeLimit *Optional* |
-## `ServiceProviderCommunicationBarringProfileModifyRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) +## `SystemPreferredCarrierGetGroupListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
-Modify an existing Communication Barring Profile. +Requests a list of groups using the specified carrier. -The priorities for OriginatingRules, RedirectingRules, CallMeNowRules and -IncomingRules are requantized to consecutive integers as part of the modify. +It is possible to restrict the number of rows returned by specifying various search +criteria. Multiple search criteria are logically ANDed together. -The response is either a `SuccessResponse()` or an `ErrorResponse()`. The following -elements are only used in AS data mode: callMeNowDefaultAction -callMeNowDefaultCallTimeout callMeNowRule applyToAttendedCallTransfers +The response is either a `SystemPreferredCarrierGetGroupListResponse()` or an +`ErrorResponse()`. **Attributes:** -|Name |Type |Description | -|------------------------------------|--------------------|--------------------------------------------| -|service_provider_id |str |serviceProviderId | -|name |str |name | -|new_name |str |newName *Optional* | -|description |str |description *Optional* | -|originating_default_action |str |originatingDefaultAction *Optional* | -|originating_default_treatment_id |str |originatingDefaultTreatmentId *Optional* | -|originating_default_transfer_number |str |originatingDefaultTransferNumber *Optional* | -|originating_default_call_timeout |int |originatingDefaultCallTimeout *Optional* | -|originating_rule |OCI.originatingRule |originatingRule *Optional* | -|redirecting_default_action |str |redirectingDefaultAction *Optional* | -|redirecting_default_call_timeout |int |redirectingDefaultCallTimeout *Optional* | -|redirecting_rule |OCI.redirectingRule |redirectingRule *Optional* | -|call_me_now_default_action |str |callMeNowDefaultAction *Optional* | -|call_me_now_default_call_timeout |int |callMeNowDefaultCallTimeout *Optional* | -|call_me_now_rule |OCI.callMeNowRule |callMeNowRule *Optional* | -|incoming_default_action |str |incomingDefaultAction *Optional* | -|incoming_default_call_timeout |int |incomingDefaultCallTimeout *Optional* | -|incoming_rule |OCI.incomingRule |incomingRule *Optional* | -|become_default |bool |becomeDefault *Optional* | -|apply_to_attended_call_transfers |bool |applyToAttendedCallTransfers *Optional* | +|Name |Type |Description | +|---------------------------------------|------------------------------------------|----------------------------------------------| +|carrier |str |carrier | +|response_size_limit |int |responseSizeLimit *Optional* | +|search_criteria_group_id |List[OCI.searchCriteriaGroupId] |searchCriteriaGroupId *Optional* | +|search_criteria_group_name |List[OCI.searchCriteriaGroupName] |searchCriteriaGroupName *Optional* | +|search_criteria_exact_service_provider |OCI.searchCriteriaExactServiceProvider |searchCriteriaExactServiceProvider *Optional* | +|search_criteria_service_provider_id |List[OCI.searchCriteriaServiceProviderId] |searchCriteriaServiceProviderId *Optional* |
-## `ServiceProviderConsolidatedAddRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) +## `SystemPreferredCarrierGetUserListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
-Add a service provider or enterprise. +Requests a list of users using the specified carrier. -The response is either a `SuccessResponse()` or an `ErrorResponse()`. The following -elements are only used in AS data mode and ignored in XS data mode: -serviceProviderExtenalId The following elements are only used in Amplify data mode and -ignored in AS and XS data mode: servicePolicy, callProcessingSliceId, -provisioningSliceId, subscriberPartition. When the callProcessingSliceId or -provisioningSliceId is not specified in the AmplifyDataMode, the default slice Id is -assigned to the service provider. Only Provisioning admin and above can change the -callProcessingSliceId, provisioningSliceId, andsubscriberPartition. The following -elements are only used in Amplify and XS data mode and ignored in AS data mode: -preferredDataCenter. Only Provisioning admin and above can change the -preferredDataCenter. The following data elements are only used in AS data mode: -resellerId resellerName The following behavior is only applicable in CloudPBX: - when -new resellerId, that does not exist in the system, is specified, the new Reseller is -created the given resellerId and resellerName (if provided) and enterprise/Service -Provider is moved to the newly created Reseller. resellerName element is ignored if -the reseller the service provider is being moved to already exists. The following -elements are optional for the service provider. If the elements are included, they -will be either added, authorized, or modified on the service provider. Should any of -the following elements be rejected to due existing system settings, the service -provider will not be added and the response will be an `ErrorResponse()`: domain admin -groupServiceAuthorization userServiceAuthorization servicePack phoneNumber dnRange -routingProfile meetMeConferencingAllocatedPorts trunkGroupMaxActiveCalls -trunkGroupBurstingMaxActiveCalls voiceMessagingGroupSettings -voiceMessagingVoicePortalScope When a group or user service is included that is not -activated or is not licensed, the response will be an `ErrorResponse()`. +It is possible to restrict the number of rows returned by specifying various search +criteria. Multiple search criteria are logically ANDed together. + +The response is either a `SystemPreferreredCarrierGetUserListResponse()` or an +`ErrorResponse()`. **Attributes:** -|Name |Type |Description | -|-----------------------------------------|-------------------------------------|-----------------------------------------------| -|is_enterprise |bool |isEnterprise *Optional* | -|use_custom_routing_profile |bool |useCustomRoutingProfile *Optional* | -|service_provider_id |str |serviceProviderId *Optional* | -|service_provider_external_id |str |serviceProviderExternalId *Optional* | -|default_domain |str |defaultDomain | -|service_provider_name |str |serviceProviderName *Optional* | -|support_email |str |supportEmail *Optional* | -|contact |OCI.contact |contact *Optional* | -|address |OCI.address |address *Optional* | -|service_policy |str |servicePolicy *Optional* | -|call_processing_slice_id |str |callProcessingSliceId *Optional* | -|provisioning_slice_id |str |provisioningSliceId *Optional* | -|subscriber_partition |str |subscriberPartition *Optional* | -|preferred_data_center |str |preferredDataCenter *Optional* | -|reseller_id |str |resellerId *Optional* | -|reseller_name |str |resellerName *Optional* | -|domain |List[str] |domain *Optional* | -|admin |List[OCI.admin] |admin *Optional* | -|group_service_authorization |List[OCI.groupServiceAuthorization] |groupServiceAuthorization *Optional* | -|user_service_authorization |List[OCI.userServiceAuthorization] |userServiceAuthorization *Optional* | -|service_pack |List[OCI.servicePack] |servicePack *Optional* | -|phone_number |List[str] |phoneNumber *Optional* | -|dn_range |List[OCI.dnRange] |dnRange *Optional* | -|routing_profile |str |routingProfile *Optional* | -|meet_me_conferencing_allocated_ports |OCI.meetMeConferencingAllocatedPorts |meetMeConferencingAllocatedPorts *Optional* | -|trunk_group_max_active_calls |OCI.trunkGroupMaxActiveCalls |trunkGroupMaxActiveCalls *Optional* | -|trunk_group_bursting_max_active_calls |OCI.trunkGroupBurstingMaxActiveCalls |trunkGroupBurstingMaxActiveCalls *Optional* | -|voice_messaging_group_settings |OCI.voiceMessagingGroupSettings |voiceMessagingGroupSettings *Optional* | -|voice_messaging_group_voice_portal_scope |str |voiceMessagingGroupVoicePortalScope *Optional* | +|Name |Type |Description | +|--------------------------------|--------------------------------------|---------------------------------------| +|carrier |str |carrier | +|response_size_limit |int |responseSizeLimit *Optional* | +|search_criteria_user_last_name |List[OCI.searchCriteriaUserLastName] |searchCriteriaUserLastName *Optional* | +|search_criteria_user_first_name |List[OCI.searchCriteriaUserFirstName] |searchCriteriaUserFirstName *Optional* | +|search_criteria_dn |List[OCI.searchCriteriaDn] |searchCriteriaDn *Optional* | +|search_criteria_email_address |List[OCI.searchCriteriaEmailAddress] |searchCriteriaEmailAddress *Optional* | +|search_criteria_user_id |List[OCI.searchCriteriaUserId] |searchCriteriaUserId *Optional* | +|search_criteria_extension |List[OCI.searchCriteriaExtension] |searchCriteriaExtension *Optional* |
-## `ServiceProviderEndpointGetListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) +## `SystemRoamingNetworkGetListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
-Request to search endpoints in the service provider/enterprise. +Get the list of all Roaming Networks. -The response is either `ServiceProviderEndpointGetListResponse()` or +The response is either a `SystemRoamingNetworkGetListResponse()` or an `ErrorResponse()`. **Attributes:** -|Name |Type |Description | -|--------------------------------------|-----------------------------------------|---------------------------------------------| -|service_provider_id |str |serviceProviderId | -|response_size_limit |int |responseSizeLimit *Optional* | -|search_criteria_group_id |List[OCI.searchCriteriaGroupId] |searchCriteriaGroupId *Optional* | -|search_criteria_line_port_user_part |List[OCI.searchCriteriaLinePortUserPart] |searchCriteriaLinePortUserPart *Optional* | -|search_criteria_line_port_domain |List[OCI.searchCriteriaLinePortDomain] |searchCriteriaLinePortDomain *Optional* | -|search_criteria_user_last_name |List[OCI.searchCriteriaUserLastName] |searchCriteriaUserLastName *Optional* | -|search_criteria_user_first_name |List[OCI.searchCriteriaUserFirstName] |searchCriteriaUserFirstName *Optional* | -|search_criteria_user_id |List[OCI.searchCriteriaUserId] |searchCriteriaUserId *Optional* | -|search_criteria_dn |List[OCI.searchCriteriaDn] |searchCriteriaDn *Optional* | -|search_criteria_extension |List[OCI.searchCriteriaExtension] |searchCriteriaExtension *Optional* | -|search_criteria_device_type |List[OCI.searchCriteriaDeviceType] |searchCriteriaDeviceType *Optional* | -|search_criteria_device_name |List[OCI.searchCriteriaDeviceName] |searchCriteriaDeviceName *Optional* | -|search_criteria_device_mac_address |List[OCI.searchCriteriaDeviceMACAddress] |searchCriteriaDeviceMACAddress *Optional* | -|search_criteria_device_net_address |List[OCI.searchCriteriaDeviceNetAddress] |searchCriteriaDeviceNetAddress *Optional* | -|search_criteria_exact_user_department |OCI.searchCriteriaExactUserDepartment |searchCriteriaExactUserDepartment *Optional* | +|Name |Type |Description | +|------------------------------------|------------------------------------------|-------------------------------------------| +|response_size_limit |int |responseSizeLimit *Optional* | +|search_criteria_roaming_msc_address |List[OCI.searchCriteriaRoamingMscAddress] |searchCriteriaRoamingMscAddress *Optional* |
-## `ServiceProviderGetPagedSortedListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) +## `SystemSIPAuthenticationEndpointLockoutGetRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
-Request a list of service providers and/or enterprises in the system. +Request to get sip authentication endpoint lockout data in the system. -The response is either a `ServiceProviderGetPagedSortedListResponse()` or an -`ErrorResponse()`. If reseller administrator sends the request, -searchCriteriaResellerId is ignored. Service providers/enterprise within the -administrator's reseller meeting the search criteria are returned. If the -responsePagingControl element is not provided, the paging startIndex will be set to 1 -by default, and the responsePageSize will be set to the maximum responsePageSize by -default. If no sortOrder is included, the response is sorted by Service Provider Id -ascending by default. Multiple search criteria are logically ANDed together unless -the searchCriteriaModeOr option is included. Then the search criteria are logically -ORed together. +The response is either a `SystemSIPAuthenticationEndpointLockoutGetResponse()` or an +`ErrorResponse()`. **Attributes:** -|Name |Type |Description | -|----------------------------------------|--------------------------------------------|-----------------------------------------------| -|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | -|sort_order |List[OCI.sortOrder] |sortOrder *Optional* | -|search_criteria_service_provider_id |List[OCI.searchCriteriaServiceProviderId] |searchCriteriaServiceProviderId *Optional* | -|search_criteria_service_provider_name |List[OCI.searchCriteriaServiceProviderName] |searchCriteriaServiceProviderName *Optional* | -|search_criteria_exact_organization_type |OCI.searchCriteriaExactOrganizationType |searchCriteriaExactOrganizationType *Optional* | -|search_criteria_reseller_id |List[OCI.searchCriteriaResellerId] |searchCriteriaResellerId *Optional* | -|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | +|Name |Type |Description | +|----------------------------------------|------------------------------------------|-----------------------------------------------| +|response_size_limit |int |responseSizeLimit *Optional* | +|search_criteria_service_provider_id |List[OCI.searchCriteriaServiceProviderId] |searchCriteriaServiceProviderId *Optional* | +|search_criteria_exact_organization_type |OCI.searchCriteriaExactOrganizationType |searchCriteriaExactOrganizationType *Optional* | +|search_criteria_group_id |List[OCI.searchCriteriaGroupId] |searchCriteriaGroupId *Optional* | +|search_criteria_line_port_user_part |List[OCI.searchCriteriaLinePortUserPart] |searchCriteriaLinePortUserPart *Optional* | +|search_criteria_line_port_domain |List[OCI.searchCriteriaLinePortDomain] |searchCriteriaLinePortDomain *Optional* | +|search_criteria_user_last_name |List[OCI.searchCriteriaUserLastName] |searchCriteriaUserLastName *Optional* | +|search_criteria_user_first_name |List[OCI.searchCriteriaUserFirstName] |searchCriteriaUserFirstName *Optional* | +|search_criteria_user_id |List[OCI.searchCriteriaUserId] |searchCriteriaUserId *Optional* |
-## `ServiceProviderMWIDeliveryToMobileEndpointCustomTemplateAddRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) +## `SystemSIPAuthenticationTrunkGroupLockoutGetRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
-Create a MWI Delivery to Mobile Endpoint Custom Template. +Request to get sip authentication trunk group lockout data in the system. -The response is either a `SuccessResponse()` or an `ErrorResponse()`. +The response is either a `SystemSIPAuthenticationTrunkGroupLockoutGetResponse()` or an +`ErrorResponse()`. **Attributes:** -|Name |Type |Description | -|--------------------|-----------------|------------------| -|service_provider_id |str |serviceProviderId | -|language |str |language | -|type |str |type | -|is_enabled |bool |isEnabled | -|template_body |OCI.templateBody |templateBody | +|Name |Type |Description | +|----------------------------------------|------------------------------------------|-----------------------------------------------| +|response_size_limit |int |responseSizeLimit *Optional* | +|search_criteria_service_provider_id |List[OCI.searchCriteriaServiceProviderId] |searchCriteriaServiceProviderId *Optional* | +|search_criteria_exact_organization_type |OCI.searchCriteriaExactOrganizationType |searchCriteriaExactOrganizationType *Optional* | +|search_criteria_group_id |List[OCI.searchCriteriaGroupId] |searchCriteriaGroupId *Optional* | +|search_criteria_trunk_group_name |List[OCI.searchCriteriaTrunkGroupName] |searchCriteriaTrunkGroupName *Optional* |
-## `ServiceProviderMWIDeliveryToMobileEndpointCustomTemplateModifyRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) +## `SystemSIPDeviceTypeGetListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
-Modify a MWI Delivery to Mobile Endpoint Custom Template. +Request to get the list of sip device types in the system. -The response is either a `SuccessResponse()` or an `ErrorResponse()`. +If includeSystemLevel is specified, all system level device types and the reseller +device types matching search criteria are returned even when searchCriteriaResellerId +is specified. If reseller administrator sends the request, searchCriteriaResellerId +is ignored. All system level device types and the device types in the administrator's +reseller meeting the search criteria are returned. See Also: +`SystemDeviceTypeGetAvailableListRequest22()` in AS data mode, +`SystemDeviceTypeGetAvailableListRequest19()` in XS data mode. + +The response is either `SystemSIPDeviceTypeGetListResponse()` or `ErrorResponse()`. +The following data elements are only used in AS data mode and ignored in XS data mode: +searchCriteriaExactDeviceTypeConfigurationOptionType **Attributes:** -|Name |Type |Description | -|--------------------|-----------------|------------------------| -|service_provider_id |str |serviceProviderId | -|language |str |language | -|type |str |type | -|is_enabled |bool |isEnabled *Optional* | -|template_body |OCI.templateBody |templateBody *Optional* | +|Name |Type |Description | +|---------------------------------------------|---------------------------------------------------|----------------------------------------------------| +|response_size_limit |int |responseSizeLimit *Optional* | +|search_criteria_device_type |List[OCI.searchCriteriaDeviceType] |searchCriteriaDeviceType *Optional* | +|search_criteria_exact_signaling_address_type |OCI.searchCriteriaExactSignalingAddressType |searchCriteriaExactSignalingAddressType *Optional* | +|search_criteria_reseller_id |List[OCI.searchCriteriaResellerId] |searchCriteriaResellerId *Optional* | +|search_criteria_device_configuration_options |List[OCI.searchCriteriaDeviceConfigurationOptions] |searchCriteriaDeviceConfigurationOptions *Optional* | +|include_system_level |bool |includeSystemLevel *Optional* |
-## `ServiceProviderRouteListEnterpriseTrunkNumberPrefixAddListRequest22`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) +## `SystemSecurityClassificationGetClassificationTrunkGroupUsageListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
-Add number prefixes to a service provider. +Get a list of users that currently have the specified Security Classification +assigned. -The response is either `SuccessResponse()` or `ErrorResponse()`. +The response is either +`SystemSecurityClassificationGetClassificationTrunkGroupUsageListResponse()` or +`ErrorResponse()`. **Attributes:** -|Name |Type |Description | -|--------------------|-----------------|------------------| -|service_provider_id |str |serviceProviderId | -|prefix |List[OCI.prefix] |prefix | +|Name |Type |Description | +|----------------------------------------|------------------------------------------|-----------------------------------------------| +|security_classification |str |securityClassification | +|response_size_limit |int |responseSizeLimit *Optional* | +|search_criteria_trunk_group_name |List[OCI.searchCriteriaTrunkGroupName] |searchCriteriaTrunkGroupName *Optional* | +|search_criteria_group_id |List[OCI.searchCriteriaGroupId] |searchCriteriaGroupId *Optional* | +|search_criteria_service_provider_id |List[OCI.searchCriteriaServiceProviderId] |searchCriteriaServiceProviderId *Optional* | +|search_criteria_exact_organization_type |OCI.searchCriteriaExactOrganizationType |searchCriteriaExactOrganizationType *Optional* |
-## `ServiceProviderRouteListEnterpriseTrunkNumberPrefixModifyListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) +## `SystemSecurityClassificationGetClassificationUserUsageListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
-Modify a list of number prefixes in a service provider. +Get a list of users that currently have the specified Security Classification +assigned. -The response is either `SuccessResponse()` or `ErrorResponse()`. +The response is either +`SystemSecurityClassificationGetClassificationUserUsageListResponse()` or +`ErrorResponse()`. **Attributes:** -|Name |Type |Description | -|--------------------|-----------------------|------------------------| -|service_provider_id |str |serviceProviderId | -|number_prefix |List[OCI.numberPrefix] |numberPrefix *Optional* | +|Name |Type |Description | +|--------------------------------|--------------------------------------|---------------------------------------| +|security_classification |str |securityClassification | +|response_size_limit |int |responseSizeLimit *Optional* | +|search_criteria_user_id |List[OCI.searchCriteriaUserId] |searchCriteriaUserId *Optional* | +|search_criteria_user_last_name |List[OCI.searchCriteriaUserLastName] |searchCriteriaUserLastName *Optional* | +|search_criteria_user_first_name |List[OCI.searchCriteriaUserFirstName] |searchCriteriaUserFirstName *Optional* | +|search_criteria_dn |List[OCI.searchCriteriaDn] |searchCriteriaDn *Optional* | +|search_criteria_extension |List[OCI.searchCriteriaExtension] |searchCriteriaExtension *Optional* |
-## `ServiceProviderRouteListEnterpriseTrunkNumberRangeAddListRequest22`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) +## `SystemServiceCodeGetListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
-Add number ranges to a service provider. +Request to get all service codes that have been defined in the system. -The response is either `SuccessResponse()` or `ErrorResponse()`. +It is possible to search by various criteria to restrict the number of rows returned. +Multiple search criteria are logically ANDed together. + +The response is either `SystemServiceCodeGetListResponse()` or `ErrorResponse()`. **Attributes:** -|Name |Type |Description | -|--------------------|----------------------|------------------| -|service_provider_id |str |serviceProviderId | -|number_range |List[OCI.numberRange] |numberRange | +|Name |Type |Description | +|-----------------------------------------|-----------------------------------------------|------------------------------------------------| +|response_size_limit |int |responseSizeLimit *Optional* | +|search_criteria_service_code |List[OCI.searchCriteriaServiceCode] |searchCriteriaServiceCode *Optional* | +|search_criteria_service_code_description |List[OCI.searchCriteriaServiceCodeDescription] |searchCriteriaServiceCodeDescription *Optional* |
-## `ServiceProviderServiceModifyAuthorizationListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) +## `SystemThirdPartyVoiceMailSupportGetDnListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
-Requests to change the service provider's service authorization status. - -The boolean flags are used to authorize or unauthorize services. +Request to get a list of ThirdPartyVoiceMailSupport User DN's defined in the system. -The response is either `SuccessResponse()` or `ErrorResponse()`. +The response is either a `SystemThirdPartyVoiceMailSupportGetDnListResponse()` or an +`ErrorResponse()`. The search can be done using multiple criterion. **Attributes:** -|Name |Type |Description | -|----------------------------|------------------------------------|-------------------------------------| -|service_provider_id |str |serviceProviderId | -|group_service_authorization |List[OCI.groupServiceAuthorization] |groupServiceAuthorization *Optional* | -|user_service_authorization |List[OCI.userServiceAuthorization] |userServiceAuthorization *Optional* | +|Name |Type |Description | +|----------------------------------|----------------------------------------|-----------------------------------------| +|response_size_limit |int |responseSizeLimit *Optional* | +|search_criteria_system_service_dn |List[OCI.searchCriteriaSystemServiceDn] |searchCriteriaSystemServiceDn *Optional* |
-## `SystemCommunicationBarringProfileModifyRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) +## `SystemTwoStageDialingGetDnListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
-Modify an existing Communication Barring Profile. - -When the originatingDefaultAction is not Treatment, originatingDefaultTreatmentId will -be automatically cleared. Also when the action of originatingRule is not Treatment, -treatmentId will be automatically cleared for the rule. The priorities for -IncomingRules are requantized to consecutive integers as part of the modify. +Request to get a list of Two Stage Dialing dns defined in the system. -The response is either a `SuccessResponse()` or an `ErrorResponse()`. The following -elements are only used in AS data mode: callMeNowDefaultAction -callMeNowDefaultCallTimeout callMeNowRule applyToAttendedCallTransfers +The response is either a `SystemTwoStageDialingGetDnListResponse()` or an +`ErrorResponse()`. **Attributes:** -|Name |Type |Description | -|------------------------------------|--------------------|--------------------------------------------| -|name |str |name | -|new_name |str |newName *Optional* | -|description |str |description *Optional* | -|originating_default_action |str |originatingDefaultAction *Optional* | -|originating_default_treatment_id |str |originatingDefaultTreatmentId *Optional* | -|originating_default_transfer_number |str |originatingDefaultTransferNumber *Optional* | -|originating_default_call_timeout |int |originatingDefaultCallTimeout *Optional* | -|originating_rule |OCI.originatingRule |originatingRule *Optional* | -|redirecting_default_action |str |redirectingDefaultAction *Optional* | -|redirecting_default_call_timeout |int |redirectingDefaultCallTimeout *Optional* | -|redirecting_rule |OCI.redirectingRule |redirectingRule *Optional* | -|incoming_default_action |str |incomingDefaultAction *Optional* | -|incoming_default_call_timeout |int |incomingDefaultCallTimeout *Optional* | -|incoming_rule |OCI.incomingRule |incomingRule *Optional* | -|call_me_now_default_action |str |callMeNowDefaultAction *Optional* | -|call_me_now_default_call_timeout |int |callMeNowDefaultCallTimeout *Optional* | -|call_me_now_rule |OCI.callMeNowRule |callMeNowRule *Optional* | -|apply_to_attended_call_transfers |bool |applyToAttendedCallTransfers *Optional* | +|Name |Type |Description | +|----------------------------------|----------------------------------------|-----------------------------------------| +|response_size_limit |int |responseSizeLimit *Optional* | +|search_criteria_system_service_dn |List[OCI.searchCriteriaSystemServiceDn] |searchCriteriaSystemServiceDn *Optional* |
@@ -70273,6 +68827,81 @@ Returns a `SystemVerifyTranslationAndRoutingResponse()`. +## `SystemXsiPolicyProfileGetAssignedServiceProviderListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Get usage of specific policy profile. + +The response is either a +`SystemXsiPolicyProfileGetAssignedServiceProviderListResponse()` or an +`ErrorResponse()`. + +**Attributes:** + +|Name |Type |Description | +|----------------------------------------|--------------------------------------------|-----------------------------------------------| +|xsi_policy_profile |OCI.xsiPolicyProfile |xsiPolicyProfile | +|response_size_limit |int |responseSizeLimit *Optional* | +|search_criteria_service_provider_id |List[OCI.searchCriteriaServiceProviderId] |searchCriteriaServiceProviderId *Optional* | +|search_criteria_service_provider_name |List[OCI.searchCriteriaServiceProviderName] |searchCriteriaServiceProviderName *Optional* | +|search_criteria_exact_organization_type |OCI.searchCriteriaExactOrganizationType |searchCriteriaExactOrganizationType *Optional* | +|search_criteria_reseller_id |List[OCI.searchCriteriaResellerId] |searchCriteriaResellerId *Optional* | +
+ + +## `SystemZoneCallingRestrictionsNetAddressGetListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Gets a list of IP Addresses and/or Ranges assigned to a zone Response is +`SystemZoneCallingRestrictionsNetAddressGetListResponse()`. + +Replaced by: `SystemZoneNetAddressGetListRequest()` + +**Attributes:** + +|Name |Type |Description | +|--------------------------------|--------------------------------------|---------------------------------------| +|zone_name |str |zoneName | +|response_size_limit |int |responseSizeLimit *Optional* | +|search_criteria_zone_ip_address |List[OCI.searchCriteriaZoneIPAddress] |searchCriteriaZoneIPAddress *Optional* | +
+ + +## `SystemZoneLocationBasedPhysicalLocationGetListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Gets a list of physical locations assigned to a zone. + +Response is `SystemZoneLocationBasedPhysicalLocationGetListResponse()` or an +`ErrorResponse()`. + +**Attributes:** + +|Name |Type |Description | +|----------------------------------|-----------------------------------------|------------------------------------------| +|zone_name |str |zoneName | +|response_size_limit |int |responseSizeLimit *Optional* | +|search_criteria_physical_location |List[OCI.searchCriteriaPhysicalLocation] |searchCriteriaPhysicalLocation *Optional* | +
+ + +## `SystemZoneNetAddressGetListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Gets a list of IP Addresses and/or Ranges assigned to a zone. + +Response is `SystemZoneNetAddressGetListResponse()` or an `ErrorResponse()`. + +**Attributes:** + +|Name |Type |Description | +|--------------------------------|--------------------------------------|---------------------------------------| +|zone_name |str |zoneName | +|response_size_limit |int |responseSizeLimit *Optional* | +|search_criteria_zone_ip_address |List[OCI.searchCriteriaZoneIPAddress] |searchCriteriaZoneIPAddress *Optional* | +
+ + ## `UserAddRequest14`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -70464,6 +69093,81 @@ Replaced by: `UserAddRequest22()` in AS data mode.
+## `UserAnnouncementFileGetListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Get the list of announcement names with associated media type and filesize for a User +and given Announcement Repository Type The response is either a +`UserAnnouncementFileGetListResponse()` or an `ErrorResponse()`. + + +**Attributes:** + +|Name |Type |Description | +|---------------------------------------|---------------------------------------------|----------------------------------------------| +|user_id |str |userId | +|announcement_file_type |str |announcementFileType *Optional* | +|include_announcement_table |bool |includeAnnouncementTable | +|response_size_limit |int |responseSizeLimit *Optional* | +|search_criteria_announcement_file_name |List[OCI.searchCriteriaAnnouncementFileName] |searchCriteriaAnnouncementFileName *Optional* | +
+ + +## `UserAnnouncementFileGetPagedSortedListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Get the list of announcement files for a user. + +If the responsePagingControl element is not provided, the paging startIndex will be +set to 1 by default, and the responsePageSize will be set to the maximum +responsePageSize by default. If no sortOrder is provided, the response is sorted by +Name ascending by default. Multiple search criteria are logically ANDed together +unless the searchCriteriaModeOr option is included. Then the search criteria are +logically ORed together. + +The response is either a `UserAnnouncementFileGetPagedSortedListResponse()` or an +`ErrorResponse()`. + +**Attributes:** + +|Name |Type |Description | +|---------------------------------------------|---------------------------------------------|---------------------------------------------------| +|user_id |str |userId | +|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | +|sort_by_announcement_file_name |OCI.sortByAnnouncementFileName |sortByAnnouncementFileName *Optional* | +|sort_by_announcement_file_size |OCI.sortByAnnouncementFileSize |sortByAnnouncementFileSize *Optional* | +|search_criteria_announcement_file_name |List[OCI.searchCriteriaAnnouncementFileName] |searchCriteriaAnnouncementFileName *Optional* | +|search_criteria_exact_announcement_file_type |OCI.searchCriteriaExactAnnouncementFileType |searchCriteriaExactAnnouncementFileType *Optional* | +|search_criteria_exact_media_file_type |List[OCI.searchCriteriaExactMediaFileType] |searchCriteriaExactMediaFileType *Optional* | +|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | +
+ + +## `UserBroadWorksAnywhereGetPhoneNumberPagedSortedListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Get the list of all the BroadWorks Anywhere phone numbers for the user. + +If no sortOrder is included the response is sorted by Phone Number ascending by +default. + +The response is either a +`UserBroadWorksAnywhereGetPhoneNumberPagedSortedListResponse()` or an +`ErrorResponse()`. + +**Attributes:** + +|Name |Type |Description | +|---------------------------------------|---------------------------------------|----------------------------------------------| +|user_id |str |userId | +|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | +|sort_by_location |OCI.sortByLocation |sortByLocation *Optional* | +|sort_by_enabled |OCI.sortByEnabled |sortByEnabled *Optional* | +|search_criteria_location |List[OCI.searchCriteriaLocation] |searchCriteriaLocation *Optional* | +|search_criteria_exact_location_enabled |OCI.searchCriteriaExactLocationEnabled |searchCriteriaExactLocationEnabled *Optional* | +
+ + ## `UserBroadWorksAnywhereModifySelectiveCriteriaRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -71078,6 +69782,37 @@ The response is either `UserBusyLampFieldGetAvailableUserListResponse()` or
+## `UserCallCenterGetAvailableCallCenterPagedSortedListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+This request gets a list of all call centers which the user can be assigned to as an +agent. + +Some of the call centers may already have the user as an agent. It is the clients +responsibility to discard the call centers that the user is already an agent of. If +the responsePagingControl element is not provided, the paging startIndex will be set +to 1 by default, and the responsePageSize will be set to the maximum ResponsePageSize +by default. It is possible to search by various criteria to restrict the number of +rows returned. Multiple search criteria are logically ANDed together unless the +searchCriteriaModeOr option is included. Then the search criteria are logically ORed +together. + +The response is either a +`UserCallCenterGetAvailableCallCenterPagedSortedListResponse()` or an +`ErrorResponse()`. + +**Attributes:** + +|Name |Type |Description | +|------------------------|-------------------------------|---------------------------------| +|user_id |str |userId | +|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | +|sort_by_user_id |OCI.sortByUserId |sortByUserId *Optional* | +|search_criteria_user_id |List[OCI.searchCriteriaUserId] |searchCriteriaUserId *Optional* | +|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | +
+ + ## `UserCallCenterGetSupervisedAgentListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -71382,249 +70117,33 @@ The response is either a `SuccessResponse()` or an `ErrorResponse()`.
-## `UserEnhancedCallLogsGetListRequest17sp4`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Request user's call logs. - -If the callLogType is not specified, all types of calls logs (placed, received, -missed) are returned. The filters "dateTimeRange", "numberFilter", -"redirectedNumberFilter", accountAuthorizationCodeFilter" and ""subscriberType" are -ignored if call logs are stored in CDS. When "ReceivedOrMissed" is specified as -"callLogType" and call logs are stored in CDS, all call logs including placed will be -returned. It is possible to restrict the number of rows returned using -responsePagingControl. If responsePagingControl is not specified, the value of -Enhanced Call Logs system parameter maxNonPagedResponseSize will control the maximum -number of call logs can be returned. - -The response is either a `UserEnhancedCallLogsGetListResponse17sp4()` or an -`ErrorResponse()`. Replaced by UserEnhancedCallLogsGetListRequest17sp4V2. Originally -deprecated in release 20. - -**Attributes:** - -|Name |Type |Description | -|----------------------------------|-----------------------------------|------------------------------------------| -|user_id |str |userId | -|call_log_type |str |callLogType *Optional* | -|date_time_range |OCI.dateTimeRange |dateTimeRange | -|number_filter |OCI.numberFilter |numberFilter *Optional* | -|redirected_number_filter |OCI.redirectedNumberFilter |redirectedNumberFilter *Optional* | -|account_authorization_code_filter |OCI.accountAuthorizationCodeFilter |accountAuthorizationCodeFilter *Optional* | -|subscriber_type |str |subscriberType *Optional* | -|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | -
- - -## `UserEnhancedCallLogsGetListRequest20`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Request user's call logs. - -If the callLogType is not specified, all types of calls logs (placed, received, -missed) are returned. The filters "dateTimeRange", "numberFilter", -"redirectedNumberFilter", "accountAuthorizationCodeFilter" -"callAuthorizationCodeFilter" and "subscriberType" are ignored if call logs are stored -in CDS. When "ReceivedOrMissed" is specified as "callLogType" and call logs are stored -in CDS, all call logs including placed will be returned. It is possible to restrict -the number of rows returned using responsePagingControl. If responsePagingControl is -not specified, the value of Enhanced Call Logs system parameter -maxNonPagedResponseSize will control the maximum number of call logs can be returned. - -The response is either a `UserEnhancedCallLogsGetListResponse20()` or an -`ErrorResponse()`. The following elements are only used in AS data mode and not -returned in XS data mode: callAuthorizationCodeFilter - -**Attributes:** - -|Name |Type |Description | -|----------------------------------|-----------------------------------|------------------------------------------| -|user_id |str |userId | -|call_log_type |str |callLogType *Optional* | -|date_time_range |OCI.dateTimeRange |dateTimeRange | -|number_filter |OCI.numberFilter |numberFilter *Optional* | -|redirected_number_filter |OCI.redirectedNumberFilter |redirectedNumberFilter *Optional* | -|account_authorization_code_filter |OCI.accountAuthorizationCodeFilter |accountAuthorizationCodeFilter *Optional* | -|call_authorization_code_filter |OCI.callAuthorizationCodeFilter |callAuthorizationCodeFilter *Optional* | -|subscriber_type |str |subscriberType *Optional* | -|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | -
- - -## `UserEnhancedCallLogsGetListRequest20sp1`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Request user's call logs. - -If the callLogType is not specified, all types of calls logs (placed, received, -missed) are returned. The filters "dateTimeRange", "numberFilter", -"redirectedNumberFilter", "accountAuthorizationCodeFilter" -"callAuthorizationCodeFilter" and "subscriberType" are ignored if call logs are stored -in CDS. When "ReceivedOrMissed" is specified as "callLogType" and call logs are stored -in CDS, all call logs including placed will be returned. It is possible to restrict -the number of rows returned using responsePagingControl. If responsePagingControl is -not specified, the value of Enhanced Call Logs system parameter -maxNonPagedResponseSize will control the maximum number of call logs can be returned. - -The response is either a `UserEnhancedCallLogsGetListResponse20sp1()` or an -`ErrorResponse()`. The following elements are only used in AS data mode: -callAuthorizationCodeFilter callSecurityClassification - -**Attributes:** - -|Name |Type |Description | -|----------------------------------|-----------------------------------|------------------------------------------| -|user_id |str |userId | -|call_log_type |str |callLogType *Optional* | -|date_time_range |OCI.dateTimeRange |dateTimeRange | -|number_filter |OCI.numberFilter |numberFilter *Optional* | -|redirected_number_filter |OCI.redirectedNumberFilter |redirectedNumberFilter *Optional* | -|account_authorization_code_filter |OCI.accountAuthorizationCodeFilter |accountAuthorizationCodeFilter *Optional* | -|call_authorization_code_filter |OCI.callAuthorizationCodeFilter |callAuthorizationCodeFilter *Optional* | -|subscriber_type |str |subscriberType *Optional* | -|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | -
- - -## `UserEnhancedCallLogsGetListRequest21`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Request user's call logs. - -If the callLogType is not specified, all types of calls logs (placed, received, -missed) are returned. The filters "dateTimeRange", "numberFilter", -"redirectedNumberFilter", "accountAuthorizationCodeFilter" -"callAuthorizationCodeFilter" and "subscriberType" are ignored if call logs are stored -in CDS. When "ReceivedOrMissed" is specified as "callLogType" and call logs are stored -in CDS, all call logs including placed will be returned. It is possible to restrict -the number of rows returned using responsePagingControl. If responsePagingControl is -not specified, the value of Enhanced Call Logs system parameter -maxNonPagedResponseSize will control the maximum number of call logs can be returned. - -The response is either a `UserEnhancedCallLogsGetListResponse21()` or an -`ErrorResponse()`. The following elements are only used in AS data mode and not -returned in XS data mode: callAuthorizationCodeFilter Replaced by: -UserEnhancedCallLogsGetListRequest21Sp1 in AS data mode - -**Attributes:** - -|Name |Type |Description | -|----------------------------------|-----------------------------------|------------------------------------------| -|user_id |str |userId | -|call_log_type |str |callLogType *Optional* | -|date_time_range |OCI.dateTimeRange |dateTimeRange | -|number_filter |OCI.numberFilter |numberFilter *Optional* | -|redirected_number_filter |OCI.redirectedNumberFilter |redirectedNumberFilter *Optional* | -|account_authorization_code_filter |OCI.accountAuthorizationCodeFilter |accountAuthorizationCodeFilter *Optional* | -|call_authorization_code_filter |OCI.callAuthorizationCodeFilter |callAuthorizationCodeFilter *Optional* | -|subscriber_type |str |subscriberType *Optional* | -|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | -
- - -## `UserEnhancedCallLogsGetListRequest21sp1`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Request user's call logs. - -If the callLogType is not specified, all types of calls logs (placed, received, -missed) are returned. The filters "dateTimeRange", "numberFilter", -"redirectedNumberFilter", "accountAuthorizationCodeFilter" -"callAuthorizationCodeFilter" and "subscriberType" are ignored if call logs are stored -in CDS. When "ReceivedOrMissed" is specified as "callLogType" and call logs are stored -in CDS, all call logs including placed will be returned. It is possible to restrict -the number of rows returned using responsePagingControl. If responsePagingControl is -not specified, the value of Enhanced Call Logs system parameter -maxNonPagedResponseSize will control the maximum number of call logs can be returned. - -The response is either a `UserEnhancedCallLogsGetListResponse21sp1()` or an -`ErrorResponse()`. The following elements are only used in AS data mode and ignored in -XS data mode: callAuthorizationCodeFilter Replaced by: -UserEnhancedCallLogsGetListRequest21Sp1V2 in AS data mode - -**Attributes:** - -|Name |Type |Description | -|----------------------------------|-----------------------------------|------------------------------------------| -|user_id |str |userId | -|call_log_type |str |callLogType *Optional* | -|date_time_range |OCI.dateTimeRange |dateTimeRange | -|number_filter |OCI.numberFilter |numberFilter *Optional* | -|redirected_number_filter |OCI.redirectedNumberFilter |redirectedNumberFilter *Optional* | -|account_authorization_code_filter |OCI.accountAuthorizationCodeFilter |accountAuthorizationCodeFilter *Optional* | -|call_authorization_code_filter |OCI.callAuthorizationCodeFilter |callAuthorizationCodeFilter *Optional* | -|subscriber_type |str |subscriberType *Optional* | -|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | -
- - -## `UserEnhancedCallLogsGetListRequest22`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Request user's call logs. - -If the callLogType is not specified, all types of calls logs (placed, received, -missed) are returned. The filters "dateTimeRange", "numberFilter", -"redirectedNumberFilter", "accountAuthorizationCodeFilter" -"callAuthorizationCodeFilter" and "subscriberType" are ignored if call logs are stored -in CDS. When "ReceivedOrMissed" is specified as "callLogType" and call logs are stored -in CDS, all call logs including placed will be returned. It is possible to restrict -the number of rows returned using responsePagingControl. If responsePagingControl is -not specified, the value of Enhanced Call Logs system parameter -maxNonPagedResponseSize will control the maximum number of call logs can be returned. - -The response is either a `UserEnhancedCallLogsGetListResponse22()` or an -`ErrorResponse()`. The following elements are only used in AS data mode and ignored in -XS data mode: callAuthorizationCodeFilter - -**Attributes:** - -|Name |Type |Description | -|----------------------------------|-----------------------------------|------------------------------------------| -|user_id |str |userId | -|call_log_type |str |callLogType *Optional* | -|date_time_range |OCI.dateTimeRange |dateTimeRange | -|number_filter |OCI.numberFilter |numberFilter *Optional* | -|redirected_number_filter |OCI.redirectedNumberFilter |redirectedNumberFilter *Optional* | -|account_authorization_code_filter |OCI.accountAuthorizationCodeFilter |accountAuthorizationCodeFilter *Optional* | -|call_authorization_code_filter |OCI.callAuthorizationCodeFilter |callAuthorizationCodeFilter *Optional* | -|subscriber_type |str |subscriberType *Optional* | -|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | -
- - -## `UserEnhancedCallLogsGetListRequest23`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) +## `UserEnterpriseCommonPhoneListGetPagedSortedListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
-Request user's call logs. - -If the callLogType is not specified, all types of calls logs (placed, received, -missed) are returned. The filters "dateTimeRange", "numberFilter", -"redirectedNumberFilter", "accountAuthorizationCodeFilter" -"callAuthorizationCodeFilter" and "subscriberType" are ignored if call logs are stored -in CDS. When "ReceivedOrMissed" is specified as "callLogType" and call logs are stored -in CDS, all call logs including placed will be returned. It is possible to restrict -the number of rows returned using responsePagingControl. If responsePagingControl is -not specified, the value of Enhanced Call Logs system parameter -maxNonPagedResponseSize will control the maximum number of call logs can be returned. +Get an enterprise's common phone list for a user. -The response is either a `UserEnhancedCallLogsGetListResponse23()` or an -`ErrorResponse()`. The following elements are only used in AS data mode and ignored in -XS data mode: callAuthorizationCodeFilter +The response is either a `UserEnterpriseCommonPhoneListGetPagedSortedListResponse()` +or an `ErrorResponse()`. The search can be done using multiple criterion. If the +searchCriteriaModeOr is present, any result matching any one criteria is included in +the results. Otherwise, only results matching all the search criterion are included +in the results. If no search criteria is specified, all results are returned. +Specifying searchCriteriaModeOr without any search criteria results in an +`ErrorResponse()`. The sort can be done on the name or the number in the common phone +list. The following elements are only used in AS data mode and ignored in XS data +mode: searchCriteriaEnterpriseCommonMultiPartPhoneListName **Attributes:** -|Name |Type |Description | -|----------------------------------|-----------------------------------|------------------------------------------| -|user_id |str |userId | -|call_log_type |str |callLogType *Optional* | -|date_time_range |OCI.dateTimeRange |dateTimeRange | -|number_filter |OCI.numberFilter |numberFilter *Optional* | -|redirected_number_filter |OCI.redirectedNumberFilter |redirectedNumberFilter *Optional* | -|account_authorization_code_filter |OCI.accountAuthorizationCodeFilter |accountAuthorizationCodeFilter *Optional* | -|call_authorization_code_filter |OCI.callAuthorizationCodeFilter |callAuthorizationCodeFilter *Optional* | -|subscriber_type |str |subscriberType *Optional* | -|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | +|Name |Type |Description | +|-------------------------------------------------------------|---------------------------------------------------------------|----------------------------------------------------------------| +|user_id |str |userId | +|response_paging_control |OCI.responsePagingControl |responsePagingControl | +|sort_by_enterprise_common_phone_list_number |OCI.sortByEnterpriseCommonPhoneListNumber |sortByEnterpriseCommonPhoneListNumber *Optional* | +|sort_by_enterprise_common_phone_list_name |OCI.sortByEnterpriseCommonPhoneListName |sortByEnterpriseCommonPhoneListName *Optional* | +|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | +|search_criteria_enterprise_common_phone_list_name |List[OCI.searchCriteriaEnterpriseCommonPhoneListName] |searchCriteriaEnterpriseCommonPhoneListName *Optional* | +|search_criteria_enterprise_common_phone_list_number |List[OCI.searchCriteriaEnterpriseCommonPhoneListNumber] |searchCriteriaEnterpriseCommonPhoneListNumber *Optional* | +|search_criteria_enterprise_common_multi_part_phone_list_name |List[OCI.searchCriteriaEnterpriseCommonMultiPartPhoneListName] |searchCriteriaEnterpriseCommonMultiPartPhoneListName *Optional* |
@@ -71737,46 +70256,6 @@ The response is either a `SuccessResponse()` or an `ErrorResponse()`. Replaced b -## `UserGetListInGroupPagedSortedListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) - -
-Request the list of users in a group. - -The response is either a `UserGetListInGroupPagedSortedListResponse()` or an -`ErrorResponse()`. If the responsePagingControl element is not provided, the paging -startIndex will be set to 1 by default, and the responsePageSize will be set to the -maximum ResponsePageSize by default. It is possible to search by various criteria to -restrict the number of rows returned. If no sortOrder is included the response is -sorted by User Id ascending by default. A limitation to the search by DN activation -exists when the Number Activation mode is set to Off. In this case DNs not assigned -to users are never returned by queries with the "dnActivationSearchCriteria" included. -Multiple search criteria are logically ANDed together unless the searchCriteriaModeOr -option is included. Then the search criteria are logically ORed together. The -following elements are used in AS data mode and ignored in XS data mode: -groupExternalId - -**Attributes:** - -|Name |Type |Description | -|------------------------------------------|----------------------------------------|-----------------------------------------------| -|service_provider_id |str |serviceProviderId *Optional* | -|group_id |str |groupId *Optional* | -|group_external_id |str |groupExternalId *Optional* | -|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | -|sort_order |List[OCI.sortOrder] |sortOrder *Optional* | -|search_criteria_user_last_name |List[OCI.searchCriteriaUserLastName] |searchCriteriaUserLastName *Optional* | -|search_criteria_user_first_name |List[OCI.searchCriteriaUserFirstName] |searchCriteriaUserFirstName *Optional* | -|search_criteria_dn |List[OCI.searchCriteriaDn] |searchCriteriaDn *Optional* | -|search_criteria_email_address |List[OCI.searchCriteriaEmailAddress] |searchCriteriaEmailAddress *Optional* | -|search_criteria_department_name |List[OCI.searchCriteriaDepartmentName] |searchCriteriaDepartmentName *Optional* | -|search_criteria_exact_user_in_trunk_group |OCI.searchCriteriaExactUserInTrunkGroup |searchCriteriaExactUserInTrunkGroup *Optional* | -|search_criteria_user_id |List[OCI.searchCriteriaUserId] |searchCriteriaUserId *Optional* | -|search_criteria_extension |List[OCI.searchCriteriaExtension] |searchCriteriaExtension *Optional* | -|search_criteria_exact_dn_activation |OCI.searchCriteriaExactDnActivation |searchCriteriaExactDnActivation *Optional* | -|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | -
- - ## `UserGetListInGroupRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -71835,6 +70314,39 @@ The response is either a `UserGetListInServiceProviderResponse()` or an
+## `UserGetListInSystemRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Request the list of users in the system. + +It is possible to search by various criteria to restrict the number of rows returned. +Multiple search criteria are logically ANDed together. If reseller administrator +sends the request, searchCriteriaResellerId is ignored. All the users in the +administrator's reseller meeting the search criteria are returned. + +The response is either a `UserGetListInSystemResponse()` or an `ErrorResponse()`. The +following data elements are only used in AS data mode: searchCriteriaResellerId + +**Attributes:** + +|Name |Type |Description | +|----------------------------------------------------|-------------------------------------------------|--------------------------------------------------------| +|response_size_limit |int |responseSizeLimit *Optional* | +|search_criteria_user_last_name |List[OCI.searchCriteriaUserLastName] |searchCriteriaUserLastName *Optional* | +|search_criteria_user_first_name |List[OCI.searchCriteriaUserFirstName] |searchCriteriaUserFirstName *Optional* | +|search_criteria_dn |List[OCI.searchCriteriaDn] |searchCriteriaDn *Optional* | +|search_criteria_email_address |List[OCI.searchCriteriaEmailAddress] |searchCriteriaEmailAddress *Optional* | +|search_criteria_group_id |List[OCI.searchCriteriaGroupId] |searchCriteriaGroupId *Optional* | +|search_criteria_exact_service_provider |OCI.searchCriteriaExactServiceProvider |searchCriteriaExactServiceProvider *Optional* | +|search_criteria_service_provider_id |List[OCI.searchCriteriaServiceProviderId] |searchCriteriaServiceProviderId *Optional* | +|search_criteria_exact_user_in_trunk_group |OCI.searchCriteriaExactUserInTrunkGroup |searchCriteriaExactUserInTrunkGroup *Optional* | +|search_criteria_exact_user_network_class_of_service |OCI.searchCriteriaExactUserNetworkClassOfService |searchCriteriaExactUserNetworkClassOfService *Optional* | +|search_criteria_user_id |List[OCI.searchCriteriaUserId] |searchCriteriaUserId *Optional* | +|search_criteria_extension |List[OCI.searchCriteriaExtension] |searchCriteriaExtension *Optional* | +|search_criteria_reseller_id |List[OCI.searchCriteriaResellerId] |searchCriteriaResellerId *Optional* | +
+ + ## `UserGetServiceInstanceListInServiceProviderRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -71864,6 +70376,107 @@ The response is either a `UserGetServiceInstanceListInServiceProviderResponse()`
+## `UserGetServiceInstanceListInSystemRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Request the list of Service Instances in the system. + +It is possible to search by various criteria to restrict the number of rows returned. +Multiple search criteria are logically ANDed together. If reseller administrator +sends the request, searchCriteriaResellerId is ignored. All the service instances in +the administrator's reseller meeting the search criteria are returned. + +The response is either a `UserGetServiceInstanceListInSystemResponse()` or an +`ErrorResponse()`. The following data elements are only used in AS data mode: +searchCriteriaResellerId + +**Attributes:** + +|Name |Type |Description | +|---------------------------------------|------------------------------------------|----------------------------------------------| +|response_size_limit |int |responseSizeLimit *Optional* | +|search_criteria_exact_service_type |OCI.searchCriteriaExactServiceType |searchCriteriaExactServiceType *Optional* | +|search_criteria_user_id |List[OCI.searchCriteriaUserId] |searchCriteriaUserId *Optional* | +|search_criteria_user_last_name |List[OCI.searchCriteriaUserLastName] |searchCriteriaUserLastName *Optional* | +|search_criteria_dn |List[OCI.searchCriteriaDn] |searchCriteriaDn *Optional* | +|search_criteria_extension |List[OCI.searchCriteriaExtension] |searchCriteriaExtension *Optional* | +|search_criteria_group_id |List[OCI.searchCriteriaGroupId] |searchCriteriaGroupId *Optional* | +|search_criteria_exact_service_provider |OCI.searchCriteriaExactServiceProvider |searchCriteriaExactServiceProvider *Optional* | +|search_criteria_service_provider_id |List[OCI.searchCriteriaServiceProviderId] |searchCriteriaServiceProviderId *Optional* | +|search_criteria_reseller_id |List[OCI.searchCriteriaResellerId] |searchCriteriaResellerId *Optional* | +
+ + +## `UserGroupCommonPhoneListGetPagedSortedListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Get a user's group's common phone list. + +The response is either a `UserGroupCommonPhoneListGetPagedSortedListResponse()` or an +`ErrorResponse()`. The search can be done using multiple criterion. If the +searchCriteriaModeOr is present, any result matching any one criteria is included in +the results. Otherwise, only results matching all the search criterion are included +in the results. If no search criteria is specified, all results are returned. +Specifying searchCriteriaModeOr without any search criteria results in an +`ErrorResponse()`. The sort can be done on the name or the number in the common phone +list. The following elements are only used in AS data mode and ignored in XS data +mode: searchCriteriaGroupCommonMultiPartPhoneListName + +**Attributes:** + +|Name |Type |Description | +|--------------------------------------------------------|----------------------------------------------------------|-----------------------------------------------------------| +|user_id |str |userId | +|response_paging_control |OCI.responsePagingControl |responsePagingControl | +|sort_by_group_common_phone_list_number |OCI.sortByGroupCommonPhoneListNumber |sortByGroupCommonPhoneListNumber *Optional* | +|sort_by_group_common_phone_list_name |OCI.sortByGroupCommonPhoneListName |sortByGroupCommonPhoneListName *Optional* | +|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | +|search_criteria_group_common_phone_list_name |List[OCI.searchCriteriaGroupCommonPhoneListName] |searchCriteriaGroupCommonPhoneListName *Optional* | +|search_criteria_group_common_phone_list_number |List[OCI.searchCriteriaGroupCommonPhoneListNumber] |searchCriteriaGroupCommonPhoneListNumber *Optional* | +|search_criteria_group_common_multi_part_phone_list_name |List[OCI.searchCriteriaGroupCommonMultiPartPhoneListName] |searchCriteriaGroupCommonMultiPartPhoneListName *Optional* | +
+ + +## `UserGroupCustomContactDirectoryGetPagedSortedListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Gets a Custom Contact Directory in a group. + +The response is either `UserGroupCustomContactDirectoryGetPagedSortedListResponse()` +or `ErrorResponse()`. The search can be done using multiple criterion. If the +searchCriteriaModeOr is present, any result matching any one criteria is included in +the results. Otherwise, only results matching all the search criterion are included +in the results. If no search criteria is specified, all results are returned. +Specifying searchCriteriaModeOr without any search criteria results in an +`ErrorResponse()`. The sort can be done on the user last name, first name, department, +or contact notes. The Receptionist Note column is only populated, if the user sending +the request is a the owner of this Receptionist Note and a Note exists. + +**Attributes:** + +|Name |Type |Description | +|------------------------------------|------------------------------------------|-------------------------------------------| +|user_id |str |userId | +|name |str |name | +|response_paging_control |OCI.responsePagingControl |responsePagingControl | +|sort_by_user_last_name |OCI.sortByUserLastName |sortByUserLastName *Optional* | +|sort_by_user_first_name |OCI.sortByUserFirstName |sortByUserFirstName *Optional* | +|sort_by_user_department |OCI.sortByUserDepartment |sortByUserDepartment *Optional* | +|sort_by_receptionist_note |OCI.sortByReceptionistNote |sortByReceptionistNote *Optional* | +|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | +|search_criteria_user_last_name |List[OCI.searchCriteriaUserLastName] |searchCriteriaUserLastName *Optional* | +|search_criteria_user_first_name |List[OCI.searchCriteriaUserFirstName] |searchCriteriaUserFirstName *Optional* | +|search_criteria_dn |List[OCI.searchCriteriaDn] |searchCriteriaDn *Optional* | +|search_criteria_extension |List[OCI.searchCriteriaExtension] |searchCriteriaExtension *Optional* | +|search_criteria_mobile_phone_number |List[OCI.searchCriteriaMobilePhoneNumber] |searchCriteriaMobilePhoneNumber *Optional* | +|search_criteria_user_id |List[OCI.searchCriteriaUserId] |searchCriteriaUserId *Optional* | +|search_criteria_department_name |List[OCI.searchCriteriaDepartmentName] |searchCriteriaDepartmentName *Optional* | +|search_criteria_imp_id |List[OCI.searchCriteriaImpId] |searchCriteriaImpId *Optional* | +|search_criteria_title |List[OCI.searchCriteriaTitle] |searchCriteriaTitle *Optional* | +|search_criteria_receptionist_note |List[OCI.searchCriteriaReceptionistNote] |searchCriteriaReceptionistNote *Optional* | +
+ + ## `UserHotelingGuestGetAvailableUserListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -72220,6 +70833,81 @@ number element is only used when the type is BroadWorks Mobility.
+## `UserPersonalAssistantExclusionNumberGetListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Request to get the User Personal Assistant Exclusion Number List information. + +The response is either a userPersonalAssistantExclusionNumberGetListResponse or an +`ErrorResponse()`. + +**Attributes:** + +|Name |Type |Description | +|----------------------------------------------------------------|--------------------------------------------------------------------|---------------------------------------------------------------------| +|user_id |str |userId | +|search_criteria_personal_assistant_exclusion_number |List[OCI.searchCriteriaPersonalAssistantExclusionNumber] |searchCriteriaPersonalAssistantExclusionNumber *Optional* | +|search_criteria_personal_assistant_exclusion_number_description |List[OCI.searchCriteriaPersonalAssistantExclusionNumberDescription] |searchCriteriaPersonalAssistantExclusionNumberDescription *Optional* | +|response_size_limit |int |responseSizeLimit *Optional* | +
+ + +## `UserPersonalPhoneListGetListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Get a user's personal phone list. + +The response is either a `UserPersonalPhoneListGetListResponse()` or an +`ErrorResponse()`. The search can be done using multiple criterion. If the +searchCriteriaModeOr is present, any result matching any one criteria is included in +the results. Otherwise, only results matching all the search criterion are included +in the results. If no search criteria is specified, all results are returned. +Specifying searchCriteriaModeOr without any search criteria results in an +`ErrorResponse()`. In all cases, if a responseSizeLimit is specified and the number of +matching results is more than this limit, then an `ErrorResponse()` is returned. + +**Attributes:** + +|Name |Type |Description | +|------------------------------------------------|----------------------------------------------------|-----------------------------------------------------| +|user_id |str |userId | +|response_size_limit |int |responseSizeLimit *Optional* | +|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | +|search_criteria_user_personal_phone_list_name |List[OCI.searchCriteriaUserPersonalPhoneListName] |searchCriteriaUserPersonalPhoneListName *Optional* | +|search_criteria_user_personal_phone_list_number |List[OCI.searchCriteriaUserPersonalPhoneListNumber] |searchCriteriaUserPersonalPhoneListNumber *Optional* | +
+ + +## `UserPersonalPhoneListGetPagedSortedListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Get a user's personal phone list. + +The response is either a `UserPersonalPhoneListGetPagedSortedListResponse()` or an +`ErrorResponse()`. The search can be done using multiple criterion. If the +searchCriteriaModeOr is present, any result matching any one criteria is included in +the results. Otherwise, only results matching all the search criterion are included +in the results. If no search criteria is specified, all results are returned. +Specifying searchCriteriaModeOr without any search criteria results in an +`ErrorResponse()`. The sort can done by the personal phone list number or name. The +following elements are only used in AS data mode and ignored in XS data mode: +searchCriteriaUserPersonalMultiPartPhoneListName + +**Attributes:** + +|Name |Type |Description | +|---------------------------------------------------------|-----------------------------------------------------------|------------------------------------------------------------| +|user_id |str |userId | +|response_paging_control |OCI.responsePagingControl |responsePagingControl | +|sort_by_user_personal_phone_list_number |OCI.sortByUserPersonalPhoneListNumber |sortByUserPersonalPhoneListNumber *Optional* | +|sort_by_user_personal_phone_list_name |OCI.sortByUserPersonalPhoneListName |sortByUserPersonalPhoneListName *Optional* | +|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | +|search_criteria_user_personal_phone_list_name |List[OCI.searchCriteriaUserPersonalPhoneListName] |searchCriteriaUserPersonalPhoneListName *Optional* | +|search_criteria_user_personal_phone_list_number |List[OCI.searchCriteriaUserPersonalPhoneListNumber] |searchCriteriaUserPersonalPhoneListNumber *Optional* | +|search_criteria_user_personal_multi_part_phone_list_name |List[OCI.searchCriteriaUserPersonalMultiPartPhoneListName] |searchCriteriaUserPersonalMultiPartPhoneListName *Optional* | +
+ + ## `UserPhoneDirectoryGetListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -72309,6 +70997,58 @@ request is the owner of the Receptionist Note and a Note exists.
+## `UserPhoneDirectoryGetPagedSortedListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Request a table containing the phone directory for a user. + +Setting isEnterpriseRequested to true will return enterprise directory members in the +response if the user is in an enterprise. Otherwise, just the group directory members +for a user are returned in the response. + +The response is either `UserPhoneDirectoryGetPagedSortedListResponse()` or +`ErrorResponse()`. The search can be done using multiple criteria. If the +searchCriteriaModeOr is present, any result matching any one criteria is included in +the results. Otherwise, only results matching all the search criteria are included in +the results. If no search criteria is specified, all results are returned. +Specifying searchCriteriaModeOr without any search criteria results in an +`ErrorResponse()`. The sort can be performed on user last name, first name, +department, or receptionist note. The Receptionist Note column is only populated, if +the user sending the request is the owner of the Receptionist Note and a Note exists. +The following elements are only used in AS data mode and ignored in XS data mode: +searchCriteriaMultiPartName + +**Attributes:** + +|Name |Type |Description | +|------------------------------------|------------------------------------------|-------------------------------------------| +|user_id |str |userId | +|is_enterprise_info_requested |bool |isEnterpriseInfoRequested | +|response_paging_control |OCI.responsePagingControl |responsePagingControl | +|sort_by_user_last_name |OCI.sortByUserLastName |sortByUserLastName *Optional* | +|sort_by_user_first_name |OCI.sortByUserFirstName |sortByUserFirstName *Optional* | +|sort_by_user_department |OCI.sortByUserDepartment |sortByUserDepartment *Optional* | +|sort_by_receptionist_note |OCI.sortByReceptionistNote |sortByReceptionistNote *Optional* | +|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | +|search_criteria_user_last_name |List[OCI.searchCriteriaUserLastName] |searchCriteriaUserLastName *Optional* | +|search_criteria_user_first_name |List[OCI.searchCriteriaUserFirstName] |searchCriteriaUserFirstName *Optional* | +|search_criteria_user_name |List[OCI.searchCriteriaUserName] |searchCriteriaUserName *Optional* | +|search_criteria_dn |List[OCI.searchCriteriaDn] |searchCriteriaDn *Optional* | +|search_criteria_group_location_code |List[OCI.searchCriteriaGroupLocationCode] |searchCriteriaGroupLocationCode *Optional* | +|search_criteria_extension |List[OCI.searchCriteriaExtension] |searchCriteriaExtension *Optional* | +|search_criteria_mobile_phone_number |List[OCI.searchCriteriaMobilePhoneNumber] |searchCriteriaMobilePhoneNumber *Optional* | +|search_criteria_email_address |List[OCI.searchCriteriaEmailAddress] |searchCriteriaEmailAddress *Optional* | +|search_criteria_yahoo_id |List[OCI.searchCriteriaYahooId] |searchCriteriaYahooId *Optional* | +|search_criteria_exact_user_group |OCI.searchCriteriaExactUserGroup |searchCriteriaExactUserGroup *Optional* | +|search_criteria_department_name |List[OCI.searchCriteriaDepartmentName] |searchCriteriaDepartmentName *Optional* | +|search_criteria_user_id |List[OCI.searchCriteriaUserId] |searchCriteriaUserId *Optional* | +|search_criteria_imp_id |List[OCI.searchCriteriaImpId] |searchCriteriaImpId *Optional* | +|search_criteria_title |List[OCI.searchCriteriaTitle] |searchCriteriaTitle *Optional* | +|search_criteria_receptionist_note |List[OCI.searchCriteriaReceptionistNote] |searchCriteriaReceptionistNote *Optional* | +|search_criteria_multi_part_name |List[OCI.searchCriteriaMultiPartName] |searchCriteriaMultiPartName *Optional* | +
+ + ## `UserPreAlertingAnnouncementModifyCriteriaRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -72474,6 +71214,36 @@ The response is either a `UserScheduleGetEventListForGroupResponse()` or an
+## `UserScheduleGetPagedSortedListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Get the list of schedules viewable by a User. + +The list can be filtered by schedule name, schedule type, and schedule level. + +The response is either a `UserScheduleGetPagedSortedListResponse()` or an +`ErrorResponse()`. This command is authorized to user who is Executive-Assistant of +the Executive. If no sortOrder is included, the response is sorted by Name ascending +by default. If the responsePagingControl element is not provided, the paging +startIndex will be set to 1 by default, and the responsePageSize will be set to the +maximum responsePageSize by default. Multiple search criteria are logically ANDed +together unless the searchCriteriaModeOr option is included. Then the search criteria +are logically ORed together. + +**Attributes:** + +|Name |Type |Description | +|-------------------------------------|-------------------------------------------|--------------------------------------------| +|user_id |str |userId | +|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | +|sort_by_schedule_name |OCI.sortByScheduleName |sortByScheduleName *Optional* | +|search_criteria_schedule_name |List[OCI.searchCriteriaScheduleName] |searchCriteriaScheduleName *Optional* | +|search_criteria_exact_schedule_type |List[OCI.searchCriteriaExactScheduleType] |searchCriteriaExactScheduleType *Optional* | +|search_criteria_exact_schedule_level |List[OCI.searchCriteriaExactScheduleLevel] |searchCriteriaExactScheduleLevel *Optional* | +|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | +
+ + ## `UserSelectiveCallAcceptanceModifyCriteriaRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -73059,6 +71829,172 @@ The response is either a `SuccessResponse()` or an `ErrorResponse()`.
+## `EnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAssignmentPagedSortedListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Request a summary table of all Mobile Subscriber Directory Numbers in an enterprise. + +If the responsePagingControl element is not provided, the paging startIndex will be +set to 1 by default, and the responsePageSize will be set to the maximum +ResponsePageSize by default. If no sortOrder is included the response is sorted by +Mobile Number ascending by default. Multiple search criteria are logically ANDed +together unless the searchCriteriaModeOr option is included. Then the search criteria +are logically ORed together. The department in both the search criteria and sort by +fields refer to the department of the user. + +The response is either +`EnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAssignmentPagedSortedListResponse()` +or `ErrorResponse()`. Replaced by: +`EnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAssignmentPagedSortedListRequest22()` + +**Attributes:** + +|Name |Type |Description | +|---------------------------------------------------|--------------------------------------------------------|---------------------------------------------------------| +|service_provider_id |str |serviceProviderId | +|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | +|sort_order |List[OCI.sortOrder] |sortOrder *Optional* | +|search_criteria_mobile_subscriber_directory_number |List[OCI.searchCriteriaMobileSubscriberDirectoryNumber] |searchCriteriaMobileSubscriberDirectoryNumber *Optional* | +|search_criteria_group_id |List[OCI.searchCriteriaGroupId] |searchCriteriaGroupId *Optional* | +|search_criteria_user_id |List[OCI.searchCriteriaUserId] |searchCriteriaUserId *Optional* | +|search_criteria_user_last_name |List[OCI.searchCriteriaUserLastName] |searchCriteriaUserLastName *Optional* | +|search_criteria_user_first_name |List[OCI.searchCriteriaUserFirstName] |searchCriteriaUserFirstName *Optional* | +|search_criteria_dn |List[OCI.searchCriteriaDn] |searchCriteriaDn *Optional* | +|search_criteria_extension |List[OCI.searchCriteriaExtension] |searchCriteriaExtension *Optional* | +|search_criteria_department_name |List[OCI.searchCriteriaDepartmentName] |searchCriteriaDepartmentName *Optional* | +|search_criteria_exact_mobile_network |List[OCI.searchCriteriaExactMobileNetwork] |searchCriteriaExactMobileNetwork *Optional* | +|search_criteria_exact_mobile_dn_availability |OCI.searchCriteriaExactMobileDnAvailability |searchCriteriaExactMobileDnAvailability *Optional* | +|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | +
+ + +## `EnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAssignmentPagedSortedListRequest22`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Request a summary table of all Mobile Subscriber Directory Numbers in an enterprise. + +If the responsePagingControl element is not provided, the paging startIndex will be +set to 1 by default, and the responsePageSize will be set to the maximum +ResponsePageSize by default. If no sortOrder is included the response is sorted by +Mobile Number ascending by default. Multiple search criteria are logically ANDed +together unless the searchCriteriaModeOr option is included. Then the search criteria +are logically ORed together. The department in both the search criteria and sort by +fields refer to the department of the user. + +The response is either +`EnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAssignmentPagedSortedListResponse22()` +or `ErrorResponse()`. + +**Attributes:** + +|Name |Type |Description | +|---------------------------------------------------|--------------------------------------------------------|---------------------------------------------------------| +|service_provider_id |str |serviceProviderId | +|include_total_number_of_rows |bool |includeTotalNumberOfRows *Optional* | +|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | +|sort_order |List[OCI.sortOrder] |sortOrder *Optional* | +|search_criteria_mobile_subscriber_directory_number |List[OCI.searchCriteriaMobileSubscriberDirectoryNumber] |searchCriteriaMobileSubscriberDirectoryNumber *Optional* | +|search_criteria_group_id |List[OCI.searchCriteriaGroupId] |searchCriteriaGroupId *Optional* | +|search_criteria_user_id |List[OCI.searchCriteriaUserId] |searchCriteriaUserId *Optional* | +|search_criteria_user_last_name |List[OCI.searchCriteriaUserLastName] |searchCriteriaUserLastName *Optional* | +|search_criteria_user_first_name |List[OCI.searchCriteriaUserFirstName] |searchCriteriaUserFirstName *Optional* | +|search_criteria_dn |List[OCI.searchCriteriaDn] |searchCriteriaDn *Optional* | +|search_criteria_extension |List[OCI.searchCriteriaExtension] |searchCriteriaExtension *Optional* | +|search_criteria_department_name |List[OCI.searchCriteriaDepartmentName] |searchCriteriaDepartmentName *Optional* | +|search_criteria_exact_mobile_network |List[OCI.searchCriteriaExactMobileNetwork] |searchCriteriaExactMobileNetwork *Optional* | +|search_criteria_exact_mobile_dn_availability |OCI.searchCriteriaExactMobileDnAvailability |searchCriteriaExactMobileDnAvailability *Optional* | +|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | +
+ + +## `EnterpriseCallCenterAgentThresholdProfileGetAvailableAgentPagedSortedListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Get the list of all Agents in the Enterprise that can be assigned to a given Call +Center Agent Threshold Profile in an Enterprise. + +An agent is available to be assigned to a given Agent Threshold Profile if it is a +Call Center Standard or Call Center Premium agent and the agent is not yet assigned to +the profile. If the responsePagingControl element is not provided, the paging +startIndex will be set to 1 by default, and the responsePageSize will be set to the +maximum ResponsePageSize by default. It is possible to search by various criteria to +restrict the number of rows returned. The available agent list for a new Call Center +Agent Threshold profile can be obtained by not setting the +excludeAgentsAssignedToProfileName. When the excludeAgentsAssignedToProfileName is +specified, all agents already assigned to the specified profile are not included in +the response, even if the search criterion element searchCriteriaAgentThresholdProfile +is specified using the same profile name. If no sortOrder is included the response is +sorted by User Id ascending by default. Multiple search criteria are logically ANDed +together unless the searchCriteriaModeOr option is included. Then the search criteria +are logically ORed together. `ErrorResponse()` is returned if +searchCriteriaExactUserGroup has multiple entries and searchCriteriaModeOr is not +included. + +The response is either a +`EnterpriseCallCenterAgentThresholdProfileGetAvailableAgentPagedSortedListResponse()` +or an `ErrorResponse()`. + +**Attributes:** + +|Name |Type |Description | +|----------------------------------------|----------------------------------------------|-----------------------------------------------| +|service_provider_id |str |serviceProviderId | +|exclude_agents_assigned_to_profile_name |str |excludeAgentsAssignedToProfileName *Optional* | +|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | +|sort_order |List[OCI.sortOrder] |sortOrder *Optional* | +|search_criteria_user_id |List[OCI.searchCriteriaUserId] |searchCriteriaUserId *Optional* | +|search_criteria_user_last_name |List[OCI.searchCriteriaUserLastName] |searchCriteriaUserLastName *Optional* | +|search_criteria_user_first_name |List[OCI.searchCriteriaUserFirstName] |searchCriteriaUserFirstName *Optional* | +|search_criteria_dn |List[OCI.searchCriteriaDn] |searchCriteriaDn *Optional* | +|search_criteria_extension |List[OCI.searchCriteriaExtension] |searchCriteriaExtension *Optional* | +|search_criteria_department_name |List[OCI.searchCriteriaDepartmentName] |searchCriteriaDepartmentName *Optional* | +|search_criteria_email_address |List[OCI.searchCriteriaEmailAddress] |searchCriteriaEmailAddress *Optional* | +|search_criteria_agent_threshold_profile |List[OCI.searchCriteriaAgentThresholdProfile] |searchCriteriaAgentThresholdProfile *Optional* | +|search_criteria_exact_user_group |List[OCI.searchCriteriaExactUserGroup] |searchCriteriaExactUserGroup *Optional* | +|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | +
+ + +## `EnterpriseCallCenterAgentThresholdProfileGetPagedSortedRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Gets an existing specified Call Center Agent Threshold Profile in an Enterprise. + +The agentTable is what the search, sort, and pagination fields apply to. If the +responsePagingControl element is not provided, the paging startIndex will be set to 1 +by default, and the responsePageSize will be set to the maximum ResponsePageSize by +default. It is possible to search by various criteria to restrict the number of rows +returned. If no sortOrder is included the response is sorted by User Id ascending by +default. Multiple search criteria are logically ANDed together unless the +searchCriteriaModeOr option is included. Then the search criteria are logically ORed +together. `ErrorResponse()` is returned if searchCriteriaExactUserGroup has multiple +entries and searchCriteriaModeOr is not included. + +The response is either a +`EnterpriseCallCenterAgentThresholdProfileGetPagedSortedResponse()` or an +`ErrorResponse()`. + +**Attributes:** + +|Name |Type |Description | +|---------------------------------|---------------------------------------|----------------------------------------| +|service_provider_id |str |serviceProviderId | +|profile_name |str |profileName | +|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | +|sort_order |List[OCI.sortOrder] |sortOrder *Optional* | +|search_criteria_user_id |List[OCI.searchCriteriaUserId] |searchCriteriaUserId *Optional* | +|search_criteria_user_last_name |List[OCI.searchCriteriaUserLastName] |searchCriteriaUserLastName *Optional* | +|search_criteria_user_first_name |List[OCI.searchCriteriaUserFirstName] |searchCriteriaUserFirstName *Optional* | +|search_criteria_dn |List[OCI.searchCriteriaDn] |searchCriteriaDn *Optional* | +|search_criteria_extension |List[OCI.searchCriteriaExtension] |searchCriteriaExtension *Optional* | +|search_criteria_department_name |List[OCI.searchCriteriaDepartmentName] |searchCriteriaDepartmentName *Optional* | +|search_criteria_exact_user_group |List[OCI.searchCriteriaExactUserGroup] |searchCriteriaExactUserGroup *Optional* | +|search_criteria_group_name |List[OCI.searchCriteriaGroupName] |searchCriteriaGroupName *Optional* | +|search_criteria_email_address |List[OCI.searchCriteriaEmailAddress] |searchCriteriaEmailAddress *Optional* | +|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | +
+ + ## `EnterpriseCallCenterEnhancedReportingScheduledReportAddRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -73135,6 +72071,53 @@ after startDate.
+## `EnterprisePhoneDirectoryGetPagedSortedListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Request a table containing the phone directory for an enterprise. + +The directory includes all users in the enterprise and all entries in the enterprise +common phone list. If the responsePagingControl element is not provided, the paging +startIndex will be set to 1 by default, and the responsePageSize will be set to the +maximum ResponsePageSize by default. It is possible to search by various criteria to +restrict the number of rows returned. If no sortOrder is included the response is +sorted by User Id ascending with a secondary sort by User Last Name ascending by +default. Multiple search criteria are logically ANDed together unless the +searchCriteriaModeOr option is included. Then the search criteria are logically ORed +together. `ErrorResponse()` is returned if searchCriteriaExactUserGroup or +searchCriteriaExactUserDepartment have multiple entries and searchCriteriaModeOr is +not included The following elements are only used in AS data mode and ignored in +Amplify and XS data mode: "sortByImpId" "searchCriteriaImpId" + +The response is either `EnterprisePhoneDirectoryGetPagedSortedListResponse()` or +`ErrorResponse()`. + +**Attributes:** + +|Name |Type |Description | +|--------------------------------------|------------------------------------------|---------------------------------------------| +|enterprise_id |str |enterpriseId | +|is_extended_info_requested |bool |isExtendedInfoRequested | +|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | +|sort_order |List[OCI.sortOrder] |sortOrder *Optional* | +|search_criteria_user_last_name |List[OCI.searchCriteriaUserLastName] |searchCriteriaUserLastName *Optional* | +|search_criteria_user_first_name |List[OCI.searchCriteriaUserFirstName] |searchCriteriaUserFirstName *Optional* | +|search_criteria_dn |List[OCI.searchCriteriaDn] |searchCriteriaDn *Optional* | +|search_criteria_group_location_code |List[OCI.searchCriteriaGroupLocationCode] |searchCriteriaGroupLocationCode *Optional* | +|search_criteria_extension |List[OCI.searchCriteriaExtension] |searchCriteriaExtension *Optional* | +|search_criteria_mobile_phone_number |List[OCI.searchCriteriaMobilePhoneNumber] |searchCriteriaMobilePhoneNumber *Optional* | +|search_criteria_email_address |List[OCI.searchCriteriaEmailAddress] |searchCriteriaEmailAddress *Optional* | +|search_criteria_exact_user_department |OCI.searchCriteriaExactUserDepartment |searchCriteriaExactUserDepartment *Optional* | +|search_criteria_department_name |List[OCI.searchCriteriaDepartmentName] |searchCriteriaDepartmentName *Optional* | +|search_criteria_exact_user_group |OCI.searchCriteriaExactUserGroup |searchCriteriaExactUserGroup *Optional* | +|search_criteria_group_name |List[OCI.searchCriteriaGroupName] |searchCriteriaGroupName *Optional* | +|search_criteria_yahoo_id |List[OCI.searchCriteriaYahooId] |searchCriteriaYahooId *Optional* | +|search_criteria_user_id |List[OCI.searchCriteriaUserId] |searchCriteriaUserId *Optional* | +|search_criteria_imp_id |List[OCI.searchCriteriaImpId] |searchCriteriaImpId *Optional* | +|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | +
+ + ## `EnterpriseSessionAdmissionControlGroupModifyRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -73166,6 +72149,110 @@ parameter needs to be set to "true".
+## `GroupAccessDeviceGetPagedSortedListRequest22`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Requests the list of access devices in a group. + +The response is either `GroupAccessDeviceGetPagedSortedListResponse()` or +`ErrorResponse()`. If no sortOrder is included, the response is sorted by Device Name +ascending by default. If the responsePagingControl element is not provided, the +paging startIndex will be set to 1 by default, and the responsePageSize will be set to +the maximum responsePageSize by default. Multiple search criteria are logically ANDed +together unless the searchCriteriaModeOr option is included. Then the search criteria +are logically ORed together. The getVisualDeviceManagementAPIDevicesOnly element can +only be set when CloudPBX is licenced. If the getVisualDeviceManagementAPIDevicesOnly +element is not set, all devices are returned with Visual Device Management API flag +set to empty. If the getVisualDeviceManagementAPIDevicesOnly element is set to true, +only SIP devices supporting Visual Device Management API are returned. If the +getVisualDeviceManagementAPIDevicesOnly element is set to false, all SIP devices are +returned with their current Visual Device Management API flag value. + +**Attributes:** + +|Name |Type |Description | +|----------------------------------------------|--------------------------------------------|---------------------------------------------------| +|service_provider_id |str |serviceProviderId | +|group_id |str |groupId | +|include_total_number_of_rows |bool |includeTotalNumberOfRows *Optional* | +|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | +|sort_order |List[OCI.sortOrder] |sortOrder *Optional* | +|search_criteria_device_name |List[OCI.searchCriteriaDeviceName] |searchCriteriaDeviceName *Optional* | +|search_criteria_device_mac_address |List[OCI.searchCriteriaDeviceMACAddress] |searchCriteriaDeviceMACAddress *Optional* | +|search_criteria_device_net_address |List[OCI.searchCriteriaDeviceNetAddress] |searchCriteriaDeviceNetAddress *Optional* | +|search_criteria_exact_device_type |List[OCI.searchCriteriaExactDeviceType] |searchCriteriaExactDeviceType *Optional* | +|search_criteria_access_device_version |List[OCI.searchCriteriaAccessDeviceVersion] |searchCriteriaAccessDeviceVersion *Optional* | +|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | +|get_visual_device_management_api_devices_only |bool |getVisualDeviceManagementAPIDevicesOnly *Optional* | +
+ + +## `GroupAdminGetPagedSortedListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Get a list of group and department administrators within the group. + +The response is either a `GroupAdminGetPagedSortedListResponse()` or an +`ErrorResponse()`. If no sort criterion is included, the response is sorted by +administrator id ascending by default. If the responsePagingControl element is not +provided, the paging startIndex will be set to 1 by default, and the responsePageSize +will be set to the maximum responsePageSize by default. Multiple search criteria are +logically ANDed together unless the searchCriteriaModeOr option is included. Then the +search criteria are logically ORed together. + +**Attributes:** + +|Name |Type |Description | +|---------------------------------------|--------------------------------------------|---------------------------------------------| +|service_provider_id |str |serviceProviderId | +|group_id |str |groupId | +|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | +|sort_order |List[OCI.sortOrder] |sortOrder *Optional* | +|search_criteria_admin_id |List[OCI.searchCriteriaAdminId] |searchCriteriaAdminId *Optional* | +|search_criteria_admin_last_name |List[OCI.searchCriteriaAdminLastName] |searchCriteriaAdminLastName *Optional* | +|search_criteria_admin_first_name |List[OCI.searchCriteriaAdminFirstName] |searchCriteriaAdminFirstName *Optional* | +|search_criteria_exact_group_admin_type |List[OCI.searchCriteriaExactGroupAdminType] |searchCriteriaExactGroupAdminType *Optional* | +|search_criteria_language |List[OCI.searchCriteriaLanguage] |searchCriteriaLanguage *Optional* | +|search_criteria_department_name |List[OCI.searchCriteriaDepartmentName] |searchCriteriaDepartmentName *Optional* | +|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | +
+ + +## `GroupAutoAttendantGetInstancePagedSortedListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Get a list of Auto Attendant instances within a group. + +The response is either `GroupAutoAttendantGetInstancePagedSortedListResponse()` or +`ErrorResponse()`. If no sortOrder is included the response is sorted by Name +ascending by default. A limitation to the search by DN activation exists when the +Number Activation mode is set to Off. In this case DNs not assigned to users are +never returned by queries with the "dnActivationSearchCriteria" included. If the +responsePagingControl element is not provided, the paging startIndex will be set to 1 +by default, and the responsePageSize will be set to the maximum responsePageSize by +default. Multiple search criteria are logically ANDed together unless the +searchCriteriaModeOr option is included. Then the search criteria are logically ORed +together. + +**Attributes:** + +|Name |Type |Description | +|------------------------------------------|-----------------------------------------|------------------------------------------------| +|service_provider_id |str |serviceProviderId | +|group_id |str |groupId | +|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | +|sort_order |List[OCI.sortOrder] |sortOrder *Optional* | +|search_criteria_user_id |List[OCI.searchCriteriaUserId] |searchCriteriaUserId *Optional* | +|search_criteria_user_last_name |List[OCI.searchCriteriaUserLastName] |searchCriteriaUserLastName *Optional* | +|search_criteria_dn |List[OCI.searchCriteriaDn] |searchCriteriaDn *Optional* | +|search_criteria_extension |List[OCI.searchCriteriaExtension] |searchCriteriaExtension *Optional* | +|search_criteria_exact_dn_activation |OCI.searchCriteriaExactDnActivation |searchCriteriaExactDnActivation *Optional* | +|search_criteria_service_status |OCI.searchCriteriaServiceStatus |searchCriteriaServiceStatus *Optional* | +|search_criteria_exact_auto_attendant_type |OCI.searchCriteriaExactAutoAttendantType |searchCriteriaExactAutoAttendantType *Optional* | +|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | +
+ + ## `GroupAutoAttendantSubmenuAddRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -73258,6 +72345,89 @@ valid for Standard auto attendants.
+## `GroupCallCenterAgentThresholdProfileGetAvailableAgentPagedSortedListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Get the list of all Agents in the Group that can be assigned to a given Call Center +Agent Threshold Profile in a Group. + +An agent is available to be assigned to a given Agent Threshold Profile if it is a +Call Center Standard or Call Center Premium agent and the agent is not yet assigned to +the profile. If the responsePagingControl element is not provided, the paging +startIndex will be set to 1 by default, and the responsePageSize will be set to the +maximum ResponsePageSize by default. It is possible to search by various criteria to +restrict the number of rows returned. The available agent list for a new Call Center +Agent Threshold profile can be obtained by not setting the +excludeAgentsAssignedToProfileName. When the excludeAgentsAssignedToProfileName is +specified, all agents already assigned to the specified profile are not included in +the response, even if the search criterion element searchCriteriaAgentThresholdProfile +is specified using the same profile name. If no sortOrder is included the response is +sorted by User Id ascending by default. Multiple search criteria are logically ANDed +together unless the searchCriteriaModeOr option is included. Then the search criteria +are logically ORed together. + +The response is either a +`GroupCallCenterAgentThresholdProfileGetAvailableAgentPagedSortedListResponse()` or an +`ErrorResponse()`. + +**Attributes:** + +|Name |Type |Description | +|----------------------------------------|----------------------------------------------|-----------------------------------------------| +|service_provider_id |str |serviceProviderId | +|group_id |str |groupId | +|exclude_agents_assigned_to_profile_name |str |excludeAgentsAssignedToProfileName *Optional* | +|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | +|sort_order |List[OCI.sortOrder] |sortOrder *Optional* | +|search_criteria_user_id |List[OCI.searchCriteriaUserId] |searchCriteriaUserId *Optional* | +|search_criteria_user_last_name |List[OCI.searchCriteriaUserLastName] |searchCriteriaUserLastName *Optional* | +|search_criteria_user_first_name |List[OCI.searchCriteriaUserFirstName] |searchCriteriaUserFirstName *Optional* | +|search_criteria_dn |List[OCI.searchCriteriaDn] |searchCriteriaDn *Optional* | +|search_criteria_extension |List[OCI.searchCriteriaExtension] |searchCriteriaExtension *Optional* | +|search_criteria_department_name |List[OCI.searchCriteriaDepartmentName] |searchCriteriaDepartmentName *Optional* | +|search_criteria_email_address |List[OCI.searchCriteriaEmailAddress] |searchCriteriaEmailAddress *Optional* | +|search_criteria_agent_threshold_profile |List[OCI.searchCriteriaAgentThresholdProfile] |searchCriteriaAgentThresholdProfile *Optional* | +|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | +
+ + +## `GroupCallCenterAgentThresholdProfileGetPagedSortedRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Gets an existing non-default Call Center Agent Threshold Profile in a Group. + +If the responsePagingControl element is not provided, the paging startIndex will be +set to 1 by default, and the responsePageSize will be set to the maximum +ResponsePageSize by default. It is possible to search by various criteria to restrict +the number of rows returned. If no sortOrder is included the response is sorted by +User Id ascending by default. Multiple search criteria are logically ANDed together +unless the searchCriteriaModeOr option is included. Then the search criteria are +logically ORed together. + +The response is either a +`GroupCallCenterAgentThresholdProfileGetPagedSortedResponse()` or an +`ErrorResponse()`. + +**Attributes:** + +|Name |Type |Description | +|--------------------------------|---------------------------------------|----------------------------------------| +|service_provider_id |str |serviceProviderId | +|group_id |str |groupId | +|profile_name |str |profileName | +|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | +|sort_order |List[OCI.sortOrder] |sortOrder *Optional* | +|search_criteria_user_id |List[OCI.searchCriteriaUserId] |searchCriteriaUserId *Optional* | +|search_criteria_user_last_name |List[OCI.searchCriteriaUserLastName] |searchCriteriaUserLastName *Optional* | +|search_criteria_user_first_name |List[OCI.searchCriteriaUserFirstName] |searchCriteriaUserFirstName *Optional* | +|search_criteria_dn |List[OCI.searchCriteriaDn] |searchCriteriaDn *Optional* | +|search_criteria_extension |List[OCI.searchCriteriaExtension] |searchCriteriaExtension *Optional* | +|search_criteria_department_name |List[OCI.searchCriteriaDepartmentName] |searchCriteriaDepartmentName *Optional* | +|search_criteria_email_address |List[OCI.searchCriteriaEmailAddress] |searchCriteriaEmailAddress *Optional* | +|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | +
+ + ## `GroupCallCenterEnhancedReportingScheduledReportAddRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -73308,31 +72478,108 @@ after startDate. **Attributes:** -|Name |Type |Description | -|-----------------------------------|----------------------------------|-------------------------------------------| -|service_provider_id |str |serviceProviderId | -|group_id |str |groupId | -|name |str |name | -|new_name |str |newName *Optional* | -|description |str |description *Optional* | -|schedule |OCI.schedule |schedule *Optional* | -|sampling_period |str |samplingPeriod *Optional* | -|start_day_of_week |str |startDayOfWeek *Optional* | -|report_time_zone |str |reportTimeZone *Optional* | -|report_date_format |str |reportDateFormat *Optional* | -|report_time_format |str |reportTimeFormat *Optional* | -|report_interval |OCI.reportInterval |reportInterval *Optional* | -|report_format |str |reportFormat *Optional* | -|agent |OCI.agent |agent *Optional* | -|call_center |OCI.callCenter |callCenter *Optional* | -|dnis |OCI.dnis |dnis *Optional* | -|call_completion_threshold_seconds |int |callCompletionThresholdSeconds *Optional* | -|short_duration_threshold_seconds |int |shortDurationThresholdSeconds *Optional* | -|service_level_threshold_seconds |OCI.serviceLevelThresholdSeconds |serviceLevelThresholdSeconds *Optional* | -|service_level_inclusions |OCI.serviceLevelInclusions |serviceLevelInclusions *Optional* | -|service_level_objective_percentage |int |serviceLevelObjectivePercentage *Optional* | -|abandoned_call_threshold_seconds |OCI.abandonedCallThresholdSeconds |abandonedCallThresholdSeconds *Optional* | -|email_address |OCI.emailAddress |emailAddress *Optional* | +|Name |Type |Description | +|-----------------------------------|----------------------------------|-------------------------------------------| +|service_provider_id |str |serviceProviderId | +|group_id |str |groupId | +|name |str |name | +|new_name |str |newName *Optional* | +|description |str |description *Optional* | +|schedule |OCI.schedule |schedule *Optional* | +|sampling_period |str |samplingPeriod *Optional* | +|start_day_of_week |str |startDayOfWeek *Optional* | +|report_time_zone |str |reportTimeZone *Optional* | +|report_date_format |str |reportDateFormat *Optional* | +|report_time_format |str |reportTimeFormat *Optional* | +|report_interval |OCI.reportInterval |reportInterval *Optional* | +|report_format |str |reportFormat *Optional* | +|agent |OCI.agent |agent *Optional* | +|call_center |OCI.callCenter |callCenter *Optional* | +|dnis |OCI.dnis |dnis *Optional* | +|call_completion_threshold_seconds |int |callCompletionThresholdSeconds *Optional* | +|short_duration_threshold_seconds |int |shortDurationThresholdSeconds *Optional* | +|service_level_threshold_seconds |OCI.serviceLevelThresholdSeconds |serviceLevelThresholdSeconds *Optional* | +|service_level_inclusions |OCI.serviceLevelInclusions |serviceLevelInclusions *Optional* | +|service_level_objective_percentage |int |serviceLevelObjectivePercentage *Optional* | +|abandoned_call_threshold_seconds |OCI.abandonedCallThresholdSeconds |abandonedCallThresholdSeconds *Optional* | +|email_address |OCI.emailAddress |emailAddress *Optional* | +
+ + +## `GroupCallCenterGetAvailableAgentPagedSortedListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Get a list of users that can be assigned as agents to a given type of Call Center. + +Searching for users by group only makes sense when the call center is part of an +Enterprise. If the responsePagingControl element is not provided, the paging +startIndex will be set to 1 by default, and the responsePageSize will be set to the +maximum ResponsePageSize by default. It is possible to search by various criteria to +restrict the number of rows returned. If no sortOrder is included the response is +sorted by User Id ascending by default. Multiple search criteria are logically ANDed +together unless the searchCriteriaModeOr option is included. Then the search criteria +are logically ORed together. `ErrorResponse()` is returned if +searchCriteriaExactUserGroup has multiple entries and searchCriteriaModeOr is not +included. + +The response is either `GroupCallCenterGetAvailableAgentPagedSortedListResponse()` or +`ErrorResponse()`. + +**Attributes:** + +|Name |Type |Description | +|---------------------------------|---------------------------------------|----------------------------------------| +|service_provider_id |str |serviceProviderId | +|group_id |str |groupId | +|call_center_type |str |callCenterType | +|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | +|sort_order |List[OCI.sortOrder] |sortOrder *Optional* | +|search_criteria_user_id |List[OCI.searchCriteriaUserId] |searchCriteriaUserId *Optional* | +|search_criteria_user_last_name |List[OCI.searchCriteriaUserLastName] |searchCriteriaUserLastName *Optional* | +|search_criteria_user_first_name |List[OCI.searchCriteriaUserFirstName] |searchCriteriaUserFirstName *Optional* | +|search_criteria_dn |List[OCI.searchCriteriaDn] |searchCriteriaDn *Optional* | +|search_criteria_extension |List[OCI.searchCriteriaExtension] |searchCriteriaExtension *Optional* | +|search_criteria_department_name |List[OCI.searchCriteriaDepartmentName] |searchCriteriaDepartmentName *Optional* | +|search_criteria_email_address |List[OCI.searchCriteriaEmailAddress] |searchCriteriaEmailAddress *Optional* | +|search_criteria_exact_user_group |List[OCI.searchCriteriaExactUserGroup] |searchCriteriaExactUserGroup *Optional* | +|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | +
+ + +## `GroupCallCenterGetInstancePagedSortedListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Get a list of Call Center instances within a group. + +The response is either `GroupCallCenterGetInstancePagedSortedListResponse()` or +`ErrorResponse()`. It is possible to get the instances within a specified department. +If the responsePagingControl element is not provided, the paging startIndex will be +set to 1 by default, and the responsePageSize will be set to the maximum +ResponsePageSize by default. It is possible to search by various criteria to restrict +the number of rows returned. If no sortOrder is included the response is sorted by +User Id ascending by default. Multiple search criteria are logically ANDed together +unless the searchCriteriaModeOr option is included. Then the search criteria are +logically ORed together. `ErrorResponse()` is returned if +searchCriteriaExactHuntPolicy or searchCriteriaExactCallCenterType have multiple +entries and searchCriteriaModeOr is not include. + +**Attributes:** + +|Name |Type |Description | +|---------------------------------------|--------------------------------------------|---------------------------------------------| +|service_provider_id |str |serviceProviderId | +|group_id |str |groupId | +|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | +|sort_order |List[OCI.sortOrder] |sortOrder *Optional* | +|search_criteria_user_id |List[OCI.searchCriteriaUserId] |searchCriteriaUserId *Optional* | +|search_criteria_call_center_name |List[OCI.searchCriteriaCallCenterName] |searchCriteriaCallCenterName *Optional* | +|search_criteria_dn |List[OCI.searchCriteriaDn] |searchCriteriaDn *Optional* | +|search_criteria_extension |List[OCI.searchCriteriaExtension] |searchCriteriaExtension *Optional* | +|search_criteria_department_name |List[OCI.searchCriteriaDepartmentName] |searchCriteriaDepartmentName *Optional* | +|search_criteria_service_status |OCI.searchCriteriaServiceStatus |searchCriteriaServiceStatus *Optional* | +|search_criteria_exact_hunt_policy |List[OCI.searchCriteriaExactHuntPolicy] |searchCriteriaExactHuntPolicy *Optional* | +|search_criteria_exact_call_center_type |List[OCI.searchCriteriaExactCallCenterType] |searchCriteriaExactCallCenterType *Optional* | +|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* |
@@ -73535,6 +72782,151 @@ The response is either a `SuccessResponse()` or an `ErrorResponse()`. +## `GroupCallParkGetAvailableAlternateRecallUserPagedSortedListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Get a list of hunt groups that are available to select as an alternate recall user. + +If the responsePagingControl element is not provided, the paging startIndex will be +set to 1 by default, and the responsePageSize will be set to the maximum +ResponsePageSize by default. It is possible to search by various criteria to restrict +the number of rows returned. If no sortOrder is included the response is sorted by +User Id ascending by default. Multiple search criteria are logically ANDed together +unless the searchCriteriaModeOr option is included. Then the search criteria are +logically ORed together. + +The response is either +`GroupCallParkGetAvailableAlternateRecallUserPagedSortedListResponse()` or +`ErrorResponse()`. + +**Attributes:** + +|Name |Type |Description | +|--------------------------------|---------------------------------------|----------------------------------------| +|service_provider_id |str |serviceProviderId | +|group_id |str |groupId | +|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | +|sort_order |List[OCI.sortOrder] |sortOrder *Optional* | +|search_criteria_user_id |List[OCI.searchCriteriaUserId] |searchCriteriaUserId *Optional* | +|search_criteria_user_last_name |List[OCI.searchCriteriaUserLastName] |searchCriteriaUserLastName *Optional* | +|search_criteria_user_first_name |List[OCI.searchCriteriaUserFirstName] |searchCriteriaUserFirstName *Optional* | +|search_criteria_dn |List[OCI.searchCriteriaDn] |searchCriteriaDn *Optional* | +|search_criteria_extension |List[OCI.searchCriteriaExtension] |searchCriteriaExtension *Optional* | +|search_criteria_department_name |List[OCI.searchCriteriaDepartmentName] |searchCriteriaDepartmentName *Optional* | +|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | +
+ + +## `GroupCallParkGetAvailableUserPagedSortedListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Get a list of users that can be assigned to a Call Park group. + +The available user list for a new Call Park group can be obtained by not setting the +name. If the responsePagingControl element is not provided, the paging startIndex +will be set to 1 by default, and the responsePageSize will be set to the maximum +ResponsePageSize by default. It is possible to search by various criteria to restrict +the number of rows returned. If no sortOrder is included the response is sorted by +User Id ascending by default. Multiple search criteria are logically ANDed together +unless the searchCriteriaModeOr option is included. Then the search criteria are +logically ORed together. + +The response is either `GroupCallParkGetAvailableUserPagedSortedListResponse()` or +`ErrorResponse()`. + +**Attributes:** + +|Name |Type |Description | +|--------------------------------|---------------------------------------|----------------------------------------| +|service_provider_id |str |serviceProviderId | +|group_id |str |groupId | +|name |str |name *Optional* | +|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | +|sort_order |List[OCI.sortOrder] |sortOrder *Optional* | +|search_criteria_user_id |List[OCI.searchCriteriaUserId] |searchCriteriaUserId *Optional* | +|search_criteria_user_last_name |List[OCI.searchCriteriaUserLastName] |searchCriteriaUserLastName *Optional* | +|search_criteria_user_first_name |List[OCI.searchCriteriaUserFirstName] |searchCriteriaUserFirstName *Optional* | +|search_criteria_dn |List[OCI.searchCriteriaDn] |searchCriteriaDn *Optional* | +|search_criteria_extension |List[OCI.searchCriteriaExtension] |searchCriteriaExtension *Optional* | +|search_criteria_department_name |List[OCI.searchCriteriaDepartmentName] |searchCriteriaDepartmentName *Optional* | +|search_criteria_email_address |List[OCI.searchCriteriaEmailAddress] |searchCriteriaEmailAddress *Optional* | +|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | +
+ + +## `GroupCallPickupGetAvailableUserPagedSortedListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Get a list of users that can be assigned to a Call Pickup group. + +The available user list for a new Call Pickup group can be obtained by not setting the +name. If the responsePagingControl element is not provided, the paging startIndex +will be set to 1 by default, and the responsePageSize will be set to the maximum +ResponsePageSize by default. It is possible to search by various criteria to restrict +the number of rows returned. If no sortOrder is included the response is sorted by +User Id ascending by default. Multiple search criteria are logically ANDed together +unless the searchCriteriaModeOr option is included. Then the search criteria are +logically ORed together. + +The response is either `GroupCallPickupGetAvailableUserPagedSortedListResponse()` or +`ErrorResponse()`. + +**Attributes:** + +|Name |Type |Description | +|--------------------------------|---------------------------------------|----------------------------------------| +|service_provider_id |str |serviceProviderId | +|group_id |str |groupId | +|name |str |name *Optional* | +|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | +|sort_order |List[OCI.sortOrder] |sortOrder *Optional* | +|search_criteria_user_id |List[OCI.searchCriteriaUserId] |searchCriteriaUserId *Optional* | +|search_criteria_user_last_name |List[OCI.searchCriteriaUserLastName] |searchCriteriaUserLastName *Optional* | +|search_criteria_user_first_name |List[OCI.searchCriteriaUserFirstName] |searchCriteriaUserFirstName *Optional* | +|search_criteria_dn |List[OCI.searchCriteriaDn] |searchCriteriaDn *Optional* | +|search_criteria_extension |List[OCI.searchCriteriaExtension] |searchCriteriaExtension *Optional* | +|search_criteria_department_name |List[OCI.searchCriteriaDepartmentName] |searchCriteriaDepartmentName *Optional* | +|search_criteria_email_address |List[OCI.searchCriteriaEmailAddress] |searchCriteriaEmailAddress *Optional* | +|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | +
+ + +## `GroupCallPickupGetInstancePagedSortedRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Gets a Call Pickup group. + +If the responsePagingControl element is not provided, the paging startIndex will be +set to 1 by default, and the responsePageSize will be set to the maximum +ResponsePageSize by default. It is possible to search by various criteria to restrict +the number of rows returned. Multiple search criteria are logically ANDed together +unless the searchCriteriaModeOr option is included. Then the search criteria are +logically ORed together. If no sortOrder is included the response is sorted by User +Id ascending by default. + +The response is either `GroupCallPickupGetInstancePagedSortedResponse()` or +`ErrorResponse()`. + +**Attributes:** + +|Name |Type |Description | +|--------------------------------|---------------------------------------|----------------------------------------| +|service_provider_id |str |serviceProviderId | +|group_id |str |groupId | +|name |str |name | +|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | +|sort_order |List[OCI.sortOrder] |sortOrder *Optional* | +|search_criteria_user_id |List[OCI.searchCriteriaUserId] |searchCriteriaUserId *Optional* | +|search_criteria_user_last_name |List[OCI.searchCriteriaUserLastName] |searchCriteriaUserLastName *Optional* | +|search_criteria_user_first_name |List[OCI.searchCriteriaUserFirstName] |searchCriteriaUserFirstName *Optional* | +|search_criteria_dn |List[OCI.searchCriteriaDn] |searchCriteriaDn *Optional* | +|search_criteria_extension |List[OCI.searchCriteriaExtension] |searchCriteriaExtension *Optional* | +|search_criteria_department_name |List[OCI.searchCriteriaDepartmentName] |searchCriteriaDepartmentName *Optional* | +|search_criteria_email_address |List[OCI.searchCriteriaEmailAddress] |searchCriteriaEmailAddress *Optional* | +|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | +
+ + ## `GroupCollaborateBridgeConsolidatedModifyInstanceRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -73575,6 +72967,119 @@ The response is either `SuccessResponse()` or `ErrorResponse()`.
+## `GroupCollaborateBridgeGetAvailableUserPagedSortedListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Get a list of users with the Collaborate – Audio service assigned that can be assigned +to a collaborate bridge. + +For an Enterprise Group this will include all users in the group’s enterprise. The +searchCriteriaGroupId parameter is only applicable for enterprise groups. If no +sortOrder is included the response is sorted by Last Name ascending by default. A +limitation to the search by DN activation exists when the Number Activation mode is +set to Off. In this case DNs not assigned to users are never returned by queries with +the "dnActivationSearchCriteria" included. Multiple search criteria are logically +ANDed together unless the searchCriteriaModeOr option is included. Then the search +criteria are logically ORed together. + +The response is either +`GroupCollaborateBridgeGetAvailableUserPagedSortedListResponse()` or +`ErrorResponse()`. + +**Attributes:** + +|Name |Type |Description | +|------------------------------------|---------------------------------------|-------------------------------------------| +|service_provider_id |str |serviceProviderId | +|group_id |str |groupId | +|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | +|sort_order |List[OCI.sortOrder] |sortOrder *Optional* | +|search_criteria_user_last_name |List[OCI.searchCriteriaUserLastName] |searchCriteriaUserLastName *Optional* | +|search_criteria_user_first_name |List[OCI.searchCriteriaUserFirstName] |searchCriteriaUserFirstName *Optional* | +|search_criteria_department_name |List[OCI.searchCriteriaDepartmentName] |searchCriteriaDepartmentName *Optional* | +|search_criteria_group_id |List[OCI.searchCriteriaGroupId] |searchCriteriaGroupId *Optional* | +|search_criteria_user_id |List[OCI.searchCriteriaUserId] |searchCriteriaUserId *Optional* | +|search_criteria_dn |List[OCI.searchCriteriaDn] |searchCriteriaDn *Optional* | +|search_criteria_extension |List[OCI.searchCriteriaExtension] |searchCriteriaExtension *Optional* | +|search_criteria_exact_dn_activation |OCI.searchCriteriaExactDnActivation |searchCriteriaExactDnActivation *Optional* | +|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | +
+ + +## `GroupCollaborateBridgeGetInstancePagedSortedListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Get a list of collaborate bridges within a group. + +The response is either `GroupCollaborateBridgeGetInstancePagedSortedListResponse()` or +`ErrorResponse()`. If the responsePagingControl element is not provided, the paging +startIndex will be set to 1 by default, and the responsePageSize will be set to the +maximum responsePageSize by default. If no sortOrder is included the response is +sorted by Name ascending by default. . Multiple search criteria are logically ANDed +together unless the searchCriteriaModeOr option is included. Then the search criteria +are logically ORed together. + +**Attributes:** + +|Name |Type |Description | +|------------------------------------|---------------------------------------|-------------------------------------------| +|service_provider_id |str |serviceProviderId | +|group_id |str |groupId | +|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | +|sort_order |List[OCI.sortOrder] |sortOrder *Optional* | +|search_criteria_user_last_name |List[OCI.searchCriteriaUserLastName] |searchCriteriaUserLastName *Optional* | +|search_criteria_department_name |List[OCI.searchCriteriaDepartmentName] |searchCriteriaDepartmentName *Optional* | +|search_criteria_user_id |List[OCI.searchCriteriaUserId] |searchCriteriaUserId *Optional* | +|search_criteria_dn |List[OCI.searchCriteriaDn] |searchCriteriaDn *Optional* | +|search_criteria_extension |List[OCI.searchCriteriaExtension] |searchCriteriaExtension *Optional* | +|search_criteria_exact_dn_activation |OCI.searchCriteriaExactDnActivation |searchCriteriaExactDnActivation *Optional* | +|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | +
+ + +## `GroupDnGetAssignmentPagedSortedListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Get the list of assigned and unassigned DNs in a group. + +Each DN can be assigned to a user and/or department. Ranges of DNs with identical +assignment and activation properties are coalesced to a single table row entry. Dns +assigned to the IMRN pool are not listed in the response. If the +responsePagingControl element is not provided, the paging startIndex will be set to 1 +by default, and the responsePageSize will be set to the maximum ResponsePageSize by +default. If no sortOrder is included the response is sorted by Phone Number by +default. Multiple search criteria are logically ANDed together unless the +searchCriteriaModeOr option is included. Then the search criterion are logically ORed +together. The department in both the search criteria and sort by fields refer to the +department to which the dn belongs. A limitation to the search by DN activation +exists when the Number Activation mode is set to Off. In this case DNs not assigned +to users are never returned by queries with the "dnActivationSearchCriteria" included. + +The response is either a `GroupDnGetAssignmentPagedSortedListResponse()` or an +`ErrorResponse()`. + +**Attributes:** + +|Name |Type |Description | +|--------------------------------------|---------------------------------------|---------------------------------------------| +|service_provider_id |str |serviceProviderId | +|group_id |str |groupId | +|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | +|sort_order |List[OCI.sortOrder] |sortOrder *Optional* | +|search_criteria_dn |List[OCI.searchCriteriaDn] |searchCriteriaDn *Optional* | +|search_criteria_department_name |List[OCI.searchCriteriaDepartmentName] |searchCriteriaDepartmentName *Optional* | +|search_criteria_exact_dn_activation |OCI.searchCriteriaExactDnActivation |searchCriteriaExactDnActivation *Optional* | +|search_criteria_exact_dn_availability |OCI.searchCriteriaExactDnAvailability |searchCriteriaExactDnAvailability *Optional* | +|search_criteria_user_id |List[OCI.searchCriteriaUserId] |searchCriteriaUserId *Optional* | +|search_criteria_user_first_name |List[OCI.searchCriteriaUserFirstName] |searchCriteriaUserFirstName *Optional* | +|search_criteria_user_last_name |List[OCI.searchCriteriaUserLastName] |searchCriteriaUserLastName *Optional* | +|search_criteria_exact_user_type |List[OCI.searchCriteriaExactUserType] |searchCriteriaExactUserType *Optional* | +|search_criteria_extension |List[OCI.searchCriteriaExtension] |searchCriteriaExtension *Optional* | +|search_criteria_email_address |List[OCI.searchCriteriaEmailAddress] |searchCriteriaEmailAddress *Optional* | +|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | +
+ + ## `GroupFlexibleSeatingHostModifyInstanceRequest22`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -73593,6 +73098,33 @@ The response is either `SuccessResponse()` or `ErrorResponse()`.
+## `GroupGetListInServiceProviderPagedSortedListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Request the list of groups in a service provider or enterprise. + +If no sortOrder is included, the response is sorted by Group Id ascending by default. + +The response is either a `GroupGetListInServiceProviderPagedSortedListResponse()` or +an `ErrorResponse()`. If the responsePagingControl element is not provided, the paging +startIndex will be set to 1 by default, and the responsePageSize will be set to the +maximum responsePageSize by default. Multiple search criteria are logically ANDed +together unless the searchCriteriaModeOr option is included. Then the search criteria +are logically ORed together. + +**Attributes:** + +|Name |Type |Description | +|---------------------------|----------------------------------|-----------------------------------| +|service_provider_id |str |serviceProviderId | +|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | +|sort_order |List[OCI.sortOrder] |sortOrder *Optional* | +|search_criteria_group_id |List[OCI.searchCriteriaGroupId] |searchCriteriaGroupId *Optional* | +|search_criteria_group_name |List[OCI.searchCriteriaGroupName] |searchCriteriaGroupName *Optional* | +|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | +
+ + ## `GroupHuntGroupConsolidatedModifyInstanceRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -73649,6 +73181,78 @@ includeHuntGroupNameInCLID
+## `GroupHuntGroupGetAvailableUserPagedSortedListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Get a list of users that can be assigned to a Hunt Group group. + +Searching for users by group only makes sense when the hunt group is part of an +Enterprise. A limitation to the search by DN activation exists when the Number +Activation mode is set to Off. In this case DNs not assigned to users are never +returned by queries with the "dnActivationSearchCriteria" included. + +The response is either `GroupHuntGroupGetAvailableUserPagedSortedListResponse()` or +`ErrorResponse()`. If no sortOrder is included, the response is sorted by User Id +ascending by default. If the responsePagingControl element is not provided, the +paging startIndex will be set to 1 by default, and the responsePageSize will be set to +the maximum responsePageSize by default. Multiple search criteria are logically ANDed +together unless the searchCriteriaModeOr option is included. Then the search criteria +are logically ORed together. + +**Attributes:** + +|Name |Type |Description | +|------------------------------------|---------------------------------------|-------------------------------------------| +|service_provider_id |str |serviceProviderId | +|group_id |str |groupId | +|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | +|sort_order |List[OCI.sortOrder] |sortOrder *Optional* | +|search_criteria_user_last_name |List[OCI.searchCriteriaUserLastName] |searchCriteriaUserLastName *Optional* | +|search_criteria_user_first_name |List[OCI.searchCriteriaUserFirstName] |searchCriteriaUserFirstName *Optional* | +|search_criteria_department_name |List[OCI.searchCriteriaDepartmentName] |searchCriteriaDepartmentName *Optional* | +|search_criteria_group_id |List[OCI.searchCriteriaGroupId] |searchCriteriaGroupId *Optional* | +|search_criteria_user_id |List[OCI.searchCriteriaUserId] |searchCriteriaUserId *Optional* | +|search_criteria_dn |List[OCI.searchCriteriaDn] |searchCriteriaDn *Optional* | +|search_criteria_extension |List[OCI.searchCriteriaExtension] |searchCriteriaExtension *Optional* | +|search_criteria_exact_dn_activation |OCI.searchCriteriaExactDnActivation |searchCriteriaExactDnActivation *Optional* | +|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | +
+ + +## `GroupHuntGroupGetInstancePagedSortedListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Get a list of Hunt Group instances within a group. + +The response is either `GroupHuntGroupGetInstancePagedSortedListResponse()` or +`ErrorResponse()`. It is possible to get the instances within a specified department. +The department in both the search criteria and sort by fields refer to the department +to which the dn belongs. If no sortOrder is included, the response is sorted by User +Id ascending by default. If the responsePagingControl element is not provided, the +paging startIndex will be set to 1 by default, and the responsePageSize will be set to +the maximum responsePageSize by default. Multiple search criteria are logically ANDed +together unless the searchCriteriaModeOr option is included. Then the search criteria +are logically ORed together. + +**Attributes:** + +|Name |Type |Description | +|------------------------------------|---------------------------------------|-------------------------------------------| +|service_provider_id |str |serviceProviderId | +|group_id |str |groupId | +|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | +|sort_order |List[OCI.sortOrder] |sortOrder *Optional* | +|search_criteria_user_last_name |List[OCI.searchCriteriaUserLastName] |searchCriteriaUserLastName *Optional* | +|search_criteria_department_name |List[OCI.searchCriteriaDepartmentName] |searchCriteriaDepartmentName *Optional* | +|search_criteria_user_id |List[OCI.searchCriteriaUserId] |searchCriteriaUserId *Optional* | +|search_criteria_dn |List[OCI.searchCriteriaDn] |searchCriteriaDn *Optional* | +|search_criteria_extension |List[OCI.searchCriteriaExtension] |searchCriteriaExtension *Optional* | +|search_criteria_exact_dn_activation |OCI.searchCriteriaExactDnActivation |searchCriteriaExactDnActivation *Optional* | +|search_criteria_service_status |OCI.searchCriteriaServiceStatus |searchCriteriaServiceStatus *Optional* | +|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | +
+ + ## `GroupOutgoingCallingPlanDigitPlanCallMeNowModifyListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -73763,6 +73367,57 @@ The response is either a `SuccessResponse()` or an `ErrorResponse()`.
+## `GroupPhoneDirectoryGetPagedSortedListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Request a table containing the phone directory for a group. + +The directory includes all users in the group and all entries in the group common +phone list. If the specified group is part of an enterprise, the directory includes +all users in the enterprise and all entries in the enterprise common phone list and +the common phone list of the specified group. If the specified group is part of a +service provider, the directory includes all users in the group and all entries in the +common phone list of the specified group. If the responsePagingControl element is not +provided, the paging startIndex will be set to 1 by default, and the responsePageSize +will be set to the maximum ResponsePageSize by default. It is possible to search by +various criteria to restrict the number of rows returned. If no sortOrder is included +the response is sorted by User Id ascending with a secondary sort by User Last Name +ascending by default. Multiple search criteria are logically ANDed together unless +the searchCriteriaModeOr option is included. Then the search criteria are logically +ORed together. `ErrorResponse()` is returned if searchCriteriaExactUserGroup or +searchCriteriaExactUserDepartment have multiple entries and searchCriteriaModeOr is +not included. The following elements are only used in AS data mode and ignored in +Amplify and XS data mode: "sortByImpId" "searchCriteriaImpId" + +The response is either `GroupPhoneDirectoryGetPagedSortedListResponse()` or +`ErrorResponse()`. + +**Attributes:** + +|Name |Type |Description | +|--------------------------------------|------------------------------------------|---------------------------------------------| +|service_provider_id |str |serviceProviderId | +|group_id |str |groupId | +|is_extended_info_requested |bool |isExtendedInfoRequested | +|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | +|sort_order |List[OCI.sortOrder] |sortOrder *Optional* | +|search_criteria_user_last_name |List[OCI.searchCriteriaUserLastName] |searchCriteriaUserLastName *Optional* | +|search_criteria_user_first_name |List[OCI.searchCriteriaUserFirstName] |searchCriteriaUserFirstName *Optional* | +|search_criteria_dn |List[OCI.searchCriteriaDn] |searchCriteriaDn *Optional* | +|search_criteria_group_location_code |List[OCI.searchCriteriaGroupLocationCode] |searchCriteriaGroupLocationCode *Optional* | +|search_criteria_extension |List[OCI.searchCriteriaExtension] |searchCriteriaExtension *Optional* | +|search_criteria_mobile_phone_number |List[OCI.searchCriteriaMobilePhoneNumber] |searchCriteriaMobilePhoneNumber *Optional* | +|search_criteria_email_address |List[OCI.searchCriteriaEmailAddress] |searchCriteriaEmailAddress *Optional* | +|search_criteria_exact_user_department |OCI.searchCriteriaExactUserDepartment |searchCriteriaExactUserDepartment *Optional* | +|search_criteria_department_name |List[OCI.searchCriteriaDepartmentName] |searchCriteriaDepartmentName *Optional* | +|search_criteria_exact_user_group |OCI.searchCriteriaExactUserGroup |searchCriteriaExactUserGroup *Optional* | +|search_criteria_yahoo_id |List[OCI.searchCriteriaYahooId] |searchCriteriaYahooId *Optional* | +|search_criteria_user_id |List[OCI.searchCriteriaUserId] |searchCriteriaUserId *Optional* | +|search_criteria_imp_id |List[OCI.searchCriteriaImpId] |searchCriteriaImpId *Optional* | +|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | +
+ + ## `GroupRoutePointModifyAnnouncementRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -73827,6 +73482,65 @@ The response is either a `SuccessResponse()` or an `ErrorResponse()`.
+## `ServiceProviderAdminGetPagedSortedListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Get a list of service provider administrators. + +The response is either a `ServiceProviderAdminGetPagedSortedListResponse()` or an +`ErrorResponse()`. If no sortOrder is included, the response is sorted by +Administrator ID ascending by default. If the responsePagingControl element is not +provided, the paging startIndex will be set to 1 by default, and the responsePageSize +will be set to the maximum responsePageSize by default. Multiple search criteria are +logically ANDed together unless the searchCriteriaModeOr option is included. Then the +search criteria are logically ORed together. + +**Attributes:** + +|Name |Type |Description | +|--------------------------------------------------|------------------------------------------------------|-------------------------------------------------------| +|service_provider_id |str |serviceProviderId | +|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | +|sort_order |List[OCI.sortOrder] |sortOrder *Optional* | +|search_criteria_admin_id |List[OCI.searchCriteriaAdminId] |searchCriteriaAdminId *Optional* | +|search_criteria_admin_last_name |List[OCI.searchCriteriaAdminLastName] |searchCriteriaAdminLastName *Optional* | +|search_criteria_admin_first_name |List[OCI.searchCriteriaAdminFirstName] |searchCriteriaAdminFirstName *Optional* | +|search_criteria_exact_service_provider_admin_type |List[OCI.searchCriteriaExactServiceProviderAdminType] |searchCriteriaExactServiceProviderAdminType *Optional* | +|search_criteria_language |List[OCI.searchCriteriaLanguage] |searchCriteriaLanguage *Optional* | +|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | +
+ + +## `ServiceProviderGetPagedSortedListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Request a list of service providers and/or enterprises in the system. + +The response is either a `ServiceProviderGetPagedSortedListResponse()` or an +`ErrorResponse()`. If reseller administrator sends the request, +searchCriteriaResellerId is ignored. Service providers/enterprise within the +administrator's reseller meeting the search criteria are returned. If the +responsePagingControl element is not provided, the paging startIndex will be set to 1 +by default, and the responsePageSize will be set to the maximum responsePageSize by +default. If no sortOrder is included, the response is sorted by Service Provider Id +ascending by default. Multiple search criteria are logically ANDed together unless +the searchCriteriaModeOr option is included. Then the search criteria are logically +ORed together. + +**Attributes:** + +|Name |Type |Description | +|----------------------------------------|--------------------------------------------|-----------------------------------------------| +|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | +|sort_order |List[OCI.sortOrder] |sortOrder *Optional* | +|search_criteria_service_provider_id |List[OCI.searchCriteriaServiceProviderId] |searchCriteriaServiceProviderId *Optional* | +|search_criteria_service_provider_name |List[OCI.searchCriteriaServiceProviderName] |searchCriteriaServiceProviderName *Optional* | +|search_criteria_exact_organization_type |OCI.searchCriteriaExactOrganizationType |searchCriteriaExactOrganizationType *Optional* | +|search_criteria_reseller_id |List[OCI.searchCriteriaResellerId] |searchCriteriaResellerId *Optional* | +|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | +
+ + ## `SystemSIPDeviceTypeAddRequest14sp6`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -77372,6 +77086,252 @@ The response is either `SuccessResponse()` or `ErrorResponse()`.
+## `UserEnhancedCallLogsGetListRequest17sp4`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Request user's call logs. + +If the callLogType is not specified, all types of calls logs (placed, received, +missed) are returned. The filters "dateTimeRange", "numberFilter", +"redirectedNumberFilter", accountAuthorizationCodeFilter" and ""subscriberType" are +ignored if call logs are stored in CDS. When "ReceivedOrMissed" is specified as +"callLogType" and call logs are stored in CDS, all call logs including placed will be +returned. It is possible to restrict the number of rows returned using +responsePagingControl. If responsePagingControl is not specified, the value of +Enhanced Call Logs system parameter maxNonPagedResponseSize will control the maximum +number of call logs can be returned. + +The response is either a `UserEnhancedCallLogsGetListResponse17sp4()` or an +`ErrorResponse()`. Replaced by UserEnhancedCallLogsGetListRequest17sp4V2. Originally +deprecated in release 20. + +**Attributes:** + +|Name |Type |Description | +|----------------------------------|-----------------------------------|------------------------------------------| +|user_id |str |userId | +|call_log_type |str |callLogType *Optional* | +|date_time_range |OCI.dateTimeRange |dateTimeRange | +|number_filter |OCI.numberFilter |numberFilter *Optional* | +|redirected_number_filter |OCI.redirectedNumberFilter |redirectedNumberFilter *Optional* | +|account_authorization_code_filter |OCI.accountAuthorizationCodeFilter |accountAuthorizationCodeFilter *Optional* | +|subscriber_type |str |subscriberType *Optional* | +|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | +
+ + +## `UserEnhancedCallLogsGetListRequest20`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Request user's call logs. + +If the callLogType is not specified, all types of calls logs (placed, received, +missed) are returned. The filters "dateTimeRange", "numberFilter", +"redirectedNumberFilter", "accountAuthorizationCodeFilter" +"callAuthorizationCodeFilter" and "subscriberType" are ignored if call logs are stored +in CDS. When "ReceivedOrMissed" is specified as "callLogType" and call logs are stored +in CDS, all call logs including placed will be returned. It is possible to restrict +the number of rows returned using responsePagingControl. If responsePagingControl is +not specified, the value of Enhanced Call Logs system parameter +maxNonPagedResponseSize will control the maximum number of call logs can be returned. + +The response is either a `UserEnhancedCallLogsGetListResponse20()` or an +`ErrorResponse()`. The following elements are only used in AS data mode and not +returned in XS data mode: callAuthorizationCodeFilter + +**Attributes:** + +|Name |Type |Description | +|----------------------------------|-----------------------------------|------------------------------------------| +|user_id |str |userId | +|call_log_type |str |callLogType *Optional* | +|date_time_range |OCI.dateTimeRange |dateTimeRange | +|number_filter |OCI.numberFilter |numberFilter *Optional* | +|redirected_number_filter |OCI.redirectedNumberFilter |redirectedNumberFilter *Optional* | +|account_authorization_code_filter |OCI.accountAuthorizationCodeFilter |accountAuthorizationCodeFilter *Optional* | +|call_authorization_code_filter |OCI.callAuthorizationCodeFilter |callAuthorizationCodeFilter *Optional* | +|subscriber_type |str |subscriberType *Optional* | +|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | +
+ + +## `UserEnhancedCallLogsGetListRequest20sp1`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Request user's call logs. + +If the callLogType is not specified, all types of calls logs (placed, received, +missed) are returned. The filters "dateTimeRange", "numberFilter", +"redirectedNumberFilter", "accountAuthorizationCodeFilter" +"callAuthorizationCodeFilter" and "subscriberType" are ignored if call logs are stored +in CDS. When "ReceivedOrMissed" is specified as "callLogType" and call logs are stored +in CDS, all call logs including placed will be returned. It is possible to restrict +the number of rows returned using responsePagingControl. If responsePagingControl is +not specified, the value of Enhanced Call Logs system parameter +maxNonPagedResponseSize will control the maximum number of call logs can be returned. + +The response is either a `UserEnhancedCallLogsGetListResponse20sp1()` or an +`ErrorResponse()`. The following elements are only used in AS data mode: +callAuthorizationCodeFilter callSecurityClassification + +**Attributes:** + +|Name |Type |Description | +|----------------------------------|-----------------------------------|------------------------------------------| +|user_id |str |userId | +|call_log_type |str |callLogType *Optional* | +|date_time_range |OCI.dateTimeRange |dateTimeRange | +|number_filter |OCI.numberFilter |numberFilter *Optional* | +|redirected_number_filter |OCI.redirectedNumberFilter |redirectedNumberFilter *Optional* | +|account_authorization_code_filter |OCI.accountAuthorizationCodeFilter |accountAuthorizationCodeFilter *Optional* | +|call_authorization_code_filter |OCI.callAuthorizationCodeFilter |callAuthorizationCodeFilter *Optional* | +|subscriber_type |str |subscriberType *Optional* | +|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | +
+ + +## `UserEnhancedCallLogsGetListRequest21`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Request user's call logs. + +If the callLogType is not specified, all types of calls logs (placed, received, +missed) are returned. The filters "dateTimeRange", "numberFilter", +"redirectedNumberFilter", "accountAuthorizationCodeFilter" +"callAuthorizationCodeFilter" and "subscriberType" are ignored if call logs are stored +in CDS. When "ReceivedOrMissed" is specified as "callLogType" and call logs are stored +in CDS, all call logs including placed will be returned. It is possible to restrict +the number of rows returned using responsePagingControl. If responsePagingControl is +not specified, the value of Enhanced Call Logs system parameter +maxNonPagedResponseSize will control the maximum number of call logs can be returned. + +The response is either a `UserEnhancedCallLogsGetListResponse21()` or an +`ErrorResponse()`. The following elements are only used in AS data mode and not +returned in XS data mode: callAuthorizationCodeFilter Replaced by: +UserEnhancedCallLogsGetListRequest21Sp1 in AS data mode + +**Attributes:** + +|Name |Type |Description | +|----------------------------------|-----------------------------------|------------------------------------------| +|user_id |str |userId | +|call_log_type |str |callLogType *Optional* | +|date_time_range |OCI.dateTimeRange |dateTimeRange | +|number_filter |OCI.numberFilter |numberFilter *Optional* | +|redirected_number_filter |OCI.redirectedNumberFilter |redirectedNumberFilter *Optional* | +|account_authorization_code_filter |OCI.accountAuthorizationCodeFilter |accountAuthorizationCodeFilter *Optional* | +|call_authorization_code_filter |OCI.callAuthorizationCodeFilter |callAuthorizationCodeFilter *Optional* | +|subscriber_type |str |subscriberType *Optional* | +|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | +
+ + +## `UserEnhancedCallLogsGetListRequest21sp1`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Request user's call logs. + +If the callLogType is not specified, all types of calls logs (placed, received, +missed) are returned. The filters "dateTimeRange", "numberFilter", +"redirectedNumberFilter", "accountAuthorizationCodeFilter" +"callAuthorizationCodeFilter" and "subscriberType" are ignored if call logs are stored +in CDS. When "ReceivedOrMissed" is specified as "callLogType" and call logs are stored +in CDS, all call logs including placed will be returned. It is possible to restrict +the number of rows returned using responsePagingControl. If responsePagingControl is +not specified, the value of Enhanced Call Logs system parameter +maxNonPagedResponseSize will control the maximum number of call logs can be returned. + +The response is either a `UserEnhancedCallLogsGetListResponse21sp1()` or an +`ErrorResponse()`. The following elements are only used in AS data mode and ignored in +XS data mode: callAuthorizationCodeFilter Replaced by: +UserEnhancedCallLogsGetListRequest21Sp1V2 in AS data mode + +**Attributes:** + +|Name |Type |Description | +|----------------------------------|-----------------------------------|------------------------------------------| +|user_id |str |userId | +|call_log_type |str |callLogType *Optional* | +|date_time_range |OCI.dateTimeRange |dateTimeRange | +|number_filter |OCI.numberFilter |numberFilter *Optional* | +|redirected_number_filter |OCI.redirectedNumberFilter |redirectedNumberFilter *Optional* | +|account_authorization_code_filter |OCI.accountAuthorizationCodeFilter |accountAuthorizationCodeFilter *Optional* | +|call_authorization_code_filter |OCI.callAuthorizationCodeFilter |callAuthorizationCodeFilter *Optional* | +|subscriber_type |str |subscriberType *Optional* | +|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | +
+ + +## `UserEnhancedCallLogsGetListRequest22`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Request user's call logs. + +If the callLogType is not specified, all types of calls logs (placed, received, +missed) are returned. The filters "dateTimeRange", "numberFilter", +"redirectedNumberFilter", "accountAuthorizationCodeFilter" +"callAuthorizationCodeFilter" and "subscriberType" are ignored if call logs are stored +in CDS. When "ReceivedOrMissed" is specified as "callLogType" and call logs are stored +in CDS, all call logs including placed will be returned. It is possible to restrict +the number of rows returned using responsePagingControl. If responsePagingControl is +not specified, the value of Enhanced Call Logs system parameter +maxNonPagedResponseSize will control the maximum number of call logs can be returned. + +The response is either a `UserEnhancedCallLogsGetListResponse22()` or an +`ErrorResponse()`. The following elements are only used in AS data mode and ignored in +XS data mode: callAuthorizationCodeFilter + +**Attributes:** + +|Name |Type |Description | +|----------------------------------|-----------------------------------|------------------------------------------| +|user_id |str |userId | +|call_log_type |str |callLogType *Optional* | +|date_time_range |OCI.dateTimeRange |dateTimeRange | +|number_filter |OCI.numberFilter |numberFilter *Optional* | +|redirected_number_filter |OCI.redirectedNumberFilter |redirectedNumberFilter *Optional* | +|account_authorization_code_filter |OCI.accountAuthorizationCodeFilter |accountAuthorizationCodeFilter *Optional* | +|call_authorization_code_filter |OCI.callAuthorizationCodeFilter |callAuthorizationCodeFilter *Optional* | +|subscriber_type |str |subscriberType *Optional* | +|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | +
+ + +## `UserEnhancedCallLogsGetListRequest23`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Request user's call logs. + +If the callLogType is not specified, all types of calls logs (placed, received, +missed) are returned. The filters "dateTimeRange", "numberFilter", +"redirectedNumberFilter", "accountAuthorizationCodeFilter" +"callAuthorizationCodeFilter" and "subscriberType" are ignored if call logs are stored +in CDS. When "ReceivedOrMissed" is specified as "callLogType" and call logs are stored +in CDS, all call logs including placed will be returned. It is possible to restrict +the number of rows returned using responsePagingControl. If responsePagingControl is +not specified, the value of Enhanced Call Logs system parameter +maxNonPagedResponseSize will control the maximum number of call logs can be returned. + +The response is either a `UserEnhancedCallLogsGetListResponse23()` or an +`ErrorResponse()`. The following elements are only used in AS data mode and ignored in +XS data mode: callAuthorizationCodeFilter + +**Attributes:** + +|Name |Type |Description | +|----------------------------------|-----------------------------------|------------------------------------------| +|user_id |str |userId | +|call_log_type |str |callLogType *Optional* | +|date_time_range |OCI.dateTimeRange |dateTimeRange | +|number_filter |OCI.numberFilter |numberFilter *Optional* | +|redirected_number_filter |OCI.redirectedNumberFilter |redirectedNumberFilter *Optional* | +|account_authorization_code_filter |OCI.accountAuthorizationCodeFilter |accountAuthorizationCodeFilter *Optional* | +|call_authorization_code_filter |OCI.callAuthorizationCodeFilter |callAuthorizationCodeFilter *Optional* | +|subscriber_type |str |subscriberType *Optional* | +|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | +
+ + ## `UserFlexibleSeatingGuestModifyRequest22`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
@@ -77400,6 +77360,46 @@ The response is either a `SuccessResponse()` or an `ErrorResponse()`.
+## `UserGetListInGroupPagedSortedListRequest`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest)) + +
+Request the list of users in a group. + +The response is either a `UserGetListInGroupPagedSortedListResponse()` or an +`ErrorResponse()`. If the responsePagingControl element is not provided, the paging +startIndex will be set to 1 by default, and the responsePageSize will be set to the +maximum ResponsePageSize by default. It is possible to search by various criteria to +restrict the number of rows returned. If no sortOrder is included the response is +sorted by User Id ascending by default. A limitation to the search by DN activation +exists when the Number Activation mode is set to Off. In this case DNs not assigned +to users are never returned by queries with the "dnActivationSearchCriteria" included. +Multiple search criteria are logically ANDed together unless the searchCriteriaModeOr +option is included. Then the search criteria are logically ORed together. The +following elements are used in AS data mode and ignored in XS data mode: +groupExternalId + +**Attributes:** + +|Name |Type |Description | +|------------------------------------------|----------------------------------------|-----------------------------------------------| +|service_provider_id |str |serviceProviderId *Optional* | +|group_id |str |groupId *Optional* | +|group_external_id |str |groupExternalId *Optional* | +|response_paging_control |OCI.responsePagingControl |responsePagingControl *Optional* | +|sort_order |List[OCI.sortOrder] |sortOrder *Optional* | +|search_criteria_user_last_name |List[OCI.searchCriteriaUserLastName] |searchCriteriaUserLastName *Optional* | +|search_criteria_user_first_name |List[OCI.searchCriteriaUserFirstName] |searchCriteriaUserFirstName *Optional* | +|search_criteria_dn |List[OCI.searchCriteriaDn] |searchCriteriaDn *Optional* | +|search_criteria_email_address |List[OCI.searchCriteriaEmailAddress] |searchCriteriaEmailAddress *Optional* | +|search_criteria_department_name |List[OCI.searchCriteriaDepartmentName] |searchCriteriaDepartmentName *Optional* | +|search_criteria_exact_user_in_trunk_group |OCI.searchCriteriaExactUserInTrunkGroup |searchCriteriaExactUserInTrunkGroup *Optional* | +|search_criteria_user_id |List[OCI.searchCriteriaUserId] |searchCriteriaUserId *Optional* | +|search_criteria_extension |List[OCI.searchCriteriaExtension] |searchCriteriaExtension *Optional* | +|search_criteria_exact_dn_activation |OCI.searchCriteriaExactDnActivation |searchCriteriaExactDnActivation *Optional* | +|search_criteria_mode_or |bool |searchCriteriaModeOr *Optional* | +
+ + ## `GroupAutoAttendantAddInstanceRequest14`([`OCIRequest`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIRequest))
diff --git a/docs/api/responses.md b/docs/api/responses.md index 6681e45..11359ca 100644 --- a/docs/api/responses.md +++ b/docs/api/responses.md @@ -1,7 +1,7 @@ # Responses @@ -35188,25 +35188,6 @@ Response to the `GroupCustomRingbackGroupGetRequest20()`.
-## `GroupDepartmentAdminGetResponse`([`OCIResponse`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIResponse)) - -
-Response to the `GroupDepartmentAdminGetRequest()`. - -The response contains the group department administrators profile information. - -**Attributes:** - -|Name |Type |Description | -|---------------------|------------------|---------------------| -|department_key |OCI.departmentKey |departmentKey | -|department_full_path |str |departmentFullPath | -|first_name |str |firstName *Optional* | -|last_name |str |lastName *Optional* | -|language |str |language | -
- - ## `GroupDepartmentGetAvailableParentListResponse`([`OCIResponse`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIResponse))
@@ -42207,6 +42188,25 @@ bridge maximum participant’s choices unlimited or a quantified number of parti
+## `GroupDepartmentAdminGetResponse`([`OCIResponse`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIResponse)) + +
+Response to the `GroupDepartmentAdminGetRequest()`. + +The response contains the group department administrators profile information. + +**Attributes:** + +|Name |Type |Description | +|---------------------|------------------|---------------------| +|department_key |OCI.departmentKey |departmentKey | +|department_full_path |str |departmentFullPath | +|first_name |str |firstName *Optional* | +|last_name |str |lastName *Optional* | +|language |str |language | +
+ + ## `GroupFindMeFollowMeGetInstanceResponse`([`OCIResponse`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIResponse))
diff --git a/docs/api/types.md b/docs/api/types.md index 1ea07b8..ae7cddf 100644 --- a/docs/api/types.md +++ b/docs/api/types.md @@ -1,7 +1,7 @@ # Types @@ -2657,23 +2657,6 @@ Time range used to filter call logs.
-## `EnterpriseDepartmentKey`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) - -
-Uniquely identifies a department defined within an enterprise. - -To uniquely identify an enterprise department, we must know the department name and -which enterprise contains the department. - -**Attributes:** - -|Name |Type|Description | -|--------------------|----|------------------| -|service_provider_id |str |serviceProviderId | -|name |str |name | -
- - ## `EnterpriseSessionAdmissionControlGroupGetRequest21sp1V2`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
@@ -2746,50 +2729,6 @@ Enterprise Voice VPN Digit Manipulation Entry.
-## `EnterpriseVoiceVPNDigitManipulationNoValue`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) - -
-Enterprise Voice VPN Digit Manipulation Entry that has no value. - - -**Attributes:** - -|Name |Type|Description| -|----------|----|-----------| -|operation |str |operation | -
- - -## `EnterpriseVoiceVPNDigitManipulationOptionalValue`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) - -
-Enterprise Voice VPN Digit Manipulation Entry that optionally has a value. - - -**Attributes:** - -|Name |Type|Description | -|----------|----|-----------------| -|operation |str |operation | -|value |str |value *Optional* | -
- - -## `EnterpriseVoiceVPNDigitManipulationRequiredValue`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) - -
-Enterprise Voice VPN Digit Manipulation Entry that has a value. - - -**Attributes:** - -|Name |Type|Description| -|----------|----|-----------| -|operation |str |operation | -|value |str |value | -
- - ## `EnterpriseVoiceVPNTreatmentEntry`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
@@ -4075,24 +4014,6 @@ Replaced by `GroupBroadWorksMobilityGetResponse22V2()`.
-## `GroupDepartmentKey`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) - -
-Uniquely identifies a department defined within a group. - -To uniquely identify a group department, we must know the department name and which -group contains the department. - -**Attributes:** - -|Name |Type|Description | -|--------------------|----|------------------| -|service_provider_id |str |serviceProviderId | -|group_id |str |groupId | -|name |str |name | -
- - ## `GroupEnterpriseTrunkPriorityWeightedTrunkGroup`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
@@ -6850,1096 +6771,1189 @@ when requesting a potentially large set of data from the provisioning server.
-## `SearchCriteriaAccessDeviceEndpointPrivateIdentity`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaComposedOr`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a private identity. - +Abstract base type for specifying search criteria where the search criteria params are +OR'ed. -**Attributes:** +A search criteria is an optional element used to restrict the number of rows returned +when requesting a potentially large set of data from the provisioning server. -|Name |Type |Description | -|--------------------|-----|------------------| -|mode |str |mode | -|value |str |value | -|is_case_insensitive |bool |isCaseInsensitive |
-## `SearchCriteriaAccessDeviceVersion`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SecurityClassificationCustomizationActivation`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for an Access Device Version. +The security classification customization activation. **Attributes:** -|Name |Type |Description | -|--------------------|-----|------------------| -|mode |str |mode | -|value |str |value | -|is_case_insensitive |bool |isCaseInsensitive | +|Name |Type |Description | +|--------------|-----|-------------| +|name |str |name | +|is_customized |bool |isCustomized |
-## `SearchCriteriaAdminFirstName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SelectDistributionListMenuKeysModifyEntry`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for an administrator's first name. +The voice portal select distribution list menu keys modify entry. **Attributes:** -|Name |Type |Description | -|--------------------|-----|------------------| -|mode |str |mode | -|value |str |value | -|is_case_insensitive |bool |isCaseInsensitive | +|Name |Type|Description | +|--------------------------------------------------------|----|------------------------------------------------------------| +|return_to_previous_menu |str |returnToPreviousMenu *Optional* | +|repeat_menu_or_finish_entering_distribution_list_number |str |repeatMenuOrFinishEnteringDistributionListNumber *Optional* |
-## `SearchCriteriaAdminId`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SelectDistributionListMenuKeysReadEntry`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for an administrator's adminId. +The voice portal select distribution list menu keys. **Attributes:** -|Name |Type |Description | -|--------------------|-----|------------------| -|mode |str |mode | -|value |str |value | -|is_case_insensitive |bool |isCaseInsensitive | +|Name |Type|Description | +|--------------------------------------------------------|----|------------------------------------------------------------| +|return_to_previous_menu |str |returnToPreviousMenu | +|repeat_menu_or_finish_entering_distribution_list_number |str |repeatMenuOrFinishEnteringDistributionListNumber *Optional* |
-## `SearchCriteriaAdminLastName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SelectiveCallRejectionCriteriaCallType`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for an administrator's last name. +The call type criteria used within an add/get request. **Attributes:** -|Name |Type |Description | -|--------------------|-----|------------------| -|mode |str |mode | -|value |str |value | -|is_case_insensitive |bool |isCaseInsensitive | +|Name |Type |Description | +|----------------------------|----------|--------------------------| +|from_dn_criteria_selection |str |fromDnCriteriaSelection | +|include_anonymous_callers |bool |includeAnonymousCallers | +|include_unavailable_callers |bool |includeUnavailableCallers | +|phone_number |List[str] |phoneNumber *Optional* |
-## `SearchCriteriaAgentThresholdProfile`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SendMessageToSelectedDistributionListMenuKeysModifyEntry`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching a Call Center Agent Threshold Profile. +The voice portal send message to selected distribution list menu keys modify entry. **Attributes:** -|Name |Type |Description | -|--------------------|-----|------------------| -|mode |str |mode | -|value |str |value | -|is_case_insensitive |bool |isCaseInsensitive | +|Name |Type|Description | +|-------------------------------------|----|--------------------------------------------| +|confirm_sending_to_distribution_list |str |confirmSendingToDistributionList *Optional* | +|cancel_sending_to_distribution_list |str |cancelSendingToDistributionList *Optional* |
-## `SearchCriteriaAlternateTrunkIdentity`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SendMessageToSelectedDistributionListMenuKeysReadEntry`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a particular fully specified alternate trunk identity. +The voice portal send message to selected distribution list menu keys. -In IMS mode, it only applies to the user part of alternate trunk identity. **Attributes:** -|Name |Type |Description | -|--------------------|-----|------------------| -|mode |str |mode | -|value |str |value | -|is_case_insensitive |bool |isCaseInsensitive | +|Name |Type|Description | +|-------------------------------------|----|--------------------------------------------| +|confirm_sending_to_distribution_list |str |confirmSendingToDistributionList *Optional* | +|cancel_sending_to_distribution_list |str |cancelSendingToDistributionList |
-## `SearchCriteriaAlternateTrunkIdentityDomain`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SendToAllGroupMembersMenuKeysModifyEntry`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for alternate trunk identity domain part. +The voice portal send to all group memeber menu keys modify entry. **Attributes:** -|Name |Type |Description | -|--------------------|-----|------------------| -|mode |str |mode | -|value |str |value | -|is_case_insensitive |bool |isCaseInsensitive | +|Name |Type|Description | +|--------------------------------|----|---------------------------------------| +|confirm_sending_to_entire_group |str |confirmSendingToEntireGroup *Optional* | +|cancel_sending_to_entire_group |str |cancelSendingToEntireGroup *Optional* |
-## `SearchCriteriaAlternateUserId`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SendToAllGroupMembersMenuKeysReadEntry`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a user's alternate userId. +The voice portal send to all group memeber menu keys. **Attributes:** -|Name |Type |Description | -|--------------------|-----|------------------| -|mode |str |mode | -|value |str |value | -|is_case_insensitive |bool |isCaseInsensitive | +|Name |Type|Description | +|--------------------------------|----|----------------------------| +|confirm_sending_to_entire_group |str |confirmSendingToEntireGroup | +|cancel_sending_to_entire_group |str |cancelSendingToEntireGroup |
-## `SearchCriteriaAnnouncementFileName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SendToDistributionListMenuKeysModifyEntry`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for an Announcement File Name. +The voice portal send to distribution list menu keys modify entry. **Attributes:** -|Name |Type |Description | -|--------------------|-----|------------------| -|mode |str |mode | -|value |str |value | -|is_case_insensitive |bool |isCaseInsensitive | +|Name |Type|Description | +|-------------------------------------------|----|-------------------------------------------------| +|send_message_to_selected_distribution_list |str |sendMessageToSelectedDistributionList *Optional* | +|select_distribution_list |str |selectDistributionList *Optional* | +|review_selected_distribution_list |str |reviewSelectedDistributionList *Optional* | +|return_to_previous_menu |str |returnToPreviousMenu *Optional* | +|repeat_menu |str |repeatMenu *Optional* |
-## `SearchCriteriaCallCenterName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SendToDistributionListMenuKeysReadEntry`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a call center +The voice portal send to distribution list menu keys. + **Attributes:** -|Name |Type |Description | -|--------------------|-----|------------------| -|mode |str |mode | -|value |str |value | -|is_case_insensitive |bool |isCaseInsensitive | +|Name |Type|Description | +|-------------------------------------------|----|------------------------------------------| +|send_message_to_selected_distribution_list |str |sendMessageToSelectedDistributionList | +|select_distribution_list |str |selectDistributionList *Optional* | +|review_selected_distribution_list |str |reviewSelectedDistributionList *Optional* | +|return_to_previous_menu |str |returnToPreviousMenu | +|repeat_menu |str |repeatMenu *Optional* |
-## `SearchCriteriaCallCenterReportTemplateName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SendToPersonMenuKeysModifyEntry`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a particular call center enhanced reporting report -template. +The voice portal send to person menu keys modify entry. **Attributes:** -|Name |Type |Description | -|--------------------|-----|------------------| -|mode |str |mode | -|value |str |value | -|is_case_insensitive |bool |isCaseInsensitive | +|Name |Type|Description | +|------------------------------------------------|----|----------------------------------------------------| +|confirm_sending_message |str |confirmSendingMessage *Optional* | +|cancel_sending_message |str |cancelSendingMessage *Optional* | +|finish_entering_number_where_to_send_message_to |str |finishEnteringNumberWhereToSendMessageTo *Optional* | +|finish_forwarding_or_sending_message |str |finishForwardingOrSendingMessage *Optional* |
-## `SearchCriteriaCallCenterScheduledReportName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SendToPersonMenuKeysReadEntry`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a call center enhanced reporting scheduled report name. +The voice portal send to person menu keys. **Attributes:** -|Name |Type |Description | -|--------------------|-----|------------------| -|mode |str |mode | -|value |str |value | -|is_case_insensitive |bool |isCaseInsensitive | +|Name |Type|Description | +|------------------------------------------------|----|-----------------------------------------| +|confirm_sending_message |str |confirmSendingMessage | +|cancel_sending_message |str |cancelSendingMessage | +|finish_entering_number_where_to_send_message_to |str |finishEnteringNumberWhereToSendMessageTo | +|finish_forwarding_or_sending_message |str |finishForwardingOrSendingMessage |
-## `SearchCriteriaCallParkName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SequentialRingLocation`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a call park by name - -**Attributes:** - -|Name |Type |Description | -|--------------------|-----|------------------| -|mode |str |mode | -|value |str |value | -|is_case_insensitive |bool |isCaseInsensitive | -
- - -## `SearchCriteriaCallPickupName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +Sequential Ring Location. -
-Criteria for searching for a call pickup by name +Replaced By: SequentialRingLocation14sp4 **Attributes:** -|Name |Type |Description | -|--------------------|-----|------------------| -|mode |str |mode | -|value |str |value | -|is_case_insensitive |bool |isCaseInsensitive | +|Name |Type|Description | +|----------------|----|-----------------------| +|phone_number |str |phoneNumber *Optional* | +|number_of_rings |int |numberOfRings |
-## `SearchCriteriaCommunicationBarringAuthorizationCode`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SequentialRingLocation14sp4`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a Communication Barring Authorization Code. +Sequential Ring Location. **Attributes:** -|Name |Type |Description | -|--------------------|-----|------------------| -|mode |str |mode | -|value |str |value | -|is_case_insensitive |bool |isCaseInsensitive | +|Name |Type |Description | +|-----------------------------|-----|---------------------------| +|phone_number |str |phoneNumber *Optional* | +|number_of_rings |int |numberOfRings | +|answer_confirmation_required |bool |answerConfirmationRequired |
-## `SearchCriteriaCommunicationBarringAuthorizationCodeDescription`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SequentialRingLocationModify`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a Communication Barring Authorization Code description. +Sequential Ring Location. **Attributes:** -|Name |Type |Description | -|--------------------|-----|------------------| -|mode |str |mode | -|value |str |value | -|is_case_insensitive |bool |isCaseInsensitive | +|Name |Type |Description | +|-----------------------------|-----|--------------------------------------| +|phone_number |str |phoneNumber *Optional* | +|number_of_rings |int |numberOfRings *Optional* | +|answer_confirmation_required |bool |answerConfirmationRequired *Optional* |
-## `SearchCriteriaComposedOr`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `ServiceActivation`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Abstract base type for specifying search criteria where the search criteria params are -OR'ed. +Service Instance active status indicator -A search criteria is an optional element used to restrict the number of rows returned -when requesting a potentially large set of data from the provisioning server. +**Attributes:** +|Name |Type |Description | +|----------------|-----|--------------| +|service_user_id |str |serviceUserId | +|is_active |bool |isActive |
-## `SearchCriteriaComposedOrUserName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `ServiceAttributeEntry`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a user's full name. +The service attributes name and value pair. -This search criterion will be compared against multiple combinations of first name and -last name: First Name + ‘ ‘ + Last Name Last Name + ‘ ‘ + First Name Hiragana Last -Name + ' ' + Hiragana First Name Note: For this search criterion, the searchMode is -always ‘Contains’ and the search criteria are always OR’ed. **Attributes:** -|Name |Type |Description | -|--------------------|----------|------------------| -|value |List[str] |value | -|is_case_insensitive |bool |isCaseInsensitive | +|Name |Type|Description| +|------|----|-----------| +|name |str |name | +|value |str |value |
-## `SearchCriteriaDepartmentName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `ServiceAttributeEntryRead`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a user's department. +The service attributes name and value pair. **Attributes:** -|Name |Type |Description | -|--------------------|-----|------------------| -|mode |str |mode | -|value |str |value | -|is_case_insensitive |bool |isCaseInsensitive | +|Name |Type|Description | +|------|----|-----------------| +|name |str |name | +|value |str |value *Optional* |
-## `SearchCriteriaDeviceMACAddress`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `ServiceCodeEntry`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for device MAC address. +The service code entry. **Attributes:** -|Name |Type |Description | -|--------------------|-----|------------------| -|mode |str |mode | -|value |str |value | -|is_case_insensitive |bool |isCaseInsensitive | +|Name |Type|Description | +|-------------|----|------------| +|service_code |str |serviceCode | +|description |str |description |
-## `SearchCriteriaDeviceManagementEventAdditionalInfo`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `ServicePolicyAttributeEntry`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a particular additional info of a DeviceManagement event. +The service policy attributes name and value pair. **Attributes:** -|Name |Type |Description | -|--------------------|-----|------------------| -|mode |str |mode | -|value |str |value | -|is_case_insensitive |bool |isCaseInsensitive | +|Name |Type|Description | +|------|----|-----------------| +|name |str |name | +|value |str |value *Optional* |
-## `SearchCriteriaDeviceManagementEventLoginId`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `ServicePolicyAttributeModifyEntry`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a particular login id. +The service policy attributes name and value pair. **Attributes:** -|Name |Type |Description | -|--------------------|-----|------------------| -|mode |str |mode | -|value |str |value | -|is_case_insensitive |bool |isCaseInsensitive | +|Name |Type|Description| +|------|----|-----------| +|name |str |name | +|value |str |value |
-## `SearchCriteriaDeviceName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `ServicePolicyProfileKey`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for device name. +The service policy profile key. **Attributes:** -|Name |Type |Description | -|--------------------|-----|------------------| -|mode |str |mode | -|value |str |value | -|is_case_insensitive |bool |isCaseInsensitive | +|Name |Type|Description| +|---------|----|-----------| +|name |str |name | +|category |str |category |
-## `SearchCriteriaDeviceNetAddress`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `ServiceProviderAdmin`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for device network address. +The common Service Provider Admin elements. **Attributes:** -|Name |Type |Description | -|--------------------|-----|------------------| -|mode |str |mode | -|value |str |value | -|is_case_insensitive |bool |isCaseInsensitive | +|Name |Type|Description | +|-------------------|----|---------------------| +|user_id |str |userId | +|first_name |str |firstName *Optional* | +|last_name |str |lastName *Optional* | +|password |str |password *Optional* | +|language |str |language *Optional* | +|administrator_type |str |administratorType |
-## `SearchCriteriaDeviceSerialNumber`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `ServiceProviderBroadWorksMobilityGetRequest21sp1V2`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for device serial number. +Get the service provider BroadWorks Mobility service settings. +The response is either a ServiceProviderBroadWorksMobilityGetResponse21sp1V2 or an +`ErrorResponse()`. Replaced by `ServiceProviderBroadWorksMobilityGetRequest22V2()`. **Attributes:** -|Name |Type |Description | -|--------------------|-----|------------------| -|mode |str |mode | -|value |str |value | -|is_case_insensitive |bool |isCaseInsensitive | +|Name |Type|Description | +|--------------------|----|------------------| +|service_provider_id |str |serviceProviderId |
-## `SearchCriteriaDeviceType`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `ServiceProviderBroadWorksMobilityGetResponse21sp1V2`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for device type. +The response to a ServiceProviderBroadWorksMobilityGetRequest21sp1V2. +Replaced by `ServiceProviderBroadWorksMobilityGetResponse22V2()`. **Attributes:** -|Name |Type |Description | -|--------------------|-----|------------------| -|mode |str |mode | -|value |str |value | -|is_case_insensitive |bool |isCaseInsensitive | +|Name |Type |Description | +|-----------------------------------------------|-----|------------------------------------------| +|use_setting_level |str |useSettingLevel | +|enable_location_services |bool |enableLocationServices | +|enable_msrn_lookup |bool |enableMSRNLookup | +|enable_mobile_state_checking |bool |enableMobileStateChecking | +|deny_call_originations |bool |denyCallOriginations | +|deny_call_terminations |bool |denyCallTerminations | +|enable_announcement_suppression |bool |enableAnnouncementSuppression | +|enable_internal_clid_delivery_access_locations |bool |enableInternalCLIDDeliveryAccessLocations | +|enable_enhanced_unreachable_state_checking |bool |enableEnhancedUnreachableStateChecking | +|enable_network_call_barring_status_check |bool |enableNetworkCallBarringStatusCheck |
-## `SearchCriteriaDigitPattern`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `ServiceProviderCommunicationBarringHierarchicalCallMeNowRule`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for digit pattern. - +Service Provider Communication Barring Hierarchical Call Me Now Rule **Attributes:** -|Name |Type |Description | -|--------------------|-----|------------------| -|mode |str |mode | -|value |str |value | -|is_case_insensitive |bool |isCaseInsensitive | +|Name |Type|Description | +|-----------------------|----|--------------------------------| +|criteria |str |criteria *Optional* | +|digit_pattern_criteria |str |digitPatternCriteria *Optional* | +|action |str |action | +|call_timeout_seconds |int |callTimeoutSeconds *Optional* | +|time_schedule |str |timeSchedule *Optional* | +|holiday_schedule |str |holidaySchedule *Optional* | +|priority |str |priority |
-## `SearchCriteriaDn`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `ServiceProviderCommunicationBarringHierarchicalOriginatingRule`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a DN. - +Service Provider Communication Barring Hierarchical Originating Rule **Attributes:** -|Name |Type |Description | -|--------------------|-----|------------------| -|mode |str |mode | -|value |str |value | -|is_case_insensitive |bool |isCaseInsensitive | +|Name |Type|Description | +|-----------------------|----|--------------------------------| +|criteria |str |criteria *Optional* | +|digit_pattern_criteria |str |digitPatternCriteria *Optional* | +|action |str |action | +|treatment_id |str |treatmentId *Optional* | +|transfer_number |str |transferNumber *Optional* | +|call_timeout_seconds |int |callTimeoutSeconds *Optional* | +|time_schedule |str |timeSchedule *Optional* | +|holiday_schedule |str |holidaySchedule *Optional* | +|priority |str |priority |
-## `SearchCriteriaDomainName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `ServiceProviderCommunicationBarringHierarchicalRedirectingRule`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for Domain Names. - +Service Provider Communication Barring Hierarchical Redirecting Rule **Attributes:** -|Name |Type |Description | -|--------------------|-----|------------------| -|mode |str |mode | -|value |str |value | -|is_case_insensitive |bool |isCaseInsensitive | +|Name |Type|Description | +|-----------------------|----|--------------------------------| +|criteria |str |criteria *Optional* | +|digit_pattern_criteria |str |digitPatternCriteria *Optional* | +|action |str |action | +|call_timeout_seconds |int |callTimeoutSeconds *Optional* | +|time_schedule |str |timeSchedule *Optional* | +|holiday_schedule |str |holidaySchedule *Optional* | +|priority |str |priority |
-## `SearchCriteriaEmailAddress`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `ServiceProviderCommunicationBarringProfileGetRequest19sp1V2`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a email address. +Get an existing Communication Barring Profile. +The response is either a ServiceProviderCommunicationBarringProfileGetResponse19sp1V2 +or an `ErrorResponse()`. **Attributes:** -|Name |Type |Description | -|--------------------|-----|------------------| -|mode |str |mode | -|value |str |value | -|is_case_insensitive |bool |isCaseInsensitive | +|Name |Type|Description | +|--------------------|----|------------------| +|service_provider_id |str |serviceProviderId | +|name |str |name |
-## `SearchCriteriaEnterpriseCommonMultiPartPhoneListName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `ServiceProviderVoiceMessagingGroupSettingsAdd`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a multi-part name in an enterprise common phone list. +A service provider's or enterprise's voice messaging settings used in the context of +add. -Note: For this search criterion, the searchMode is always ‘Contains’ and the multi- -part search criteria are always AND’ed. **Attributes:** -|Name |Type |Description | -|--------------------|----------|------------------| -|value |List[str] |value | -|is_case_insensitive |bool |isCaseInsensitive | +|Name |Type |Description | +|-----------------------------------------------------|-----|----------------------------------------------| +|delivery_from_address |str |deliveryFromAddress *Optional* | +|notification_from_address |str |notificationFromAddress *Optional* | +|voice_portal_lockout_from_address |str |voicePortalLockoutFromAddress *Optional* | +|use_system_default_delivery_from_address |bool |useSystemDefaultDeliveryFromAddress | +|use_system_default_notification_from_address |bool |useSystemDefaultNotificationFromAddress | +|use_system_default_voice_portal_lockout_from_address |bool |useSystemDefaultVoicePortalLockoutFromAddress |
-## `SearchCriteriaEnterpriseCommonPhoneListName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SimultaneousRingNumber`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a name in an enterprise common phone list. +Simultaneous Ring number entry. **Attributes:** -|Name |Type |Description | -|--------------------|-----|------------------| -|mode |str |mode | -|value |str |value | -|is_case_insensitive |bool |isCaseInsensitive | +|Name |Type |Description | +|-----------------------------|-----|---------------------------| +|phone_number |str |phoneNumber | +|answer_confirmation_required |bool |answerConfirmationRequired |
-## `SearchCriteriaEnterpriseCommonPhoneListNumber`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SortCriteria`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a phone number in an enterprise common phone list. +The sort criteria specifies whether sort is ascending or descending, and whether the +sort is case sensitive. +Sort order defaults to ascending and case sensitive. **Attributes:** -|Name |Type |Description | -|--------------------|-----|------------------| -|mode |str |mode | -|value |str |value | -|is_case_insensitive |bool |isCaseInsensitive | +|Name |Type |Description | +|------------------|-----|----------------| +|is_ascending |bool |isAscending | +|is_case_sensitive |bool |isCaseSensitive |
-## `SearchCriteriaEnterpriseTrunkName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SortCriteriaNumeric`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for an Enterprise Trunk name. +The sort criteria specifies whether sort is ascending or descending. +Sort order defaults to ascending. **Attributes:** -|Name |Type |Description | -|--------------------|-----|------------------| -|mode |str |mode | -|value |str |value | -|is_case_insensitive |bool |isCaseInsensitive | +|Name |Type |Description | +|-------------|-----|------------| +|is_ascending |bool |isAscending |
-## `SearchCriteriaExactAnnouncementFileType`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SpeedDial100Entry`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a particular announcement file type. +Modify the speed dial 100 prefix setting for a group. +The response is either a `SuccessResponse()` or an `ErrorResponse()`. **Attributes:** -|Name |Type|Description| -|-----|----|-----------| -|type |str |type | +|Name |Type|Description | +|-------------|----|-----------------------| +|speed_code |int |speedCode | +|phone_number |str |phoneNumber | +|description |str |description *Optional* |
-## `SearchCriteriaExactAutoAttendantType`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SpeedDial100EntryModify`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a particular auto-attendant type. +Modify the speed dial 100 prefix setting for a group. +The response is either a `SuccessResponse()` or an `ErrorResponse()`. **Attributes:** -|Name |Type|Description| -|-----|----|-----------| -|type |str |type | +|Name |Type|Description | +|-------------|----|-----------------------| +|speed_code |int |speedCode | +|phone_number |str |phoneNumber *Optional* | +|description |str |description *Optional* |
-## `SearchCriteriaExactCallCenterScheduledReportCreatedBySupervisor`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SpeedDial8Entry`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for call center scheduled report created by a supervisor or -administrator. +Modify the speed dial 8 prefix setting for a group. +The response is either a `SuccessResponse()` or an `ErrorResponse()`. **Attributes:** -|Name |Type |Description | -|----------------------|-----|--------------------| -|created_by_supervisor |bool |createdBySupervisor | +|Name |Type|Description | +|-------------|----|-----------------------| +|speed_code |int |speedCode | +|phone_number |str |phoneNumber *Optional* | +|description |str |description *Optional* |
-## `SearchCriteriaExactCallCenterScheduledReportGroup`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `StreetAddress`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a particular fully specified call center scheduled report's -group. +Street address information. **Attributes:** -|Name |Type|Description | -|--------------------|----|------------------| -|service_provider_id |str |serviceProviderId | -|group_id |str |groupId | +|Name |Type|Description | +|-------------------------------|----|--------------------------------------| +|address_line1 |str |addressLine1 *Optional* | +|address_line2 |str |addressLine2 *Optional* | +|city |str |city *Optional* | +|state_or_province |str |stateOrProvince *Optional* | +|state_or_province_display_name |str |stateOrProvinceDisplayName *Optional* | +|zip_or_postal_code |str |zipOrPostalCode *Optional* | +|country |str |country *Optional* |
-## `SearchCriteriaExactCallCenterScheduledReportServiceProvider`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SystemBroadWorksMobilityGetRequest21sp1V2`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a particular call center scheduled report's service -provider. - +Get the broadworks mobility system parameters. -**Attributes:** +The response is either a SystemBroadWorksMobilityGetResponse21sp1V2 or an +`ErrorResponse()`. Replaced by `SystemBroadWorksMobilityGetRequest22V2()`. -|Name |Type|Description | -|--------------------|----|------------------| -|service_provider_id |str |serviceProviderId |
-## `SearchCriteriaExactCallCenterType`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SystemBroadWorksMobilityGetResponse21sp1V2`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a particular fully specified call center type. +The response to a SystemBroadWorksMobilityGetRequest21sp1V2. +Replaced by `SystemBroadWorksMobilityGetResponse22V2()`. **Attributes:** -|Name |Type|Description | -|-----------------|----|---------------| -|call_center_type |str |callCenterType | +|Name |Type |Description | +|-----------------------------------------------|-----|------------------------------------------| +|enable_location_services |bool |enableLocationServices | +|enable_msrn_lookup |bool |enableMSRNLookup | +|enable_mobile_state_checking |bool |enableMobileStateChecking | +|deny_call_originations |bool |denyCallOriginations | +|deny_call_terminations |bool |denyCallTerminations | +|imrn_timeout_millisecnds |int |imrnTimeoutMillisecnds | +|enable_internal_clid_delivery_access_locations |bool |enableInternalCLIDDeliveryAccessLocations | +|enable_enhanced_unreachable_state_checking |bool |enableEnhancedUnreachableStateChecking | +|enable_network_call_barring_status_check |bool |enableNetworkCallBarringStatusCheck |
-## `SearchCriteriaExactCustomContactDirectory`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SystemCollaborateGetRequest20sp1V2`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a particular fully specified custom contact directory. - +Request the system level data associated with collaborate services. -**Attributes:** +The response is either a SystemCollaborateGetResponse20sp1V2 or an `ErrorResponse()`. -|Name |Type|Description | -|------------------------------|----|---------------------------| -|custom_contact_directory_name |str |customContactDirectoryName |
-## `SearchCriteriaExactDeviceLevel`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SystemCommunicationBarringProfileGetRequest19sp1V2`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a particular device level. +Get an existing Communication Barring Profile. +The response is either a SystemCommunicationBarringProfileGetResponse19sp1V2 or an +`ErrorResponse()`. **Attributes:** -|Name |Type|Description | -|-------------|----|------------| -|device_level |str |deviceLevel | +|Name |Type|Description| +|-----|----|-----------| +|name |str |name |
-## `SearchCriteriaExactDeviceManagementEventAction`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SystemSIPDeviceTypeGetRequest18sp1V2`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a particular fully specified DeviceManagement event action. +Request to get a sip device type. + +See Also: `SystemDeviceTypeGetRequest()` +The response is either `SystemSIPDeviceTypeGetResponse19()` or `ErrorResponse()`. +Replaced by: `SystemSIPDeviceTypeGetRequest19()`. **Attributes:** -|Name |Type|Description | -|----------------|----|--------------| -|dm_event_action |str |dmEventAction | +|Name |Type|Description| +|------------|----|-----------| +|device_type |str |deviceType |
-## `SearchCriteriaExactDeviceManagementEventLevel`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SystemSIPDeviceTypeGetRequest21sp1V2`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a particular fully specified DeviceManagement event level. +Request to get a sip device type. + +See Also: `SystemDeviceTypeGetRequest()` +The response is either SystemSIPDeviceTypeGetResponse21sp1V2 or `ErrorResponse()`. +Replaced by: `SystemSIPDeviceTypeGetRequest22()` in AS data mode. **Attributes:** -|Name |Type|Description | -|---------------|----|-------------| -|dm_event_level |str |dmEventLevel | +|Name |Type|Description| +|------------|----|-----------| +|device_type |str |deviceType |
-## `SearchCriteriaExactDeviceManagementEventStatusCompleted`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `TimeInterval`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a particular fully specified Device Management completed -event status. +Time Interval. **Attributes:** -|Name |Type|Description | -|--------------------------|----|-----------------------| -|dm_event_status_completed |str |dmEventStatusCompleted | +|Name |Type|Description | +|------------------|----|---------------| +|start_day_of_week |str |startDayOfWeek | +|start_hour |int |startHour | +|start_minute |int |startMinute | +|end_day_of_week |str |endDayOfWeek | +|end_hour |int |endHour | +|end_minute |int |endMinute |
-## `SearchCriteriaExactDeviceManagementEventStatusInProgressOrPending`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `TimeSchedule`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a particular fully specified Device Management event in -progress or pending status. +The from dn criteria. **Attributes:** -|Name |Type|Description | -|---------------------------------------|----|---------------------------------| -|dm_event_status_in_progress_or_pending |str |dmEventStatusInProgressOrPending | +|Name |Type|Description| +|-----|----|-----------| +|type |str |type | +|name |str |name |
-## `SearchCriteriaExactDeviceManagementEventType`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `TrunkGroupDeviceEndpointAdd`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a particular fully specified DeviceManagement event type. +Trunk group device endpoint used in the context of modify. **Attributes:** -|Name |Type|Description | -|--------------|----|------------| -|dm_event_type |str |dmEventType | +|Name |Type|Description | +|----------|----|-------------------| +|name |str |name | +|line_port |str |linePort | +|contact |str |contact *Optional* |
-## `SearchCriteriaExactDeviceServiceProvider`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `TrunkGroupDeviceEndpointModify`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a particular fully specified service provider associated -with a device. +Trunk group device endpoint used in the context of modify. **Attributes:** -|Name |Type|Description | -|--------------------|----|------------------| -|service_provider_id |str |serviceProviderId | +|Name |Type|Description | +|----------|----|-------------------| +|name |str |name | +|line_port |str |linePort | +|contact |str |contact *Optional* |
-## `SearchCriteriaExactDeviceType`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `TrunkGroupDeviceEndpointRead`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a particular fully specified device type. +Trunk group device endpoint. **Attributes:** -|Name |Type|Description| -|------------|----|-----------| -|device_type |str |deviceType | +|Name |Type |Description | +|----------------------------|-----|--------------------------| +|service_user_id |str |serviceUserId | +|name |str |name | +|line_port |str |linePort | +|contact |str |contact *Optional* | +|static_registration_capable |bool |staticRegistrationCapable | +|use_domain |bool |useDomain |
-## `SearchCriteriaExactDeviceTypeConfigurationOptionType`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `TrunkGroupDeviceEndpointRead14sp4`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a particular fully specified -DeviceTypeConfigurationOptionType. +Trunk group device endpoint. **Attributes:** -|Name |Type|Description | -|----------------------|----|--------------------| -|device_config_options |str |deviceConfigOptions | +|Name |Type |Description | +|----------------------------|-----|--------------------------| +|name |str |name | +|line_port |str |linePort | +|contact |str |contact *Optional* | +|static_registration_capable |bool |staticRegistrationCapable | +|use_domain |bool |useDomain | +|is_pilot_user |bool |isPilotUser |
-## `SearchCriteriaExactDnActivation`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `TrunkGroupDeviceMultipleContactEndpointAdd`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a particular Dn activation state. +Trunk group device endpoint used in the context of modify that can have multiple +contacts. **Attributes:** -|Name |Type |Description| -|----------|-----|-----------| -|activated |bool |activated | +|Name |Type |Description | +|----------|----------|-------------------| +|name |str |name | +|line_port |str |linePort | +|contact |List[str] |contact *Optional* |
-## `SearchCriteriaExactDnAvailability`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `TrunkGroupDeviceMultipleContactEndpointRead`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a particular dn availability. +Trunk group device endpoint that can have multiple contacts. **Attributes:** -|Name |Type |Description| -|----------|-----|-----------| -|available |bool |available | +|Name |Type |Description | +|----------------------------|----------|--------------------------| +|name |str |name | +|line_port |str |linePort | +|contact |List[str] |contact *Optional* | +|static_registration_capable |bool |staticRegistrationCapable | +|use_domain |bool |useDomain | +|is_pilot_user |bool |isPilotUser |
-## `SearchCriteriaExactDomainLevel`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `TrunkGroupKey`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a particular domain level. +Uniquely identifies a Trunk Group system-wide. +The trunkGroupName is unique within a group, but not unique system-wide. **Attributes:** -|Name |Type|Description | -|-------------|----|------------| -|domain_level |str |domainLevel | +|Name |Type|Description | +|--------------------|----|------------------| +|service_provider_id |str |serviceProviderId | +|group_id |str |groupId | +|name |str |name |
-## `SearchCriteriaExactEndpointType`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `UnboundedNonNegativeInt`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a particular endpoint type. +Unbounded Quantity. +Can either be unlimited or a non-negative int quantity. **Attributes:** -|Name |Type|Description | -|--------------|----|-------------| -|endpoint_type |str |endpointType | +|Name |Type |Description | +|----------|-----|---------------------| +|unlimited |bool |unlimited *Optional* | +|quantity |int |quantity *Optional* |
-## `SearchCriteriaExactEndpointType21sp1`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `UnboundedPositiveInt`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a particular endpoint type. +Unbounded Quantity. +Can either be unlimited or a positive int quantity. **Attributes:** -|Name |Type|Description | -|--------------|----|-------------| -|endpoint_type |str |endpointType | +|Name |Type |Description | +|----------|-----|---------------------| +|unlimited |bool |unlimited *Optional* | +|quantity |int |quantity *Optional* |
-## `SearchCriteriaExactGroupAdminType`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `UserBroadWorksMobilityMobileIdentityGetRequest21sp1V2`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a particular group administrator type. +Get the settings for a user's specified mobile identity. +The response is either a UserBroadWorksMobilityMobileIdentityGetResponse21sp1V2 or an +`ErrorResponse()`. Replaced by: `UserBroadWorksMobilityMobileIdentityGetRequest22()`. **Attributes:** -|Name |Type|Description| -|-----|----|-----------| -|type |str |type | +|Name |Type|Description | +|--------------|----|-------------| +|user_id |str |userId | +|mobile_number |str |mobileNumber |
-## `SearchCriteriaExactHuntPolicy`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `UserDNExtension`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a particular fully specified hunt policy. +User's DN and extension. +Used in SearchCriteriaComposedOrDnExtension when either a DN or an extension can be +used as a search criteria. **Attributes:** -|Name |Type|Description| -|------------|----|-----------| -|hunt_policy |str |huntPolicy | +|Name |Type|Description | +|----------|----|---------------------| +|dn |str |dn *Optional* | +|extension |str |extension *Optional* |
-## `SearchCriteriaExactLocationEnabled`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `UserDisplayNames`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a particular Location enabled state. +The parts of a user's display name that a client can display in whatever way is +appropriate for the client application. **Attributes:** -|Name |Type |Description| -|--------|-----|-----------| -|enabled |bool |enabled | +|Name |Type|Description | +|--------------------|----|-----------------------------| +|last_name |str |lastName | +|first_name |str |firstName | +|hiragana_last_name |str |hiraganaLastName *Optional* | +|hiragana_first_name |str |hiraganaFirstName *Optional* |
-## `SearchCriteriaExactMediaFileType`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `UserEndpointKey`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a particular media file type. +Key to uniquely identify a user endpoint. **Attributes:** -|Name |Type|Description| -|-----|----|-----------| -|type |str |type | +|Name |Type|Description| +|----------|----|-----------| +|user_id |str |userId | +|line_port |str |linePort |
-## `SearchCriteriaExactMobileDnAvailability`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `UserEnhancedCallLogsGetListResponse17sp4V2`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a particular mobile dn availability. +Response to UserEnhancedCallLogsGetListRequest17sp4V2. +Total numbers of rows is: - the total number of retrievable logs of the call log type +that was specified in the UserEnhancedCallLogsGetListRequest17sp4V2, if a call log +type was specified in the request. - the total number of retrievable logs, if no call +log type was specified in the request. A list of MixedCallLogsEntry will be returned +if the call logs are stored on CDS A list of ExtendedMixedCallLogsEntry17sp4 will be +returned if the call logs are stored on DBS The logs are sorted by date/time of the +call. **Attributes:** -|Name |Type |Description| -|----------|-----|-----------| -|available |bool |available | +|Name |Type |Description | +|---------------------|--------------|-------------------------| +|total_number_of_rows |int |totalNumberOfRows | +|legacy_entry |legacyEntry |legacyEntry *Optional* | +|extended_entry |extendedEntry |extendedEntry *Optional* |
-## `SearchCriteriaExactMobileNetwork`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `UserEnhancedCallLogsGetListResponse21sp1V2`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a particular BroadWorks Mobility Mobile Network. +Response to UserEnhancedCallLogsGetListRequest21sp1V2. +Total numbers of rows is: - the total number of retrievable logs of the call log type +that was specified in the UserEnhancedCallLogsGetListRequest21sp1V2, if a call log +type was specified in the request. - the total number of retrievable logs, if no call +log type was specified in the request. A list of MixedCallLogsEntry will be returned +if the call logs are stored on CDS A list of ExtendedMixedCallLogsEntry21sp1V2 will be +returned if the call logs are stored on DBS The logs are sorted by date/time of the +call. **Attributes:** -|Name |Type|Description | -|--------------------|----|------------------| -|mobile_network_name |str |mobileNetworkName | +|Name |Type |Description | +|---------------------|--------------|-------------------------| +|total_number_of_rows |int |totalNumberOfRows | +|legacy_entry |legacyEntry |legacyEntry *Optional* | +|extended_entry |extendedEntry |extendedEntry *Optional* |
-## `SearchCriteriaExactOrganizationType`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `UserFeatureAccessCodeModifyEntry`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for an organization type. +Feature Access Code Entry to be used in all user modify command. **Attributes:** -|Name |Type|Description | -|------------------|----|-----------------| -|organization_type |str |organizationType | +|Name |Type |Description | +|-------------------------|-----|----------------------| +|feature_access_code_name |str |featureAccessCodeName | +|enable_fac |bool |enableFAC *Optional* |
-## `SearchCriteriaExactPolicySelection`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `UserGetRequest21sp1V2`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a particular Voice VPN policy selection. +Request to get the user information. +The response is either UserGetResponse21sp1V2 or `ErrorResponse()`. Replaced by +`UserGetRequest22V3()` in AS data mode **Attributes:** -|Name |Type|Description | -|-----------------|----|----------------| -|policy_selection |str |policySelection | +|Name |Type|Description| +|--------|----|-----------| +|user_id |str |userId |
-## `SearchCriteriaExactPortNumber`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `UserMoveMessage`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a port number. +The message describes the impact made when moving a user from one group to another +group within the enterprise. +The message could also contain the error condition that prevents the user move. **Attributes:** -|Name |Type|Description| -|-----|----|-----------| -|port |int |port | +|Name |Type|Description | +|----------------|----|---------------| +|message_code |int |messageCode | +|summary |str |summary | +|summary_english |str |summaryEnglish |
-## `SearchCriteriaExactScheduleLevel`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `UserPreferredCarrierName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a particular schedule level. +User can either use it's group's preferred carrier or use it's own. +The user carrier name is exposed if it was previously configured. **Attributes:** -|Name |Type|Description| -|------|----|-----------| -|level |str |level | -
- - -## `SearchCriteriaExactScheduleType`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) - -
-Criteria for searching for a particular schedule type. - - -**Attributes:** - -|Name |Type|Description| -|-----|----|-----------| -|type |str |type | +|Name |Type |Description | +|----------------------------|-----|-------------------------| +|use_group_preferred_carrier |bool |useGroupPreferredCarrier | +|carrier |str |carrier *Optional* |
-## `SearchCriteriaExactServiceProvider`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `UserPreferredCarrierNameModify`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a particular fully specified service provider. +User can either use it's group's preferred carrier or use it's own. +You can use the group's preferred carrier without clearing the user carrier name -- in +this case, the user carrier name is retained. **Attributes:** -|Name |Type|Description | -|--------------------|----|------------------| -|service_provider_id |str |serviceProviderId | +|Name |Type |Description | +|----------------------------|-----|-------------------------| +|use_group_preferred_carrier |bool |useGroupPreferredCarrier | +|carrier |str |carrier *Optional* |
-## `SearchCriteriaExactServiceProviderAdminType`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `UserTwoStageDialingGetRequest13Mp20`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a particular service provider administrator type. +Request the user level data associated with Two Stage Dialing. +The response is either a UserTwoStageDialingGetResponse13Mp20 or an `ErrorResponse()`. **Attributes:** -|Name |Type|Description| -|-----|----|-----------| -|type |str |type | +|Name |Type|Description| +|--------|----|-----------| +|user_id |str |userId |
-## `SearchCriteriaExactServiceType`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `UserTwoStageDialingGetResponse13Mp20`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a particular fully specified service type. +Response to UserTwoStageDialingGetRequest13Mp20. **Attributes:** -|Name |Type|Description | -|-------------|----|------------| -|service_type |str |serviceType | +|Name |Type |Description | +|-------------------------------------|-----|---------------------------------| +|is_active |bool |isActive | +|allow_activation_with_user_addresses |bool |allowActivationWithUserAddresses |
-## `SearchCriteriaExactSignalingAddressType`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `VerifyTranslationAndRoutingOrigination`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a particular fully specified SignalingAddressType. +Verification Translation and Routing origination value. **Attributes:** -|Name |Type|Description| -|--------|----|-----------| -|profile |str |profile | +|Name |Type|Description | +|----------|----|--------------------| +|line_port |str |linePort *Optional* | +|phone |str |phone *Optional* | +|user_id |str |userId *Optional* | +|url |str |url *Optional* |
-## `SearchCriteriaExactSkillLevel`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `VirtualOnNetUser`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a skill Level. +Virtual On-Net User. **Attributes:** -|Name |Type|Description| -|------------|----|-----------| -|skill_level |int |skillLevel | +|Name |Type|Description | +|------------------------------|----|-------------------------| +|phone_number |str |phoneNumber | +|extension |str |extension | +|first_name |str |firstName | +|last_name |str |lastName | +|calling_line_id_first_name |str |callingLineIdFirstName | +|calling_line_id_last_name |str |callingLineIdLastName | +|virtual_on_net_call_type_name |str |virtualOnNetCallTypeName |
-## `SearchCriteriaExactUserGroup`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `VirtualOnNetUserKey`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a particular fully specified user's group. +Virtual On-Net User identifier which is the Service Provider ID, Group ID, and phone +number (in E. +164 format). **Attributes:** @@ -7947,9489 +7961,9475 @@ Criteria for searching for a particular fully specified user's group. |--------------------|----|------------------| |service_provider_id |str |serviceProviderId | |group_id |str |groupId | +|phone_number |str |phoneNumber |
-## `SearchCriteriaExactUserInTrunkGroup`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `VoiceMessagingAliasListModify`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for user in/not in a trunk group. +A list of dns that is added to a previously configured list. **Attributes:** -|Name |Type |Description | -|--------------------|-----|-----------------| -|user_in_trunk_group |bool |userInTrunkGroup | +|Name |Type |Description | +|-------------|----------|------------| +|phone_number |List[str] |phoneNumber |
-## `SearchCriteriaExactUserNetworkClassOfService`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `VoiceMessagingAliasReplacementList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for users with a specified network class of service. +A list of dns that that replaces a previously configured list. +By convention, an element of this type may be set nil to clear the list. **Attributes:** -|Name |Type|Description | -|-------------------------|----|----------------------| -|network_class_of_service |str |networkClassOfService | +|Name |Type |Description | +|-------------|----------|------------| +|phone_number |List[str] |phoneNumber |
-## `SearchCriteriaExactUserRouteListAssigned`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `VoiceMessagingAlternateNoAnswerGreetingRead`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for users with/without Route List feature assigned. +The configuration of a alternate no answer greeting. +It is used when geting a user's voice messaging greeting. **Attributes:** -|Name |Type |Description | -|--------------------|-----|------------------| -|route_list_assigned |bool |routeListAssigned | +|Name |Type|Description | +|-----------|----|---------------------| +|name |str |name | +|audio_file |str |audioFile *Optional* | +|video_file |str |videoFile *Optional* |
-## `SearchCriteriaExactUserRouteListAssignment`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `VoiceMessagingAlternateNoAnswerGreetingRead16`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for users with Route List feature assignment. +The configuration of a alternate no answer greeting. +It is used when geting a user's voice messaging greeting. **Attributes:** -|Name |Type |Description| -|---------|-----|-----------| -|assigned |bool |assigned | +|Name |Type|Description | +|-----------------|----|--------------------------| +|name |str |name | +|audio_file |str |audioFile *Optional* | +|audio_media_type |str |audioMediaType *Optional* | +|video_file |str |videoFile *Optional* | +|video_media_type |str |videoMediaType *Optional* |
-## `SearchCriteriaExactUserType`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `VoiceMessagingMenuKeysModifyEntry`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a particular User Type. +The voice portal voice messaging menu keys modify entry. **Attributes:** -|Name |Type|Description| -|----------|----|-----------| -|user_type |str |userType | +|Name |Type|Description | +|------------------------------|----|--------------------------------------| +|play_messages |str |playMessages *Optional* | +|change_busy_greeting |str |changeBusyGreeting *Optional* | +|change_no_answer_greeting |str |changeNoAnswerGreeting *Optional* | +|change_extended_away_greeting |str |changeExtendedAwayGreeting *Optional* | +|compose_message |str |composeMessage *Optional* | +|delete_all_messages |str |deleteAllMessages *Optional* | +|passcode |str |passcode *Optional* | +|personalized_name |str |personalizedName *Optional* | +|message_deposit |str |messageDeposit *Optional* | +|return_to_previous_menu |str |returnToPreviousMenu *Optional* | +|repeat_menu |str |repeatMenu *Optional* |
-## `SearchCriteriaExactVirtualOnNetCallTypeName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `VoiceMessagingMenuKeysReadEntry`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a particular fully specified Virtual On-Net Call Type Name. +The voice portal voice messaging menu keys. **Attributes:** -|Name |Type|Description | -|------------------------------|----|-------------------------| -|virtual_on_net_call_type_name |str |virtualOnNetCallTypeName | +|Name |Type|Description | +|------------------------------|----|--------------------------------------| +|play_messages |str |playMessages *Optional* | +|change_busy_greeting |str |changeBusyGreeting *Optional* | +|change_no_answer_greeting |str |changeNoAnswerGreeting *Optional* | +|change_extended_away_greeting |str |changeExtendedAwayGreeting *Optional* | +|compose_message |str |composeMessage *Optional* | +|delete_all_messages |str |deleteAllMessages *Optional* | +|passcode |str |passcode *Optional* | +|personalized_name |str |personalizedName *Optional* | +|message_deposit |str |messageDeposit *Optional* | +|return_to_previous_menu |str |returnToPreviousMenu | +|repeat_menu |str |repeatMenu *Optional* |
-## `SearchCriteriaExtension`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `VoicePortalCallingMenuKeysModifyEntry`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for an extension. +The voice portal calling menu keys modify entry. **Attributes:** -|Name |Type |Description | -|--------------------|-----|------------------| -|mode |str |mode | -|value |str |value | -|is_case_insensitive |bool |isCaseInsensitive | +|Name |Type|Description | +|----------------------------------------------|----|-------------------------------------------------| +|end_current_call_and_go_back_to_previous_menu |str |endCurrentCallAndGoBackToPreviousMenu *Optional* | +|return_to_previous_menu |str |returnToPreviousMenu *Optional* |
-## `SearchCriteriaForwardedToNumber`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `VoicePortalCallingMenuKeysReadEntry`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a forwarded to number. +The voice portal change calling menu keys. -This search criteria data type is only intended to be used by the commands introduced -by BW-2301. The commands are `EnterpriseUserCallForwardingSettingsGetListRequest()` -and `GroupUserCallForwardingSettingsGetListRequest()`. The following Call Forwarding -services are compatible for this search: Call Forwarding Always, Call Forwarding -Always Secondary, Call Forwarding Busy, Call Forwarding No Answer, Call Forwarding Not -Reachable, Call Forwarding Selective. **Attributes:** -|Name |Type |Description | -|--------------------|-----|------------------| -|mode |str |mode | -|value |str |value | -|is_case_insensitive |bool |isCaseInsensitive | +|Name |Type|Description | +|----------------------------------------------|----|--------------------------------------| +|end_current_call_and_go_back_to_previous_menu |str |endCurrentCallAndGoBackToPreviousMenu | +|return_to_previous_menu |str |returnToPreviousMenu |
-## `SearchCriteriaGroupCommonMultiPartPhoneListName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `VoicePortalLoginMenuKeysModifyEntry`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a multi-value name in a group common phone list. +The voice portal voice portal login menu keys modify entry. -Note: For this search criterion, the searchMode is always ‘Contains’ and the multi- -part search criteria are always AND’ed. **Attributes:** -|Name |Type |Description | -|--------------------|----------|------------------| -|value |List[str] |value | -|is_case_insensitive |bool |isCaseInsensitive | +|Name |Type|Description | +|------------------------------|----|-------------------------------------| +|access_using_other_mailbox_id |str |accessUsingOtherMailboxId *Optional* |
-## `SearchCriteriaGroupCommonPhoneListName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `VoicePortalLoginMenuKeysReadEntry`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a name in a group common phone list. +The voice portal login menu keys. **Attributes:** -|Name |Type |Description | -|--------------------|-----|------------------| -|mode |str |mode | -|value |str |value | -|is_case_insensitive |bool |isCaseInsensitive | +|Name |Type|Description | +|------------------------------|----|-------------------------------------| +|access_using_other_mailbox_id |str |accessUsingOtherMailboxId *Optional* |
-## `SearchCriteriaGroupCommonPhoneListNumber`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `VoicePortalMainMenuKeysModifyEntry`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a phone number in a group common phone list. +The voice portal main menu keys modify entry. **Attributes:** -|Name |Type |Description | -|--------------------|-----|------------------| -|mode |str |mode | -|value |str |value | -|is_case_insensitive |bool |isCaseInsensitive | +|Name |Type|Description | +|---------------------------|----|-----------------------------------| +|voice_messaging |str |voiceMessaging *Optional* | +|comm_pilot_express_profile |str |commPilotExpressProfile *Optional* | +|greetings |str |greetings *Optional* | +|call_forwarding_options |str |callForwardingOptions *Optional* | +|voice_portal_calling |str |voicePortalCalling *Optional* | +|hoteling |str |hoteling *Optional* | +|passcode |str |passcode *Optional* | +|exit_voice_portal |str |exitVoicePortal *Optional* | +|repeat_menu |str |repeatMenu *Optional* | +|external_routing |str |externalRouting *Optional* | +|announcement |str |announcement *Optional* | +|personal_assistant |str |personalAssistant *Optional* |
-## `SearchCriteriaGroupExternalId`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `VoicePortalMainMenuKeysReadEntry`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching by a group's externalId. +The voice portal main menu keys. **Attributes:** -|Name |Type|Description| -|------|----|-----------| -|mode |str |mode | -|value |str |value | +|Name |Type|Description | +|---------------------------|----|-----------------------------------| +|voice_messaging |str |voiceMessaging *Optional* | +|comm_pilot_express_profile |str |commPilotExpressProfile *Optional* | +|greetings |str |greetings *Optional* | +|call_forwarding_options |str |callForwardingOptions *Optional* | +|voice_portal_calling |str |voicePortalCalling *Optional* | +|hoteling |str |hoteling *Optional* | +|passcode |str |passcode *Optional* | +|exit_voice_portal |str |exitVoicePortal *Optional* | +|repeat_menu |str |repeatMenu *Optional* | +|external_routing |str |externalRouting *Optional* | +|announcement |str |announcement *Optional* | +|personal_assistant |str |personalAssistant *Optional* |
-## `SearchCriteriaGroupId`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `XsiApplicationIdEntry`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a group ID. +The system application Id entry. **Attributes:** -|Name |Type |Description | -|--------------------|-----|------------------| -|mode |str |mode | -|value |str |value | -|is_case_insensitive |bool |isCaseInsensitive | +|Name |Type|Description | +|-------------------|----|-----------------------| +|xsi_application_id |str |xsiApplicationId | +|description |str |description *Optional* |
-## `SearchCriteriaGroupLocationCode`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `XsiPolicyProfileAssignEntry`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a group location dialing code. +The Xsi policy profile assign entry contains multiple Xsi policy profile and one +default xsi policy profile. **Attributes:** -|Name |Type |Description | -|--------------------|-----|------------------| -|mode |str |mode | -|value |str |value | -|is_case_insensitive |bool |isCaseInsensitive | +|Name |Type |Description | +|--------|----------|-------------------| +|name |List[str] |name *Optional* | +|default |str |default *Optional* |
-## `SearchCriteriaGroupName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `XsiPolicyProfileKey`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a group name. +The system Xsi policy profile key. **Attributes:** -|Name |Type |Description | -|--------------------|-----|------------------| -|mode |str |mode | -|value |str |value | -|is_case_insensitive |bool |isCaseInsensitive | +|Name |Type|Description| +|------|----|-----------| +|name |str |name | +|level |str |level |
-## `SearchCriteriaHomeMscAddress`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `XsiPolicyProfileUnassignEntry`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a system Home Network Msc Address. +The Xsi policy profile unassign entry contains mutiltipe Xsi policy profile and a new +replacement default xsi policy profile. **Attributes:** -|Name |Type |Description | -|--------------------|-----|------------------| -|mode |str |mode | -|value |str |value | -|is_case_insensitive |bool |isCaseInsensitive | +|Name |Type |Description | +|------------|----------|----------------------| +|name |List[str] |name *Optional* | +|new_default |str |newDefault *Optional* |
-## `SearchCriteriaIMRN`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `AccessDeviceEndpointAdd`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for an IMRN Number. +Access device end point used in the context of add. +Port numbers are only used by devices with static line ordering. The following +element is only used in AS data mode and ignored in XS data mode: pathHeader **Attributes:** -|Name |Type |Description | -|--------------------|-----|------------------| -|mode |str |mode | -|value |str |value | -|is_case_insensitive |bool |isCaseInsensitive | +|Name |Type |Description | +|--------------|-------------|----------------------| +|access_device |accessDevice |accessDevice | +|line_port |str |linePort | +|contact |str |contact *Optional* | +|path_header |str |pathHeader *Optional* | +|port_number |int |portNumber *Optional* |
-## `SearchCriteriaImpId`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `AccessDeviceEndpointAndHotlineAdd`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a user's IMP Id. +Access device end point used in the context of add. +Port numbers are only used by devices with static line ordering. The following +element is only used in AS data mode and ignored in XS data mode: pathHeader +useHotline, use value false in XS data mode hotlineContact The following element is +only used in XS data mode and ignored in AS data mode: privateIdentity **Attributes:** -|Name |Type |Description | -|--------------------|-----|------------------| -|mode |str |mode | -|value |str |value | -|is_case_insensitive |bool |isCaseInsensitive | +|Name |Type |Description | +|-----------------|-------------|---------------------------| +|access_device |accessDevice |accessDevice | +|line_port |str |linePort | +|private_identity |str |privateIdentity *Optional* | +|contact |str |contact *Optional* | +|path_header |str |pathHeader *Optional* | +|port_number |int |portNumber *Optional* | +|use_hotline |bool |useHotline | +|hotline_contact |str |hotlineContact *Optional* |
-## `SearchCriteriaLanguage`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `AccessDeviceEndpointAndHotlineModify`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a language. +Access device end point used in the context of modify. +Port numbers are only used by devices with static line ordering. The following +element is only used in AS data mode and ignored in XS data mode: pathHeader +useHotline hotlineContact **Attributes:** -|Name |Type |Description | -|--------------------|-----|------------------| -|mode |str |mode | -|value |str |value | -|is_case_insensitive |bool |isCaseInsensitive | +|Name |Type |Description | +|----------------|-------------|--------------------------| +|access_device |accessDevice |accessDevice | +|line_port |str |linePort | +|contact |str |contact *Optional* | +|path_header |str |pathHeader *Optional* | +|port_number |int |portNumber *Optional* | +|use_hotline |bool |useHotline *Optional* | +|hotline_contact |str |hotlineContact *Optional* |
-## `SearchCriteriaLinePortDomain`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `AccessDeviceEndpointKey`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for device line/port, or SIPURI domain part. +Access device end point in the context of a modify or delete command. **Attributes:** -|Name |Type |Description | -|--------------------|-----|------------------| -|mode |str |mode | -|value |str |value | -|is_case_insensitive |bool |isCaseInsensitive | +|Name |Type |Description | +|--------------|-------------|-------------| +|access_device |accessDevice |accessDevice | +|line_port |str |linePort |
-## `SearchCriteriaLinePortUserPart`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `AccessDeviceEndpointModify`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for device line/port, or SIPURI user part. +Access device end point used in the context of modify. +Port numbers are only used by devices with static line ordering. The following +element is only used in AS data mode and ignored in XS data mode: pathHeader **Attributes:** -|Name |Type |Description | -|--------------------|-----|------------------| -|mode |str |mode | -|value |str |value | -|is_case_insensitive |bool |isCaseInsensitive | +|Name |Type |Description | +|--------------|-------------|----------------------| +|access_device |accessDevice |accessDevice | +|line_port |str |linePort | +|contact |str |contact *Optional* | +|path_header |str |pathHeader *Optional* | +|port_number |int |portNumber *Optional* |
-## `SearchCriteriaLocation`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `AccessDeviceEndpointRead14`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a Location. +Access device end point. **Attributes:** -|Name |Type |Description | -|--------------------|-----|------------------| -|mode |str |mode | -|value |str |value | -|is_case_insensitive |bool |isCaseInsensitive | +|Name |Type |Description | +|----------------------------|-------------|--------------------------| +|access_device |accessDevice |accessDevice | +|line_port |str |linePort | +|contact |str |contact *Optional* | +|static_registration_capable |bool |staticRegistrationCapable | +|use_domain |bool |useDomain |
-## `SearchCriteriaLoginId`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `AccessDeviceEndpointWithPortNumberRead`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a Login Id. +Access device end point. +Port numbers are only used by devices with static line ordering. **Attributes:** -|Name |Type |Description | -|--------------------|-----|------------------| -|mode |str |mode | -|value |str |value | -|is_case_insensitive |bool |isCaseInsensitive | +|Name |Type |Description | +|----------------------------|-------------|--------------------------| +|access_device |accessDevice |accessDevice | +|line_port |str |linePort | +|contact |str |contact *Optional* | +|static_registration_capable |bool |staticRegistrationCapable | +|use_domain |bool |useDomain | +|port_number |int |portNumber *Optional* |
-## `SearchCriteriaMobilePhoneNumber`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `AccessDeviceEndpointWithPortNumberRead22`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a user's mobile phone number. +Access device end point. +Port numbers are only used by devices with static line ordering. The following +element is only used in AS data mode and ignored in XS data mode: pathHeader **Attributes:** -|Name |Type |Description | -|--------------------|-----|------------------| -|mode |str |mode | -|value |str |value | -|is_case_insensitive |bool |isCaseInsensitive | +|Name |Type |Description | +|----------------------------|-------------|--------------------------| +|access_device |accessDevice |accessDevice | +|line_port |str |linePort | +|contact |str |contact *Optional* | +|path_header |str |pathHeader *Optional* | +|static_registration_capable |bool |staticRegistrationCapable | +|use_domain |bool |useDomain | +|port_number |int |portNumber *Optional* |
-## `SearchCriteriaMobileSubscriberDirectoryNumber`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `AccessDeviceEndpointWithPortNumberRead22V2`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a BroadWorks Mobility Mobile Subscriber Directory Number. +Access device end point. +Port numbers are only used by devices with static line ordering. The following +element is only used in AS data mode and ignored in XS data mode: pathHeader +hotlineContact The following elements are only used in AS data mode and a value false +is returned in the XS mode: useHotline **Attributes:** -|Name |Type |Description | -|--------------------|-----|------------------| -|mode |str |mode | -|value |str |value | -|is_case_insensitive |bool |isCaseInsensitive | +|Name |Type |Description | +|----------------------------|-------------|--------------------------| +|access_device |accessDevice |accessDevice | +|line_port |str |linePort | +|contact |str |contact *Optional* | +|path_header |str |pathHeader *Optional* | +|static_registration_capable |bool |staticRegistrationCapable | +|use_domain |bool |useDomain | +|port_number |int |portNumber *Optional* | +|use_hotline |bool |useHotline | +|hotline_contact |str |hotlineContact *Optional* |
-## `SearchCriteriaMultiPartUserName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `AccessDeviceMultipleContactEndpointAdd`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a user's full name. +Access device end point used in the context of add that can have more than one contact +defined. -This search criterion will be compared against multiple combinations of first name and -last name: First Name + ‘ ‘ + Last Name Last Name + ‘ ‘ + First Name Last Name + ‘, ‘ -+ First Name Hiragana Last Name + Hiragana First Name Note that when specific -conditions are met, VON users will be included in the search results. Note: For this -search criterion, the searchMode is always ‘Contains’ and the multi-part search -criteria are always AND’ed. +Only Static Registration capabable devices may have more than one contact defined. +Port numbers are only used by devices with static line ordering. **Attributes:** -|Name |Type |Description | -|--------------------|----------|------------------| -|value |List[str] |value | -|is_case_insensitive |bool |isCaseInsensitive | +|Name |Type |Description | +|--------------|-------------|----------------------| +|access_device |accessDevice |accessDevice | +|line_port |str |linePort | +|contact |List[str] |contact *Optional* | +|port_number |int |portNumber *Optional* |
-## `SearchCriteriaNetworkClassOfServiceName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `AccessDeviceMultipleContactEndpointAdd22`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a Network Class of Service name. +Access device end point used in the context of add that can have more than one contact +defined. +Only Static Registration capabable devices may have more than one contact defined. +Port numbers are only used by devices with static line ordering. **Attributes:** -|Name |Type |Description | -|--------------------|-----|------------------| -|mode |str |mode | -|value |str |value | -|is_case_insensitive |bool |isCaseInsensitive | +|Name |Type |Description | +|--------------|--------------|----------------------| +|access_device |accessDevice |accessDevice | +|line_port |str |linePort | +|contact |List[contact] |contact *Optional* | +|port_number |int |portNumber *Optional* |
-## `SearchCriteriaNumberPortabilityQueryDigitPattern`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `AccessDeviceMultipleContactEndpointModify`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for digit pattern. +Access device end point used in the context of modify that can have more than one +contact defined. +Only Static Registration capable devices may have more than one contact defined. Port +numbers are only used by devices with static line ordering. **Attributes:** -|Name |Type |Description | -|--------------------|-----|------------------| -|mode |str |mode | -|value |str |value | -|is_case_insensitive |bool |isCaseInsensitive | +|Name |Type |Description | +|--------------|-------------|------------------------| +|access_device |accessDevice |accessDevice *Optional* | +|line_port |str |linePort *Optional* | +|contact_list |contactList |contactList *Optional* | +|port_number |int |portNumber *Optional* |
-## `SearchCriteriaNumberPortabilityStatus`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `AccessDeviceMultipleContactEndpointRead`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for number portability status. +Access device end point that can have multiple contacts. +Replaced by AccessDeviceMultipleContactEndpointRead19. **Attributes:** -|Name |Type |Description | -|--------------------|-----|------------------| -|mode |str |mode | -|value |str |value | -|is_case_insensitive |bool |isCaseInsensitive | +|Name |Type |Description | +|----------------------------|-------------|--------------------------| +|access_device |accessDevice |accessDevice | +|line_port |str |linePort | +|contact |List[str] |contact *Optional* | +|static_registration_capable |bool |staticRegistrationCapable | +|use_domain |bool |useDomain |
-## `SearchCriteriaOutgoingDNorSIPURI`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `AccessDeviceMultipleContactEndpointRead19`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a phone number or SIPURI. +Access device end point that can have multiple contacts. +Port numbers are only used by devices with static line ordering. Replaced by +AccessDeviceMultipleContactEndpointRead20. **Attributes:** -|Name |Type |Description | -|--------------------|-----|------------------| -|mode |str |mode | -|value |str |value | -|is_case_insensitive |bool |isCaseInsensitive | +|Name |Type |Description | +|----------------------------|-------------|--------------------------| +|access_device |accessDevice |accessDevice | +|line_port |str |linePort | +|contact |List[str] |contact *Optional* | +|static_registration_capable |bool |staticRegistrationCapable | +|use_domain |bool |useDomain | +|port_number |int |portNumber *Optional* |
-## `SearchCriteriaPersonalAssistantExclusionNumber`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `AccessDeviceMultipleContactEndpointRead20`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for Personal Assistant Exclusion Number. +Access device end point that can have multiple contacts. +Port numbers are only used by devices with static line ordering. Replaced by +AccessDeviceMultipleContactEndpointRead22. **Attributes:** -|Name |Type |Description | -|--------------------|-----|------------------| -|mode |str |mode | -|value |str |value | -|is_case_insensitive |bool |isCaseInsensitive | +|Name |Type |Description | +|---------------------------------|-------------|------------------------------| +|access_device |accessDevice |accessDevice | +|line_port |str |linePort | +|contact |List[str] |contact *Optional* | +|static_registration_capable |bool |staticRegistrationCapable | +|use_domain |bool |useDomain | +|port_number |int |portNumber *Optional* | +|support_visual_device_management |bool |supportVisualDeviceManagement |
-## `SearchCriteriaPersonalAssistantExclusionNumberDescription`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `AccessDeviceMultipleContactEndpointRead22`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching Personal Assistant Exclusion Number's Description. +Access device end point that can have multiple contacts. +Port numbers are only used by devices with static line ordering. **Attributes:** -|Name |Type |Description | -|--------------------|-----|------------------| -|mode |str |mode | -|value |str |value | -|is_case_insensitive |bool |isCaseInsensitive | +|Name |Type |Description | +|---------------------------------|--------------|------------------------------| +|access_device |accessDevice |accessDevice | +|line_port |str |linePort | +|contact |List[contact] |contact *Optional* | +|static_registration_capable |bool |staticRegistrationCapable | +|use_domain |bool |useDomain | +|port_number |int |portNumber *Optional* | +|support_visual_device_management |bool |supportVisualDeviceManagement |
-## `SearchCriteriaPhysicalLocation`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `AccessDeviceMultipleIdentityAndContactEndpointAdd`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a Physical Location. +Access device end point used in the context of add that can have more than one contact +defined. +The endpoint is identified by its linePort (public Identity) and possibly a private +Identity. Only Static Registration capabable devices may have more than one contact +defined. Port numbers are only used by devices with static line ordering. The +following elements are only used in XS data mode and ignored in AS data mode: +privateIdentity **Attributes:** -|Name |Type |Description | -|--------------------|-----|------------------| -|mode |str |mode | -|value |str |value | -|is_case_insensitive |bool |isCaseInsensitive | +|Name |Type |Description | +|-----------------|-------------|---------------------------| +|access_device |accessDevice |accessDevice | +|line_port |str |linePort | +|private_identity |str |privateIdentity *Optional* | +|contact |List[str] |contact *Optional* | +|port_number |int |portNumber *Optional* |
-## `SearchCriteriaProfileServiceCode`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `AccessDeviceMultipleIdentityAndContactEndpointAdd22`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a Service Code. +Access device end point used in the context of add that can have more than one contact +defined. +The endpoint is identified by its linePort (public Identity) and possibly a private +Identity. Only Static Registration capabable devices may have more than one contact +defined. Port numbers are only used by devices with static line ordering. The +following elements are only used in XS data mode and ignored in AS data mode: +privateIdentity **Attributes:** -|Name |Type |Description | -|--------------------|-----|------------------| -|mode |str |mode | -|value |str |value | -|is_case_insensitive |bool |isCaseInsensitive | +|Name |Type |Description | +|-----------------|--------------|---------------------------| +|access_device |accessDevice |accessDevice | +|line_port |str |linePort | +|private_identity |str |privateIdentity *Optional* | +|contact |List[contact] |contact *Optional* | +|port_number |int |portNumber *Optional* |
-## `SearchCriteriaProfileServiceCodeDescription`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `AccessDeviceMultipleIdentityAndContactEndpointAdd22V2`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a Service Code description. +Access device end point used in the context of add that can have more than one contact +defined. +The endpoint is identified by its linePort (public Identity) and possibly a private +Identity. Only Static Registration capabable devices may have more than one contact +defined. Port numbers are only used by devices with static line ordering. The +following elements are only used in XS data mode and ignored in AS data mode: +privateIdentity The following elements are only used in AS data mode and ignored in XS +data mode: useHotline, use value false in XS data mode hotlineContact **Attributes:** -|Name |Type |Description | -|--------------------|-----|------------------| -|mode |str |mode | -|value |str |value | -|is_case_insensitive |bool |isCaseInsensitive | +|Name |Type |Description | +|-----------------|--------------|---------------------------| +|access_device |accessDevice |accessDevice | +|line_port |str |linePort | +|private_identity |str |privateIdentity *Optional* | +|contact |List[contact] |contact *Optional* | +|port_number |int |portNumber *Optional* | +|use_hotline |bool |useHotline | +|hotline_contact |str |hotlineContact *Optional* |
-## `SearchCriteriaReceptionistNote`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `AccessDeviceMultipleIdentityAndContactEndpointModify`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for Receptionist Notes. +Access device end point used in the context of modify that can have more than one +contact defined. +The endpoint is identified by its linePort (public Identity) and possibly a private +Identity. Only Static Registration capabable devices may have more than one contact +defined. Port numbers are only used by devices with static line ordering. The +following elements are only used in XS data mode and ignored in AS data mode: +privateIdentity **Attributes:** -|Name |Type |Description | -|--------------------|-----|------------------| -|mode |str |mode | -|value |str |value | -|is_case_insensitive |bool |isCaseInsensitive | +|Name |Type |Description | +|-----------------|-------------|---------------------------| +|access_device |accessDevice |accessDevice *Optional* | +|line_port |str |linePort *Optional* | +|private_identity |str |privateIdentity *Optional* | +|contact_list |contactList |contactList *Optional* | +|port_number |int |portNumber *Optional* |
-## `SearchCriteriaRegistrationURI`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `AccessDeviceMultipleIdentityAndContactEndpointRead`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a RegistrationURI. +Access device end point that can have multiple contacts. +The endpoint is identified by its linePort (public Identity) and possibly a private +Identity. Port numbers are only used by devices with static line ordering. The +following elements are only used in XS data mode and not returned in AS data mode: +privateIdentity The following elements are only used in AS data mode and a value false +is returned in the XS mode: supportVisualDeviceManagement **Attributes:** -|Name |Type |Description | -|--------------------|-----|------------------| -|mode |str |mode | -|value |str |value | -|is_case_insensitive |bool |isCaseInsensitive | +|Name |Type |Description | +|---------------------------------|-------------|------------------------------| +|access_device |accessDevice |accessDevice | +|line_port |str |linePort | +|private_identity |str |privateIdentity *Optional* | +|contact |List[str] |contact *Optional* | +|static_registration_capable |bool |staticRegistrationCapable | +|use_domain |bool |useDomain | +|port_number |int |portNumber *Optional* | +|support_visual_device_management |bool |supportVisualDeviceManagement |
-## `SearchCriteriaResellerId`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `AccessDeviceMultipleIdentityAndContactEndpointRead22`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a reseller ID. +Access device end point that can have multiple contacts. +The endpoint is identified by its linePort (public Identity) and possibly a private +Identity. Port numbers are only used by devices with static line ordering. The +following elements are only used in XS data mode and not returned in AS data mode: +privateIdentity The following elements are only used in AS data mode and a value false +is returned in the XS mode: supportVisualDeviceManagement **Attributes:** -|Name |Type |Description | -|--------------------|-----|------------------| -|mode |str |mode | -|value |str |value | -|is_case_insensitive |bool |isCaseInsensitive | -
- +|Name |Type |Description | +|---------------------------------|--------------|------------------------------| +|access_device |accessDevice |accessDevice | +|line_port |str |linePort | +|private_identity |str |privateIdentity *Optional* | +|contact |List[contact] |contact *Optional* | +|static_registration_capable |bool |staticRegistrationCapable | +|use_domain |bool |useDomain | +|port_number |int |portNumber *Optional* | +|support_visual_device_management |bool |supportVisualDeviceManagement | + -## `SearchCriteriaResellerName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) + +## `AccessDeviceMultipleIdentityAndContactEndpointRead22V2`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a reseller name. +Access device end point that can have multiple contacts. +The endpoint is identified by its linePort (public Identity) and possibly a private +Identity. Port numbers are only used by devices with static line ordering. The +following elements are only used in XS data mode and not returned in AS data mode: +privateIdentity The following elements are only used in AS data mode and a value false +is returned in the XS mode: supportVisualDeviceManagement useHotline The following +elements are only used in AS data mode and not returned in XS data mode: +hotlineContact **Attributes:** -|Name |Type |Description | -|--------------------|-----|------------------| -|mode |str |mode | -|value |str |value | -|is_case_insensitive |bool |isCaseInsensitive | +|Name |Type |Description | +|---------------------------------|--------------|------------------------------| +|access_device |accessDevice |accessDevice | +|line_port |str |linePort | +|private_identity |str |privateIdentity *Optional* | +|contact |List[contact] |contact *Optional* | +|static_registration_capable |bool |staticRegistrationCapable | +|use_domain |bool |useDomain | +|port_number |int |portNumber *Optional* | +|support_visual_device_management |bool |supportVisualDeviceManagement | +|use_hotline |bool |useHotline | +|hotline_contact |str |hotlineContact *Optional* |
-## `SearchCriteriaRoamingMscAddress`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `AccessDeviceMultipleIdentityEndpointAdd`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a system Roaming Network Msc Address. +Access device end point used in the context of add. +The endpoint is identified by its linePort (public Identity) and possibly a private +Identity. Port numbers are only used by devices with static line ordering. The +following elements are only used in XS data mode and ignored in AS data mode: +privateIdentity **Attributes:** -|Name |Type |Description | -|--------------------|-----|------------------| -|mode |str |mode | -|value |str |value | -|is_case_insensitive |bool |isCaseInsensitive | +|Name |Type |Description | +|-----------------|-------------|---------------------------| +|access_device |accessDevice |accessDevice | +|line_port |str |linePort | +|private_identity |str |privateIdentity *Optional* | +|contact |str |contact *Optional* | +|port_number |int |portNumber *Optional* |
-## `SearchCriteriaRoutePointName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `AccessDeviceMultipleIdentityEndpointKey`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a route point +Access device end point in the context of a modify or delete command. + +The endpoint is identified by its linePort (public Identity) and possibly a private +Identity. The following elements are only used in XS data mode and ignored in AS data +mode: privateIdentity **Attributes:** -|Name |Type |Description | -|--------------------|-----|------------------| -|mode |str |mode | -|value |str |value | -|is_case_insensitive |bool |isCaseInsensitive | +|Name |Type |Description | +|-----------------|-------------|---------------------------| +|access_device |accessDevice |accessDevice | +|line_port |str |linePort | +|private_identity |str |privateIdentity *Optional* |
-## `SearchCriteriaSIPContact`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `AccessDeviceMultipleIdentityEndpointWithType`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a SIP Contact. +Access device end point that can have multiple contacts. +The endpoint is identified by its linePort (public Identity) and possibly a private +Identity. Port numbers are only used by devices with static line ordering. **Attributes:** -|Name |Type |Description | -|--------------------|-----|------------------| -|mode |str |mode | -|value |str |value | -|is_case_insensitive |bool |isCaseInsensitive | +|Name |Type |Description | +|-----------------|-------------|---------------------------| +|access_device |accessDevice |accessDevice | +|device_type |str |deviceType | +|line_port |str |linePort | +|private_identity |str |privateIdentity *Optional* | +|contact |str |contact *Optional* | +|port_number |int |portNumber *Optional* | +|mac_address |str |macAddress *Optional* |
-## `SearchCriteriaScheduleName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `AutoAttendantKeyConfigurationEntry`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a schedule name. +The configuration entry of a key for Auto Attendant. +The following elements are only used in AS data mode: audioFile videoFile **Attributes:** -|Name |Type |Description | -|--------------------|-----|------------------| -|mode |str |mode | -|value |str |value | -|is_case_insensitive |bool |isCaseInsensitive | +|Name |Type |Description | +|-------------|----------|-----------------------| +|description |str |description *Optional* | +|action |str |action | +|phone_number |str |phoneNumber *Optional* | +|audio_file |audioFile |audioFile *Optional* | +|video_file |videoFile |videoFile *Optional* |
-## `SearchCriteriaServiceCode`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `AutoAttendantKeyConfigurationEntry19`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a Service Code. +The configuration entry of a key for Auto Attendant. +The following data elements are only valid for Standard Auto Attendants: submenuId **Attributes:** -|Name |Type |Description | -|--------------------|-----|------------------| -|mode |str |mode | -|value |str |value | -|is_case_insensitive |bool |isCaseInsensitive | +|Name |Type |Description | +|-------------|----------|-----------------------| +|description |str |description *Optional* | +|action |str |action | +|phone_number |str |phoneNumber *Optional* | +|audio_file |audioFile |audioFile *Optional* | +|video_file |videoFile |videoFile *Optional* | +|submenu_id |str |submenuId *Optional* |
-## `SearchCriteriaServiceCodeDescription`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `AutoAttendantKeyConfigurationEntry20`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a Service Code description. +The configuration entry of a key for Auto Attendant. +The following data elements are only used in AS data mode: audioFile videoFile +submenuId The following data elements are only valid for Standard Auto Attendants: +submenuId **Attributes:** -|Name |Type |Description | -|--------------------|-----|------------------| -|mode |str |mode | -|value |str |value | -|is_case_insensitive |bool |isCaseInsensitive | +|Name |Type |Description | +|-------------|----------|-----------------------| +|description |str |description *Optional* | +|action |str |action | +|phone_number |str |phoneNumber *Optional* | +|audio_file |audioFile |audioFile *Optional* | +|video_file |videoFile |videoFile *Optional* | +|submenu_id |str |submenuId *Optional* |
-## `SearchCriteriaServiceInstanceName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `AutoAttendantKeyConfigurationModifyEntry`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a service instance name. +The modify configuration entry of a key for Auto Attendant. +The following data elements are only valid for Standard Auto Attendants: submenuId **Attributes:** -|Name |Type |Description | -|--------------------|-----|------------------| -|mode |str |mode | -|value |str |value | -|is_case_insensitive |bool |isCaseInsensitive | +|Name |Type |Description | +|-------------|----------|-----------------------| +|description |str |description *Optional* | +|action |str |action | +|phone_number |str |phoneNumber *Optional* | +|audio_file |audioFile |audioFile *Optional* | +|video_file |videoFile |videoFile *Optional* | +|submenu_id |str |submenuId *Optional* |
-## `SearchCriteriaServiceProviderId`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `AutoAttendantKeyConfigurationModifyEntry20`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a service provider ID. +The modify configuration entry of a key for Auto Attendant. +The following data elements are only used in AS data mode: audioFile videoFile +submenuId The following data elements are only valid for Standard Auto Attendants: +submenuId **Attributes:** -|Name |Type |Description | -|--------------------|-----|------------------| -|mode |str |mode | -|value |str |value | -|is_case_insensitive |bool |isCaseInsensitive | +|Name |Type |Description | +|-------------|----------|-----------------------| +|description |str |description *Optional* | +|action |str |action | +|phone_number |str |phoneNumber *Optional* | +|audio_file |audioFile |audioFile *Optional* | +|video_file |videoFile |videoFile *Optional* | +|submenu_id |str |submenuId *Optional* |
-## `SearchCriteriaServiceProviderName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `AutoAttendantKeyConfigurationReadEntry20`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a service provider name. +The read configuration entry of a key for Auto Attendant. +The following data elements are only used in AS data mode: submenuId The following +data elements are only valid for Standard Auto Attendants: submenuId **Attributes:** -|Name |Type |Description | -|--------------------|-----|------------------| -|mode |str |mode | -|value |str |value | -|is_case_insensitive |bool |isCaseInsensitive | +|Name |Type |Description | +|-------------|----------|-----------------------| +|description |str |description *Optional* | +|action |str |action | +|phone_number |str |phoneNumber *Optional* | +|audio_file |audioFile |audioFile *Optional* | +|video_file |videoFile |videoFile *Optional* | +|submenu_id |str |submenuId *Optional* |
-## `SearchCriteriaServiceProviderNumberPortabilityQueryDigitPattern`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `AutoAttendantKeyReadConfiguration`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for digit pattern. +The read configuration of a key for Auto Attendant. **Attributes:** -|Name |Type |Description | -|--------------------|-----|------------------| -|mode |str |mode | -|value |str |value | -|is_case_insensitive |bool |isCaseInsensitive | +|Name |Type |Description| +|------|------|-----------| +|key |str |key | +|entry |entry |entry |
-## `SearchCriteriaServiceStatus`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `AutoAttendantKeyReadConfiguration19`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for services that are active or not. +The read configuration of a key for Auto Attendant. -This search criteria data type is only intended to be used by the commands introduced -by BW-2301. The commands are `EnterpriseUserCallWaitingSettingsGetListRequest()` and -`GroupUserCallWaitingSettingsGetListRequest()`. **Attributes:** -|Name |Type |Description| -|----------|-----|-----------| -|is_active |bool |isActive | +|Name |Type |Description| +|------|------|-----------| +|key |str |key | +|entry |entry |entry |
-## `SearchCriteriaSystemServiceDn`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `CPEDeviceOptionsRead`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a system service DN. +CPE device's options. **Attributes:** -|Name |Type |Description | -|--------------------|-----|------------------| -|mode |str |mode | -|value |str |value | -|is_case_insensitive |bool |isCaseInsensitive | +|Name |Type |Description | +|--------------------------------------|----------------------------------|---------------------------------------------| +|enable_monitoring |bool |enableMonitoring | +|reset_event |str |resetEvent *Optional* | +|config_type |str |configType | +|system_file_name |str |systemFileName *Optional* | +|device_file_format |str |deviceFileFormat *Optional* | +|device_management_device_type_options |deviceManagementDeviceTypeOptions |deviceManagementDeviceTypeOptions *Optional* |
-## `SearchCriteriaTitle`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `CPEDeviceOptionsRead16`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a user's title. +CPE device's options. **Attributes:** -|Name |Type |Description | -|--------------------|-----|------------------| -|mode |str |mode | -|value |str |value | -|is_case_insensitive |bool |isCaseInsensitive | +|Name |Type |Description | +|--------------------------------------|----------------------------------|---------------------------------------------| +|enable_monitoring |bool |enableMonitoring | +|reset_event |str |resetEvent *Optional* | +|config_type |str |configType | +|system_file_name |str |systemFileName *Optional* | +|device_file_format |str |deviceFileFormat *Optional* | +|device_management_device_type_options |deviceManagementDeviceTypeOptions |deviceManagementDeviceTypeOptions *Optional* |
-## `SearchCriteriaTrunkGroupName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `CPEDeviceOptionsRead16sp1`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a trunk group +CPE device's options. + **Attributes:** -|Name |Type |Description | -|--------------------|-----|------------------| -|mode |str |mode | -|value |str |value | -|is_case_insensitive |bool |isCaseInsensitive | +|Name |Type |Description | +|--------------------------------------|----------------------------------|---------------------------------------------| +|enable_monitoring |bool |enableMonitoring | +|config_type |str |configType *Optional* | +|system_file_name |str |systemFileName *Optional* | +|device_file_format |str |deviceFileFormat *Optional* | +|device_management_device_type_options |deviceManagementDeviceTypeOptions |deviceManagementDeviceTypeOptions *Optional* |
-## `SearchCriteriaUserExternalId`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `CPEDeviceOptionsRead21sp1`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a user's externalId. +CPE device's options. **Attributes:** -|Name |Type|Description| -|------|----|-----------| -|mode |str |mode | -|value |str |value | +|Name |Type |Description | +|--------------------------------------|----------------------------------|---------------------------------------------| +|enable_monitoring |bool |enableMonitoring | +|config_type |str |configType *Optional* | +|system_file_name |str |systemFileName *Optional* | +|device_file_format |str |deviceFileFormat *Optional* | +|device_management_device_type_options |deviceManagementDeviceTypeOptions |deviceManagementDeviceTypeOptions *Optional* |
-## `SearchCriteriaUserFirstName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `CPEDeviceOptionsRead22`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a user's first name. +CPE device's options. **Attributes:** -|Name |Type |Description | -|--------------------|-----|------------------| -|mode |str |mode | -|value |str |value | -|is_case_insensitive |bool |isCaseInsensitive | +|Name |Type |Description | +|--------------------------------------|----------------------------------|---------------------------------------------| +|enable_monitoring |bool |enableMonitoring | +|config_type |str |configType *Optional* | +|system_file_name |str |systemFileName *Optional* | +|device_file_format |str |deviceFileFormat *Optional* | +|device_management_device_type_options |deviceManagementDeviceTypeOptions |deviceManagementDeviceTypeOptions *Optional* |
-## `SearchCriteriaUserHotlineContact`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `CPEDeviceOptionsRead22V2`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a user's hotline contact. +CPE device's options. **Attributes:** -|Name |Type |Description | -|--------------------|-----|------------------| -|mode |str |mode | -|value |str |value | -|is_case_insensitive |bool |isCaseInsensitive | +|Name |Type |Description | +|--------------------------------------|----------------------------------|---------------------------------------------| +|enable_monitoring |bool |enableMonitoring | +|config_type |str |configType *Optional* | +|system_file_name |str |systemFileName *Optional* | +|device_file_format |str |deviceFileFormat *Optional* | +|device_management_device_type_options |deviceManagementDeviceTypeOptions |deviceManagementDeviceTypeOptions *Optional* |
-## `SearchCriteriaUserId`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `CPEDeviceOptionsRead22V3`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a user's userId. +CPE device's options. **Attributes:** -|Name |Type |Description | -|--------------------|-----|------------------| -|mode |str |mode | -|value |str |value | -|is_case_insensitive |bool |isCaseInsensitive | +|Name |Type |Description | +|--------------------------------------|----------------------------------|---------------------------------------------| +|enable_monitoring |bool |enableMonitoring | +|config_type |str |configType *Optional* | +|system_file_name |str |systemFileName *Optional* | +|device_file_format |str |deviceFileFormat *Optional* | +|device_management_device_type_options |deviceManagementDeviceTypeOptions |deviceManagementDeviceTypeOptions *Optional* |
-## `SearchCriteriaUserLastName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `CPEDeviceOptionsRead22V4`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a user's last name. +CPE device's options. **Attributes:** -|Name |Type |Description | -|--------------------|-----|------------------| -|mode |str |mode | -|value |str |value | -|is_case_insensitive |bool |isCaseInsensitive | +|Name |Type |Description | +|--------------------------------------|----------------------------------|---------------------------------------------| +|enable_monitoring |bool |enableMonitoring | +|config_type |str |configType *Optional* | +|system_file_name |str |systemFileName *Optional* | +|device_file_format |str |deviceFileFormat *Optional* | +|device_management_device_type_options |deviceManagementDeviceTypeOptions |deviceManagementDeviceTypeOptions *Optional* |
-## `SearchCriteriaUserName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `CallCenterAgentStatistics13mp8`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a user's full name. +Contains Call Center statistics for a specified agent. -This search criterion will be compared against multiple combinations of first name and -last name: First Name + ' ' + Last Name Last Name + ' ' + First Name Last Name + ', ' -+ First Name Hiragana Last Name + ' ' + Hiragana First Name Note that when specific -conditions are met, VON users will be included in the search results. **Attributes:** -|Name |Type |Description | -|--------------------|-----|------------------| -|mode |str |mode | -|value |str |value | -|is_case_insensitive |bool |isCaseInsensitive | +|Name |Type |Description | +|---------------------|--------------------|--------------------| +|agent_user_id |str |agentUserId | +|agent_display_names |agentDisplayNames |agentDisplayNames | +|available |bool |available | +|statistics_yesterday |statisticsYesterday |statisticsYesterday | +|statistics_today |statisticsToday |statisticsToday |
-## `SearchCriteriaUserPersonalMultiPartPhoneListName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `CallCenterAgentStatistics14sp9`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a name in a user personal phone list. +Contains Call Center statistics for a specified agent. -Note: For this search criterion, the searchMode is always ‘Contains’ and the multi- -part search criteria are always AND’ed. **Attributes:** -|Name |Type |Description | -|--------------------|----------|------------------| -|value |List[str] |value | -|is_case_insensitive |bool |isCaseInsensitive | +|Name |Type |Description | +|--------------------|------------------|------------------| +|agent_user_id |str |agentUserId | +|agent_display_names |agentDisplayNames |agentDisplayNames | +|available |bool |available | +|statistics |statistics |statistics |
-## `SearchCriteriaUserPersonalPhoneListName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `CallCenterAnnouncementFileListModify`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a name in a user personal phone list. +Contains a list of audio or video files to modify. **Attributes:** -|Name |Type |Description | -|--------------------|-----|------------------| -|mode |str |mode | -|value |str |value | -|is_case_insensitive |bool |isCaseInsensitive | +|Name |Type |Description | +|------|------|-----------------| +|file1 |file1 |file1 *Optional* | +|file2 |file2 |file2 *Optional* | +|file3 |file3 |file3 *Optional* | +|file4 |file4 |file4 *Optional* |
-## `SearchCriteriaUserPersonalPhoneListNumber`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `CallCenterAnnouncementFileListModify20`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a phone number in a user personal phone list. - +Contains a list of announcement repository files **Attributes:** -|Name |Type |Description | -|--------------------|-----|------------------| -|mode |str |mode | -|value |str |value | -|is_case_insensitive |bool |isCaseInsensitive | +|Name |Type |Description | +|------|------|-----------------| +|file1 |file1 |file1 *Optional* | +|file2 |file2 |file2 *Optional* | +|file3 |file3 |file3 *Optional* | +|file4 |file4 |file4 *Optional* |
-## `SearchCriteriaUserPlaceType`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `CallCenterAnnouncementFileListRead20`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching based on a user type – “User” or “Place”. - +Contains a list of announcement repository files **Attributes:** -|Name |Type|Description| -|------|----|-----------| -|value |str |value | +|Name |Type |Description | +|------|------|-----------------| +|file1 |file1 |file1 *Optional* | +|file2 |file2 |file2 *Optional* | +|file3 |file3 |file3 *Optional* | +|file4 |file4 |file4 *Optional* |
-## `SearchCriteriaYahooId`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `CallCenterReplacementSkilledAgents`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a user's yahoo id. +A list of agents grouped by skill levels. **Attributes:** -|Name |Type |Description | -|--------------------|-----|------------------| -|mode |str |mode | -|value |str |value | -|is_case_insensitive |bool |isCaseInsensitive | +|Name |Type |Description| +|------------|-------|-----------| +|skill_level |int |skillLevel | +|agents |agents |agents |
-## `SearchCriteriaZoneIPAddress`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `CallCenterReportIntervalDates`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a system zone's IP Address. +The call center enhanced reporting report interval, using dates. **Attributes:** -|Name |Type |Description | -|--------------------|-----|------------------| -|mode |str |mode | -|value |str |value | -|is_case_insensitive |bool |isCaseInsensitive | +|Name |Type |Description| +|-----------|----------|-----------| +|start_date |str |startDate | +|start_time |startTime |startTime | +|end_date |str |endDate | +|end_time |endTime |endTime |
-## `SecurityClassificationCustomizationActivation`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `CallCenterReportScheduleRecurrence`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The security classification customization activation. +A recurring schedule for call center enhanced reporting scheduled report. **Attributes:** -|Name |Type |Description | -|--------------|-----|-------------| -|name |str |name | -|is_customized |bool |isCustomized | +|Name |Type |Description | +|--------------|-------------|-------------| +|time_zone |str |timeZone | +|start_date |str |startDate | +|schedule_time |scheduleTime |scheduleTime | +|recurrence |recurrence |recurrence |
-## `SelectDistributionListMenuKeysModifyEntry`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `CallCenterReportScheduleTime`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The voice portal select distribution list menu keys modify entry. +A scheduled time for call center enhanced reporting scheduled report. **Attributes:** -|Name |Type|Description | -|--------------------------------------------------------|----|------------------------------------------------------------| -|return_to_previous_menu |str |returnToPreviousMenu *Optional* | -|repeat_menu_or_finish_entering_distribution_list_number |str |repeatMenuOrFinishEnteringDistributionListNumber *Optional* | +|Name |Type |Description | +|--------------|-------------|-------------| +|time_zone |str |timeZone | +|schedule_date |str |scheduleDate | +|schedule_time |scheduleTime |scheduleTime |
-## `SelectDistributionListMenuKeysReadEntry`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `CallMeNowToDnCriteriaModify`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The voice portal select distribution list menu keys. +The To dn criteria used on the call me now external number to be modified. **Attributes:** -|Name |Type|Description | -|--------------------------------------------------------|----|------------------------------------------------------------| -|return_to_previous_menu |str |returnToPreviousMenu | -|repeat_menu_or_finish_entering_distribution_list_number |str |repeatMenuOrFinishEnteringDistributionListNumber *Optional* | -
+|Name |Type |Description | +|-------------------------|----------------|---------------------------------| +|to_dn_criteria_selection |str |toDnCriteriaSelection *Optional* | +|phone_number_list |phoneNumberList |phoneNumberList *Optional* | + -## `SelectiveCallRejectionCriteriaCallType`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `CombinedAccessDeviceMultipleIdentityEndpointAdd`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The call type criteria used within an add/get request. +Access device end point used in the context of add. +The endpoint is identified by its linePort (public Identity) and possibly a private +Identity. Only Static Registration capable devices may have more than one contact +defined. Port numbers are only used by devices with static line ordering. In the +case an access device referenced by accessDevice does not exist, the device will be +added. The device attributes deviceType, protocol, netAddress, port, +outboundProxyServerNetAddress, stunServerNetAddress, macAddress, serialNumber, +description, physicalLocation, transportProtocol, useCustomUserNamePassword and +accessDeviceCredentials will be ignored if the access device already exists. **Attributes:** -|Name |Type |Description | -|----------------------------|----------|--------------------------| -|from_dn_criteria_selection |str |fromDnCriteriaSelection | -|include_anonymous_callers |bool |includeAnonymousCallers | -|include_unavailable_callers |bool |includeUnavailableCallers | -|phone_number |List[str] |phoneNumber *Optional* | +|Name |Type |Description | +|----------------------------------|------------------------|-----------------------------------------| +|access_device |accessDevice |accessDevice | +|line_port |str |linePort | +|private_identity |str |privateIdentity *Optional* | +|contact |str |contact *Optional* | +|port_number |int |portNumber *Optional* | +|device_type |str |deviceType *Optional* | +|protocol |str |protocol *Optional* | +|net_address |str |netAddress *Optional* | +|port |int |port *Optional* | +|outbound_proxy_server_net_address |str |outboundProxyServerNetAddress *Optional* | +|stun_server_net_address |str |stunServerNetAddress *Optional* | +|mac_address |str |macAddress *Optional* | +|serial_number |str |serialNumber *Optional* | +|description |str |description *Optional* | +|physical_location |str |physicalLocation *Optional* | +|transport_protocol |str |transportProtocol *Optional* | +|use_custom_user_name_password |bool |useCustomUserNamePassword *Optional* | +|access_device_credentials |accessDeviceCredentials |accessDeviceCredentials *Optional* |
-## `SendMessageToSelectedDistributionListMenuKeysModifyEntry`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `CombinedAccessDeviceMultipleIdentityEndpointModify`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The voice portal send message to selected distribution list menu keys modify entry. +Access device end point used in the context of modify. +The endpoint is identified by its linePort (public Identity) and possibly a private +Identity. Only Static Registration capable devices may have more than one contact +defined. Port numbers are only used by devices with static line ordering. In the +case an access device referenced by accessDevice does not exist, the device will be +added. When the device needs to be added, if the linePort is not specified, the +request will fail The device attributes deviceType, protocol, netAddress, port, +outboundProxyServerNetAddress, stunServerNetAddress, macAddress, serialNumber, +description, physicalLocation, transportProtocol, useCustomUserNamePassword and +accessDeviceCredentials will be ignored if the access device already exists. **Attributes:** -|Name |Type|Description | -|-------------------------------------|----|--------------------------------------------| -|confirm_sending_to_distribution_list |str |confirmSendingToDistributionList *Optional* | -|cancel_sending_to_distribution_list |str |cancelSendingToDistributionList *Optional* | +|Name |Type |Description | +|----------------------------------|------------------------|-----------------------------------------| +|access_device |accessDevice |accessDevice *Optional* | +|line_port |str |linePort *Optional* | +|private_identity |str |privateIdentity *Optional* | +|contact |str |contact *Optional* | +|port_number |int |portNumber *Optional* | +|device_type |str |deviceType *Optional* | +|protocol |str |protocol *Optional* | +|net_address |str |netAddress *Optional* | +|port |int |port *Optional* | +|outbound_proxy_server_net_address |str |outboundProxyServerNetAddress *Optional* | +|stun_server_net_address |str |stunServerNetAddress *Optional* | +|mac_address |str |macAddress *Optional* | +|serial_number |str |serialNumber *Optional* | +|description |str |description *Optional* | +|physical_location |str |physicalLocation *Optional* | +|transport_protocol |str |transportProtocol *Optional* | +|use_custom_user_name_password |bool |useCustomUserNamePassword *Optional* | +|access_device_credentials |accessDeviceCredentials |accessDeviceCredentials *Optional* |
-## `SendMessageToSelectedDistributionListMenuKeysReadEntry`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `CombinedGroupServiceAuthorization`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The voice portal send message to selected distribution list menu keys. +Authorize a group service. **Attributes:** -|Name |Type|Description | -|-------------------------------------|----|--------------------------------------------| -|confirm_sending_to_distribution_list |str |confirmSendingToDistributionList *Optional* | -|cancel_sending_to_distribution_list |str |cancelSendingToDistributionList | +|Name |Type |Description | +|--------------------|-------------------|------------------------------| +|service_name |str |serviceName | +|authorized_quantity |authorizedQuantity |authorizedQuantity *Optional* |
-## `SendToAllGroupMembersMenuKeysModifyEntry`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `CombinedServiceInstanceAddProfile`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The voice portal send to all group memeber menu keys modify entry. +Service Profile Information for group service. +When name, callingLineIdLastName and callingLineIdFirstName are not included, the +values in the corresponding service instance template (if this is used to add a Hunt +Group, for example, the name will come from the Hunt Group template) will be used. +Otherwise, the request will fail. If the phoneNumber has not been assigned to the +group, it will be added to group and service provider if needed. **Attributes:** -|Name |Type|Description | -|--------------------------------|----|---------------------------------------| -|confirm_sending_to_entire_group |str |confirmSendingToEntireGroup *Optional* | -|cancel_sending_to_entire_group |str |cancelSendingToEntireGroup *Optional* | +|Name |Type |Description | +|-----------------------------|-----------|------------------------------------| +|name |str |name *Optional* | +|calling_line_id_last_name |str |callingLineIdLastName *Optional* | +|calling_line_id_first_name |str |callingLineIdFirstName *Optional* | +|hiragana_last_name |str |hiraganaLastName *Optional* | +|hiragana_first_name |str |hiraganaFirstName *Optional* | +|phone_number |str |phoneNumber *Optional* | +|extension |str |extension *Optional* | +|password |str |password *Optional* | +|department |department |department *Optional* | +|language |str |language *Optional* | +|time_zone |str |timeZone *Optional* | +|alias |List[str] |alias *Optional* | +|public_user_identity |str |publicUserIdentity *Optional* | +|calling_line_id_phone_number |str |callingLineIdPhoneNumber *Optional* |
-## `SendToAllGroupMembersMenuKeysReadEntry`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `CombinedServicePackAssignment`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The voice portal send to all group memeber menu keys. +Assign a service pack to user. +If the service pack has not been authorized to service provider or group, it will be +authorized. If the service pack needs to be authorized at group/service provider +levels, the authorizedQuantity will be used. Otherwise, it will be ignored. If the +authorizedQuantity is not included, the quantity will come from the group template for +the service pack. If a template does not exist, the service quantity will be set to +unlimited. **Attributes:** -|Name |Type|Description | -|--------------------------------|----|----------------------------| -|confirm_sending_to_entire_group |str |confirmSendingToEntireGroup | -|cancel_sending_to_entire_group |str |cancelSendingToEntireGroup | +|Name |Type |Description | +|--------------------|-------------------|------------------------------| +|service_pack_name |str |servicePackName | +|authorized_quantity |authorizedQuantity |authorizedQuantity *Optional* |
-## `SendToDistributionListMenuKeysModifyEntry`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `CombinedServicePackAuthorization`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The voice portal send to distribution list menu keys modify entry. +Authorize a service pack. **Attributes:** -|Name |Type|Description | -|-------------------------------------------|----|-------------------------------------------------| -|send_message_to_selected_distribution_list |str |sendMessageToSelectedDistributionList *Optional* | -|select_distribution_list |str |selectDistributionList *Optional* | -|review_selected_distribution_list |str |reviewSelectedDistributionList *Optional* | -|return_to_previous_menu |str |returnToPreviousMenu *Optional* | -|repeat_menu |str |repeatMenu *Optional* | +|Name |Type |Description | +|--------------------|-------------------|------------------------------| +|service_pack_name |str |servicePackName | +|authorized_quantity |authorizedQuantity |authorizedQuantity *Optional* |
-## `SendToDistributionListMenuKeysReadEntry`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `CombinedSharedCallAppearanceAccessDeviceMultipleIdentityEndpoint`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The voice portal send to distribution list menu keys. +Access device end point for Shared Call Appearance Service used in the context of add. +The endpoint is identified by its linePort (public Identity) and possibly a private +Identity. Port numbers are only used by devices with static line ordering. In the +case an access device referenced by accessDevice does not exist, the device will be +added. When elements for isActive, allowOrigination, allowTermination and allowVideo +are not included in the request, the values for them will come for the Shared Call +Appearance endpoints template. If the template does not exist, the request using this +data type will fail. The device attributes deviceType, protocol, netAddress, port, +outboundProxyServerNetAddress, stunServerNetAddress, macAddress, serialNumber, +description, physicalLocation, transportProtocol, useCustomUserNamePassword and +accessDeviceCredentials will be ignored if the access device already exists. **Attributes:** -|Name |Type|Description | -|-------------------------------------------|----|------------------------------------------| -|send_message_to_selected_distribution_list |str |sendMessageToSelectedDistributionList | -|select_distribution_list |str |selectDistributionList *Optional* | -|review_selected_distribution_list |str |reviewSelectedDistributionList *Optional* | -|return_to_previous_menu |str |returnToPreviousMenu | -|repeat_menu |str |repeatMenu *Optional* | +|Name |Type |Description | +|----------------------------------|------------------------|-----------------------------------------| +|access_device |accessDevice |accessDevice | +|line_port |str |linePort | +|private_identity |str |privateIdentity *Optional* | +|contact |str |contact *Optional* | +|port_number |int |portNumber *Optional* | +|is_active |bool |isActive *Optional* | +|allow_origination |bool |allowOrigination *Optional* | +|allow_termination |bool |allowTermination *Optional* | +|allow_video |bool |allowVideo *Optional* | +|device_type |str |deviceType *Optional* | +|protocol |str |protocol *Optional* | +|net_address |str |netAddress *Optional* | +|port |int |port *Optional* | +|outbound_proxy_server_net_address |str |outboundProxyServerNetAddress *Optional* | +|stun_server_net_address |str |stunServerNetAddress *Optional* | +|mac_address |str |macAddress *Optional* | +|serial_number |str |serialNumber *Optional* | +|description |str |description *Optional* | +|physical_location |str |physicalLocation *Optional* | +|transport_protocol |str |transportProtocol *Optional* | +|use_custom_user_name_password |bool |useCustomUserNamePassword *Optional* | +|access_device_credentials |accessDeviceCredentials |accessDeviceCredentials *Optional* |
-## `SendToPersonMenuKeysModifyEntry`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `CombinedUserServiceAssignment`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The voice portal send to person menu keys modify entry. +Assign a service user. +If the service has not been authorized to service provider or group, it will be +authorized. If the service needs to be authorized at group/service provider levels, +the authorizedQuantity will be used. Otherwise, it will be ignored. If the +authorizedQuantity is not included, the quantity will come from the group template for +the service. If a template does not exist, the service quantity will be set to +unlimited. **Attributes:** -|Name |Type|Description | -|------------------------------------------------|----|----------------------------------------------------| -|confirm_sending_message |str |confirmSendingMessage *Optional* | -|cancel_sending_message |str |cancelSendingMessage *Optional* | -|finish_entering_number_where_to_send_message_to |str |finishEnteringNumberWhereToSendMessageTo *Optional* | -|finish_forwarding_or_sending_message |str |finishForwardingOrSendingMessage *Optional* | +|Name |Type |Description | +|--------------------|-------------------|------------------------------| +|user_service |str |userService | +|authorized_quantity |authorizedQuantity |authorizedQuantity *Optional* |
-## `SendToPersonMenuKeysReadEntry`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `CombinedUserServiceAuthorization`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The voice portal send to person menu keys. +Authorize a user service. **Attributes:** -|Name |Type|Description | -|------------------------------------------------|----|-----------------------------------------| -|confirm_sending_message |str |confirmSendingMessage | -|cancel_sending_message |str |cancelSendingMessage | -|finish_entering_number_where_to_send_message_to |str |finishEnteringNumberWhereToSendMessageTo | -|finish_forwarding_or_sending_message |str |finishForwardingOrSendingMessage | +|Name |Type |Description | +|--------------------|-------------------|------------------------------| +|service_name |str |serviceName | +|authorized_quantity |authorizedQuantity |authorizedQuantity *Optional* |
-## `SequentialRingLocation`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `CommPilotExpressAvailableInOffice`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Sequential Ring Location. +CommPilot Express Available In Office Settings. -Replaced By: SequentialRingLocation14sp4 **Attributes:** -|Name |Type|Description | -|----------------|----|-----------------------| -|phone_number |str |phoneNumber *Optional* | -|number_of_rings |int |numberOfRings | +|Name |Type |Description | +|--------------------------------|----------------|---------------------------------------| +|additional_phone_number_to_ring |str |additionalPhoneNumberToRing *Optional* | +|busy_setting |busySetting |busySetting | +|no_answer_setting |noAnswerSetting |noAnswerSetting |
-## `SequentialRingLocation14sp4`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `CommPilotExpressAvailableInOfficeModify`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Sequential Ring Location. +CommPilot Express Available In Office Settings. **Attributes:** -|Name |Type |Description | -|-----------------------------|-----|---------------------------| -|phone_number |str |phoneNumber *Optional* | -|number_of_rings |int |numberOfRings | -|answer_confirmation_required |bool |answerConfirmationRequired | +|Name |Type |Description | +|--------------------------------|----------------|---------------------------------------| +|additional_phone_number_to_ring |str |additionalPhoneNumberToRing *Optional* | +|busy_setting |busySetting |busySetting *Optional* | +|no_answer_setting |noAnswerSetting |noAnswerSetting *Optional* |
-## `SequentialRingLocationModify`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `CommPilotExpressAvailableOutOfOffice`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Sequential Ring Location. +CommPilot Express Available Out Of Office Configuration used in the context of a get. **Attributes:** -|Name |Type |Description | -|-----------------------------|-----|--------------------------------------| -|phone_number |str |phoneNumber *Optional* | -|number_of_rings |int |numberOfRings *Optional* | -|answer_confirmation_required |bool |answerConfirmationRequired *Optional* | +|Name |Type |Description | +|---------------------|-------------------|-------------------| +|incoming_calls |incomingCalls |incomingCalls | +|incoming_call_notify |incomingCallNotify |incomingCallNotify |
-## `ServiceActivation`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `CommPilotExpressAvailableOutOfOfficeModify`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Service Instance active status indicator +CommPilot Express Available Out Of Office Configuration used in the context of a +modify. + **Attributes:** -|Name |Type |Description | -|----------------|-----|--------------| -|service_user_id |str |serviceUserId | -|is_active |bool |isActive | +|Name |Type |Description | +|---------------------|-------------------|------------------------------| +|incoming_calls |incomingCalls |incomingCalls *Optional* | +|incoming_call_notify |incomingCallNotify |incomingCallNotify *Optional* |
-## `ServiceAttributeEntry`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `CommPilotExpressBusy`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The service attributes name and value pair. +CommPilot Express Available In Office Configuration used in the context of a get. **Attributes:** -|Name |Type|Description| -|------|----|-----------| -|name |str |name | -|value |str |value | +|Name |Type |Description | +|------------------|----------------|----------------| +|incoming_calls |incomingCalls |incomingCalls | +|voice_mail_notify |voiceMailNotify |voiceMailNotify |
-## `ServiceAttributeEntryRead`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `CommPilotExpressBusyModify`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The service attributes name and value pair. +CommPilot Express Available In Office Configuration used in the context of a modify. **Attributes:** -|Name |Type|Description | -|------|----|-----------------| -|name |str |name | -|value |str |value *Optional* | +|Name |Type |Description | +|------------------|----------------|---------------------------| +|incoming_calls |incomingCalls |incomingCalls *Optional* | +|voice_mail_notify |voiceMailNotify |voiceMailNotify *Optional* |
-## `ServiceCodeEntry`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `CommPilotExpressUnavailable`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The service code entry. +CommPilot Express Unavailable Configuration used in the context of a get. **Attributes:** -|Name |Type|Description | -|-------------|----|------------| -|service_code |str |serviceCode | -|description |str |description | +|Name |Type |Description | +|--------------------|--------------|------------------| +|incoming_calls |incomingCalls |incomingCalls | +|voice_mail_greeting |str |voiceMailGreeting |
-## `ServicePolicyAttributeEntry`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `CommPilotExpressUnavailableModify`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The service policy attributes name and value pair. +CommPilot Express Unavailable Configuration used in the context of a modify. **Attributes:** -|Name |Type|Description | -|------|----|-----------------| -|name |str |name | -|value |str |value *Optional* | +|Name |Type |Description | +|--------------------|--------------|-----------------------------| +|incoming_calls |incomingCalls |incomingCalls *Optional* | +|voice_mail_greeting |str |voiceMailGreeting *Optional* |
-## `ServicePolicyAttributeModifyEntry`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `ConsolidatedAccessDeviceMultipleIdentityEndpointAndContactAdd`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The service policy attributes name and value pair. +Access device end point used in the context of add. +The endpoint is identified by its linePort (public Identity) and possibly a private +Identity. In XS data mode, only one contact can be defined. Only Static Registration +capable devices may have more than one contact defined. Port numbers are only used by +devices with static line ordering. In the case an access device referenced by +accessDevice does not exist, the device will be added. The device attributes +deviceType, protocol, netAddress, port, outboundProxyServerNetAddress, +stunServerNetAddress, macAddress, serialNumber, description, physicalLocation, +transportProtocol, useCustomUserNamePassword and accessDeviceCredentials will be +ignored if the access device already exists. **Attributes:** -|Name |Type|Description| -|------|----|-----------| -|name |str |name | -|value |str |value | +|Name |Type |Description | +|----------------------------------|------------------------|-----------------------------------------| +|access_device |accessDevice |accessDevice | +|line_port |str |linePort | +|private_identity |str |privateIdentity *Optional* | +|contact |List[str] |contact *Optional* | +|port_number |int |portNumber *Optional* | +|device_type |str |deviceType *Optional* | +|protocol |str |protocol *Optional* | +|net_address |str |netAddress *Optional* | +|port |int |port *Optional* | +|outbound_proxy_server_net_address |str |outboundProxyServerNetAddress *Optional* | +|stun_server_net_address |str |stunServerNetAddress *Optional* | +|mac_address |str |macAddress *Optional* | +|serial_number |str |serialNumber *Optional* | +|description |str |description *Optional* | +|physical_location |str |physicalLocation *Optional* | +|transport_protocol |str |transportProtocol *Optional* | +|use_custom_user_name_password |bool |useCustomUserNamePassword *Optional* | +|access_device_credentials |accessDeviceCredentials |accessDeviceCredentials *Optional* |
-## `ServicePolicyProfileKey`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `ConsolidatedAccessDeviceMultipleIdentityEndpointAndContactAdd22`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The service policy profile key. +Access device end point used in the context of add. +The endpoint is identified by its linePort (public Identity) and possibly a private +Identity. In XS data mode, only one contact can be defined. Only Static Registration +capable devices may have more than one contact defined. Port numbers are only used by +devices with static line ordering. In the case an access device referenced by +accessDevice does not exist, the device will be added. The device attributes +deviceType, protocol, netAddress, port, outboundProxyServerNetAddress, +stunServerNetAddress, macAddress, serialNumber, description, physicalLocation, +transportProtocol, useCustomUserNamePassword and accessDeviceCredentials will be +ignored if the access device already exists. The following elements are only used in +AS data mode and ignored in XS data mode: useHotline, use value false in XS data mode +hotlineContact **Attributes:** -|Name |Type|Description| -|---------|----|-----------| -|name |str |name | -|category |str |category | +|Name |Type |Description | +|----------------------------------|------------------------|-----------------------------------------| +|access_device |accessDevice |accessDevice | +|line_port |str |linePort | +|private_identity |str |privateIdentity *Optional* | +|contact |List[str] |contact *Optional* | +|port_number |int |portNumber *Optional* | +|device_type |str |deviceType *Optional* | +|protocol |str |protocol *Optional* | +|net_address |str |netAddress *Optional* | +|port |int |port *Optional* | +|outbound_proxy_server_net_address |str |outboundProxyServerNetAddress *Optional* | +|stun_server_net_address |str |stunServerNetAddress *Optional* | +|mac_address |str |macAddress *Optional* | +|serial_number |str |serialNumber *Optional* | +|description |str |description *Optional* | +|physical_location |str |physicalLocation *Optional* | +|transport_protocol |str |transportProtocol *Optional* | +|use_custom_user_name_password |bool |useCustomUserNamePassword *Optional* | +|access_device_credentials |accessDeviceCredentials |accessDeviceCredentials *Optional* | +|use_hotline |bool |useHotline | +|hotline_contact |str |hotlineContact *Optional* |
-## `ServiceProviderAdmin`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `ConsolidatedAccessDeviceMultipleIdentityEndpointAndContactModify`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The common Service Provider Admin elements. +Access device end point used in the context of modify. +. The endpoint is identified by its linePort (public Identity) and possibly a private +Identity. Only Static Registration capable devices may have more than one contact +defined. Only the first contact in contactList is used in XS data mode. Port numbers +are only used by devices with static line ordering. In the case an access device +referenced by accessDevice does not exist, the device will be added. When the device +needs to be added, if the linePort is not specified, the request will fail If the +deviceType is included in the request a new device will be created using the type +unless a device with the same name already exists. The device attributes protocol, +netAddress, port, outboundProxyServerNetAddress, stunServerNetAddress, macAddress, +serialNumber, description, physicalLocation, transportProtocol, +useCustomUserNamePassword and accessDeviceCredentials will be ignored if the access +device already exists. The following elements are only used in AS data mode and +ignored in XS data mode: useHotline hotlineContact **Attributes:** -|Name |Type|Description | -|-------------------|----|---------------------| -|user_id |str |userId | -|first_name |str |firstName *Optional* | -|last_name |str |lastName *Optional* | -|password |str |password *Optional* | -|language |str |language *Optional* | -|administrator_type |str |administratorType | +|Name |Type |Description | +|----------------------------------|------------------------|-----------------------------------------| +|access_device |accessDevice |accessDevice *Optional* | +|line_port |str |linePort *Optional* | +|private_identity |str |privateIdentity *Optional* | +|contact_list |contactList |contactList *Optional* | +|port_number |int |portNumber *Optional* | +|device_type |str |deviceType *Optional* | +|protocol |str |protocol *Optional* | +|net_address |str |netAddress *Optional* | +|port |int |port *Optional* | +|outbound_proxy_server_net_address |str |outboundProxyServerNetAddress *Optional* | +|stun_server_net_address |str |stunServerNetAddress *Optional* | +|mac_address |str |macAddress *Optional* | +|serial_number |str |serialNumber *Optional* | +|description |str |description *Optional* | +|physical_location |str |physicalLocation *Optional* | +|transport_protocol |str |transportProtocol *Optional* | +|use_custom_user_name_password |bool |useCustomUserNamePassword *Optional* | +|access_device_credentials |accessDeviceCredentials |accessDeviceCredentials *Optional* | +|use_hotline |bool |useHotline *Optional* | +|hotline_contact |str |hotlineContact *Optional* |
-## `ServiceProviderBroadWorksMobilityGetRequest21sp1V2`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `ConsolidatedGroupServiceAssignment`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Get the service provider BroadWorks Mobility service settings. +Authorize and assign a group service. -The response is either a ServiceProviderBroadWorksMobilityGetResponse21sp1V2 or an -`ErrorResponse()`. Replaced by `ServiceProviderBroadWorksMobilityGetRequest22V2()`. +The authorizedQuantity will be used at the group level if provided; otherwise, the +service quantity will be set to unlimited. The command will fail if the authorized +quantity set at the service provider level is insufficient. **Attributes:** -|Name |Type|Description | -|--------------------|----|------------------| -|service_provider_id |str |serviceProviderId | +|Name |Type |Description | +|--------------------|-------------------|------------------------------| +|group_service_name |str |groupServiceName | +|authorized_quantity |authorizedQuantity |authorizedQuantity *Optional* |
-## `ServiceProviderBroadWorksMobilityGetResponse21sp1V2`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `ConsolidatedServicePackAssignment`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The response to a ServiceProviderBroadWorksMobilityGetRequest21sp1V2. +Assign a service pack to user. -Replaced by `ServiceProviderBroadWorksMobilityGetResponse22V2()`. +If the service pack has not been authorized to the group, it will be authorized. The +authorizedQuantity will be used at the group level if provided; otherwise, the service +quantity will be set to unlimited. The command will fail if the authorized quantity +set at the service provider level is insufficient. **Attributes:** -|Name |Type |Description | -|-----------------------------------------------|-----|------------------------------------------| -|use_setting_level |str |useSettingLevel | -|enable_location_services |bool |enableLocationServices | -|enable_msrn_lookup |bool |enableMSRNLookup | -|enable_mobile_state_checking |bool |enableMobileStateChecking | -|deny_call_originations |bool |denyCallOriginations | -|deny_call_terminations |bool |denyCallTerminations | -|enable_announcement_suppression |bool |enableAnnouncementSuppression | -|enable_internal_clid_delivery_access_locations |bool |enableInternalCLIDDeliveryAccessLocations | -|enable_enhanced_unreachable_state_checking |bool |enableEnhancedUnreachableStateChecking | -|enable_network_call_barring_status_check |bool |enableNetworkCallBarringStatusCheck | +|Name |Type |Description | +|--------------------|-------------------|------------------------------| +|service_pack_name |str |servicePackName | +|authorized_quantity |authorizedQuantity |authorizedQuantity *Optional* |
-## `ServiceProviderCommunicationBarringHierarchicalCallMeNowRule`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `ConsolidatedSharedCallAppearanceAccessDeviceMultipleIdentityEndpoint`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Service Provider Communication Barring Hierarchical Call Me Now Rule - -**Attributes:** +Access device end point for Shared Call Appearance Service used in the context of add. -|Name |Type|Description | -|-----------------------|----|--------------------------------| -|criteria |str |criteria *Optional* | -|digit_pattern_criteria |str |digitPatternCriteria *Optional* | -|action |str |action | -|call_timeout_seconds |int |callTimeoutSeconds *Optional* | -|time_schedule |str |timeSchedule *Optional* | -|holiday_schedule |str |holidaySchedule *Optional* | -|priority |str |priority | -
- - -## `ServiceProviderCommunicationBarringHierarchicalOriginatingRule`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) - -
-Service Provider Communication Barring Hierarchical Originating Rule - -**Attributes:** - -|Name |Type|Description | -|-----------------------|----|--------------------------------| -|criteria |str |criteria *Optional* | -|digit_pattern_criteria |str |digitPatternCriteria *Optional* | -|action |str |action | -|treatment_id |str |treatmentId *Optional* | -|transfer_number |str |transferNumber *Optional* | -|call_timeout_seconds |int |callTimeoutSeconds *Optional* | -|time_schedule |str |timeSchedule *Optional* | -|holiday_schedule |str |holidaySchedule *Optional* | -|priority |str |priority | -
- - -## `ServiceProviderCommunicationBarringHierarchicalRedirectingRule`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) - -
-Service Provider Communication Barring Hierarchical Redirecting Rule +The endpoint is identified by its linePort (public Identity) and possibly a private +Identity. Port numbers are only used by devices with static line ordering. In the +case an access device referenced by accessDevice does not exist, the device will be +added. The device attributes deviceType, protocol, netAddress, port, +outboundProxyServerNetAddress, stunServerNetAddress, macAddress, serialNumber, +description, physicalLocation, transportProtocol, useCustomUserNamePassword and +accessDeviceCredentials will be ignored if the access device already exists. The +following elements are only used in XS data mode and ignored in AS data mode: +privateIdentity **Attributes:** -|Name |Type|Description | -|-----------------------|----|--------------------------------| -|criteria |str |criteria *Optional* | -|digit_pattern_criteria |str |digitPatternCriteria *Optional* | -|action |str |action | -|call_timeout_seconds |int |callTimeoutSeconds *Optional* | -|time_schedule |str |timeSchedule *Optional* | -|holiday_schedule |str |holidaySchedule *Optional* | -|priority |str |priority | +|Name |Type |Description | +|----------------------------------|------------------------|-----------------------------------------| +|access_device |accessDevice |accessDevice | +|line_port |str |linePort | +|private_identity |str |privateIdentity *Optional* | +|contact |str |contact *Optional* | +|port_number |int |portNumber *Optional* | +|is_active |bool |isActive | +|allow_origination |bool |allowOrigination | +|allow_termination |bool |allowTermination | +|device_type |str |deviceType *Optional* | +|protocol |str |protocol *Optional* | +|net_address |str |netAddress *Optional* | +|port |int |port *Optional* | +|outbound_proxy_server_net_address |str |outboundProxyServerNetAddress *Optional* | +|stun_server_net_address |str |stunServerNetAddress *Optional* | +|mac_address |str |macAddress *Optional* | +|serial_number |str |serialNumber *Optional* | +|description |str |description *Optional* | +|physical_location |str |physicalLocation *Optional* | +|transport_protocol |str |transportProtocol *Optional* | +|use_custom_user_name_password |bool |useCustomUserNamePassword *Optional* | +|access_device_credentials |accessDeviceCredentials |accessDeviceCredentials *Optional* | +|use_hotline |bool |useHotline *Optional* | +|hotline_contact |str |hotlineContact *Optional* |
-## `ServiceProviderCommunicationBarringProfileGetRequest19sp1V2`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `ConsolidatedSharedCallAppearanceAccessDeviceMultipleIdentityEndpointAdd22`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Get an existing Communication Barring Profile. +Access device end point for Shared Call Appearance Service used in the context of add. -The response is either a ServiceProviderCommunicationBarringProfileGetResponse19sp1V2 -or an `ErrorResponse()`. +The endpoint is identified by its linePort (public Identity) and possibly a private +Identity. Port numbers are only used by devices with static line ordering. In the +case an access device referenced by accessDevice does not exist, the device will be +added. The device attributes deviceType, protocol, netAddress, port, +outboundProxyServerNetAddress, stunServerNetAddress, macAddress, serialNumber, +description, physicalLocation, transportProtocol, useCustomUserNamePassword and +accessDeviceCredentials will be ignored if the access device already exists. The +following elements are only used in XS data mode and ignored in AS data mode: +privateIdentity The following elements are only used in AS data mode and ignored in XS +data mode: useHotline, use value false in XS data mode hotlineContact **Attributes:** -|Name |Type|Description | -|--------------------|----|------------------| -|service_provider_id |str |serviceProviderId | -|name |str |name | +|Name |Type |Description | +|----------------------------------|------------------------|-----------------------------------------| +|access_device |accessDevice |accessDevice | +|line_port |str |linePort | +|private_identity |str |privateIdentity *Optional* | +|contact |str |contact *Optional* | +|port_number |int |portNumber *Optional* | +|is_active |bool |isActive | +|allow_origination |bool |allowOrigination | +|allow_termination |bool |allowTermination | +|device_type |str |deviceType *Optional* | +|protocol |str |protocol *Optional* | +|net_address |str |netAddress *Optional* | +|port |int |port *Optional* | +|outbound_proxy_server_net_address |str |outboundProxyServerNetAddress *Optional* | +|stun_server_net_address |str |stunServerNetAddress *Optional* | +|mac_address |str |macAddress *Optional* | +|serial_number |str |serialNumber *Optional* | +|description |str |description *Optional* | +|physical_location |str |physicalLocation *Optional* | +|transport_protocol |str |transportProtocol *Optional* | +|use_custom_user_name_password |bool |useCustomUserNamePassword *Optional* | +|access_device_credentials |accessDeviceCredentials |accessDeviceCredentials *Optional* | +|use_hotline |bool |useHotline | +|hotline_contact |str |hotlineContact *Optional* |
-## `ServiceProviderVoiceMessagingGroupSettingsAdd`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `ConsolidatedUserServiceAssignment`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-A service provider's or enterprise's voice messaging settings used in the context of -add. +Assign a user service. +If the service has not been authorized to the group, it will be authorized. The +authorizedQuantity will be used at the group level if provided; otherwise, the service +quantity will be set to unlimited. The command will fail if the authorized quantity +set at the service provider level is insufficient. **Attributes:** -|Name |Type |Description | -|-----------------------------------------------------|-----|----------------------------------------------| -|delivery_from_address |str |deliveryFromAddress *Optional* | -|notification_from_address |str |notificationFromAddress *Optional* | -|voice_portal_lockout_from_address |str |voicePortalLockoutFromAddress *Optional* | -|use_system_default_delivery_from_address |bool |useSystemDefaultDeliveryFromAddress | -|use_system_default_notification_from_address |bool |useSystemDefaultNotificationFromAddress | -|use_system_default_voice_portal_lockout_from_address |bool |useSystemDefaultVoicePortalLockoutFromAddress | +|Name |Type |Description | +|--------------------|-------------------|------------------------------| +|user_service_name |str |userServiceName | +|authorized_quantity |authorizedQuantity |authorizedQuantity *Optional* |
-## `SimultaneousRingNumber`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `CriteriaFromDnModify`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Simultaneous Ring number entry. +The from dn criteria used within a modify request. **Attributes:** -|Name |Type |Description | -|-----------------------------|-----|---------------------------| -|phone_number |str |phoneNumber | -|answer_confirmation_required |bool |answerConfirmationRequired | +|Name |Type |Description | +|----------------------------|----------------|-------------------------------------| +|from_dn_criteria_selection |str |fromDnCriteriaSelection *Optional* | +|include_anonymous_callers |bool |includeAnonymousCallers *Optional* | +|include_unavailable_callers |bool |includeUnavailableCallers *Optional* | +|phone_number_list |phoneNumberList |phoneNumberList *Optional* |
-## `SortByAdminFirstName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `DeviceManagementDeviceTypeModifyOptions`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The sort criteria specifies the administrator first name as the column for the sort, -whether the sort is ascending or descending, and whether the sort is case sensitive. +Device Management System device type options during a modify request. **Attributes:** -|Name |Type |Description | -|------------------|-----|----------------| -|is_ascending |bool |isAscending | -|is_case_sensitive |bool |isCaseSensitive | +|Name |Type |Description | +|---------------------------------------|------------------------|----------------------------------------------| +|device_access_protocol |str |deviceAccessProtocol *Optional* | +|tag_mode |str |tagMode *Optional* | +|tag_set |str |tagSet *Optional* | +|allow_device_profile_custom_tag_set |bool |allowDeviceProfileCustomTagSet *Optional* | +|allow_group_custom_tag_set |bool |allowGroupCustomTagSet *Optional* | +|send_email_upon_reset_failure |bool |sendEmailUponResetFailure *Optional* | +|device_access_net_address |str |deviceAccessNetAddress *Optional* | +|device_access_port |int |deviceAccessPort *Optional* | +|device_access_context |str |deviceAccessContext *Optional* | +|default_device_language |str |defaultDeviceLanguage *Optional* | +|default_device_encoding |str |defaultDeviceEncoding *Optional* | +|access_device_credentials |accessDeviceCredentials |accessDeviceCredentials *Optional* | +|use_http_digest_authentication |bool |useHttpDigestAuthentication *Optional* | +|mac_based_file_authentication |bool |macBasedFileAuthentication *Optional* | +|user_name_password_file_authentication |bool |userNamePasswordFileAuthentication *Optional* | +|mac_in_non_request_uri |bool |macInNonRequestURI *Optional* | +|mac_format_in_non_request_uri |str |macFormatInNonRequestURI *Optional* |
-## `SortByAdminId`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `DeviceManagementDeviceTypeModifyOptions16`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The sort criteria specifies the administrator id as the column for the sort, whether -the sort is ascending or descending, and whether the sort is case sensitive. +Device Management System device type options during a modify request. **Attributes:** -|Name |Type |Description | -|------------------|-----|----------------| -|is_ascending |bool |isAscending | -|is_case_sensitive |bool |isCaseSensitive | +|Name |Type |Description | +|---------------------------------------|------------------------|----------------------------------------------| +|device_access_protocol |str |deviceAccessProtocol *Optional* | +|tag_mode |str |tagMode *Optional* | +|tag_set |str |tagSet *Optional* | +|allow_device_profile_custom_tag_set |bool |allowDeviceProfileCustomTagSet *Optional* | +|allow_group_custom_tag_set |bool |allowGroupCustomTagSet *Optional* | +|allow_sp_custom_tag_set |bool |allowSpCustomTagSet *Optional* | +|send_email_upon_reset_failure |bool |sendEmailUponResetFailure *Optional* | +|device_access_net_address |str |deviceAccessNetAddress *Optional* | +|device_access_port |int |deviceAccessPort *Optional* | +|device_access_context |str |deviceAccessContext *Optional* | +|default_device_language |str |defaultDeviceLanguage *Optional* | +|default_device_encoding |str |defaultDeviceEncoding *Optional* | +|access_device_credentials |accessDeviceCredentials |accessDeviceCredentials *Optional* | +|use_http_digest_authentication |bool |useHttpDigestAuthentication *Optional* | +|mac_based_file_authentication |bool |macBasedFileAuthentication *Optional* | +|user_name_password_file_authentication |bool |userNamePasswordFileAuthentication *Optional* | +|mac_in_non_request_uri |bool |macInNonRequestURI *Optional* | +|mac_in_cert |bool |macInCert *Optional* | +|mac_format_in_non_request_uri |str |macFormatInNonRequestURI *Optional* |
-## `SortByAdminLastName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `DeviceManagementDeviceTypeModifyOptions22`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The sort criteria specifies the administrator last name as the column for the sort, -whether the sort is ascending or descending, and whether the sort is case sensitive. +Device Management System device type options during a modify request. +The following data elements are only used in AS data mode and ignored in XS data mode: +enableDeviceActivation deviceModel **Attributes:** -|Name |Type |Description | -|------------------|-----|----------------| -|is_ascending |bool |isAscending | -|is_case_sensitive |bool |isCaseSensitive | +|Name |Type |Description | +|---------------------------------------|------------------------|----------------------------------------------| +|device_access_protocol |str |deviceAccessProtocol *Optional* | +|tag_mode |str |tagMode *Optional* | +|tag_set |str |tagSet *Optional* | +|allow_device_profile_custom_tag_set |bool |allowDeviceProfileCustomTagSet *Optional* | +|allow_group_custom_tag_set |bool |allowGroupCustomTagSet *Optional* | +|allow_sp_custom_tag_set |bool |allowSpCustomTagSet *Optional* | +|send_email_upon_reset_failure |bool |sendEmailUponResetFailure *Optional* | +|device_access_net_address |str |deviceAccessNetAddress *Optional* | +|device_access_port |int |deviceAccessPort *Optional* | +|device_access_context |str |deviceAccessContext *Optional* | +|default_device_language |str |defaultDeviceLanguage *Optional* | +|default_device_encoding |str |defaultDeviceEncoding *Optional* | +|access_device_credentials |accessDeviceCredentials |accessDeviceCredentials *Optional* | +|use_http_digest_authentication |bool |useHttpDigestAuthentication *Optional* | +|mac_based_file_authentication |bool |macBasedFileAuthentication *Optional* | +|user_name_password_file_authentication |bool |userNamePasswordFileAuthentication *Optional* | +|mac_in_non_request_uri |bool |macInNonRequestURI *Optional* | +|mac_in_cert |bool |macInCert *Optional* | +|mac_format_in_non_request_uri |str |macFormatInNonRequestURI *Optional* | +|enable_device_activation |bool |enableDeviceActivation *Optional* | +|device_model |str |deviceModel *Optional* |
-## `SortByAgentThresholdProfile`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `DeviceManagementDeviceTypeOptions`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The sort criteria specifies the call center agent threshold profile as the column for -the sort, whether the sort is ascending or descending, and whether the sort is case -sensitive. +Device Management System device type options. **Attributes:** -|Name |Type |Description | -|------------------|-----|----------------| -|is_ascending |bool |isAscending | -|is_case_sensitive |bool |isCaseSensitive | +|Name |Type |Description | +|---------------------------------------|------------------------|------------------------------------| +|device_access_protocol |str |deviceAccessProtocol | +|tag_mode |str |tagMode | +|tag_set |str |tagSet *Optional* | +|allow_device_profile_custom_tag_set |bool |allowDeviceProfileCustomTagSet | +|allow_group_custom_tag_set |bool |allowGroupCustomTagSet | +|send_email_upon_reset_failure |bool |sendEmailUponResetFailure | +|device_access_net_address |str |deviceAccessNetAddress *Optional* | +|device_access_port |int |deviceAccessPort *Optional* | +|device_access_context |str |deviceAccessContext *Optional* | +|device_access_uri |str |deviceAccessURI *Optional* | +|default_device_language |str |defaultDeviceLanguage *Optional* | +|default_device_encoding |str |defaultDeviceEncoding *Optional* | +|access_device_credentials |accessDeviceCredentials |accessDeviceCredentials *Optional* | +|use_http_digest_authentication |bool |useHttpDigestAuthentication | +|mac_based_file_authentication |bool |macBasedFileAuthentication | +|user_name_password_file_authentication |bool |userNamePasswordFileAuthentication | +|mac_in_non_request_uri |bool |macInNonRequestURI | +|mac_format_in_non_request_uri |str |macFormatInNonRequestURI *Optional* |
-## `SortByAnnouncementFileName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `DeviceManagementDeviceTypeOptions16`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The sort criteria specifies the file name as the column for the sort, whether the sort -is ascending or descending, and whether the sort is case sensitive. +Device Management System device type options. **Attributes:** -|Name |Type |Description | -|------------------|-----|----------------| -|is_ascending |bool |isAscending | -|is_case_sensitive |bool |isCaseSensitive | +|Name |Type |Description | +|---------------------------------------|------------------------|------------------------------------| +|device_access_protocol |str |deviceAccessProtocol | +|tag_mode |str |tagMode | +|tag_set |str |tagSet *Optional* | +|allow_device_profile_custom_tag_set |bool |allowDeviceProfileCustomTagSet | +|allow_group_custom_tag_set |bool |allowGroupCustomTagSet | +|send_email_upon_reset_failure |bool |sendEmailUponResetFailure | +|device_access_net_address |str |deviceAccessNetAddress *Optional* | +|device_access_port |int |deviceAccessPort *Optional* | +|device_access_context |str |deviceAccessContext *Optional* | +|device_access_uri |str |deviceAccessURI *Optional* | +|default_device_language |str |defaultDeviceLanguage *Optional* | +|default_device_encoding |str |defaultDeviceEncoding *Optional* | +|access_device_credentials |accessDeviceCredentials |accessDeviceCredentials *Optional* | +|use_http_digest_authentication |bool |useHttpDigestAuthentication | +|mac_based_file_authentication |bool |macBasedFileAuthentication | +|user_name_password_file_authentication |bool |userNamePasswordFileAuthentication | +|mac_in_non_request_uri |bool |macInNonRequestURI | +|mac_format_in_non_request_uri |str |macFormatInNonRequestURI *Optional* |
-## `SortByAnnouncementFileSize`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `DeviceManagementDeviceTypeOptions21sp1`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The sort criteria specifies the file size as the column for the sort, whether the sort -is ascending or descending, and whether the sort is case sensitive. +Device Management System device type options. +Note: For the elements listed below, when device configuration is set to +deviceManagement, those elements apply to the creation of the Polycom Phone Services +directory file only. For all other files, they are not used. Those elements are +instead configured on a per-file basis at the Device Type File level. When device +configuration is set to legacy, those elements apply to all configuration files. +useHttpDigestAuthentication macBasedFileAuthentication +userNamePasswordFileAuthentication macInNonRequestURI macInCert +macFormatInNonRequestURI **Attributes:** -|Name |Type |Description | -|-------------|-----|------------| -|is_ascending |bool |isAscending | +|Name |Type |Description | +|---------------------------------------|------------------------|------------------------------------| +|device_access_protocol |str |deviceAccessProtocol | +|tag_mode |str |tagMode | +|tag_set |str |tagSet *Optional* | +|allow_device_profile_custom_tag_set |bool |allowDeviceProfileCustomTagSet | +|allow_group_custom_tag_set |bool |allowGroupCustomTagSet | +|send_email_upon_reset_failure |bool |sendEmailUponResetFailure | +|device_access_net_address |str |deviceAccessNetAddress *Optional* | +|device_access_port |int |deviceAccessPort *Optional* | +|device_access_context |str |deviceAccessContext *Optional* | +|device_access_uri |str |deviceAccessURI *Optional* | +|default_device_language |str |defaultDeviceLanguage *Optional* | +|default_device_encoding |str |defaultDeviceEncoding *Optional* | +|access_device_credentials |accessDeviceCredentials |accessDeviceCredentials *Optional* | +|use_http_digest_authentication |bool |useHttpDigestAuthentication | +|mac_based_file_authentication |bool |macBasedFileAuthentication | +|user_name_password_file_authentication |bool |userNamePasswordFileAuthentication | +|mac_in_non_request_uri |bool |macInNonRequestURI | +|mac_in_cert |bool |macInCert | +|mac_format_in_non_request_uri |str |macFormatInNonRequestURI *Optional* |
-## `SortByCallCenterName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `DeviceManagementDeviceTypeOptions22`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The sort criteria specifies the call center name as the column for the sort, whether -the sort is ascending or descending, and whether the sort is case sensitive. +Device Management System device type options. +Note: For the elements listed below, when device configuration is set to +deviceManagement, those elements apply to the creation of the Polycom Phone Services +directory file only. For all other files, they are not used. Those elements are +instead configured on a per-file basis at the Device Type File level. When device +configuration is set to legacy, those elements apply to all configuration files. +useHttpDigestAuthentication macBasedFileAuthentication +userNamePasswordFileAuthentication macInNonRequestURI macInCert +macFormatInNonRequestURI **Attributes:** -|Name |Type |Description | -|------------------|-----|----------------| -|is_ascending |bool |isAscending | -|is_case_sensitive |bool |isCaseSensitive | +|Name |Type |Description | +|---------------------------------------|------------------------|------------------------------------| +|device_access_protocol |str |deviceAccessProtocol | +|tag_mode |str |tagMode | +|tag_set |str |tagSet *Optional* | +|allow_device_profile_custom_tag_set |bool |allowDeviceProfileCustomTagSet | +|allow_group_custom_tag_set |bool |allowGroupCustomTagSet | +|allow_sp_custom_tag_set |bool |allowSpCustomTagSet | +|send_email_upon_reset_failure |bool |sendEmailUponResetFailure | +|device_access_net_address |str |deviceAccessNetAddress *Optional* | +|device_access_port |int |deviceAccessPort *Optional* | +|device_access_context |str |deviceAccessContext *Optional* | +|device_access_uri |str |deviceAccessURI *Optional* | +|default_device_language |str |defaultDeviceLanguage *Optional* | +|default_device_encoding |str |defaultDeviceEncoding *Optional* | +|access_device_credentials |accessDeviceCredentials |accessDeviceCredentials *Optional* | +|use_http_digest_authentication |bool |useHttpDigestAuthentication | +|mac_based_file_authentication |bool |macBasedFileAuthentication | +|user_name_password_file_authentication |bool |userNamePasswordFileAuthentication | +|mac_in_non_request_uri |bool |macInNonRequestURI | +|mac_in_cert |bool |macInCert | +|mac_format_in_non_request_uri |str |macFormatInNonRequestURI *Optional* |
-## `SortByCallCenterType`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `DeviceManagementDeviceTypeOptions22V2`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The sort criteria specifies the call center type as the column for the sort, whether -the sort is ascending or descending, and whether the sort is case sensitive. +Device Management System device type options. +Note: For the elements listed below, when device configuration is set to +deviceManagement, those elements apply to the creation of the Polycom Phone Services +directory file only. For all other files, they are not used. Those elements are +instead configured on a per-file basis at the Device Type File level. When device +configuration is set to legacy, those elements apply to all configuration files. +useHttpDigestAuthentication macBasedFileAuthentication +userNamePasswordFileAuthentication macInNonRequestURI macInCert +macFormatInNonRequestURI **Attributes:** -|Name |Type |Description | -|------------------|-----|----------------| -|is_ascending |bool |isAscending | -|is_case_sensitive |bool |isCaseSensitive | +|Name |Type |Description | +|---------------------------------------|------------------------|------------------------------------| +|device_access_protocol |str |deviceAccessProtocol | +|tag_mode |str |tagMode | +|tag_set |str |tagSet *Optional* | +|allow_device_profile_custom_tag_set |bool |allowDeviceProfileCustomTagSet | +|allow_group_custom_tag_set |bool |allowGroupCustomTagSet | +|allow_sp_custom_tag_set |bool |allowSpCustomTagSet | +|send_email_upon_reset_failure |bool |sendEmailUponResetFailure | +|device_access_net_address |str |deviceAccessNetAddress *Optional* | +|device_access_port |int |deviceAccessPort *Optional* | +|device_access_context |str |deviceAccessContext *Optional* | +|device_access_uri |str |deviceAccessURI *Optional* | +|default_device_language |str |defaultDeviceLanguage *Optional* | +|default_device_encoding |str |defaultDeviceEncoding *Optional* | +|access_device_credentials |accessDeviceCredentials |accessDeviceCredentials *Optional* | +|use_http_digest_authentication |bool |useHttpDigestAuthentication | +|mac_based_file_authentication |bool |macBasedFileAuthentication | +|user_name_password_file_authentication |bool |userNamePasswordFileAuthentication | +|mac_in_non_request_uri |bool |macInNonRequestURI | +|mac_in_cert |bool |macInCert | +|mac_format_in_non_request_uri |str |macFormatInNonRequestURI *Optional* |
-## `SortByCallParkName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `DeviceManagementDeviceTypeOptions22V3`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The sort criteria specifies the call park name as the column for the sort, whether the -sort is ascending or descending, and whether the sort is case sensitive. +Device Management System device type options. +Note: For the elements listed below, when device configuration is set to +deviceManagement, those elements apply to the creation of the Polycom Phone Services +directory file only. For all other files, they are not used. Those elements are +instead configured on a per-file basis at the Device Type File level. When device +configuration is set to legacy, those elements apply to all configuration files. +useHttpDigestAuthentication macBasedFileAuthentication +userNamePasswordFileAuthentication macInNonRequestURI macInCert +macFormatInNonRequestURI The following data elements are only used in AS data mode and +ignored in XS data mode: enableDeviceActivation deviceModel **Attributes:** -|Name |Type |Description | -|------------------|-----|----------------| -|is_ascending |bool |isAscending | -|is_case_sensitive |bool |isCaseSensitive | +|Name |Type |Description | +|---------------------------------------|------------------------|------------------------------------| +|device_access_protocol |str |deviceAccessProtocol | +|tag_mode |str |tagMode | +|tag_set |str |tagSet *Optional* | +|allow_device_profile_custom_tag_set |bool |allowDeviceProfileCustomTagSet | +|allow_group_custom_tag_set |bool |allowGroupCustomTagSet | +|allow_sp_custom_tag_set |bool |allowSpCustomTagSet | +|send_email_upon_reset_failure |bool |sendEmailUponResetFailure | +|device_access_net_address |str |deviceAccessNetAddress *Optional* | +|device_access_port |int |deviceAccessPort *Optional* | +|device_access_context |str |deviceAccessContext *Optional* | +|device_access_uri |str |deviceAccessURI *Optional* | +|default_device_language |str |defaultDeviceLanguage *Optional* | +|default_device_encoding |str |defaultDeviceEncoding *Optional* | +|access_device_credentials |accessDeviceCredentials |accessDeviceCredentials *Optional* | +|use_http_digest_authentication |bool |useHttpDigestAuthentication | +|mac_based_file_authentication |bool |macBasedFileAuthentication | +|user_name_password_file_authentication |bool |userNamePasswordFileAuthentication | +|mac_in_non_request_uri |bool |macInNonRequestURI | +|mac_in_cert |bool |macInCert | +|mac_format_in_non_request_uri |str |macFormatInNonRequestURI *Optional* | +|enable_device_activation |bool |enableDeviceActivation | +|device_model |str |deviceModel *Optional* |
-## `SortByCallPickupName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `DeviceManagementDeviceTypeOptions22V4`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The sort criteria specifies the call pickup name as the column for the sort, whether -the sort is ascending or descending, and whether the sort is case sensitive. +Device Management System device type options. +Note: For the elements listed below, when device configuration is set to +deviceManagement, those elements apply to the creation of the Polycom Phone Services +directory file only. For all other files, they are not used. Those elements are +instead configured on a per-file basis at the Device Type File level. When device +configuration is set to legacy, those elements apply to all configuration files. +useHttpDigestAuthentication macBasedFileAuthentication +userNamePasswordFileAuthentication macInNonRequestURI macInCert +macFormatInNonRequestURI The following data elements are only used in AS data mode and +ignored in XS data mode: enableDeviceActivation deviceModel supportLinks **Attributes:** -|Name |Type |Description | -|------------------|-----|----------------| -|is_ascending |bool |isAscending | -|is_case_sensitive |bool |isCaseSensitive | +|Name |Type |Description | +|---------------------------------------|------------------------|------------------------------------| +|device_access_protocol |str |deviceAccessProtocol | +|tag_mode |str |tagMode | +|tag_set |str |tagSet *Optional* | +|allow_device_profile_custom_tag_set |bool |allowDeviceProfileCustomTagSet | +|allow_group_custom_tag_set |bool |allowGroupCustomTagSet | +|allow_sp_custom_tag_set |bool |allowSpCustomTagSet | +|send_email_upon_reset_failure |bool |sendEmailUponResetFailure | +|device_access_net_address |str |deviceAccessNetAddress *Optional* | +|device_access_port |int |deviceAccessPort *Optional* | +|device_access_context |str |deviceAccessContext *Optional* | +|device_access_uri |str |deviceAccessURI *Optional* | +|default_device_language |str |defaultDeviceLanguage *Optional* | +|default_device_encoding |str |defaultDeviceEncoding *Optional* | +|access_device_credentials |accessDeviceCredentials |accessDeviceCredentials *Optional* | +|use_http_digest_authentication |bool |useHttpDigestAuthentication | +|mac_based_file_authentication |bool |macBasedFileAuthentication | +|user_name_password_file_authentication |bool |userNamePasswordFileAuthentication | +|mac_in_non_request_uri |bool |macInNonRequestURI | +|mac_in_cert |bool |macInCert | +|mac_format_in_non_request_uri |str |macFormatInNonRequestURI *Optional* | +|enable_device_activation |bool |enableDeviceActivation | +|device_model |str |deviceModel *Optional* | +|support_links |str |supportLinks |
-## `SortByDepartmentName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `EnterpriseAccessDevice`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The sort criteria specifies the department name as the column for the sort, whether -the sort is ascending or descending, and whether the sort is case sensitive. +Uniquely identifies an access device accessible for an enterprise. +It could be a system level device, an enterprise level device or a group level device. **Attributes:** -|Name |Type |Description | -|------------------|-----|----------------| -|is_ascending |bool |isAscending | -|is_case_sensitive |bool |isCaseSensitive | +|Name |Type |Description | +|--------------|-------------|-------------------| +|access_device |accessDevice |accessDevice | +|group_id |str |groupId *Optional* |
-## `SortByDeviceMACAddress`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `EnterpriseDepartmentKey`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The sort criteria specifies the device MAC address as the column for the sort, whether -the sort is ascending or descending, and whether the sort is case sensitive. +Uniquely identifies a department defined within an enterprise. +To uniquely identify an enterprise department, we must know the department name and +which enterprise contains the department. **Attributes:** -|Name |Type |Description | -|------------------|-----|----------------| -|is_ascending |bool |isAscending | -|is_case_sensitive |bool |isCaseSensitive | +|Name |Type|Description | +|--------------------|----|------------------| +|service_provider_id |str |serviceProviderId | +|name |str |name |
-## `SortByDeviceName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `EnterpriseEnterpriseTrunkPriorityWeightedTrunkGroup`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The sort criteria specifies the device name as the column for the sort, whether the -sort is ascending or descending, and whether the sort is case sensitive. - +Trunk group details (order and weight) for each trunk group **Attributes:** -|Name |Type |Description | -|------------------|-----|----------------| -|is_ascending |bool |isAscending | -|is_case_sensitive |bool |isCaseSensitive | +|Name |Type |Description| +|------------|-----------|-----------| +|trunk_group |trunkGroup |trunkGroup | +|priority |int |priority | +|weight |int |weight |
-## `SortByDeviceNetAddress`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `EnterpriseTrunkNumberPrefix22`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The sort criteria specifies the device net address as the column for the sort, whether -the sort is ascending or descending, and whether the sort is case sensitive. - +Enterprise Trunk Number Prefix **Attributes:** -|Name |Type |Description | -|------------------|-----|----------------| -|is_ascending |bool |isAscending | -|is_case_sensitive |bool |isCaseSensitive | +|Name |Type |Description | +|----------------|---------------|--------------------------| +|number_prefix |str |numberPrefix | +|extension_range |extensionRange |extensionRange *Optional* |
-## `SortByDeviceType`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `EnterpriseTrunkNumberPrefixModify`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The sort criteria specifies the device type as the column for the sort, whether the -sort is ascending or descending, and whether the sort is case sensitive. +Enterprise Trunk Number Prefix for modify. **Attributes:** -|Name |Type |Description | -|------------------|-----|----------------| -|is_ascending |bool |isAscending | -|is_case_sensitive |bool |isCaseSensitive | +|Name |Type |Description | +|----------------|---------------|--------------------------| +|number_prefix |str |numberPrefix | +|extension_range |extensionRange |extensionRange *Optional* |
-## `SortByDn`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `EnterpriseTrunkNumberRange`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The sort criteria specifies the DN as the column for the sort, whether the sort is -ascending or descending, and whether the sort is case sensitive. +Directory number range. +The minimum and maximum values are inclusive. **Attributes:** -|Name |Type |Description | -|------------------|-----|----------------| -|is_ascending |bool |isAscending | -|is_case_sensitive |bool |isCaseSensitive | +|Name |Type |Description | +|-----------------|--------|---------------------------| +|dn_range |dnRange |dnRange | +|extension_length |int |extensionLength *Optional* |
-## `SortByDnActivated`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `EnterpriseTrunkPriorityWeightedTrunkGroup`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The sort criteria specifies the dn activation status as the column for the sort, -whether the sort is ascending or descending, and whether the sort is case sensitive. - +Trunk group details (order and weight) for each trunk group **Attributes:** -|Name |Type |Description | -|------------------|-----|----------------| -|is_ascending |bool |isAscending | -|is_case_sensitive |bool |isCaseSensitive | +|Name |Type |Description| +|------------|-----------|-----------| +|trunk_group |trunkGroup |trunkGroup | +|priority |int |priority | +|weight |int |weight |
-## `SortByDnAvailable`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `EnterpriseVoiceVPNDigitManipulationNoValue`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The sort criteria specifies the dn availability as the column for the sort, whether -the sort is ascending or descending, and whether the sort is case sensitive. +Enterprise Voice VPN Digit Manipulation Entry that has no value. **Attributes:** -|Name |Type |Description | -|------------------|-----|----------------| -|is_ascending |bool |isAscending | -|is_case_sensitive |bool |isCaseSensitive | +|Name |Type|Description| +|----------|----|-----------| +|operation |str |operation |
-## `SortByEmailAddress`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `EnterpriseVoiceVPNDigitManipulationOptionalValue`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The sort criteria specifies the email as the column for the sort, whether the sort is -ascending or descending, and whether the sort is case sensitive. +Enterprise Voice VPN Digit Manipulation Entry that optionally has a value. **Attributes:** -|Name |Type |Description | -|------------------|-----|----------------| -|is_ascending |bool |isAscending | -|is_case_sensitive |bool |isCaseSensitive | +|Name |Type|Description | +|----------|----|-----------------| +|operation |str |operation | +|value |str |value *Optional* |
-## `SortByEnabled`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `EnterpriseVoiceVPNDigitManipulationRequiredValue`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The sort criteria specifies the Broadworks Enabled Flag as the column for the sort, -whether the sort is ascending or descending, and whether the sort is case sensitive. +Enterprise Voice VPN Digit Manipulation Entry that has a value. **Attributes:** -|Name |Type |Description | -|------------------|-----|----------------| -|is_ascending |bool |isAscending | -|is_case_sensitive |bool |isCaseSensitive | +|Name |Type|Description| +|----------|----|-----------| +|operation |str |operation | +|value |str |value |
-## `SortByEnterpriseCommonPhoneListName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `ExecutiveCallFilteringCriteriaFromDnModify`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The sort criteria specifies the enterprise common phone list name as the column for -the sort, whether sort is ascending or descending, and whether the sort is case -sensitive. +The from dn criteria used within an executive call filtering criteria modify request. **Attributes:** -|Name |Type |Description | -|------------------|-----|----------------| -|is_ascending |bool |isAscending | -|is_case_sensitive |bool |isCaseSensitive | +|Name |Type |Description | +|----------------------------|----------------|-------------------------------------| +|from_dn_criteria_selection |str |fromDnCriteriaSelection *Optional* | +|include_anonymous_callers |bool |includeAnonymousCallers *Optional* | +|include_unavailable_callers |bool |includeUnavailableCallers *Optional* | +|phone_number_list |phoneNumberList |phoneNumberList *Optional* |
-## `SortByEnterpriseCommonPhoneListNumber`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `ExtendedFileResource`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The sort criteria specifies the enterprise common phone list number as as the column -for the sort, whether sort is ascending or descending, and whether the sort is case -sensitive. +Represents either an existing file for the application server to use, or the contents +of a file to transfer and an URL. **Attributes:** -|Name |Type |Description | -|------------------|-----|----------------| -|is_ascending |bool |isAscending | -|is_case_sensitive |bool |isCaseSensitive | +|Name |Type |Description | +|-----|-----|----------------| +|file |file |file *Optional* | +|url |str |url *Optional* |
-## `SortByExtension`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `ExtendedMediaFileLevelResource20`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The sort criteria specifies the extension as the column for the sort, whether the sort -is ascending or descending, and whether the sort is case sensitive. +Represents either an existing file for the application server to use, or the contents +of a file to transfer and an URL. **Attributes:** -|Name |Type |Description | -|------------------|-----|----------------| -|is_ascending |bool |isAscending | -|is_case_sensitive |bool |isCaseSensitive | +|Name |Type |Description | +|-----|-----|----------------| +|file |file |file *Optional* | +|url |str |url *Optional* |
-## `SortByForwardedToNumber`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `ExtendedMediaFileResource`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The sort criteria specifies the forwarded to phone number as the column for the sort, -whether the sort is ascending or descending, and whether the sort is case sensitive. +Represents either an existing file for the application server to use, or the contents +of a file to transfer and an URL. -This sort criteria data type is only intended to be used by the commands introduced by -BW-2301. The commands are `EnterpriseUserCallForwardingSettingsGetListRequest()` and -`GroupUserCallForwardingSettingsGetListRequest()`. The following Call Forwarding -services are compatible for this search: Call Forwarding Always, Call Forwarding -Always Secondary, Call Forwarding Busy, Call Forwarding No Answer, Call Forwarding Not -Reachable, Call Forwarding Selective. **Attributes:** -|Name |Type |Description | -|------------------|-----|----------------| -|is_ascending |bool |isAscending | -|is_case_sensitive |bool |isCaseSensitive | +|Name |Type |Description | +|-----|-----|----------------| +|file |file |file *Optional* | +|url |str |url *Optional* |
-## `SortByGroupCommonPhoneListName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `ExtendedMediaFileResource20`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The sort criteria specifies the group common phone list name as the column for the -sort, whether the sort is ascending or descending, and whether the sort is case -sensitive. +Represents either an existing file for the application server to use, or the contents +of a file to transfer and an URL. **Attributes:** -|Name |Type |Description | -|------------------|-----|----------------| -|is_ascending |bool |isAscending | -|is_case_sensitive |bool |isCaseSensitive | +|Name |Type |Description | +|-----|-----|----------------| +|file |file |file *Optional* | +|url |str |url *Optional* |
-## `SortByGroupCommonPhoneListNumber`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `GroupDepartmentKey`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The sort criteria specifies the group common phone list number as the column for the -sort, whether sort is ascending or descending, and whether the sort is case sensitive. +Uniquely identifies a department defined within a group. +To uniquely identify a group department, we must know the department name and which +group contains the department. **Attributes:** -|Name |Type |Description | -|------------------|-----|----------------| -|is_ascending |bool |isAscending | -|is_case_sensitive |bool |isCaseSensitive | +|Name |Type|Description | +|--------------------|----|------------------| +|service_provider_id |str |serviceProviderId | +|group_id |str |groupId | +|name |str |name |
-## `SortByGroupId`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `GroupServiceAuthorization`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The sort criteria specifies the group id as the column for the sort, whether the sort -is ascending or descending, and whether the sort is case sensitive. +Authorize (with quantity) or unauthorize a group service. **Attributes:** -|Name |Type |Description | -|------------------|-----|----------------| -|is_ascending |bool |isAscending | -|is_case_sensitive |bool |isCaseSensitive | +|Name |Type |Description | +|--------------------|-------------------|------------------------------| +|service_name |str |serviceName | +|authorized_quantity |authorizedQuantity |authorizedQuantity *Optional* | +|unauthorized |bool |unauthorized *Optional* |
-## `SortByGroupLocationCode`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `GroupServiceAuthorizationAndAssignment`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The sort criteria specifies the group location code as the column for the sort, -whether the sort is ascending or descending, and whether the sort is case sensitive. +Authorize (with quantity) a group service, and optionally assign the service. **Attributes:** -|Name |Type |Description | -|------------------|-----|----------------| -|is_ascending |bool |isAscending | -|is_case_sensitive |bool |isCaseSensitive | -
- - -## `SortByGroupName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) - -
-The sort criteria specifies the group name as the column for the sort, whether the -sort is ascending or descending, and whether the sort is case sensitive. - - -**Attributes:** - -|Name |Type |Description | -|------------------|-----|----------------| -|is_ascending |bool |isAscending | -|is_case_sensitive |bool |isCaseSensitive | -
- - -## `SortByHuntPolicy`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) - -
-The sort criteria specifies the call center hunt policy as the column for the sort, -whether the sort is ascending or descending, and whether the sort is case sensitive. - - -**Attributes:** - -|Name |Type |Description | -|------------------|-----|----------------| -|is_ascending |bool |isAscending | -|is_case_sensitive |bool |isCaseSensitive | -
- - -## `SortByImpId`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) - -
-The sort criteria specifies the imp id as the column for the sort, whether the sort is -ascending or descending, and whether the sort is case sensitive. - - -**Attributes:** - -|Name |Type |Description | -|------------------|-----|----------------| -|is_ascending |bool |isAscending | -|is_case_sensitive |bool |isCaseSensitive | +|Name |Type |Description | +|--------------------|-------------------|------------------------------| +|service_name |str |serviceName | +|authorized_quantity |authorizedQuantity |authorizedQuantity *Optional* | +|assign |bool |assign *Optional* |
-## `SortByLocation`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `GroupSessionAdmissionControlGroupGetResponse21sp1V2`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The sort criteria specifies the Broadworks Location as the column for the sort, -whether the sort is ascending or descending, and whether the sort is case sensitive. +Response to GroupSessionAdmissionControlGroupGetRequest21sp1V2. +Returns the profile information for the session admission control group. **Attributes:** -|Name |Type |Description | -|------------------|-----|----------------| -|is_ascending |bool |isAscending | -|is_case_sensitive |bool |isCaseSensitive | +|Name |Type |Description | +|---------------------------------------------------|--------------|-------------------------------------------| +|max_session |int |maxSession | +|max_user_originating_sessions |int |maxUserOriginatingSessions *Optional* | +|max_user_terminating_sessions |int |maxUserTerminatingSessions *Optional* | +|reserved_session |int |reservedSession | +|reserved_user_originating_sessions |int |reservedUserOriginatingSessions *Optional* | +|reserved_user_terminating_sessions |int |reservedUserTerminatingSessions *Optional* | +|default_group |bool |defaultGroup | +|count_intra_sac_group_sessions |bool |countIntraSACGroupSessions | +|devices |List[devices] |devices *Optional* | +|block_emergency_and_repair_calls_due_to_sac_limits |bool |blockEmergencyAndRepairCallsDueToSACLimits | +|media_group_name |str |mediaGroupName *Optional* | +|access_info_pattern |str |accessInfoPattern *Optional* |
-## `SortByMobileDirectoryNumber`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `GroupTrunkGroupGetInstanceRequest14sp9A`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The sort criteria specifies the Mobile dn availability as the column for the sort, -whether the sort is ascending or descending, and whether the sort is case sensitive. +Get a Trunk Group Instance's profile. +The response is either a GroupTrunkGroupGetInstanceResponse14sp9A or an +`ErrorResponse()`. The response contains a hosted user table with column headings: +"User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name". **Attributes:** -|Name |Type |Description | -|------------------|-----|----------------| -|is_ascending |bool |isAscending | -|is_case_sensitive |bool |isCaseSensitive | +|Name |Type |Description | +|----------------|--------------|--------------| +|trunk_group_key |trunkGroupKey |trunkGroupKey |
-## `SortByMobilePhoneNumber`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `GroupTrunkGroupGetInstanceRequest17sp4V2`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The sort criteria specifies the mobile phone number as the column for the sort, -whether the sort is ascending or descending, and whether the sort is case sensitive. +Get a Trunk Group Instance's profile. +The response is either a GroupTrunkGroupGetInstanceResponse17sp4V2 or an +`ErrorResponse()`. The response contains a hosted user table with column headings: +"User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name". +Replaced by: `GroupTrunkGroupGetInstanceRequest19V2()` **Attributes:** -|Name |Type |Description | -|------------------|-----|----------------| -|is_ascending |bool |isAscending | -|is_case_sensitive |bool |isCaseSensitive | +|Name |Type |Description | +|----------------|--------------|--------------| +|trunk_group_key |trunkGroupKey |trunkGroupKey |
-## `SortByReceptionistNote`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `GroupTrunkGroupGetInstanceRequest19sp1V2`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The sort criteria specifies the Receptionist Notes as the column for the sort, whether -the sort is ascending or descending, and whether the sort is case sensitive. +Get a Trunk Group Instance's profile. +The response is either a GroupTrunkGroupGetInstanceResponse19sp1V2 or an +`ErrorResponse()`. The response contains a hosted user table with column headings: +"User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name", +"Phone Number", "Extension", "Department", "Email Address". Replaced by: +`GroupTrunkGroupGetInstanceRequest20sp1()` **Attributes:** -|Name |Type |Description | -|------------------|-----|----------------| -|is_ascending |bool |isAscending | -|is_case_sensitive |bool |isCaseSensitive | +|Name |Type |Description | +|----------------|--------------|--------------| +|trunk_group_key |trunkGroupKey |trunkGroupKey |
-## `SortByScheduleName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `GroupTrunkGroupGetInstanceResponse14sp9A`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The sort criteria specifies the schedule name as the column for the sort, whether the -sort is ascending or descending, and whether the sort is case sensitive. +Response to GroupTrunkGroupGetInstanceRequest14sp9A. +Returns the profile information for the Trunk Group. Contains a hosted user table +with column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name", +"Hiragana First Name". **Attributes:** -|Name |Type |Description | -|------------------|-----|----------------| -|is_ascending |bool |isAscending | -|is_case_sensitive |bool |isCaseSensitive | +|Name |Type |Description | +|------------------------------------------------|-------------------------------------------|---------------------------------------------------------------------------| +|pilot_user_id |str |pilotUserId *Optional* | +|department |department |department *Optional* | +|access_device |accessDevice |accessDevice *Optional* | +|max_active_calls |int |maxActiveCalls | +|max_incoming_calls |int |maxIncomingCalls *Optional* | +|max_outgoing_calls |int |maxOutgoingCalls *Optional* | +|enable_bursting |bool |enableBursting | +|bursting_max_active_calls |int |burstingMaxActiveCalls *Optional* | +|bursting_max_incoming_calls |int |burstingMaxIncomingCalls *Optional* | +|bursting_max_outgoing_calls |int |burstingMaxOutgoingCalls *Optional* | +|capacity_exceeded_action |str |capacityExceededAction *Optional* | +|capacity_exceeded_forward_address |str |capacityExceededForwardAddress *Optional* | +|capacity_exceeded_reroute_trunk_group_key |capacityExceededRerouteTrunkGroupKey |capacityExceededRerouteTrunkGroupKey *Optional* | +|capacity_exceeded_trap_initial_calls |int |capacityExceededTrapInitialCalls | +|capacity_exceeded_trap_offset_calls |int |capacityExceededTrapOffsetCalls | +|unreachable_destination_action |str |unreachableDestinationAction *Optional* | +|unreachable_destination_forward_address |str |unreachableDestinationForwardAddress *Optional* | +|unreachable_destination_reroute_trunk_group_key |unreachableDestinationRerouteTrunkGroupKey |unreachableDestinationRerouteTrunkGroupKey *Optional* | +|unreachable_destination_trap_initial_calls |int |unreachableDestinationTrapInitialCalls | +|unreachable_destination_trap_offset_calls |int |unreachableDestinationTrapOffsetCalls | +|invitation_timeout |int |invitationTimeout | +|require_authentication |bool |requireAuthentication | +|sip_authentication_user_name |str |sipAuthenticationUserName *Optional* | +|hosted_user_table |List(hostedUserTable) |hostedUserTable - *Table* array of hostedUserTable named tuples *Optional* | +|trunk_group_identity |str |trunkGroupIdentity *Optional* | +|otg_dtg_identity |str |otgDtgIdentity *Optional* | +|include_trunk_group_identity |bool |includeTrunkGroupIdentity | +|include_dtg_identity |bool |includeDtgIdentity | +|enable_network_address_identity |bool |enableNetworkAddressIdentity | +|allow_unscreened_calls |bool |allowUnscreenedCalls | +|allow_unscreened_emergency_calls |bool |allowUnscreenedEmergencyCalls | +|pilot_user_calling_line_identity_policy |str |pilotUserCallingLineIdentityPolicy | +|pilot_user_charge_number_policy |str |pilotUserChargeNumberPolicy | +|call_forwarding_always_action |str |callForwardingAlwaysAction *Optional* | +|call_forwarding_always_forward_address |str |callForwardingAlwaysForwardAddress *Optional* | +|call_forwarding_always_reroute_trunk_group_key |callForwardingAlwaysRerouteTrunkGroupKey |callForwardingAlwaysRerouteTrunkGroupKey *Optional* |
-## `SortByServiceProviderId`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `GroupTrunkGroupGetInstanceResponse17sp4V2`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The sort criteria specifies the service provider id as the column for the sort, -whether the sort is ascending or descending, and whether the sort is case sensitive. +Response to GroupTrunkGroupGetInstanceRequest17sp4V2. +Returns the profile information for the Trunk Group. Contains a hosted user table +with column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name", +"Hiragana First Name". Replaced by: `GroupTrunkGroupGetInstanceResponse19V2()` **Attributes:** -|Name |Type |Description | -|------------------|-----|----------------| -|is_ascending |bool |isAscending | -|is_case_sensitive |bool |isCaseSensitive | +|Name |Type |Description | +|-------------------------------------------------|-------------------------------------------|---------------------------------------------------------------------------| +|pilot_user_id |str |pilotUserId *Optional* | +|department |department |department *Optional* | +|access_device |accessDevice |accessDevice *Optional* | +|max_active_calls |int |maxActiveCalls | +|max_incoming_calls |int |maxIncomingCalls *Optional* | +|max_outgoing_calls |int |maxOutgoingCalls *Optional* | +|enable_bursting |bool |enableBursting | +|bursting_max_active_calls |int |burstingMaxActiveCalls *Optional* | +|bursting_max_incoming_calls |int |burstingMaxIncomingCalls *Optional* | +|bursting_max_outgoing_calls |int |burstingMaxOutgoingCalls *Optional* | +|capacity_exceeded_action |str |capacityExceededAction *Optional* | +|capacity_exceeded_forward_address |str |capacityExceededForwardAddress *Optional* | +|capacity_exceeded_reroute_trunk_group_key |capacityExceededRerouteTrunkGroupKey |capacityExceededRerouteTrunkGroupKey *Optional* | +|capacity_exceeded_trap_initial_calls |int |capacityExceededTrapInitialCalls | +|capacity_exceeded_trap_offset_calls |int |capacityExceededTrapOffsetCalls | +|unreachable_destination_action |str |unreachableDestinationAction *Optional* | +|unreachable_destination_forward_address |str |unreachableDestinationForwardAddress *Optional* | +|unreachable_destination_reroute_trunk_group_key |unreachableDestinationRerouteTrunkGroupKey |unreachableDestinationRerouteTrunkGroupKey *Optional* | +|invitation_timeout |int |invitationTimeout | +|require_authentication |bool |requireAuthentication | +|sip_authentication_user_name |str |sipAuthenticationUserName *Optional* | +|hosted_user_table |List(hostedUserTable) |hostedUserTable - *Table* array of hostedUserTable named tuples *Optional* | +|trunk_group_identity |str |trunkGroupIdentity *Optional* | +|otg_dtg_identity |str |otgDtgIdentity *Optional* | +|allow_termination_to_trunk_group_identity |bool |allowTerminationToTrunkGroupIdentity | +|allow_termination_to_dtg_identity |bool |allowTerminationToDtgIdentity | +|include_trunk_group_identity |bool |includeTrunkGroupIdentity | +|include_dtg_identity |bool |includeDtgIdentity | +|include_trunk_group_identity_for_network_calls |bool |includeTrunkGroupIdentityForNetworkCalls | +|include_otg_identity_for_network_calls |bool |includeOtgIdentityForNetworkCalls | +|enable_network_address_identity |bool |enableNetworkAddressIdentity | +|allow_unscreened_calls |bool |allowUnscreenedCalls | +|allow_unscreened_emergency_calls |bool |allowUnscreenedEmergencyCalls | +|pilot_user_calling_line_identity_policy |str |pilotUserCallingLineIdentityPolicy | +|pilot_user_charge_number_policy |str |pilotUserChargeNumberPolicy | +|call_forwarding_always_action |str |callForwardingAlwaysAction *Optional* | +|call_forwarding_always_forward_address |str |callForwardingAlwaysForwardAddress *Optional* | +|call_forwarding_always_reroute_trunk_group_key |callForwardingAlwaysRerouteTrunkGroupKey |callForwardingAlwaysRerouteTrunkGroupKey *Optional* | +|peering_domain |str |peeringDomain *Optional* | +|route_to_peering_domain |bool |routeToPeeringDomain | +|prefix_enabled |bool |prefixEnabled | +|prefix |str |prefix *Optional* | +|stateful_rerouting_enabled |bool |statefulReroutingEnabled | +|send_continuous_options_message |bool |sendContinuousOptionsMessage | +|continuous_options_sending_interval_seconds |int |continuousOptionsSendingIntervalSeconds | +|failure_options_sending_interval_seconds |int |failureOptionsSendingIntervalSeconds | +|failure_threshold_counter |int |failureThresholdCounter | +|success_threshold_counter |int |successThresholdCounter | +|invite_failure_threshold_counter |int |inviteFailureThresholdCounter | +|invite_failure_threshold_window_seconds |int |inviteFailureThresholdWindowSeconds | +|trunk_group_state |str |trunkGroupState | +|pilot_user_calling_line_asserted_identity_policy |str |pilotUserCallingLineAssertedIdentityPolicy | +|use_system_calling_line_asserted_identity_policy |bool |useSystemCallingLineAssertedIdentityPolicy |
-## `SortByServiceProviderName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `GroupTrunkGroupGetInstanceResponse19sp1V2`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The sort criteria specifies the service provider name as the column for the sort, -whether the sort is ascending or descending, and whether the sort is case sensitive. +Response to GroupTrunkGroupGetInstanceRequest19sp1V2. +Returns the profile information for the Trunk Group. Contains a hosted user table +with column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name", +"Hiragana First Name", "Phone Number", "Extension", "Department", "Email Address". +Replaced by: `GroupTrunkGroupGetInstanceResponse20sp1()` **Attributes:** -|Name |Type |Description | -|------------------|-----|----------------| -|is_ascending |bool |isAscending | -|is_case_sensitive |bool |isCaseSensitive | -
- - -## `SortByServiceStatus`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) - +|Name |Type |Description | +|------------------------------------------------------------|-------------------------------------------|---------------------------------------------------------------------------| +|pilot_user_id |str |pilotUserId *Optional* | +|department |department |department *Optional* | +|access_device |accessDevice |accessDevice *Optional* | +|max_active_calls |int |maxActiveCalls | +|max_incoming_calls |int |maxIncomingCalls *Optional* | +|max_outgoing_calls |int |maxOutgoingCalls *Optional* | +|enable_bursting |bool |enableBursting | +|bursting_max_active_calls |int |burstingMaxActiveCalls *Optional* | +|bursting_max_incoming_calls |int |burstingMaxIncomingCalls *Optional* | +|bursting_max_outgoing_calls |int |burstingMaxOutgoingCalls *Optional* | +|capacity_exceeded_action |str |capacityExceededAction *Optional* | +|capacity_exceeded_forward_address |str |capacityExceededForwardAddress *Optional* | +|capacity_exceeded_reroute_trunk_group_key |capacityExceededRerouteTrunkGroupKey |capacityExceededRerouteTrunkGroupKey *Optional* | +|capacity_exceeded_trap_initial_calls |int |capacityExceededTrapInitialCalls | +|capacity_exceeded_trap_offset_calls |int |capacityExceededTrapOffsetCalls | +|unreachable_destination_action |str |unreachableDestinationAction *Optional* | +|unreachable_destination_forward_address |str |unreachableDestinationForwardAddress *Optional* | +|unreachable_destination_reroute_trunk_group_key |unreachableDestinationRerouteTrunkGroupKey |unreachableDestinationRerouteTrunkGroupKey *Optional* | +|invitation_timeout |int |invitationTimeout | +|require_authentication |bool |requireAuthentication | +|sip_authentication_user_name |str |sipAuthenticationUserName *Optional* | +|hosted_user_table |List(hostedUserTable) |hostedUserTable - *Table* array of hostedUserTable named tuples *Optional* | +|trunk_group_identity |str |trunkGroupIdentity *Optional* | +|otg_dtg_identity |str |otgDtgIdentity *Optional* | +|allow_termination_to_trunk_group_identity |bool |allowTerminationToTrunkGroupIdentity | +|allow_termination_to_dtg_identity |bool |allowTerminationToDtgIdentity | +|include_trunk_group_identity |bool |includeTrunkGroupIdentity | +|include_dtg_identity |bool |includeDtgIdentity | +|include_trunk_group_identity_for_network_calls |bool |includeTrunkGroupIdentityForNetworkCalls | +|include_otg_identity_for_network_calls |bool |includeOtgIdentityForNetworkCalls | +|enable_network_address_identity |bool |enableNetworkAddressIdentity | +|allow_unscreened_calls |bool |allowUnscreenedCalls | +|allow_unscreened_emergency_calls |bool |allowUnscreenedEmergencyCalls | +|pilot_user_calling_line_identity_for_external_calls_policy |str |pilotUserCallingLineIdentityForExternalCallsPolicy | +|pilot_user_charge_number_policy |str |pilotUserChargeNumberPolicy | +|call_forwarding_always_action |str |callForwardingAlwaysAction *Optional* | +|call_forwarding_always_forward_address |str |callForwardingAlwaysForwardAddress *Optional* | +|call_forwarding_always_reroute_trunk_group_key |callForwardingAlwaysRerouteTrunkGroupKey |callForwardingAlwaysRerouteTrunkGroupKey *Optional* | +|peering_domain |str |peeringDomain *Optional* | +|route_to_peering_domain |bool |routeToPeeringDomain | +|prefix_enabled |bool |prefixEnabled | +|prefix |str |prefix *Optional* | +|stateful_rerouting_enabled |bool |statefulReroutingEnabled | +|send_continuous_options_message |bool |sendContinuousOptionsMessage | +|continuous_options_sending_interval_seconds |int |continuousOptionsSendingIntervalSeconds | +|failure_options_sending_interval_seconds |int |failureOptionsSendingIntervalSeconds | +|failure_threshold_counter |int |failureThresholdCounter | +|success_threshold_counter |int |successThresholdCounter | +|invite_failure_threshold_counter |int |inviteFailureThresholdCounter | +|invite_failure_threshold_window_seconds |int |inviteFailureThresholdWindowSeconds | +|trunk_group_state |str |trunkGroupState | +|pilot_user_calling_line_asserted_identity_policy |str |pilotUserCallingLineAssertedIdentityPolicy | +|use_system_calling_line_asserted_identity_policy |bool |useSystemCallingLineAssertedIdentityPolicy | +|total_active_incoming_calls |int |totalActiveIncomingCalls | +|total_active_outgoing_calls |int |totalActiveOutgoingCalls | +|pilot_user_call_optimization_policy |str |pilotUserCallOptimizationPolicy | +|clid_source_for_screened_calls_policy |str |clidSourceForScreenedCallsPolicy | +|use_system_clid_source_for_screened_calls_policy |bool |useSystemCLIDSourceForScreenedCallsPolicy | +|user_lookup_policy |str |userLookupPolicy | +|use_system_user_lookup_policy |bool |useSystemUserLookupPolicy | +|pilot_user_calling_line_identity_for_emergency_calls_policy |str |pilotUserCallingLineIdentityForEmergencyCallsPolicy | + + + +## `GroupTrunkGroupModifyInstanceRequest14sp9A`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +
-The sort criteria specifies the service status as the column for the sort, whether the -sort is ascending or descending, and whether the sort is case sensitive. +Modify a Trunk Group Instance in a group. -This sort criteria data type is only intended to be used by the commands introduced by -BW-2301. The commands are `EnterpriseUserCallWaitingSettingsGetListRequest()`, -`GroupUserCallWaitingSettingsGetListRequest()`, -`EnterpriseUserHotelingGuestSettingsGetListRequest()`, and -`GroupUserHotelingGuestSettingsGetListRequest()`. +The access device cannot be modified or cleared if there are any users assigned to the +Trunk Group. + +The response is either a `SuccessResponse()` or an `ErrorResponse()`. **Attributes:** -|Name |Type |Description | -|------------------|-----|----------------| -|is_ascending |bool |isAscending | -|is_case_sensitive |bool |isCaseSensitive | +|Name |Type |Description | +|------------------------------------------------|-------------------------------------------|------------------------------------------------------| +|trunk_group_key |trunkGroupKey |trunkGroupKey | +|new_name |str |newName *Optional* | +|pilot_user_id |str |pilotUserId *Optional* | +|department |department |department *Optional* | +|access_device |accessDevice |accessDevice *Optional* | +|max_active_calls |int |maxActiveCalls *Optional* | +|max_incoming_calls |int |maxIncomingCalls *Optional* | +|max_outgoing_calls |int |maxOutgoingCalls *Optional* | +|enable_bursting |bool |enableBursting *Optional* | +|bursting_max_active_calls |int |burstingMaxActiveCalls *Optional* | +|bursting_max_incoming_calls |int |burstingMaxIncomingCalls *Optional* | +|bursting_max_outgoing_calls |int |burstingMaxOutgoingCalls *Optional* | +|capacity_exceeded_action |str |capacityExceededAction *Optional* | +|capacity_exceeded_forward_address |str |capacityExceededForwardAddress *Optional* | +|capacity_exceeded_reroute_trunk_group_key |capacityExceededRerouteTrunkGroupKey |capacityExceededRerouteTrunkGroupKey *Optional* | +|capacity_exceeded_trap_initial_calls |int |capacityExceededTrapInitialCalls *Optional* | +|capacity_exceeded_trap_offset_calls |int |capacityExceededTrapOffsetCalls *Optional* | +|unreachable_destination_action |str |unreachableDestinationAction *Optional* | +|unreachable_destination_forward_address |str |unreachableDestinationForwardAddress *Optional* | +|unreachable_destination_reroute_trunk_group_key |unreachableDestinationRerouteTrunkGroupKey |unreachableDestinationRerouteTrunkGroupKey *Optional* | +|unreachable_destination_trap_initial_calls |int |unreachableDestinationTrapInitialCalls *Optional* | +|unreachable_destination_trap_offset_calls |int |unreachableDestinationTrapOffsetCalls *Optional* | +|invitation_timeout |int |invitationTimeout *Optional* | +|require_authentication |bool |requireAuthentication *Optional* | +|sip_authentication_user_name |str |sipAuthenticationUserName *Optional* | +|sip_authentication_password |str |sipAuthenticationPassword *Optional* | +|hosted_user_id_list |hostedUserIdList |hostedUserIdList *Optional* | +|trunk_group_identity |str |trunkGroupIdentity *Optional* | +|otg_dtg_identity |str |otgDtgIdentity *Optional* | +|include_trunk_group_identity |bool |includeTrunkGroupIdentity *Optional* | +|include_dtg_identity |bool |includeDtgIdentity *Optional* | +|enable_network_address_identity |bool |enableNetworkAddressIdentity *Optional* | +|allow_unscreened_calls |bool |allowUnscreenedCalls *Optional* | +|allow_unscreened_emergency_calls |bool |allowUnscreenedEmergencyCalls *Optional* | +|pilot_user_calling_line_identity_policy |str |pilotUserCallingLineIdentityPolicy *Optional* | +|pilot_user_charge_number_policy |str |pilotUserChargeNumberPolicy *Optional* | +|call_forwarding_always_action |str |callForwardingAlwaysAction *Optional* | +|call_forwarding_always_forward_address |str |callForwardingAlwaysForwardAddress *Optional* | +|call_forwarding_always_reroute_trunk_group_key |callForwardingAlwaysRerouteTrunkGroupKey |callForwardingAlwaysRerouteTrunkGroupKey *Optional* |
-## `SortByTrunkGroupName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `IncomingCallingPlanDepartmentPermissions`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The sort criteria specifies the trunk group name as the column for the sort, whether -the sort is ascending or descending, and whether the sort is case sensitive. +Allows or disallows various types of incoming calls for a specified department. **Attributes:** -|Name |Type |Description | -|------------------|-----|----------------| -|is_ascending |bool |isAscending | -|is_case_sensitive |bool |isCaseSensitive | +|Name |Type |Description | +|--------------------------|-----------------------------|----------------------------------| +|department_key |departmentKey |departmentKey | +|department_full_path_name |str |departmentFullPathName | +|allow_from_within_group |bool |allowFromWithinGroup | +|allow_from_outside_group |str |allowFromOutsideGroup | +|allow_collect_calls |bool |allowCollectCalls | +|digit_pattern_permission |List[digitPatternPermission] |digitPatternPermission *Optional* |
-## `SortByUserDepartment`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `IncomingCallingPlanDepartmentPermissionsModify`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The sort criteria specifies the user department name as the column for the sort, -whether the sort is ascending or descending, and whether the sort is case sensitive. +Allows or disallows various types of incoming calls for a specified department. +For use when modifing settings. **Attributes:** -|Name |Type |Description | -|------------------|-----|----------------| -|is_ascending |bool |isAscending | -|is_case_sensitive |bool |isCaseSensitive | +|Name |Type |Description | +|-------------------------|-----------------------------|----------------------------------| +|department_key |departmentKey |departmentKey | +|allow_from_within_group |bool |allowFromWithinGroup *Optional* | +|allow_from_outside_group |str |allowFromOutsideGroup *Optional* | +|allow_collect_calls |bool |allowCollectCalls *Optional* | +|digit_pattern_permission |List[digitPatternPermission] |digitPatternPermission *Optional* |
-## `SortByUserFirstName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `IncomingCallingPlanPermissions`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The sort criteria specifies the user first name as the column for the sort, whether -the sort is ascending or descending, and whether the sort is case sensitive. +Allows or disallows various types of incoming calls for a user or group -- not any +particular department. **Attributes:** -|Name |Type |Description | -|------------------|-----|----------------| -|is_ascending |bool |isAscending | -|is_case_sensitive |bool |isCaseSensitive | +|Name |Type |Description | +|-------------------------|-----------------------------|----------------------------------| +|allow_from_within_group |bool |allowFromWithinGroup | +|allow_from_outside_group |str |allowFromOutsideGroup | +|allow_collect_calls |bool |allowCollectCalls | +|digit_pattern_permission |List[digitPatternPermission] |digitPatternPermission *Optional* |
-## `SortByUserId`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `IncomingCallingPlanPermissionsModify`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The sort criteria specifies the user id as the column for the sort, whether the sort -is ascending or descending, and whether the sort is case sensitive. +Allows or disallows various types of incoming calls for a user or group -- not any +particular department. +For use when modifing settings. **Attributes:** -|Name |Type |Description | -|------------------|-----|----------------| -|is_ascending |bool |isAscending | -|is_case_sensitive |bool |isCaseSensitive | +|Name |Type |Description | +|-------------------------|-----------------------------|----------------------------------| +|allow_from_within_group |bool |allowFromWithinGroup *Optional* | +|allow_from_outside_group |str |allowFromOutsideGroup *Optional* | +|allow_collect_calls |bool |allowCollectCalls *Optional* | +|digit_pattern_permission |List[digitPatternPermission] |digitPatternPermission *Optional* |
-## `SortByUserLastName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `MWIDeliveryToMobileEndpointTemplateBody`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The sort criteria specifies the user last name as the column for the sort, whether the -sort is ascending or descending, and whether the sort is case sensitive. +MWI Delivery To Mobile Endpoint template body. **Attributes:** -|Name |Type |Description | -|------------------|-----|----------------| -|is_ascending |bool |isAscending | -|is_case_sensitive |bool |isCaseSensitive | +|Name |Type |Description| +|-----|-----------|-----------| +|line |List[line] |line |
-## `SortByUserPersonalPhoneListName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `OutgoingCallingPlanCallMeNowDepartmentPermissions`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The sort criteria specifies the user personal phone list name as the column for the -sort, whether sort is ascending or descending, and whether the sort is case sensitive. +Outgoing Calling Plan for Call Me Now call permissions for a department. **Attributes:** -|Name |Type |Description | -|------------------|-----|----------------| -|is_ascending |bool |isAscending | -|is_case_sensitive |bool |isCaseSensitive | +|Name |Type |Description | +|----------------|--------------|---------------| +|department_key |departmentKey |departmentKey | +|department_name |str |departmentName | +|permissions |permissions |permissions |
-## `SortByUserPersonalPhoneListNumber`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `OutgoingCallingPlanCallMeNowDepartmentPermissionsModify`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The sort criteria specifies the user personal phone list number as the column for the -sort, whether the sort is ascending or descending, and whether the sort is case -sensitive. +Modify outgoing Calling Plan for Call Me Now call permissions for a department. **Attributes:** -|Name |Type |Description | -|------------------|-----|----------------| -|is_ascending |bool |isAscending | -|is_case_sensitive |bool |isCaseSensitive | +|Name |Type |Description | +|---------------|--------------|--------------| +|department_key |departmentKey |departmentKey | +|permissions |permissions |permissions |
-## `SortByYahooId`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `OutgoingCallingPlanDepartmentAuthorizationCodes`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The sort criteria specifies the yahoo id as the column for the sort, whether the sort -is ascending or descending, and whether the sort is case sensitive. +Outgoing Calling Plan Authorization Code for a department. **Attributes:** -|Name |Type |Description | -|------------------|-----|----------------| -|is_ascending |bool |isAscending | -|is_case_sensitive |bool |isCaseSensitive | +|Name |Type |Description | +|----------------|----------------|---------------------| +|department_key |departmentKey |departmentKey | +|department_name |str |departmentName | +|code_entry |List[codeEntry] |codeEntry *Optional* |
-## `SortCriteria`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `OutgoingCallingPlanDepartmentTransferNumbers`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The sort criteria specifies whether sort is ascending or descending, and whether the -sort is case sensitive. +Outgoing Calling Plan transfer numbers for a department. -Sort order defaults to ascending and case sensitive. **Attributes:** -|Name |Type |Description | -|------------------|-----|----------------| -|is_ascending |bool |isAscending | -|is_case_sensitive |bool |isCaseSensitive | +|Name |Type |Description | +|-----------------|----------------|----------------| +|department_key |departmentKey |departmentKey | +|department_name |str |departmentName | +|transfer_numbers |transferNumbers |transferNumbers |
-## `SortCriteriaNumeric`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `OutgoingCallingPlanDepartmentTransferNumbersModify`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The sort criteria specifies whether sort is ascending or descending. +Outgoing Calling Plan transfer numbers for a department. -Sort order defaults to ascending. **Attributes:** -|Name |Type |Description | -|-------------|-----|------------| -|is_ascending |bool |isAscending | +|Name |Type |Description | +|-----------------|----------------|---------------------------| +|department_key |departmentKey |departmentKey | +|transfer_numbers |transferNumbers |transferNumbers *Optional* |
-## `SpeedDial100Entry`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `OutgoingCallingPlanDigitPatternCallMeNowPermissions`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Modify the speed dial 100 prefix setting for a group. +Outgoing Calling Plan Call Me Now call permissions for specified digit patterns. -The response is either a `SuccessResponse()` or an `ErrorResponse()`. **Attributes:** -|Name |Type|Description | -|-------------|----|-----------------------| -|speed_code |int |speedCode | -|phone_number |str |phoneNumber | -|description |str |description *Optional* | +|Name |Type |Description | +|--------------------------|------------------------------|------------------------| +|digit_pattern_permissions |List[digitPatternPermissions] |digitPatternPermissions |
-## `SpeedDial100EntryModify`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `OutgoingCallingPlanDigitPatternOriginatingPermissions`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Modify the speed dial 100 prefix setting for a group. +Outgoing Calling Plan originating call permissions for specified digit patterns. -The response is either a `SuccessResponse()` or an `ErrorResponse()`. **Attributes:** -|Name |Type|Description | -|-------------|----|-----------------------| -|speed_code |int |speedCode | -|phone_number |str |phoneNumber *Optional* | -|description |str |description *Optional* | +|Name |Type |Description | +|--------------------------|------------------------------|------------------------| +|digit_pattern_permissions |List[digitPatternPermissions] |digitPatternPermissions |
-## `SpeedDial8Entry`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `OutgoingCallingPlanDigitPatternRedirectingPermissions`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Modify the speed dial 8 prefix setting for a group. +Outgoing Calling Plan redirecting call permissions for specified digit patterns. -The response is either a `SuccessResponse()` or an `ErrorResponse()`. **Attributes:** -|Name |Type|Description | -|-------------|----|-----------------------| -|speed_code |int |speedCode | -|phone_number |str |phoneNumber *Optional* | -|description |str |description *Optional* | +|Name |Type |Description | +|--------------------------|------------------------------|------------------------| +|digit_pattern_permissions |List[digitPatternPermissions] |digitPatternPermissions |
-## `StreetAddress`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `OutgoingCallingPlanGroupAuthorizationCodes`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Street address information. +Outgoing Calling Plan Authorization Code for the group default. **Attributes:** -|Name |Type|Description | -|-------------------------------|----|--------------------------------------| -|address_line1 |str |addressLine1 *Optional* | -|address_line2 |str |addressLine2 *Optional* | -|city |str |city *Optional* | -|state_or_province |str |stateOrProvince *Optional* | -|state_or_province_display_name |str |stateOrProvinceDisplayName *Optional* | -|zip_or_postal_code |str |zipOrPostalCode *Optional* | -|country |str |country *Optional* | +|Name |Type |Description | +|-----------|----------------|---------------------| +|code_entry |List[codeEntry] |codeEntry *Optional* |
-## `SystemBroadWorksMobilityGetRequest21sp1V2`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `OutgoingCallingPlanOriginatingDepartmentPermissions`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Get the broadworks mobility system parameters. +Outgoing Calling Plan originating call permissions for a department. -The response is either a SystemBroadWorksMobilityGetResponse21sp1V2 or an -`ErrorResponse()`. Replaced by `SystemBroadWorksMobilityGetRequest22V2()`. +**Attributes:** + +|Name |Type |Description | +|----------------|--------------|---------------| +|department_key |departmentKey |departmentKey | +|department_name |str |departmentName | +|permissions |permissions |permissions |
-## `SystemBroadWorksMobilityGetResponse21sp1V2`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `OutgoingCallingPlanOriginatingDepartmentPermissionsModify`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The response to a SystemBroadWorksMobilityGetRequest21sp1V2. +Outgoing Calling Plan originating call permissions for a department. -Replaced by `SystemBroadWorksMobilityGetResponse22V2()`. **Attributes:** -|Name |Type |Description | -|-----------------------------------------------|-----|------------------------------------------| -|enable_location_services |bool |enableLocationServices | -|enable_msrn_lookup |bool |enableMSRNLookup | -|enable_mobile_state_checking |bool |enableMobileStateChecking | -|deny_call_originations |bool |denyCallOriginations | -|deny_call_terminations |bool |denyCallTerminations | -|imrn_timeout_millisecnds |int |imrnTimeoutMillisecnds | -|enable_internal_clid_delivery_access_locations |bool |enableInternalCLIDDeliveryAccessLocations | -|enable_enhanced_unreachable_state_checking |bool |enableEnhancedUnreachableStateChecking | -|enable_network_call_barring_status_check |bool |enableNetworkCallBarringStatusCheck | +|Name |Type |Description | +|---------------|--------------|-----------------------| +|department_key |departmentKey |departmentKey | +|permissions |permissions |permissions *Optional* |
-## `SystemCollaborateGetRequest20sp1V2`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `OutgoingCallingPlanRedirectedDepartmentPermissions`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Request the system level data associated with collaborate services. +Outgoing Calling Plan being forwarded/transferred permissions for a department. -The response is either a SystemCollaborateGetResponse20sp1V2 or an `ErrorResponse()`. +**Attributes:** + +|Name |Type |Description | +|----------------|--------------|---------------| +|department_key |departmentKey |departmentKey | +|department_name |str |departmentName | +|permissions |permissions |permissions |
-## `SystemCommunicationBarringProfileGetRequest19sp1V2`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `OutgoingCallingPlanRedirectedDepartmentPermissionsModify`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Get an existing Communication Barring Profile. +Outgoing Calling Plan being forwarded/transferred permissions for a department. -The response is either a SystemCommunicationBarringProfileGetResponse19sp1V2 or an -`ErrorResponse()`. **Attributes:** -|Name |Type|Description| -|-----|----|-----------| -|name |str |name | +|Name |Type |Description | +|---------------|--------------|--------------| +|department_key |departmentKey |departmentKey | +|permissions |permissions |permissions |
-## `SystemSIPDeviceTypeGetRequest18sp1V2`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `OutgoingCallingPlanRedirectingDepartmentPermissions`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Request to get a sip device type. - -See Also: `SystemDeviceTypeGetRequest()` +Outgoing Calling Plan initiating call forwards/transfer permissions for a department. -The response is either `SystemSIPDeviceTypeGetResponse19()` or `ErrorResponse()`. -Replaced by: `SystemSIPDeviceTypeGetRequest19()`. **Attributes:** -|Name |Type|Description| -|------------|----|-----------| -|device_type |str |deviceType | +|Name |Type |Description | +|----------------|--------------|---------------| +|department_key |departmentKey |departmentKey | +|department_name |str |departmentName | +|permissions |permissions |permissions |
-## `SystemSIPDeviceTypeGetRequest21sp1V2`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `OutgoingCallingPlanRedirectingDepartmentPermissionsModify`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Request to get a sip device type. - -See Also: `SystemDeviceTypeGetRequest()` +Outgoing Calling Plan initiating call forwards/transfer permissions for a department. -The response is either SystemSIPDeviceTypeGetResponse21sp1V2 or `ErrorResponse()`. -Replaced by: `SystemSIPDeviceTypeGetRequest22()` in AS data mode. **Attributes:** -|Name |Type|Description| -|------------|----|-----------| -|device_type |str |deviceType | +|Name |Type |Description | +|---------------|--------------|--------------| +|department_key |departmentKey |departmentKey | +|permissions |permissions |permissions |
-## `TimeInterval`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `OutgoingPinholeDigitPlanDigitPatternCallMeNowPermissions`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Time Interval. +Outgoing Pinhole Digit Plan Call Me Now call permissions for specified digit patterns. **Attributes:** -|Name |Type|Description | -|------------------|----|---------------| -|start_day_of_week |str |startDayOfWeek | -|start_hour |int |startHour | -|start_minute |int |startMinute | -|end_day_of_week |str |endDayOfWeek | -|end_hour |int |endHour | -|end_minute |int |endMinute | +|Name |Type |Description | +|--------------------------|------------------------------|------------------------| +|digit_pattern_permissions |List[digitPatternPermissions] |digitPatternPermissions |
-## `TimeSchedule`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `OutgoingPinholeDigitPlanDigitPatternOriginatingPermissions`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The from dn criteria. +Outgoing Pinhole Digit Plan originating call permissions for specified digit patterns. **Attributes:** -|Name |Type|Description| -|-----|----|-----------| -|type |str |type | -|name |str |name | +|Name |Type |Description | +|--------------------------|------------------------------|------------------------| +|digit_pattern_permissions |List[digitPatternPermissions] |digitPatternPermissions |
-## `TrunkGroupDeviceEndpointAdd`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `OutgoingPinholeDigitPlanDigitPatternRedirectingPermissions`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Trunk group device endpoint used in the context of modify. +Outgoing Pinhole Digit Plan redirecting call permissions for specified digit patterns. **Attributes:** -|Name |Type|Description | -|----------|----|-------------------| -|name |str |name | -|line_port |str |linePort | -|contact |str |contact *Optional* | +|Name |Type |Description | +|--------------------------|------------------------------|------------------------| +|digit_pattern_permissions |List[digitPatternPermissions] |digitPatternPermissions |
-## `TrunkGroupDeviceEndpointModify`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `PriorityAlertCriteriaFromDnModify`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Trunk group device endpoint used in the context of modify. +The from dn criteria used within a modify request. **Attributes:** -|Name |Type|Description | -|----------|----|-------------------| -|name |str |name | -|line_port |str |linePort | -|contact |str |contact *Optional* | +|Name |Type |Description | +|----------------------------|----------------|-------------------------------------| +|from_dn_criteria_selection |str |fromDnCriteriaSelection *Optional* | +|include_anonymous_callers |bool |includeAnonymousCallers *Optional* | +|include_unavailable_callers |bool |includeUnavailableCallers *Optional* | +|phone_number_list |phoneNumberList |phoneNumberList *Optional* |
-## `TrunkGroupDeviceEndpointRead`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `ProfileAndServiceDeviceEndpointInfo`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Trunk group device endpoint. - +Represents information about an endpoint device **Attributes:** -|Name |Type |Description | -|----------------------------|-----|--------------------------| -|service_user_id |str |serviceUserId | -|name |str |name | -|line_port |str |linePort | -|contact |str |contact *Optional* | -|static_registration_capable |bool |staticRegistrationCapable | -|use_domain |bool |useDomain | +|Name |Type |Description | +|--------------------------|-------------|----------------------------------| +|access_device |accessDevice |accessDevice | +|line_port |str |linePort | +|private_identity |str |privateIdentity *Optional* | +|access_device_mac_address |str |accessDeviceMacAddress *Optional* |
-## `TrunkGroupDeviceEndpointRead14sp4`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `ProfileAndServiceMusicOnHoldInfo`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Trunk group device endpoint. - +This is the configuration parameters for Music On Hold service **Attributes:** -|Name |Type |Description | -|----------------------------|-----|--------------------------| -|name |str |name | -|line_port |str |linePort | -|contact |str |contact *Optional* | -|static_registration_capable |bool |staticRegistrationCapable | -|use_domain |bool |useDomain | -|is_pilot_user |bool |isPilotUser | +|Name |Type |Description | +|----------------------------------------|---------------|-----------------------------------| +|enable_video |bool |enableVideo | +|source |source |source | +|use_alternate_source_for_internal_calls |bool |useAlternateSourceForInternalCalls | +|internal_source |internalSource |internalSource *Optional* |
-## `TrunkGroupDeviceMultipleContactEndpointAdd`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `ProfileAndServiceSimultaneousRingPersonalInfo`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Trunk group device endpoint used in the context of modify that can have multiple -contacts. +This is the configuration parameters for Simultaneous Ring Personal service Contains a +criteria table with column heading: "Is Active", "Criteria Name", "Time Schedule", +"Holiday Schedule", "Calls From" and "Blacklisted". +The "Calls From" column is a string containing call numbers **Attributes:** -|Name |Type |Description | -|----------|----------|-------------------| -|name |str |name | -|line_port |str |linePort | -|contact |List[str] |contact *Optional* | +|Name |Type |Description | +|-------------------------|-----------------------------|------------------------------------------------------------| +|is_active |bool |isActive | +|do_not_ring_if_on_call |bool |doNotRingIfOnCall | +|simultaneous_ring_number |List[simultaneousRingNumber] |simultaneousRingNumber *Optional* | +|criteria_table |List(criteriaTable) |criteriaTable - *Table* array of criteriaTable named tuples |
-## `TrunkGroupDeviceMultipleContactEndpointRead`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `ProfileAndServiceSpeedDial100Info`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Trunk group device endpoint that can have multiple contacts. - +This is the configuration parameters for Speed Dial 100 service **Attributes:** -|Name |Type |Description | -|----------------------------|----------|--------------------------| -|name |str |name | -|line_port |str |linePort | -|contact |List[str] |contact *Optional* | -|static_registration_capable |bool |staticRegistrationCapable | -|use_domain |bool |useDomain | -|is_pilot_user |bool |isPilotUser | +|Name |Type |Description | +|-----------------|---------------------|--------------------------| +|prefix |str |prefix *Optional* | +|speed_dial_entry |List[speedDialEntry] |speedDialEntry *Optional* |
-## `TrunkGroupKey`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `ProfileAndServiceSpeedDial8Info`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Uniquely identifies a Trunk Group system-wide. - -The trunkGroupName is unique within a group, but not unique system-wide. +This is the configuration parameters for Speed Dial 8 service **Attributes:** -|Name |Type|Description | -|--------------------|----|------------------| -|service_provider_id |str |serviceProviderId | -|group_id |str |groupId | -|name |str |name | +|Name |Type |Description | +|-----------------|---------------------|--------------------------| +|speed_dial_entry |List[speedDialEntry] |speedDialEntry *Optional* |
-## `UnboundedNonNegativeInt`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `PushNotificationTokenData`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Unbounded Quantity. +? The common push notification token elements. -Can either be unlimited or a non-negative int quantity. **Attributes:** -|Name |Type |Description | -|----------|-----|---------------------| -|unlimited |bool |unlimited *Optional* | -|quantity |int |quantity *Optional* | +|Name |Type |Description | +|-----------------------------|--------------------------------|-------------------------------------| +|push_notification_token |str |pushNotificationToken | +|push_notification_type |str |pushNotificationType | +|push_notification_event_data |List[pushNotificationEventData] |pushNotificationEventData *Optional* |
-## `UnboundedPositiveInt`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `ReceptionistContactUserAndNote`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Unbounded Quantity. +The Receptionist User (or VON User) and Receptionist Notes. -Can either be unlimited or a positive int quantity. **Attributes:** -|Name |Type |Description | -|----------|-----|---------------------| -|unlimited |bool |unlimited *Optional* | -|quantity |int |quantity *Optional* | +|Name |Type |Description | +|----------------|--------|-------------------------| +|contact_user_id |str |contactUserId *Optional* | +|von_user |vonUser |vonUser *Optional* | +|note |str |note |
-## `UserBroadWorksMobilityMobileIdentityGetRequest21sp1V2`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `ReplacementAgentWeightList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Get the settings for a user's specified mobile identity. +A list of agent userIds and hunt agent weights that replaces the previously configured +list. -The response is either a UserBroadWorksMobilityMobileIdentityGetResponse21sp1V2 or an -`ErrorResponse()`. Replaced by: `UserBroadWorksMobilityMobileIdentityGetRequest22()`. +By convention, an element of this type may be set nill to clear the list. **Attributes:** -|Name |Type|Description | -|--------------|----|-------------| -|user_id |str |userId | -|mobile_number |str |mobileNumber | +|Name |Type |Description | +|-------------|------------------|------------| +|agent_weight |List[agentWeight] |agentWeight |
-## `UserDNExtension`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `ReplacementAlternateUserIdEntryList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-User's DN and extension. +A list of alternate user ids that that replaces a previously configured list. -Used in SearchCriteriaComposedOrDnExtension when either a DN or an extension can be -used as a search criteria. +By convention, an element of this type may be set nill to clear the list. **Attributes:** -|Name |Type|Description | -|----------|----|---------------------| -|dn |str |dn *Optional* | -|extension |str |extension *Optional* | +|Name |Type |Description | +|------------------|----------------------|----------------| +|alternate_user_id |List[alternateUserId] |alternateUserId |
-## `UserDisplayNames`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `ReplacementCallToNumberList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The parts of a user's display name that a client can display in whatever way is -appropriate for the client application. +A list of Call to Numbers that replaces a previously configured list. +By convention, an element of this type may be set nill to clear the list. For the +callToNumbers, the extension element is not used and the number element is only used +when the type is BroadWorks Mobility. **Attributes:** -|Name |Type|Description | -|--------------------|----|-----------------------------| -|last_name |str |lastName | -|first_name |str |firstName | -|hiragana_last_name |str |hiraganaLastName *Optional* | -|hiragana_first_name |str |hiraganaFirstName *Optional* | +|Name |Type |Description | +|---------------|-------------------|-------------| +|call_to_number |List[callToNumber] |callToNumber |
-## `UserEndpointKey`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `ReplacementCommunicationBarringCallMeNowRuleList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Key to uniquely identify a user endpoint. +A list of Communication Barring CallMeNow Rules that replaces a previously configured +list. +By convention, an element of this type may be set nill to clear the list. **Attributes:** -|Name |Type|Description| -|----------|----|-----------| -|user_id |str |userId | -|line_port |str |linePort | +|Name |Type |Description| +|-----|-----------|-----------| +|rule |List[rule] |rule |
-## `UserEnhancedCallLogsGetListResponse17sp4V2`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `ReplacementCommunicationBarringIncomingRuleList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Response to UserEnhancedCallLogsGetListRequest17sp4V2. +A list of Communication Barring Incoming Rules that replaces a previously configured +list. -Total numbers of rows is: - the total number of retrievable logs of the call log type -that was specified in the UserEnhancedCallLogsGetListRequest17sp4V2, if a call log -type was specified in the request. - the total number of retrievable logs, if no call -log type was specified in the request. A list of MixedCallLogsEntry will be returned -if the call logs are stored on CDS A list of ExtendedMixedCallLogsEntry17sp4 will be -returned if the call logs are stored on DBS The logs are sorted by date/time of the -call. +By convention, an element of this type may be set nill to clear the list. **Attributes:** -|Name |Type |Description | -|---------------------|--------------|-------------------------| -|total_number_of_rows |int |totalNumberOfRows | -|legacy_entry |legacyEntry |legacyEntry *Optional* | -|extended_entry |extendedEntry |extendedEntry *Optional* | +|Name |Type |Description| +|-----|-----------|-----------| +|rule |List[rule] |rule |
-## `UserEnhancedCallLogsGetListResponse21sp1V2`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `ReplacementCommunicationBarringIncomingRuleList19sp1`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Response to UserEnhancedCallLogsGetListRequest21sp1V2. +A list of Communication Barring Incoming Rules that replaces a previously configured +list. -Total numbers of rows is: - the total number of retrievable logs of the call log type -that was specified in the UserEnhancedCallLogsGetListRequest21sp1V2, if a call log -type was specified in the request. - the total number of retrievable logs, if no call -log type was specified in the request. A list of MixedCallLogsEntry will be returned -if the call logs are stored on CDS A list of ExtendedMixedCallLogsEntry21sp1V2 will be -returned if the call logs are stored on DBS The logs are sorted by date/time of the -call. +By convention, an element of this type may be set nill to clear the list. **Attributes:** -|Name |Type |Description | -|---------------------|--------------|-------------------------| -|total_number_of_rows |int |totalNumberOfRows | -|legacy_entry |legacyEntry |legacyEntry *Optional* | -|extended_entry |extendedEntry |extendedEntry *Optional* | +|Name |Type |Description| +|-----|-----------|-----------| +|rule |List[rule] |rule |
-## `UserFeatureAccessCodeModifyEntry`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `ReplacementCommunicationBarringOriginatingRuleList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Feature Access Code Entry to be used in all user modify command. +A list of Communication Barring Originating Rules that replaces a previously +configured list. +By convention, an element of this type may be set nill to clear the list. **Attributes:** -|Name |Type |Description | -|-------------------------|-----|----------------------| -|feature_access_code_name |str |featureAccessCodeName | -|enable_fac |bool |enableFAC *Optional* | +|Name |Type |Description| +|-----|-----------|-----------| +|rule |List[rule] |rule |
-## `UserGetRequest21sp1V2`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `ReplacementCommunicationBarringRedirectingRuleList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Request to get the user information. +A list of Communication Barring Redirecting Rules that replaces a previously +configured list. -The response is either UserGetResponse21sp1V2 or `ErrorResponse()`. Replaced by -`UserGetRequest22V3()` in AS data mode +By convention, an element of this type may be set nill to clear the list. **Attributes:** -|Name |Type|Description| -|--------|----|-----------| -|user_id |str |userId | +|Name |Type |Description| +|-----|-----------|-----------| +|rule |List[rule] |rule |
-## `UserMoveMessage`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `ReplacementContactList22`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The message describes the impact made when moving a user from one group to another -group within the enterprise. +A list of SIP contacts that replaces a previously configured list. -The message could also contain the error condition that prevents the user move. +By convention, an element of this type may be set nill to clear the list. **Attributes:** -|Name |Type|Description | -|----------------|----|---------------| -|message_code |int |messageCode | -|summary |str |summary | -|summary_english |str |summaryEnglish | +|Name |Type |Description| +|--------|--------------|-----------| +|contact |List[contact] |contact |
-## `UserPreferredCarrierName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `ReplacementCustomContactDirectoryEntryList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-User can either use it's group's preferred carrier or use it's own. +A list of userIds and/or Virtual On-Net user DNs that replaces a previously configured +list. -The user carrier name is exposed if it was previously configured. +By convention, an element of this type may be set nill to clear the list. **Attributes:** -|Name |Type |Description | -|----------------------------|-----|-------------------------| -|use_group_preferred_carrier |bool |useGroupPreferredCarrier | -|carrier |str |carrier *Optional* | +|Name |Type |Description| +|------|------------|-----------| +|entry |List[entry] |entry |
-## `UserPreferredCarrierNameModify`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `ReplacementDeviceList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-User can either use it's group's preferred carrier or use it's own. +A list of devices that replaces a previously configured list. -You can use the group's preferred carrier without clearing the user carrier name -- in -this case, the user carrier name is retained. +By convention, an element of this type may be set nill to clear the list. **Attributes:** -|Name |Type |Description | -|----------------------------|-----|-------------------------| -|use_group_preferred_carrier |bool |useGroupPreferredCarrier | -|carrier |str |carrier *Optional* | +|Name |Type |Description| +|-------|-------------|-----------| +|device |List[device] |device |
-## `UserTwoStageDialingGetRequest13Mp20`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `ReplacementEnterpriseEnterpriseTrunkTrunkGroupKeyList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Request the user level data associated with Two Stage Dialing. +A list of Enterprise Trunk Krunk Group Keys that replaces a previously configured +list. -The response is either a UserTwoStageDialingGetResponse13Mp20 or an `ErrorResponse()`. +By convention, an element of this type may be set nill to clear the list. **Attributes:** -|Name |Type|Description| -|--------|----|-----------| -|user_id |str |userId | -
+|Name |Type |Description| +|------------|-----------------|-----------| +|trunk_group |List[trunkGroup] |trunkGroup | + -## `UserTwoStageDialingGetResponse13Mp20`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `ReplacementEnterpriseTrunkTrunkGroupKeyList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Response to UserTwoStageDialingGetRequest13Mp20. +A list of Enterprise Trunk Krunk Group Keys that replaces a previously configured +list. +By convention, an element of this type may be set nill to clear the list. **Attributes:** -|Name |Type |Description | -|-------------------------------------|-----|---------------------------------| -|is_active |bool |isActive | -|allow_activation_with_user_addresses |bool |allowActivationWithUserAddresses | +|Name |Type |Description | +|-----------------|---------------------|---------------| +|trunk_group_list |List[trunkGroupList] |trunkGroupList |
-## `VerifyTranslationAndRoutingOrigination`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `ReplacementGroupEnterpriseTrunkPriorityWeightedTrunkGroupList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Verification Translation and Routing origination value. +A list of enterprise trunk priority weighted trunk groups in a group that replaces a +previously configured list. +By convention, an element of this type may be set nill to clear the list. **Attributes:** -|Name |Type|Description | -|----------|----|--------------------| -|line_port |str |linePort *Optional* | -|phone |str |phone *Optional* | -|user_id |str |userId *Optional* | -|url |str |url *Optional* | +|Name |Type |Description| +|------------|-----------------|-----------| +|trunk_group |List[trunkGroup] |trunkGroup |
-## `VirtualOnNetUser`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `ScheduleEvents`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Virtual On-Net User. +Retrives all Holiday or Time Event details for a given schedulel Level. **Attributes:** -|Name |Type|Description | -|------------------------------|----|-------------------------| -|phone_number |str |phoneNumber | -|extension |str |extension | -|first_name |str |firstName | -|last_name |str |lastName | -|calling_line_id_first_name |str |callingLineIdFirstName | -|calling_line_id_last_name |str |callingLineIdLastName | -|virtual_on_net_call_type_name |str |virtualOnNetCallTypeName | +|Name |Type |Description | +|--------------|-----------|-----------------------| +|eventname |str |eventname | +|start_date |str |startDate | +|all_day_event |bool |allDayEvent *Optional* | +|start_time |startTime |startTime *Optional* | +|end_time |endTime |endTime *Optional* | +|end_date |str |endDate | +|recurrence |recurrence |recurrence *Optional* |
-## `VirtualOnNetUserKey`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `ScheduleGlobalKey`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Virtual On-Net User identifier which is the Service Provider ID, Group ID, and phone -number (in E. +Uniquely identifies Holiday and Time Schedules throughout all System, Service +Provider, Group and User level. -164 format). **Attributes:** -|Name |Type|Description | -|--------------------|----|------------------| -|service_provider_id |str |serviceProviderId | -|group_id |str |groupId | -|phone_number |str |phoneNumber | +|Name |Type |Description | +|---------------|------------|--------------| +|schedule_key |scheduleKey |scheduleKey | +|schedule_level |str |scheduleLevel |
-## `VoiceMessagingAliasListModify`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaAccessDeviceEndpointPrivateIdentity`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-A list of dns that is added to a previously configured list. +Criteria for searching for a private identity. **Attributes:** -|Name |Type |Description | -|-------------|----------|------------| -|phone_number |List[str] |phoneNumber | +|Name |Type |Description | +|--------------------|-----|------------------| +|mode |str |mode | +|value |str |value | +|is_case_insensitive |bool |isCaseInsensitive |
-## `VoiceMessagingAliasReplacementList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaAccessDeviceVersion`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-A list of dns that that replaces a previously configured list. +Criteria for searching for an Access Device Version. -By convention, an element of this type may be set nil to clear the list. **Attributes:** -|Name |Type |Description | -|-------------|----------|------------| -|phone_number |List[str] |phoneNumber | +|Name |Type |Description | +|--------------------|-----|------------------| +|mode |str |mode | +|value |str |value | +|is_case_insensitive |bool |isCaseInsensitive |
-## `VoiceMessagingAlternateNoAnswerGreetingRead`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaAdminFirstName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The configuration of a alternate no answer greeting. +Criteria for searching for an administrator's first name. -It is used when geting a user's voice messaging greeting. **Attributes:** -|Name |Type|Description | -|-----------|----|---------------------| -|name |str |name | -|audio_file |str |audioFile *Optional* | -|video_file |str |videoFile *Optional* | +|Name |Type |Description | +|--------------------|-----|------------------| +|mode |str |mode | +|value |str |value | +|is_case_insensitive |bool |isCaseInsensitive |
-## `VoiceMessagingAlternateNoAnswerGreetingRead16`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaAdminId`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The configuration of a alternate no answer greeting. +Criteria for searching for an administrator's adminId. -It is used when geting a user's voice messaging greeting. **Attributes:** -|Name |Type|Description | -|-----------------|----|--------------------------| -|name |str |name | -|audio_file |str |audioFile *Optional* | -|audio_media_type |str |audioMediaType *Optional* | -|video_file |str |videoFile *Optional* | -|video_media_type |str |videoMediaType *Optional* | +|Name |Type |Description | +|--------------------|-----|------------------| +|mode |str |mode | +|value |str |value | +|is_case_insensitive |bool |isCaseInsensitive |
-## `VoiceMessagingMenuKeysModifyEntry`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaAdminLastName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The voice portal voice messaging menu keys modify entry. +Criteria for searching for an administrator's last name. **Attributes:** -|Name |Type|Description | -|------------------------------|----|--------------------------------------| -|play_messages |str |playMessages *Optional* | -|change_busy_greeting |str |changeBusyGreeting *Optional* | -|change_no_answer_greeting |str |changeNoAnswerGreeting *Optional* | -|change_extended_away_greeting |str |changeExtendedAwayGreeting *Optional* | -|compose_message |str |composeMessage *Optional* | -|delete_all_messages |str |deleteAllMessages *Optional* | -|passcode |str |passcode *Optional* | -|personalized_name |str |personalizedName *Optional* | -|message_deposit |str |messageDeposit *Optional* | -|return_to_previous_menu |str |returnToPreviousMenu *Optional* | -|repeat_menu |str |repeatMenu *Optional* | +|Name |Type |Description | +|--------------------|-----|------------------| +|mode |str |mode | +|value |str |value | +|is_case_insensitive |bool |isCaseInsensitive |
-## `VoiceMessagingMenuKeysReadEntry`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaAgentThresholdProfile`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The voice portal voice messaging menu keys. +Criteria for searching a Call Center Agent Threshold Profile. **Attributes:** -|Name |Type|Description | -|------------------------------|----|--------------------------------------| -|play_messages |str |playMessages *Optional* | -|change_busy_greeting |str |changeBusyGreeting *Optional* | -|change_no_answer_greeting |str |changeNoAnswerGreeting *Optional* | -|change_extended_away_greeting |str |changeExtendedAwayGreeting *Optional* | -|compose_message |str |composeMessage *Optional* | -|delete_all_messages |str |deleteAllMessages *Optional* | -|passcode |str |passcode *Optional* | -|personalized_name |str |personalizedName *Optional* | -|message_deposit |str |messageDeposit *Optional* | -|return_to_previous_menu |str |returnToPreviousMenu | -|repeat_menu |str |repeatMenu *Optional* | +|Name |Type |Description | +|--------------------|-----|------------------| +|mode |str |mode | +|value |str |value | +|is_case_insensitive |bool |isCaseInsensitive |
-## `VoicePortalCallingMenuKeysModifyEntry`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaAlternateTrunkIdentity`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The voice portal calling menu keys modify entry. +Criteria for searching for a particular fully specified alternate trunk identity. +In IMS mode, it only applies to the user part of alternate trunk identity. **Attributes:** -|Name |Type|Description | -|----------------------------------------------|----|-------------------------------------------------| -|end_current_call_and_go_back_to_previous_menu |str |endCurrentCallAndGoBackToPreviousMenu *Optional* | -|return_to_previous_menu |str |returnToPreviousMenu *Optional* | +|Name |Type |Description | +|--------------------|-----|------------------| +|mode |str |mode | +|value |str |value | +|is_case_insensitive |bool |isCaseInsensitive |
-## `VoicePortalCallingMenuKeysReadEntry`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaAlternateTrunkIdentityDomain`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The voice portal change calling menu keys. +Criteria for searching for alternate trunk identity domain part. **Attributes:** -|Name |Type|Description | -|----------------------------------------------|----|--------------------------------------| -|end_current_call_and_go_back_to_previous_menu |str |endCurrentCallAndGoBackToPreviousMenu | -|return_to_previous_menu |str |returnToPreviousMenu | +|Name |Type |Description | +|--------------------|-----|------------------| +|mode |str |mode | +|value |str |value | +|is_case_insensitive |bool |isCaseInsensitive |
-## `VoicePortalLoginMenuKeysModifyEntry`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaAlternateUserId`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The voice portal voice portal login menu keys modify entry. +Criteria for searching for a user's alternate userId. **Attributes:** -|Name |Type|Description | -|------------------------------|----|-------------------------------------| -|access_using_other_mailbox_id |str |accessUsingOtherMailboxId *Optional* | +|Name |Type |Description | +|--------------------|-----|------------------| +|mode |str |mode | +|value |str |value | +|is_case_insensitive |bool |isCaseInsensitive |
-## `VoicePortalLoginMenuKeysReadEntry`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaAnnouncementFileName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The voice portal login menu keys. +Criteria for searching for an Announcement File Name. **Attributes:** -|Name |Type|Description | -|------------------------------|----|-------------------------------------| -|access_using_other_mailbox_id |str |accessUsingOtherMailboxId *Optional* | +|Name |Type |Description | +|--------------------|-----|------------------| +|mode |str |mode | +|value |str |value | +|is_case_insensitive |bool |isCaseInsensitive |
-## `VoicePortalMainMenuKeysModifyEntry`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaCallCenterName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The voice portal main menu keys modify entry. - +Criteria for searching for a call center **Attributes:** -|Name |Type|Description | -|---------------------------|----|-----------------------------------| -|voice_messaging |str |voiceMessaging *Optional* | -|comm_pilot_express_profile |str |commPilotExpressProfile *Optional* | -|greetings |str |greetings *Optional* | -|call_forwarding_options |str |callForwardingOptions *Optional* | -|voice_portal_calling |str |voicePortalCalling *Optional* | -|hoteling |str |hoteling *Optional* | -|passcode |str |passcode *Optional* | -|exit_voice_portal |str |exitVoicePortal *Optional* | -|repeat_menu |str |repeatMenu *Optional* | -|external_routing |str |externalRouting *Optional* | -|announcement |str |announcement *Optional* | -|personal_assistant |str |personalAssistant *Optional* | +|Name |Type |Description | +|--------------------|-----|------------------| +|mode |str |mode | +|value |str |value | +|is_case_insensitive |bool |isCaseInsensitive |
-## `VoicePortalMainMenuKeysReadEntry`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaCallCenterReportTemplateName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The voice portal main menu keys. +Criteria for searching for a particular call center enhanced reporting report +template. **Attributes:** -|Name |Type|Description | -|---------------------------|----|-----------------------------------| -|voice_messaging |str |voiceMessaging *Optional* | -|comm_pilot_express_profile |str |commPilotExpressProfile *Optional* | -|greetings |str |greetings *Optional* | -|call_forwarding_options |str |callForwardingOptions *Optional* | -|voice_portal_calling |str |voicePortalCalling *Optional* | -|hoteling |str |hoteling *Optional* | -|passcode |str |passcode *Optional* | -|exit_voice_portal |str |exitVoicePortal *Optional* | -|repeat_menu |str |repeatMenu *Optional* | -|external_routing |str |externalRouting *Optional* | -|announcement |str |announcement *Optional* | -|personal_assistant |str |personalAssistant *Optional* | +|Name |Type |Description | +|--------------------|-----|------------------| +|mode |str |mode | +|value |str |value | +|is_case_insensitive |bool |isCaseInsensitive |
-## `XsiApplicationIdEntry`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaCallCenterScheduledReportName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The system application Id entry. +Criteria for searching for a call center enhanced reporting scheduled report name. **Attributes:** -|Name |Type|Description | -|-------------------|----|-----------------------| -|xsi_application_id |str |xsiApplicationId | -|description |str |description *Optional* | +|Name |Type |Description | +|--------------------|-----|------------------| +|mode |str |mode | +|value |str |value | +|is_case_insensitive |bool |isCaseInsensitive |
-## `XsiPolicyProfileAssignEntry`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaCallParkName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The Xsi policy profile assign entry contains multiple Xsi policy profile and one -default xsi policy profile. - +Criteria for searching for a call park by name **Attributes:** -|Name |Type |Description | -|--------|----------|-------------------| -|name |List[str] |name *Optional* | -|default |str |default *Optional* | +|Name |Type |Description | +|--------------------|-----|------------------| +|mode |str |mode | +|value |str |value | +|is_case_insensitive |bool |isCaseInsensitive |
-## `XsiPolicyProfileKey`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaCallPickupName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The system Xsi policy profile key. - +Criteria for searching for a call pickup by name **Attributes:** -|Name |Type|Description| -|------|----|-----------| -|name |str |name | -|level |str |level | +|Name |Type |Description | +|--------------------|-----|------------------| +|mode |str |mode | +|value |str |value | +|is_case_insensitive |bool |isCaseInsensitive |
-## `XsiPolicyProfileUnassignEntry`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaCommunicationBarringAuthorizationCode`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The Xsi policy profile unassign entry contains mutiltipe Xsi policy profile and a new -replacement default xsi policy profile. +Criteria for searching for a Communication Barring Authorization Code. **Attributes:** -|Name |Type |Description | -|------------|----------|----------------------| -|name |List[str] |name *Optional* | -|new_default |str |newDefault *Optional* | +|Name |Type |Description | +|--------------------|-----|------------------| +|mode |str |mode | +|value |str |value | +|is_case_insensitive |bool |isCaseInsensitive |
-## `AccessDeviceEndpointAdd`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaCommunicationBarringAuthorizationCodeDescription`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Access device end point used in the context of add. +Criteria for searching for a Communication Barring Authorization Code description. -Port numbers are only used by devices with static line ordering. The following -element is only used in AS data mode and ignored in XS data mode: pathHeader **Attributes:** -|Name |Type |Description | -|--------------|-------------|----------------------| -|access_device |accessDevice |accessDevice | -|line_port |str |linePort | -|contact |str |contact *Optional* | -|path_header |str |pathHeader *Optional* | -|port_number |int |portNumber *Optional* | +|Name |Type |Description | +|--------------------|-----|------------------| +|mode |str |mode | +|value |str |value | +|is_case_insensitive |bool |isCaseInsensitive |
-## `AccessDeviceEndpointAndHotlineAdd`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaComposedOrDnExtension`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Access device end point used in the context of add. +Criteria for searching for a DN OR an extension. -Port numbers are only used by devices with static line ordering. The following -element is only used in AS data mode and ignored in XS data mode: pathHeader -useHotline, use value false in XS data mode hotlineContact The following element is -only used in XS data mode and ignored in AS data mode: privateIdentity +Note: For this search criterion, the searchMode is always ‘Contains’ and the search +criteria are always OR’ed. **Attributes:** -|Name |Type |Description | -|-----------------|-------------|---------------------------| -|access_device |accessDevice |accessDevice | -|line_port |str |linePort | -|private_identity |str |privateIdentity *Optional* | -|contact |str |contact *Optional* | -|path_header |str |pathHeader *Optional* | -|port_number |int |portNumber *Optional* | -|use_hotline |bool |useHotline | -|hotline_contact |str |hotlineContact *Optional* | +|Name |Type |Description| +|------|------|-----------| +|value |value |value |
-## `AccessDeviceEndpointAndHotlineModify`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaComposedOrUserName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Access device end point used in the context of modify. +Criteria for searching for a user's full name. -Port numbers are only used by devices with static line ordering. The following -element is only used in AS data mode and ignored in XS data mode: pathHeader -useHotline hotlineContact +This search criterion will be compared against multiple combinations of first name and +last name: First Name + ‘ ‘ + Last Name Last Name + ‘ ‘ + First Name Hiragana Last +Name + ' ' + Hiragana First Name Note: For this search criterion, the searchMode is +always ‘Contains’ and the search criteria are always OR’ed. **Attributes:** -|Name |Type |Description | -|----------------|-------------|--------------------------| -|access_device |accessDevice |accessDevice | -|line_port |str |linePort | -|contact |str |contact *Optional* | -|path_header |str |pathHeader *Optional* | -|port_number |int |portNumber *Optional* | -|use_hotline |bool |useHotline *Optional* | -|hotline_contact |str |hotlineContact *Optional* | +|Name |Type |Description | +|--------------------|----------|------------------| +|value |List[str] |value | +|is_case_insensitive |bool |isCaseInsensitive |
-## `AccessDeviceEndpointKey`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaDepartmentName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Access device end point in the context of a modify or delete command. +Criteria for searching for a user's department. **Attributes:** -|Name |Type |Description | -|--------------|-------------|-------------| -|access_device |accessDevice |accessDevice | -|line_port |str |linePort | +|Name |Type |Description | +|--------------------|-----|------------------| +|mode |str |mode | +|value |str |value | +|is_case_insensitive |bool |isCaseInsensitive |
-## `AccessDeviceEndpointModify`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaDeviceMACAddress`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Access device end point used in the context of modify. +Criteria for searching for device MAC address. -Port numbers are only used by devices with static line ordering. The following -element is only used in AS data mode and ignored in XS data mode: pathHeader **Attributes:** -|Name |Type |Description | -|--------------|-------------|----------------------| -|access_device |accessDevice |accessDevice | -|line_port |str |linePort | -|contact |str |contact *Optional* | -|path_header |str |pathHeader *Optional* | -|port_number |int |portNumber *Optional* | +|Name |Type |Description | +|--------------------|-----|------------------| +|mode |str |mode | +|value |str |value | +|is_case_insensitive |bool |isCaseInsensitive |
-## `AccessDeviceEndpointRead14`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaDeviceManagementEventAdditionalInfo`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Access device end point. +Criteria for searching for a particular additional info of a DeviceManagement event. **Attributes:** -|Name |Type |Description | -|----------------------------|-------------|--------------------------| -|access_device |accessDevice |accessDevice | -|line_port |str |linePort | -|contact |str |contact *Optional* | -|static_registration_capable |bool |staticRegistrationCapable | -|use_domain |bool |useDomain | +|Name |Type |Description | +|--------------------|-----|------------------| +|mode |str |mode | +|value |str |value | +|is_case_insensitive |bool |isCaseInsensitive |
-## `AccessDeviceEndpointWithPortNumberRead`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaDeviceManagementEventLoginId`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Access device end point. +Criteria for searching for a particular login id. -Port numbers are only used by devices with static line ordering. **Attributes:** -|Name |Type |Description | -|----------------------------|-------------|--------------------------| -|access_device |accessDevice |accessDevice | -|line_port |str |linePort | -|contact |str |contact *Optional* | -|static_registration_capable |bool |staticRegistrationCapable | -|use_domain |bool |useDomain | -|port_number |int |portNumber *Optional* | +|Name |Type |Description | +|--------------------|-----|------------------| +|mode |str |mode | +|value |str |value | +|is_case_insensitive |bool |isCaseInsensitive |
-## `AccessDeviceEndpointWithPortNumberRead22`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaDeviceName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Access device end point. +Criteria for searching for device name. -Port numbers are only used by devices with static line ordering. The following -element is only used in AS data mode and ignored in XS data mode: pathHeader **Attributes:** -|Name |Type |Description | -|----------------------------|-------------|--------------------------| -|access_device |accessDevice |accessDevice | -|line_port |str |linePort | -|contact |str |contact *Optional* | -|path_header |str |pathHeader *Optional* | -|static_registration_capable |bool |staticRegistrationCapable | -|use_domain |bool |useDomain | -|port_number |int |portNumber *Optional* | +|Name |Type |Description | +|--------------------|-----|------------------| +|mode |str |mode | +|value |str |value | +|is_case_insensitive |bool |isCaseInsensitive |
-## `AccessDeviceEndpointWithPortNumberRead22V2`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaDeviceNetAddress`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Access device end point. +Criteria for searching for device network address. -Port numbers are only used by devices with static line ordering. The following -element is only used in AS data mode and ignored in XS data mode: pathHeader -hotlineContact The following elements are only used in AS data mode and a value false -is returned in the XS mode: useHotline **Attributes:** -|Name |Type |Description | -|----------------------------|-------------|--------------------------| -|access_device |accessDevice |accessDevice | -|line_port |str |linePort | -|contact |str |contact *Optional* | -|path_header |str |pathHeader *Optional* | -|static_registration_capable |bool |staticRegistrationCapable | -|use_domain |bool |useDomain | -|port_number |int |portNumber *Optional* | -|use_hotline |bool |useHotline | -|hotline_contact |str |hotlineContact *Optional* | +|Name |Type |Description | +|--------------------|-----|------------------| +|mode |str |mode | +|value |str |value | +|is_case_insensitive |bool |isCaseInsensitive |
-## `AccessDeviceMultipleContactEndpointAdd`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaDeviceSerialNumber`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Access device end point used in the context of add that can have more than one contact -defined. +Criteria for searching for device serial number. -Only Static Registration capabable devices may have more than one contact defined. -Port numbers are only used by devices with static line ordering. **Attributes:** -|Name |Type |Description | -|--------------|-------------|----------------------| -|access_device |accessDevice |accessDevice | -|line_port |str |linePort | -|contact |List[str] |contact *Optional* | -|port_number |int |portNumber *Optional* | +|Name |Type |Description | +|--------------------|-----|------------------| +|mode |str |mode | +|value |str |value | +|is_case_insensitive |bool |isCaseInsensitive |
-## `AccessDeviceMultipleContactEndpointAdd22`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaDeviceType`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Access device end point used in the context of add that can have more than one contact -defined. +Criteria for searching for device type. -Only Static Registration capabable devices may have more than one contact defined. -Port numbers are only used by devices with static line ordering. **Attributes:** -|Name |Type |Description | -|--------------|--------------|----------------------| -|access_device |accessDevice |accessDevice | -|line_port |str |linePort | -|contact |List[contact] |contact *Optional* | -|port_number |int |portNumber *Optional* | +|Name |Type |Description | +|--------------------|-----|------------------| +|mode |str |mode | +|value |str |value | +|is_case_insensitive |bool |isCaseInsensitive |
-## `AccessDeviceMultipleContactEndpointModify`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaDigitPattern`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Access device end point used in the context of modify that can have more than one -contact defined. +Criteria for searching for digit pattern. -Only Static Registration capable devices may have more than one contact defined. Port -numbers are only used by devices with static line ordering. **Attributes:** -|Name |Type |Description | -|--------------|-------------|------------------------| -|access_device |accessDevice |accessDevice *Optional* | -|line_port |str |linePort *Optional* | -|contact_list |contactList |contactList *Optional* | -|port_number |int |portNumber *Optional* | +|Name |Type |Description | +|--------------------|-----|------------------| +|mode |str |mode | +|value |str |value | +|is_case_insensitive |bool |isCaseInsensitive |
-## `AccessDeviceMultipleContactEndpointRead`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaDn`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Access device end point that can have multiple contacts. +Criteria for searching for a DN. -Replaced by AccessDeviceMultipleContactEndpointRead19. **Attributes:** -|Name |Type |Description | -|----------------------------|-------------|--------------------------| -|access_device |accessDevice |accessDevice | -|line_port |str |linePort | -|contact |List[str] |contact *Optional* | -|static_registration_capable |bool |staticRegistrationCapable | -|use_domain |bool |useDomain | +|Name |Type |Description | +|--------------------|-----|------------------| +|mode |str |mode | +|value |str |value | +|is_case_insensitive |bool |isCaseInsensitive |
-## `AccessDeviceMultipleContactEndpointRead19`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaDomainName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Access device end point that can have multiple contacts. +Criteria for searching for Domain Names. -Port numbers are only used by devices with static line ordering. Replaced by -AccessDeviceMultipleContactEndpointRead20. **Attributes:** -|Name |Type |Description | -|----------------------------|-------------|--------------------------| -|access_device |accessDevice |accessDevice | -|line_port |str |linePort | -|contact |List[str] |contact *Optional* | -|static_registration_capable |bool |staticRegistrationCapable | -|use_domain |bool |useDomain | -|port_number |int |portNumber *Optional* | +|Name |Type |Description | +|--------------------|-----|------------------| +|mode |str |mode | +|value |str |value | +|is_case_insensitive |bool |isCaseInsensitive |
-## `AccessDeviceMultipleContactEndpointRead20`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaEmailAddress`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Access device end point that can have multiple contacts. +Criteria for searching for a email address. -Port numbers are only used by devices with static line ordering. Replaced by -AccessDeviceMultipleContactEndpointRead22. **Attributes:** -|Name |Type |Description | -|---------------------------------|-------------|------------------------------| -|access_device |accessDevice |accessDevice | -|line_port |str |linePort | -|contact |List[str] |contact *Optional* | -|static_registration_capable |bool |staticRegistrationCapable | -|use_domain |bool |useDomain | -|port_number |int |portNumber *Optional* | -|support_visual_device_management |bool |supportVisualDeviceManagement | +|Name |Type |Description | +|--------------------|-----|------------------| +|mode |str |mode | +|value |str |value | +|is_case_insensitive |bool |isCaseInsensitive |
-## `AccessDeviceMultipleContactEndpointRead22`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaEnterpriseCommonMultiPartPhoneListName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Access device end point that can have multiple contacts. +Criteria for searching for a multi-part name in an enterprise common phone list. -Port numbers are only used by devices with static line ordering. +Note: For this search criterion, the searchMode is always ‘Contains’ and the multi- +part search criteria are always AND’ed. **Attributes:** -|Name |Type |Description | -|---------------------------------|--------------|------------------------------| -|access_device |accessDevice |accessDevice | -|line_port |str |linePort | -|contact |List[contact] |contact *Optional* | -|static_registration_capable |bool |staticRegistrationCapable | -|use_domain |bool |useDomain | -|port_number |int |portNumber *Optional* | -|support_visual_device_management |bool |supportVisualDeviceManagement | +|Name |Type |Description | +|--------------------|----------|------------------| +|value |List[str] |value | +|is_case_insensitive |bool |isCaseInsensitive |
-## `AccessDeviceMultipleIdentityAndContactEndpointAdd`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaEnterpriseCommonPhoneListName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Access device end point used in the context of add that can have more than one contact -defined. +Criteria for searching for a name in an enterprise common phone list. -The endpoint is identified by its linePort (public Identity) and possibly a private -Identity. Only Static Registration capabable devices may have more than one contact -defined. Port numbers are only used by devices with static line ordering. The -following elements are only used in XS data mode and ignored in AS data mode: -privateIdentity **Attributes:** -|Name |Type |Description | -|-----------------|-------------|---------------------------| -|access_device |accessDevice |accessDevice | -|line_port |str |linePort | -|private_identity |str |privateIdentity *Optional* | -|contact |List[str] |contact *Optional* | -|port_number |int |portNumber *Optional* | +|Name |Type |Description | +|--------------------|-----|------------------| +|mode |str |mode | +|value |str |value | +|is_case_insensitive |bool |isCaseInsensitive |
-## `AccessDeviceMultipleIdentityAndContactEndpointAdd22`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaEnterpriseCommonPhoneListNumber`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Access device end point used in the context of add that can have more than one contact -defined. +Criteria for searching for a phone number in an enterprise common phone list. -The endpoint is identified by its linePort (public Identity) and possibly a private -Identity. Only Static Registration capabable devices may have more than one contact -defined. Port numbers are only used by devices with static line ordering. The -following elements are only used in XS data mode and ignored in AS data mode: -privateIdentity **Attributes:** -|Name |Type |Description | -|-----------------|--------------|---------------------------| -|access_device |accessDevice |accessDevice | -|line_port |str |linePort | -|private_identity |str |privateIdentity *Optional* | -|contact |List[contact] |contact *Optional* | -|port_number |int |portNumber *Optional* | +|Name |Type |Description | +|--------------------|-----|------------------| +|mode |str |mode | +|value |str |value | +|is_case_insensitive |bool |isCaseInsensitive |
-## `AccessDeviceMultipleIdentityAndContactEndpointAdd22V2`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaEnterpriseTrunkName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Access device end point used in the context of add that can have more than one contact -defined. +Criteria for searching for an Enterprise Trunk name. -The endpoint is identified by its linePort (public Identity) and possibly a private -Identity. Only Static Registration capabable devices may have more than one contact -defined. Port numbers are only used by devices with static line ordering. The -following elements are only used in XS data mode and ignored in AS data mode: -privateIdentity The following elements are only used in AS data mode and ignored in XS -data mode: useHotline, use value false in XS data mode hotlineContact **Attributes:** -|Name |Type |Description | -|-----------------|--------------|---------------------------| -|access_device |accessDevice |accessDevice | -|line_port |str |linePort | -|private_identity |str |privateIdentity *Optional* | -|contact |List[contact] |contact *Optional* | -|port_number |int |portNumber *Optional* | -|use_hotline |bool |useHotline | -|hotline_contact |str |hotlineContact *Optional* | +|Name |Type |Description | +|--------------------|-----|------------------| +|mode |str |mode | +|value |str |value | +|is_case_insensitive |bool |isCaseInsensitive |
-## `AccessDeviceMultipleIdentityAndContactEndpointModify`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaExactAnnouncementFileType`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Access device end point used in the context of modify that can have more than one -contact defined. +Criteria for searching for a particular announcement file type. -The endpoint is identified by its linePort (public Identity) and possibly a private -Identity. Only Static Registration capabable devices may have more than one contact -defined. Port numbers are only used by devices with static line ordering. The -following elements are only used in XS data mode and ignored in AS data mode: -privateIdentity **Attributes:** -|Name |Type |Description | -|-----------------|-------------|---------------------------| -|access_device |accessDevice |accessDevice *Optional* | -|line_port |str |linePort *Optional* | -|private_identity |str |privateIdentity *Optional* | -|contact_list |contactList |contactList *Optional* | -|port_number |int |portNumber *Optional* | +|Name |Type|Description| +|-----|----|-----------| +|type |str |type |
-## `AccessDeviceMultipleIdentityAndContactEndpointRead`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaExactAutoAttendantType`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Access device end point that can have multiple contacts. +Criteria for searching for a particular auto-attendant type. -The endpoint is identified by its linePort (public Identity) and possibly a private -Identity. Port numbers are only used by devices with static line ordering. The -following elements are only used in XS data mode and not returned in AS data mode: -privateIdentity The following elements are only used in AS data mode and a value false -is returned in the XS mode: supportVisualDeviceManagement **Attributes:** -|Name |Type |Description | -|---------------------------------|-------------|------------------------------| -|access_device |accessDevice |accessDevice | -|line_port |str |linePort | -|private_identity |str |privateIdentity *Optional* | -|contact |List[str] |contact *Optional* | -|static_registration_capable |bool |staticRegistrationCapable | -|use_domain |bool |useDomain | -|port_number |int |portNumber *Optional* | -|support_visual_device_management |bool |supportVisualDeviceManagement | +|Name |Type|Description| +|-----|----|-----------| +|type |str |type |
-## `AccessDeviceMultipleIdentityAndContactEndpointRead22`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaExactCallCenterReportTemplateKey`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Access device end point that can have multiple contacts. +Criteria for searching for a particular call center enhanced reporting report +template. -The endpoint is identified by its linePort (public Identity) and possibly a private -Identity. Port numbers are only used by devices with static line ordering. The -following elements are only used in XS data mode and not returned in AS data mode: -privateIdentity The following elements are only used in AS data mode and a value false -is returned in the XS mode: supportVisualDeviceManagement **Attributes:** -|Name |Type |Description | -|---------------------------------|--------------|------------------------------| -|access_device |accessDevice |accessDevice | -|line_port |str |linePort | -|private_identity |str |privateIdentity *Optional* | -|contact |List[contact] |contact *Optional* | -|static_registration_capable |bool |staticRegistrationCapable | -|use_domain |bool |useDomain | -|port_number |int |portNumber *Optional* | -|support_visual_device_management |bool |supportVisualDeviceManagement | +|Name |Type |Description | +|----------------|---------------|---------------| +|report_template |reportTemplate |reportTemplate |
-## `AccessDeviceMultipleIdentityAndContactEndpointRead22V2`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaExactCallCenterScheduledReportCreatedBySupervisor`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Access device end point that can have multiple contacts. - -The endpoint is identified by its linePort (public Identity) and possibly a private -Identity. Port numbers are only used by devices with static line ordering. The -following elements are only used in XS data mode and not returned in AS data mode: -privateIdentity The following elements are only used in AS data mode and a value false -is returned in the XS mode: supportVisualDeviceManagement useHotline The following -elements are only used in AS data mode and not returned in XS data mode: -hotlineContact +Criteria for searching for call center scheduled report created by a supervisor or +administrator. + **Attributes:** -|Name |Type |Description | -|---------------------------------|--------------|------------------------------| -|access_device |accessDevice |accessDevice | -|line_port |str |linePort | -|private_identity |str |privateIdentity *Optional* | -|contact |List[contact] |contact *Optional* | -|static_registration_capable |bool |staticRegistrationCapable | -|use_domain |bool |useDomain | -|port_number |int |portNumber *Optional* | -|support_visual_device_management |bool |supportVisualDeviceManagement | -|use_hotline |bool |useHotline | -|hotline_contact |str |hotlineContact *Optional* | +|Name |Type |Description | +|----------------------|-----|--------------------| +|created_by_supervisor |bool |createdBySupervisor |
-## `AccessDeviceMultipleIdentityEndpointAdd`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaExactCallCenterScheduledReportGroup`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Access device end point used in the context of add. +Criteria for searching for a particular fully specified call center scheduled report's +group. -The endpoint is identified by its linePort (public Identity) and possibly a private -Identity. Port numbers are only used by devices with static line ordering. The -following elements are only used in XS data mode and ignored in AS data mode: -privateIdentity **Attributes:** -|Name |Type |Description | -|-----------------|-------------|---------------------------| -|access_device |accessDevice |accessDevice | -|line_port |str |linePort | -|private_identity |str |privateIdentity *Optional* | -|contact |str |contact *Optional* | -|port_number |int |portNumber *Optional* | +|Name |Type|Description | +|--------------------|----|------------------| +|service_provider_id |str |serviceProviderId | +|group_id |str |groupId |
-## `AccessDeviceMultipleIdentityEndpointKey`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaExactCallCenterScheduledReportServiceProvider`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Access device end point in the context of a modify or delete command. +Criteria for searching for a particular call center scheduled report's service +provider. -The endpoint is identified by its linePort (public Identity) and possibly a private -Identity. The following elements are only used in XS data mode and ignored in AS data -mode: privateIdentity **Attributes:** -|Name |Type |Description | -|-----------------|-------------|---------------------------| -|access_device |accessDevice |accessDevice | -|line_port |str |linePort | -|private_identity |str |privateIdentity *Optional* | +|Name |Type|Description | +|--------------------|----|------------------| +|service_provider_id |str |serviceProviderId |
-## `AccessDeviceMultipleIdentityEndpointWithType`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaExactCallCenterType`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Access device end point that can have multiple contacts. +Criteria for searching for a particular fully specified call center type. -The endpoint is identified by its linePort (public Identity) and possibly a private -Identity. Port numbers are only used by devices with static line ordering. **Attributes:** -|Name |Type |Description | -|-----------------|-------------|---------------------------| -|access_device |accessDevice |accessDevice | -|device_type |str |deviceType | -|line_port |str |linePort | -|private_identity |str |privateIdentity *Optional* | -|contact |str |contact *Optional* | -|port_number |int |portNumber *Optional* | -|mac_address |str |macAddress *Optional* | +|Name |Type|Description | +|-----------------|----|---------------| +|call_center_type |str |callCenterType |
-## `AutoAttendantKeyConfigurationEntry`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaExactCustomContactDirectory`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The configuration entry of a key for Auto Attendant. +Criteria for searching for a particular fully specified custom contact directory. -The following elements are only used in AS data mode: audioFile videoFile **Attributes:** -|Name |Type |Description | -|-------------|----------|-----------------------| -|description |str |description *Optional* | -|action |str |action | -|phone_number |str |phoneNumber *Optional* | -|audio_file |audioFile |audioFile *Optional* | -|video_file |videoFile |videoFile *Optional* | +|Name |Type|Description | +|------------------------------|----|---------------------------| +|custom_contact_directory_name |str |customContactDirectoryName |
-## `AutoAttendantKeyConfigurationEntry19`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaExactDeviceLevel`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The configuration entry of a key for Auto Attendant. +Criteria for searching for a particular device level. -The following data elements are only valid for Standard Auto Attendants: submenuId **Attributes:** -|Name |Type |Description | -|-------------|----------|-----------------------| -|description |str |description *Optional* | -|action |str |action | -|phone_number |str |phoneNumber *Optional* | -|audio_file |audioFile |audioFile *Optional* | -|video_file |videoFile |videoFile *Optional* | -|submenu_id |str |submenuId *Optional* | +|Name |Type|Description | +|-------------|----|------------| +|device_level |str |deviceLevel |
-## `AutoAttendantKeyConfigurationEntry20`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaExactDeviceManagementEventAction`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The configuration entry of a key for Auto Attendant. +Criteria for searching for a particular fully specified DeviceManagement event action. -The following data elements are only used in AS data mode: audioFile videoFile -submenuId The following data elements are only valid for Standard Auto Attendants: -submenuId **Attributes:** -|Name |Type |Description | -|-------------|----------|-----------------------| -|description |str |description *Optional* | -|action |str |action | -|phone_number |str |phoneNumber *Optional* | -|audio_file |audioFile |audioFile *Optional* | -|video_file |videoFile |videoFile *Optional* | -|submenu_id |str |submenuId *Optional* | +|Name |Type|Description | +|----------------|----|--------------| +|dm_event_action |str |dmEventAction |
-## `AutoAttendantKeyConfigurationModifyEntry`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaExactDeviceManagementEventLevel`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The modify configuration entry of a key for Auto Attendant. +Criteria for searching for a particular fully specified DeviceManagement event level. -The following data elements are only valid for Standard Auto Attendants: submenuId **Attributes:** -|Name |Type |Description | -|-------------|----------|-----------------------| -|description |str |description *Optional* | -|action |str |action | -|phone_number |str |phoneNumber *Optional* | -|audio_file |audioFile |audioFile *Optional* | -|video_file |videoFile |videoFile *Optional* | -|submenu_id |str |submenuId *Optional* | +|Name |Type|Description | +|---------------|----|-------------| +|dm_event_level |str |dmEventLevel |
-## `AutoAttendantKeyConfigurationModifyEntry20`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaExactDeviceManagementEventStatusCompleted`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The modify configuration entry of a key for Auto Attendant. +Criteria for searching for a particular fully specified Device Management completed +event status. -The following data elements are only used in AS data mode: audioFile videoFile -submenuId The following data elements are only valid for Standard Auto Attendants: -submenuId **Attributes:** -|Name |Type |Description | -|-------------|----------|-----------------------| -|description |str |description *Optional* | -|action |str |action | -|phone_number |str |phoneNumber *Optional* | -|audio_file |audioFile |audioFile *Optional* | -|video_file |videoFile |videoFile *Optional* | -|submenu_id |str |submenuId *Optional* | +|Name |Type|Description | +|--------------------------|----|-----------------------| +|dm_event_status_completed |str |dmEventStatusCompleted |
-## `AutoAttendantKeyConfigurationReadEntry20`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaExactDeviceManagementEventStatusInProgressOrPending`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The read configuration entry of a key for Auto Attendant. +Criteria for searching for a particular fully specified Device Management event in +progress or pending status. -The following data elements are only used in AS data mode: submenuId The following -data elements are only valid for Standard Auto Attendants: submenuId **Attributes:** -|Name |Type |Description | -|-------------|----------|-----------------------| -|description |str |description *Optional* | -|action |str |action | -|phone_number |str |phoneNumber *Optional* | -|audio_file |audioFile |audioFile *Optional* | -|video_file |videoFile |videoFile *Optional* | -|submenu_id |str |submenuId *Optional* | +|Name |Type|Description | +|---------------------------------------|----|---------------------------------| +|dm_event_status_in_progress_or_pending |str |dmEventStatusInProgressOrPending |
-## `AutoAttendantKeyReadConfiguration`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaExactDeviceManagementEventType`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The read configuration of a key for Auto Attendant. +Criteria for searching for a particular fully specified DeviceManagement event type. **Attributes:** -|Name |Type |Description| -|------|------|-----------| -|key |str |key | -|entry |entry |entry | +|Name |Type|Description | +|--------------|----|------------| +|dm_event_type |str |dmEventType |
-## `AutoAttendantKeyReadConfiguration19`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaExactDeviceServiceProvider`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The read configuration of a key for Auto Attendant. +Criteria for searching for a particular fully specified service provider associated +with a device. **Attributes:** -|Name |Type |Description| -|------|------|-----------| -|key |str |key | -|entry |entry |entry | +|Name |Type|Description | +|--------------------|----|------------------| +|service_provider_id |str |serviceProviderId |
-## `CPEDeviceOptionsRead`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaExactDeviceType`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-CPE device's options. +Criteria for searching for a particular fully specified device type. **Attributes:** -|Name |Type |Description | -|--------------------------------------|----------------------------------|---------------------------------------------| -|enable_monitoring |bool |enableMonitoring | -|reset_event |str |resetEvent *Optional* | -|config_type |str |configType | -|system_file_name |str |systemFileName *Optional* | -|device_file_format |str |deviceFileFormat *Optional* | -|device_management_device_type_options |deviceManagementDeviceTypeOptions |deviceManagementDeviceTypeOptions *Optional* | +|Name |Type|Description| +|------------|----|-----------| +|device_type |str |deviceType |
-## `CPEDeviceOptionsRead16`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaExactDeviceTypeConfigurationOptionType`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-CPE device's options. +Criteria for searching for a particular fully specified +DeviceTypeConfigurationOptionType. **Attributes:** -|Name |Type |Description | -|--------------------------------------|----------------------------------|---------------------------------------------| -|enable_monitoring |bool |enableMonitoring | -|reset_event |str |resetEvent *Optional* | -|config_type |str |configType | -|system_file_name |str |systemFileName *Optional* | -|device_file_format |str |deviceFileFormat *Optional* | -|device_management_device_type_options |deviceManagementDeviceTypeOptions |deviceManagementDeviceTypeOptions *Optional* | +|Name |Type|Description | +|----------------------|----|--------------------| +|device_config_options |str |deviceConfigOptions |
-## `CPEDeviceOptionsRead16sp1`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaExactDnActivation`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-CPE device's options. +Criteria for searching for a particular Dn activation state. **Attributes:** -|Name |Type |Description | -|--------------------------------------|----------------------------------|---------------------------------------------| -|enable_monitoring |bool |enableMonitoring | -|config_type |str |configType *Optional* | -|system_file_name |str |systemFileName *Optional* | -|device_file_format |str |deviceFileFormat *Optional* | -|device_management_device_type_options |deviceManagementDeviceTypeOptions |deviceManagementDeviceTypeOptions *Optional* | +|Name |Type |Description| +|----------|-----|-----------| +|activated |bool |activated |
-## `CPEDeviceOptionsRead21sp1`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaExactDnAvailability`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-CPE device's options. +Criteria for searching for a particular dn availability. **Attributes:** -|Name |Type |Description | -|--------------------------------------|----------------------------------|---------------------------------------------| -|enable_monitoring |bool |enableMonitoring | -|config_type |str |configType *Optional* | -|system_file_name |str |systemFileName *Optional* | -|device_file_format |str |deviceFileFormat *Optional* | -|device_management_device_type_options |deviceManagementDeviceTypeOptions |deviceManagementDeviceTypeOptions *Optional* | +|Name |Type |Description| +|----------|-----|-----------| +|available |bool |available |
-## `CPEDeviceOptionsRead22`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaExactDnDepartment`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-CPE device's options. +Criteria for searching for a particular fully specified DN's department. **Attributes:** -|Name |Type |Description | -|--------------------------------------|----------------------------------|---------------------------------------------| -|enable_monitoring |bool |enableMonitoring | -|config_type |str |configType *Optional* | -|system_file_name |str |systemFileName *Optional* | -|device_file_format |str |deviceFileFormat *Optional* | -|device_management_device_type_options |deviceManagementDeviceTypeOptions |deviceManagementDeviceTypeOptions *Optional* | +|Name |Type |Description | +|---------------|--------------|--------------| +|department_key |departmentKey |departmentKey |
-## `CPEDeviceOptionsRead22V2`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaExactDomainLevel`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-CPE device's options. +Criteria for searching for a particular domain level. **Attributes:** -|Name |Type |Description | -|--------------------------------------|----------------------------------|---------------------------------------------| -|enable_monitoring |bool |enableMonitoring | -|config_type |str |configType *Optional* | -|system_file_name |str |systemFileName *Optional* | -|device_file_format |str |deviceFileFormat *Optional* | -|device_management_device_type_options |deviceManagementDeviceTypeOptions |deviceManagementDeviceTypeOptions *Optional* | +|Name |Type|Description | +|-------------|----|------------| +|domain_level |str |domainLevel |
-## `CPEDeviceOptionsRead22V3`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaExactEndpointType`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-CPE device's options. +Criteria for searching for a particular endpoint type. **Attributes:** -|Name |Type |Description | -|--------------------------------------|----------------------------------|---------------------------------------------| -|enable_monitoring |bool |enableMonitoring | -|config_type |str |configType *Optional* | -|system_file_name |str |systemFileName *Optional* | -|device_file_format |str |deviceFileFormat *Optional* | -|device_management_device_type_options |deviceManagementDeviceTypeOptions |deviceManagementDeviceTypeOptions *Optional* | +|Name |Type|Description | +|--------------|----|-------------| +|endpoint_type |str |endpointType |
-## `CPEDeviceOptionsRead22V4`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaExactEndpointType21sp1`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-CPE device's options. +Criteria for searching for a particular endpoint type. **Attributes:** -|Name |Type |Description | -|--------------------------------------|----------------------------------|---------------------------------------------| -|enable_monitoring |bool |enableMonitoring | -|config_type |str |configType *Optional* | -|system_file_name |str |systemFileName *Optional* | -|device_file_format |str |deviceFileFormat *Optional* | -|device_management_device_type_options |deviceManagementDeviceTypeOptions |deviceManagementDeviceTypeOptions *Optional* | +|Name |Type|Description | +|--------------|----|-------------| +|endpoint_type |str |endpointType |
-## `CallCenterAgentStatistics13mp8`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaExactGroupAdminType`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Contains Call Center statistics for a specified agent. +Criteria for searching for a particular group administrator type. **Attributes:** -|Name |Type |Description | -|---------------------|--------------------|--------------------| -|agent_user_id |str |agentUserId | -|agent_display_names |agentDisplayNames |agentDisplayNames | -|available |bool |available | -|statistics_yesterday |statisticsYesterday |statisticsYesterday | -|statistics_today |statisticsToday |statisticsToday | +|Name |Type|Description| +|-----|----|-----------| +|type |str |type |
-## `CallCenterAgentStatistics14sp9`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaExactHuntPolicy`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Contains Call Center statistics for a specified agent. +Criteria for searching for a particular fully specified hunt policy. **Attributes:** -|Name |Type |Description | -|--------------------|------------------|------------------| -|agent_user_id |str |agentUserId | -|agent_display_names |agentDisplayNames |agentDisplayNames | -|available |bool |available | -|statistics |statistics |statistics | +|Name |Type|Description| +|------------|----|-----------| +|hunt_policy |str |huntPolicy |
-## `CallCenterAnnouncementFileListModify`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaExactLocationEnabled`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Contains a list of audio or video files to modify. +Criteria for searching for a particular Location enabled state. **Attributes:** -|Name |Type |Description | -|------|------|-----------------| -|file1 |file1 |file1 *Optional* | -|file2 |file2 |file2 *Optional* | -|file3 |file3 |file3 *Optional* | -|file4 |file4 |file4 *Optional* | +|Name |Type |Description| +|--------|-----|-----------| +|enabled |bool |enabled |
-## `CallCenterAnnouncementFileListModify20`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaExactMediaFileType`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Contains a list of announcement repository files +Criteria for searching for a particular media file type. + **Attributes:** -|Name |Type |Description | -|------|------|-----------------| -|file1 |file1 |file1 *Optional* | -|file2 |file2 |file2 *Optional* | -|file3 |file3 |file3 *Optional* | -|file4 |file4 |file4 *Optional* | +|Name |Type|Description| +|-----|----|-----------| +|type |str |type |
-## `CallCenterAnnouncementFileListRead20`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaExactMobileDnAvailability`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Contains a list of announcement repository files +Criteria for searching for a particular mobile dn availability. + **Attributes:** -|Name |Type |Description | -|------|------|-----------------| -|file1 |file1 |file1 *Optional* | -|file2 |file2 |file2 *Optional* | -|file3 |file3 |file3 *Optional* | -|file4 |file4 |file4 *Optional* | +|Name |Type |Description| +|----------|-----|-----------| +|available |bool |available |
-## `CallCenterReplacementSkilledAgents`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaExactMobileNetwork`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-A list of agents grouped by skill levels. +Criteria for searching for a particular BroadWorks Mobility Mobile Network. **Attributes:** -|Name |Type |Description| -|------------|-------|-----------| -|skill_level |int |skillLevel | -|agents |agents |agents | +|Name |Type|Description | +|--------------------|----|------------------| +|mobile_network_name |str |mobileNetworkName |
-## `CallCenterReportIntervalDates`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaExactOrganizationType`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The call center enhanced reporting report interval, using dates. +Criteria for searching for an organization type. **Attributes:** -|Name |Type |Description| -|-----------|----------|-----------| -|start_date |str |startDate | -|start_time |startTime |startTime | -|end_date |str |endDate | -|end_time |endTime |endTime | +|Name |Type|Description | +|------------------|----|-----------------| +|organization_type |str |organizationType |
-## `CallCenterReportScheduleRecurrence`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaExactPolicySelection`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-A recurring schedule for call center enhanced reporting scheduled report. +Criteria for searching for a particular Voice VPN policy selection. **Attributes:** -|Name |Type |Description | -|--------------|-------------|-------------| -|time_zone |str |timeZone | -|start_date |str |startDate | -|schedule_time |scheduleTime |scheduleTime | -|recurrence |recurrence |recurrence | +|Name |Type|Description | +|-----------------|----|----------------| +|policy_selection |str |policySelection |
-## `CallCenterReportScheduleTime`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaExactPortNumber`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-A scheduled time for call center enhanced reporting scheduled report. +Criteria for searching for a port number. **Attributes:** -|Name |Type |Description | -|--------------|-------------|-------------| -|time_zone |str |timeZone | -|schedule_date |str |scheduleDate | -|schedule_time |scheduleTime |scheduleTime | +|Name |Type|Description| +|-----|----|-----------| +|port |int |port |
-## `CallMeNowToDnCriteriaModify`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaExactScheduleLevel`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The To dn criteria used on the call me now external number to be modified. +Criteria for searching for a particular schedule level. **Attributes:** -|Name |Type |Description | -|-------------------------|----------------|---------------------------------| -|to_dn_criteria_selection |str |toDnCriteriaSelection *Optional* | -|phone_number_list |phoneNumberList |phoneNumberList *Optional* | +|Name |Type|Description| +|------|----|-----------| +|level |str |level |
-## `CombinedAccessDeviceMultipleIdentityEndpointAdd`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaExactScheduleType`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Access device end point used in the context of add. +Criteria for searching for a particular schedule type. -The endpoint is identified by its linePort (public Identity) and possibly a private -Identity. Only Static Registration capable devices may have more than one contact -defined. Port numbers are only used by devices with static line ordering. In the -case an access device referenced by accessDevice does not exist, the device will be -added. The device attributes deviceType, protocol, netAddress, port, -outboundProxyServerNetAddress, stunServerNetAddress, macAddress, serialNumber, -description, physicalLocation, transportProtocol, useCustomUserNamePassword and -accessDeviceCredentials will be ignored if the access device already exists. **Attributes:** -|Name |Type |Description | -|----------------------------------|------------------------|-----------------------------------------| -|access_device |accessDevice |accessDevice | -|line_port |str |linePort | -|private_identity |str |privateIdentity *Optional* | -|contact |str |contact *Optional* | -|port_number |int |portNumber *Optional* | -|device_type |str |deviceType *Optional* | -|protocol |str |protocol *Optional* | -|net_address |str |netAddress *Optional* | -|port |int |port *Optional* | -|outbound_proxy_server_net_address |str |outboundProxyServerNetAddress *Optional* | -|stun_server_net_address |str |stunServerNetAddress *Optional* | -|mac_address |str |macAddress *Optional* | -|serial_number |str |serialNumber *Optional* | -|description |str |description *Optional* | -|physical_location |str |physicalLocation *Optional* | -|transport_protocol |str |transportProtocol *Optional* | -|use_custom_user_name_password |bool |useCustomUserNamePassword *Optional* | -|access_device_credentials |accessDeviceCredentials |accessDeviceCredentials *Optional* | +|Name |Type|Description| +|-----|----|-----------| +|type |str |type |
-## `CombinedAccessDeviceMultipleIdentityEndpointModify`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaExactServiceProvider`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Access device end point used in the context of modify. +Criteria for searching for a particular fully specified service provider. -The endpoint is identified by its linePort (public Identity) and possibly a private -Identity. Only Static Registration capable devices may have more than one contact -defined. Port numbers are only used by devices with static line ordering. In the -case an access device referenced by accessDevice does not exist, the device will be -added. When the device needs to be added, if the linePort is not specified, the -request will fail The device attributes deviceType, protocol, netAddress, port, -outboundProxyServerNetAddress, stunServerNetAddress, macAddress, serialNumber, -description, physicalLocation, transportProtocol, useCustomUserNamePassword and -accessDeviceCredentials will be ignored if the access device already exists. **Attributes:** -|Name |Type |Description | -|----------------------------------|------------------------|-----------------------------------------| -|access_device |accessDevice |accessDevice *Optional* | -|line_port |str |linePort *Optional* | -|private_identity |str |privateIdentity *Optional* | -|contact |str |contact *Optional* | -|port_number |int |portNumber *Optional* | -|device_type |str |deviceType *Optional* | -|protocol |str |protocol *Optional* | -|net_address |str |netAddress *Optional* | -|port |int |port *Optional* | -|outbound_proxy_server_net_address |str |outboundProxyServerNetAddress *Optional* | -|stun_server_net_address |str |stunServerNetAddress *Optional* | -|mac_address |str |macAddress *Optional* | -|serial_number |str |serialNumber *Optional* | -|description |str |description *Optional* | -|physical_location |str |physicalLocation *Optional* | -|transport_protocol |str |transportProtocol *Optional* | -|use_custom_user_name_password |bool |useCustomUserNamePassword *Optional* | -|access_device_credentials |accessDeviceCredentials |accessDeviceCredentials *Optional* | +|Name |Type|Description | +|--------------------|----|------------------| +|service_provider_id |str |serviceProviderId |
-## `CombinedGroupServiceAuthorization`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaExactServiceProviderAdminType`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Authorize a group service. +Criteria for searching for a particular service provider administrator type. **Attributes:** -|Name |Type |Description | -|--------------------|-------------------|------------------------------| -|service_name |str |serviceName | -|authorized_quantity |authorizedQuantity |authorizedQuantity *Optional* | +|Name |Type|Description| +|-----|----|-----------| +|type |str |type |
-## `CombinedServiceInstanceAddProfile`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaExactServiceType`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Service Profile Information for group service. +Criteria for searching for a particular fully specified service type. -When name, callingLineIdLastName and callingLineIdFirstName are not included, the -values in the corresponding service instance template (if this is used to add a Hunt -Group, for example, the name will come from the Hunt Group template) will be used. -Otherwise, the request will fail. If the phoneNumber has not been assigned to the -group, it will be added to group and service provider if needed. **Attributes:** -|Name |Type |Description | -|-----------------------------|-----------|------------------------------------| -|name |str |name *Optional* | -|calling_line_id_last_name |str |callingLineIdLastName *Optional* | -|calling_line_id_first_name |str |callingLineIdFirstName *Optional* | -|hiragana_last_name |str |hiraganaLastName *Optional* | -|hiragana_first_name |str |hiraganaFirstName *Optional* | -|phone_number |str |phoneNumber *Optional* | -|extension |str |extension *Optional* | -|password |str |password *Optional* | -|department |department |department *Optional* | -|language |str |language *Optional* | -|time_zone |str |timeZone *Optional* | -|alias |List[str] |alias *Optional* | -|public_user_identity |str |publicUserIdentity *Optional* | -|calling_line_id_phone_number |str |callingLineIdPhoneNumber *Optional* | +|Name |Type|Description | +|-------------|----|------------| +|service_type |str |serviceType |
-## `CombinedServicePackAssignment`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaExactSignalingAddressType`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Assign a service pack to user. +Criteria for searching for a particular fully specified SignalingAddressType. -If the service pack has not been authorized to service provider or group, it will be -authorized. If the service pack needs to be authorized at group/service provider -levels, the authorizedQuantity will be used. Otherwise, it will be ignored. If the -authorizedQuantity is not included, the quantity will come from the group template for -the service pack. If a template does not exist, the service quantity will be set to -unlimited. **Attributes:** -|Name |Type |Description | -|--------------------|-------------------|------------------------------| -|service_pack_name |str |servicePackName | -|authorized_quantity |authorizedQuantity |authorizedQuantity *Optional* | +|Name |Type|Description| +|--------|----|-----------| +|profile |str |profile |
-## `CombinedServicePackAuthorization`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaExactSkillLevel`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Authorize a service pack. +Criteria for searching for a skill Level. **Attributes:** -|Name |Type |Description | -|--------------------|-------------------|------------------------------| -|service_pack_name |str |servicePackName | -|authorized_quantity |authorizedQuantity |authorizedQuantity *Optional* | +|Name |Type|Description| +|------------|----|-----------| +|skill_level |int |skillLevel |
-## `CombinedSharedCallAppearanceAccessDeviceMultipleIdentityEndpoint`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaExactUserDepartment`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Access device end point for Shared Call Appearance Service used in the context of add. +Criteria for searching for a particular fully specified user's department. -The endpoint is identified by its linePort (public Identity) and possibly a private -Identity. Port numbers are only used by devices with static line ordering. In the -case an access device referenced by accessDevice does not exist, the device will be -added. When elements for isActive, allowOrigination, allowTermination and allowVideo -are not included in the request, the values for them will come for the Shared Call -Appearance endpoints template. If the template does not exist, the request using this -data type will fail. The device attributes deviceType, protocol, netAddress, port, -outboundProxyServerNetAddress, stunServerNetAddress, macAddress, serialNumber, -description, physicalLocation, transportProtocol, useCustomUserNamePassword and -accessDeviceCredentials will be ignored if the access device already exists. **Attributes:** -|Name |Type |Description | -|----------------------------------|------------------------|-----------------------------------------| -|access_device |accessDevice |accessDevice | -|line_port |str |linePort | -|private_identity |str |privateIdentity *Optional* | -|contact |str |contact *Optional* | -|port_number |int |portNumber *Optional* | -|is_active |bool |isActive *Optional* | -|allow_origination |bool |allowOrigination *Optional* | -|allow_termination |bool |allowTermination *Optional* | -|allow_video |bool |allowVideo *Optional* | -|device_type |str |deviceType *Optional* | -|protocol |str |protocol *Optional* | -|net_address |str |netAddress *Optional* | -|port |int |port *Optional* | -|outbound_proxy_server_net_address |str |outboundProxyServerNetAddress *Optional* | -|stun_server_net_address |str |stunServerNetAddress *Optional* | -|mac_address |str |macAddress *Optional* | -|serial_number |str |serialNumber *Optional* | -|description |str |description *Optional* | -|physical_location |str |physicalLocation *Optional* | -|transport_protocol |str |transportProtocol *Optional* | -|use_custom_user_name_password |bool |useCustomUserNamePassword *Optional* | -|access_device_credentials |accessDeviceCredentials |accessDeviceCredentials *Optional* | +|Name |Type |Description | +|---------------|--------------|--------------| +|department_key |departmentKey |departmentKey |
-## `CombinedUserServiceAssignment`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaExactUserGroup`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Assign a service user. +Criteria for searching for a particular fully specified user's group. -If the service has not been authorized to service provider or group, it will be -authorized. If the service needs to be authorized at group/service provider levels, -the authorizedQuantity will be used. Otherwise, it will be ignored. If the -authorizedQuantity is not included, the quantity will come from the group template for -the service. If a template does not exist, the service quantity will be set to -unlimited. **Attributes:** -|Name |Type |Description | -|--------------------|-------------------|------------------------------| -|user_service |str |userService | -|authorized_quantity |authorizedQuantity |authorizedQuantity *Optional* | +|Name |Type|Description | +|--------------------|----|------------------| +|service_provider_id |str |serviceProviderId | +|group_id |str |groupId |
-## `CombinedUserServiceAuthorization`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaExactUserInTrunkGroup`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Authorize a user service. +Criteria for searching for user in/not in a trunk group. **Attributes:** -|Name |Type |Description | -|--------------------|-------------------|------------------------------| -|service_name |str |serviceName | -|authorized_quantity |authorizedQuantity |authorizedQuantity *Optional* | +|Name |Type |Description | +|--------------------|-----|-----------------| +|user_in_trunk_group |bool |userInTrunkGroup |
-## `CommPilotExpressAvailableInOffice`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaExactUserNetworkClassOfService`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-CommPilot Express Available In Office Settings. +Criteria for searching for users with a specified network class of service. **Attributes:** -|Name |Type |Description | -|--------------------------------|----------------|---------------------------------------| -|additional_phone_number_to_ring |str |additionalPhoneNumberToRing *Optional* | -|busy_setting |busySetting |busySetting | -|no_answer_setting |noAnswerSetting |noAnswerSetting | +|Name |Type|Description | +|-------------------------|----|----------------------| +|network_class_of_service |str |networkClassOfService |
-## `CommPilotExpressAvailableInOfficeModify`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaExactUserRouteListAssigned`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-CommPilot Express Available In Office Settings. +Criteria for searching for users with/without Route List feature assigned. **Attributes:** -|Name |Type |Description | -|--------------------------------|----------------|---------------------------------------| -|additional_phone_number_to_ring |str |additionalPhoneNumberToRing *Optional* | -|busy_setting |busySetting |busySetting *Optional* | -|no_answer_setting |noAnswerSetting |noAnswerSetting *Optional* | +|Name |Type |Description | +|--------------------|-----|------------------| +|route_list_assigned |bool |routeListAssigned |
-## `CommPilotExpressAvailableOutOfOffice`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaExactUserRouteListAssignment`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-CommPilot Express Available Out Of Office Configuration used in the context of a get. +Criteria for searching for users with Route List feature assignment. **Attributes:** -|Name |Type |Description | -|---------------------|-------------------|-------------------| -|incoming_calls |incomingCalls |incomingCalls | -|incoming_call_notify |incomingCallNotify |incomingCallNotify | +|Name |Type |Description| +|---------|-----|-----------| +|assigned |bool |assigned |
-## `CommPilotExpressAvailableOutOfOfficeModify`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaExactUserType`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-CommPilot Express Available Out Of Office Configuration used in the context of a -modify. +Criteria for searching for a particular User Type. **Attributes:** -|Name |Type |Description | -|---------------------|-------------------|------------------------------| -|incoming_calls |incomingCalls |incomingCalls *Optional* | -|incoming_call_notify |incomingCallNotify |incomingCallNotify *Optional* | +|Name |Type|Description| +|----------|----|-----------| +|user_type |str |userType |
-## `CommPilotExpressBusy`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaExactVirtualOnNetCallTypeName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-CommPilot Express Available In Office Configuration used in the context of a get. +Criteria for searching for a particular fully specified Virtual On-Net Call Type Name. **Attributes:** -|Name |Type |Description | -|------------------|----------------|----------------| -|incoming_calls |incomingCalls |incomingCalls | -|voice_mail_notify |voiceMailNotify |voiceMailNotify | +|Name |Type|Description | +|------------------------------|----|-------------------------| +|virtual_on_net_call_type_name |str |virtualOnNetCallTypeName |
-## `CommPilotExpressBusyModify`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaExtension`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-CommPilot Express Available In Office Configuration used in the context of a modify. +Criteria for searching for an extension. **Attributes:** -|Name |Type |Description | -|------------------|----------------|---------------------------| -|incoming_calls |incomingCalls |incomingCalls *Optional* | -|voice_mail_notify |voiceMailNotify |voiceMailNotify *Optional* | +|Name |Type |Description | +|--------------------|-----|------------------| +|mode |str |mode | +|value |str |value | +|is_case_insensitive |bool |isCaseInsensitive |
-## `CommPilotExpressUnavailable`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaForwardedToNumber`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-CommPilot Express Unavailable Configuration used in the context of a get. +Criteria for searching for a forwarded to number. +This search criteria data type is only intended to be used by the commands introduced +by BW-2301. The commands are `EnterpriseUserCallForwardingSettingsGetListRequest()` +and `GroupUserCallForwardingSettingsGetListRequest()`. The following Call Forwarding +services are compatible for this search: Call Forwarding Always, Call Forwarding +Always Secondary, Call Forwarding Busy, Call Forwarding No Answer, Call Forwarding Not +Reachable, Call Forwarding Selective. **Attributes:** -|Name |Type |Description | -|--------------------|--------------|------------------| -|incoming_calls |incomingCalls |incomingCalls | -|voice_mail_greeting |str |voiceMailGreeting | +|Name |Type |Description | +|--------------------|-----|------------------| +|mode |str |mode | +|value |str |value | +|is_case_insensitive |bool |isCaseInsensitive |
-## `CommPilotExpressUnavailableModify`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaGroupCommonMultiPartPhoneListName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-CommPilot Express Unavailable Configuration used in the context of a modify. +Criteria for searching for a multi-value name in a group common phone list. +Note: For this search criterion, the searchMode is always ‘Contains’ and the multi- +part search criteria are always AND’ed. **Attributes:** -|Name |Type |Description | -|--------------------|--------------|-----------------------------| -|incoming_calls |incomingCalls |incomingCalls *Optional* | -|voice_mail_greeting |str |voiceMailGreeting *Optional* | +|Name |Type |Description | +|--------------------|----------|------------------| +|value |List[str] |value | +|is_case_insensitive |bool |isCaseInsensitive |
-## `ConsolidatedAccessDeviceMultipleIdentityEndpointAndContactAdd`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaGroupCommonPhoneListName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Access device end point used in the context of add. +Criteria for searching for a name in a group common phone list. -The endpoint is identified by its linePort (public Identity) and possibly a private -Identity. In XS data mode, only one contact can be defined. Only Static Registration -capable devices may have more than one contact defined. Port numbers are only used by -devices with static line ordering. In the case an access device referenced by -accessDevice does not exist, the device will be added. The device attributes -deviceType, protocol, netAddress, port, outboundProxyServerNetAddress, -stunServerNetAddress, macAddress, serialNumber, description, physicalLocation, -transportProtocol, useCustomUserNamePassword and accessDeviceCredentials will be -ignored if the access device already exists. **Attributes:** -|Name |Type |Description | -|----------------------------------|------------------------|-----------------------------------------| -|access_device |accessDevice |accessDevice | -|line_port |str |linePort | -|private_identity |str |privateIdentity *Optional* | -|contact |List[str] |contact *Optional* | -|port_number |int |portNumber *Optional* | -|device_type |str |deviceType *Optional* | -|protocol |str |protocol *Optional* | -|net_address |str |netAddress *Optional* | -|port |int |port *Optional* | -|outbound_proxy_server_net_address |str |outboundProxyServerNetAddress *Optional* | -|stun_server_net_address |str |stunServerNetAddress *Optional* | -|mac_address |str |macAddress *Optional* | -|serial_number |str |serialNumber *Optional* | -|description |str |description *Optional* | -|physical_location |str |physicalLocation *Optional* | -|transport_protocol |str |transportProtocol *Optional* | -|use_custom_user_name_password |bool |useCustomUserNamePassword *Optional* | -|access_device_credentials |accessDeviceCredentials |accessDeviceCredentials *Optional* | +|Name |Type |Description | +|--------------------|-----|------------------| +|mode |str |mode | +|value |str |value | +|is_case_insensitive |bool |isCaseInsensitive |
-## `ConsolidatedAccessDeviceMultipleIdentityEndpointAndContactAdd22`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaGroupCommonPhoneListNumber`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Access device end point used in the context of add. +Criteria for searching for a phone number in a group common phone list. -The endpoint is identified by its linePort (public Identity) and possibly a private -Identity. In XS data mode, only one contact can be defined. Only Static Registration -capable devices may have more than one contact defined. Port numbers are only used by -devices with static line ordering. In the case an access device referenced by -accessDevice does not exist, the device will be added. The device attributes -deviceType, protocol, netAddress, port, outboundProxyServerNetAddress, -stunServerNetAddress, macAddress, serialNumber, description, physicalLocation, -transportProtocol, useCustomUserNamePassword and accessDeviceCredentials will be -ignored if the access device already exists. The following elements are only used in -AS data mode and ignored in XS data mode: useHotline, use value false in XS data mode -hotlineContact **Attributes:** -|Name |Type |Description | -|----------------------------------|------------------------|-----------------------------------------| -|access_device |accessDevice |accessDevice | -|line_port |str |linePort | -|private_identity |str |privateIdentity *Optional* | -|contact |List[str] |contact *Optional* | -|port_number |int |portNumber *Optional* | -|device_type |str |deviceType *Optional* | -|protocol |str |protocol *Optional* | -|net_address |str |netAddress *Optional* | -|port |int |port *Optional* | -|outbound_proxy_server_net_address |str |outboundProxyServerNetAddress *Optional* | -|stun_server_net_address |str |stunServerNetAddress *Optional* | -|mac_address |str |macAddress *Optional* | -|serial_number |str |serialNumber *Optional* | -|description |str |description *Optional* | -|physical_location |str |physicalLocation *Optional* | -|transport_protocol |str |transportProtocol *Optional* | -|use_custom_user_name_password |bool |useCustomUserNamePassword *Optional* | -|access_device_credentials |accessDeviceCredentials |accessDeviceCredentials *Optional* | -|use_hotline |bool |useHotline | -|hotline_contact |str |hotlineContact *Optional* | +|Name |Type |Description | +|--------------------|-----|------------------| +|mode |str |mode | +|value |str |value | +|is_case_insensitive |bool |isCaseInsensitive |
-## `ConsolidatedAccessDeviceMultipleIdentityEndpointAndContactModify`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaGroupExternalId`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Access device end point used in the context of modify. +Criteria for searching by a group's externalId. -. The endpoint is identified by its linePort (public Identity) and possibly a private -Identity. Only Static Registration capable devices may have more than one contact -defined. Only the first contact in contactList is used in XS data mode. Port numbers -are only used by devices with static line ordering. In the case an access device -referenced by accessDevice does not exist, the device will be added. When the device -needs to be added, if the linePort is not specified, the request will fail If the -deviceType is included in the request a new device will be created using the type -unless a device with the same name already exists. The device attributes protocol, -netAddress, port, outboundProxyServerNetAddress, stunServerNetAddress, macAddress, -serialNumber, description, physicalLocation, transportProtocol, -useCustomUserNamePassword and accessDeviceCredentials will be ignored if the access -device already exists. The following elements are only used in AS data mode and -ignored in XS data mode: useHotline hotlineContact **Attributes:** -|Name |Type |Description | -|----------------------------------|------------------------|-----------------------------------------| -|access_device |accessDevice |accessDevice *Optional* | -|line_port |str |linePort *Optional* | -|private_identity |str |privateIdentity *Optional* | -|contact_list |contactList |contactList *Optional* | -|port_number |int |portNumber *Optional* | -|device_type |str |deviceType *Optional* | -|protocol |str |protocol *Optional* | -|net_address |str |netAddress *Optional* | -|port |int |port *Optional* | -|outbound_proxy_server_net_address |str |outboundProxyServerNetAddress *Optional* | -|stun_server_net_address |str |stunServerNetAddress *Optional* | -|mac_address |str |macAddress *Optional* | -|serial_number |str |serialNumber *Optional* | -|description |str |description *Optional* | -|physical_location |str |physicalLocation *Optional* | -|transport_protocol |str |transportProtocol *Optional* | -|use_custom_user_name_password |bool |useCustomUserNamePassword *Optional* | -|access_device_credentials |accessDeviceCredentials |accessDeviceCredentials *Optional* | -|use_hotline |bool |useHotline *Optional* | -|hotline_contact |str |hotlineContact *Optional* | +|Name |Type|Description| +|------|----|-----------| +|mode |str |mode | +|value |str |value |
-## `ConsolidatedGroupServiceAssignment`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaGroupId`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Authorize and assign a group service. +Criteria for searching for a group ID. -The authorizedQuantity will be used at the group level if provided; otherwise, the -service quantity will be set to unlimited. The command will fail if the authorized -quantity set at the service provider level is insufficient. **Attributes:** -|Name |Type |Description | -|--------------------|-------------------|------------------------------| -|group_service_name |str |groupServiceName | -|authorized_quantity |authorizedQuantity |authorizedQuantity *Optional* | +|Name |Type |Description | +|--------------------|-----|------------------| +|mode |str |mode | +|value |str |value | +|is_case_insensitive |bool |isCaseInsensitive |
-## `ConsolidatedServicePackAssignment`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaGroupLocationCode`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Assign a service pack to user. +Criteria for searching for a group location dialing code. -If the service pack has not been authorized to the group, it will be authorized. The -authorizedQuantity will be used at the group level if provided; otherwise, the service -quantity will be set to unlimited. The command will fail if the authorized quantity -set at the service provider level is insufficient. **Attributes:** -|Name |Type |Description | -|--------------------|-------------------|------------------------------| -|service_pack_name |str |servicePackName | -|authorized_quantity |authorizedQuantity |authorizedQuantity *Optional* | +|Name |Type |Description | +|--------------------|-----|------------------| +|mode |str |mode | +|value |str |value | +|is_case_insensitive |bool |isCaseInsensitive |
-## `ConsolidatedSharedCallAppearanceAccessDeviceMultipleIdentityEndpoint`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaGroupName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Access device end point for Shared Call Appearance Service used in the context of add. +Criteria for searching for a group name. -The endpoint is identified by its linePort (public Identity) and possibly a private -Identity. Port numbers are only used by devices with static line ordering. In the -case an access device referenced by accessDevice does not exist, the device will be -added. The device attributes deviceType, protocol, netAddress, port, -outboundProxyServerNetAddress, stunServerNetAddress, macAddress, serialNumber, -description, physicalLocation, transportProtocol, useCustomUserNamePassword and -accessDeviceCredentials will be ignored if the access device already exists. The -following elements are only used in XS data mode and ignored in AS data mode: -privateIdentity **Attributes:** -|Name |Type |Description | -|----------------------------------|------------------------|-----------------------------------------| -|access_device |accessDevice |accessDevice | -|line_port |str |linePort | -|private_identity |str |privateIdentity *Optional* | -|contact |str |contact *Optional* | -|port_number |int |portNumber *Optional* | -|is_active |bool |isActive | -|allow_origination |bool |allowOrigination | -|allow_termination |bool |allowTermination | -|device_type |str |deviceType *Optional* | -|protocol |str |protocol *Optional* | -|net_address |str |netAddress *Optional* | -|port |int |port *Optional* | -|outbound_proxy_server_net_address |str |outboundProxyServerNetAddress *Optional* | -|stun_server_net_address |str |stunServerNetAddress *Optional* | -|mac_address |str |macAddress *Optional* | -|serial_number |str |serialNumber *Optional* | -|description |str |description *Optional* | -|physical_location |str |physicalLocation *Optional* | -|transport_protocol |str |transportProtocol *Optional* | -|use_custom_user_name_password |bool |useCustomUserNamePassword *Optional* | -|access_device_credentials |accessDeviceCredentials |accessDeviceCredentials *Optional* | -|use_hotline |bool |useHotline *Optional* | -|hotline_contact |str |hotlineContact *Optional* | +|Name |Type |Description | +|--------------------|-----|------------------| +|mode |str |mode | +|value |str |value | +|is_case_insensitive |bool |isCaseInsensitive |
-## `ConsolidatedSharedCallAppearanceAccessDeviceMultipleIdentityEndpointAdd22`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaHomeMscAddress`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Access device end point for Shared Call Appearance Service used in the context of add. +Criteria for searching for a system Home Network Msc Address. -The endpoint is identified by its linePort (public Identity) and possibly a private -Identity. Port numbers are only used by devices with static line ordering. In the -case an access device referenced by accessDevice does not exist, the device will be -added. The device attributes deviceType, protocol, netAddress, port, -outboundProxyServerNetAddress, stunServerNetAddress, macAddress, serialNumber, -description, physicalLocation, transportProtocol, useCustomUserNamePassword and -accessDeviceCredentials will be ignored if the access device already exists. The -following elements are only used in XS data mode and ignored in AS data mode: -privateIdentity The following elements are only used in AS data mode and ignored in XS -data mode: useHotline, use value false in XS data mode hotlineContact **Attributes:** -|Name |Type |Description | -|----------------------------------|------------------------|-----------------------------------------| -|access_device |accessDevice |accessDevice | -|line_port |str |linePort | -|private_identity |str |privateIdentity *Optional* | -|contact |str |contact *Optional* | -|port_number |int |portNumber *Optional* | -|is_active |bool |isActive | -|allow_origination |bool |allowOrigination | -|allow_termination |bool |allowTermination | -|device_type |str |deviceType *Optional* | -|protocol |str |protocol *Optional* | -|net_address |str |netAddress *Optional* | -|port |int |port *Optional* | -|outbound_proxy_server_net_address |str |outboundProxyServerNetAddress *Optional* | -|stun_server_net_address |str |stunServerNetAddress *Optional* | -|mac_address |str |macAddress *Optional* | -|serial_number |str |serialNumber *Optional* | -|description |str |description *Optional* | -|physical_location |str |physicalLocation *Optional* | -|transport_protocol |str |transportProtocol *Optional* | -|use_custom_user_name_password |bool |useCustomUserNamePassword *Optional* | -|access_device_credentials |accessDeviceCredentials |accessDeviceCredentials *Optional* | -|use_hotline |bool |useHotline | -|hotline_contact |str |hotlineContact *Optional* | +|Name |Type |Description | +|--------------------|-----|------------------| +|mode |str |mode | +|value |str |value | +|is_case_insensitive |bool |isCaseInsensitive |
-## `ConsolidatedUserServiceAssignment`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaIMRN`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Assign a user service. +Criteria for searching for an IMRN Number. -If the service has not been authorized to the group, it will be authorized. The -authorizedQuantity will be used at the group level if provided; otherwise, the service -quantity will be set to unlimited. The command will fail if the authorized quantity -set at the service provider level is insufficient. **Attributes:** -|Name |Type |Description | -|--------------------|-------------------|------------------------------| -|user_service_name |str |userServiceName | -|authorized_quantity |authorizedQuantity |authorizedQuantity *Optional* | +|Name |Type |Description | +|--------------------|-----|------------------| +|mode |str |mode | +|value |str |value | +|is_case_insensitive |bool |isCaseInsensitive |
-## `CriteriaFromDnModify`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaImpId`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The from dn criteria used within a modify request. +Criteria for searching for a user's IMP Id. **Attributes:** -|Name |Type |Description | -|----------------------------|----------------|-------------------------------------| -|from_dn_criteria_selection |str |fromDnCriteriaSelection *Optional* | -|include_anonymous_callers |bool |includeAnonymousCallers *Optional* | -|include_unavailable_callers |bool |includeUnavailableCallers *Optional* | -|phone_number_list |phoneNumberList |phoneNumberList *Optional* | +|Name |Type |Description | +|--------------------|-----|------------------| +|mode |str |mode | +|value |str |value | +|is_case_insensitive |bool |isCaseInsensitive |
-## `DeviceManagementDeviceTypeModifyOptions`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaLanguage`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Device Management System device type options during a modify request. +Criteria for searching for a language. **Attributes:** -|Name |Type |Description | -|---------------------------------------|------------------------|----------------------------------------------| -|device_access_protocol |str |deviceAccessProtocol *Optional* | -|tag_mode |str |tagMode *Optional* | -|tag_set |str |tagSet *Optional* | -|allow_device_profile_custom_tag_set |bool |allowDeviceProfileCustomTagSet *Optional* | -|allow_group_custom_tag_set |bool |allowGroupCustomTagSet *Optional* | -|send_email_upon_reset_failure |bool |sendEmailUponResetFailure *Optional* | -|device_access_net_address |str |deviceAccessNetAddress *Optional* | -|device_access_port |int |deviceAccessPort *Optional* | -|device_access_context |str |deviceAccessContext *Optional* | -|default_device_language |str |defaultDeviceLanguage *Optional* | -|default_device_encoding |str |defaultDeviceEncoding *Optional* | -|access_device_credentials |accessDeviceCredentials |accessDeviceCredentials *Optional* | -|use_http_digest_authentication |bool |useHttpDigestAuthentication *Optional* | -|mac_based_file_authentication |bool |macBasedFileAuthentication *Optional* | -|user_name_password_file_authentication |bool |userNamePasswordFileAuthentication *Optional* | -|mac_in_non_request_uri |bool |macInNonRequestURI *Optional* | -|mac_format_in_non_request_uri |str |macFormatInNonRequestURI *Optional* | +|Name |Type |Description | +|--------------------|-----|------------------| +|mode |str |mode | +|value |str |value | +|is_case_insensitive |bool |isCaseInsensitive |
-## `DeviceManagementDeviceTypeModifyOptions16`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaLinePortDomain`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Device Management System device type options during a modify request. +Criteria for searching for device line/port, or SIPURI domain part. **Attributes:** -|Name |Type |Description | -|---------------------------------------|------------------------|----------------------------------------------| -|device_access_protocol |str |deviceAccessProtocol *Optional* | -|tag_mode |str |tagMode *Optional* | -|tag_set |str |tagSet *Optional* | -|allow_device_profile_custom_tag_set |bool |allowDeviceProfileCustomTagSet *Optional* | -|allow_group_custom_tag_set |bool |allowGroupCustomTagSet *Optional* | -|allow_sp_custom_tag_set |bool |allowSpCustomTagSet *Optional* | -|send_email_upon_reset_failure |bool |sendEmailUponResetFailure *Optional* | -|device_access_net_address |str |deviceAccessNetAddress *Optional* | -|device_access_port |int |deviceAccessPort *Optional* | -|device_access_context |str |deviceAccessContext *Optional* | -|default_device_language |str |defaultDeviceLanguage *Optional* | -|default_device_encoding |str |defaultDeviceEncoding *Optional* | -|access_device_credentials |accessDeviceCredentials |accessDeviceCredentials *Optional* | -|use_http_digest_authentication |bool |useHttpDigestAuthentication *Optional* | -|mac_based_file_authentication |bool |macBasedFileAuthentication *Optional* | -|user_name_password_file_authentication |bool |userNamePasswordFileAuthentication *Optional* | -|mac_in_non_request_uri |bool |macInNonRequestURI *Optional* | -|mac_in_cert |bool |macInCert *Optional* | -|mac_format_in_non_request_uri |str |macFormatInNonRequestURI *Optional* | +|Name |Type |Description | +|--------------------|-----|------------------| +|mode |str |mode | +|value |str |value | +|is_case_insensitive |bool |isCaseInsensitive |
-## `DeviceManagementDeviceTypeModifyOptions22`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaLinePortUserPart`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Device Management System device type options during a modify request. +Criteria for searching for device line/port, or SIPURI user part. -The following data elements are only used in AS data mode and ignored in XS data mode: -enableDeviceActivation deviceModel **Attributes:** -|Name |Type |Description | -|---------------------------------------|------------------------|----------------------------------------------| -|device_access_protocol |str |deviceAccessProtocol *Optional* | -|tag_mode |str |tagMode *Optional* | -|tag_set |str |tagSet *Optional* | -|allow_device_profile_custom_tag_set |bool |allowDeviceProfileCustomTagSet *Optional* | -|allow_group_custom_tag_set |bool |allowGroupCustomTagSet *Optional* | -|allow_sp_custom_tag_set |bool |allowSpCustomTagSet *Optional* | -|send_email_upon_reset_failure |bool |sendEmailUponResetFailure *Optional* | -|device_access_net_address |str |deviceAccessNetAddress *Optional* | -|device_access_port |int |deviceAccessPort *Optional* | -|device_access_context |str |deviceAccessContext *Optional* | -|default_device_language |str |defaultDeviceLanguage *Optional* | -|default_device_encoding |str |defaultDeviceEncoding *Optional* | -|access_device_credentials |accessDeviceCredentials |accessDeviceCredentials *Optional* | -|use_http_digest_authentication |bool |useHttpDigestAuthentication *Optional* | -|mac_based_file_authentication |bool |macBasedFileAuthentication *Optional* | -|user_name_password_file_authentication |bool |userNamePasswordFileAuthentication *Optional* | -|mac_in_non_request_uri |bool |macInNonRequestURI *Optional* | -|mac_in_cert |bool |macInCert *Optional* | -|mac_format_in_non_request_uri |str |macFormatInNonRequestURI *Optional* | -|enable_device_activation |bool |enableDeviceActivation *Optional* | -|device_model |str |deviceModel *Optional* | +|Name |Type |Description | +|--------------------|-----|------------------| +|mode |str |mode | +|value |str |value | +|is_case_insensitive |bool |isCaseInsensitive |
-## `DeviceManagementDeviceTypeOptions`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaLocation`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Device Management System device type options. +Criteria for searching for a Location. **Attributes:** -|Name |Type |Description | -|---------------------------------------|------------------------|------------------------------------| -|device_access_protocol |str |deviceAccessProtocol | -|tag_mode |str |tagMode | -|tag_set |str |tagSet *Optional* | -|allow_device_profile_custom_tag_set |bool |allowDeviceProfileCustomTagSet | -|allow_group_custom_tag_set |bool |allowGroupCustomTagSet | -|send_email_upon_reset_failure |bool |sendEmailUponResetFailure | -|device_access_net_address |str |deviceAccessNetAddress *Optional* | -|device_access_port |int |deviceAccessPort *Optional* | -|device_access_context |str |deviceAccessContext *Optional* | -|device_access_uri |str |deviceAccessURI *Optional* | -|default_device_language |str |defaultDeviceLanguage *Optional* | -|default_device_encoding |str |defaultDeviceEncoding *Optional* | -|access_device_credentials |accessDeviceCredentials |accessDeviceCredentials *Optional* | -|use_http_digest_authentication |bool |useHttpDigestAuthentication | -|mac_based_file_authentication |bool |macBasedFileAuthentication | -|user_name_password_file_authentication |bool |userNamePasswordFileAuthentication | -|mac_in_non_request_uri |bool |macInNonRequestURI | -|mac_format_in_non_request_uri |str |macFormatInNonRequestURI *Optional* | +|Name |Type |Description | +|--------------------|-----|------------------| +|mode |str |mode | +|value |str |value | +|is_case_insensitive |bool |isCaseInsensitive |
-## `DeviceManagementDeviceTypeOptions16`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaLoginId`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Device Management System device type options. +Criteria for searching for a Login Id. **Attributes:** -|Name |Type |Description | -|---------------------------------------|------------------------|------------------------------------| -|device_access_protocol |str |deviceAccessProtocol | -|tag_mode |str |tagMode | -|tag_set |str |tagSet *Optional* | -|allow_device_profile_custom_tag_set |bool |allowDeviceProfileCustomTagSet | -|allow_group_custom_tag_set |bool |allowGroupCustomTagSet | -|send_email_upon_reset_failure |bool |sendEmailUponResetFailure | -|device_access_net_address |str |deviceAccessNetAddress *Optional* | -|device_access_port |int |deviceAccessPort *Optional* | -|device_access_context |str |deviceAccessContext *Optional* | -|device_access_uri |str |deviceAccessURI *Optional* | -|default_device_language |str |defaultDeviceLanguage *Optional* | -|default_device_encoding |str |defaultDeviceEncoding *Optional* | -|access_device_credentials |accessDeviceCredentials |accessDeviceCredentials *Optional* | -|use_http_digest_authentication |bool |useHttpDigestAuthentication | -|mac_based_file_authentication |bool |macBasedFileAuthentication | -|user_name_password_file_authentication |bool |userNamePasswordFileAuthentication | -|mac_in_non_request_uri |bool |macInNonRequestURI | -|mac_format_in_non_request_uri |str |macFormatInNonRequestURI *Optional* | +|Name |Type |Description | +|--------------------|-----|------------------| +|mode |str |mode | +|value |str |value | +|is_case_insensitive |bool |isCaseInsensitive |
-## `DeviceManagementDeviceTypeOptions21sp1`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaMobilePhoneNumber`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Device Management System device type options. +Criteria for searching for a user's mobile phone number. -Note: For the elements listed below, when device configuration is set to -deviceManagement, those elements apply to the creation of the Polycom Phone Services -directory file only. For all other files, they are not used. Those elements are -instead configured on a per-file basis at the Device Type File level. When device -configuration is set to legacy, those elements apply to all configuration files. -useHttpDigestAuthentication macBasedFileAuthentication -userNamePasswordFileAuthentication macInNonRequestURI macInCert -macFormatInNonRequestURI **Attributes:** -|Name |Type |Description | -|---------------------------------------|------------------------|------------------------------------| -|device_access_protocol |str |deviceAccessProtocol | -|tag_mode |str |tagMode | -|tag_set |str |tagSet *Optional* | -|allow_device_profile_custom_tag_set |bool |allowDeviceProfileCustomTagSet | -|allow_group_custom_tag_set |bool |allowGroupCustomTagSet | -|send_email_upon_reset_failure |bool |sendEmailUponResetFailure | -|device_access_net_address |str |deviceAccessNetAddress *Optional* | -|device_access_port |int |deviceAccessPort *Optional* | -|device_access_context |str |deviceAccessContext *Optional* | -|device_access_uri |str |deviceAccessURI *Optional* | -|default_device_language |str |defaultDeviceLanguage *Optional* | -|default_device_encoding |str |defaultDeviceEncoding *Optional* | -|access_device_credentials |accessDeviceCredentials |accessDeviceCredentials *Optional* | -|use_http_digest_authentication |bool |useHttpDigestAuthentication | -|mac_based_file_authentication |bool |macBasedFileAuthentication | -|user_name_password_file_authentication |bool |userNamePasswordFileAuthentication | -|mac_in_non_request_uri |bool |macInNonRequestURI | -|mac_in_cert |bool |macInCert | -|mac_format_in_non_request_uri |str |macFormatInNonRequestURI *Optional* | +|Name |Type |Description | +|--------------------|-----|------------------| +|mode |str |mode | +|value |str |value | +|is_case_insensitive |bool |isCaseInsensitive |
-## `DeviceManagementDeviceTypeOptions22`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaMobileSubscriberDirectoryNumber`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Device Management System device type options. +Criteria for searching for a BroadWorks Mobility Mobile Subscriber Directory Number. -Note: For the elements listed below, when device configuration is set to -deviceManagement, those elements apply to the creation of the Polycom Phone Services -directory file only. For all other files, they are not used. Those elements are -instead configured on a per-file basis at the Device Type File level. When device -configuration is set to legacy, those elements apply to all configuration files. -useHttpDigestAuthentication macBasedFileAuthentication -userNamePasswordFileAuthentication macInNonRequestURI macInCert -macFormatInNonRequestURI **Attributes:** -|Name |Type |Description | -|---------------------------------------|------------------------|------------------------------------| -|device_access_protocol |str |deviceAccessProtocol | -|tag_mode |str |tagMode | -|tag_set |str |tagSet *Optional* | -|allow_device_profile_custom_tag_set |bool |allowDeviceProfileCustomTagSet | -|allow_group_custom_tag_set |bool |allowGroupCustomTagSet | -|allow_sp_custom_tag_set |bool |allowSpCustomTagSet | -|send_email_upon_reset_failure |bool |sendEmailUponResetFailure | -|device_access_net_address |str |deviceAccessNetAddress *Optional* | -|device_access_port |int |deviceAccessPort *Optional* | -|device_access_context |str |deviceAccessContext *Optional* | -|device_access_uri |str |deviceAccessURI *Optional* | -|default_device_language |str |defaultDeviceLanguage *Optional* | -|default_device_encoding |str |defaultDeviceEncoding *Optional* | -|access_device_credentials |accessDeviceCredentials |accessDeviceCredentials *Optional* | -|use_http_digest_authentication |bool |useHttpDigestAuthentication | -|mac_based_file_authentication |bool |macBasedFileAuthentication | -|user_name_password_file_authentication |bool |userNamePasswordFileAuthentication | -|mac_in_non_request_uri |bool |macInNonRequestURI | -|mac_in_cert |bool |macInCert | -|mac_format_in_non_request_uri |str |macFormatInNonRequestURI *Optional* | +|Name |Type |Description | +|--------------------|-----|------------------| +|mode |str |mode | +|value |str |value | +|is_case_insensitive |bool |isCaseInsensitive |
-## `DeviceManagementDeviceTypeOptions22V2`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaMultiPartUserName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Device Management System device type options. +Criteria for searching for a user's full name. -Note: For the elements listed below, when device configuration is set to -deviceManagement, those elements apply to the creation of the Polycom Phone Services -directory file only. For all other files, they are not used. Those elements are -instead configured on a per-file basis at the Device Type File level. When device -configuration is set to legacy, those elements apply to all configuration files. -useHttpDigestAuthentication macBasedFileAuthentication -userNamePasswordFileAuthentication macInNonRequestURI macInCert -macFormatInNonRequestURI +This search criterion will be compared against multiple combinations of first name and +last name: First Name + ‘ ‘ + Last Name Last Name + ‘ ‘ + First Name Last Name + ‘, ‘ ++ First Name Hiragana Last Name + Hiragana First Name Note that when specific +conditions are met, VON users will be included in the search results. Note: For this +search criterion, the searchMode is always ‘Contains’ and the multi-part search +criteria are always AND’ed. **Attributes:** -|Name |Type |Description | -|---------------------------------------|------------------------|------------------------------------| -|device_access_protocol |str |deviceAccessProtocol | -|tag_mode |str |tagMode | -|tag_set |str |tagSet *Optional* | -|allow_device_profile_custom_tag_set |bool |allowDeviceProfileCustomTagSet | -|allow_group_custom_tag_set |bool |allowGroupCustomTagSet | -|allow_sp_custom_tag_set |bool |allowSpCustomTagSet | -|send_email_upon_reset_failure |bool |sendEmailUponResetFailure | -|device_access_net_address |str |deviceAccessNetAddress *Optional* | -|device_access_port |int |deviceAccessPort *Optional* | -|device_access_context |str |deviceAccessContext *Optional* | -|device_access_uri |str |deviceAccessURI *Optional* | -|default_device_language |str |defaultDeviceLanguage *Optional* | -|default_device_encoding |str |defaultDeviceEncoding *Optional* | -|access_device_credentials |accessDeviceCredentials |accessDeviceCredentials *Optional* | -|use_http_digest_authentication |bool |useHttpDigestAuthentication | -|mac_based_file_authentication |bool |macBasedFileAuthentication | -|user_name_password_file_authentication |bool |userNamePasswordFileAuthentication | -|mac_in_non_request_uri |bool |macInNonRequestURI | -|mac_in_cert |bool |macInCert | -|mac_format_in_non_request_uri |str |macFormatInNonRequestURI *Optional* | +|Name |Type |Description | +|--------------------|----------|------------------| +|value |List[str] |value | +|is_case_insensitive |bool |isCaseInsensitive |
-## `DeviceManagementDeviceTypeOptions22V3`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaNetworkClassOfServiceName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Device Management System device type options. +Criteria for searching for a Network Class of Service name. -Note: For the elements listed below, when device configuration is set to -deviceManagement, those elements apply to the creation of the Polycom Phone Services -directory file only. For all other files, they are not used. Those elements are -instead configured on a per-file basis at the Device Type File level. When device -configuration is set to legacy, those elements apply to all configuration files. -useHttpDigestAuthentication macBasedFileAuthentication -userNamePasswordFileAuthentication macInNonRequestURI macInCert -macFormatInNonRequestURI The following data elements are only used in AS data mode and -ignored in XS data mode: enableDeviceActivation deviceModel **Attributes:** -|Name |Type |Description | -|---------------------------------------|------------------------|------------------------------------| -|device_access_protocol |str |deviceAccessProtocol | -|tag_mode |str |tagMode | -|tag_set |str |tagSet *Optional* | -|allow_device_profile_custom_tag_set |bool |allowDeviceProfileCustomTagSet | -|allow_group_custom_tag_set |bool |allowGroupCustomTagSet | -|allow_sp_custom_tag_set |bool |allowSpCustomTagSet | -|send_email_upon_reset_failure |bool |sendEmailUponResetFailure | -|device_access_net_address |str |deviceAccessNetAddress *Optional* | -|device_access_port |int |deviceAccessPort *Optional* | -|device_access_context |str |deviceAccessContext *Optional* | -|device_access_uri |str |deviceAccessURI *Optional* | -|default_device_language |str |defaultDeviceLanguage *Optional* | -|default_device_encoding |str |defaultDeviceEncoding *Optional* | -|access_device_credentials |accessDeviceCredentials |accessDeviceCredentials *Optional* | -|use_http_digest_authentication |bool |useHttpDigestAuthentication | -|mac_based_file_authentication |bool |macBasedFileAuthentication | -|user_name_password_file_authentication |bool |userNamePasswordFileAuthentication | -|mac_in_non_request_uri |bool |macInNonRequestURI | -|mac_in_cert |bool |macInCert | -|mac_format_in_non_request_uri |str |macFormatInNonRequestURI *Optional* | -|enable_device_activation |bool |enableDeviceActivation | -|device_model |str |deviceModel *Optional* | +|Name |Type |Description | +|--------------------|-----|------------------| +|mode |str |mode | +|value |str |value | +|is_case_insensitive |bool |isCaseInsensitive |
-## `DeviceManagementDeviceTypeOptions22V4`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaNumberPortabilityQueryDigitPattern`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Device Management System device type options. +Criteria for searching for digit pattern. -Note: For the elements listed below, when device configuration is set to -deviceManagement, those elements apply to the creation of the Polycom Phone Services -directory file only. For all other files, they are not used. Those elements are -instead configured on a per-file basis at the Device Type File level. When device -configuration is set to legacy, those elements apply to all configuration files. -useHttpDigestAuthentication macBasedFileAuthentication -userNamePasswordFileAuthentication macInNonRequestURI macInCert -macFormatInNonRequestURI The following data elements are only used in AS data mode and -ignored in XS data mode: enableDeviceActivation deviceModel supportLinks **Attributes:** -|Name |Type |Description | -|---------------------------------------|------------------------|------------------------------------| -|device_access_protocol |str |deviceAccessProtocol | -|tag_mode |str |tagMode | -|tag_set |str |tagSet *Optional* | -|allow_device_profile_custom_tag_set |bool |allowDeviceProfileCustomTagSet | -|allow_group_custom_tag_set |bool |allowGroupCustomTagSet | -|allow_sp_custom_tag_set |bool |allowSpCustomTagSet | -|send_email_upon_reset_failure |bool |sendEmailUponResetFailure | -|device_access_net_address |str |deviceAccessNetAddress *Optional* | -|device_access_port |int |deviceAccessPort *Optional* | -|device_access_context |str |deviceAccessContext *Optional* | -|device_access_uri |str |deviceAccessURI *Optional* | -|default_device_language |str |defaultDeviceLanguage *Optional* | -|default_device_encoding |str |defaultDeviceEncoding *Optional* | -|access_device_credentials |accessDeviceCredentials |accessDeviceCredentials *Optional* | -|use_http_digest_authentication |bool |useHttpDigestAuthentication | -|mac_based_file_authentication |bool |macBasedFileAuthentication | -|user_name_password_file_authentication |bool |userNamePasswordFileAuthentication | -|mac_in_non_request_uri |bool |macInNonRequestURI | -|mac_in_cert |bool |macInCert | -|mac_format_in_non_request_uri |str |macFormatInNonRequestURI *Optional* | -|enable_device_activation |bool |enableDeviceActivation | -|device_model |str |deviceModel *Optional* | -|support_links |str |supportLinks | +|Name |Type |Description | +|--------------------|-----|------------------| +|mode |str |mode | +|value |str |value | +|is_case_insensitive |bool |isCaseInsensitive |
-## `EnhancedCallLogsNumberFilter`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaNumberPortabilityStatus`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Filter criteria based on the called number or number called. +Criteria for searching for number portability status. **Attributes:** -|Name |Type |Description | -|--------------------------------------------|----------------------------------------------|---------------------------------------------------| -|include_basic_call_type |List[str] |includeBasicCallType *Optional* | -|include_call_category |List[str] |includeCallCategory *Optional* | -|include_configurable_call_type |List[str] |includeConfigurableCallType *Optional* | -|search_criteria_dialed_number |List[searchCriteriaDialedNumber] |searchCriteriaDialedNumber *Optional* | -|search_criteria_called_number |List[searchCriteriaCalledNumber] |searchCriteriaCalledNumber *Optional* | -|search_criteria_network_translated_number |List[searchCriteriaNetworkTranslatedNumber] |searchCriteriaNetworkTranslatedNumber *Optional* | -|search_criteria_calling_presentation_number |List[searchCriteriaCallingPresentationNumber] |searchCriteriaCallingPresentationNumber *Optional* | +|Name |Type |Description | +|--------------------|-----|------------------| +|mode |str |mode | +|value |str |value | +|is_case_insensitive |bool |isCaseInsensitive |
-## `EnhancedCallLogsRedirectedNumberFilter`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaOutgoingDNorSIPURI`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Filter criteria based on the transferred/forwarded number. +Criteria for searching for a phone number or SIPURI. **Attributes:** -|Name |Type |Description | -|-------------------------------------------------------------|-------------------------------------------------------------|------------------------------------------------------------------| -|redirected_call |redirectedCall |redirectedCall *Optional* | -|include_service_invocation_basic_call_type |List[str] |includeServiceInvocationBasicCallType *Optional* | -|include_service_invocation_call_category |List[str] |includeServiceInvocationCallCategory *Optional* | -|include_service_invocation_configurable_call_type |List[str] |includeServiceInvocationConfigurableCallType *Optional* | -|search_criteria_service_invocation_dialed_number |List[searchCriteriaServiceInvocationDialedNumber] |searchCriteriaServiceInvocationDialedNumber *Optional* | -|search_criteria_service_invocation_called_number |List[searchCriteriaServiceInvocationCalledNumber] |searchCriteriaServiceInvocationCalledNumber *Optional* | -|search_criteria_service_invocation_network_translated_number |List[searchCriteriaServiceInvocationNetworkTranslatedNumber] |searchCriteriaServiceInvocationNetworkTranslatedNumber *Optional* | +|Name |Type |Description | +|--------------------|-----|------------------| +|mode |str |mode | +|value |str |value | +|is_case_insensitive |bool |isCaseInsensitive |
-## `EnhancedCallLogsRedirectedNumberFilter20sp1`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaPersonalAssistantExclusionNumber`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Filter criteria based on the transferred/forwarded number. +Criteria for searching for Personal Assistant Exclusion Number. **Attributes:** -|Name |Type |Description | -|-------------------------------------------------------------|-------------------------------------------------------------|------------------------------------------------------------------| -|redirected_call |redirectedCall |redirectedCall *Optional* | -|include_service_invocation_basic_call_type |List[str] |includeServiceInvocationBasicCallType *Optional* | -|include_service_invocation_call_category |List[str] |includeServiceInvocationCallCategory *Optional* | -|include_service_invocation_configurable_call_type |List[str] |includeServiceInvocationConfigurableCallType *Optional* | -|search_criteria_service_invocation_dialed_number |List[searchCriteriaServiceInvocationDialedNumber] |searchCriteriaServiceInvocationDialedNumber *Optional* | -|search_criteria_service_invocation_called_number |List[searchCriteriaServiceInvocationCalledNumber] |searchCriteriaServiceInvocationCalledNumber *Optional* | -|search_criteria_service_invocation_network_translated_number |List[searchCriteriaServiceInvocationNetworkTranslatedNumber] |searchCriteriaServiceInvocationNetworkTranslatedNumber *Optional* | +|Name |Type |Description | +|--------------------|-----|------------------| +|mode |str |mode | +|value |str |value | +|is_case_insensitive |bool |isCaseInsensitive |
-## `EnhancedCallLogsRedirectedNumberFilter21`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaPersonalAssistantExclusionNumberDescription`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Filter criteria based on the transferred/forwarded number. +Criteria for searching Personal Assistant Exclusion Number's Description. **Attributes:** -|Name |Type |Description | -|-------------------------------------------------------------|-------------------------------------------------------------|------------------------------------------------------------------| -|redirected_call |redirectedCall |redirectedCall *Optional* | -|include_service_invocation_basic_call_type |List[str] |includeServiceInvocationBasicCallType *Optional* | -|include_service_invocation_call_category |List[str] |includeServiceInvocationCallCategory *Optional* | -|include_service_invocation_configurable_call_type |List[str] |includeServiceInvocationConfigurableCallType *Optional* | -|search_criteria_service_invocation_dialed_number |List[searchCriteriaServiceInvocationDialedNumber] |searchCriteriaServiceInvocationDialedNumber *Optional* | -|search_criteria_service_invocation_called_number |List[searchCriteriaServiceInvocationCalledNumber] |searchCriteriaServiceInvocationCalledNumber *Optional* | -|search_criteria_service_invocation_network_translated_number |List[searchCriteriaServiceInvocationNetworkTranslatedNumber] |searchCriteriaServiceInvocationNetworkTranslatedNumber *Optional* | +|Name |Type |Description | +|--------------------|-----|------------------| +|mode |str |mode | +|value |str |value | +|is_case_insensitive |bool |isCaseInsensitive |
-## `EnhancedCallLogsRedirectedNumberFilter21sp1`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaPhysicalLocation`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Filter criteria based on the transferred/forwarded number. +Criteria for searching for a Physical Location. **Attributes:** -|Name |Type |Description | -|-------------------------------------------------------------|-------------------------------------------------------------|------------------------------------------------------------------| -|redirected_call |redirectedCall |redirectedCall *Optional* | -|include_service_invocation_basic_call_type |List[str] |includeServiceInvocationBasicCallType *Optional* | -|include_service_invocation_call_category |List[str] |includeServiceInvocationCallCategory *Optional* | -|include_service_invocation_configurable_call_type |List[str] |includeServiceInvocationConfigurableCallType *Optional* | -|search_criteria_service_invocation_dialed_number |List[searchCriteriaServiceInvocationDialedNumber] |searchCriteriaServiceInvocationDialedNumber *Optional* | -|search_criteria_service_invocation_called_number |List[searchCriteriaServiceInvocationCalledNumber] |searchCriteriaServiceInvocationCalledNumber *Optional* | -|search_criteria_service_invocation_network_translated_number |List[searchCriteriaServiceInvocationNetworkTranslatedNumber] |searchCriteriaServiceInvocationNetworkTranslatedNumber *Optional* | +|Name |Type |Description | +|--------------------|-----|------------------| +|mode |str |mode | +|value |str |value | +|is_case_insensitive |bool |isCaseInsensitive |
-## `EnhancedCallLogsRedirectedNumberFilter23`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaProfileServiceCode`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Filter criteria based on the transferred/forwarded number. +Criteria for searching for a Service Code. **Attributes:** -|Name |Type |Description | -|-------------------------------------------------------------|-------------------------------------------------------------|------------------------------------------------------------------| -|redirected_call |redirectedCall |redirectedCall *Optional* | -|include_service_invocation_basic_call_type |List[str] |includeServiceInvocationBasicCallType *Optional* | -|include_service_invocation_call_category |List[str] |includeServiceInvocationCallCategory *Optional* | -|include_service_invocation_configurable_call_type |List[str] |includeServiceInvocationConfigurableCallType *Optional* | -|search_criteria_service_invocation_dialed_number |List[searchCriteriaServiceInvocationDialedNumber] |searchCriteriaServiceInvocationDialedNumber *Optional* | -|search_criteria_service_invocation_called_number |List[searchCriteriaServiceInvocationCalledNumber] |searchCriteriaServiceInvocationCalledNumber *Optional* | -|search_criteria_service_invocation_network_translated_number |List[searchCriteriaServiceInvocationNetworkTranslatedNumber] |searchCriteriaServiceInvocationNetworkTranslatedNumber *Optional* | +|Name |Type |Description | +|--------------------|-----|------------------| +|mode |str |mode | +|value |str |value | +|is_case_insensitive |bool |isCaseInsensitive |
-## `EnterpriseAccessDevice`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaProfileServiceCodeDescription`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Uniquely identifies an access device accessible for an enterprise. +Criteria for searching for a Service Code description. -It could be a system level device, an enterprise level device or a group level device. **Attributes:** -|Name |Type |Description | -|--------------|-------------|-------------------| -|access_device |accessDevice |accessDevice | -|group_id |str |groupId *Optional* | +|Name |Type |Description | +|--------------------|-----|------------------| +|mode |str |mode | +|value |str |value | +|is_case_insensitive |bool |isCaseInsensitive |
-## `EnterpriseEnterpriseTrunkPriorityWeightedTrunkGroup`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaReceptionistNote`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Trunk group details (order and weight) for each trunk group +Criteria for searching for Receptionist Notes. + **Attributes:** -|Name |Type |Description| -|------------|-----------|-----------| -|trunk_group |trunkGroup |trunkGroup | -|priority |int |priority | -|weight |int |weight | +|Name |Type |Description | +|--------------------|-----|------------------| +|mode |str |mode | +|value |str |value | +|is_case_insensitive |bool |isCaseInsensitive |
-## `EnterpriseTrunkNumberPrefix22`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaRegistrationURI`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Enterprise Trunk Number Prefix +Criteria for searching for a RegistrationURI. + **Attributes:** -|Name |Type |Description | -|----------------|---------------|--------------------------| -|number_prefix |str |numberPrefix | -|extension_range |extensionRange |extensionRange *Optional* | +|Name |Type |Description | +|--------------------|-----|------------------| +|mode |str |mode | +|value |str |value | +|is_case_insensitive |bool |isCaseInsensitive |
-## `EnterpriseTrunkNumberPrefixModify`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaResellerId`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Enterprise Trunk Number Prefix for modify. +Criteria for searching for a reseller ID. **Attributes:** -|Name |Type |Description | -|----------------|---------------|--------------------------| -|number_prefix |str |numberPrefix | -|extension_range |extensionRange |extensionRange *Optional* | +|Name |Type |Description | +|--------------------|-----|------------------| +|mode |str |mode | +|value |str |value | +|is_case_insensitive |bool |isCaseInsensitive |
-## `EnterpriseTrunkNumberRange`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaResellerName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Directory number range. +Criteria for searching for a reseller name. -The minimum and maximum values are inclusive. **Attributes:** -|Name |Type |Description | -|-----------------|--------|---------------------------| -|dn_range |dnRange |dnRange | -|extension_length |int |extensionLength *Optional* | +|Name |Type |Description | +|--------------------|-----|------------------| +|mode |str |mode | +|value |str |value | +|is_case_insensitive |bool |isCaseInsensitive |
-## `EnterpriseTrunkPriorityWeightedTrunkGroup`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaRoamingMscAddress`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Trunk group details (order and weight) for each trunk group +Criteria for searching for a system Roaming Network Msc Address. + **Attributes:** -|Name |Type |Description| -|------------|-----------|-----------| -|trunk_group |trunkGroup |trunkGroup | -|priority |int |priority | -|weight |int |weight | +|Name |Type |Description | +|--------------------|-----|------------------| +|mode |str |mode | +|value |str |value | +|is_case_insensitive |bool |isCaseInsensitive |
-## `ExecutiveCallFilteringCriteriaFromDnModify`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaRoutePointName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The from dn criteria used within an executive call filtering criteria modify request. +Criteria for searching for a route point + +**Attributes:** + +|Name |Type |Description | +|--------------------|-----|------------------| +|mode |str |mode | +|value |str |value | +|is_case_insensitive |bool |isCaseInsensitive | +
+ + +## `SearchCriteriaSIPContact`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) + +
+Criteria for searching for a SIP Contact. **Attributes:** -|Name |Type |Description | -|----------------------------|----------------|-------------------------------------| -|from_dn_criteria_selection |str |fromDnCriteriaSelection *Optional* | -|include_anonymous_callers |bool |includeAnonymousCallers *Optional* | -|include_unavailable_callers |bool |includeUnavailableCallers *Optional* | -|phone_number_list |phoneNumberList |phoneNumberList *Optional* | +|Name |Type |Description | +|--------------------|-----|------------------| +|mode |str |mode | +|value |str |value | +|is_case_insensitive |bool |isCaseInsensitive |
-## `ExtendedFileResource`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaScheduleName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Represents either an existing file for the application server to use, or the contents -of a file to transfer and an URL. +Criteria for searching for a schedule name. **Attributes:** -|Name |Type |Description | -|-----|-----|----------------| -|file |file |file *Optional* | -|url |str |url *Optional* | +|Name |Type |Description | +|--------------------|-----|------------------| +|mode |str |mode | +|value |str |value | +|is_case_insensitive |bool |isCaseInsensitive |
-## `ExtendedMediaFileLevelResource20`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaServiceCode`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Represents either an existing file for the application server to use, or the contents -of a file to transfer and an URL. +Criteria for searching for a Service Code. **Attributes:** -|Name |Type |Description | -|-----|-----|----------------| -|file |file |file *Optional* | -|url |str |url *Optional* | +|Name |Type |Description | +|--------------------|-----|------------------| +|mode |str |mode | +|value |str |value | +|is_case_insensitive |bool |isCaseInsensitive |
-## `ExtendedMediaFileResource`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaServiceCodeDescription`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Represents either an existing file for the application server to use, or the contents -of a file to transfer and an URL. +Criteria for searching for a Service Code description. **Attributes:** -|Name |Type |Description | -|-----|-----|----------------| -|file |file |file *Optional* | -|url |str |url *Optional* | +|Name |Type |Description | +|--------------------|-----|------------------| +|mode |str |mode | +|value |str |value | +|is_case_insensitive |bool |isCaseInsensitive |
-## `ExtendedMediaFileResource20`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaServiceInstanceName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Represents either an existing file for the application server to use, or the contents -of a file to transfer and an URL. +Criteria for searching for a service instance name. **Attributes:** -|Name |Type |Description | -|-----|-----|----------------| -|file |file |file *Optional* | -|url |str |url *Optional* | +|Name |Type |Description | +|--------------------|-----|------------------| +|mode |str |mode | +|value |str |value | +|is_case_insensitive |bool |isCaseInsensitive |
-## `GroupServiceAuthorization`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaServiceProviderId`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Authorize (with quantity) or unauthorize a group service. +Criteria for searching for a service provider ID. **Attributes:** -|Name |Type |Description | -|--------------------|-------------------|------------------------------| -|service_name |str |serviceName | -|authorized_quantity |authorizedQuantity |authorizedQuantity *Optional* | -|unauthorized |bool |unauthorized *Optional* | +|Name |Type |Description | +|--------------------|-----|------------------| +|mode |str |mode | +|value |str |value | +|is_case_insensitive |bool |isCaseInsensitive |
-## `GroupServiceAuthorizationAndAssignment`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaServiceProviderName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Authorize (with quantity) a group service, and optionally assign the service. +Criteria for searching for a service provider name. **Attributes:** -|Name |Type |Description | -|--------------------|-------------------|------------------------------| -|service_name |str |serviceName | -|authorized_quantity |authorizedQuantity |authorizedQuantity *Optional* | -|assign |bool |assign *Optional* | +|Name |Type |Description | +|--------------------|-----|------------------| +|mode |str |mode | +|value |str |value | +|is_case_insensitive |bool |isCaseInsensitive |
-## `GroupSessionAdmissionControlGroupGetResponse21sp1V2`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaServiceProviderNumberPortabilityQueryDigitPattern`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Response to GroupSessionAdmissionControlGroupGetRequest21sp1V2. +Criteria for searching for digit pattern. -Returns the profile information for the session admission control group. **Attributes:** -|Name |Type |Description | -|---------------------------------------------------|--------------|-------------------------------------------| -|max_session |int |maxSession | -|max_user_originating_sessions |int |maxUserOriginatingSessions *Optional* | -|max_user_terminating_sessions |int |maxUserTerminatingSessions *Optional* | -|reserved_session |int |reservedSession | -|reserved_user_originating_sessions |int |reservedUserOriginatingSessions *Optional* | -|reserved_user_terminating_sessions |int |reservedUserTerminatingSessions *Optional* | -|default_group |bool |defaultGroup | -|count_intra_sac_group_sessions |bool |countIntraSACGroupSessions | -|devices |List[devices] |devices *Optional* | -|block_emergency_and_repair_calls_due_to_sac_limits |bool |blockEmergencyAndRepairCallsDueToSACLimits | -|media_group_name |str |mediaGroupName *Optional* | -|access_info_pattern |str |accessInfoPattern *Optional* | +|Name |Type |Description | +|--------------------|-----|------------------| +|mode |str |mode | +|value |str |value | +|is_case_insensitive |bool |isCaseInsensitive |
-## `GroupTrunkGroupGetInstanceRequest14sp9A`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaServiceStatus`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Get a Trunk Group Instance's profile. +Criteria for searching for services that are active or not. -The response is either a GroupTrunkGroupGetInstanceResponse14sp9A or an -`ErrorResponse()`. The response contains a hosted user table with column headings: -"User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name". +This search criteria data type is only intended to be used by the commands introduced +by BW-2301. The commands are `EnterpriseUserCallWaitingSettingsGetListRequest()` and +`GroupUserCallWaitingSettingsGetListRequest()`. **Attributes:** -|Name |Type |Description | -|----------------|--------------|--------------| -|trunk_group_key |trunkGroupKey |trunkGroupKey | +|Name |Type |Description| +|----------|-----|-----------| +|is_active |bool |isActive |
-## `GroupTrunkGroupGetInstanceRequest17sp4V2`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaSystemServiceDn`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Get a Trunk Group Instance's profile. +Criteria for searching for a system service DN. -The response is either a GroupTrunkGroupGetInstanceResponse17sp4V2 or an -`ErrorResponse()`. The response contains a hosted user table with column headings: -"User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name". -Replaced by: `GroupTrunkGroupGetInstanceRequest19V2()` **Attributes:** -|Name |Type |Description | -|----------------|--------------|--------------| -|trunk_group_key |trunkGroupKey |trunkGroupKey | +|Name |Type |Description | +|--------------------|-----|------------------| +|mode |str |mode | +|value |str |value | +|is_case_insensitive |bool |isCaseInsensitive |
-## `GroupTrunkGroupGetInstanceRequest19sp1V2`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaTitle`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Get a Trunk Group Instance's profile. +Criteria for searching for a user's title. -The response is either a GroupTrunkGroupGetInstanceResponse19sp1V2 or an -`ErrorResponse()`. The response contains a hosted user table with column headings: -"User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name", -"Phone Number", "Extension", "Department", "Email Address". Replaced by: -`GroupTrunkGroupGetInstanceRequest20sp1()` **Attributes:** -|Name |Type |Description | -|----------------|--------------|--------------| -|trunk_group_key |trunkGroupKey |trunkGroupKey | +|Name |Type |Description | +|--------------------|-----|------------------| +|mode |str |mode | +|value |str |value | +|is_case_insensitive |bool |isCaseInsensitive |
-## `GroupTrunkGroupGetInstanceResponse14sp9A`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaTrunkGroupName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Response to GroupTrunkGroupGetInstanceRequest14sp9A. +Criteria for searching for a trunk group + +**Attributes:** + +|Name |Type |Description | +|--------------------|-----|------------------| +|mode |str |mode | +|value |str |value | +|is_case_insensitive |bool |isCaseInsensitive | +
+ + +## `SearchCriteriaUserExternalId`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) + +
+Criteria for searching for a user's externalId. -Returns the profile information for the Trunk Group. Contains a hosted user table -with column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name", -"Hiragana First Name". **Attributes:** -|Name |Type |Description | -|------------------------------------------------|-------------------------------------------|---------------------------------------------------------------------------| -|pilot_user_id |str |pilotUserId *Optional* | -|department |department |department *Optional* | -|access_device |accessDevice |accessDevice *Optional* | -|max_active_calls |int |maxActiveCalls | -|max_incoming_calls |int |maxIncomingCalls *Optional* | -|max_outgoing_calls |int |maxOutgoingCalls *Optional* | -|enable_bursting |bool |enableBursting | -|bursting_max_active_calls |int |burstingMaxActiveCalls *Optional* | -|bursting_max_incoming_calls |int |burstingMaxIncomingCalls *Optional* | -|bursting_max_outgoing_calls |int |burstingMaxOutgoingCalls *Optional* | -|capacity_exceeded_action |str |capacityExceededAction *Optional* | -|capacity_exceeded_forward_address |str |capacityExceededForwardAddress *Optional* | -|capacity_exceeded_reroute_trunk_group_key |capacityExceededRerouteTrunkGroupKey |capacityExceededRerouteTrunkGroupKey *Optional* | -|capacity_exceeded_trap_initial_calls |int |capacityExceededTrapInitialCalls | -|capacity_exceeded_trap_offset_calls |int |capacityExceededTrapOffsetCalls | -|unreachable_destination_action |str |unreachableDestinationAction *Optional* | -|unreachable_destination_forward_address |str |unreachableDestinationForwardAddress *Optional* | -|unreachable_destination_reroute_trunk_group_key |unreachableDestinationRerouteTrunkGroupKey |unreachableDestinationRerouteTrunkGroupKey *Optional* | -|unreachable_destination_trap_initial_calls |int |unreachableDestinationTrapInitialCalls | -|unreachable_destination_trap_offset_calls |int |unreachableDestinationTrapOffsetCalls | -|invitation_timeout |int |invitationTimeout | -|require_authentication |bool |requireAuthentication | -|sip_authentication_user_name |str |sipAuthenticationUserName *Optional* | -|hosted_user_table |List(hostedUserTable) |hostedUserTable - *Table* array of hostedUserTable named tuples *Optional* | -|trunk_group_identity |str |trunkGroupIdentity *Optional* | -|otg_dtg_identity |str |otgDtgIdentity *Optional* | -|include_trunk_group_identity |bool |includeTrunkGroupIdentity | -|include_dtg_identity |bool |includeDtgIdentity | -|enable_network_address_identity |bool |enableNetworkAddressIdentity | -|allow_unscreened_calls |bool |allowUnscreenedCalls | -|allow_unscreened_emergency_calls |bool |allowUnscreenedEmergencyCalls | -|pilot_user_calling_line_identity_policy |str |pilotUserCallingLineIdentityPolicy | -|pilot_user_charge_number_policy |str |pilotUserChargeNumberPolicy | -|call_forwarding_always_action |str |callForwardingAlwaysAction *Optional* | -|call_forwarding_always_forward_address |str |callForwardingAlwaysForwardAddress *Optional* | -|call_forwarding_always_reroute_trunk_group_key |callForwardingAlwaysRerouteTrunkGroupKey |callForwardingAlwaysRerouteTrunkGroupKey *Optional* | +|Name |Type|Description| +|------|----|-----------| +|mode |str |mode | +|value |str |value |
-## `GroupTrunkGroupGetInstanceResponse17sp4V2`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaUserFirstName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Response to GroupTrunkGroupGetInstanceRequest17sp4V2. +Criteria for searching for a user's first name. -Returns the profile information for the Trunk Group. Contains a hosted user table -with column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name", -"Hiragana First Name". Replaced by: `GroupTrunkGroupGetInstanceResponse19V2()` **Attributes:** -|Name |Type |Description | -|-------------------------------------------------|-------------------------------------------|---------------------------------------------------------------------------| -|pilot_user_id |str |pilotUserId *Optional* | -|department |department |department *Optional* | -|access_device |accessDevice |accessDevice *Optional* | -|max_active_calls |int |maxActiveCalls | -|max_incoming_calls |int |maxIncomingCalls *Optional* | -|max_outgoing_calls |int |maxOutgoingCalls *Optional* | -|enable_bursting |bool |enableBursting | -|bursting_max_active_calls |int |burstingMaxActiveCalls *Optional* | -|bursting_max_incoming_calls |int |burstingMaxIncomingCalls *Optional* | -|bursting_max_outgoing_calls |int |burstingMaxOutgoingCalls *Optional* | -|capacity_exceeded_action |str |capacityExceededAction *Optional* | -|capacity_exceeded_forward_address |str |capacityExceededForwardAddress *Optional* | -|capacity_exceeded_reroute_trunk_group_key |capacityExceededRerouteTrunkGroupKey |capacityExceededRerouteTrunkGroupKey *Optional* | -|capacity_exceeded_trap_initial_calls |int |capacityExceededTrapInitialCalls | -|capacity_exceeded_trap_offset_calls |int |capacityExceededTrapOffsetCalls | -|unreachable_destination_action |str |unreachableDestinationAction *Optional* | -|unreachable_destination_forward_address |str |unreachableDestinationForwardAddress *Optional* | -|unreachable_destination_reroute_trunk_group_key |unreachableDestinationRerouteTrunkGroupKey |unreachableDestinationRerouteTrunkGroupKey *Optional* | -|invitation_timeout |int |invitationTimeout | -|require_authentication |bool |requireAuthentication | -|sip_authentication_user_name |str |sipAuthenticationUserName *Optional* | -|hosted_user_table |List(hostedUserTable) |hostedUserTable - *Table* array of hostedUserTable named tuples *Optional* | -|trunk_group_identity |str |trunkGroupIdentity *Optional* | -|otg_dtg_identity |str |otgDtgIdentity *Optional* | -|allow_termination_to_trunk_group_identity |bool |allowTerminationToTrunkGroupIdentity | -|allow_termination_to_dtg_identity |bool |allowTerminationToDtgIdentity | -|include_trunk_group_identity |bool |includeTrunkGroupIdentity | -|include_dtg_identity |bool |includeDtgIdentity | -|include_trunk_group_identity_for_network_calls |bool |includeTrunkGroupIdentityForNetworkCalls | -|include_otg_identity_for_network_calls |bool |includeOtgIdentityForNetworkCalls | -|enable_network_address_identity |bool |enableNetworkAddressIdentity | -|allow_unscreened_calls |bool |allowUnscreenedCalls | -|allow_unscreened_emergency_calls |bool |allowUnscreenedEmergencyCalls | -|pilot_user_calling_line_identity_policy |str |pilotUserCallingLineIdentityPolicy | -|pilot_user_charge_number_policy |str |pilotUserChargeNumberPolicy | -|call_forwarding_always_action |str |callForwardingAlwaysAction *Optional* | -|call_forwarding_always_forward_address |str |callForwardingAlwaysForwardAddress *Optional* | -|call_forwarding_always_reroute_trunk_group_key |callForwardingAlwaysRerouteTrunkGroupKey |callForwardingAlwaysRerouteTrunkGroupKey *Optional* | -|peering_domain |str |peeringDomain *Optional* | -|route_to_peering_domain |bool |routeToPeeringDomain | -|prefix_enabled |bool |prefixEnabled | -|prefix |str |prefix *Optional* | -|stateful_rerouting_enabled |bool |statefulReroutingEnabled | -|send_continuous_options_message |bool |sendContinuousOptionsMessage | -|continuous_options_sending_interval_seconds |int |continuousOptionsSendingIntervalSeconds | -|failure_options_sending_interval_seconds |int |failureOptionsSendingIntervalSeconds | -|failure_threshold_counter |int |failureThresholdCounter | -|success_threshold_counter |int |successThresholdCounter | -|invite_failure_threshold_counter |int |inviteFailureThresholdCounter | -|invite_failure_threshold_window_seconds |int |inviteFailureThresholdWindowSeconds | -|trunk_group_state |str |trunkGroupState | -|pilot_user_calling_line_asserted_identity_policy |str |pilotUserCallingLineAssertedIdentityPolicy | -|use_system_calling_line_asserted_identity_policy |bool |useSystemCallingLineAssertedIdentityPolicy | +|Name |Type |Description | +|--------------------|-----|------------------| +|mode |str |mode | +|value |str |value | +|is_case_insensitive |bool |isCaseInsensitive |
-## `GroupTrunkGroupGetInstanceResponse19sp1V2`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaUserHotlineContact`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Response to GroupTrunkGroupGetInstanceRequest19sp1V2. +Criteria for searching for a user's hotline contact. -Returns the profile information for the Trunk Group. Contains a hosted user table -with column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name", -"Hiragana First Name", "Phone Number", "Extension", "Department", "Email Address". -Replaced by: `GroupTrunkGroupGetInstanceResponse20sp1()` **Attributes:** -|Name |Type |Description | -|------------------------------------------------------------|-------------------------------------------|---------------------------------------------------------------------------| -|pilot_user_id |str |pilotUserId *Optional* | -|department |department |department *Optional* | -|access_device |accessDevice |accessDevice *Optional* | -|max_active_calls |int |maxActiveCalls | -|max_incoming_calls |int |maxIncomingCalls *Optional* | -|max_outgoing_calls |int |maxOutgoingCalls *Optional* | -|enable_bursting |bool |enableBursting | -|bursting_max_active_calls |int |burstingMaxActiveCalls *Optional* | -|bursting_max_incoming_calls |int |burstingMaxIncomingCalls *Optional* | -|bursting_max_outgoing_calls |int |burstingMaxOutgoingCalls *Optional* | -|capacity_exceeded_action |str |capacityExceededAction *Optional* | -|capacity_exceeded_forward_address |str |capacityExceededForwardAddress *Optional* | -|capacity_exceeded_reroute_trunk_group_key |capacityExceededRerouteTrunkGroupKey |capacityExceededRerouteTrunkGroupKey *Optional* | -|capacity_exceeded_trap_initial_calls |int |capacityExceededTrapInitialCalls | -|capacity_exceeded_trap_offset_calls |int |capacityExceededTrapOffsetCalls | -|unreachable_destination_action |str |unreachableDestinationAction *Optional* | -|unreachable_destination_forward_address |str |unreachableDestinationForwardAddress *Optional* | -|unreachable_destination_reroute_trunk_group_key |unreachableDestinationRerouteTrunkGroupKey |unreachableDestinationRerouteTrunkGroupKey *Optional* | -|invitation_timeout |int |invitationTimeout | -|require_authentication |bool |requireAuthentication | -|sip_authentication_user_name |str |sipAuthenticationUserName *Optional* | -|hosted_user_table |List(hostedUserTable) |hostedUserTable - *Table* array of hostedUserTable named tuples *Optional* | -|trunk_group_identity |str |trunkGroupIdentity *Optional* | -|otg_dtg_identity |str |otgDtgIdentity *Optional* | -|allow_termination_to_trunk_group_identity |bool |allowTerminationToTrunkGroupIdentity | -|allow_termination_to_dtg_identity |bool |allowTerminationToDtgIdentity | -|include_trunk_group_identity |bool |includeTrunkGroupIdentity | -|include_dtg_identity |bool |includeDtgIdentity | -|include_trunk_group_identity_for_network_calls |bool |includeTrunkGroupIdentityForNetworkCalls | -|include_otg_identity_for_network_calls |bool |includeOtgIdentityForNetworkCalls | -|enable_network_address_identity |bool |enableNetworkAddressIdentity | -|allow_unscreened_calls |bool |allowUnscreenedCalls | -|allow_unscreened_emergency_calls |bool |allowUnscreenedEmergencyCalls | -|pilot_user_calling_line_identity_for_external_calls_policy |str |pilotUserCallingLineIdentityForExternalCallsPolicy | -|pilot_user_charge_number_policy |str |pilotUserChargeNumberPolicy | -|call_forwarding_always_action |str |callForwardingAlwaysAction *Optional* | -|call_forwarding_always_forward_address |str |callForwardingAlwaysForwardAddress *Optional* | -|call_forwarding_always_reroute_trunk_group_key |callForwardingAlwaysRerouteTrunkGroupKey |callForwardingAlwaysRerouteTrunkGroupKey *Optional* | -|peering_domain |str |peeringDomain *Optional* | -|route_to_peering_domain |bool |routeToPeeringDomain | -|prefix_enabled |bool |prefixEnabled | -|prefix |str |prefix *Optional* | -|stateful_rerouting_enabled |bool |statefulReroutingEnabled | -|send_continuous_options_message |bool |sendContinuousOptionsMessage | -|continuous_options_sending_interval_seconds |int |continuousOptionsSendingIntervalSeconds | -|failure_options_sending_interval_seconds |int |failureOptionsSendingIntervalSeconds | -|failure_threshold_counter |int |failureThresholdCounter | -|success_threshold_counter |int |successThresholdCounter | -|invite_failure_threshold_counter |int |inviteFailureThresholdCounter | -|invite_failure_threshold_window_seconds |int |inviteFailureThresholdWindowSeconds | -|trunk_group_state |str |trunkGroupState | -|pilot_user_calling_line_asserted_identity_policy |str |pilotUserCallingLineAssertedIdentityPolicy | -|use_system_calling_line_asserted_identity_policy |bool |useSystemCallingLineAssertedIdentityPolicy | -|total_active_incoming_calls |int |totalActiveIncomingCalls | -|total_active_outgoing_calls |int |totalActiveOutgoingCalls | -|pilot_user_call_optimization_policy |str |pilotUserCallOptimizationPolicy | -|clid_source_for_screened_calls_policy |str |clidSourceForScreenedCallsPolicy | -|use_system_clid_source_for_screened_calls_policy |bool |useSystemCLIDSourceForScreenedCallsPolicy | -|user_lookup_policy |str |userLookupPolicy | -|use_system_user_lookup_policy |bool |useSystemUserLookupPolicy | -|pilot_user_calling_line_identity_for_emergency_calls_policy |str |pilotUserCallingLineIdentityForEmergencyCallsPolicy | +|Name |Type |Description | +|--------------------|-----|------------------| +|mode |str |mode | +|value |str |value | +|is_case_insensitive |bool |isCaseInsensitive |
-## `GroupTrunkGroupModifyInstanceRequest14sp9A`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaUserId`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Modify a Trunk Group Instance in a group. +Criteria for searching for a user's userId. -The access device cannot be modified or cleared if there are any users assigned to the -Trunk Group. -The response is either a `SuccessResponse()` or an `ErrorResponse()`. +**Attributes:** + +|Name |Type |Description | +|--------------------|-----|------------------| +|mode |str |mode | +|value |str |value | +|is_case_insensitive |bool |isCaseInsensitive | +
+ + +## `SearchCriteriaUserLastName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) + +
+Criteria for searching for a user's last name. + **Attributes:** -|Name |Type |Description | -|------------------------------------------------|-------------------------------------------|------------------------------------------------------| -|trunk_group_key |trunkGroupKey |trunkGroupKey | -|new_name |str |newName *Optional* | -|pilot_user_id |str |pilotUserId *Optional* | -|department |department |department *Optional* | -|access_device |accessDevice |accessDevice *Optional* | -|max_active_calls |int |maxActiveCalls *Optional* | -|max_incoming_calls |int |maxIncomingCalls *Optional* | -|max_outgoing_calls |int |maxOutgoingCalls *Optional* | -|enable_bursting |bool |enableBursting *Optional* | -|bursting_max_active_calls |int |burstingMaxActiveCalls *Optional* | -|bursting_max_incoming_calls |int |burstingMaxIncomingCalls *Optional* | -|bursting_max_outgoing_calls |int |burstingMaxOutgoingCalls *Optional* | -|capacity_exceeded_action |str |capacityExceededAction *Optional* | -|capacity_exceeded_forward_address |str |capacityExceededForwardAddress *Optional* | -|capacity_exceeded_reroute_trunk_group_key |capacityExceededRerouteTrunkGroupKey |capacityExceededRerouteTrunkGroupKey *Optional* | -|capacity_exceeded_trap_initial_calls |int |capacityExceededTrapInitialCalls *Optional* | -|capacity_exceeded_trap_offset_calls |int |capacityExceededTrapOffsetCalls *Optional* | -|unreachable_destination_action |str |unreachableDestinationAction *Optional* | -|unreachable_destination_forward_address |str |unreachableDestinationForwardAddress *Optional* | -|unreachable_destination_reroute_trunk_group_key |unreachableDestinationRerouteTrunkGroupKey |unreachableDestinationRerouteTrunkGroupKey *Optional* | -|unreachable_destination_trap_initial_calls |int |unreachableDestinationTrapInitialCalls *Optional* | -|unreachable_destination_trap_offset_calls |int |unreachableDestinationTrapOffsetCalls *Optional* | -|invitation_timeout |int |invitationTimeout *Optional* | -|require_authentication |bool |requireAuthentication *Optional* | -|sip_authentication_user_name |str |sipAuthenticationUserName *Optional* | -|sip_authentication_password |str |sipAuthenticationPassword *Optional* | -|hosted_user_id_list |hostedUserIdList |hostedUserIdList *Optional* | -|trunk_group_identity |str |trunkGroupIdentity *Optional* | -|otg_dtg_identity |str |otgDtgIdentity *Optional* | -|include_trunk_group_identity |bool |includeTrunkGroupIdentity *Optional* | -|include_dtg_identity |bool |includeDtgIdentity *Optional* | -|enable_network_address_identity |bool |enableNetworkAddressIdentity *Optional* | -|allow_unscreened_calls |bool |allowUnscreenedCalls *Optional* | -|allow_unscreened_emergency_calls |bool |allowUnscreenedEmergencyCalls *Optional* | -|pilot_user_calling_line_identity_policy |str |pilotUserCallingLineIdentityPolicy *Optional* | -|pilot_user_charge_number_policy |str |pilotUserChargeNumberPolicy *Optional* | -|call_forwarding_always_action |str |callForwardingAlwaysAction *Optional* | -|call_forwarding_always_forward_address |str |callForwardingAlwaysForwardAddress *Optional* | -|call_forwarding_always_reroute_trunk_group_key |callForwardingAlwaysRerouteTrunkGroupKey |callForwardingAlwaysRerouteTrunkGroupKey *Optional* | +|Name |Type |Description | +|--------------------|-----|------------------| +|mode |str |mode | +|value |str |value | +|is_case_insensitive |bool |isCaseInsensitive |
-## `IncomingCallingPlanDepartmentPermissions`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SearchCriteriaUserName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Allows or disallows various types of incoming calls for a specified department. +Criteria for searching for a user's full name. +This search criterion will be compared against multiple combinations of first name and +last name: First Name + ' ' + Last Name Last Name + ' ' + First Name Last Name + ', ' ++ First Name Hiragana Last Name + ' ' + Hiragana First Name Note that when specific +conditions are met, VON users will be included in the search results. **Attributes:** -|Name |Type |Description | -|--------------------------|-----------------------------|----------------------------------| -|department_key |departmentKey |departmentKey | -|department_full_path_name |str |departmentFullPathName | -|allow_from_within_group |bool |allowFromWithinGroup | -|allow_from_outside_group |str |allowFromOutsideGroup | -|allow_collect_calls |bool |allowCollectCalls | -|digit_pattern_permission |List[digitPatternPermission] |digitPatternPermission *Optional* | +|Name |Type |Description | +|--------------------|-----|------------------| +|mode |str |mode | +|value |str |value | +|is_case_insensitive |bool |isCaseInsensitive | +
+ + +## `SearchCriteriaUserPersonalMultiPartPhoneListName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) + +
+Criteria for searching for a name in a user personal phone list. + +Note: For this search criterion, the searchMode is always ‘Contains’ and the multi- +part search criteria are always AND’ed. + +**Attributes:** + +|Name |Type |Description | +|--------------------|----------|------------------| +|value |List[str] |value | +|is_case_insensitive |bool |isCaseInsensitive | +
+ + +## `SearchCriteriaUserPersonalPhoneListName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) + +
+Criteria for searching for a name in a user personal phone list. + + +**Attributes:** + +|Name |Type |Description | +|--------------------|-----|------------------| +|mode |str |mode | +|value |str |value | +|is_case_insensitive |bool |isCaseInsensitive | +
+ + +## `SearchCriteriaUserPersonalPhoneListNumber`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) + +
+Criteria for searching for a phone number in a user personal phone list. + + +**Attributes:** + +|Name |Type |Description | +|--------------------|-----|------------------| +|mode |str |mode | +|value |str |value | +|is_case_insensitive |bool |isCaseInsensitive | +
+ + +## `SearchCriteriaUserPlaceType`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) + +
+Criteria for searching based on a user type – “User” or “Place”. + + +**Attributes:** + +|Name |Type|Description| +|------|----|-----------| +|value |str |value | +
+ + +## `SearchCriteriaYahooId`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) + +
+Criteria for searching for a user's yahoo id. + + +**Attributes:** + +|Name |Type |Description | +|--------------------|-----|------------------| +|mode |str |mode | +|value |str |value | +|is_case_insensitive |bool |isCaseInsensitive | +
+ + +## `SearchCriteriaZoneIPAddress`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) + +
+Criteria for searching for a system zone's IP Address. + + +**Attributes:** + +|Name |Type |Description | +|--------------------|-----|------------------| +|mode |str |mode | +|value |str |value | +|is_case_insensitive |bool |isCaseInsensitive | +
+ + +## `SelectiveCallRejectionCriteriaCallTypeModify`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) + +
+The call type criteria used within a modify request. + + +**Attributes:** + +|Name |Type |Description | +|----------------------------|----------------|-------------------------------------| +|from_dn_criteria_selection |str |fromDnCriteriaSelection *Optional* | +|include_anonymous_callers |bool |includeAnonymousCallers *Optional* | +|include_unavailable_callers |bool |includeUnavailableCallers *Optional* | +|phone_number_list |phoneNumberList |phoneNumberList *Optional* | +
+ + +## `ServiceInstanceAddProfile`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) + +
+Service Profile Information for group service. + + +**Attributes:** + +|Name |Type |Description | +|-----------------------------|-----------|------------------------------------| +|name |str |name | +|calling_line_id_last_name |str |callingLineIdLastName | +|calling_line_id_first_name |str |callingLineIdFirstName | +|hiragana_last_name |str |hiraganaLastName *Optional* | +|hiragana_first_name |str |hiraganaFirstName *Optional* | +|phone_number |str |phoneNumber *Optional* | +|extension |str |extension *Optional* | +|password |str |password *Optional* | +|department |department |department *Optional* | +|language |str |language *Optional* | +|time_zone |str |timeZone *Optional* | +|alias |List[str] |alias *Optional* | +|public_user_identity |str |publicUserIdentity *Optional* | +|calling_line_id_phone_number |str |callingLineIdPhoneNumber *Optional* |
-## `IncomingCallingPlanDepartmentPermissionsModify`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `ServiceInstanceAddProfileCallCenter`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Allows or disallows various types of incoming calls for a specified department. +Service Profile Information for a call center. -For use when modifing settings. +Password is required. **Attributes:** -|Name |Type |Description | -|-------------------------|-----------------------------|----------------------------------| -|department_key |departmentKey |departmentKey | -|allow_from_within_group |bool |allowFromWithinGroup *Optional* | -|allow_from_outside_group |str |allowFromOutsideGroup *Optional* | -|allow_collect_calls |bool |allowCollectCalls *Optional* | -|digit_pattern_permission |List[digitPatternPermission] |digitPatternPermission *Optional* | +|Name |Type |Description | +|-----------------------------|-----------|------------------------------------| +|name |str |name | +|calling_line_id_last_name |str |callingLineIdLastName | +|calling_line_id_first_name |str |callingLineIdFirstName | +|hiragana_last_name |str |hiraganaLastName *Optional* | +|hiragana_first_name |str |hiraganaFirstName *Optional* | +|phone_number |str |phoneNumber *Optional* | +|extension |str |extension *Optional* | +|password |str |password | +|department |department |department *Optional* | +|language |str |language *Optional* | +|time_zone |str |timeZone *Optional* | +|alias |List[str] |alias *Optional* | +|public_user_identity |str |publicUserIdentity *Optional* | +|calling_line_id_phone_number |str |callingLineIdPhoneNumber *Optional* |
-## `IncomingCallingPlanPermissions`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `ServiceInstanceAddProfileFlexibleSeatingHost`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Allows or disallows various types of incoming calls for a user or group -- not any -particular department. +Service Profile Information for a flexible seating host. **Attributes:** -|Name |Type |Description | -|-------------------------|-----------------------------|----------------------------------| -|allow_from_within_group |bool |allowFromWithinGroup | -|allow_from_outside_group |str |allowFromOutsideGroup | -|allow_collect_calls |bool |allowCollectCalls | -|digit_pattern_permission |List[digitPatternPermission] |digitPatternPermission *Optional* | +|Name |Type |Description | +|-----------------------------|-----------|------------------------------------| +|name |str |name | +|calling_line_id_last_name |str |callingLineIdLastName | +|calling_line_id_first_name |str |callingLineIdFirstName | +|hiragana_last_name |str |hiraganaLastName *Optional* | +|hiragana_first_name |str |hiraganaFirstName *Optional* | +|phone_number |str |phoneNumber *Optional* | +|extension |str |extension *Optional* | +|password |str |password *Optional* | +|department |department |department *Optional* | +|language |str |language *Optional* | +|time_zone |str |timeZone *Optional* | +|calling_line_id_phone_number |str |callingLineIdPhoneNumber *Optional* |
-## `IncomingCallingPlanPermissionsModify`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `ServiceInstanceAddProfileTrunkGroup`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Allows or disallows various types of incoming calls for a user or group -- not any -particular department. +Service Profile Information for a trunk group. -For use when modifing settings. +The publicUserIdentity element is not part of ServiceInstanceAddProfileTrunkGroup. **Attributes:** -|Name |Type |Description | -|-------------------------|-----------------------------|----------------------------------| -|allow_from_within_group |bool |allowFromWithinGroup *Optional* | -|allow_from_outside_group |str |allowFromOutsideGroup *Optional* | -|allow_collect_calls |bool |allowCollectCalls *Optional* | -|digit_pattern_permission |List[digitPatternPermission] |digitPatternPermission *Optional* | +|Name |Type |Description | +|-----------------------------|-----------|------------------------------------| +|name |str |name | +|calling_line_id_last_name |str |callingLineIdLastName | +|calling_line_id_first_name |str |callingLineIdFirstName | +|hiragana_last_name |str |hiraganaLastName *Optional* | +|hiragana_first_name |str |hiraganaFirstName *Optional* | +|phone_number |str |phoneNumber *Optional* | +|extension |str |extension *Optional* | +|password |str |password *Optional* | +|department |department |department *Optional* | +|language |str |language *Optional* | +|time_zone |str |timeZone *Optional* | +|alias |List[str] |alias *Optional* | +|calling_line_id_phone_number |str |callingLineIdPhoneNumber *Optional* |
-## `MWIDeliveryToMobileEndpointTemplateBody`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `ServiceInstanceModifyProfile`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-MWI Delivery To Mobile Endpoint template body. +Service Profile Information for group service used when modifying an existing service +instance. **Attributes:** -|Name |Type |Description| -|-----|-----------|-----------| -|line |List[line] |line | +|Name |Type |Description | +|-----------------------------|-------------|------------------------------------| +|name |str |name *Optional* | +|calling_line_id_last_name |str |callingLineIdLastName *Optional* | +|calling_line_id_first_name |str |callingLineIdFirstName *Optional* | +|hiragana_last_name |str |hiraganaLastName *Optional* | +|hiragana_first_name |str |hiraganaFirstName *Optional* | +|phone_number |str |phoneNumber *Optional* | +|extension |str |extension *Optional* | +|password |str |password *Optional* | +|department |department |department *Optional* | +|language |str |language *Optional* | +|time_zone |str |timeZone *Optional* | +|sip_alias_list |sipAliasList |sipAliasList *Optional* | +|public_user_identity |str |publicUserIdentity *Optional* | +|calling_line_id_phone_number |str |callingLineIdPhoneNumber *Optional* |
-## `OutgoingCallingPlanCallMeNowDepartmentPermissions`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `ServiceInstanceModifyProfileFlexibleSeatingHost`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Outgoing Calling Plan for Call Me Now call permissions for a department. - +Service Profile Information for a flexible seating host **Attributes:** -|Name |Type |Description | -|----------------|--------------|---------------| -|department_key |departmentKey |departmentKey | -|department_name |str |departmentName | -|permissions |permissions |permissions | +|Name |Type |Description | +|-----------------------------|-----------|------------------------------------| +|name |str |name *Optional* | +|calling_line_id_last_name |str |callingLineIdLastName *Optional* | +|calling_line_id_first_name |str |callingLineIdFirstName *Optional* | +|hiragana_last_name |str |hiraganaLastName *Optional* | +|hiragana_first_name |str |hiraganaFirstName *Optional* | +|phone_number |str |phoneNumber *Optional* | +|extension |str |extension *Optional* | +|password |str |password *Optional* | +|department |department |department *Optional* | +|language |str |language *Optional* | +|time_zone |str |timeZone *Optional* | +|calling_line_id_phone_number |str |callingLineIdPhoneNumber *Optional* |
-## `OutgoingCallingPlanCallMeNowDepartmentPermissionsModify`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `ServiceInstanceModifyProfileTrunkGroup`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Modify outgoing Calling Plan for Call Me Now call permissions for a department. +Service Profile Information for a trunk group used when modifying an existing service +instance. **Attributes:** -|Name |Type |Description | -|---------------|--------------|--------------| -|department_key |departmentKey |departmentKey | -|permissions |permissions |permissions | +|Name |Type |Description | +|---------------------------|-------------|----------------------------------| +|name |str |name *Optional* | +|calling_line_id_last_name |str |callingLineIdLastName *Optional* | +|calling_line_id_first_name |str |callingLineIdFirstName *Optional* | +|hiragana_last_name |str |hiraganaLastName *Optional* | +|hiragana_first_name |str |hiraganaFirstName *Optional* | +|phone_number |str |phoneNumber *Optional* | +|extension |str |extension *Optional* | +|password |str |password *Optional* | +|department |department |department *Optional* | +|language |str |language *Optional* | +|time_zone |str |timeZone *Optional* | +|sip_alias_list |sipAliasList |sipAliasList *Optional* |
-## `OutgoingCallingPlanDepartmentAuthorizationCodes`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `ServiceInstanceReadProfile`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Outgoing Calling Plan Authorization Code for a department. +Service Profile Information for group service. +It is identical to the ServiceInstanceAddProfile, but without the password. Prior to +release 14 this was called ServiceInstanceProfile. **Attributes:** -|Name |Type |Description | -|----------------|----------------|---------------------| -|department_key |departmentKey |departmentKey | -|department_name |str |departmentName | -|code_entry |List[codeEntry] |codeEntry *Optional* | +|Name |Type |Description | +|---------------------------|-----------|-------------------------------| +|name |str |name | +|calling_line_id_last_name |str |callingLineIdLastName | +|calling_line_id_first_name |str |callingLineIdFirstName | +|hiragana_last_name |str |hiraganaLastName *Optional* | +|hiragana_first_name |str |hiraganaFirstName *Optional* | +|phone_number |str |phoneNumber *Optional* | +|extension |str |extension *Optional* | +|department |department |department *Optional* | +|language |str |language *Optional* | +|time_zone |str |timeZone *Optional* | +|time_zone_display_name |str |timeZoneDisplayName *Optional* | +|alias |List[str] |alias *Optional* | +|public_user_identity |str |publicUserIdentity *Optional* |
-## `OutgoingCallingPlanDepartmentTransferNumbers`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `ServiceInstanceReadProfile17`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Outgoing Calling Plan transfer numbers for a department. +Service Profile Information for group service. +It is identical to the ServiceInstanceAddProfile, but without the password. Replaced +by: ServiceInstanceReadProfile17sp4 **Attributes:** -|Name |Type |Description | -|-----------------|----------------|----------------| -|department_key |departmentKey |departmentKey | -|department_name |str |departmentName | -|transfer_numbers |transferNumbers |transferNumbers | +|Name |Type |Description | +|---------------------------|-----------|-------------------------------| +|name |str |name | +|calling_line_id_last_name |str |callingLineIdLastName | +|calling_line_id_first_name |str |callingLineIdFirstName | +|hiragana_last_name |str |hiraganaLastName *Optional* | +|hiragana_first_name |str |hiraganaFirstName *Optional* | +|phone_number |str |phoneNumber *Optional* | +|extension |str |extension *Optional* | +|department |department |department *Optional* | +|language |str |language *Optional* | +|time_zone |str |timeZone *Optional* | +|time_zone_display_name |str |timeZoneDisplayName *Optional* | +|alias |List[str] |alias *Optional* | +|public_user_identity |str |publicUserIdentity *Optional* |
-## `OutgoingCallingPlanDepartmentTransferNumbersModify`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `ServiceInstanceReadProfile17sp4`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Outgoing Calling Plan transfer numbers for a department. +Service Profile Information for group service. +Replaced by: ServiceInstanceReadProfile19sp1 **Attributes:** -|Name |Type |Description | -|-----------------|----------------|---------------------------| -|department_key |departmentKey |departmentKey | -|transfer_numbers |transferNumbers |transferNumbers *Optional* | +|Name |Type |Description | +|---------------------------|-----------|-------------------------------| +|name |str |name | +|calling_line_id_last_name |str |callingLineIdLastName | +|calling_line_id_first_name |str |callingLineIdFirstName | +|hiragana_last_name |str |hiraganaLastName *Optional* | +|hiragana_first_name |str |hiraganaFirstName *Optional* | +|phone_number |str |phoneNumber *Optional* | +|extension |str |extension *Optional* | +|country_code |str |countryCode *Optional* | +|national_prefix |str |nationalPrefix *Optional* | +|department |department |department *Optional* | +|language |str |language *Optional* | +|time_zone |str |timeZone *Optional* | +|time_zone_display_name |str |timeZoneDisplayName *Optional* | +|alias |List[str] |alias *Optional* | +|public_user_identity |str |publicUserIdentity *Optional* |
-## `OutgoingCallingPlanDigitPatternCallMeNowPermissions`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `ServiceInstanceReadProfile19sp1`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Outgoing Calling Plan Call Me Now call permissions for specified digit patterns. +Service Profile Information for group service. +The callingLineIdPhoneNumber is no longer being formatted for display purpose. The +value is returned exactly the same as being stored. **Attributes:** -|Name |Type |Description | -|--------------------------|------------------------------|------------------------| -|digit_pattern_permissions |List[digitPatternPermissions] |digitPatternPermissions | +|Name |Type |Description | +|-----------------------------|-----------|------------------------------------| +|name |str |name | +|calling_line_id_last_name |str |callingLineIdLastName | +|calling_line_id_first_name |str |callingLineIdFirstName | +|hiragana_last_name |str |hiraganaLastName *Optional* | +|hiragana_first_name |str |hiraganaFirstName *Optional* | +|phone_number |str |phoneNumber *Optional* | +|extension |str |extension *Optional* | +|country_code |str |countryCode *Optional* | +|national_prefix |str |nationalPrefix *Optional* | +|department |department |department *Optional* | +|language |str |language *Optional* | +|time_zone |str |timeZone *Optional* | +|time_zone_display_name |str |timeZoneDisplayName *Optional* | +|alias |List[str] |alias *Optional* | +|public_user_identity |str |publicUserIdentity *Optional* | +|calling_line_id_phone_number |str |callingLineIdPhoneNumber *Optional* |
-## `OutgoingCallingPlanDigitPatternOriginatingPermissions`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `ServicePack`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Outgoing Calling Plan originating call permissions for specified digit patterns. +The common Service Pack elements. **Attributes:** -|Name |Type |Description | -|--------------------------|------------------------------|------------------------| -|digit_pattern_permissions |List[digitPatternPermissions] |digitPatternPermissions | +|Name |Type |Description | +|-------------------------|--------------------|----------------------------------| +|service_pack_name |str |servicePackName | +|service_pack_description |str |servicePackDescription *Optional* | +|is_available_for_use |bool |isAvailableForUse | +|service_pack_quantity |servicePackQuantity |servicePackQuantity | +|service_name |List[str] |serviceName *Optional* |
-## `OutgoingCallingPlanDigitPatternRedirectingPermissions`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `ServicePackAuthorization`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Outgoing Calling Plan redirecting call permissions for specified digit patterns. +Authorize (with quantity) or unauthorize a service pack. **Attributes:** -|Name |Type |Description | -|--------------------------|------------------------------|------------------------| -|digit_pattern_permissions |List[digitPatternPermissions] |digitPatternPermissions | +|Name |Type |Description | +|--------------------|-------------------|------------------------------| +|service_pack_name |str |servicePackName | +|authorized_quantity |authorizedQuantity |authorizedQuantity *Optional* | +|unauthorized |bool |unauthorized *Optional* |
-## `OutgoingCallingPlanGroupAuthorizationCodes`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `ServiceProviderCommunicationBarringProfileGetResponse19sp1V2`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Outgoing Calling Plan Authorization Code for the group default. +Response to the ServiceProviderCommunicationBarringProfileGetRequest19sp1V2. +The response contains the Communication Barring Profile information. The incoming, +originating, redirecting and call me now rules are returned in ascending priority +order. The following elements are only used in AS data mode: callMeNowDefaultAction +callMeNowDefaultCallTimeout callMeNowRule applyToAttendedCallTransfers **Attributes:** -|Name |Type |Description | -|-----------|----------------|---------------------| -|code_entry |List[codeEntry] |codeEntry *Optional* | +|Name |Type |Description | +|------------------------------------|----------------------|--------------------------------------------| +|description |str |description *Optional* | +|originating_default_action |str |originatingDefaultAction | +|originating_default_treatment_id |str |originatingDefaultTreatmentId *Optional* | +|originating_default_transfer_number |str |originatingDefaultTransferNumber *Optional* | +|originating_default_call_timeout |int |originatingDefaultCallTimeout *Optional* | +|originating_rule |List[originatingRule] |originatingRule *Optional* | +|redirecting_default_action |str |redirectingDefaultAction | +|redirecting_default_call_timeout |int |redirectingDefaultCallTimeout *Optional* | +|redirecting_rule |List[redirectingRule] |redirectingRule *Optional* | +|call_me_now_default_action |str |callMeNowDefaultAction | +|call_me_now_default_call_timeout |int |callMeNowDefaultCallTimeout *Optional* | +|call_me_now_rule |List[callMeNowRule] |callMeNowRule *Optional* | +|incoming_default_action |str |incomingDefaultAction | +|incoming_default_call_timeout |int |incomingDefaultCallTimeout *Optional* | +|incoming_rule |List[incomingRule] |incomingRule *Optional* | +|is_default |bool |isDefault | +|apply_to_attended_call_transfers |bool |applyToAttendedCallTransfers |
-## `OutgoingCallingPlanOriginatingDepartmentPermissions`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `ServiceProviderReplacementCommunicationBarringHierarchicalCallMeNowRuleList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Outgoing Calling Plan originating call permissions for a department. +A list of Service Provider Communication Barring Hierarchical Call Me Now Rules that +replaces a previously configured list. +By convention, an element of this type may be set nill to clear the list. **Attributes:** -|Name |Type |Description | -|----------------|--------------|---------------| -|department_key |departmentKey |departmentKey | -|department_name |str |departmentName | -|permissions |permissions |permissions | +|Name |Type |Description| +|-----|-----------|-----------| +|rule |List[rule] |rule |
-## `OutgoingCallingPlanOriginatingDepartmentPermissionsModify`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `ServiceProviderReplacementCommunicationBarringHierarchicalOriginatingRuleList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Outgoing Calling Plan originating call permissions for a department. +A list of Service Provider Communication Barring Hierarchical Originating Rules that +replaces a previously configured list. +By convention, an element of this type may be set nill to clear the list. **Attributes:** -|Name |Type |Description | -|---------------|--------------|-----------------------| -|department_key |departmentKey |departmentKey | -|permissions |permissions |permissions *Optional* | +|Name |Type |Description| +|-----|-----------|-----------| +|rule |List[rule] |rule |
-## `OutgoingCallingPlanRedirectedDepartmentPermissions`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `ServiceProviderReplacementCommunicationBarringHierarchicalRedirectingRuleList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Outgoing Calling Plan being forwarded/transferred permissions for a department. +A list of Service Provider Communication Barring Hierarchical Redirecting Rules that +replaces a previously configured list. +By convention, an element of this type may be set nill to clear the list. **Attributes:** -|Name |Type |Description | -|----------------|--------------|---------------| -|department_key |departmentKey |departmentKey | -|department_name |str |departmentName | -|permissions |permissions |permissions | +|Name |Type |Description| +|-----|-----------|-----------| +|rule |List[rule] |rule |
-## `OutgoingCallingPlanRedirectedDepartmentPermissionsModify`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `ShInterfaceUserIdDataEntry`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Outgoing Calling Plan being forwarded/transferred permissions for a department. +ShInterface User Id Data Entry. **Attributes:** -|Name |Type |Description | -|---------------|--------------|--------------| -|department_key |departmentKey |departmentKey | -|permissions |permissions |permissions | +|Name |Type |Description | +|---------------------|-------------------|---------------------| +|user_type |str |userType | +|public_user_identity |publicUserIdentity |publicUserIdentity | +|endpoint_type |str |endpointType | +|scscf_name |str |SCSCFName *Optional* | +|ims_user_state |str |IMSUserState |
-## `OutgoingCallingPlanRedirectingDepartmentPermissions`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `ShInterfaceUserIdDataEntry21sp1`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Outgoing Calling Plan initiating call forwards/transfer permissions for a department. +ShInterface User Id Data Entry. **Attributes:** -|Name |Type |Description | -|----------------|--------------|---------------| -|department_key |departmentKey |departmentKey | -|department_name |str |departmentName | -|permissions |permissions |permissions | +|Name |Type |Description | +|---------------------|-------------------|---------------------| +|user_type |str |userType | +|public_user_identity |publicUserIdentity |publicUserIdentity | +|endpoint_type |str |endpointType | +|scscf_name |str |SCSCFName *Optional* | +|ims_user_state |str |IMSUserState |
-## `OutgoingCallingPlanRedirectingDepartmentPermissionsModify`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `ShInterfaceUserListEntry`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Outgoing Calling Plan initiating call forwards/transfer permissions for a department. +ShInterface User List Entry. **Attributes:** -|Name |Type |Description | -|---------------|--------------|--------------| -|department_key |departmentKey |departmentKey | -|permissions |permissions |permissions | +|Name |Type |Description | +|---------------------|-------------------|---------------------| +|user_id |str |userId | +|user_type |str |userType | +|public_user_identity |publicUserIdentity |publicUserIdentity | +|endpoint_type |str |endpointType | +|scscf_name |str |SCSCFName *Optional* | +|ims_user_state |str |IMSUserState |
-## `OutgoingPinholeDigitPlanDigitPatternCallMeNowPermissions`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `ShInterfaceUserListEntry21sp1`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Outgoing Pinhole Digit Plan Call Me Now call permissions for specified digit patterns. +ShInterface User List Entry. **Attributes:** -|Name |Type |Description | -|--------------------------|------------------------------|------------------------| -|digit_pattern_permissions |List[digitPatternPermissions] |digitPatternPermissions | +|Name |Type |Description | +|---------------------|-------------------|---------------------| +|user_id |str |userId | +|user_type |str |userType | +|public_user_identity |publicUserIdentity |publicUserIdentity | +|endpoint_type |str |endpointType | +|scscf_name |str |SCSCFName *Optional* | +|ims_user_state |str |IMSUserState |
-## `OutgoingPinholeDigitPlanDigitPatternOriginatingPermissions`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SimultaneousRingReplacementNumberList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Outgoing Pinhole Digit Plan originating call permissions for specified digit patterns. +A list of Simultaneous Ring numbers that replaces a previously configured list. +By convention, an element of this type may be set nill to clear the list. **Attributes:** -|Name |Type |Description | -|--------------------------|------------------------------|------------------------| -|digit_pattern_permissions |List[digitPatternPermissions] |digitPatternPermissions | +|Name |Type |Description | +|-------------------------|-----------------------------|-----------------------| +|simultaneous_ring_number |List[simultaneousRingNumber] |simultaneousRingNumber |
-## `OutgoingPinholeDigitPlanDigitPatternRedirectingPermissions`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SortByAdminFirstName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Outgoing Pinhole Digit Plan redirecting call permissions for specified digit patterns. +The sort criteria specifies the administrator first name as the column for the sort, +whether the sort is ascending or descending, and whether the sort is case sensitive. **Attributes:** -|Name |Type |Description | -|--------------------------|------------------------------|------------------------| -|digit_pattern_permissions |List[digitPatternPermissions] |digitPatternPermissions | +|Name |Type |Description | +|------------------|-----|----------------| +|is_ascending |bool |isAscending | +|is_case_sensitive |bool |isCaseSensitive |
-## `PriorityAlertCriteriaFromDnModify`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SortByAdminId`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The from dn criteria used within a modify request. +The sort criteria specifies the administrator id as the column for the sort, whether +the sort is ascending or descending, and whether the sort is case sensitive. **Attributes:** -|Name |Type |Description | -|----------------------------|----------------|-------------------------------------| -|from_dn_criteria_selection |str |fromDnCriteriaSelection *Optional* | -|include_anonymous_callers |bool |includeAnonymousCallers *Optional* | -|include_unavailable_callers |bool |includeUnavailableCallers *Optional* | -|phone_number_list |phoneNumberList |phoneNumberList *Optional* | +|Name |Type |Description | +|------------------|-----|----------------| +|is_ascending |bool |isAscending | +|is_case_sensitive |bool |isCaseSensitive |
-## `ProfileAndServiceDeviceEndpointInfo`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SortByAdminLastName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Represents information about an endpoint device +The sort criteria specifies the administrator last name as the column for the sort, +whether the sort is ascending or descending, and whether the sort is case sensitive. + **Attributes:** -|Name |Type |Description | -|--------------------------|-------------|----------------------------------| -|access_device |accessDevice |accessDevice | -|line_port |str |linePort | -|private_identity |str |privateIdentity *Optional* | -|access_device_mac_address |str |accessDeviceMacAddress *Optional* | +|Name |Type |Description | +|------------------|-----|----------------| +|is_ascending |bool |isAscending | +|is_case_sensitive |bool |isCaseSensitive |
-## `ProfileAndServiceMusicOnHoldInfo`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SortByAgentThresholdProfile`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-This is the configuration parameters for Music On Hold service +The sort criteria specifies the call center agent threshold profile as the column for +the sort, whether the sort is ascending or descending, and whether the sort is case +sensitive. + **Attributes:** -|Name |Type |Description | -|----------------------------------------|---------------|-----------------------------------| -|enable_video |bool |enableVideo | -|source |source |source | -|use_alternate_source_for_internal_calls |bool |useAlternateSourceForInternalCalls | -|internal_source |internalSource |internalSource *Optional* | +|Name |Type |Description | +|------------------|-----|----------------| +|is_ascending |bool |isAscending | +|is_case_sensitive |bool |isCaseSensitive |
-## `ProfileAndServiceSimultaneousRingPersonalInfo`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SortByAnnouncementFileName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-This is the configuration parameters for Simultaneous Ring Personal service Contains a -criteria table with column heading: "Is Active", "Criteria Name", "Time Schedule", -"Holiday Schedule", "Calls From" and "Blacklisted". - -The "Calls From" column is a string containing call numbers - -**Attributes:** +The sort criteria specifies the file name as the column for the sort, whether the sort +is ascending or descending, and whether the sort is case sensitive. -|Name |Type |Description | -|-------------------------|-----------------------------|------------------------------------------------------------| -|is_active |bool |isActive | -|do_not_ring_if_on_call |bool |doNotRingIfOnCall | -|simultaneous_ring_number |List[simultaneousRingNumber] |simultaneousRingNumber *Optional* | -|criteria_table |List(criteriaTable) |criteriaTable - *Table* array of criteriaTable named tuples | + +**Attributes:** + +|Name |Type |Description | +|------------------|-----|----------------| +|is_ascending |bool |isAscending | +|is_case_sensitive |bool |isCaseSensitive |
-## `ProfileAndServiceSpeedDial100Info`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SortByAnnouncementFileSize`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-This is the configuration parameters for Speed Dial 100 service +The sort criteria specifies the file size as the column for the sort, whether the sort +is ascending or descending, and whether the sort is case sensitive. + **Attributes:** -|Name |Type |Description | -|-----------------|---------------------|--------------------------| -|prefix |str |prefix *Optional* | -|speed_dial_entry |List[speedDialEntry] |speedDialEntry *Optional* | +|Name |Type |Description | +|-------------|-----|------------| +|is_ascending |bool |isAscending |
-## `ProfileAndServiceSpeedDial8Info`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SortByCallCenterName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-This is the configuration parameters for Speed Dial 8 service +The sort criteria specifies the call center name as the column for the sort, whether +the sort is ascending or descending, and whether the sort is case sensitive. + **Attributes:** -|Name |Type |Description | -|-----------------|---------------------|--------------------------| -|speed_dial_entry |List[speedDialEntry] |speedDialEntry *Optional* | +|Name |Type |Description | +|------------------|-----|----------------| +|is_ascending |bool |isAscending | +|is_case_sensitive |bool |isCaseSensitive |
-## `PushNotificationTokenData`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SortByCallCenterType`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-? The common push notification token elements. +The sort criteria specifies the call center type as the column for the sort, whether +the sort is ascending or descending, and whether the sort is case sensitive. **Attributes:** -|Name |Type |Description | -|-----------------------------|--------------------------------|-------------------------------------| -|push_notification_token |str |pushNotificationToken | -|push_notification_type |str |pushNotificationType | -|push_notification_event_data |List[pushNotificationEventData] |pushNotificationEventData *Optional* | +|Name |Type |Description | +|------------------|-----|----------------| +|is_ascending |bool |isAscending | +|is_case_sensitive |bool |isCaseSensitive |
-## `ReceptionistContactUserAndNote`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SortByCallParkName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The Receptionist User (or VON User) and Receptionist Notes. +The sort criteria specifies the call park name as the column for the sort, whether the +sort is ascending or descending, and whether the sort is case sensitive. **Attributes:** -|Name |Type |Description | -|----------------|--------|-------------------------| -|contact_user_id |str |contactUserId *Optional* | -|von_user |vonUser |vonUser *Optional* | -|note |str |note | +|Name |Type |Description | +|------------------|-----|----------------| +|is_ascending |bool |isAscending | +|is_case_sensitive |bool |isCaseSensitive |
-## `ReplacementAgentWeightList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SortByCallPickupName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-A list of agent userIds and hunt agent weights that replaces the previously configured -list. +The sort criteria specifies the call pickup name as the column for the sort, whether +the sort is ascending or descending, and whether the sort is case sensitive. -By convention, an element of this type may be set nill to clear the list. **Attributes:** -|Name |Type |Description | -|-------------|------------------|------------| -|agent_weight |List[agentWeight] |agentWeight | +|Name |Type |Description | +|------------------|-----|----------------| +|is_ascending |bool |isAscending | +|is_case_sensitive |bool |isCaseSensitive |
-## `ReplacementAlternateUserIdEntryList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SortByDepartmentName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-A list of alternate user ids that that replaces a previously configured list. +The sort criteria specifies the department name as the column for the sort, whether +the sort is ascending or descending, and whether the sort is case sensitive. -By convention, an element of this type may be set nill to clear the list. **Attributes:** -|Name |Type |Description | -|------------------|----------------------|----------------| -|alternate_user_id |List[alternateUserId] |alternateUserId | +|Name |Type |Description | +|------------------|-----|----------------| +|is_ascending |bool |isAscending | +|is_case_sensitive |bool |isCaseSensitive |
-## `ReplacementCallToNumberList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SortByDeviceMACAddress`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-A list of Call to Numbers that replaces a previously configured list. +The sort criteria specifies the device MAC address as the column for the sort, whether +the sort is ascending or descending, and whether the sort is case sensitive. -By convention, an element of this type may be set nill to clear the list. For the -callToNumbers, the extension element is not used and the number element is only used -when the type is BroadWorks Mobility. **Attributes:** -|Name |Type |Description | -|---------------|-------------------|-------------| -|call_to_number |List[callToNumber] |callToNumber | +|Name |Type |Description | +|------------------|-----|----------------| +|is_ascending |bool |isAscending | +|is_case_sensitive |bool |isCaseSensitive |
-## `ReplacementCommunicationBarringCallMeNowRuleList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SortByDeviceName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-A list of Communication Barring CallMeNow Rules that replaces a previously configured -list. +The sort criteria specifies the device name as the column for the sort, whether the +sort is ascending or descending, and whether the sort is case sensitive. -By convention, an element of this type may be set nill to clear the list. **Attributes:** -|Name |Type |Description| -|-----|-----------|-----------| -|rule |List[rule] |rule | +|Name |Type |Description | +|------------------|-----|----------------| +|is_ascending |bool |isAscending | +|is_case_sensitive |bool |isCaseSensitive |
-## `ReplacementCommunicationBarringIncomingRuleList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SortByDeviceNetAddress`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-A list of Communication Barring Incoming Rules that replaces a previously configured -list. +The sort criteria specifies the device net address as the column for the sort, whether +the sort is ascending or descending, and whether the sort is case sensitive. -By convention, an element of this type may be set nill to clear the list. **Attributes:** -|Name |Type |Description| -|-----|-----------|-----------| -|rule |List[rule] |rule | +|Name |Type |Description | +|------------------|-----|----------------| +|is_ascending |bool |isAscending | +|is_case_sensitive |bool |isCaseSensitive |
-## `ReplacementCommunicationBarringIncomingRuleList19sp1`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SortByDeviceType`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-A list of Communication Barring Incoming Rules that replaces a previously configured -list. +The sort criteria specifies the device type as the column for the sort, whether the +sort is ascending or descending, and whether the sort is case sensitive. -By convention, an element of this type may be set nill to clear the list. **Attributes:** -|Name |Type |Description| -|-----|-----------|-----------| -|rule |List[rule] |rule | +|Name |Type |Description | +|------------------|-----|----------------| +|is_ascending |bool |isAscending | +|is_case_sensitive |bool |isCaseSensitive |
-## `ReplacementCommunicationBarringOriginatingRuleList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SortByDn`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-A list of Communication Barring Originating Rules that replaces a previously -configured list. +The sort criteria specifies the DN as the column for the sort, whether the sort is +ascending or descending, and whether the sort is case sensitive. -By convention, an element of this type may be set nill to clear the list. **Attributes:** -|Name |Type |Description| -|-----|-----------|-----------| -|rule |List[rule] |rule | +|Name |Type |Description | +|------------------|-----|----------------| +|is_ascending |bool |isAscending | +|is_case_sensitive |bool |isCaseSensitive |
-## `ReplacementCommunicationBarringRedirectingRuleList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SortByDnActivated`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-A list of Communication Barring Redirecting Rules that replaces a previously -configured list. +The sort criteria specifies the dn activation status as the column for the sort, +whether the sort is ascending or descending, and whether the sort is case sensitive. -By convention, an element of this type may be set nill to clear the list. **Attributes:** -|Name |Type |Description| -|-----|-----------|-----------| -|rule |List[rule] |rule | +|Name |Type |Description | +|------------------|-----|----------------| +|is_ascending |bool |isAscending | +|is_case_sensitive |bool |isCaseSensitive |
-## `ReplacementContactList22`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SortByDnAvailable`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-A list of SIP contacts that replaces a previously configured list. +The sort criteria specifies the dn availability as the column for the sort, whether +the sort is ascending or descending, and whether the sort is case sensitive. -By convention, an element of this type may be set nill to clear the list. **Attributes:** -|Name |Type |Description| -|--------|--------------|-----------| -|contact |List[contact] |contact | +|Name |Type |Description | +|------------------|-----|----------------| +|is_ascending |bool |isAscending | +|is_case_sensitive |bool |isCaseSensitive |
-## `ReplacementCustomContactDirectoryEntryList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SortByEmailAddress`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-A list of userIds and/or Virtual On-Net user DNs that replaces a previously configured -list. +The sort criteria specifies the email as the column for the sort, whether the sort is +ascending or descending, and whether the sort is case sensitive. -By convention, an element of this type may be set nill to clear the list. **Attributes:** -|Name |Type |Description| -|------|------------|-----------| -|entry |List[entry] |entry | +|Name |Type |Description | +|------------------|-----|----------------| +|is_ascending |bool |isAscending | +|is_case_sensitive |bool |isCaseSensitive |
-## `ReplacementDeviceList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SortByEnabled`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-A list of devices that replaces a previously configured list. +The sort criteria specifies the Broadworks Enabled Flag as the column for the sort, +whether the sort is ascending or descending, and whether the sort is case sensitive. -By convention, an element of this type may be set nill to clear the list. **Attributes:** -|Name |Type |Description| -|-------|-------------|-----------| -|device |List[device] |device | +|Name |Type |Description | +|------------------|-----|----------------| +|is_ascending |bool |isAscending | +|is_case_sensitive |bool |isCaseSensitive |
-## `ReplacementEnterpriseEnterpriseTrunkTrunkGroupKeyList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SortByEnterpriseCommonPhoneListName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-A list of Enterprise Trunk Krunk Group Keys that replaces a previously configured -list. +The sort criteria specifies the enterprise common phone list name as the column for +the sort, whether sort is ascending or descending, and whether the sort is case +sensitive. -By convention, an element of this type may be set nill to clear the list. **Attributes:** -|Name |Type |Description| -|------------|-----------------|-----------| -|trunk_group |List[trunkGroup] |trunkGroup | +|Name |Type |Description | +|------------------|-----|----------------| +|is_ascending |bool |isAscending | +|is_case_sensitive |bool |isCaseSensitive |
-## `ReplacementEnterpriseTrunkTrunkGroupKeyList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SortByEnterpriseCommonPhoneListNumber`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-A list of Enterprise Trunk Krunk Group Keys that replaces a previously configured -list. +The sort criteria specifies the enterprise common phone list number as as the column +for the sort, whether sort is ascending or descending, and whether the sort is case +sensitive. -By convention, an element of this type may be set nill to clear the list. **Attributes:** -|Name |Type |Description | -|-----------------|---------------------|---------------| -|trunk_group_list |List[trunkGroupList] |trunkGroupList | +|Name |Type |Description | +|------------------|-----|----------------| +|is_ascending |bool |isAscending | +|is_case_sensitive |bool |isCaseSensitive |
-## `ReplacementGroupEnterpriseTrunkPriorityWeightedTrunkGroupList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SortByExtension`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-A list of enterprise trunk priority weighted trunk groups in a group that replaces a -previously configured list. +The sort criteria specifies the extension as the column for the sort, whether the sort +is ascending or descending, and whether the sort is case sensitive. -By convention, an element of this type may be set nill to clear the list. **Attributes:** -|Name |Type |Description| -|------------|-----------------|-----------| -|trunk_group |List[trunkGroup] |trunkGroup | +|Name |Type |Description | +|------------------|-----|----------------| +|is_ascending |bool |isAscending | +|is_case_sensitive |bool |isCaseSensitive |
-## `ScheduleEvents`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SortByForwardedToNumber`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Retrives all Holiday or Time Event details for a given schedulel Level. +The sort criteria specifies the forwarded to phone number as the column for the sort, +whether the sort is ascending or descending, and whether the sort is case sensitive. +This sort criteria data type is only intended to be used by the commands introduced by +BW-2301. The commands are `EnterpriseUserCallForwardingSettingsGetListRequest()` and +`GroupUserCallForwardingSettingsGetListRequest()`. The following Call Forwarding +services are compatible for this search: Call Forwarding Always, Call Forwarding +Always Secondary, Call Forwarding Busy, Call Forwarding No Answer, Call Forwarding Not +Reachable, Call Forwarding Selective. **Attributes:** -|Name |Type |Description | -|--------------|-----------|-----------------------| -|eventname |str |eventname | -|start_date |str |startDate | -|all_day_event |bool |allDayEvent *Optional* | -|start_time |startTime |startTime *Optional* | -|end_time |endTime |endTime *Optional* | -|end_date |str |endDate | -|recurrence |recurrence |recurrence *Optional* | +|Name |Type |Description | +|------------------|-----|----------------| +|is_ascending |bool |isAscending | +|is_case_sensitive |bool |isCaseSensitive |
-## `ScheduleGlobalKey`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SortByGroupCommonPhoneListName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Uniquely identifies Holiday and Time Schedules throughout all System, Service -Provider, Group and User level. +The sort criteria specifies the group common phone list name as the column for the +sort, whether the sort is ascending or descending, and whether the sort is case +sensitive. **Attributes:** -|Name |Type |Description | -|---------------|------------|--------------| -|schedule_key |scheduleKey |scheduleKey | -|schedule_level |str |scheduleLevel | +|Name |Type |Description | +|------------------|-----|----------------| +|is_ascending |bool |isAscending | +|is_case_sensitive |bool |isCaseSensitive |
-## `SearchCriteriaComposedOrDnExtension`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SortByGroupCommonPhoneListNumber`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a DN OR an extension. +The sort criteria specifies the group common phone list number as the column for the +sort, whether sort is ascending or descending, and whether the sort is case sensitive. -Note: For this search criterion, the searchMode is always ‘Contains’ and the search -criteria are always OR’ed. **Attributes:** -|Name |Type |Description| -|------|------|-----------| -|value |value |value | +|Name |Type |Description | +|------------------|-----|----------------| +|is_ascending |bool |isAscending | +|is_case_sensitive |bool |isCaseSensitive |
-## `SearchCriteriaExactCallCenterReportTemplateKey`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SortByGroupId`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a particular call center enhanced reporting report -template. +The sort criteria specifies the group id as the column for the sort, whether the sort +is ascending or descending, and whether the sort is case sensitive. **Attributes:** -|Name |Type |Description | -|----------------|---------------|---------------| -|report_template |reportTemplate |reportTemplate | +|Name |Type |Description | +|------------------|-----|----------------| +|is_ascending |bool |isAscending | +|is_case_sensitive |bool |isCaseSensitive |
-## `SearchCriteriaExactDnDepartment`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SortByGroupLocationCode`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a particular fully specified DN's department. +The sort criteria specifies the group location code as the column for the sort, +whether the sort is ascending or descending, and whether the sort is case sensitive. **Attributes:** -|Name |Type |Description | -|---------------|--------------|--------------| -|department_key |departmentKey |departmentKey | +|Name |Type |Description | +|------------------|-----|----------------| +|is_ascending |bool |isAscending | +|is_case_sensitive |bool |isCaseSensitive |
-## `SearchCriteriaExactUserDepartment`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SortByGroupName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Criteria for searching for a particular fully specified user's department. +The sort criteria specifies the group name as the column for the sort, whether the +sort is ascending or descending, and whether the sort is case sensitive. **Attributes:** -|Name |Type |Description | -|---------------|--------------|--------------| -|department_key |departmentKey |departmentKey | +|Name |Type |Description | +|------------------|-----|----------------| +|is_ascending |bool |isAscending | +|is_case_sensitive |bool |isCaseSensitive |
-## `SelectiveCallRejectionCriteriaCallTypeModify`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SortByHuntPolicy`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The call type criteria used within a modify request. +The sort criteria specifies the call center hunt policy as the column for the sort, +whether the sort is ascending or descending, and whether the sort is case sensitive. **Attributes:** -|Name |Type |Description | -|----------------------------|----------------|-------------------------------------| -|from_dn_criteria_selection |str |fromDnCriteriaSelection *Optional* | -|include_anonymous_callers |bool |includeAnonymousCallers *Optional* | -|include_unavailable_callers |bool |includeUnavailableCallers *Optional* | -|phone_number_list |phoneNumberList |phoneNumberList *Optional* | +|Name |Type |Description | +|------------------|-----|----------------| +|is_ascending |bool |isAscending | +|is_case_sensitive |bool |isCaseSensitive |
-## `ServiceInstanceAddProfile`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SortByImpId`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Service Profile Information for group service. +The sort criteria specifies the imp id as the column for the sort, whether the sort is +ascending or descending, and whether the sort is case sensitive. **Attributes:** -|Name |Type |Description | -|-----------------------------|-----------|------------------------------------| -|name |str |name | -|calling_line_id_last_name |str |callingLineIdLastName | -|calling_line_id_first_name |str |callingLineIdFirstName | -|hiragana_last_name |str |hiraganaLastName *Optional* | -|hiragana_first_name |str |hiraganaFirstName *Optional* | -|phone_number |str |phoneNumber *Optional* | -|extension |str |extension *Optional* | -|password |str |password *Optional* | -|department |department |department *Optional* | -|language |str |language *Optional* | -|time_zone |str |timeZone *Optional* | -|alias |List[str] |alias *Optional* | -|public_user_identity |str |publicUserIdentity *Optional* | -|calling_line_id_phone_number |str |callingLineIdPhoneNumber *Optional* | +|Name |Type |Description | +|------------------|-----|----------------| +|is_ascending |bool |isAscending | +|is_case_sensitive |bool |isCaseSensitive |
-## `ServiceInstanceAddProfileCallCenter`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SortByLocation`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Service Profile Information for a call center. +The sort criteria specifies the Broadworks Location as the column for the sort, +whether the sort is ascending or descending, and whether the sort is case sensitive. -Password is required. **Attributes:** -|Name |Type |Description | -|-----------------------------|-----------|------------------------------------| -|name |str |name | -|calling_line_id_last_name |str |callingLineIdLastName | -|calling_line_id_first_name |str |callingLineIdFirstName | -|hiragana_last_name |str |hiraganaLastName *Optional* | -|hiragana_first_name |str |hiraganaFirstName *Optional* | -|phone_number |str |phoneNumber *Optional* | -|extension |str |extension *Optional* | -|password |str |password | -|department |department |department *Optional* | -|language |str |language *Optional* | -|time_zone |str |timeZone *Optional* | -|alias |List[str] |alias *Optional* | -|public_user_identity |str |publicUserIdentity *Optional* | -|calling_line_id_phone_number |str |callingLineIdPhoneNumber *Optional* | +|Name |Type |Description | +|------------------|-----|----------------| +|is_ascending |bool |isAscending | +|is_case_sensitive |bool |isCaseSensitive |
-## `ServiceInstanceAddProfileFlexibleSeatingHost`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SortByMobileDirectoryNumber`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Service Profile Information for a flexible seating host. +The sort criteria specifies the Mobile dn availability as the column for the sort, +whether the sort is ascending or descending, and whether the sort is case sensitive. **Attributes:** -|Name |Type |Description | -|-----------------------------|-----------|------------------------------------| -|name |str |name | -|calling_line_id_last_name |str |callingLineIdLastName | -|calling_line_id_first_name |str |callingLineIdFirstName | -|hiragana_last_name |str |hiraganaLastName *Optional* | -|hiragana_first_name |str |hiraganaFirstName *Optional* | -|phone_number |str |phoneNumber *Optional* | -|extension |str |extension *Optional* | -|password |str |password *Optional* | -|department |department |department *Optional* | -|language |str |language *Optional* | -|time_zone |str |timeZone *Optional* | -|calling_line_id_phone_number |str |callingLineIdPhoneNumber *Optional* | +|Name |Type |Description | +|------------------|-----|----------------| +|is_ascending |bool |isAscending | +|is_case_sensitive |bool |isCaseSensitive |
-## `ServiceInstanceAddProfileTrunkGroup`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SortByMobilePhoneNumber`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Service Profile Information for a trunk group. +The sort criteria specifies the mobile phone number as the column for the sort, +whether the sort is ascending or descending, and whether the sort is case sensitive. -The publicUserIdentity element is not part of ServiceInstanceAddProfileTrunkGroup. **Attributes:** -|Name |Type |Description | -|-----------------------------|-----------|------------------------------------| -|name |str |name | -|calling_line_id_last_name |str |callingLineIdLastName | -|calling_line_id_first_name |str |callingLineIdFirstName | -|hiragana_last_name |str |hiraganaLastName *Optional* | -|hiragana_first_name |str |hiraganaFirstName *Optional* | -|phone_number |str |phoneNumber *Optional* | -|extension |str |extension *Optional* | -|password |str |password *Optional* | -|department |department |department *Optional* | -|language |str |language *Optional* | -|time_zone |str |timeZone *Optional* | -|alias |List[str] |alias *Optional* | -|calling_line_id_phone_number |str |callingLineIdPhoneNumber *Optional* | +|Name |Type |Description | +|------------------|-----|----------------| +|is_ascending |bool |isAscending | +|is_case_sensitive |bool |isCaseSensitive |
-## `ServiceInstanceModifyProfile`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SortByReceptionistNote`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Service Profile Information for group service used when modifying an existing service -instance. +The sort criteria specifies the Receptionist Notes as the column for the sort, whether +the sort is ascending or descending, and whether the sort is case sensitive. **Attributes:** -|Name |Type |Description | -|-----------------------------|-------------|------------------------------------| -|name |str |name *Optional* | -|calling_line_id_last_name |str |callingLineIdLastName *Optional* | -|calling_line_id_first_name |str |callingLineIdFirstName *Optional* | -|hiragana_last_name |str |hiraganaLastName *Optional* | -|hiragana_first_name |str |hiraganaFirstName *Optional* | -|phone_number |str |phoneNumber *Optional* | -|extension |str |extension *Optional* | -|password |str |password *Optional* | -|department |department |department *Optional* | -|language |str |language *Optional* | -|time_zone |str |timeZone *Optional* | -|sip_alias_list |sipAliasList |sipAliasList *Optional* | -|public_user_identity |str |publicUserIdentity *Optional* | -|calling_line_id_phone_number |str |callingLineIdPhoneNumber *Optional* | +|Name |Type |Description | +|------------------|-----|----------------| +|is_ascending |bool |isAscending | +|is_case_sensitive |bool |isCaseSensitive |
-## `ServiceInstanceModifyProfileFlexibleSeatingHost`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SortByScheduleName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Service Profile Information for a flexible seating host +The sort criteria specifies the schedule name as the column for the sort, whether the +sort is ascending or descending, and whether the sort is case sensitive. + **Attributes:** -|Name |Type |Description | -|-----------------------------|-----------|------------------------------------| -|name |str |name *Optional* | -|calling_line_id_last_name |str |callingLineIdLastName *Optional* | -|calling_line_id_first_name |str |callingLineIdFirstName *Optional* | -|hiragana_last_name |str |hiraganaLastName *Optional* | -|hiragana_first_name |str |hiraganaFirstName *Optional* | -|phone_number |str |phoneNumber *Optional* | -|extension |str |extension *Optional* | -|password |str |password *Optional* | -|department |department |department *Optional* | -|language |str |language *Optional* | -|time_zone |str |timeZone *Optional* | -|calling_line_id_phone_number |str |callingLineIdPhoneNumber *Optional* | +|Name |Type |Description | +|------------------|-----|----------------| +|is_ascending |bool |isAscending | +|is_case_sensitive |bool |isCaseSensitive | +
+ + +## `SortByServiceProviderId`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) + +
+The sort criteria specifies the service provider id as the column for the sort, +whether the sort is ascending or descending, and whether the sort is case sensitive. + + +**Attributes:** + +|Name |Type |Description | +|------------------|-----|----------------| +|is_ascending |bool |isAscending | +|is_case_sensitive |bool |isCaseSensitive |
-## `ServiceInstanceModifyProfileTrunkGroup`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SortByServiceProviderName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Service Profile Information for a trunk group used when modifying an existing service -instance. +The sort criteria specifies the service provider name as the column for the sort, +whether the sort is ascending or descending, and whether the sort is case sensitive. **Attributes:** -|Name |Type |Description | -|---------------------------|-------------|----------------------------------| -|name |str |name *Optional* | -|calling_line_id_last_name |str |callingLineIdLastName *Optional* | -|calling_line_id_first_name |str |callingLineIdFirstName *Optional* | -|hiragana_last_name |str |hiraganaLastName *Optional* | -|hiragana_first_name |str |hiraganaFirstName *Optional* | -|phone_number |str |phoneNumber *Optional* | -|extension |str |extension *Optional* | -|password |str |password *Optional* | -|department |department |department *Optional* | -|language |str |language *Optional* | -|time_zone |str |timeZone *Optional* | -|sip_alias_list |sipAliasList |sipAliasList *Optional* | +|Name |Type |Description | +|------------------|-----|----------------| +|is_ascending |bool |isAscending | +|is_case_sensitive |bool |isCaseSensitive |
-## `ServiceInstanceReadProfile`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SortByServiceStatus`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Service Profile Information for group service. +The sort criteria specifies the service status as the column for the sort, whether the +sort is ascending or descending, and whether the sort is case sensitive. -It is identical to the ServiceInstanceAddProfile, but without the password. Prior to -release 14 this was called ServiceInstanceProfile. +This sort criteria data type is only intended to be used by the commands introduced by +BW-2301. The commands are `EnterpriseUserCallWaitingSettingsGetListRequest()`, +`GroupUserCallWaitingSettingsGetListRequest()`, +`EnterpriseUserHotelingGuestSettingsGetListRequest()`, and +`GroupUserHotelingGuestSettingsGetListRequest()`. **Attributes:** -|Name |Type |Description | -|---------------------------|-----------|-------------------------------| -|name |str |name | -|calling_line_id_last_name |str |callingLineIdLastName | -|calling_line_id_first_name |str |callingLineIdFirstName | -|hiragana_last_name |str |hiraganaLastName *Optional* | -|hiragana_first_name |str |hiraganaFirstName *Optional* | -|phone_number |str |phoneNumber *Optional* | -|extension |str |extension *Optional* | -|department |department |department *Optional* | -|language |str |language *Optional* | -|time_zone |str |timeZone *Optional* | -|time_zone_display_name |str |timeZoneDisplayName *Optional* | -|alias |List[str] |alias *Optional* | -|public_user_identity |str |publicUserIdentity *Optional* | +|Name |Type |Description | +|------------------|-----|----------------| +|is_ascending |bool |isAscending | +|is_case_sensitive |bool |isCaseSensitive |
-## `ServiceInstanceReadProfile17`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SortByTrunkGroupName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Service Profile Information for group service. +The sort criteria specifies the trunk group name as the column for the sort, whether +the sort is ascending or descending, and whether the sort is case sensitive. -It is identical to the ServiceInstanceAddProfile, but without the password. Replaced -by: ServiceInstanceReadProfile17sp4 **Attributes:** -|Name |Type |Description | -|---------------------------|-----------|-------------------------------| -|name |str |name | -|calling_line_id_last_name |str |callingLineIdLastName | -|calling_line_id_first_name |str |callingLineIdFirstName | -|hiragana_last_name |str |hiraganaLastName *Optional* | -|hiragana_first_name |str |hiraganaFirstName *Optional* | -|phone_number |str |phoneNumber *Optional* | -|extension |str |extension *Optional* | -|department |department |department *Optional* | -|language |str |language *Optional* | -|time_zone |str |timeZone *Optional* | -|time_zone_display_name |str |timeZoneDisplayName *Optional* | -|alias |List[str] |alias *Optional* | -|public_user_identity |str |publicUserIdentity *Optional* | +|Name |Type |Description | +|------------------|-----|----------------| +|is_ascending |bool |isAscending | +|is_case_sensitive |bool |isCaseSensitive |
-## `ServiceInstanceReadProfile17sp4`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SortByUserDepartment`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Service Profile Information for group service. +The sort criteria specifies the user department name as the column for the sort, +whether the sort is ascending or descending, and whether the sort is case sensitive. -Replaced by: ServiceInstanceReadProfile19sp1 **Attributes:** -|Name |Type |Description | -|---------------------------|-----------|-------------------------------| -|name |str |name | -|calling_line_id_last_name |str |callingLineIdLastName | -|calling_line_id_first_name |str |callingLineIdFirstName | -|hiragana_last_name |str |hiraganaLastName *Optional* | -|hiragana_first_name |str |hiraganaFirstName *Optional* | -|phone_number |str |phoneNumber *Optional* | -|extension |str |extension *Optional* | -|country_code |str |countryCode *Optional* | -|national_prefix |str |nationalPrefix *Optional* | -|department |department |department *Optional* | -|language |str |language *Optional* | -|time_zone |str |timeZone *Optional* | -|time_zone_display_name |str |timeZoneDisplayName *Optional* | -|alias |List[str] |alias *Optional* | -|public_user_identity |str |publicUserIdentity *Optional* | +|Name |Type |Description | +|------------------|-----|----------------| +|is_ascending |bool |isAscending | +|is_case_sensitive |bool |isCaseSensitive |
-## `ServiceInstanceReadProfile19sp1`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SortByUserFirstName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Service Profile Information for group service. +The sort criteria specifies the user first name as the column for the sort, whether +the sort is ascending or descending, and whether the sort is case sensitive. -The callingLineIdPhoneNumber is no longer being formatted for display purpose. The -value is returned exactly the same as being stored. **Attributes:** -|Name |Type |Description | -|-----------------------------|-----------|------------------------------------| -|name |str |name | -|calling_line_id_last_name |str |callingLineIdLastName | -|calling_line_id_first_name |str |callingLineIdFirstName | -|hiragana_last_name |str |hiraganaLastName *Optional* | -|hiragana_first_name |str |hiraganaFirstName *Optional* | -|phone_number |str |phoneNumber *Optional* | -|extension |str |extension *Optional* | -|country_code |str |countryCode *Optional* | -|national_prefix |str |nationalPrefix *Optional* | -|department |department |department *Optional* | -|language |str |language *Optional* | -|time_zone |str |timeZone *Optional* | -|time_zone_display_name |str |timeZoneDisplayName *Optional* | -|alias |List[str] |alias *Optional* | -|public_user_identity |str |publicUserIdentity *Optional* | -|calling_line_id_phone_number |str |callingLineIdPhoneNumber *Optional* | +|Name |Type |Description | +|------------------|-----|----------------| +|is_ascending |bool |isAscending | +|is_case_sensitive |bool |isCaseSensitive |
-## `ServicePack`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SortByUserId`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The common Service Pack elements. +The sort criteria specifies the user id as the column for the sort, whether the sort +is ascending or descending, and whether the sort is case sensitive. **Attributes:** -|Name |Type |Description | -|-------------------------|--------------------|----------------------------------| -|service_pack_name |str |servicePackName | -|service_pack_description |str |servicePackDescription *Optional* | -|is_available_for_use |bool |isAvailableForUse | -|service_pack_quantity |servicePackQuantity |servicePackQuantity | -|service_name |List[str] |serviceName *Optional* | +|Name |Type |Description | +|------------------|-----|----------------| +|is_ascending |bool |isAscending | +|is_case_sensitive |bool |isCaseSensitive |
-## `ServicePackAuthorization`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SortByUserLastName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Authorize (with quantity) or unauthorize a service pack. +The sort criteria specifies the user last name as the column for the sort, whether the +sort is ascending or descending, and whether the sort is case sensitive. **Attributes:** -|Name |Type |Description | -|--------------------|-------------------|------------------------------| -|service_pack_name |str |servicePackName | -|authorized_quantity |authorizedQuantity |authorizedQuantity *Optional* | -|unauthorized |bool |unauthorized *Optional* | +|Name |Type |Description | +|------------------|-----|----------------| +|is_ascending |bool |isAscending | +|is_case_sensitive |bool |isCaseSensitive |
-## `ServiceProviderCommunicationBarringProfileGetResponse19sp1V2`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SortByUserPersonalPhoneListName`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Response to the ServiceProviderCommunicationBarringProfileGetRequest19sp1V2. +The sort criteria specifies the user personal phone list name as the column for the +sort, whether sort is ascending or descending, and whether the sort is case sensitive. -The response contains the Communication Barring Profile information. The incoming, -originating, redirecting and call me now rules are returned in ascending priority -order. The following elements are only used in AS data mode: callMeNowDefaultAction -callMeNowDefaultCallTimeout callMeNowRule applyToAttendedCallTransfers **Attributes:** -|Name |Type |Description | -|------------------------------------|----------------------|--------------------------------------------| -|description |str |description *Optional* | -|originating_default_action |str |originatingDefaultAction | -|originating_default_treatment_id |str |originatingDefaultTreatmentId *Optional* | -|originating_default_transfer_number |str |originatingDefaultTransferNumber *Optional* | -|originating_default_call_timeout |int |originatingDefaultCallTimeout *Optional* | -|originating_rule |List[originatingRule] |originatingRule *Optional* | -|redirecting_default_action |str |redirectingDefaultAction | -|redirecting_default_call_timeout |int |redirectingDefaultCallTimeout *Optional* | -|redirecting_rule |List[redirectingRule] |redirectingRule *Optional* | -|call_me_now_default_action |str |callMeNowDefaultAction | -|call_me_now_default_call_timeout |int |callMeNowDefaultCallTimeout *Optional* | -|call_me_now_rule |List[callMeNowRule] |callMeNowRule *Optional* | -|incoming_default_action |str |incomingDefaultAction | -|incoming_default_call_timeout |int |incomingDefaultCallTimeout *Optional* | -|incoming_rule |List[incomingRule] |incomingRule *Optional* | -|is_default |bool |isDefault | -|apply_to_attended_call_transfers |bool |applyToAttendedCallTransfers | +|Name |Type |Description | +|------------------|-----|----------------| +|is_ascending |bool |isAscending | +|is_case_sensitive |bool |isCaseSensitive |
-## `ServiceProviderReplacementCommunicationBarringHierarchicalCallMeNowRuleList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SortByUserPersonalPhoneListNumber`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-A list of Service Provider Communication Barring Hierarchical Call Me Now Rules that -replaces a previously configured list. +The sort criteria specifies the user personal phone list number as the column for the +sort, whether the sort is ascending or descending, and whether the sort is case +sensitive. -By convention, an element of this type may be set nill to clear the list. **Attributes:** -|Name |Type |Description| -|-----|-----------|-----------| -|rule |List[rule] |rule | +|Name |Type |Description | +|------------------|-----|----------------| +|is_ascending |bool |isAscending | +|is_case_sensitive |bool |isCaseSensitive |
-## `ServiceProviderReplacementCommunicationBarringHierarchicalOriginatingRuleList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SortByYahooId`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-A list of Service Provider Communication Barring Hierarchical Originating Rules that -replaces a previously configured list. +The sort criteria specifies the yahoo id as the column for the sort, whether the sort +is ascending or descending, and whether the sort is case sensitive. -By convention, an element of this type may be set nill to clear the list. **Attributes:** -|Name |Type |Description| -|-----|-----------|-----------| -|rule |List[rule] |rule | +|Name |Type |Description | +|------------------|-----|----------------| +|is_ascending |bool |isAscending | +|is_case_sensitive |bool |isCaseSensitive |
-## `ServiceProviderReplacementCommunicationBarringHierarchicalRedirectingRuleList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SystemCollaborateGetResponse20sp1V2`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-A list of Service Provider Communication Barring Hierarchical Redirecting Rules that -replaces a previously configured list. +Response to SystemCollaborateGetRequest20sp1V2. -By convention, an element of this type may be set nill to clear the list. **Attributes:** -|Name |Type |Description| -|-----|-----------|-----------| -|rule |List[rule] |rule | +|Name |Type |Description | +|---------------------------------------------------|-----------------------|----------------------------------------------| +|collaborate_room_id_length |int |collaborateRoomIdLength | +|instant_room_idle_timeout_seconds |int |instantRoomIdleTimeoutSeconds | +|collaborate_room_maximum_duration_minutes |int |collaborateRoomMaximumDurationMinutes | +|support_outdial |bool |supportOutdial | +|max_collaborate_room_participants |int |maxCollaborateRoomParticipants | +|collaborate_active_talker_refresh_interval_seconds |int |collaborateActiveTalkerRefreshIntervalSeconds | +|terminate_collaborate_after_grace_period |bool |terminateCollaborateAfterGracePeriod | +|collaborate_grace_period |collaborateGracePeriod |collaborateGracePeriod | +|enable_active_collaborate_notification |bool |enableActiveCollaborateNotification | +|collaborate_from_address |str |collaborateFromAddress *Optional* |
-## `ShInterfaceUserIdDataEntry`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SystemCollaborateModifyRequest20sp1V2`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-ShInterface User Id Data Entry. +Modify the system level data associated with collaborate services. +The response is either a `SuccessResponse()` or an `ErrorResponse()`. **Attributes:** -|Name |Type |Description | -|---------------------|-------------------|---------------------| -|user_type |str |userType | -|public_user_identity |publicUserIdentity |publicUserIdentity | -|endpoint_type |str |endpointType | -|scscf_name |str |SCSCFName *Optional* | -|ims_user_state |str |IMSUserState | +|Name |Type |Description | +|---------------------------------------------------|-----------------------|---------------------------------------------------------| +|collaborate_room_id_length |int |collaborateRoomIdLength *Optional* | +|instant_room_idle_timeout_seconds |int |instantRoomIdleTimeoutSeconds *Optional* | +|collaborate_room_maximum_duration_minutes |int |collaborateRoomMaximumDurationMinutes *Optional* | +|support_outdial |bool |supportOutdial *Optional* | +|max_collaborate_room_participants |int |maxCollaborateRoomParticipants *Optional* | +|collaborate_active_talker_refresh_interval_seconds |int |collaborateActiveTalkerRefreshIntervalSeconds *Optional* | +|terminate_collaborate_after_grace_period |bool |terminateCollaborateAfterGracePeriod *Optional* | +|collaborate_grace_period |collaborateGracePeriod |collaborateGracePeriod *Optional* | +|enable_active_collaborate_notification |bool |enableActiveCollaborateNotification *Optional* | +|collaborate_from_address |str |collaborateFromAddress *Optional* |
-## `ShInterfaceUserIdDataEntry21sp1`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SystemCommunicationBarringProfileGetResponse19sp1V2`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-ShInterface User Id Data Entry. +Response to the SystemCommunicationBarringProfileGetRequest19sp1V2. +The response contains the Communication Barring Profile information. The incoming +rules are returned in ascending priority order. The following elements are only used +in AS data mode: callMeNowDefaultAction callMeNowDefaultCallTimeout callMeNowRule +applyToAttendedCallTransfers **Attributes:** -|Name |Type |Description | -|---------------------|-------------------|---------------------| -|user_type |str |userType | -|public_user_identity |publicUserIdentity |publicUserIdentity | -|endpoint_type |str |endpointType | -|scscf_name |str |SCSCFName *Optional* | -|ims_user_state |str |IMSUserState | +|Name |Type |Description | +|------------------------------------|----------------------|--------------------------------------------| +|description |str |description *Optional* | +|originating_default_action |str |originatingDefaultAction | +|originating_default_treatment_id |str |originatingDefaultTreatmentId *Optional* | +|originating_default_transfer_number |str |originatingDefaultTransferNumber *Optional* | +|originating_default_call_timeout |int |originatingDefaultCallTimeout *Optional* | +|originating_rule |List[originatingRule] |originatingRule *Optional* | +|redirecting_default_action |str |redirectingDefaultAction | +|redirecting_default_call_timeout |int |redirectingDefaultCallTimeout *Optional* | +|redirecting_rule |List[redirectingRule] |redirectingRule *Optional* | +|incoming_default_action |str |incomingDefaultAction | +|incoming_default_call_timeout |int |incomingDefaultCallTimeout *Optional* | +|incoming_rule |List[incomingRule] |incomingRule *Optional* | +|call_me_now_default_action |str |callMeNowDefaultAction | +|call_me_now_default_call_timeout |int |callMeNowDefaultCallTimeout *Optional* | +|call_me_now_rule |List[callMeNowRule] |callMeNowRule *Optional* | +|apply_to_attended_call_transfers |bool |applyToAttendedCallTransfers |
-## `ShInterfaceUserListEntry`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `TreeDeviceInfo`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-ShInterface User List Entry. +Information related to a tree device. +A tree device is a device associated with a device type that has the option +supportLinks set to "Support Links from Devices". Many leaf devices can link to it. +When a tree device is created, it is assigned a system-wide unique linkId. **Attributes:** -|Name |Type |Description | -|---------------------|-------------------|---------------------| -|user_id |str |userId | -|user_type |str |userType | -|public_user_identity |publicUserIdentity |publicUserIdentity | -|endpoint_type |str |endpointType | -|scscf_name |str |SCSCFName *Optional* | -|ims_user_state |str |IMSUserState | +|Name |Type |Description | +|----------------|--------------|--------------| +|tree_device_key |treeDeviceKey |treeDeviceKey | +|link_id |str |linkId |
-## `ShInterfaceUserListEntry21sp1`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `TrunkAddressingAdd`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-ShInterface User List Entry. +Trunk group endpoint. **Attributes:** -|Name |Type |Description | -|---------------------|-------------------|---------------------| -|user_id |str |userId | -|user_type |str |userType | -|public_user_identity |publicUserIdentity |publicUserIdentity | -|endpoint_type |str |endpointType | -|scscf_name |str |SCSCFName *Optional* | -|ims_user_state |str |IMSUserState | +|Name |Type |Description | +|----------------------------|-------------------------|------------------------------------| +|trunk_group_device_endpoint |trunkGroupDeviceEndpoint |trunkGroupDeviceEndpoint *Optional* | +|enterprise_trunk_name |str |enterpriseTrunkName *Optional* | +|alternate_trunk_identity |str |alternateTrunkIdentity *Optional* |
-## `SimultaneousRingReplacementNumberList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `TrunkAddressingModify`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-A list of Simultaneous Ring numbers that replaces a previously configured list. +Trunk group endpoint. -By convention, an element of this type may be set nill to clear the list. **Attributes:** -|Name |Type |Description | -|-------------------------|-----------------------------|-----------------------| -|simultaneous_ring_number |List[simultaneousRingNumber] |simultaneousRingNumber | +|Name |Type |Description | +|----------------------------|-------------------------|------------------------------------| +|trunk_group_device_endpoint |trunkGroupDeviceEndpoint |trunkGroupDeviceEndpoint *Optional* | +|enterprise_trunk_name |str |enterpriseTrunkName *Optional* | +|alternate_trunk_identity |str |alternateTrunkIdentity *Optional* |
-## `SortOrderEnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAssignmentPagedSortedList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `TrunkAddressingMultipleContactAdd`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Used to sort the -`SortOrderEnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAssignmentPagedSortedListRequest()`. +Trunk group endpoint that can have multiple contacts. +alternateTrunkIdentityDomain is only used in XS mode and the AS when deployed in IMS +mode. Both alternateTrunkIdentity and AlternateTrunkIdentityDomain should be set at +the same time if one is set in XS mode. The following elements are only used in AS +data mode and are ignored in XS data mode: physicalLocation **Attributes:** -|Name |Type |Description | -|--------------------------------|----------------------------|---------------------------------------| -|sort_by_mobile_directory_number |sortByMobileDirectoryNumber |sortByMobileDirectoryNumber *Optional* | -|sort_by_dn |sortByDn |sortByDn *Optional* | -|sort_by_department_name |sortByDepartmentName |sortByDepartmentName *Optional* | -|sort_by_user_id |sortByUserId |sortByUserId *Optional* | -|sort_by_user_first_name |sortByUserFirstName |sortByUserFirstName *Optional* | -|sort_by_user_last_name |sortByUserLastName |sortByUserLastName *Optional* | -|sort_by_extension |sortByExtension |sortByExtension *Optional* | -|sort_by_dn_available |sortByDnAvailable |sortByDnAvailable *Optional* | +|Name |Type |Description | +|--------------------------------|-------------------------|----------------------------------------| +|trunk_group_device_endpoint |trunkGroupDeviceEndpoint |trunkGroupDeviceEndpoint *Optional* | +|enterprise_trunk_name |str |enterpriseTrunkName *Optional* | +|alternate_trunk_identity |str |alternateTrunkIdentity *Optional* | +|alternate_trunk_identity_domain |str |alternateTrunkIdentityDomain *Optional* | +|physical_location |str |physicalLocation *Optional* |
-## `SortOrderEnterpriseCallCenterAgentThresholdProfileGetAvailableAgentPagedSortedList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `TrunkAddressingMultipleContactRead`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Used to sort the -`EnterpriseCallCenterAgentThresholdProfileGetAvailableAgentPagedSortedListRequest()` -request. +Trunk group endpoint that can have multiple contacts. +Replaced by: TrunkAddressingMultipleContactRead21 **Attributes:** -|Name |Type |Description | -|--------------------------------|----------------------------|---------------------------------------| -|sort_by_user_id |sortByUserId |sortByUserId *Optional* | -|sort_by_user_last_name |sortByUserLastName |sortByUserLastName *Optional* | -|sort_by_user_first_name |sortByUserFirstName |sortByUserFirstName *Optional* | -|sort_by_dn |sortByDn |sortByDn *Optional* | -|sort_by_extension |sortByExtension |sortByExtension *Optional* | -|sort_by_department_name |sortByDepartmentName |sortByDepartmentName *Optional* | -|sort_by_email_address |sortByEmailAddress |sortByEmailAddress *Optional* | -|sort_by_agent_threshold_profile |sortByAgentThresholdProfile |sortByAgentThresholdProfile *Optional* | +|Name |Type |Description | +|----------------------------|-------------------------|------------------------------------| +|trunk_group_device_endpoint |trunkGroupDeviceEndpoint |trunkGroupDeviceEndpoint *Optional* | +|enterprise_trunk_name |str |enterpriseTrunkName *Optional* | +|alternate_trunk_identity |str |alternateTrunkIdentity *Optional* |
-## `SortOrderEnterpriseCallCenterAgentThresholdProfileGetPagedSorted`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `TrunkAddressingMultipleContactRead21`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Used to sort the `EnterpriseCallCenterAgentThresholdProfileGetPagedSortedRequest()` -request. +Trunk group endpoint that can have multiple contacts. +alternateTrunkIdentityDomain is only used in XS mode and the AS when deployed in IMS +mode. The following elements are only used in AS data mode and ignored in XS data +mode: alternateTrunkIdentityDomain **Attributes:** -|Name |Type |Description | -|------------------------|---------------------|--------------------------------| -|sort_by_user_id |sortByUserId |sortByUserId *Optional* | -|sort_by_user_last_name |sortByUserLastName |sortByUserLastName *Optional* | -|sort_by_user_first_name |sortByUserFirstName |sortByUserFirstName *Optional* | -|sort_by_dn |sortByDn |sortByDn *Optional* | -|sort_by_extension |sortByExtension |sortByExtension *Optional* | -|sort_by_department_name |sortByDepartmentName |sortByDepartmentName *Optional* | -|sort_by_email_address |sortByEmailAddress |sortByEmailAddress *Optional* | +|Name |Type |Description | +|--------------------------------|-------------------------|----------------------------------------| +|trunk_group_device_endpoint |trunkGroupDeviceEndpoint |trunkGroupDeviceEndpoint *Optional* | +|enterprise_trunk_name |str |enterpriseTrunkName *Optional* | +|alternate_trunk_identity |str |alternateTrunkIdentity *Optional* | +|alternate_trunk_identity_domain |str |alternateTrunkIdentityDomain *Optional* |
-## `SortOrderEnterprisePhoneDirectoryGetPagedSortedList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `TrunkAddressingMultipleContactRead21sp1`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Used to sort the `EnterprisePhoneDirectoryGetPagedSortedListRequest()` request. +Trunk group endpoint that can have multiple contacts. +alternateTrunkIdentityDomain is only used in XS mode and the AS when deployed in IMS +mode. The following elements are only used in AS data mode and are ignored in XS data +mode: physicalLocation **Attributes:** -|Name |Type |Description | -|----------------------------|------------------------|-----------------------------------| -|sort_by_user_last_name |sortByUserLastName |sortByUserLastName *Optional* | -|sort_by_user_first_name |sortByUserFirstName |sortByUserFirstName *Optional* | -|sort_by_group_location_code |sortByGroupLocationCode |sortByGroupLocationCode *Optional* | -|sort_by_mobile_phone_number |sortByMobilePhoneNumber |sortByMobilePhoneNumber *Optional* | -|sort_by_email_address |sortByEmailAddress |sortByEmailAddress *Optional* | -|sort_by_department_name |sortByDepartmentName |sortByDepartmentName *Optional* | -|sort_by_group_name |sortByGroupName |sortByGroupName *Optional* | -|sort_by_yahoo_id |sortByYahooId |sortByYahooId *Optional* | -|sort_by_user_id |sortByUserId |sortByUserId *Optional* | -|sort_by_imp_id |sortByImpId |sortByImpId *Optional* | +|Name |Type |Description | +|--------------------------------|-------------------------|----------------------------------------| +|trunk_group_device_endpoint |trunkGroupDeviceEndpoint |trunkGroupDeviceEndpoint *Optional* | +|enterprise_trunk_name |str |enterpriseTrunkName *Optional* | +|alternate_trunk_identity |str |alternateTrunkIdentity *Optional* | +|alternate_trunk_identity_domain |str |alternateTrunkIdentityDomain *Optional* | +|physical_location |str |physicalLocation *Optional* |
-## `SortOrderGroupAccessDeviceGetPagedSortedList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `TrunkAddressingRead`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Used to sort the `GroupAccessDeviceGetPagedSortedListRequest()` request. +Trunk group endpoint. **Attributes:** -|Name |Type |Description | -|---------------------------|-----------------------|----------------------------------| -|sort_by_device_name |sortByDeviceName |sortByDeviceName *Optional* | -|sort_by_device_type |sortByDeviceType |sortByDeviceType *Optional* | -|sort_by_device_net_address |sortByDeviceNetAddress |sortByDeviceNetAddress *Optional* | -|sort_by_device_mac_address |sortByDeviceMACAddress |sortByDeviceMACAddress *Optional* | +|Name |Type |Description | +|----------------------------|-------------------------|------------------------------------| +|trunk_group_device_endpoint |trunkGroupDeviceEndpoint |trunkGroupDeviceEndpoint *Optional* | +|enterprise_trunk_name |str |enterpriseTrunkName *Optional* | +|alternate_trunk_identity |str |alternateTrunkIdentity *Optional* |
-## `SortOrderGroupAdminGetPagedSortedList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `TrunkGroupDeviceMultipleContactEndpointAdd22`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Used to sort the `GroupAdminGetPagedSortedListRequest()` request. +Trunk group device endpoint used in the context of modify that can have multiple +contacts. **Attributes:** -|Name |Type |Description | -|-------------------------|---------------------|--------------------------------| -|sort_by_admin_id |sortByAdminId |sortByAdminId *Optional* | -|sort_by_admin_last_name |sortByAdminLastName |sortByAdminLastName *Optional* | -|sort_by_admin_first_name |sortByAdminFirstName |sortByAdminFirstName *Optional* | +|Name |Type |Description | +|----------|--------------|-------------------| +|name |str |name | +|line_port |str |linePort | +|contact |List[contact] |contact *Optional* |
-## `SortOrderGroupAutoAttendantGetInstancePagedSortedList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `TrunkGroupDeviceMultipleContactEndpointModify`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Used to sort the `GroupAutoAttendantGetInstancePagedSortedListRequest()` request. +Trunk group device endpoint used in the context of modify that can have multiple +contacts. **Attributes:** -|Name |Type |Description | -|-----------------------|-------------------|------------------------------| -|sort_by_user_id |sortByUserId |sortByUserId *Optional* | -|sort_by_user_last_name |sortByUserLastName |sortByUserLastName *Optional* | -|sort_by_dn |sortByDn |sortByDn *Optional* | -|sort_by_extension |sortByExtension |sortByExtension *Optional* | +|Name |Type |Description | +|-------------|------------|-----------------------| +|name |str |name *Optional* | +|line_port |str |linePort *Optional* | +|contact_list |contactList |contactList *Optional* |
-## `SortOrderGroupCallCenterAgentThresholdProfileGetAvailableAgentPagedSortedList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `TrunkGroupDeviceMultipleContactEndpointRead22`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Used to sort the -`GroupCallCenterAgentThresholdProfileGetAvailableAgentPagedSortedListRequest()` -request. +Trunk group device endpoint that can have multiple contacts. **Attributes:** -|Name |Type |Description | -|--------------------------------|----------------------------|---------------------------------------| -|sort_by_user_id |sortByUserId |sortByUserId *Optional* | -|sort_by_user_last_name |sortByUserLastName |sortByUserLastName *Optional* | -|sort_by_user_first_name |sortByUserFirstName |sortByUserFirstName *Optional* | -|sort_by_dn |sortByDn |sortByDn *Optional* | -|sort_by_extension |sortByExtension |sortByExtension *Optional* | -|sort_by_department_name |sortByDepartmentName |sortByDepartmentName *Optional* | -|sort_by_email_address |sortByEmailAddress |sortByEmailAddress *Optional* | -|sort_by_agent_threshold_profile |sortByAgentThresholdProfile |sortByAgentThresholdProfile *Optional* | +|Name |Type |Description | +|----------------------------|--------------|--------------------------| +|name |str |name | +|line_port |str |linePort | +|contact |List[contact] |contact *Optional* | +|static_registration_capable |bool |staticRegistrationCapable | +|use_domain |bool |useDomain | +|is_pilot_user |bool |isPilotUser |
-## `SortOrderGroupCallCenterAgentThresholdProfileGetPagedSorted`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `TrunkGroupMultipleContactPilotUser`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Used to sort the `GroupCallCenterAgentThresholdProfileGetPagedSortedRequest()` -request. +Trunk Group pilot user information used when adding a Trunk Group. **Attributes:** -|Name |Type |Description | -|------------------------|---------------------|--------------------------------| -|sort_by_user_id |sortByUserId |sortByUserId *Optional* | -|sort_by_user_last_name |sortByUserLastName |sortByUserLastName *Optional* | -|sort_by_user_first_name |sortByUserFirstName |sortByUserFirstName *Optional* | -|sort_by_dn |sortByDn |sortByDn *Optional* | -|sort_by_extension |sortByExtension |sortByExtension *Optional* | -|sort_by_department_name |sortByDepartmentName |sortByDepartmentName *Optional* | -|sort_by_email_address |sortByEmailAddress |sortByEmailAddress *Optional* | +|Name |Type |Description | +|-----------------------------|-----------|------------------------------------| +|user_id |str |userId | +|last_name |str |lastName | +|first_name |str |firstName | +|calling_line_id_last_name |str |callingLineIdLastName | +|calling_line_id_first_name |str |callingLineIdFirstName | +|hiragana_last_name |str |hiraganaLastName *Optional* | +|hiragana_first_name |str |hiraganaFirstName *Optional* | +|password |str |password *Optional* | +|department |department |department *Optional* | +|language |str |language *Optional* | +|time_zone |str |timeZone *Optional* | +|line_port |str |linePort | +|contact |List[str] |contact *Optional* | +|calling_line_id_phone_number |str |callingLineIdPhoneNumber *Optional* |
-## `SortOrderGroupCallCenterGetAvailableAgentPagedSortedList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `TrunkGroupMultipleContactPilotUser22`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Used to sort the `GroupCallCenterGetAvailableAgentPagedSortedListRequest()` request. +Trunk Group pilot user information used when adding a Trunk Group. **Attributes:** -|Name |Type |Description | -|------------------------|---------------------|--------------------------------| -|sort_by_user_id |sortByUserId |sortByUserId *Optional* | -|sort_by_user_last_name |sortByUserLastName |sortByUserLastName *Optional* | -|sort_by_user_first_name |sortByUserFirstName |sortByUserFirstName *Optional* | -|sort_by_dn |sortByDn |sortByDn *Optional* | -|sort_by_extension |sortByExtension |sortByExtension *Optional* | -|sort_by_department_name |sortByDepartmentName |sortByDepartmentName *Optional* | -|sort_by_email_address |sortByEmailAddress |sortByEmailAddress *Optional* | +|Name |Type |Description | +|-----------------------------|--------------|------------------------------------| +|user_id |str |userId | +|last_name |str |lastName | +|first_name |str |firstName | +|calling_line_id_last_name |str |callingLineIdLastName | +|calling_line_id_first_name |str |callingLineIdFirstName | +|hiragana_last_name |str |hiraganaLastName *Optional* | +|hiragana_first_name |str |hiraganaFirstName *Optional* | +|password |str |password *Optional* | +|department |department |department *Optional* | +|language |str |language *Optional* | +|time_zone |str |timeZone *Optional* | +|line_port |str |linePort | +|contact |List[contact] |contact *Optional* | +|calling_line_id_phone_number |str |callingLineIdPhoneNumber *Optional* |
-## `SortOrderGroupCallCenterGetInstancePagedSortedList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `TrunkGroupPilotUser`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Used to sort the `GroupCallCenterGetInstancePagedSortedListRequest()` request. +Trunk Group pilot user information used when adding a Trunk Group. **Attributes:** -|Name |Type |Description | -|-------------------------|---------------------|--------------------------------| -|sort_by_user_id |sortByUserId |sortByUserId *Optional* | -|sort_by_call_center_name |sortByCallCenterName |sortByCallCenterName *Optional* | -|sort_by_dn |sortByDn |sortByDn *Optional* | -|sort_by_extension |sortByExtension |sortByExtension *Optional* | -|sort_by_department_name |sortByDepartmentName |sortByDepartmentName *Optional* | -|sort_by_hunt_policy |sortByHuntPolicy |sortByHuntPolicy *Optional* | -|sort_by_call_center_type |sortByCallCenterType |sortByCallCenterType *Optional* | +|Name |Type |Description | +|---------------------------|-----------|-----------------------------| +|user_id |str |userId | +|last_name |str |lastName | +|first_name |str |firstName | +|calling_line_id_last_name |str |callingLineIdLastName | +|calling_line_id_first_name |str |callingLineIdFirstName | +|hiragana_last_name |str |hiraganaLastName *Optional* | +|hiragana_first_name |str |hiraganaFirstName *Optional* | +|password |str |password *Optional* | +|department |department |department *Optional* | +|language |str |language *Optional* | +|time_zone |str |timeZone *Optional* | +|line_port |str |linePort | +|contact |str |contact *Optional* |
-## `SortOrderGroupCallParkGetAvailableAlternateRecallUserPagedSortedList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `UserServiceAuthorization`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Used to sort the -`GroupCallParkGetAvailableAlternateRecallUserPagedSortedListRequest()` request. +Authorize (with quantity) or unauthorize a user service. **Attributes:** -|Name |Type |Description | -|------------------------|---------------------|--------------------------------| -|sort_by_user_id |sortByUserId |sortByUserId *Optional* | -|sort_by_user_last_name |sortByUserLastName |sortByUserLastName *Optional* | -|sort_by_user_first_name |sortByUserFirstName |sortByUserFirstName *Optional* | -|sort_by_dn |sortByDn |sortByDn *Optional* | -|sort_by_extension |sortByExtension |sortByExtension *Optional* | -|sort_by_department_name |sortByDepartmentName |sortByDepartmentName *Optional* | +|Name |Type |Description | +|--------------------|-------------------|------------------------------| +|service_name |str |serviceName | +|authorized_quantity |authorizedQuantity |authorizedQuantity *Optional* | +|unauthorized |bool |unauthorized *Optional* |
-## `SortOrderGroupCallParkGetAvailableUserPagedSortedList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `VerifyTranslationAndRoutingParameters`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Used to sort the `GroupCallParkGetAvailableUserPagedSortedListRequest()` request. +Verification Translation and Routing parameters for creating a Verify Translation and +Routing request from parameters. **Attributes:** -|Name |Type |Description | -|------------------------|---------------------|--------------------------------| -|sort_by_user_id |sortByUserId |sortByUserId *Optional* | -|sort_by_user_last_name |sortByUserLastName |sortByUserLastName *Optional* | -|sort_by_user_first_name |sortByUserFirstName |sortByUserFirstName *Optional* | -|sort_by_dn |sortByDn |sortByDn *Optional* | -|sort_by_extension |sortByExtension |sortByExtension *Optional* | -|sort_by_department_name |sortByDepartmentName |sortByDepartmentName *Optional* | -|sort_by_email_address |sortByEmailAddress |sortByEmailAddress *Optional* | +|Name |Type |Description | +|------------|------------|---------------------| +|origination |origination |origination | +|destination |str |destination | +|contact |str |contact *Optional* | +|diversion |str |diversion *Optional* |
-## `SortOrderGroupCallPickupGetAvailableUserPagedSortedList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `VirtualOnNetUserRange`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Used to sort the `GroupCallPickupGetAvailableUserPagedSortedListRequest()` request. +Virtual On-Net User Range. **Attributes:** -|Name |Type |Description | -|------------------------|---------------------|--------------------------------| -|sort_by_user_id |sortByUserId |sortByUserId *Optional* | -|sort_by_user_last_name |sortByUserLastName |sortByUserLastName *Optional* | -|sort_by_user_first_name |sortByUserFirstName |sortByUserFirstName *Optional* | -|sort_by_dn |sortByDn |sortByDn *Optional* | -|sort_by_extension |sortByExtension |sortByExtension *Optional* | -|sort_by_department_name |sortByDepartmentName |sortByDepartmentName *Optional* | -|sort_by_email_address |sortByEmailAddress |sortByEmailAddress *Optional* | +|Name |Type |Description | +|------------------------------|---------------|-------------------------| +|dn_range |dnRange |dnRange | +|extension_range |extensionRange |extensionRange | +|first_name |str |firstName | +|last_name |str |lastName | +|calling_line_id_first_name |str |callingLineIdFirstName | +|calling_line_id_last_name |str |callingLineIdLastName | +|virtual_on_net_call_type_name |str |virtualOnNetCallTypeName |
-## `SortOrderGroupCallPickupGetInstancePagedSorted`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `VoiceMessagingAlternateNoAnswerGreetingModify`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Used to sort the `GroupCallPickupGetInstancePagedSortedRequest()` request. +The configuration of a alternate no answer greeting. +It is used when modifying a user's voice messaging greeting. **Attributes:** -|Name |Type |Description | -|------------------------|---------------------|--------------------------------| -|sort_by_user_id |sortByUserId |sortByUserId *Optional* | -|sort_by_user_last_name |sortByUserLastName |sortByUserLastName *Optional* | -|sort_by_user_first_name |sortByUserFirstName |sortByUserFirstName *Optional* | -|sort_by_dn |sortByDn |sortByDn *Optional* | -|sort_by_extension |sortByExtension |sortByExtension *Optional* | -|sort_by_department_name |sortByDepartmentName |sortByDepartmentName *Optional* | -|sort_by_email_address |sortByEmailAddress |sortByEmailAddress *Optional* | +|Name |Type |Description | +|-----------|----------|---------------------| +|name |str |name *Optional* | +|audio_file |audioFile |audioFile *Optional* | +|video_file |videoFile |videoFile *Optional* |
-## `SortOrderGroupCollaborateBridgeGetAvailableUserPagedSortedList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `VoiceMessagingAlternateNoAnswerGreetingModify16`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Used to sort the `GroupCollaborateBridgeGetAvailableUserPagedSortedListRequest()` -request. +The configuration of a alternate no answer greeting. +It is used when modifying a user's voice messaging greeting. **Attributes:** -|Name |Type |Description | -|------------------------|--------------------|-------------------------------| -|sort_by_user_id |sortByUserId |sortByUserId *Optional* | -|sort_by_user_last_name |sortByUserLastName |sortByUserLastName *Optional* | -|sort_by_user_first_name |sortByUserFirstName |sortByUserFirstName *Optional* | -|sort_by_dn |sortByDn |sortByDn *Optional* | -|sort_by_extension |sortByExtension |sortByExtension *Optional* | +|Name |Type |Description | +|-----------|----------|---------------------| +|name |str |name *Optional* | +|audio_file |audioFile |audioFile *Optional* | +|video_file |videoFile |videoFile *Optional* |
-## `SortOrderGroupCollaborateBridgeGetInstancePagedSortedList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `VoiceMessagingAlternateNoAnswerGreetingModify20`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Used to sort the `GroupCollaborateBridgeGetInstancePagedSortedListRequest()`. +The configuration of a alternate no answer greeting. +It is used when modifying a user's voice messaging greeting. **Attributes:** -|Name |Type |Description | -|-----------------------|-------------------|------------------------------| -|sort_by_user_id |sortByUserId |sortByUserId *Optional* | -|sort_by_user_last_name |sortByUserLastName |sortByUserLastName *Optional* | -|sort_by_dn |sortByDn |sortByDn *Optional* | -|sort_by_extension |sortByExtension |sortByExtension *Optional* | +|Name |Type |Description | +|-----------|----------|---------------------| +|name |str |name *Optional* | +|audio_file |audioFile |audioFile *Optional* | +|video_file |videoFile |videoFile *Optional* |
-## `SortOrderGroupDnGetAssignmentPagedSortedList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `VoiceMessagingAlternateNoAnswerGreetingRead20`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Used to sort the `GroupDnGetAssignmentPagedSortedListRequest()` request. +The configuration of a alternate no answer greeting. +It is used when geting a user's voice messaging greeting. **Attributes:** -|Name |Type |Description | -|------------------------|---------------------|--------------------------------| -|sort_by_dn |sortByDn |sortByDn *Optional* | -|sort_by_department_name |sortByDepartmentName |sortByDepartmentName *Optional* | -|sort_by_dn_activated |sortByDnActivated |sortByDnActivated *Optional* | -|sort_by_dn_available |sortByDnAvailable |sortByDnAvailable *Optional* | -|sort_by_user_id |sortByUserId |sortByUserId *Optional* | -|sort_by_user_first_name |sortByUserFirstName |sortByUserFirstName *Optional* | -|sort_by_user_last_name |sortByUserLastName |sortByUserLastName *Optional* | -|sort_by_extension |sortByExtension |sortByExtension *Optional* | -|sort_by_email_address |sortByEmailAddress |sortByEmailAddress *Optional* | +|Name |Type |Description | +|-----------|----------|---------------------| +|name |str |name | +|audio_file |audioFile |audioFile *Optional* | +|video_file |videoFile |videoFile *Optional* |
-## `SortOrderGroupGetListInServiceProviderPagedSortedList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `VoiceMessagingDistributionListModify`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Used to sort the `GroupGetListInServiceProviderPagedSortedListRequest()` request. - +A list of voice mail distribution lists It is used when setting a user's voice +messaging distribution lists **Attributes:** -|Name |Type |Description | -|-------------------|----------------|---------------------------| -|sort_by_group_id |sortByGroupId |sortByGroupId *Optional* | -|sort_by_group_name |sortByGroupName |sortByGroupName *Optional* | +|Name |Type |Description | +|------------------|----------------|---------------------------| +|list_id |int |listId | +|description |str |description *Optional* | +|phone_number_list |phoneNumberList |phoneNumberList *Optional* |
-## `SortOrderGroupHuntGroupGetAvailableUserPagedSortedList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `AccessDeviceMultipleContactEndpointModify22`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Used to sort the `GroupHuntGroupGetAvailableUserPagedSortedListRequest()` request. +Access device end point used in the context of modify that can have more than one +contact defined. +Only Static Registration capable devices may have more than one contact defined. Port +numbers are only used by devices with static line ordering. **Attributes:** -|Name |Type |Description | -|------------------------|--------------------|-------------------------------| -|sort_by_user_id |sortByUserId |sortByUserId *Optional* | -|sort_by_user_last_name |sortByUserLastName |sortByUserLastName *Optional* | -|sort_by_user_first_name |sortByUserFirstName |sortByUserFirstName *Optional* | -|sort_by_dn |sortByDn |sortByDn *Optional* | -|sort_by_extension |sortByExtension |sortByExtension *Optional* | +|Name |Type |Description | +|--------------|-------------|------------------------| +|access_device |accessDevice |accessDevice *Optional* | +|line_port |str |linePort *Optional* | +|contact_list |contactList |contactList *Optional* | +|port_number |int |portNumber *Optional* |
-## `SortOrderGroupHuntGroupGetInstancePagedSortedList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `AccessDeviceMultipleIdentityAndContactEndpointModify22`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Used to sort the `GroupHuntGroupGetInstancePagedSortedListRequest()` request. +Access device end point used in the context of modify that can have more than one +contact defined. +The endpoint is identified by its linePort (public Identity) and possibly a private +Identity. Only Static Registration capable devices may have more than one contact +defined. Port numbers are only used by devices with static line ordering. The +following elements are only used in XS data mode and ignored in AS data mode: +privateIdentity The following elements are only used in AS data mode and ignored in XS +data mode: useHotline hotlineContact **Attributes:** -|Name |Type |Description | -|-----------------------|-------------------|------------------------------| -|sort_by_user_id |sortByUserId |sortByUserId *Optional* | -|sort_by_user_last_name |sortByUserLastName |sortByUserLastName *Optional* | -|sort_by_dn |sortByDn |sortByDn *Optional* | -|sort_by_extension |sortByExtension |sortByExtension *Optional* | +|Name |Type |Description | +|-----------------|-------------|---------------------------| +|access_device |accessDevice |accessDevice *Optional* | +|line_port |str |linePort *Optional* | +|private_identity |str |privateIdentity *Optional* | +|contact_list |contactList |contactList *Optional* | +|port_number |int |portNumber *Optional* | +|use_hotline |bool |useHotline *Optional* | +|hotline_contact |str |hotlineContact *Optional* |
-## `SortOrderGroupPhoneDirectoryGetPagedSortedList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `AutoAttendantKeyConfiguration`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Used to sort the `GroupPhoneDirectoryGetPagedSortedListRequest()` request. +The configuration of a key for Auto Attendant. **Attributes:** -|Name |Type |Description | -|----------------------------|------------------------|-----------------------------------| -|sort_by_user_last_name |sortByUserLastName |sortByUserLastName *Optional* | -|sort_by_user_first_name |sortByUserFirstName |sortByUserFirstName *Optional* | -|sort_by_mobile_phone_number |sortByMobilePhoneNumber |sortByMobilePhoneNumber *Optional* | -|sort_by_email_address |sortByEmailAddress |sortByEmailAddress *Optional* | -|sort_by_department_name |sortByDepartmentName |sortByDepartmentName *Optional* | -|sort_by_yahoo_id |sortByYahooId |sortByYahooId *Optional* | -|sort_by_user_id |sortByUserId |sortByUserId *Optional* | -|sort_by_imp_id |sortByImpId |sortByImpId *Optional* | +|Name |Type |Description| +|------|------|-----------| +|key |str |key | +|entry |entry |entry |
-## `SortOrderServiceProviderAdminGetPagedSortedList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `AutoAttendantKeyConfiguration19`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Used to sort the `ServiceProviderAdminGetPagedSortedListRequest()` request. +The configuration of a key for Auto Attendant. **Attributes:** -|Name |Type |Description | -|-------------------------|---------------------|--------------------------------| -|sort_by_admin_id |sortByAdminId |sortByAdminId *Optional* | -|sort_by_admin_last_name |sortByAdminLastName |sortByAdminLastName *Optional* | -|sort_by_admin_first_name |sortByAdminFirstName |sortByAdminFirstName *Optional* | +|Name |Type |Description| +|------|------|-----------| +|key |str |key | +|entry |entry |entry |
-## `SortOrderServiceProviderGetPagedSortedList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `AutoAttendantKeyConfiguration20`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Used to sort the `ServiceProviderGetPagedSortedListRequest()` request. +The configuration of a key for Auto Attendant. **Attributes:** -|Name |Type |Description | -|------------------------------|--------------------------|-------------------------------------| -|sort_by_service_provider_id |sortByServiceProviderId |sortByServiceProviderId *Optional* | -|sort_by_service_provider_name |sortByServiceProviderName |sortByServiceProviderName *Optional* | +|Name |Type |Description| +|------|------|-----------| +|key |str |key | +|entry |entry |entry |
-## `SortOrderUserGetListInGroupPagedSortedList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `AutoAttendantKeyModifyConfiguration`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Used to sort the `UserGetListInGroupPagedSortedListRequest()` request. +The modify configuration of a key for Auto Attendant. **Attributes:** -|Name |Type |Description | -|------------------------|---------------------|--------------------------------| -|sort_by_user_id |sortByUserId |sortByUserId *Optional* | -|sort_by_user_last_name |sortByUserLastName |sortByUserLastName *Optional* | -|sort_by_user_first_name |sortByUserFirstName |sortByUserFirstName *Optional* | -|sort_by_department_name |sortByDepartmentName |sortByDepartmentName *Optional* | -|sort_by_dn |sortByDn |sortByDn *Optional* | -|sort_by_extension |sortByExtension |sortByExtension *Optional* | -|sort_by_email_address |sortByEmailAddress |sortByEmailAddress *Optional* | +|Name |Type |Description| +|------|------|-----------| +|key |str |key | +|entry |entry |entry |
-## `SystemCollaborateGetResponse20sp1V2`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `AutoAttendantKeyModifyConfiguration20`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Response to SystemCollaborateGetRequest20sp1V2. +The modify configuration of a key for Auto Attendant. **Attributes:** -|Name |Type |Description | -|---------------------------------------------------|-----------------------|----------------------------------------------| -|collaborate_room_id_length |int |collaborateRoomIdLength | -|instant_room_idle_timeout_seconds |int |instantRoomIdleTimeoutSeconds | -|collaborate_room_maximum_duration_minutes |int |collaborateRoomMaximumDurationMinutes | -|support_outdial |bool |supportOutdial | -|max_collaborate_room_participants |int |maxCollaborateRoomParticipants | -|collaborate_active_talker_refresh_interval_seconds |int |collaborateActiveTalkerRefreshIntervalSeconds | -|terminate_collaborate_after_grace_period |bool |terminateCollaborateAfterGracePeriod | -|collaborate_grace_period |collaborateGracePeriod |collaborateGracePeriod | -|enable_active_collaborate_notification |bool |enableActiveCollaborateNotification | -|collaborate_from_address |str |collaborateFromAddress *Optional* | +|Name |Type |Description| +|------|------|-----------| +|key |str |key | +|entry |entry |entry |
-## `SystemCollaborateModifyRequest20sp1V2`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `AutoAttendantKeyReadConfiguration20`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Modify the system level data associated with collaborate services. +The read configuration of a key for Auto Attendant. -The response is either a `SuccessResponse()` or an `ErrorResponse()`. **Attributes:** -|Name |Type |Description | -|---------------------------------------------------|-----------------------|---------------------------------------------------------| -|collaborate_room_id_length |int |collaborateRoomIdLength *Optional* | -|instant_room_idle_timeout_seconds |int |instantRoomIdleTimeoutSeconds *Optional* | -|collaborate_room_maximum_duration_minutes |int |collaborateRoomMaximumDurationMinutes *Optional* | -|support_outdial |bool |supportOutdial *Optional* | -|max_collaborate_room_participants |int |maxCollaborateRoomParticipants *Optional* | -|collaborate_active_talker_refresh_interval_seconds |int |collaborateActiveTalkerRefreshIntervalSeconds *Optional* | -|terminate_collaborate_after_grace_period |bool |terminateCollaborateAfterGracePeriod *Optional* | -|collaborate_grace_period |collaborateGracePeriod |collaborateGracePeriod *Optional* | -|enable_active_collaborate_notification |bool |enableActiveCollaborateNotification *Optional* | -|collaborate_from_address |str |collaborateFromAddress *Optional* | +|Name |Type |Description| +|------|------|-----------| +|key |str |key | +|entry |entry |entry |
-## `SystemCommunicationBarringProfileGetResponse19sp1V2`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `AutoAttendantReadMenu19`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Response to the SystemCommunicationBarringProfileGetRequest19sp1V2. +The configuration of the automated receptionist greeting prompt and dialing menu to be +used during after business hours. -The response contains the Communication Barring Profile information. The incoming -rules are returned in ascending priority order. The following elements are only used -in AS data mode: callMeNowDefaultAction callMeNowDefaultCallTimeout callMeNowRule -applyToAttendedCallTransfers **Attributes:** -|Name |Type |Description | -|------------------------------------|----------------------|--------------------------------------------| -|description |str |description *Optional* | -|originating_default_action |str |originatingDefaultAction | -|originating_default_treatment_id |str |originatingDefaultTreatmentId *Optional* | -|originating_default_transfer_number |str |originatingDefaultTransferNumber *Optional* | -|originating_default_call_timeout |int |originatingDefaultCallTimeout *Optional* | -|originating_rule |List[originatingRule] |originatingRule *Optional* | -|redirecting_default_action |str |redirectingDefaultAction | -|redirecting_default_call_timeout |int |redirectingDefaultCallTimeout *Optional* | -|redirecting_rule |List[redirectingRule] |redirectingRule *Optional* | -|incoming_default_action |str |incomingDefaultAction | -|incoming_default_call_timeout |int |incomingDefaultCallTimeout *Optional* | -|incoming_rule |List[incomingRule] |incomingRule *Optional* | -|call_me_now_default_action |str |callMeNowDefaultAction | -|call_me_now_default_call_timeout |int |callMeNowDefaultCallTimeout *Optional* | -|call_me_now_rule |List[callMeNowRule] |callMeNowRule *Optional* | -|apply_to_attended_call_transfers |bool |applyToAttendedCallTransfers | +|Name |Type |Description | +|------------------------------------------|-----------------------|-------------------------------------| +|announcement_selection |str |announcementSelection | +|audio_file_description |str |audioFileDescription *Optional* | +|audio_media_type |str |audioMediaType *Optional* | +|video_file_description |str |videoFileDescription *Optional* | +|video_media_type |str |videoMediaType *Optional* | +|enable_first_menu_level_extension_dialing |bool |enableFirstMenuLevelExtensionDialing | +|key_configuration |List[keyConfiguration] |keyConfiguration *Optional* |
-## `TreeDeviceInfo`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `CPEDeviceModifyOptions`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Information related to a tree device. +CPE device's options when used with a modify request. -A tree device is a device associated with a device type that has the option -supportLinks set to "Support Links from Devices". Many leaf devices can link to it. -When a tree device is created, it is assigned a system-wide unique linkId. +The following options are not changeable: configType systemFileName deviceFileFormat **Attributes:** -|Name |Type |Description | -|----------------|--------------|--------------| -|tree_device_key |treeDeviceKey |treeDeviceKey | -|link_id |str |linkId | +|Name |Type |Description | +|--------------------------------------|----------------------------------|---------------------------------------------| +|enable_monitoring |bool |enableMonitoring *Optional* | +|reset_event |str |resetEvent *Optional* | +|device_management_device_type_options |deviceManagementDeviceTypeOptions |deviceManagementDeviceTypeOptions *Optional* |
-## `TrunkAddressingAdd`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `CPEDeviceModifyOptions16`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Trunk group endpoint. +CPE device's options when used with a modify request. +The following options are not changeable: configType systemFileName deviceFileFormat **Attributes:** -|Name |Type |Description | -|----------------------------|-------------------------|------------------------------------| -|trunk_group_device_endpoint |trunkGroupDeviceEndpoint |trunkGroupDeviceEndpoint *Optional* | -|enterprise_trunk_name |str |enterpriseTrunkName *Optional* | -|alternate_trunk_identity |str |alternateTrunkIdentity *Optional* | +|Name |Type |Description | +|--------------------------------------|----------------------------------|---------------------------------------------| +|enable_monitoring |bool |enableMonitoring *Optional* | +|reset_event |str |resetEvent *Optional* | +|device_management_device_type_options |deviceManagementDeviceTypeOptions |deviceManagementDeviceTypeOptions *Optional* |
-## `TrunkAddressingModify`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `CPEDeviceModifyOptions16sp1`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Trunk group endpoint. +CPE device's options when used with a modify request. +The following options are not changeable: configType systemFileName deviceFileFormat **Attributes:** -|Name |Type |Description | -|----------------------------|-------------------------|------------------------------------| -|trunk_group_device_endpoint |trunkGroupDeviceEndpoint |trunkGroupDeviceEndpoint *Optional* | -|enterprise_trunk_name |str |enterpriseTrunkName *Optional* | -|alternate_trunk_identity |str |alternateTrunkIdentity *Optional* | +|Name |Type |Description | +|--------------------------------------|----------------------------------|---------------------------------------------| +|enable_monitoring |bool |enableMonitoring *Optional* | +|device_management_device_type_options |deviceManagementDeviceTypeOptions |deviceManagementDeviceTypeOptions *Optional* |
-## `TrunkAddressingMultipleContactAdd`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `CPEDeviceModifyOptions22`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Trunk group endpoint that can have multiple contacts. +CPE device's options when used with a modify request. -alternateTrunkIdentityDomain is only used in XS mode and the AS when deployed in IMS -mode. Both alternateTrunkIdentity and AlternateTrunkIdentityDomain should be set at -the same time if one is set in XS mode. The following elements are only used in AS -data mode and are ignored in XS data mode: physicalLocation +The following options are not changeable: configType systemFileName deviceFileFormat **Attributes:** -|Name |Type |Description | -|--------------------------------|-------------------------|----------------------------------------| -|trunk_group_device_endpoint |trunkGroupDeviceEndpoint |trunkGroupDeviceEndpoint *Optional* | -|enterprise_trunk_name |str |enterpriseTrunkName *Optional* | -|alternate_trunk_identity |str |alternateTrunkIdentity *Optional* | -|alternate_trunk_identity_domain |str |alternateTrunkIdentityDomain *Optional* | -|physical_location |str |physicalLocation *Optional* | +|Name |Type |Description | +|--------------------------------------|----------------------------------|---------------------------------------------| +|enable_monitoring |bool |enableMonitoring *Optional* | +|device_management_device_type_options |deviceManagementDeviceTypeOptions |deviceManagementDeviceTypeOptions *Optional* |
-## `TrunkAddressingMultipleContactRead`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `CPEDeviceOptions14sp6`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Trunk group endpoint that can have multiple contacts. +CPE device's options. -Replaced by: TrunkAddressingMultipleContactRead21 **Attributes:** -|Name |Type |Description | -|----------------------------|-------------------------|------------------------------------| -|trunk_group_device_endpoint |trunkGroupDeviceEndpoint |trunkGroupDeviceEndpoint *Optional* | -|enterprise_trunk_name |str |enterpriseTrunkName *Optional* | -|alternate_trunk_identity |str |alternateTrunkIdentity *Optional* | +|Name |Type |Description | +|--------------------------------------|----------------------------------|---------------------------------------------| +|enable_monitoring |bool |enableMonitoring | +|reset_event |str |resetEvent *Optional* | +|config_type |str |configType | +|system_file_name |str |systemFileName *Optional* | +|device_file_format |str |deviceFileFormat *Optional* | +|device_management_device_type_options |deviceManagementDeviceTypeOptions |deviceManagementDeviceTypeOptions *Optional* |
-## `TrunkAddressingMultipleContactRead21`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `CPEDeviceOptions16`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Trunk group endpoint that can have multiple contacts. +CPE device's options. -alternateTrunkIdentityDomain is only used in XS mode and the AS when deployed in IMS -mode. The following elements are only used in AS data mode and ignored in XS data -mode: alternateTrunkIdentityDomain **Attributes:** -|Name |Type |Description | -|--------------------------------|-------------------------|----------------------------------------| -|trunk_group_device_endpoint |trunkGroupDeviceEndpoint |trunkGroupDeviceEndpoint *Optional* | -|enterprise_trunk_name |str |enterpriseTrunkName *Optional* | -|alternate_trunk_identity |str |alternateTrunkIdentity *Optional* | -|alternate_trunk_identity_domain |str |alternateTrunkIdentityDomain *Optional* | +|Name |Type |Description | +|--------------------------------------|----------------------------------|---------------------------------------------| +|enable_monitoring |bool |enableMonitoring | +|reset_event |str |resetEvent *Optional* | +|config_type |str |configType | +|system_file_name |str |systemFileName *Optional* | +|device_file_format |str |deviceFileFormat *Optional* | +|device_management_device_type_options |deviceManagementDeviceTypeOptions |deviceManagementDeviceTypeOptions *Optional* |
-## `TrunkAddressingMultipleContactRead21sp1`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `CPEDeviceOptions16sp1`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Trunk group endpoint that can have multiple contacts. +CPE device's options. -alternateTrunkIdentityDomain is only used in XS mode and the AS when deployed in IMS -mode. The following elements are only used in AS data mode and are ignored in XS data -mode: physicalLocation +The field configType is optional to allow the use of field enableMonitoring for all +device types being managed or not ie. device configuration option equals to +DeviceManagement, or Legacy, or Not Supported). If the device configuration option is +set to "Not Supported", the value of configType is forced set to "None" regardless of +its current value. It is not allowed to add a device type with device configuration +option set to Device Management or Legacy when the configType is not set. **Attributes:** -|Name |Type |Description | -|--------------------------------|-------------------------|----------------------------------------| -|trunk_group_device_endpoint |trunkGroupDeviceEndpoint |trunkGroupDeviceEndpoint *Optional* | -|enterprise_trunk_name |str |enterpriseTrunkName *Optional* | -|alternate_trunk_identity |str |alternateTrunkIdentity *Optional* | -|alternate_trunk_identity_domain |str |alternateTrunkIdentityDomain *Optional* | -|physical_location |str |physicalLocation *Optional* | +|Name |Type |Description | +|--------------------------------------|----------------------------------|---------------------------------------------| +|enable_monitoring |bool |enableMonitoring | +|config_type |str |configType *Optional* | +|system_file_name |str |systemFileName *Optional* | +|device_file_format |str |deviceFileFormat *Optional* | +|device_management_device_type_options |deviceManagementDeviceTypeOptions |deviceManagementDeviceTypeOptions *Optional* |
-## `TrunkAddressingRead`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `CPEDeviceOptions21sp1`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Trunk group endpoint. +CPE device's options. +The field configType is optional to allow the use of field enableMonitoring for all +device types being managed or not ie. device configuration option equals to +DeviceManagement, or Legacy, or Not Supported). If the device configuration option is +set to "Not Supported", the value of configType is forced set to "None" regardless of +its current value. It is not allowed to add a device type with device configuration +option set to Device Management or Legacy when the configType is not set. **Attributes:** -|Name |Type |Description | -|----------------------------|-------------------------|------------------------------------| -|trunk_group_device_endpoint |trunkGroupDeviceEndpoint |trunkGroupDeviceEndpoint *Optional* | -|enterprise_trunk_name |str |enterpriseTrunkName *Optional* | -|alternate_trunk_identity |str |alternateTrunkIdentity *Optional* | +|Name |Type |Description | +|--------------------------------------|----------------------------------|---------------------------------------------| +|enable_monitoring |bool |enableMonitoring | +|config_type |str |configType *Optional* | +|system_file_name |str |systemFileName *Optional* | +|device_file_format |str |deviceFileFormat *Optional* | +|device_management_device_type_options |deviceManagementDeviceTypeOptions |deviceManagementDeviceTypeOptions *Optional* |
-## `TrunkGroupDeviceMultipleContactEndpointAdd22`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `CPEDeviceOptions22`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Trunk group device endpoint used in the context of modify that can have multiple -contacts. +CPE device's options. +The field configType is optional to allow the use of field enableMonitoring for all +device types being managed or not ie. device configuration option equals to +DeviceManagement, or Legacy, or Not Supported). If the device configuration option is +set to "Not Supported", the value of configType is forced set to "None" regardless of +its current value. It is not allowed to add a device type with device configuration +option set to Device Management or Legacy when the configType is not set. **Attributes:** -|Name |Type |Description | -|----------|--------------|-------------------| -|name |str |name | -|line_port |str |linePort | -|contact |List[contact] |contact *Optional* | +|Name |Type |Description | +|--------------------------------------|----------------------------------|---------------------------------------------| +|enable_monitoring |bool |enableMonitoring | +|config_type |str |configType *Optional* | +|system_file_name |str |systemFileName *Optional* | +|device_file_format |str |deviceFileFormat *Optional* | +|device_management_device_type_options |deviceManagementDeviceTypeOptions |deviceManagementDeviceTypeOptions *Optional* |
-## `TrunkGroupDeviceMultipleContactEndpointModify`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `CPEDeviceOptions22V2`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Trunk group device endpoint used in the context of modify that can have multiple -contacts. +CPE device's options. +The field configType is optional to allow the use of field enableMonitoring for all +device types being managed or not ie. device configuration option equals to +DeviceManagement, or Legacy, or Not Supported). If the device configuration option is +set to "Not Supported", the value of configType is forced set to "None" regardless of +its current value. It is not allowed to add a device type with device configuration +option set to Device Management or Legacy when the configType is not set. **Attributes:** -|Name |Type |Description | -|-------------|------------|-----------------------| -|name |str |name *Optional* | -|line_port |str |linePort *Optional* | -|contact_list |contactList |contactList *Optional* | +|Name |Type |Description | +|--------------------------------------|----------------------------------|---------------------------------------------| +|enable_monitoring |bool |enableMonitoring | +|config_type |str |configType *Optional* | +|system_file_name |str |systemFileName *Optional* | +|device_file_format |str |deviceFileFormat *Optional* | +|device_management_device_type_options |deviceManagementDeviceTypeOptions |deviceManagementDeviceTypeOptions *Optional* |
-## `TrunkGroupDeviceMultipleContactEndpointRead22`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `CPEDeviceOptions22V3`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Trunk group device endpoint that can have multiple contacts. +CPE device's options. +The field configType is optional to allow the use of field enableMonitoring for all +device types being managed or not ie. device configuration option equals to +DeviceManagement, or Legacy, or Not Supported). If the device configuration option is +set to "Not Supported", the value of configType is forced set to "None" regardless of +its current value. It is not allowed to add a device type with device configuration +option set to Device Management or Legacy when the configType is not set. **Attributes:** -|Name |Type |Description | -|----------------------------|--------------|--------------------------| -|name |str |name | -|line_port |str |linePort | -|contact |List[contact] |contact *Optional* | -|static_registration_capable |bool |staticRegistrationCapable | -|use_domain |bool |useDomain | -|is_pilot_user |bool |isPilotUser | +|Name |Type |Description | +|--------------------------------------|----------------------------------|---------------------------------------------| +|enable_monitoring |bool |enableMonitoring | +|config_type |str |configType *Optional* | +|system_file_name |str |systemFileName *Optional* | +|device_file_format |str |deviceFileFormat *Optional* | +|device_management_device_type_options |deviceManagementDeviceTypeOptions |deviceManagementDeviceTypeOptions *Optional* |
-## `TrunkGroupMultipleContactPilotUser`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `CPEDeviceOptions22V4`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Trunk Group pilot user information used when adding a Trunk Group. +CPE device's options. +The field configType is optional to allow the use of field enableMonitoring for all +device types being managed or not ie. device configuration option equals to +DeviceManagement, or Legacy, or Not Supported). If the device configuration option is +set to "Not Supported", the value of configType is forced set to "None" regardless of +its current value. It is not allowed to add a device type with device configuration +option set to Device Management or Legacy when the configType is not set. **Attributes:** -|Name |Type |Description | -|-----------------------------|-----------|------------------------------------| -|user_id |str |userId | -|last_name |str |lastName | -|first_name |str |firstName | -|calling_line_id_last_name |str |callingLineIdLastName | -|calling_line_id_first_name |str |callingLineIdFirstName | -|hiragana_last_name |str |hiraganaLastName *Optional* | -|hiragana_first_name |str |hiraganaFirstName *Optional* | -|password |str |password *Optional* | -|department |department |department *Optional* | -|language |str |language *Optional* | -|time_zone |str |timeZone *Optional* | -|line_port |str |linePort | -|contact |List[str] |contact *Optional* | -|calling_line_id_phone_number |str |callingLineIdPhoneNumber *Optional* | +|Name |Type |Description | +|--------------------------------------|----------------------------------|---------------------------------------------| +|enable_monitoring |bool |enableMonitoring | +|config_type |str |configType *Optional* | +|system_file_name |str |systemFileName *Optional* | +|device_file_format |str |deviceFileFormat *Optional* | +|device_management_device_type_options |deviceManagementDeviceTypeOptions |deviceManagementDeviceTypeOptions *Optional* |
-## `TrunkGroupMultipleContactPilotUser22`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `CallCenterMediaOnHoldSourceModify16`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Trunk Group pilot user information used when adding a Trunk Group. +Contains the call center media on hold source configuration. **Attributes:** -|Name |Type |Description | -|-----------------------------|--------------|------------------------------------| -|user_id |str |userId | -|last_name |str |lastName | -|first_name |str |firstName | -|calling_line_id_last_name |str |callingLineIdLastName | -|calling_line_id_first_name |str |callingLineIdFirstName | -|hiragana_last_name |str |hiraganaLastName *Optional* | -|hiragana_first_name |str |hiraganaFirstName *Optional* | -|password |str |password *Optional* | -|department |department |department *Optional* | -|language |str |language *Optional* | -|time_zone |str |timeZone *Optional* | -|line_port |str |linePort | -|contact |List[contact] |contact *Optional* | -|calling_line_id_phone_number |str |callingLineIdPhoneNumber *Optional* | +|Name |Type |Description | +|-------------------------------|--------------------|---------------------------------------| +|audio_message_source_selection |str |audioMessageSourceSelection *Optional* | +|audio_file |audioFile |audioFile *Optional* | +|external_audio_source |externalAudioSource |externalAudioSource *Optional* | +|video_message_source_selection |str |videoMessageSourceSelection *Optional* | +|video_file |videoFile |videoFile *Optional* | +|external_video_source |externalVideoSource |externalVideoSource *Optional* |
-## `TrunkGroupPilotUser`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `CallCenterMediaOnHoldSourceModify17`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Trunk Group pilot user information used when adding a Trunk Group. +Contains the call center media on hold source configuration. **Attributes:** -|Name |Type |Description | -|---------------------------|-----------|-----------------------------| -|user_id |str |userId | -|last_name |str |lastName | -|first_name |str |firstName | -|calling_line_id_last_name |str |callingLineIdLastName | -|calling_line_id_first_name |str |callingLineIdFirstName | -|hiragana_last_name |str |hiraganaLastName *Optional* | -|hiragana_first_name |str |hiraganaFirstName *Optional* | -|password |str |password *Optional* | -|department |department |department *Optional* | -|language |str |language *Optional* | -|time_zone |str |timeZone *Optional* | -|line_port |str |linePort | -|contact |str |contact *Optional* | +|Name |Type |Description | +|-------------------------------|--------------------|---------------------------------------| +|audio_message_source_selection |str |audioMessageSourceSelection *Optional* | +|audio_url_list |audioUrlList |audioUrlList *Optional* | +|audio_file_list |audioFileList |audioFileList *Optional* | +|external_audio_source |externalAudioSource |externalAudioSource *Optional* | +|video_message_source_selection |str |videoMessageSourceSelection *Optional* | +|video_url_list |videoUrlList |videoUrlList *Optional* | +|video_file_list |videoFileList |videoFileList *Optional* | +|external_video_source |externalVideoSource |externalVideoSource *Optional* |
-## `UserServiceAuthorization`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `CallCenterMediaOnHoldSourceModify20`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Authorize (with quantity) or unauthorize a user service. +Contains the call center media on hold source configuration. **Attributes:** -|Name |Type |Description | -|--------------------|-------------------|------------------------------| -|service_name |str |serviceName | -|authorized_quantity |authorizedQuantity |authorizedQuantity *Optional* | -|unauthorized |bool |unauthorized *Optional* | +|Name |Type |Description | +|-------------------------------|--------------------|---------------------------------------| +|audio_message_source_selection |str |audioMessageSourceSelection *Optional* | +|audio_url_list |audioUrlList |audioUrlList *Optional* | +|audio_file_list |audioFileList |audioFileList *Optional* | +|external_audio_source |externalAudioSource |externalAudioSource *Optional* | +|video_message_source_selection |str |videoMessageSourceSelection *Optional* | +|video_url_list |videoUrlList |videoUrlList *Optional* | +|video_file_list |videoFileList |videoFileList *Optional* | +|external_video_source |externalVideoSource |externalVideoSource *Optional* |
-## `VerifyTranslationAndRoutingParameters`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `CallCenterMediaOnHoldSourceRead16`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Verification Translation and Routing parameters for creating a Verify Translation and -Routing request from parameters. +Contains the call center media on hold source configuration. **Attributes:** -|Name |Type |Description | -|------------|------------|---------------------| -|origination |origination |origination | -|destination |str |destination | -|contact |str |contact *Optional* | -|diversion |str |diversion *Optional* | +|Name |Type |Description | +|-------------------------------|--------------------|---------------------------------------| +|audio_message_source_selection |str |audioMessageSourceSelection | +|audio_file_url |str |audioFileUrl *Optional* | +|audio_file_description |str |audioFileDescription *Optional* | +|audio_file_media_type |str |audioFileMediaType *Optional* | +|external_audio_source |externalAudioSource |externalAudioSource *Optional* | +|video_message_source_selection |str |videoMessageSourceSelection *Optional* | +|video_file_url |str |videoFileUrl *Optional* | +|video_file_description |str |videoFileDescription *Optional* | +|video_file_media_type |str |videoFileMediaType *Optional* | +|external_video_source |externalVideoSource |externalVideoSource *Optional* |
-## `VirtualOnNetUserRange`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `CallCenterMediaOnHoldSourceRead17`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Virtual On-Net User Range. +Contains the call center media on hold source configuration. +Replaced by: CallCenterMediaOnHoldSourceRead19. **Attributes:** -|Name |Type |Description | -|------------------------------|---------------|-------------------------| -|dn_range |dnRange |dnRange | -|extension_range |extensionRange |extensionRange | -|first_name |str |firstName | -|last_name |str |lastName | -|calling_line_id_first_name |str |callingLineIdFirstName | -|calling_line_id_last_name |str |callingLineIdLastName | -|virtual_on_net_call_type_name |str |virtualOnNetCallTypeName | +|Name |Type |Description | +|-------------------------------|--------------------|---------------------------------------| +|audio_message_source_selection |str |audioMessageSourceSelection | +|audio_url_list |audioUrlList |audioUrlList *Optional* | +|audio_file_list |audioFileList |audioFileList *Optional* | +|audio_media_type_list |audioMediaTypeList |audioMediaTypeList *Optional* | +|external_audio_source |externalAudioSource |externalAudioSource *Optional* | +|video_message_source_selection |str |videoMessageSourceSelection *Optional* | +|video_url_list |videoUrlList |videoUrlList *Optional* | +|video_file_list |videoFileList |videoFileList *Optional* | +|video_media_type_list |videoMediaTypeList |videoMediaTypeList *Optional* | +|external_video_source |externalVideoSource |externalVideoSource *Optional* |
-## `VoiceMessagingAlternateNoAnswerGreetingModify`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `CallCenterMediaOnHoldSourceRead19`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The configuration of a alternate no answer greeting. +Contains the call center media on hold source configuration. -It is used when modifying a user's voice messaging greeting. **Attributes:** -|Name |Type |Description | -|-----------|----------|---------------------| -|name |str |name *Optional* | -|audio_file |audioFile |audioFile *Optional* | -|video_file |videoFile |videoFile *Optional* | +|Name |Type |Description | +|-------------------------------|--------------------|---------------------------------------| +|audio_message_source_selection |str |audioMessageSourceSelection | +|audio_url_list |audioUrlList |audioUrlList *Optional* | +|audio_file_list |audioFileList |audioFileList *Optional* | +|audio_media_type_list |audioMediaTypeList |audioMediaTypeList *Optional* | +|external_audio_source |externalAudioSource |externalAudioSource *Optional* | +|video_message_source_selection |str |videoMessageSourceSelection *Optional* | +|video_url_list |videoUrlList |videoUrlList *Optional* | +|video_file_list |videoFileList |videoFileList *Optional* | +|video_media_type_list |videoMediaTypeList |videoMediaTypeList *Optional* | +|external_video_source |externalVideoSource |externalVideoSource *Optional* |
-## `VoiceMessagingAlternateNoAnswerGreetingModify16`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `CallCenterMediaOnHoldSourceRead20`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The configuration of a alternate no answer greeting. +Contains the call center media on hold source configuration. -It is used when modifying a user's voice messaging greeting. **Attributes:** -|Name |Type |Description | -|-----------|----------|---------------------| -|name |str |name *Optional* | -|audio_file |audioFile |audioFile *Optional* | -|video_file |videoFile |videoFile *Optional* | +|Name |Type |Description | +|-------------------------------|--------------------|---------------------------------------| +|audio_message_source_selection |str |audioMessageSourceSelection | +|audio_url_list |audioUrlList |audioUrlList *Optional* | +|audio_file_list |audioFileList |audioFileList *Optional* | +|external_audio_source |externalAudioSource |externalAudioSource *Optional* | +|video_message_source_selection |str |videoMessageSourceSelection *Optional* | +|video_url_list |videoUrlList |videoUrlList *Optional* | +|video_file_list |videoFileList |videoFileList *Optional* | +|external_video_source |externalVideoSource |externalVideoSource *Optional* |
-## `VoiceMessagingAlternateNoAnswerGreetingModify20`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `CallCenterMediaOnHoldSourceRead22`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The configuration of a alternate no answer greeting. +Contains the call center media on hold source configuration. -It is used when modifying a user's voice messaging greeting. **Attributes:** -|Name |Type |Description | -|-----------|----------|---------------------| -|name |str |name *Optional* | -|audio_file |audioFile |audioFile *Optional* | -|video_file |videoFile |videoFile *Optional* | +|Name |Type |Description | +|-------------------------------|--------------------|---------------------------------------| +|audio_message_source_selection |str |audioMessageSourceSelection | +|audio_url_list |audioUrlList |audioUrlList *Optional* | +|audio_file_list |audioFileList |audioFileList *Optional* | +|external_audio_source |externalAudioSource |externalAudioSource *Optional* | +|video_message_source_selection |str |videoMessageSourceSelection *Optional* | +|video_url_list |videoUrlList |videoUrlList *Optional* | +|video_file_list |videoFileList |videoFileList *Optional* | +|external_video_source |externalVideoSource |externalVideoSource *Optional* |
-## `VoiceMessagingAlternateNoAnswerGreetingRead20`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `CallCenterReportInterval`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The configuration of a alternate no answer greeting. +Report interval for call center enhanced reporting scheduled reports. -It is used when geting a user's voice messaging greeting. **Attributes:** -|Name |Type |Description | -|-----------|----------|---------------------| -|name |str |name | -|audio_file |audioFile |audioFile *Optional* | -|video_file |videoFile |videoFile *Optional* | +|Name |Type |Description | +|--------|--------|-------------------| +|dates |dates |dates *Optional* | +|current |current |current *Optional* | +|past |past |past *Optional* |
-## `VoiceMessagingDistributionListModify`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `CallCenterReportSchedule`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-A list of voice mail distribution lists It is used when setting a user's voice -messaging distribution lists +A schedule for call center enhanced reporting scheduled report. + +It can either be a fixed time schedule or recurring schedule **Attributes:** -|Name |Type |Description | -|------------------|----------------|---------------------------| -|list_id |int |listId | -|description |str |description *Optional* | -|phone_number_list |phoneNumberList |phoneNumberList *Optional* | +|Name |Type |Description | +|--------------|-------------|------------------------| +|schedule_time |scheduleTime |scheduleTime *Optional* | +|recurrence |recurrence |recurrence *Optional* |
-## `AccessDeviceMultipleContactEndpointModify22`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `ConsolidatedGroupProperties`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Access device end point used in the context of modify that can have more than one -contact defined. -Only Static Registration capable devices may have more than one contact defined. Port -numbers are only used by devices with static line ordering. **Attributes:** -|Name |Type |Description | -|--------------|-------------|------------------------| -|access_device |accessDevice |accessDevice *Optional* | -|line_port |str |linePort *Optional* | -|contact_list |contactList |contactList *Optional* | -|port_number |int |portNumber *Optional* | +|Name |Type |Description | +|---------------------------------|-----------------------------|----------------------------------------| +|default_domain |str |defaultDomain | +|user_limit |int |userLimit | +|group_name |str |groupName *Optional* | +|calling_line_id_name |str |callingLineIdName *Optional* | +|time_zone |str |timeZone *Optional* | +|location_dialing_code |str |locationDialingCode *Optional* | +|contact |contact |contact *Optional* | +|address |address |address *Optional* | +|network_class_of_service |List[str] |networkClassOfService *Optional* | +|default_network_class_of_service |defaultNetworkClassOfService |defaultNetworkClassOfService *Optional* | +|group_service |List[groupService] |groupService *Optional* | +|service_policy |str |servicePolicy *Optional* |
-## `AccessDeviceMultipleIdentityAndContactEndpointModify22`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `EnhancedCallLogsNumberFilter`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Access device end point used in the context of modify that can have more than one -contact defined. +Filter criteria based on the called number or number called. -The endpoint is identified by its linePort (public Identity) and possibly a private -Identity. Only Static Registration capable devices may have more than one contact -defined. Port numbers are only used by devices with static line ordering. The -following elements are only used in XS data mode and ignored in AS data mode: -privateIdentity The following elements are only used in AS data mode and ignored in XS -data mode: useHotline hotlineContact **Attributes:** -|Name |Type |Description | -|-----------------|-------------|---------------------------| -|access_device |accessDevice |accessDevice *Optional* | -|line_port |str |linePort *Optional* | -|private_identity |str |privateIdentity *Optional* | -|contact_list |contactList |contactList *Optional* | -|port_number |int |portNumber *Optional* | -|use_hotline |bool |useHotline *Optional* | -|hotline_contact |str |hotlineContact *Optional* | +|Name |Type |Description | +|--------------------------------------------|----------------------------------------------|---------------------------------------------------| +|include_basic_call_type |List[str] |includeBasicCallType *Optional* | +|include_call_category |List[str] |includeCallCategory *Optional* | +|include_configurable_call_type |List[str] |includeConfigurableCallType *Optional* | +|search_criteria_dialed_number |List[searchCriteriaDialedNumber] |searchCriteriaDialedNumber *Optional* | +|search_criteria_called_number |List[searchCriteriaCalledNumber] |searchCriteriaCalledNumber *Optional* | +|search_criteria_network_translated_number |List[searchCriteriaNetworkTranslatedNumber] |searchCriteriaNetworkTranslatedNumber *Optional* | +|search_criteria_calling_presentation_number |List[searchCriteriaCallingPresentationNumber] |searchCriteriaCallingPresentationNumber *Optional* |
-## `AutoAttendantKeyConfiguration`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `EnhancedCallLogsRedirectedNumberFilter`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The configuration of a key for Auto Attendant. +Filter criteria based on the transferred/forwarded number. **Attributes:** -|Name |Type |Description| -|------|------|-----------| -|key |str |key | -|entry |entry |entry | +|Name |Type |Description | +|-------------------------------------------------------------|-------------------------------------------------------------|------------------------------------------------------------------| +|redirected_call |redirectedCall |redirectedCall *Optional* | +|include_service_invocation_basic_call_type |List[str] |includeServiceInvocationBasicCallType *Optional* | +|include_service_invocation_call_category |List[str] |includeServiceInvocationCallCategory *Optional* | +|include_service_invocation_configurable_call_type |List[str] |includeServiceInvocationConfigurableCallType *Optional* | +|search_criteria_service_invocation_dialed_number |List[searchCriteriaServiceInvocationDialedNumber] |searchCriteriaServiceInvocationDialedNumber *Optional* | +|search_criteria_service_invocation_called_number |List[searchCriteriaServiceInvocationCalledNumber] |searchCriteriaServiceInvocationCalledNumber *Optional* | +|search_criteria_service_invocation_network_translated_number |List[searchCriteriaServiceInvocationNetworkTranslatedNumber] |searchCriteriaServiceInvocationNetworkTranslatedNumber *Optional* |
-## `AutoAttendantKeyConfiguration19`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `EnhancedCallLogsRedirectedNumberFilter20sp1`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The configuration of a key for Auto Attendant. +Filter criteria based on the transferred/forwarded number. **Attributes:** -|Name |Type |Description| -|------|------|-----------| -|key |str |key | -|entry |entry |entry | +|Name |Type |Description | +|-------------------------------------------------------------|-------------------------------------------------------------|------------------------------------------------------------------| +|redirected_call |redirectedCall |redirectedCall *Optional* | +|include_service_invocation_basic_call_type |List[str] |includeServiceInvocationBasicCallType *Optional* | +|include_service_invocation_call_category |List[str] |includeServiceInvocationCallCategory *Optional* | +|include_service_invocation_configurable_call_type |List[str] |includeServiceInvocationConfigurableCallType *Optional* | +|search_criteria_service_invocation_dialed_number |List[searchCriteriaServiceInvocationDialedNumber] |searchCriteriaServiceInvocationDialedNumber *Optional* | +|search_criteria_service_invocation_called_number |List[searchCriteriaServiceInvocationCalledNumber] |searchCriteriaServiceInvocationCalledNumber *Optional* | +|search_criteria_service_invocation_network_translated_number |List[searchCriteriaServiceInvocationNetworkTranslatedNumber] |searchCriteriaServiceInvocationNetworkTranslatedNumber *Optional* |
-## `AutoAttendantKeyConfiguration20`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `EnhancedCallLogsRedirectedNumberFilter21`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The configuration of a key for Auto Attendant. +Filter criteria based on the transferred/forwarded number. **Attributes:** -|Name |Type |Description| -|------|------|-----------| -|key |str |key | -|entry |entry |entry | +|Name |Type |Description | +|-------------------------------------------------------------|-------------------------------------------------------------|------------------------------------------------------------------| +|redirected_call |redirectedCall |redirectedCall *Optional* | +|include_service_invocation_basic_call_type |List[str] |includeServiceInvocationBasicCallType *Optional* | +|include_service_invocation_call_category |List[str] |includeServiceInvocationCallCategory *Optional* | +|include_service_invocation_configurable_call_type |List[str] |includeServiceInvocationConfigurableCallType *Optional* | +|search_criteria_service_invocation_dialed_number |List[searchCriteriaServiceInvocationDialedNumber] |searchCriteriaServiceInvocationDialedNumber *Optional* | +|search_criteria_service_invocation_called_number |List[searchCriteriaServiceInvocationCalledNumber] |searchCriteriaServiceInvocationCalledNumber *Optional* | +|search_criteria_service_invocation_network_translated_number |List[searchCriteriaServiceInvocationNetworkTranslatedNumber] |searchCriteriaServiceInvocationNetworkTranslatedNumber *Optional* |
-## `AutoAttendantKeyModifyConfiguration`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `EnhancedCallLogsRedirectedNumberFilter21sp1`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The modify configuration of a key for Auto Attendant. +Filter criteria based on the transferred/forwarded number. **Attributes:** -|Name |Type |Description| -|------|------|-----------| -|key |str |key | -|entry |entry |entry | +|Name |Type |Description | +|-------------------------------------------------------------|-------------------------------------------------------------|------------------------------------------------------------------| +|redirected_call |redirectedCall |redirectedCall *Optional* | +|include_service_invocation_basic_call_type |List[str] |includeServiceInvocationBasicCallType *Optional* | +|include_service_invocation_call_category |List[str] |includeServiceInvocationCallCategory *Optional* | +|include_service_invocation_configurable_call_type |List[str] |includeServiceInvocationConfigurableCallType *Optional* | +|search_criteria_service_invocation_dialed_number |List[searchCriteriaServiceInvocationDialedNumber] |searchCriteriaServiceInvocationDialedNumber *Optional* | +|search_criteria_service_invocation_called_number |List[searchCriteriaServiceInvocationCalledNumber] |searchCriteriaServiceInvocationCalledNumber *Optional* | +|search_criteria_service_invocation_network_translated_number |List[searchCriteriaServiceInvocationNetworkTranslatedNumber] |searchCriteriaServiceInvocationNetworkTranslatedNumber *Optional* |
-## `AutoAttendantKeyModifyConfiguration20`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `EnhancedCallLogsRedirectedNumberFilter23`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The modify configuration of a key for Auto Attendant. +Filter criteria based on the transferred/forwarded number. **Attributes:** -|Name |Type |Description| -|------|------|-----------| -|key |str |key | -|entry |entry |entry | +|Name |Type |Description | +|-------------------------------------------------------------|-------------------------------------------------------------|------------------------------------------------------------------| +|redirected_call |redirectedCall |redirectedCall *Optional* | +|include_service_invocation_basic_call_type |List[str] |includeServiceInvocationBasicCallType *Optional* | +|include_service_invocation_call_category |List[str] |includeServiceInvocationCallCategory *Optional* | +|include_service_invocation_configurable_call_type |List[str] |includeServiceInvocationConfigurableCallType *Optional* | +|search_criteria_service_invocation_dialed_number |List[searchCriteriaServiceInvocationDialedNumber] |searchCriteriaServiceInvocationDialedNumber *Optional* | +|search_criteria_service_invocation_called_number |List[searchCriteriaServiceInvocationCalledNumber] |searchCriteriaServiceInvocationCalledNumber *Optional* | +|search_criteria_service_invocation_network_translated_number |List[searchCriteriaServiceInvocationNetworkTranslatedNumber] |searchCriteriaServiceInvocationNetworkTranslatedNumber *Optional* |
-## `AutoAttendantKeyReadConfiguration20`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `EnterpriseSessionAdmissionControlGroupGetResponse21sp1V2`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The read configuration of a key for Auto Attendant. +Response to EnterpriseSessionAdmissionControlGroupGetRequest21sp1V2. +Returns the profile information for the session admission control group. **Attributes:** -|Name |Type |Description| -|------|------|-----------| -|key |str |key | -|entry |entry |entry | +|Name |Type |Description | +|---------------------------------------------------|--------------|-------------------------------------------| +|max_session |int |maxSession | +|max_user_originating_sessions |int |maxUserOriginatingSessions *Optional* | +|max_user_terminating_sessions |int |maxUserTerminatingSessions *Optional* | +|reserved_session |int |reservedSession | +|reserved_user_originating_sessions |int |reservedUserOriginatingSessions *Optional* | +|reserved_user_terminating_sessions |int |reservedUserTerminatingSessions *Optional* | +|default_group |bool |defaultGroup | +|count_intra_sac_group_sessions |bool |countIntraSACGroupSessions | +|devices |List[devices] |devices *Optional* | +|block_emergency_and_repair_calls_due_to_sac_limits |bool |blockEmergencyAndRepairCallsDueToSACLimits | +|media_group_name |str |mediaGroupName *Optional* | +|access_info_pattern |str |accessInfoPattern *Optional* |
-## `AutoAttendantReadMenu19`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `GroupHuntGroupAddInstanceRequest17sp1V1`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-The configuration of the automated receptionist greeting prompt and dialing menu to be -used during after business hours. +Add a Hunt Group instance to a group. +The domain is required in the serviceUserId. + +The response is either `SuccessResponse()` or `ErrorResponse()`. The following +elements are only used in XS data mode: allowMembersToControlGroupBusy, use value +"false" in AS data mode enableGroupBusy, use value "false" in AS data mode **Attributes:** -|Name |Type |Description | -|------------------------------------------|-----------------------|-------------------------------------| -|announcement_selection |str |announcementSelection | -|audio_file_description |str |audioFileDescription *Optional* | -|audio_media_type |str |audioMediaType *Optional* | -|video_file_description |str |videoFileDescription *Optional* | -|video_media_type |str |videoMediaType *Optional* | -|enable_first_menu_level_extension_dialing |bool |enableFirstMenuLevelExtensionDialing | -|key_configuration |List[keyConfiguration] |keyConfiguration *Optional* | +|Name |Type |Description | +|------------------------------------|-----------------------|--------------------------------| +|service_provider_id |str |serviceProviderId | +|group_id |str |groupId | +|service_user_id |str |serviceUserId | +|service_instance_profile |serviceInstanceProfile |serviceInstanceProfile | +|policy |str |policy | +|hunt_after_no_answer |bool |huntAfterNoAnswer | +|no_answer_number_of_rings |int |noAnswerNumberOfRings | +|forward_after_timeout |bool |forwardAfterTimeout | +|forward_timeout_seconds |int |forwardTimeoutSeconds | +|forward_to_phone_number |str |forwardToPhoneNumber *Optional* | +|agent_user_id |List[str] |agentUserId *Optional* | +|allow_call_waiting_for_agents |bool |allowCallWaitingForAgents | +|allow_members_to_control_group_busy |bool |allowMembersToControlGroupBusy | +|enable_group_busy |bool |enableGroupBusy |
-## `CPEDeviceModifyOptions`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `GroupHuntGroupGetInstanceResponse17sp1V1`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-CPE device's options when used with a modify request. +Response to GroupHuntGroupGetInstanceRequest17sp1V1. -The following options are not changeable: configType systemFileName deviceFileFormat +Contains the service profile information and a table of assigned users. The table has +column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana +First Name", "Weight". The following elements are only used in XS data mode: +allowMembersToControlGroupBusy enableGroupBusy **Attributes:** -|Name |Type |Description | -|--------------------------------------|----------------------------------|---------------------------------------------| -|enable_monitoring |bool |enableMonitoring *Optional* | -|reset_event |str |resetEvent *Optional* | -|device_management_device_type_options |deviceManagementDeviceTypeOptions |deviceManagementDeviceTypeOptions *Optional* | +|Name |Type |Description | +|------------------------------------|-----------------------|--------------------------------------------------------------| +|service_instance_profile |serviceInstanceProfile |serviceInstanceProfile | +|policy |str |policy | +|hunt_after_no_answer |bool |huntAfterNoAnswer | +|no_answer_number_of_rings |int |noAnswerNumberOfRings | +|forward_after_timeout |bool |forwardAfterTimeout | +|forward_timeout_seconds |int |forwardTimeoutSeconds | +|forward_to_phone_number |str |forwardToPhoneNumber *Optional* | +|agent_user_table |List(agentUserTable) |agentUserTable - *Table* array of agentUserTable named tuples | +|allow_call_waiting_for_agents |bool |allowCallWaitingForAgents | +|allow_members_to_control_group_busy |bool |allowMembersToControlGroupBusy | +|enable_group_busy |bool |enableGroupBusy |
-## `CPEDeviceModifyOptions16`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `GroupTrunkGroupAddInstanceRequest14sp9A`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-CPE device's options when used with a modify request. +Add a Trunk Group instance to a group. -The following options are not changeable: configType systemFileName deviceFileFormat +The response is either a `SuccessResponse()` or an `ErrorResponse()`. **Attributes:** -|Name |Type |Description | -|--------------------------------------|----------------------------------|---------------------------------------------| -|enable_monitoring |bool |enableMonitoring *Optional* | -|reset_event |str |resetEvent *Optional* | -|device_management_device_type_options |deviceManagementDeviceTypeOptions |deviceManagementDeviceTypeOptions *Optional* | +|Name |Type |Description | +|------------------------------------------------|-------------------------------------------|------------------------------------------------------| +|service_provider_id |str |serviceProviderId | +|group_id |str |groupId | +|name |str |name | +|pilot_user |pilotUser |pilotUser *Optional* | +|department |department |department *Optional* | +|access_device |accessDevice |accessDevice *Optional* | +|max_active_calls |int |maxActiveCalls | +|max_incoming_calls |int |maxIncomingCalls *Optional* | +|max_outgoing_calls |int |maxOutgoingCalls *Optional* | +|enable_bursting |bool |enableBursting | +|bursting_max_active_calls |int |burstingMaxActiveCalls *Optional* | +|bursting_max_incoming_calls |int |burstingMaxIncomingCalls *Optional* | +|bursting_max_outgoing_calls |int |burstingMaxOutgoingCalls *Optional* | +|capacity_exceeded_action |str |capacityExceededAction *Optional* | +|capacity_exceeded_forward_address |str |capacityExceededForwardAddress *Optional* | +|capacity_exceeded_reroute_trunk_group_key |capacityExceededRerouteTrunkGroupKey |capacityExceededRerouteTrunkGroupKey *Optional* | +|capacity_exceeded_trap_initial_calls |int |capacityExceededTrapInitialCalls | +|capacity_exceeded_trap_offset_calls |int |capacityExceededTrapOffsetCalls | +|unreachable_destination_action |str |unreachableDestinationAction *Optional* | +|unreachable_destination_forward_address |str |unreachableDestinationForwardAddress *Optional* | +|unreachable_destination_reroute_trunk_group_key |unreachableDestinationRerouteTrunkGroupKey |unreachableDestinationRerouteTrunkGroupKey *Optional* | +|unreachable_destination_trap_initial_calls |int |unreachableDestinationTrapInitialCalls | +|unreachable_destination_trap_offset_calls |int |unreachableDestinationTrapOffsetCalls | +|invitation_timeout |int |invitationTimeout | +|require_authentication |bool |requireAuthentication | +|sip_authentication_user_name |str |sipAuthenticationUserName *Optional* | +|sip_authentication_password |str |sipAuthenticationPassword *Optional* | +|hosted_user_id |List[str] |hostedUserId *Optional* | +|trunk_group_identity |str |trunkGroupIdentity *Optional* | +|otg_dtg_identity |str |otgDtgIdentity *Optional* | +|include_trunk_group_identity |bool |includeTrunkGroupIdentity | +|include_dtg_identity |bool |includeDtgIdentity | +|enable_network_address_identity |bool |enableNetworkAddressIdentity | +|allow_unscreened_calls |bool |allowUnscreenedCalls | +|allow_unscreened_emergency_calls |bool |allowUnscreenedEmergencyCalls | +|pilot_user_calling_line_identity_policy |str |pilotUserCallingLineIdentityPolicy | +|pilot_user_charge_number_policy |str |pilotUserChargeNumberPolicy | +|call_forwarding_always_action |str |callForwardingAlwaysAction *Optional* | +|call_forwarding_always_forward_address |str |callForwardingAlwaysForwardAddress *Optional* | +|call_forwarding_always_reroute_trunk_group_key |callForwardingAlwaysRerouteTrunkGroupKey |callForwardingAlwaysRerouteTrunkGroupKey *Optional* |
-## `CPEDeviceModifyOptions16sp1`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `OutgoingCallingPlanDigitPatternCallMeNowDepartmentPermissions`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-CPE device's options when used with a modify request. +Outgoing Calling Plan Call Me Now call permissions for specified digit patterns. -The following options are not changeable: configType systemFileName deviceFileFormat **Attributes:** -|Name |Type |Description | -|--------------------------------------|----------------------------------|---------------------------------------------| -|enable_monitoring |bool |enableMonitoring *Optional* | -|device_management_device_type_options |deviceManagementDeviceTypeOptions |deviceManagementDeviceTypeOptions *Optional* | +|Name |Type |Description | +|--------------------------|------------------------|------------------------| +|department_key |departmentKey |departmentKey | +|department_name |str |departmentName | +|digit_pattern_permissions |digitPatternPermissions |digitPatternPermissions |
-## `CPEDeviceModifyOptions22`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `OutgoingCallingPlanDigitPatternCallMeNowDepartmentPermissionsModify`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-CPE device's options when used with a modify request. +Modify outgoing Calling Plan Call Me Now call permissions for specified digit +patterns. -The following options are not changeable: configType systemFileName deviceFileFormat **Attributes:** -|Name |Type |Description | -|--------------------------------------|----------------------------------|---------------------------------------------| -|enable_monitoring |bool |enableMonitoring *Optional* | -|device_management_device_type_options |deviceManagementDeviceTypeOptions |deviceManagementDeviceTypeOptions *Optional* | +|Name |Type |Description | +|--------------------------|------------------------|------------------------| +|department_key |departmentKey |departmentKey | +|digit_pattern_permissions |digitPatternPermissions |digitPatternPermissions |
-## `CPEDeviceOptions14sp6`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `OutgoingCallingPlanDigitPatternOriginatingDepartmentPermissions`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-CPE device's options. +Outgoing Calling Plan originating call permissions for specified digit patterns. **Attributes:** -|Name |Type |Description | -|--------------------------------------|----------------------------------|---------------------------------------------| -|enable_monitoring |bool |enableMonitoring | -|reset_event |str |resetEvent *Optional* | -|config_type |str |configType | -|system_file_name |str |systemFileName *Optional* | -|device_file_format |str |deviceFileFormat *Optional* | -|device_management_device_type_options |deviceManagementDeviceTypeOptions |deviceManagementDeviceTypeOptions *Optional* | +|Name |Type |Description | +|--------------------------|------------------------|------------------------| +|department_key |departmentKey |departmentKey | +|department_name |str |departmentName | +|digit_pattern_permissions |digitPatternPermissions |digitPatternPermissions |
-## `CPEDeviceOptions16`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `OutgoingCallingPlanDigitPatternOriginatingDepartmentPermissionsModify`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-CPE device's options. +Modify outgoing Calling Plan originating call permissions for specified digit +patterns. **Attributes:** -|Name |Type |Description | -|--------------------------------------|----------------------------------|---------------------------------------------| -|enable_monitoring |bool |enableMonitoring | -|reset_event |str |resetEvent *Optional* | -|config_type |str |configType | -|system_file_name |str |systemFileName *Optional* | -|device_file_format |str |deviceFileFormat *Optional* | -|device_management_device_type_options |deviceManagementDeviceTypeOptions |deviceManagementDeviceTypeOptions *Optional* | +|Name |Type |Description | +|--------------------------|------------------------|------------------------| +|department_key |departmentKey |departmentKey | +|digit_pattern_permissions |digitPatternPermissions |digitPatternPermissions |
-## `CPEDeviceOptions16sp1`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `OutgoingCallingPlanDigitPatternRedirectingDepartmentPermissions`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-CPE device's options. +Outgoing Calling Plan redirecting call permissions for specified digit patterns. -The field configType is optional to allow the use of field enableMonitoring for all -device types being managed or not ie. device configuration option equals to -DeviceManagement, or Legacy, or Not Supported). If the device configuration option is -set to "Not Supported", the value of configType is forced set to "None" regardless of -its current value. It is not allowed to add a device type with device configuration -option set to Device Management or Legacy when the configType is not set. **Attributes:** -|Name |Type |Description | -|--------------------------------------|----------------------------------|---------------------------------------------| -|enable_monitoring |bool |enableMonitoring | -|config_type |str |configType *Optional* | -|system_file_name |str |systemFileName *Optional* | -|device_file_format |str |deviceFileFormat *Optional* | -|device_management_device_type_options |deviceManagementDeviceTypeOptions |deviceManagementDeviceTypeOptions *Optional* | +|Name |Type |Description | +|--------------------------|------------------------|------------------------| +|department_key |departmentKey |departmentKey | +|department_name |str |departmentName | +|digit_pattern_permissions |digitPatternPermissions |digitPatternPermissions |
-## `CPEDeviceOptions21sp1`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `OutgoingCallingPlanDigitPatternRedirectingDepartmentPermissionsModify`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-CPE device's options. +Modify outgoing Calling Plan redirecting call permissions for specified digit +patterns. -The field configType is optional to allow the use of field enableMonitoring for all -device types being managed or not ie. device configuration option equals to -DeviceManagement, or Legacy, or Not Supported). If the device configuration option is -set to "Not Supported", the value of configType is forced set to "None" regardless of -its current value. It is not allowed to add a device type with device configuration -option set to Device Management or Legacy when the configType is not set. **Attributes:** -|Name |Type |Description | -|--------------------------------------|----------------------------------|---------------------------------------------| -|enable_monitoring |bool |enableMonitoring | -|config_type |str |configType *Optional* | -|system_file_name |str |systemFileName *Optional* | -|device_file_format |str |deviceFileFormat *Optional* | -|device_management_device_type_options |deviceManagementDeviceTypeOptions |deviceManagementDeviceTypeOptions *Optional* | +|Name |Type |Description | +|--------------------------|------------------------|------------------------| +|department_key |departmentKey |departmentKey | +|digit_pattern_permissions |digitPatternPermissions |digitPatternPermissions |
-## `CPEDeviceOptions22`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `OutgoingPinholeDigitPlanDigitPatternCallMeNowDepartmentPermissions`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-CPE device's options. +Outgoing Pinhole Digit Plan Call Me Now call permissions for a department. -The field configType is optional to allow the use of field enableMonitoring for all -device types being managed or not ie. device configuration option equals to -DeviceManagement, or Legacy, or Not Supported). If the device configuration option is -set to "Not Supported", the value of configType is forced set to "None" regardless of -its current value. It is not allowed to add a device type with device configuration -option set to Device Management or Legacy when the configType is not set. **Attributes:** -|Name |Type |Description | -|--------------------------------------|----------------------------------|---------------------------------------------| -|enable_monitoring |bool |enableMonitoring | -|config_type |str |configType *Optional* | -|system_file_name |str |systemFileName *Optional* | -|device_file_format |str |deviceFileFormat *Optional* | -|device_management_device_type_options |deviceManagementDeviceTypeOptions |deviceManagementDeviceTypeOptions *Optional* | +|Name |Type |Description | +|----------------|--------------|---------------| +|department_key |departmentKey |departmentKey | +|department_name |str |departmentName | +|permissions |permissions |permissions |
-## `CPEDeviceOptions22V2`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `OutgoingPinholeDigitPlanDigitPatternCallMeNowDepartmentPermissionsModify`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-CPE device's options. +Modify Outgoing Pinhole Digit Plan Call Me Now call permissions for specified digit +patterns. -The field configType is optional to allow the use of field enableMonitoring for all -device types being managed or not ie. device configuration option equals to -DeviceManagement, or Legacy, or Not Supported). If the device configuration option is -set to "Not Supported", the value of configType is forced set to "None" regardless of -its current value. It is not allowed to add a device type with device configuration -option set to Device Management or Legacy when the configType is not set. **Attributes:** -|Name |Type |Description | -|--------------------------------------|----------------------------------|---------------------------------------------| -|enable_monitoring |bool |enableMonitoring | -|config_type |str |configType *Optional* | -|system_file_name |str |systemFileName *Optional* | -|device_file_format |str |deviceFileFormat *Optional* | -|device_management_device_type_options |deviceManagementDeviceTypeOptions |deviceManagementDeviceTypeOptions *Optional* | +|Name |Type |Description | +|--------------------------|------------------------|------------------------| +|department_key |departmentKey |departmentKey | +|digit_pattern_permissions |digitPatternPermissions |digitPatternPermissions |
-## `CPEDeviceOptions22V3`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `OutgoingPinholeDigitPlanDigitPatternOriginatingDepartmentPermissions`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-CPE device's options. +Outgoing Pinhole Digit Plan department originating call permissions for specified +digit patterns. -The field configType is optional to allow the use of field enableMonitoring for all -device types being managed or not ie. device configuration option equals to -DeviceManagement, or Legacy, or Not Supported). If the device configuration option is -set to "Not Supported", the value of configType is forced set to "None" regardless of -its current value. It is not allowed to add a device type with device configuration -option set to Device Management or Legacy when the configType is not set. **Attributes:** -|Name |Type |Description | -|--------------------------------------|----------------------------------|---------------------------------------------| -|enable_monitoring |bool |enableMonitoring | -|config_type |str |configType *Optional* | -|system_file_name |str |systemFileName *Optional* | -|device_file_format |str |deviceFileFormat *Optional* | -|device_management_device_type_options |deviceManagementDeviceTypeOptions |deviceManagementDeviceTypeOptions *Optional* | +|Name |Type |Description | +|--------------------------|------------------------|------------------------| +|department_key |departmentKey |departmentKey | +|department_name |str |departmentName | +|digit_pattern_permissions |digitPatternPermissions |digitPatternPermissions |
-## `CPEDeviceOptions22V4`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `OutgoingPinholeDigitPlanDigitPatternOriginatingDepartmentPermissionsModify`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-CPE device's options. +Modify Outgoing Pinhole Digit Plan originating call permissions for specified digit +patterns. -The field configType is optional to allow the use of field enableMonitoring for all -device types being managed or not ie. device configuration option equals to -DeviceManagement, or Legacy, or Not Supported). If the device configuration option is -set to "Not Supported", the value of configType is forced set to "None" regardless of -its current value. It is not allowed to add a device type with device configuration -option set to Device Management or Legacy when the configType is not set. **Attributes:** -|Name |Type |Description | -|--------------------------------------|----------------------------------|---------------------------------------------| -|enable_monitoring |bool |enableMonitoring | -|config_type |str |configType *Optional* | -|system_file_name |str |systemFileName *Optional* | -|device_file_format |str |deviceFileFormat *Optional* | -|device_management_device_type_options |deviceManagementDeviceTypeOptions |deviceManagementDeviceTypeOptions *Optional* | +|Name |Type |Description | +|--------------------------|------------------------|------------------------| +|department_key |departmentKey |departmentKey | +|digit_pattern_permissions |digitPatternPermissions |digitPatternPermissions |
-## `CallCenterMediaOnHoldSourceModify16`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `OutgoingPinholeDigitPlanDigitPatternRedirectingDepartmentPermissions`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Contains the call center media on hold source configuration. +Outgoing Pinhole Digit Plan initiating call forwards/transfer permissions for a +department. **Attributes:** -|Name |Type |Description | -|-------------------------------|--------------------|---------------------------------------| -|audio_message_source_selection |str |audioMessageSourceSelection *Optional* | -|audio_file |audioFile |audioFile *Optional* | -|external_audio_source |externalAudioSource |externalAudioSource *Optional* | -|video_message_source_selection |str |videoMessageSourceSelection *Optional* | -|video_file |videoFile |videoFile *Optional* | -|external_video_source |externalVideoSource |externalVideoSource *Optional* | +|Name |Type |Description | +|----------------|--------------|---------------| +|department_key |departmentKey |departmentKey | +|department_name |str |departmentName | +|permissions |permissions |permissions |
-## `CallCenterMediaOnHoldSourceModify17`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `OutgoingPinholeDigitPlanDigitPatternRedirectingDepartmentPermissionsModify`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Contains the call center media on hold source configuration. +Modify Outgoing Pinhole Digit Plan redirecting call permissions for specified digit +patterns. **Attributes:** -|Name |Type |Description | -|-------------------------------|--------------------|---------------------------------------| -|audio_message_source_selection |str |audioMessageSourceSelection *Optional* | -|audio_url_list |audioUrlList |audioUrlList *Optional* | -|audio_file_list |audioFileList |audioFileList *Optional* | -|external_audio_source |externalAudioSource |externalAudioSource *Optional* | -|video_message_source_selection |str |videoMessageSourceSelection *Optional* | -|video_url_list |videoUrlList |videoUrlList *Optional* | -|video_file_list |videoFileList |videoFileList *Optional* | -|external_video_source |externalVideoSource |externalVideoSource *Optional* | +|Name |Type |Description | +|--------------------------|------------------------|------------------------| +|department_key |departmentKey |departmentKey | +|digit_pattern_permissions |digitPatternPermissions |digitPatternPermissions |
-## `CallCenterMediaOnHoldSourceModify20`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `PushNotificationRegistrationData`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Contains the call center media on hold source configuration. +? The common push notification registration elements. **Attributes:** -|Name |Type |Description | -|-------------------------------|--------------------|---------------------------------------| -|audio_message_source_selection |str |audioMessageSourceSelection *Optional* | -|audio_url_list |audioUrlList |audioUrlList *Optional* | -|audio_file_list |audioFileList |audioFileList *Optional* | -|external_audio_source |externalAudioSource |externalAudioSource *Optional* | -|video_message_source_selection |str |videoMessageSourceSelection *Optional* | -|video_url_list |videoUrlList |videoUrlList *Optional* | -|video_file_list |videoFileList |videoFileList *Optional* | -|external_video_source |externalVideoSource |externalVideoSource *Optional* | +|Name |Type |Description | +|---------------------------------|--------------------------------|-------------------------------------| +|registration_id |str |registrationId | +|application_id |str |applicationId | +|application_version |str |applicationVersion | +|device_os_type |str |deviceOsType | +|device_version |str |deviceVersion | +|timestamp |str |timestamp | +|push_notification_client_version |str |pushNotificationClientVersion | +|push_notification_token_data |List[pushNotificationTokenData] |pushNotificationTokenData *Optional* |
-## `CallCenterMediaOnHoldSourceRead16`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `ReplacementCombinedGroupServiceAuthorizationList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Contains the call center media on hold source configuration. +A list of group services that replaces a previously authorized group services. **Attributes:** -|Name |Type |Description | -|-------------------------------|--------------------|---------------------------------------| -|audio_message_source_selection |str |audioMessageSourceSelection | -|audio_file_url |str |audioFileUrl *Optional* | -|audio_file_description |str |audioFileDescription *Optional* | -|audio_file_media_type |str |audioFileMediaType *Optional* | -|external_audio_source |externalAudioSource |externalAudioSource *Optional* | -|video_message_source_selection |str |videoMessageSourceSelection *Optional* | -|video_file_url |str |videoFileUrl *Optional* | -|video_file_description |str |videoFileDescription *Optional* | -|video_file_media_type |str |videoFileMediaType *Optional* | -|external_video_source |externalVideoSource |externalVideoSource *Optional* | +|Name |Type |Description | +|----------------------------|--------------------------------|--------------------------| +|group_service_authorization |List[groupServiceAuthorization] |groupServiceAuthorization |
-## `CallCenterMediaOnHoldSourceRead17`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `ReplacementCombinedServicePackAssignmentList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Contains the call center media on hold source configuration. +A list of service packs that replaces existing service packs assgined to the user. -Replaced by: CallCenterMediaOnHoldSourceRead19. +If a service pack is already assigned to the user, the service quantitiy will be +updated if included. **Attributes:** -|Name |Type |Description | -|-------------------------------|--------------------|---------------------------------------| -|audio_message_source_selection |str |audioMessageSourceSelection | -|audio_url_list |audioUrlList |audioUrlList *Optional* | -|audio_file_list |audioFileList |audioFileList *Optional* | -|audio_media_type_list |audioMediaTypeList |audioMediaTypeList *Optional* | -|external_audio_source |externalAudioSource |externalAudioSource *Optional* | -|video_message_source_selection |str |videoMessageSourceSelection *Optional* | -|video_url_list |videoUrlList |videoUrlList *Optional* | -|video_file_list |videoFileList |videoFileList *Optional* | -|video_media_type_list |videoMediaTypeList |videoMediaTypeList *Optional* | -|external_video_source |externalVideoSource |externalVideoSource *Optional* | +|Name |Type |Description | +|-------------|------------------|------------| +|service_pack |List[servicePack] |servicePack |
-## `CallCenterMediaOnHoldSourceRead19`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `ReplacementCombinedServicePackAuthorizationList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Contains the call center media on hold source configuration. +A list of service packs that replaces previously authorized service packs. **Attributes:** -|Name |Type |Description | -|-------------------------------|--------------------|---------------------------------------| -|audio_message_source_selection |str |audioMessageSourceSelection | -|audio_url_list |audioUrlList |audioUrlList *Optional* | -|audio_file_list |audioFileList |audioFileList *Optional* | -|audio_media_type_list |audioMediaTypeList |audioMediaTypeList *Optional* | -|external_audio_source |externalAudioSource |externalAudioSource *Optional* | -|video_message_source_selection |str |videoMessageSourceSelection *Optional* | -|video_url_list |videoUrlList |videoUrlList *Optional* | -|video_file_list |videoFileList |videoFileList *Optional* | -|video_media_type_list |videoMediaTypeList |videoMediaTypeList *Optional* | -|external_video_source |externalVideoSource |externalVideoSource *Optional* | +|Name |Type |Description | +|---------------------------|-------------------------------|-------------------------| +|service_pack_authorization |List[servicePackAuthorization] |servicePackAuthorization |
-## `CallCenterMediaOnHoldSourceRead20`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `ReplacementCombinedSharedCallAppearanceAccessDeviceMultipleIdentityEndpointList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Contains the call center media on hold source configuration. +A list of shared call appearance endpoints that replaces existing endpoints. **Attributes:** -|Name |Type |Description | -|-------------------------------|--------------------|---------------------------------------| -|audio_message_source_selection |str |audioMessageSourceSelection | -|audio_url_list |audioUrlList |audioUrlList *Optional* | -|audio_file_list |audioFileList |audioFileList *Optional* | -|external_audio_source |externalAudioSource |externalAudioSource *Optional* | -|video_message_source_selection |str |videoMessageSourceSelection *Optional* | -|video_url_list |videoUrlList |videoUrlList *Optional* | -|video_file_list |videoFileList |videoFileList *Optional* | -|external_video_source |externalVideoSource |externalVideoSource *Optional* | +|Name |Type |Description | +|----------------------------------------------|-----------------------------------------------|-----------------------------------------| +|shared_call_appearance_access_device_endpoint |List[sharedCallAppearanceAccessDeviceEndpoint] |sharedCallAppearanceAccessDeviceEndpoint |
-## `CallCenterMediaOnHoldSourceRead22`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `ReplacementCombinedUserServiceAssignmentList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Contains the call center media on hold source configuration. +A list of user services that replaces existing user services assgined to the user. +If a service is already assigned to the user, the service quantitiy will be updated if +included. **Attributes:** -|Name |Type |Description | -|-------------------------------|--------------------|---------------------------------------| -|audio_message_source_selection |str |audioMessageSourceSelection | -|audio_url_list |audioUrlList |audioUrlList *Optional* | -|audio_file_list |audioFileList |audioFileList *Optional* | -|external_audio_source |externalAudioSource |externalAudioSource *Optional* | -|video_message_source_selection |str |videoMessageSourceSelection *Optional* | -|video_url_list |videoUrlList |videoUrlList *Optional* | -|video_file_list |videoFileList |videoFileList *Optional* | -|external_video_source |externalVideoSource |externalVideoSource *Optional* | +|Name |Type |Description | +|-------------|------------------|------------| +|service_name |List[serviceName] |serviceName |
-## `CallCenterReportInterval`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `ReplacementCombinedUserServiceAuthorizationList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Report interval for call center enhanced reporting scheduled reports. +A list of user services that replaces a previously authorized user services. **Attributes:** -|Name |Type |Description | -|--------|--------|-------------------| -|dates |dates |dates *Optional* | -|current |current |current *Optional* | -|past |past |past *Optional* | +|Name |Type |Description | +|---------------------------|-------------------------------|-------------------------| +|user_service_authorization |List[userServiceAuthorization] |userServiceAuthorization |
-## `CallCenterReportSchedule`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `ReplacementConsolidatedServicePackAssignmentList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-A schedule for call center enhanced reporting scheduled report. +A list of service packs that replaces existing service packs assigned to the user. -It can either be a fixed time schedule or recurring schedule +If a service pack is not authorized to the group, the service will be authorized. The +authorizedQuantity will be used if provided; otherwise, the service quantity will be +set to unlimited. The command will fail if the authorized Quantity set at the service +provider is insufficient If a service pack is already authorized to the group, the +service quantity will be ignored if included. **Attributes:** -|Name |Type |Description | -|--------------|-------------|------------------------| -|schedule_time |scheduleTime |scheduleTime *Optional* | -|recurrence |recurrence |recurrence *Optional* | +|Name |Type |Description | +|-------------|------------------|------------| +|service_pack |List[servicePack] |servicePack |
-## `ConsolidatedGroupProperties`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `ReplacementConsolidatedSharedCallAppearanceAccessDeviceMultipleIdentityEndpointList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
+A list of shared call appearance endpoints that replaces existing endpoints. **Attributes:** -|Name |Type |Description | -|---------------------------------|-----------------------------|----------------------------------------| -|default_domain |str |defaultDomain | -|user_limit |int |userLimit | -|group_name |str |groupName *Optional* | -|calling_line_id_name |str |callingLineIdName *Optional* | -|time_zone |str |timeZone *Optional* | -|location_dialing_code |str |locationDialingCode *Optional* | -|contact |contact |contact *Optional* | -|address |address |address *Optional* | -|network_class_of_service |List[str] |networkClassOfService *Optional* | -|default_network_class_of_service |defaultNetworkClassOfService |defaultNetworkClassOfService *Optional* | -|group_service |List[groupService] |groupService *Optional* | -|service_policy |str |servicePolicy *Optional* | +|Name |Type |Description | +|----------------------------------------------|-----------------------------------------------|-----------------------------------------| +|shared_call_appearance_access_device_endpoint |List[sharedCallAppearanceAccessDeviceEndpoint] |sharedCallAppearanceAccessDeviceEndpoint |
-## `EnterpriseSessionAdmissionControlGroupGetResponse21sp1V2`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `ReplacementConsolidatedSharedCallAppearanceAccessDeviceMultipleIdentityEndpointList22`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Response to EnterpriseSessionAdmissionControlGroupGetRequest21sp1V2. +A list of shared call appearance endpoints that replaces existing endpoints. -Returns the profile information for the session admission control group. **Attributes:** -|Name |Type |Description | -|---------------------------------------------------|--------------|-------------------------------------------| -|max_session |int |maxSession | -|max_user_originating_sessions |int |maxUserOriginatingSessions *Optional* | -|max_user_terminating_sessions |int |maxUserTerminatingSessions *Optional* | -|reserved_session |int |reservedSession | -|reserved_user_originating_sessions |int |reservedUserOriginatingSessions *Optional* | -|reserved_user_terminating_sessions |int |reservedUserTerminatingSessions *Optional* | -|default_group |bool |defaultGroup | -|count_intra_sac_group_sessions |bool |countIntraSACGroupSessions | -|devices |List[devices] |devices *Optional* | -|block_emergency_and_repair_calls_due_to_sac_limits |bool |blockEmergencyAndRepairCallsDueToSACLimits | -|media_group_name |str |mediaGroupName *Optional* | -|access_info_pattern |str |accessInfoPattern *Optional* | +|Name |Type |Description | +|----------------------------------------------|-----------------------------------------------|-----------------------------------------| +|shared_call_appearance_access_device_endpoint |List[sharedCallAppearanceAccessDeviceEndpoint] |sharedCallAppearanceAccessDeviceEndpoint |
-## `GroupHuntGroupAddInstanceRequest17sp1V1`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `ReplacementConsolidatedUserServiceAssignmentList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Add a Hunt Group instance to a group. - -The domain is required in the serviceUserId. +A list of user services that replaces existing user services assigned to the user. -The response is either `SuccessResponse()` or `ErrorResponse()`. The following -elements are only used in XS data mode: allowMembersToControlGroupBusy, use value -"false" in AS data mode enableGroupBusy, use value "false" in AS data mode +If a service is not authorized to the group, the service will be authorized. The +authorizedQuantity will be used if provided; otherwise, the service quantity will be +set to unlimited. The command will fail if the authorized Quantity set at the service +provider is insufficient. If a service is already authorized to the group, the +service quantity will be ignored if included. **Attributes:** -|Name |Type |Description | -|------------------------------------|-----------------------|--------------------------------| -|service_provider_id |str |serviceProviderId | -|group_id |str |groupId | -|service_user_id |str |serviceUserId | -|service_instance_profile |serviceInstanceProfile |serviceInstanceProfile | -|policy |str |policy | -|hunt_after_no_answer |bool |huntAfterNoAnswer | -|no_answer_number_of_rings |int |noAnswerNumberOfRings | -|forward_after_timeout |bool |forwardAfterTimeout | -|forward_timeout_seconds |int |forwardTimeoutSeconds | -|forward_to_phone_number |str |forwardToPhoneNumber *Optional* | -|agent_user_id |List[str] |agentUserId *Optional* | -|allow_call_waiting_for_agents |bool |allowCallWaitingForAgents | -|allow_members_to_control_group_busy |bool |allowMembersToControlGroupBusy | -|enable_group_busy |bool |enableGroupBusy | +|Name |Type |Description | +|--------------------------|-----------------------------|-----------------------| +|user_service_service_name |List[userServiceServiceName] |userServiceServiceName |
-## `GroupHuntGroupGetInstanceResponse17sp1V1`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `ReplacementEnterpriseDeviceList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Response to GroupHuntGroupGetInstanceRequest17sp1V1. +A list of enterprise accessible devices that replaces a previously configured list. -Contains the service profile information and a table of assigned users. The table has -column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana -First Name", "Weight". The following elements are only used in XS data mode: -allowMembersToControlGroupBusy enableGroupBusy +By convention, an element of this type may be set nill to clear the list. **Attributes:** -|Name |Type |Description | -|------------------------------------|-----------------------|--------------------------------------------------------------| -|service_instance_profile |serviceInstanceProfile |serviceInstanceProfile | -|policy |str |policy | -|hunt_after_no_answer |bool |huntAfterNoAnswer | -|no_answer_number_of_rings |int |noAnswerNumberOfRings | -|forward_after_timeout |bool |forwardAfterTimeout | -|forward_timeout_seconds |int |forwardTimeoutSeconds | -|forward_to_phone_number |str |forwardToPhoneNumber *Optional* | -|agent_user_table |List(agentUserTable) |agentUserTable - *Table* array of agentUserTable named tuples | -|allow_call_waiting_for_agents |bool |allowCallWaitingForAgents | -|allow_members_to_control_group_busy |bool |allowMembersToControlGroupBusy | -|enable_group_busy |bool |enableGroupBusy | +|Name |Type |Description| +|-------|-------------|-----------| +|device |List[device] |device |
-## `GroupTrunkGroupAddInstanceRequest14sp9A`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `ReplacementEnterpriseEnterpriseTrunkPriorityWeightedTrunkGroupList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Add a Trunk Group instance to a group. +A list of enterprise trunk priority weighted trunk groups that replaces a previously +configured list. -The response is either a `SuccessResponse()` or an `ErrorResponse()`. +By convention, an element of this type may be set nill to clear the list. **Attributes:** -|Name |Type |Description | -|------------------------------------------------|-------------------------------------------|------------------------------------------------------| -|service_provider_id |str |serviceProviderId | -|group_id |str |groupId | -|name |str |name | -|pilot_user |pilotUser |pilotUser *Optional* | -|department |department |department *Optional* | -|access_device |accessDevice |accessDevice *Optional* | -|max_active_calls |int |maxActiveCalls | -|max_incoming_calls |int |maxIncomingCalls *Optional* | -|max_outgoing_calls |int |maxOutgoingCalls *Optional* | -|enable_bursting |bool |enableBursting | -|bursting_max_active_calls |int |burstingMaxActiveCalls *Optional* | -|bursting_max_incoming_calls |int |burstingMaxIncomingCalls *Optional* | -|bursting_max_outgoing_calls |int |burstingMaxOutgoingCalls *Optional* | -|capacity_exceeded_action |str |capacityExceededAction *Optional* | -|capacity_exceeded_forward_address |str |capacityExceededForwardAddress *Optional* | -|capacity_exceeded_reroute_trunk_group_key |capacityExceededRerouteTrunkGroupKey |capacityExceededRerouteTrunkGroupKey *Optional* | -|capacity_exceeded_trap_initial_calls |int |capacityExceededTrapInitialCalls | -|capacity_exceeded_trap_offset_calls |int |capacityExceededTrapOffsetCalls | -|unreachable_destination_action |str |unreachableDestinationAction *Optional* | -|unreachable_destination_forward_address |str |unreachableDestinationForwardAddress *Optional* | -|unreachable_destination_reroute_trunk_group_key |unreachableDestinationRerouteTrunkGroupKey |unreachableDestinationRerouteTrunkGroupKey *Optional* | -|unreachable_destination_trap_initial_calls |int |unreachableDestinationTrapInitialCalls | -|unreachable_destination_trap_offset_calls |int |unreachableDestinationTrapOffsetCalls | -|invitation_timeout |int |invitationTimeout | -|require_authentication |bool |requireAuthentication | -|sip_authentication_user_name |str |sipAuthenticationUserName *Optional* | -|sip_authentication_password |str |sipAuthenticationPassword *Optional* | -|hosted_user_id |List[str] |hostedUserId *Optional* | -|trunk_group_identity |str |trunkGroupIdentity *Optional* | -|otg_dtg_identity |str |otgDtgIdentity *Optional* | -|include_trunk_group_identity |bool |includeTrunkGroupIdentity | -|include_dtg_identity |bool |includeDtgIdentity | -|enable_network_address_identity |bool |enableNetworkAddressIdentity | -|allow_unscreened_calls |bool |allowUnscreenedCalls | -|allow_unscreened_emergency_calls |bool |allowUnscreenedEmergencyCalls | -|pilot_user_calling_line_identity_policy |str |pilotUserCallingLineIdentityPolicy | -|pilot_user_charge_number_policy |str |pilotUserChargeNumberPolicy | -|call_forwarding_always_action |str |callForwardingAlwaysAction *Optional* | -|call_forwarding_always_forward_address |str |callForwardingAlwaysForwardAddress *Optional* | -|call_forwarding_always_reroute_trunk_group_key |callForwardingAlwaysRerouteTrunkGroupKey |callForwardingAlwaysRerouteTrunkGroupKey *Optional* | +|Name |Type |Description| +|------------|-----------------|-----------| +|trunk_group |List[trunkGroup] |trunkGroup |
-## `OutgoingCallingPlanDigitPatternCallMeNowDepartmentPermissions`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SortOrderEnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAssignmentPagedSortedList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Outgoing Calling Plan Call Me Now call permissions for specified digit patterns. +Used to sort the +`SortOrderEnterpriseBroadWorksMobilityMobileSubscriberDirectoryNumberGetAssignmentPagedSortedListRequest()`. **Attributes:** -|Name |Type |Description | -|--------------------------|------------------------|------------------------| -|department_key |departmentKey |departmentKey | -|department_name |str |departmentName | -|digit_pattern_permissions |digitPatternPermissions |digitPatternPermissions | +|Name |Type |Description | +|--------------------------------|----------------------------|---------------------------------------| +|sort_by_mobile_directory_number |sortByMobileDirectoryNumber |sortByMobileDirectoryNumber *Optional* | +|sort_by_dn |sortByDn |sortByDn *Optional* | +|sort_by_department_name |sortByDepartmentName |sortByDepartmentName *Optional* | +|sort_by_user_id |sortByUserId |sortByUserId *Optional* | +|sort_by_user_first_name |sortByUserFirstName |sortByUserFirstName *Optional* | +|sort_by_user_last_name |sortByUserLastName |sortByUserLastName *Optional* | +|sort_by_extension |sortByExtension |sortByExtension *Optional* | +|sort_by_dn_available |sortByDnAvailable |sortByDnAvailable *Optional* |
-## `OutgoingCallingPlanDigitPatternCallMeNowDepartmentPermissionsModify`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SortOrderEnterpriseCallCenterAgentThresholdProfileGetAvailableAgentPagedSortedList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Modify outgoing Calling Plan Call Me Now call permissions for specified digit -patterns. +Used to sort the +`EnterpriseCallCenterAgentThresholdProfileGetAvailableAgentPagedSortedListRequest()` +request. **Attributes:** -|Name |Type |Description | -|--------------------------|------------------------|------------------------| -|department_key |departmentKey |departmentKey | -|digit_pattern_permissions |digitPatternPermissions |digitPatternPermissions | +|Name |Type |Description | +|--------------------------------|----------------------------|---------------------------------------| +|sort_by_user_id |sortByUserId |sortByUserId *Optional* | +|sort_by_user_last_name |sortByUserLastName |sortByUserLastName *Optional* | +|sort_by_user_first_name |sortByUserFirstName |sortByUserFirstName *Optional* | +|sort_by_dn |sortByDn |sortByDn *Optional* | +|sort_by_extension |sortByExtension |sortByExtension *Optional* | +|sort_by_department_name |sortByDepartmentName |sortByDepartmentName *Optional* | +|sort_by_email_address |sortByEmailAddress |sortByEmailAddress *Optional* | +|sort_by_agent_threshold_profile |sortByAgentThresholdProfile |sortByAgentThresholdProfile *Optional* |
-## `OutgoingCallingPlanDigitPatternOriginatingDepartmentPermissions`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SortOrderEnterpriseCallCenterAgentThresholdProfileGetPagedSorted`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Outgoing Calling Plan originating call permissions for specified digit patterns. +Used to sort the `EnterpriseCallCenterAgentThresholdProfileGetPagedSortedRequest()` +request. **Attributes:** -|Name |Type |Description | -|--------------------------|------------------------|------------------------| -|department_key |departmentKey |departmentKey | -|department_name |str |departmentName | -|digit_pattern_permissions |digitPatternPermissions |digitPatternPermissions | +|Name |Type |Description | +|------------------------|---------------------|--------------------------------| +|sort_by_user_id |sortByUserId |sortByUserId *Optional* | +|sort_by_user_last_name |sortByUserLastName |sortByUserLastName *Optional* | +|sort_by_user_first_name |sortByUserFirstName |sortByUserFirstName *Optional* | +|sort_by_dn |sortByDn |sortByDn *Optional* | +|sort_by_extension |sortByExtension |sortByExtension *Optional* | +|sort_by_department_name |sortByDepartmentName |sortByDepartmentName *Optional* | +|sort_by_email_address |sortByEmailAddress |sortByEmailAddress *Optional* |
-## `OutgoingCallingPlanDigitPatternOriginatingDepartmentPermissionsModify`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SortOrderEnterprisePhoneDirectoryGetPagedSortedList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Modify outgoing Calling Plan originating call permissions for specified digit -patterns. +Used to sort the `EnterprisePhoneDirectoryGetPagedSortedListRequest()` request. **Attributes:** -|Name |Type |Description | -|--------------------------|------------------------|------------------------| -|department_key |departmentKey |departmentKey | -|digit_pattern_permissions |digitPatternPermissions |digitPatternPermissions | +|Name |Type |Description | +|----------------------------|------------------------|-----------------------------------| +|sort_by_user_last_name |sortByUserLastName |sortByUserLastName *Optional* | +|sort_by_user_first_name |sortByUserFirstName |sortByUserFirstName *Optional* | +|sort_by_group_location_code |sortByGroupLocationCode |sortByGroupLocationCode *Optional* | +|sort_by_mobile_phone_number |sortByMobilePhoneNumber |sortByMobilePhoneNumber *Optional* | +|sort_by_email_address |sortByEmailAddress |sortByEmailAddress *Optional* | +|sort_by_department_name |sortByDepartmentName |sortByDepartmentName *Optional* | +|sort_by_group_name |sortByGroupName |sortByGroupName *Optional* | +|sort_by_yahoo_id |sortByYahooId |sortByYahooId *Optional* | +|sort_by_user_id |sortByUserId |sortByUserId *Optional* | +|sort_by_imp_id |sortByImpId |sortByImpId *Optional* |
-## `OutgoingCallingPlanDigitPatternRedirectingDepartmentPermissions`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SortOrderGroupAccessDeviceGetPagedSortedList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Outgoing Calling Plan redirecting call permissions for specified digit patterns. +Used to sort the `GroupAccessDeviceGetPagedSortedListRequest()` request. **Attributes:** -|Name |Type |Description | -|--------------------------|------------------------|------------------------| -|department_key |departmentKey |departmentKey | -|department_name |str |departmentName | -|digit_pattern_permissions |digitPatternPermissions |digitPatternPermissions | +|Name |Type |Description | +|---------------------------|-----------------------|----------------------------------| +|sort_by_device_name |sortByDeviceName |sortByDeviceName *Optional* | +|sort_by_device_type |sortByDeviceType |sortByDeviceType *Optional* | +|sort_by_device_net_address |sortByDeviceNetAddress |sortByDeviceNetAddress *Optional* | +|sort_by_device_mac_address |sortByDeviceMACAddress |sortByDeviceMACAddress *Optional* |
-## `OutgoingCallingPlanDigitPatternRedirectingDepartmentPermissionsModify`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SortOrderGroupAdminGetPagedSortedList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Modify outgoing Calling Plan redirecting call permissions for specified digit -patterns. +Used to sort the `GroupAdminGetPagedSortedListRequest()` request. **Attributes:** -|Name |Type |Description | -|--------------------------|------------------------|------------------------| -|department_key |departmentKey |departmentKey | -|digit_pattern_permissions |digitPatternPermissions |digitPatternPermissions | +|Name |Type |Description | +|-------------------------|---------------------|--------------------------------| +|sort_by_admin_id |sortByAdminId |sortByAdminId *Optional* | +|sort_by_admin_last_name |sortByAdminLastName |sortByAdminLastName *Optional* | +|sort_by_admin_first_name |sortByAdminFirstName |sortByAdminFirstName *Optional* |
-## `OutgoingPinholeDigitPlanDigitPatternCallMeNowDepartmentPermissions`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SortOrderGroupAutoAttendantGetInstancePagedSortedList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Outgoing Pinhole Digit Plan Call Me Now call permissions for a department. +Used to sort the `GroupAutoAttendantGetInstancePagedSortedListRequest()` request. **Attributes:** -|Name |Type |Description | -|----------------|--------------|---------------| -|department_key |departmentKey |departmentKey | -|department_name |str |departmentName | -|permissions |permissions |permissions | +|Name |Type |Description | +|-----------------------|-------------------|------------------------------| +|sort_by_user_id |sortByUserId |sortByUserId *Optional* | +|sort_by_user_last_name |sortByUserLastName |sortByUserLastName *Optional* | +|sort_by_dn |sortByDn |sortByDn *Optional* | +|sort_by_extension |sortByExtension |sortByExtension *Optional* |
-## `OutgoingPinholeDigitPlanDigitPatternCallMeNowDepartmentPermissionsModify`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SortOrderGroupCallCenterAgentThresholdProfileGetAvailableAgentPagedSortedList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Modify Outgoing Pinhole Digit Plan Call Me Now call permissions for specified digit -patterns. +Used to sort the +`GroupCallCenterAgentThresholdProfileGetAvailableAgentPagedSortedListRequest()` +request. **Attributes:** -|Name |Type |Description | -|--------------------------|------------------------|------------------------| -|department_key |departmentKey |departmentKey | -|digit_pattern_permissions |digitPatternPermissions |digitPatternPermissions | +|Name |Type |Description | +|--------------------------------|----------------------------|---------------------------------------| +|sort_by_user_id |sortByUserId |sortByUserId *Optional* | +|sort_by_user_last_name |sortByUserLastName |sortByUserLastName *Optional* | +|sort_by_user_first_name |sortByUserFirstName |sortByUserFirstName *Optional* | +|sort_by_dn |sortByDn |sortByDn *Optional* | +|sort_by_extension |sortByExtension |sortByExtension *Optional* | +|sort_by_department_name |sortByDepartmentName |sortByDepartmentName *Optional* | +|sort_by_email_address |sortByEmailAddress |sortByEmailAddress *Optional* | +|sort_by_agent_threshold_profile |sortByAgentThresholdProfile |sortByAgentThresholdProfile *Optional* |
-## `OutgoingPinholeDigitPlanDigitPatternOriginatingDepartmentPermissions`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SortOrderGroupCallCenterAgentThresholdProfileGetPagedSorted`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Outgoing Pinhole Digit Plan department originating call permissions for specified -digit patterns. +Used to sort the `GroupCallCenterAgentThresholdProfileGetPagedSortedRequest()` +request. **Attributes:** -|Name |Type |Description | -|--------------------------|------------------------|------------------------| -|department_key |departmentKey |departmentKey | -|department_name |str |departmentName | -|digit_pattern_permissions |digitPatternPermissions |digitPatternPermissions | +|Name |Type |Description | +|------------------------|---------------------|--------------------------------| +|sort_by_user_id |sortByUserId |sortByUserId *Optional* | +|sort_by_user_last_name |sortByUserLastName |sortByUserLastName *Optional* | +|sort_by_user_first_name |sortByUserFirstName |sortByUserFirstName *Optional* | +|sort_by_dn |sortByDn |sortByDn *Optional* | +|sort_by_extension |sortByExtension |sortByExtension *Optional* | +|sort_by_department_name |sortByDepartmentName |sortByDepartmentName *Optional* | +|sort_by_email_address |sortByEmailAddress |sortByEmailAddress *Optional* |
-## `OutgoingPinholeDigitPlanDigitPatternOriginatingDepartmentPermissionsModify`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SortOrderGroupCallCenterGetAvailableAgentPagedSortedList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Modify Outgoing Pinhole Digit Plan originating call permissions for specified digit -patterns. +Used to sort the `GroupCallCenterGetAvailableAgentPagedSortedListRequest()` request. **Attributes:** -|Name |Type |Description | -|--------------------------|------------------------|------------------------| -|department_key |departmentKey |departmentKey | -|digit_pattern_permissions |digitPatternPermissions |digitPatternPermissions | +|Name |Type |Description | +|------------------------|---------------------|--------------------------------| +|sort_by_user_id |sortByUserId |sortByUserId *Optional* | +|sort_by_user_last_name |sortByUserLastName |sortByUserLastName *Optional* | +|sort_by_user_first_name |sortByUserFirstName |sortByUserFirstName *Optional* | +|sort_by_dn |sortByDn |sortByDn *Optional* | +|sort_by_extension |sortByExtension |sortByExtension *Optional* | +|sort_by_department_name |sortByDepartmentName |sortByDepartmentName *Optional* | +|sort_by_email_address |sortByEmailAddress |sortByEmailAddress *Optional* |
-## `OutgoingPinholeDigitPlanDigitPatternRedirectingDepartmentPermissions`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SortOrderGroupCallCenterGetInstancePagedSortedList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Outgoing Pinhole Digit Plan initiating call forwards/transfer permissions for a -department. +Used to sort the `GroupCallCenterGetInstancePagedSortedListRequest()` request. **Attributes:** -|Name |Type |Description | -|----------------|--------------|---------------| -|department_key |departmentKey |departmentKey | -|department_name |str |departmentName | -|permissions |permissions |permissions | +|Name |Type |Description | +|-------------------------|---------------------|--------------------------------| +|sort_by_user_id |sortByUserId |sortByUserId *Optional* | +|sort_by_call_center_name |sortByCallCenterName |sortByCallCenterName *Optional* | +|sort_by_dn |sortByDn |sortByDn *Optional* | +|sort_by_extension |sortByExtension |sortByExtension *Optional* | +|sort_by_department_name |sortByDepartmentName |sortByDepartmentName *Optional* | +|sort_by_hunt_policy |sortByHuntPolicy |sortByHuntPolicy *Optional* | +|sort_by_call_center_type |sortByCallCenterType |sortByCallCenterType *Optional* |
-## `OutgoingPinholeDigitPlanDigitPatternRedirectingDepartmentPermissionsModify`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SortOrderGroupCallParkGetAvailableAlternateRecallUserPagedSortedList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-Modify Outgoing Pinhole Digit Plan redirecting call permissions for specified digit -patterns. +Used to sort the +`GroupCallParkGetAvailableAlternateRecallUserPagedSortedListRequest()` request. **Attributes:** -|Name |Type |Description | -|--------------------------|------------------------|------------------------| -|department_key |departmentKey |departmentKey | -|digit_pattern_permissions |digitPatternPermissions |digitPatternPermissions | +|Name |Type |Description | +|------------------------|---------------------|--------------------------------| +|sort_by_user_id |sortByUserId |sortByUserId *Optional* | +|sort_by_user_last_name |sortByUserLastName |sortByUserLastName *Optional* | +|sort_by_user_first_name |sortByUserFirstName |sortByUserFirstName *Optional* | +|sort_by_dn |sortByDn |sortByDn *Optional* | +|sort_by_extension |sortByExtension |sortByExtension *Optional* | +|sort_by_department_name |sortByDepartmentName |sortByDepartmentName *Optional* |
-## `PushNotificationRegistrationData`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SortOrderGroupCallParkGetAvailableUserPagedSortedList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-? The common push notification registration elements. +Used to sort the `GroupCallParkGetAvailableUserPagedSortedListRequest()` request. **Attributes:** -|Name |Type |Description | -|---------------------------------|--------------------------------|-------------------------------------| -|registration_id |str |registrationId | -|application_id |str |applicationId | -|application_version |str |applicationVersion | -|device_os_type |str |deviceOsType | -|device_version |str |deviceVersion | -|timestamp |str |timestamp | -|push_notification_client_version |str |pushNotificationClientVersion | -|push_notification_token_data |List[pushNotificationTokenData] |pushNotificationTokenData *Optional* | +|Name |Type |Description | +|------------------------|---------------------|--------------------------------| +|sort_by_user_id |sortByUserId |sortByUserId *Optional* | +|sort_by_user_last_name |sortByUserLastName |sortByUserLastName *Optional* | +|sort_by_user_first_name |sortByUserFirstName |sortByUserFirstName *Optional* | +|sort_by_dn |sortByDn |sortByDn *Optional* | +|sort_by_extension |sortByExtension |sortByExtension *Optional* | +|sort_by_department_name |sortByDepartmentName |sortByDepartmentName *Optional* | +|sort_by_email_address |sortByEmailAddress |sortByEmailAddress *Optional* |
-## `ReplacementCombinedGroupServiceAuthorizationList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SortOrderGroupCallPickupGetAvailableUserPagedSortedList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-A list of group services that replaces a previously authorized group services. +Used to sort the `GroupCallPickupGetAvailableUserPagedSortedListRequest()` request. **Attributes:** -|Name |Type |Description | -|----------------------------|--------------------------------|--------------------------| -|group_service_authorization |List[groupServiceAuthorization] |groupServiceAuthorization | +|Name |Type |Description | +|------------------------|---------------------|--------------------------------| +|sort_by_user_id |sortByUserId |sortByUserId *Optional* | +|sort_by_user_last_name |sortByUserLastName |sortByUserLastName *Optional* | +|sort_by_user_first_name |sortByUserFirstName |sortByUserFirstName *Optional* | +|sort_by_dn |sortByDn |sortByDn *Optional* | +|sort_by_extension |sortByExtension |sortByExtension *Optional* | +|sort_by_department_name |sortByDepartmentName |sortByDepartmentName *Optional* | +|sort_by_email_address |sortByEmailAddress |sortByEmailAddress *Optional* |
-## `ReplacementCombinedServicePackAssignmentList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SortOrderGroupCallPickupGetInstancePagedSorted`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-A list of service packs that replaces existing service packs assgined to the user. +Used to sort the `GroupCallPickupGetInstancePagedSortedRequest()` request. -If a service pack is already assigned to the user, the service quantitiy will be -updated if included. **Attributes:** -|Name |Type |Description | -|-------------|------------------|------------| -|service_pack |List[servicePack] |servicePack | +|Name |Type |Description | +|------------------------|---------------------|--------------------------------| +|sort_by_user_id |sortByUserId |sortByUserId *Optional* | +|sort_by_user_last_name |sortByUserLastName |sortByUserLastName *Optional* | +|sort_by_user_first_name |sortByUserFirstName |sortByUserFirstName *Optional* | +|sort_by_dn |sortByDn |sortByDn *Optional* | +|sort_by_extension |sortByExtension |sortByExtension *Optional* | +|sort_by_department_name |sortByDepartmentName |sortByDepartmentName *Optional* | +|sort_by_email_address |sortByEmailAddress |sortByEmailAddress *Optional* |
-## `ReplacementCombinedServicePackAuthorizationList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SortOrderGroupCollaborateBridgeGetAvailableUserPagedSortedList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-A list of service packs that replaces previously authorized service packs. +Used to sort the `GroupCollaborateBridgeGetAvailableUserPagedSortedListRequest()` +request. **Attributes:** -|Name |Type |Description | -|---------------------------|-------------------------------|-------------------------| -|service_pack_authorization |List[servicePackAuthorization] |servicePackAuthorization | +|Name |Type |Description | +|------------------------|--------------------|-------------------------------| +|sort_by_user_id |sortByUserId |sortByUserId *Optional* | +|sort_by_user_last_name |sortByUserLastName |sortByUserLastName *Optional* | +|sort_by_user_first_name |sortByUserFirstName |sortByUserFirstName *Optional* | +|sort_by_dn |sortByDn |sortByDn *Optional* | +|sort_by_extension |sortByExtension |sortByExtension *Optional* |
-## `ReplacementCombinedSharedCallAppearanceAccessDeviceMultipleIdentityEndpointList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SortOrderGroupCollaborateBridgeGetInstancePagedSortedList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-A list of shared call appearance endpoints that replaces existing endpoints. +Used to sort the `GroupCollaborateBridgeGetInstancePagedSortedListRequest()`. **Attributes:** -|Name |Type |Description | -|----------------------------------------------|-----------------------------------------------|-----------------------------------------| -|shared_call_appearance_access_device_endpoint |List[sharedCallAppearanceAccessDeviceEndpoint] |sharedCallAppearanceAccessDeviceEndpoint | +|Name |Type |Description | +|-----------------------|-------------------|------------------------------| +|sort_by_user_id |sortByUserId |sortByUserId *Optional* | +|sort_by_user_last_name |sortByUserLastName |sortByUserLastName *Optional* | +|sort_by_dn |sortByDn |sortByDn *Optional* | +|sort_by_extension |sortByExtension |sortByExtension *Optional* |
-## `ReplacementCombinedUserServiceAssignmentList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SortOrderGroupDnGetAssignmentPagedSortedList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-A list of user services that replaces existing user services assgined to the user. +Used to sort the `GroupDnGetAssignmentPagedSortedListRequest()` request. -If a service is already assigned to the user, the service quantitiy will be updated if -included. **Attributes:** -|Name |Type |Description | -|-------------|------------------|------------| -|service_name |List[serviceName] |serviceName | +|Name |Type |Description | +|------------------------|---------------------|--------------------------------| +|sort_by_dn |sortByDn |sortByDn *Optional* | +|sort_by_department_name |sortByDepartmentName |sortByDepartmentName *Optional* | +|sort_by_dn_activated |sortByDnActivated |sortByDnActivated *Optional* | +|sort_by_dn_available |sortByDnAvailable |sortByDnAvailable *Optional* | +|sort_by_user_id |sortByUserId |sortByUserId *Optional* | +|sort_by_user_first_name |sortByUserFirstName |sortByUserFirstName *Optional* | +|sort_by_user_last_name |sortByUserLastName |sortByUserLastName *Optional* | +|sort_by_extension |sortByExtension |sortByExtension *Optional* | +|sort_by_email_address |sortByEmailAddress |sortByEmailAddress *Optional* |
-## `ReplacementCombinedUserServiceAuthorizationList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SortOrderGroupGetListInServiceProviderPagedSortedList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-A list of user services that replaces a previously authorized user services. +Used to sort the `GroupGetListInServiceProviderPagedSortedListRequest()` request. **Attributes:** -|Name |Type |Description | -|---------------------------|-------------------------------|-------------------------| -|user_service_authorization |List[userServiceAuthorization] |userServiceAuthorization | +|Name |Type |Description | +|-------------------|----------------|---------------------------| +|sort_by_group_id |sortByGroupId |sortByGroupId *Optional* | +|sort_by_group_name |sortByGroupName |sortByGroupName *Optional* |
-## `ReplacementConsolidatedServicePackAssignmentList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SortOrderGroupHuntGroupGetAvailableUserPagedSortedList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-A list of service packs that replaces existing service packs assigned to the user. +Used to sort the `GroupHuntGroupGetAvailableUserPagedSortedListRequest()` request. -If a service pack is not authorized to the group, the service will be authorized. The -authorizedQuantity will be used if provided; otherwise, the service quantity will be -set to unlimited. The command will fail if the authorized Quantity set at the service -provider is insufficient If a service pack is already authorized to the group, the -service quantity will be ignored if included. **Attributes:** -|Name |Type |Description | -|-------------|------------------|------------| -|service_pack |List[servicePack] |servicePack | +|Name |Type |Description | +|------------------------|--------------------|-------------------------------| +|sort_by_user_id |sortByUserId |sortByUserId *Optional* | +|sort_by_user_last_name |sortByUserLastName |sortByUserLastName *Optional* | +|sort_by_user_first_name |sortByUserFirstName |sortByUserFirstName *Optional* | +|sort_by_dn |sortByDn |sortByDn *Optional* | +|sort_by_extension |sortByExtension |sortByExtension *Optional* |
-## `ReplacementConsolidatedSharedCallAppearanceAccessDeviceMultipleIdentityEndpointList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SortOrderGroupHuntGroupGetInstancePagedSortedList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-A list of shared call appearance endpoints that replaces existing endpoints. +Used to sort the `GroupHuntGroupGetInstancePagedSortedListRequest()` request. **Attributes:** -|Name |Type |Description | -|----------------------------------------------|-----------------------------------------------|-----------------------------------------| -|shared_call_appearance_access_device_endpoint |List[sharedCallAppearanceAccessDeviceEndpoint] |sharedCallAppearanceAccessDeviceEndpoint | +|Name |Type |Description | +|-----------------------|-------------------|------------------------------| +|sort_by_user_id |sortByUserId |sortByUserId *Optional* | +|sort_by_user_last_name |sortByUserLastName |sortByUserLastName *Optional* | +|sort_by_dn |sortByDn |sortByDn *Optional* | +|sort_by_extension |sortByExtension |sortByExtension *Optional* |
-## `ReplacementConsolidatedSharedCallAppearanceAccessDeviceMultipleIdentityEndpointList22`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SortOrderGroupPhoneDirectoryGetPagedSortedList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-A list of shared call appearance endpoints that replaces existing endpoints. +Used to sort the `GroupPhoneDirectoryGetPagedSortedListRequest()` request. **Attributes:** -|Name |Type |Description | -|----------------------------------------------|-----------------------------------------------|-----------------------------------------| -|shared_call_appearance_access_device_endpoint |List[sharedCallAppearanceAccessDeviceEndpoint] |sharedCallAppearanceAccessDeviceEndpoint | +|Name |Type |Description | +|----------------------------|------------------------|-----------------------------------| +|sort_by_user_last_name |sortByUserLastName |sortByUserLastName *Optional* | +|sort_by_user_first_name |sortByUserFirstName |sortByUserFirstName *Optional* | +|sort_by_mobile_phone_number |sortByMobilePhoneNumber |sortByMobilePhoneNumber *Optional* | +|sort_by_email_address |sortByEmailAddress |sortByEmailAddress *Optional* | +|sort_by_department_name |sortByDepartmentName |sortByDepartmentName *Optional* | +|sort_by_yahoo_id |sortByYahooId |sortByYahooId *Optional* | +|sort_by_user_id |sortByUserId |sortByUserId *Optional* | +|sort_by_imp_id |sortByImpId |sortByImpId *Optional* |
-## `ReplacementConsolidatedUserServiceAssignmentList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SortOrderServiceProviderAdminGetPagedSortedList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-A list of user services that replaces existing user services assigned to the user. +Used to sort the `ServiceProviderAdminGetPagedSortedListRequest()` request. -If a service is not authorized to the group, the service will be authorized. The -authorizedQuantity will be used if provided; otherwise, the service quantity will be -set to unlimited. The command will fail if the authorized Quantity set at the service -provider is insufficient. If a service is already authorized to the group, the -service quantity will be ignored if included. **Attributes:** -|Name |Type |Description | -|--------------------------|-----------------------------|-----------------------| -|user_service_service_name |List[userServiceServiceName] |userServiceServiceName | +|Name |Type |Description | +|-------------------------|---------------------|--------------------------------| +|sort_by_admin_id |sortByAdminId |sortByAdminId *Optional* | +|sort_by_admin_last_name |sortByAdminLastName |sortByAdminLastName *Optional* | +|sort_by_admin_first_name |sortByAdminFirstName |sortByAdminFirstName *Optional* |
-## `ReplacementEnterpriseDeviceList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SortOrderServiceProviderGetPagedSortedList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-A list of enterprise accessible devices that replaces a previously configured list. +Used to sort the `ServiceProviderGetPagedSortedListRequest()` request. -By convention, an element of this type may be set nill to clear the list. **Attributes:** -|Name |Type |Description| -|-------|-------------|-----------| -|device |List[device] |device | +|Name |Type |Description | +|------------------------------|--------------------------|-------------------------------------| +|sort_by_service_provider_id |sortByServiceProviderId |sortByServiceProviderId *Optional* | +|sort_by_service_provider_name |sortByServiceProviderName |sortByServiceProviderName *Optional* |
-## `ReplacementEnterpriseEnterpriseTrunkPriorityWeightedTrunkGroupList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) +## `SortOrderUserGetListInGroupPagedSortedList`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
-A list of enterprise trunk priority weighted trunk groups that replaces a previously -configured list. +Used to sort the `UserGetListInGroupPagedSortedListRequest()` request. -By convention, an element of this type may be set nill to clear the list. **Attributes:** -|Name |Type |Description| -|------------|-----------------|-----------| -|trunk_group |List[trunkGroup] |trunkGroup | +|Name |Type |Description | +|------------------------|---------------------|--------------------------------| +|sort_by_user_id |sortByUserId |sortByUserId *Optional* | +|sort_by_user_last_name |sortByUserLastName |sortByUserLastName *Optional* | +|sort_by_user_first_name |sortByUserFirstName |sortByUserFirstName *Optional* | +|sort_by_department_name |sortByDepartmentName |sortByDepartmentName *Optional* | +|sort_by_dn |sortByDn |sortByDn *Optional* | +|sort_by_extension |sortByExtension |sortByExtension *Optional* | +|sort_by_email_address |sortByEmailAddress |sortByEmailAddress *Optional* |
@@ -17690,76 +17690,6 @@ Code", "National Prefix" -## `UserEnhancedCallLogsGetListRequest17sp4V2`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) - -
-Request user's call logs. - -If the callLogType is not specified, all types of calls logs (placed, received, -missed) are returned. The filters "dateTimeRange", "numberFilter", -"redirectedNumberFilter", "accountAuthorizationCodeFilter" -"callAuthorizationCodeFilter" and "subscriberType" are ignored if call logs are stored -in CDS. When "ReceivedOrMissed" is specified as "callLogType" and call logs are stored -in CDS, all call logs including placed will be returned. It is possible to restrict -the number of rows returned using responsePagingControl. If responsePagingControl is -not specified, the value of Enhanced Call Logs system parameter -maxNonPagedResponseSize will control the maximum number of call logs can be returned. - -The response is either a UserEnhancedCallLogsGetListResponse17sp4V2 or an -`ErrorResponse()`. The following elements are only used in AS data mode and not -returned in XS data mode: callAuthorizationCodeFilter - -**Attributes:** - -|Name |Type |Description | -|----------------------------------|-------------------------------|------------------------------------------| -|user_id |str |userId | -|call_log_type |str |callLogType *Optional* | -|date_time_range |dateTimeRange |dateTimeRange | -|number_filter |numberFilter |numberFilter *Optional* | -|redirected_number_filter |redirectedNumberFilter |redirectedNumberFilter *Optional* | -|account_authorization_code_filter |accountAuthorizationCodeFilter |accountAuthorizationCodeFilter *Optional* | -|call_authorization_code_filter |callAuthorizationCodeFilter |callAuthorizationCodeFilter *Optional* | -|subscriber_type |str |subscriberType *Optional* | -|response_paging_control |responsePagingControl |responsePagingControl *Optional* | -
- - -## `UserEnhancedCallLogsGetListRequest21sp1V2`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) - -
-Request user's call logs. - -If the callLogType is not specified, all types of calls logs (placed, received, -missed) are returned. The filters "dateTimeRange", "numberFilter", -"redirectedNumberFilter", "accountAuthorizationCodeFilter" -"callAuthorizationCodeFilter" and "subscriberType" are ignored if call logs are stored -in CDS. When "ReceivedOrMissed" is specified as "callLogType" and call logs are stored -in CDS, all call logs including placed will be returned. It is possible to restrict -the number of rows returned using responsePagingControl. If responsePagingControl is -not specified, the value of Enhanced Call Logs system parameter -maxNonPagedResponseSize will control the maximum number of call logs can be returned. - -The response is either a UserEnhancedCallLogsGetListResponse21sp1V2 or an -`ErrorResponse()`. The following elements are only used in AS data mode and ignored in -XS data mode: callAuthorizationCodeFilter - -**Attributes:** - -|Name |Type |Description | -|----------------------------------|-------------------------------|------------------------------------------| -|user_id |str |userId | -|call_log_type |str |callLogType *Optional* | -|date_time_range |dateTimeRange |dateTimeRange | -|number_filter |numberFilter |numberFilter *Optional* | -|redirected_number_filter |redirectedNumberFilter |redirectedNumberFilter *Optional* | -|account_authorization_code_filter |accountAuthorizationCodeFilter |accountAuthorizationCodeFilter *Optional* | -|call_authorization_code_filter |callAuthorizationCodeFilter |callAuthorizationCodeFilter *Optional* | -|subscriber_type |str |subscriberType *Optional* | -|response_paging_control |responsePagingControl |responsePagingControl *Optional* | -
- - ## `UserGetResponse21sp1V2`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType))
@@ -18168,3 +18098,73 @@ physicalLocation |alternate_trunk_identity_domain |str |alternateTrunkIdentityDomain *Optional* | |physical_location |str |physicalLocation *Optional* |
+ + +## `UserEnhancedCallLogsGetListRequest17sp4V2`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) + +
+Request user's call logs. + +If the callLogType is not specified, all types of calls logs (placed, received, +missed) are returned. The filters "dateTimeRange", "numberFilter", +"redirectedNumberFilter", "accountAuthorizationCodeFilter" +"callAuthorizationCodeFilter" and "subscriberType" are ignored if call logs are stored +in CDS. When "ReceivedOrMissed" is specified as "callLogType" and call logs are stored +in CDS, all call logs including placed will be returned. It is possible to restrict +the number of rows returned using responsePagingControl. If responsePagingControl is +not specified, the value of Enhanced Call Logs system parameter +maxNonPagedResponseSize will control the maximum number of call logs can be returned. + +The response is either a UserEnhancedCallLogsGetListResponse17sp4V2 or an +`ErrorResponse()`. The following elements are only used in AS data mode and not +returned in XS data mode: callAuthorizationCodeFilter + +**Attributes:** + +|Name |Type |Description | +|----------------------------------|-------------------------------|------------------------------------------| +|user_id |str |userId | +|call_log_type |str |callLogType *Optional* | +|date_time_range |dateTimeRange |dateTimeRange | +|number_filter |numberFilter |numberFilter *Optional* | +|redirected_number_filter |redirectedNumberFilter |redirectedNumberFilter *Optional* | +|account_authorization_code_filter |accountAuthorizationCodeFilter |accountAuthorizationCodeFilter *Optional* | +|call_authorization_code_filter |callAuthorizationCodeFilter |callAuthorizationCodeFilter *Optional* | +|subscriber_type |str |subscriberType *Optional* | +|response_paging_control |responsePagingControl |responsePagingControl *Optional* | +
+ + +## `UserEnhancedCallLogsGetListRequest21sp1V2`([`OCIType`](/broadworks_ocip/api/base/#broadworks_ocip.base.OCIType)) + +
+Request user's call logs. + +If the callLogType is not specified, all types of calls logs (placed, received, +missed) are returned. The filters "dateTimeRange", "numberFilter", +"redirectedNumberFilter", "accountAuthorizationCodeFilter" +"callAuthorizationCodeFilter" and "subscriberType" are ignored if call logs are stored +in CDS. When "ReceivedOrMissed" is specified as "callLogType" and call logs are stored +in CDS, all call logs including placed will be returned. It is possible to restrict +the number of rows returned using responsePagingControl. If responsePagingControl is +not specified, the value of Enhanced Call Logs system parameter +maxNonPagedResponseSize will control the maximum number of call logs can be returned. + +The response is either a UserEnhancedCallLogsGetListResponse21sp1V2 or an +`ErrorResponse()`. The following elements are only used in AS data mode and ignored in +XS data mode: callAuthorizationCodeFilter + +**Attributes:** + +|Name |Type |Description | +|----------------------------------|-------------------------------|------------------------------------------| +|user_id |str |userId | +|call_log_type |str |callLogType *Optional* | +|date_time_range |dateTimeRange |dateTimeRange | +|number_filter |numberFilter |numberFilter *Optional* | +|redirected_number_filter |redirectedNumberFilter |redirectedNumberFilter *Optional* | +|account_authorization_code_filter |accountAuthorizationCodeFilter |accountAuthorizationCodeFilter *Optional* | +|call_authorization_code_filter |callAuthorizationCodeFilter |callAuthorizationCodeFilter *Optional* | +|subscriber_type |str |subscriberType *Optional* | +|response_paging_control |responsePagingControl |responsePagingControl *Optional* | +