Skip to content

SystemCommunicationBarringProfileModifyRequest

Bases: 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):

new_name (Optional[str]):

description (Optional[Nillable[str]]):

originating_default_action (Optional[str]):

originating_default_treatment_id (Optional[Nillable[str]]):

originating_default_transfer_number (Optional[Nillable[str]]):

originating_default_call_timeout (Optional[Nillable[int]]):

originating_rule (Optional[Nillable[ReplacementCommunicationBarringOriginatingRuleList]]):

redirecting_default_action (Optional[str]):

redirecting_default_call_timeout (Optional[Nillable[int]]):

redirecting_rule (Optional[Nillable[ReplacementCommunicationBarringRedirectingRuleList]]):

incoming_default_action (Optional[str]):

incoming_default_call_timeout (Optional[Nillable[int]]):

incoming_rule (Optional[Nillable[ReplacementCommunicationBarringIncomingRuleList19sp1]]):

call_me_now_default_action (Optional[str]):

call_me_now_default_call_timeout (Optional[Nillable[int]]):

call_me_now_rule (Optional[Nillable[ReplacementCommunicationBarringCallMeNowRuleList]]):

apply_to_attended_call_transfers (Optional[bool]):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=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):

        new_name (Optional[str]):

        description (Optional[Nillable[str]]):

        originating_default_action (Optional[str]):

        originating_default_treatment_id (Optional[Nillable[str]]):

        originating_default_transfer_number (Optional[Nillable[str]]):

        originating_default_call_timeout (Optional[Nillable[int]]):

        originating_rule (Optional[Nillable[ReplacementCommunicationBarringOriginatingRuleList]]):

        redirecting_default_action (Optional[str]):

        redirecting_default_call_timeout (Optional[Nillable[int]]):

        redirecting_rule (Optional[Nillable[ReplacementCommunicationBarringRedirectingRuleList]]):

        incoming_default_action (Optional[str]):

        incoming_default_call_timeout (Optional[Nillable[int]]):

        incoming_rule (Optional[Nillable[ReplacementCommunicationBarringIncomingRuleList19sp1]]):

        call_me_now_default_action (Optional[str]):

        call_me_now_default_call_timeout (Optional[Nillable[int]]):

        call_me_now_rule (Optional[Nillable[ReplacementCommunicationBarringCallMeNowRuleList]]):

        apply_to_attended_call_transfers (Optional[bool]):

    """

    name: str = field(metadata={"alias": "name"})

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

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

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

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

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

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

    originating_rule: Optional[
        Nillable[ReplacementCommunicationBarringOriginatingRuleList]
    ] = field(default=None, metadata={"alias": "originatingRule"})

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

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

    redirecting_rule: Optional[
        Nillable[ReplacementCommunicationBarringRedirectingRuleList]
    ] = field(default=None, metadata={"alias": "redirectingRule"})

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

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

    incoming_rule: Optional[
        Nillable[ReplacementCommunicationBarringIncomingRuleList19sp1]
    ] = field(default=None, metadata={"alias": "incomingRule"})

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

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

    call_me_now_rule: Optional[
        Nillable[ReplacementCommunicationBarringCallMeNowRuleList]
    ] = field(default=None, metadata={"alias": "callMeNowRule"})

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

    def __post_init__(self):
        nillable_fields = [
            "description",
            "originating_default_treatment_id",
            "originating_default_transfer_number",
            "originating_default_call_timeout",
            "originating_rule",
            "redirecting_default_call_timeout",
            "redirecting_rule",
            "incoming_default_call_timeout",
            "incoming_rule",
            "call_me_now_default_call_timeout",
            "call_me_now_rule",
        ]
        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_fast/commands/base_command.py
class SuccessResponse(OCIResponse):
    pass

Bases: OCIResponse

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

Example Usage

from mercury_ocip_fast.client import Client
from mercury_ocip_fast.commands import SystemCommunicationBarringProfileModifyRequest

client = Client()

command = SystemCommunicationBarringProfileModifyRequest(
    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 = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("SystemCommunicationBarringProfileModifyRequest",
    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=...,
)

print(response)