UserCommunicationBarringUserControlModifyRequest

Bases: OCIRequest

Enabling a profile automatically disables the currently active profile. Also allows the passcode for the service to be modified and the lockout to be reset. Admins only need to populate the newPasscode field when changing the passcode. Users must populate both the oldPasscode and new Passcode fields when changing the passcode. The response is either SuccessResponse or ErrorResponse.

Attributes:

user_id (str):

enable_profile (Optional[Nillable[int]]):

old_passcode (Optional[str]):

new_passcode (Optional[str]):

reset_lockout (Optional[bool]):

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

@dataclass(kw_only=True)
class UserCommunicationBarringUserControlModifyRequest(OCIRequest):
    """Enabling a profile automatically disables the currently active profile.
        Also allows the passcode for the service to be modified and the lockout to be reset.
        Admins only need to populate the newPasscode field when changing the passcode.
        Users must populate both the oldPasscode and new Passcode fields when changing the passcode.
        The response is either SuccessResponse or ErrorResponse.

    Attributes:

        user_id (str):

        enable_profile (Optional[Nillable[int]]):

        old_passcode (Optional[str]):

        new_passcode (Optional[str]):

        reset_lockout (Optional[bool]):

    """

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

    enable_profile: Optional[Nillable[int]] = field(
        default=None, metadata={"alias": "enableProfile"}
    )

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

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

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

    def __post_init__(self):
        nillable_fields = ["enable_profile"]
        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_fast/commands/base_command.py

class SuccessResponse(OCIResponse):
    pass

Bases: OCIResponse

Source code in src/mercury_ocip_fast/commands/base_command.py

class ErrorResponse(OCIResponse):
    errorCode: Optional[int] = None
    summary: str
    summaryEnglish: str
    detail: Optional[str] = None

Example Usage

from mercury_ocip_fast.client import Client
from mercury_ocip_fast.commands import UserCommunicationBarringUserControlModifyRequest

client = Client()

command = UserCommunicationBarringUserControlModifyRequest(
    user_id=...,
    enable_profile=...,
    old_passcode=...,
    new_passcode=...,
    reset_lockout=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("UserCommunicationBarringUserControlModifyRequest",
    user_id=...,
    enable_profile=...,
    old_passcode=...,
    new_passcode=...,
    reset_lockout=...,
)

print(response)