GroupAccountAuthorizationCodesGetRequest

Bases: OCIRequest

Request the group's account/authorization codes setting. The response is either a GroupAccountAuthorizationCodesGetResponse or an ErrorResponse.

Attributes:

service_provider_id (str):

group_id (str):

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

@dataclass(kw_only=True)
class GroupAccountAuthorizationCodesGetRequest(OCIRequest):
    """Request the group's account/authorization codes setting.
        The response is either a GroupAccountAuthorizationCodesGetResponse or an ErrorResponse.

    Attributes:

        service_provider_id (str):

        group_id (str):

    """

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

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

Responses

Bases: OCIDataResponse

Response to GroupAccountAuthorizationCodesGetRequest. The tables has the following column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name", "Phone Number", "Extension", "Department", "Email Address".

Attributes:

type (str):

number_of_digits (int):

allow_local_and_toll_free_calls (bool):

mandatory_usage_user_table (OCITable):

optional_usage_user_table (OCITable):

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

@dataclass(kw_only=True)
class GroupAccountAuthorizationCodesGetResponse(OCIDataResponse):
    """Response to GroupAccountAuthorizationCodesGetRequest.
        The tables has the following column headings:
        \"User Id\", \"Last Name\", \"First Name\", \"Hiragana Last Name\", \"Hiragana First Name\",
        \"Phone Number\", \"Extension\", \"Department\", \"Email Address\".

    Attributes:

        type (str):

        number_of_digits (int):

        allow_local_and_toll_free_calls (bool):

        mandatory_usage_user_table (OCITable):

        optional_usage_user_table (OCITable):

    """

    type: str = field(metadata={"alias": "type"})

    number_of_digits: int = field(metadata={"alias": "numberOfDigits"})

    allow_local_and_toll_free_calls: bool = field(
        metadata={"alias": "allowLocalAndTollFreeCalls"}
    )

    mandatory_usage_user_table: OCITable = field(
        metadata={"alias": "mandatoryUsageUserTable"}
    )

    optional_usage_user_table: OCITable = field(
        metadata={"alias": "optionalUsageUserTable"}
    )

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 GroupAccountAuthorizationCodesGetRequest

client = Client()

command = GroupAccountAuthorizationCodesGetRequest(
    service_provider_id=...,
    group_id=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("GroupAccountAuthorizationCodesGetRequest",
    service_provider_id=...,
    group_id=...,
)

print(response)