Skip to content

SystemConfigurableTreatmentModifyRequest

Bases: OCIRequest

Modify the fields for a configurable treatment. 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:
  warnCode
  warnText
  accessSendWarningHeader
  networkSendWarningHeader

Attributes:

treatment_id (str):

charge_indicator (Optional[str]):

description (Optional[Nillable[str]]):

access_sip_status_code (Optional[Nillable[int]]):

access_sip_status_message (Optional[Nillable[str]]):

network_sip_status_code (Optional[Nillable[int]]):

network_sip_status_message (Optional[Nillable[str]]):

q850_cause_value (Optional[Nillable[int]]):

q850_text (Optional[Nillable[str]]):

access_treatment_audio_file (Optional[Nillable[str]]):

access_treatment_video_file (Optional[Nillable[str]]):

network_treatment_audio_file (Optional[Nillable[str]]):

network_treatment_video_file (Optional[Nillable[str]]):

cdr_termination_cause (Optional[Nillable[str]]):

route_advance (Optional[bool]):

internal_release_cause (Optional[Nillable[str]]):

access_send_reason_header (Optional[bool]):

network_send_reason_header (Optional[bool]):

warn_code (Optional[Nillable[int]]):

warn_text (Optional[Nillable[str]]):

access_send_warning_header (Optional[bool]):

network_send_warning_header (Optional[bool]):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class SystemConfigurableTreatmentModifyRequest(OCIRequest):
    """Modify the fields for a configurable treatment.
        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:
          warnCode
          warnText
          accessSendWarningHeader
          networkSendWarningHeader

    Attributes:

        treatment_id (str):

        charge_indicator (Optional[str]):

        description (Optional[Nillable[str]]):

        access_sip_status_code (Optional[Nillable[int]]):

        access_sip_status_message (Optional[Nillable[str]]):

        network_sip_status_code (Optional[Nillable[int]]):

        network_sip_status_message (Optional[Nillable[str]]):

        q850_cause_value (Optional[Nillable[int]]):

        q850_text (Optional[Nillable[str]]):

        access_treatment_audio_file (Optional[Nillable[str]]):

        access_treatment_video_file (Optional[Nillable[str]]):

        network_treatment_audio_file (Optional[Nillable[str]]):

        network_treatment_video_file (Optional[Nillable[str]]):

        cdr_termination_cause (Optional[Nillable[str]]):

        route_advance (Optional[bool]):

        internal_release_cause (Optional[Nillable[str]]):

        access_send_reason_header (Optional[bool]):

        network_send_reason_header (Optional[bool]):

        warn_code (Optional[Nillable[int]]):

        warn_text (Optional[Nillable[str]]):

        access_send_warning_header (Optional[bool]):

        network_send_warning_header (Optional[bool]):

    """

    treatment_id: str = field(metadata={"alias": "treatmentId"})

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    def __post_init__(self):
        nillable_fields = [
            "description",
            "access_sip_status_code",
            "access_sip_status_message",
            "network_sip_status_code",
            "network_sip_status_message",
            "q850_cause_value",
            "q850_text",
            "access_treatment_audio_file",
            "access_treatment_video_file",
            "network_treatment_audio_file",
            "network_treatment_video_file",
            "cdr_termination_cause",
            "internal_release_cause",
            "warn_code",
            "warn_text",
        ]
        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 SystemConfigurableTreatmentModifyRequest

client = Client()

command = SystemConfigurableTreatmentModifyRequest(
    treatment_id=...,
    charge_indicator=...,
    description=...,
    access_sip_status_code=...,
    access_sip_status_message=...,
    network_sip_status_code=...,
    network_sip_status_message=...,
    q850_cause_value=...,
    q850_text=...,
    access_treatment_audio_file=...,
    access_treatment_video_file=...,
    network_treatment_audio_file=...,
    network_treatment_video_file=...,
    cdr_termination_cause=...,
    route_advance=...,
    internal_release_cause=...,
    access_send_reason_header=...,
    network_send_reason_header=...,
    warn_code=...,
    warn_text=...,
    access_send_warning_header=...,
    network_send_warning_header=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("SystemConfigurableTreatmentModifyRequest",
    treatment_id=...,
    charge_indicator=...,
    description=...,
    access_sip_status_code=...,
    access_sip_status_message=...,
    network_sip_status_code=...,
    network_sip_status_message=...,
    q850_cause_value=...,
    q850_text=...,
    access_treatment_audio_file=...,
    access_treatment_video_file=...,
    network_treatment_audio_file=...,
    network_treatment_video_file=...,
    cdr_termination_cause=...,
    route_advance=...,
    internal_release_cause=...,
    access_send_reason_header=...,
    network_send_reason_header=...,
    warn_code=...,
    warn_text=...,
    access_send_warning_header=...,
    network_send_warning_header=...,
)

print(response)