Skip to content

ServiceProviderCommunicationBarringProfileAddRequest19sp1

Bases: OCIRequest

Add a new Communication Barring Profile. The priorities for OriginatingRules, RedirectingRules, CallMeNowRules and IncomingRules are requantized to consecutive integers as part of the add. The response is either a SuccessResponse or an ErrorResponse. The following elements are only used in AS data mode: callMeNowDefaultAction, use value "Block" in XS data mode callMeNowDefaultCallTimeout callMeNowRule applyToAttendedCallTransfers, use value "false" in XS data mode

Attributes:

service_provider_id (str):

name (str):

description (Optional[str]):

originating_default_action (str):

originating_default_treatment_id (Optional[str]):

originating_default_transfer_number (Optional[str]):

originating_default_call_timeout (Optional[int]):

originating_rule (Optional[List[ServiceProviderCommunicationBarringHierarchicalOriginatingRule]]):

redirecting_default_action (str):

redirecting_default_call_timeout (Optional[int]):

redirecting_rule (Optional[List[ServiceProviderCommunicationBarringHierarchicalRedirectingRule]]):

call_me_now_default_action (str):

call_me_now_default_call_timeout (Optional[int]):

call_me_now_rule (Optional[List[ServiceProviderCommunicationBarringHierarchicalCallMeNowRule]]):

incoming_default_action (str):

incoming_default_call_timeout (Optional[int]):

incoming_rule (Optional[List[CommunicationBarringIncomingRule19sp1]]):

become_default (bool):

apply_to_attended_call_transfers (bool):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class ServiceProviderCommunicationBarringProfileAddRequest19sp1(OCIRequest):
    """Add a new Communication Barring Profile.
        The priorities for OriginatingRules, RedirectingRules, CallMeNowRules and IncomingRules are requantized to consecutive integers as part of the add.
        The response is either a SuccessResponse or an ErrorResponse.
        The following elements are only used in AS data mode:
           callMeNowDefaultAction, use value \"Block\" in XS data mode
           callMeNowDefaultCallTimeout
           callMeNowRule
           applyToAttendedCallTransfers, use value \"false\" in XS data mode

    Attributes:

        service_provider_id (str):

        name (str):

        description (Optional[str]):

        originating_default_action (str):

        originating_default_treatment_id (Optional[str]):

        originating_default_transfer_number (Optional[str]):

        originating_default_call_timeout (Optional[int]):

        originating_rule (Optional[List[ServiceProviderCommunicationBarringHierarchicalOriginatingRule]]):

        redirecting_default_action (str):

        redirecting_default_call_timeout (Optional[int]):

        redirecting_rule (Optional[List[ServiceProviderCommunicationBarringHierarchicalRedirectingRule]]):

        call_me_now_default_action (str):

        call_me_now_default_call_timeout (Optional[int]):

        call_me_now_rule (Optional[List[ServiceProviderCommunicationBarringHierarchicalCallMeNowRule]]):

        incoming_default_action (str):

        incoming_default_call_timeout (Optional[int]):

        incoming_rule (Optional[List[CommunicationBarringIncomingRule19sp1]]):

        become_default (bool):

        apply_to_attended_call_transfers (bool):

    """

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

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

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

    originating_default_action: str = field(
        metadata={"alias": "originatingDefaultAction"}
    )

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

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

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

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

    redirecting_default_action: str = field(
        metadata={"alias": "redirectingDefaultAction"}
    )

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

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

    call_me_now_default_action: str = field(
        metadata={"alias": "callMeNowDefaultAction"}
    )

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

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

    incoming_default_action: str = field(metadata={"alias": "incomingDefaultAction"})

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

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

    become_default: bool = field(metadata={"alias": "becomeDefault"})

    apply_to_attended_call_transfers: bool = field(
        metadata={"alias": "applyToAttendedCallTransfers"}
    )

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 ServiceProviderCommunicationBarringProfileAddRequest19sp1

client = Client()

command = ServiceProviderCommunicationBarringProfileAddRequest19sp1(
    service_provider_id=...,
    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("ServiceProviderCommunicationBarringProfileAddRequest19sp1",
    service_provider_id=...,
    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)