UserGroupNightForwardingGetRequest

Bases: OCIRequest

Request to get the Group Night Forwarding user parameters. The response is either UserGroupNightForwardingGetResponse or ErrorResponse.

Attributes:

user_id (str):

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

@dataclass(kw_only=True)
class UserGroupNightForwardingGetRequest(OCIRequest):
    """Request to get the Group Night Forwarding user parameters.
        The response is either UserGroupNightForwardingGetResponse or ErrorResponse.

    Attributes:

        user_id (str):

    """

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

Responses

Bases: OCIDataResponse

Response to UserGroupNightForwardingGetRequest. businessHours and holidaySchedule are returned in the response only when groupNightForwarding is ‘Auto On’.

Attributes:

night_forwarding (str):

group_night_forwarding (str):

business_hours (Optional[TimeSchedule]):

holiday_schedule (Optional[HolidaySchedule]):

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

@dataclass(kw_only=True)
class UserGroupNightForwardingGetResponse(OCIDataResponse):
    """Response to UserGroupNightForwardingGetRequest.
        businessHours and holidaySchedule are returned in the response only when groupNightForwarding is ‘Auto On’.

    Attributes:

        night_forwarding (str):

        group_night_forwarding (str):

        business_hours (Optional[TimeSchedule]):

        holiday_schedule (Optional[HolidaySchedule]):

    """

    night_forwarding: str = field(metadata={"alias": "nightForwarding"})

    group_night_forwarding: str = field(metadata={"alias": "groupNightForwarding"})

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

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

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 UserGroupNightForwardingGetRequest

client = Client()

command = UserGroupNightForwardingGetRequest(
    user_id=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("UserGroupNightForwardingGetRequest",
    user_id=...,
)

print(response)