Skip to content

SystemFaxMessagingModifyRequest

Bases: OCIRequest

Modify the system level data associated with Fax Messaging. The following elements are only used in AS data mode and ignored in XS data mode: statusDurationHours statusAuditIntervalHours The response is either a SuccessResponse or an ErrorResponse.

Attributes:

status_duration_hours (Optional[int]):

status_audit_interval_hours (Optional[int]):

maximum_concurrent_faxes_per_user (Optional[int]):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class SystemFaxMessagingModifyRequest(OCIRequest):
    """Modify the system level data associated with Fax Messaging.
        The following elements are only used in AS data mode and ignored in XS data mode:
          statusDurationHours
          statusAuditIntervalHours
        The response is either a SuccessResponse or an ErrorResponse.

    Attributes:

        status_duration_hours (Optional[int]):

        status_audit_interval_hours (Optional[int]):

        maximum_concurrent_faxes_per_user (Optional[int]):

    """

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

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

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

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 SystemFaxMessagingModifyRequest

client = Client()

command = SystemFaxMessagingModifyRequest(
    status_duration_hours=...,
    status_audit_interval_hours=...,
    maximum_concurrent_faxes_per_user=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("SystemFaxMessagingModifyRequest",
    status_duration_hours=...,
    status_audit_interval_hours=...,
    maximum_concurrent_faxes_per_user=...,
)

print(response)