Skip to content

ServiceProviderCommunicationBarringProfileModifyRequest

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

service_provider_id (str):

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[ServiceProviderReplacementCommunicationBarringHierarchicalOriginatingRuleList]]):

redirecting_default_action (Optional[str]):

redirecting_default_call_timeout (Optional[Nillable[int]]):

redirecting_rule (Optional[Nillable[ServiceProviderReplacementCommunicationBarringHierarchicalRedirectingRuleList]]):

call_me_now_default_action (Optional[str]):

call_me_now_default_call_timeout (Optional[Nillable[int]]):

call_me_now_rule (Optional[Nillable[ServiceProviderReplacementCommunicationBarringHierarchicalCallMeNowRuleList]]):

incoming_default_action (Optional[str]):

incoming_default_call_timeout (Optional[Nillable[int]]):

incoming_rule (Optional[Nillable[ReplacementCommunicationBarringIncomingRuleList19sp1]]):

become_default (Optional[bool]):

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

        service_provider_id (str):

        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[ServiceProviderReplacementCommunicationBarringHierarchicalOriginatingRuleList]]):

        redirecting_default_action (Optional[str]):

        redirecting_default_call_timeout (Optional[Nillable[int]]):

        redirecting_rule (Optional[Nillable[ServiceProviderReplacementCommunicationBarringHierarchicalRedirectingRuleList]]):

        call_me_now_default_action (Optional[str]):

        call_me_now_default_call_timeout (Optional[Nillable[int]]):

        call_me_now_rule (Optional[Nillable[ServiceProviderReplacementCommunicationBarringHierarchicalCallMeNowRuleList]]):

        incoming_default_action (Optional[str]):

        incoming_default_call_timeout (Optional[Nillable[int]]):

        incoming_rule (Optional[Nillable[ReplacementCommunicationBarringIncomingRuleList19sp1]]):

        become_default (Optional[bool]):

        apply_to_attended_call_transfers (Optional[bool]):

    """

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

    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[
            ServiceProviderReplacementCommunicationBarringHierarchicalOriginatingRuleList
        ]
    ] = 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[
            ServiceProviderReplacementCommunicationBarringHierarchicalRedirectingRuleList
        ]
    ] = field(default=None, metadata={"alias": "redirectingRule"})

    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[
            ServiceProviderReplacementCommunicationBarringHierarchicalCallMeNowRuleList
        ]
    ] = field(default=None, metadata={"alias": "callMeNowRule"})

    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"})

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

    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",
            "call_me_now_default_call_timeout",
            "call_me_now_rule",
            "incoming_default_call_timeout",
            "incoming_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/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 ServiceProviderCommunicationBarringProfileModifyRequest

client = Client()

command = ServiceProviderCommunicationBarringProfileModifyRequest(
    service_provider_id=...,
    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=...,
    call_me_now_default_action=...,
    call_me_now_default_call_timeout=...,
    call_me_now_rule=...,
    incoming_default_action=...,
    incoming_default_call_timeout=...,
    incoming_rule=...,
    become_default=...,
    apply_to_attended_call_transfers=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("ServiceProviderCommunicationBarringProfileModifyRequest",
    service_provider_id=...,
    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=...,
    call_me_now_default_action=...,
    call_me_now_default_call_timeout=...,
    call_me_now_rule=...,
    incoming_default_action=...,
    incoming_default_call_timeout=...,
    incoming_rule=...,
    become_default=...,
    apply_to_attended_call_transfers=...,
)

print(response)