UserPersonalAssistantExclusionNumberModifyRequest

Bases: OCIRequest

Modify an existing User Personal Assistant Exclusion Number description. The response is either a SuccessResponse or an ErrorResponse.

Attributes:

user_id (str):

exclusion_number (str):

description (Optional[Nillable[str]]):

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

@dataclass(kw_only=True)
class UserPersonalAssistantExclusionNumberModifyRequest(OCIRequest):
    """Modify an existing User Personal Assistant Exclusion Number description.
        The response is either a SuccessResponse or an ErrorResponse.

    Attributes:

        user_id (str):

        exclusion_number (str):

        description (Optional[Nillable[str]]):

    """

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

    exclusion_number: str = field(metadata={"alias": "exclusionNumber"})

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

    def __post_init__(self):
        nillable_fields = ["description"]
        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 UserPersonalAssistantExclusionNumberModifyRequest

client = Client()

command = UserPersonalAssistantExclusionNumberModifyRequest(
    user_id=...,
    exclusion_number=...,
    description=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("UserPersonalAssistantExclusionNumberModifyRequest",
    user_id=...,
    exclusion_number=...,
    description=...,
)

print(response)