Skip to content

GroupCallCenterAgentThresholdProfileModifyRequest

Bases: OCIRequest

Modifies an existing Call Center Agent Threshold Profile in the Group. The response is either a SuccessResponse or an ErrorResponse.

Attributes:

service_provider_id (str):

group_id (str):

profile_name (str):

new_profile_name (Optional[str]):

profile_description (Optional[Nillable[str]]):

threshold_current_call_state_idle_time_yellow (Optional[Nillable[int]]):

threshold_current_call_state_idle_time_red (Optional[Nillable[int]]):

threshold_current_call_state_on_call_time_yellow (Optional[Nillable[int]]):

threshold_current_call_state_on_call_time_red (Optional[Nillable[int]]):

threshold_current_agent_state_unavailable_time_yellow (Optional[Nillable[int]]):

threshold_current_agent_state_unavailable_time_red (Optional[Nillable[int]]):

threshold_average_busy_in_time_yellow (Optional[Nillable[int]]):

threshold_average_busy_in_time_red (Optional[Nillable[int]]):

threshold_average_busy_out_time_yellow (Optional[Nillable[int]]):

threshold_average_busy_out_time_red (Optional[Nillable[int]]):

threshold_average_wrap_up_time_yellow (Optional[Nillable[int]]):

threshold_average_wrap_up_time_red (Optional[Nillable[int]]):

enable_notification_email (Optional[bool]):

notification_email_address_list (Optional[Nillable[CallCenterAgentThresholdProfileReplacementNotificationEmailList]]):

agent_user_id_list (Optional[Nillable[ReplacementUserIdList]]):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class GroupCallCenterAgentThresholdProfileModifyRequest(OCIRequest):
    """Modifies an existing Call Center Agent Threshold Profile in the Group.
        The response is either a SuccessResponse or an ErrorResponse.

    Attributes:

        service_provider_id (str):

        group_id (str):

        profile_name (str):

        new_profile_name (Optional[str]):

        profile_description (Optional[Nillable[str]]):

        threshold_current_call_state_idle_time_yellow (Optional[Nillable[int]]):

        threshold_current_call_state_idle_time_red (Optional[Nillable[int]]):

        threshold_current_call_state_on_call_time_yellow (Optional[Nillable[int]]):

        threshold_current_call_state_on_call_time_red (Optional[Nillable[int]]):

        threshold_current_agent_state_unavailable_time_yellow (Optional[Nillable[int]]):

        threshold_current_agent_state_unavailable_time_red (Optional[Nillable[int]]):

        threshold_average_busy_in_time_yellow (Optional[Nillable[int]]):

        threshold_average_busy_in_time_red (Optional[Nillable[int]]):

        threshold_average_busy_out_time_yellow (Optional[Nillable[int]]):

        threshold_average_busy_out_time_red (Optional[Nillable[int]]):

        threshold_average_wrap_up_time_yellow (Optional[Nillable[int]]):

        threshold_average_wrap_up_time_red (Optional[Nillable[int]]):

        enable_notification_email (Optional[bool]):

        notification_email_address_list (Optional[Nillable[CallCenterAgentThresholdProfileReplacementNotificationEmailList]]):

        agent_user_id_list (Optional[Nillable[ReplacementUserIdList]]):

    """

    service_provider_id: str = field(metadata={"alias": "serviceProviderId"})

    group_id: str = field(metadata={"alias": "groupId"})

    profile_name: str = field(metadata={"alias": "profileName"})

    new_profile_name: Optional[str] = field(
        default=None, metadata={"alias": "newProfileName"}
    )

    profile_description: Optional[Nillable[str]] = field(
        default=None, metadata={"alias": "profileDescription"}
    )

    threshold_current_call_state_idle_time_yellow: Optional[Nillable[int]] = field(
        default=None, metadata={"alias": "thresholdCurrentCallStateIdleTimeYellow"}
    )

    threshold_current_call_state_idle_time_red: Optional[Nillable[int]] = field(
        default=None, metadata={"alias": "thresholdCurrentCallStateIdleTimeRed"}
    )

    threshold_current_call_state_on_call_time_yellow: Optional[Nillable[int]] = field(
        default=None, metadata={"alias": "thresholdCurrentCallStateOnCallTimeYellow"}
    )

    threshold_current_call_state_on_call_time_red: Optional[Nillable[int]] = field(
        default=None, metadata={"alias": "thresholdCurrentCallStateOnCallTimeRed"}
    )

    threshold_current_agent_state_unavailable_time_yellow: Optional[Nillable[int]] = (
        field(
            default=None,
            metadata={"alias": "thresholdCurrentAgentStateUnavailableTimeYellow"},
        )
    )

    threshold_current_agent_state_unavailable_time_red: Optional[Nillable[int]] = field(
        default=None, metadata={"alias": "thresholdCurrentAgentStateUnavailableTimeRed"}
    )

    threshold_average_busy_in_time_yellow: Optional[Nillable[int]] = field(
        default=None, metadata={"alias": "thresholdAverageBusyInTimeYellow"}
    )

    threshold_average_busy_in_time_red: Optional[Nillable[int]] = field(
        default=None, metadata={"alias": "thresholdAverageBusyInTimeRed"}
    )

    threshold_average_busy_out_time_yellow: Optional[Nillable[int]] = field(
        default=None, metadata={"alias": "thresholdAverageBusyOutTimeYellow"}
    )

    threshold_average_busy_out_time_red: Optional[Nillable[int]] = field(
        default=None, metadata={"alias": "thresholdAverageBusyOutTimeRed"}
    )

    threshold_average_wrap_up_time_yellow: Optional[Nillable[int]] = field(
        default=None, metadata={"alias": "thresholdAverageWrapUpTimeYellow"}
    )

    threshold_average_wrap_up_time_red: Optional[Nillable[int]] = field(
        default=None, metadata={"alias": "thresholdAverageWrapUpTimeRed"}
    )

    enable_notification_email: Optional[bool] = field(
        default=None, metadata={"alias": "enableNotificationEmail"}
    )

    notification_email_address_list: Optional[
        Nillable[CallCenterAgentThresholdProfileReplacementNotificationEmailList]
    ] = field(default=None, metadata={"alias": "notificationEmailAddressList"})

    agent_user_id_list: Optional[Nillable[ReplacementUserIdList]] = field(
        default=None, metadata={"alias": "agentUserIdList"}
    )

    def __post_init__(self):
        nillable_fields = [
            "profile_description",
            "threshold_current_call_state_idle_time_yellow",
            "threshold_current_call_state_idle_time_red",
            "threshold_current_call_state_on_call_time_yellow",
            "threshold_current_call_state_on_call_time_red",
            "threshold_current_agent_state_unavailable_time_yellow",
            "threshold_current_agent_state_unavailable_time_red",
            "threshold_average_busy_in_time_yellow",
            "threshold_average_busy_in_time_red",
            "threshold_average_busy_out_time_yellow",
            "threshold_average_busy_out_time_red",
            "threshold_average_wrap_up_time_yellow",
            "threshold_average_wrap_up_time_red",
            "notification_email_address_list",
            "agent_user_id_list",
        ]
        for field_name in nillable_fields:
            value = getattr(self, field_name)
            if value == "" or value == "None":
                object.__setattr__(self, field_name, OCINil)

