Skip to content

GroupAccountAuthorizationCodesModifyRequest

Bases: OCIRequest

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

Attributes:

service_provider_id (str):

group_id (str):

code_type (Optional[str]):

number_of_digits (Optional[int]):

allow_local_and_toll_free_calls (Optional[bool]):

mandatory_usage_user_id_list (Optional[Nillable[ReplacementUserIdList]]):

optional_usage_user_id_list (Optional[Nillable[ReplacementUserIdList]]):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class GroupAccountAuthorizationCodesModifyRequest(OCIRequest):
    """Change the group's account/authorization codes setting.
        The response is either a SuccessResponse or an ErrorResponse.

    Attributes:

        service_provider_id (str):

        group_id (str):

        code_type (Optional[str]):

        number_of_digits (Optional[int]):

        allow_local_and_toll_free_calls (Optional[bool]):

        mandatory_usage_user_id_list (Optional[Nillable[ReplacementUserIdList]]):

        optional_usage_user_id_list (Optional[Nillable[ReplacementUserIdList]]):

    """

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

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

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

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

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

    mandatory_usage_user_id_list: Optional[Nillable[ReplacementUserIdList]] = field(
        default=None, metadata={"alias": "mandatoryUsageUserIdList"}
    )

    optional_usage_user_id_list: Optional[Nillable[ReplacementUserIdList]] = field(
        default=None, metadata={"alias": "optionalUsageUserIdList"}
    )

    def __post_init__(self):
        nillable_fields = [
            "mandatory_usage_user_id_list",
            "optional_usage_user_id_list",
        ]
        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 GroupAccountAuthorizationCodesModifyRequest

client = Client()

command = GroupAccountAuthorizationCodesModifyRequest(
    service_provider_id=...,
    group_id=...,
    code_type=...,
    number_of_digits=...,
    allow_local_and_toll_free_calls=...,
    mandatory_usage_user_id_list=...,
    optional_usage_user_id_list=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("GroupAccountAuthorizationCodesModifyRequest",
    service_provider_id=...,
    group_id=...,
    code_type=...,
    number_of_digits=...,
    allow_local_and_toll_free_calls=...,
    mandatory_usage_user_id_list=...,
    optional_usage_user_id_list=...,
)

print(response)