Skip to content

GroupGroupNightForwardingModifyRequest

Bases: OCIRequest

Request to modify the Group Night Forwarding group parameters. The response is either SuccessResponse or ErrorResponse.

Attributes:

service_provider_id (str):

group_id (str):

night_forwarding (Optional[str]):

business_hours (Optional[Nillable[TimeSchedule]]):

holiday_schedule (Optional[Nillable[HolidaySchedule]]):

forward_to_phone_number (Optional[Nillable[str]]):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class GroupGroupNightForwardingModifyRequest(OCIRequest):
    """Request to modify the Group Night Forwarding group parameters.
        The response is either SuccessResponse or ErrorResponse.

    Attributes:

        service_provider_id (str):

        group_id (str):

        night_forwarding (Optional[str]):

        business_hours (Optional[Nillable[TimeSchedule]]):

        holiday_schedule (Optional[Nillable[HolidaySchedule]]):

        forward_to_phone_number (Optional[Nillable[str]]):

    """

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

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

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

    business_hours: Optional[Nillable[TimeSchedule]] = field(
        default=None, metadata={"alias": "businessHours"}
    )

    holiday_schedule: Optional[Nillable[HolidaySchedule]] = field(
        default=None, metadata={"alias": "holidaySchedule"}
    )

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

    def __post_init__(self):
        nillable_fields = [
            "business_hours",
            "holiday_schedule",
            "forward_to_phone_number",
        ]
        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 GroupGroupNightForwardingModifyRequest

client = Client()

command = GroupGroupNightForwardingModifyRequest(
    service_provider_id=...,
    group_id=...,
    night_forwarding=...,
    business_hours=...,
    holiday_schedule=...,
    forward_to_phone_number=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("GroupGroupNightForwardingModifyRequest",
    service_provider_id=...,
    group_id=...,
    night_forwarding=...,
    business_hours=...,
    holiday_schedule=...,
    forward_to_phone_number=...,
)

print(response)