Responses

Bases: OCIResponse

Source code in src/mercury_ocip/commands/base_command.py
class SuccessResponse(OCIResponse):
    pass

Bases: OCIResponse

Source code in src/mercury_ocip/commands/base_command.py
class ErrorResponse(OCIResponse):
    errorCode: Optional[int] = None
    summary: str
    summaryEnglish: str
    detail: Optional[str] = None

Example Usage

from mercury_ocip.client import Client
from mercury_ocip.commands import GroupCallCenterAgentThresholdProfileModifyRequest

client = Client()

command = GroupCallCenterAgentThresholdProfileModifyRequest(
    service_provider_id=...,
    group_id=...,
    profile_name=...,
    new_profile_name=...,
    profile_description=...,
    threshold_current_call_state_idle_time_yellow=...,
    threshold_current_call_state_idle_time_red=...,
    threshold_current_call_state_on_call_time_yellow=...,
    threshold_current_call_state_on_call_time_red=...,
    threshold_current_agent_state_unavailable_time_yellow=...,
    threshold_current_agent_state_unavailable_time_red=...,
    threshold_average_busy_in_time_yellow=...,
    threshold_average_busy_in_time_red=...,
    threshold_average_busy_out_time_yellow=...,
    threshold_average_busy_out_time_red=...,
    threshold_average_wrap_up_time_yellow=...,
    threshold_average_wrap_up_time_red=...,
    enable_notification_email=...,
    notification_email_address_list=...,
    agent_user_id_list=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("GroupCallCenterAgentThresholdProfileModifyRequest",
    service_provider_id=...,
    group_id=...,
    profile_name=...,
    new_profile_name=...,
    profile_description=...,
    threshold_current_call_state_idle_time_yellow=...,
    threshold_current_call_state_idle_time_red=...,
    threshold_current_call_state_on_call_time_yellow=...,
    threshold_current_call_state_on_call_time_red=...,
    threshold_current_agent_state_unavailable_time_yellow=...,
    threshold_current_agent_state_unavailable_time_red=...,
    threshold_average_busy_in_time_yellow=...,
    threshold_average_busy_in_time_red=...,
    threshold_average_busy_out_time_yellow=...,
    threshold_average_busy_out_time_red=...,
    threshold_average_wrap_up_time_yellow=...,
    threshold_average_wrap_up_time_red=...,
    enable_notification_email=...,
    notification_email_address_list=...,
    agent_user_id_list=...,
)

print(response)