UserFaxMessagingModifyRequest

Bases: OCIRequest

Modify the user level data associated with Fax Messaging. The response is either a SuccessResponse or an ErrorResponse.

Attributes:

user_id (str):

is_active (Optional[bool]):

phone_number (Optional[Nillable[str]]):

extension (Optional[Nillable[str]]):

sip_alias_list (Optional[Nillable[ReplacementSIPAliasList]]):

Source code in src/mercury_ocip/commands/commands.py

@dataclass(kw_only=True)
class UserFaxMessagingModifyRequest(OCIRequest):
    """Modify the user level data associated with Fax Messaging.
        The response is either a SuccessResponse or an ErrorResponse.

    Attributes:

        user_id (str):

        is_active (Optional[bool]):

        phone_number (Optional[Nillable[str]]):

        extension (Optional[Nillable[str]]):

        sip_alias_list (Optional[Nillable[ReplacementSIPAliasList]]):

    """

    user_id: str = field(metadata={"alias": "userId"})

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

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

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

    sip_alias_list: Optional[Nillable[ReplacementSIPAliasList]] = field(
        default=None, metadata={"alias": "sipAliasList"}
    )

    def __post_init__(self):
        nillable_fields = ["phone_number", "extension", "sip_alias_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 UserFaxMessagingModifyRequest

client = Client()

command = UserFaxMessagingModifyRequest(
    user_id=...,
    is_active=...,
    phone_number=...,
    extension=...,
    sip_alias_list=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("UserFaxMessagingModifyRequest",
    user_id=...,
    is_active=...,
    phone_number=...,
    extension=...,
    sip_alias_list=...,
)

print(response)