Skip to content

GroupVoiceMessagingGroupModifyRequest

Bases: OCIRequest

Request to modify the group's voice messaging settings. The response is either SuccessResponse or ErrorResponse.

Attributes:

service_provider_id (str):

group_id (str):

use_mail_server_setting (Optional[str]):

warn_caller_before_recording_voice_message (Optional[bool]):

allow_users_configuring_advanced_settings (Optional[bool]):

allow_compose_or_forward_message_to_entire_group (Optional[bool]):

mail_server_net_address (Optional[Nillable[str]]):

mail_server_protocol (Optional[str]):

real_delete_for_imap (Optional[bool]):

max_mailbox_length_minutes (Optional[int]):

does_message_age (Optional[bool]):

hold_period_days (Optional[int]):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class GroupVoiceMessagingGroupModifyRequest(OCIRequest):
    """Request to modify the group's voice messaging settings.
        The response is either SuccessResponse or ErrorResponse.

    Attributes:

        service_provider_id (str):

        group_id (str):

        use_mail_server_setting (Optional[str]):

        warn_caller_before_recording_voice_message (Optional[bool]):

        allow_users_configuring_advanced_settings (Optional[bool]):

        allow_compose_or_forward_message_to_entire_group (Optional[bool]):

        mail_server_net_address (Optional[Nillable[str]]):

        mail_server_protocol (Optional[str]):

        real_delete_for_imap (Optional[bool]):

        max_mailbox_length_minutes (Optional[int]):

        does_message_age (Optional[bool]):

        hold_period_days (Optional[int]):

    """

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

    group_id: str = field(metadata={"alias": "groupId"})

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

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

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

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

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

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

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

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

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

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

    def __post_init__(self):
        nillable_fields = ["mail_server_net_address"]
        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 GroupVoiceMessagingGroupModifyRequest

client = Client()

command = GroupVoiceMessagingGroupModifyRequest(
    service_provider_id=...,
    group_id=...,
    use_mail_server_setting=...,
    warn_caller_before_recording_voice_message=...,
    allow_users_configuring_advanced_settings=...,
    allow_compose_or_forward_message_to_entire_group=...,
    mail_server_net_address=...,
    mail_server_protocol=...,
    real_delete_for_imap=...,
    max_mailbox_length_minutes=...,
    does_message_age=...,
    hold_period_days=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("GroupVoiceMessagingGroupModifyRequest",
    service_provider_id=...,
    group_id=...,
    use_mail_server_setting=...,
    warn_caller_before_recording_voice_message=...,
    allow_users_configuring_advanced_settings=...,
    allow_compose_or_forward_message_to_entire_group=...,
    mail_server_net_address=...,
    mail_server_protocol=...,
    real_delete_for_imap=...,
    max_mailbox_length_minutes=...,
    does_message_age=...,
    hold_period_days=...,
)

print(response)