GroupOfficeZoneAssignListRequest

Bases: OCIRequest

Assign a list of Office Zones to a group. The Element defaultOfficeZone is required only for the first assignment, for subsequent assignments it is optional. Office Zones can only be assigned if the Location-Based Calling Restrictions has been authorized to the group otherwise the request will fail. The response is either a SuccessResponse or an ErrorResponse.

Attributes:

service_provider_id (str):

group_id (str):

office_zone_name (Optional[List[str]]):

default_office_zone_name (Optional[str]):

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

@dataclass(kw_only=True)
class GroupOfficeZoneAssignListRequest(OCIRequest):
    """Assign a list of Office Zones to a group.
        The Element defaultOfficeZone is required only for the first assignment, for subsequent assignments it is optional.
        Office Zones can only be assigned if the Location-Based Calling Restrictions has been authorized to the group otherwise the request will fail.
        The response is either a SuccessResponse or an ErrorResponse.

    Attributes:

        service_provider_id (str):

        group_id (str):

        office_zone_name (Optional[List[str]]):

        default_office_zone_name (Optional[str]):

    """

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

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

    office_zone_name: Optional[List[str]] = field(
        default=None, metadata={"alias": "officeZoneName"}
    )

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

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 GroupOfficeZoneAssignListRequest

client = Client()

command = GroupOfficeZoneAssignListRequest(
    service_provider_id=...,
    group_id=...,
    office_zone_name=...,
    default_office_zone_name=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("GroupOfficeZoneAssignListRequest",
    service_provider_id=...,
    group_id=...,
    office_zone_name=...,
    default_office_zone_name=...,
)

print(response)