UserBroadWorksReceptionistEnterpriseNoteModifyListRequest

Bases: OCIRequest

Add a list of notes for an existing Receptionist user. The response is either a SuccessResponse or an ErrorResponse. If some of the users add and some users fail to add, then the response will contain a WarningResponse containing only the a comma delimited list of users that failed to add. If the user sending the request is the not the owner of the Receptionist Note, then an ErrorResponse will be returned.

Attributes:

receptionist_user_id (str):

receptionist_user_and_note (List[ReceptionistContactUserAndNote]):

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

@dataclass(kw_only=True)
class UserBroadWorksReceptionistEnterpriseNoteModifyListRequest(OCIRequest):
    """Add a list of notes for an existing Receptionist user.
        The response is either a SuccessResponse or an ErrorResponse.
        If some of the users add and some users fail to add, then the
        response will contain a WarningResponse containing only the
        a comma delimited list of users that failed to add. If the user
        sending the request is the not the owner of the Receptionist Note,
        then an ErrorResponse will be returned.

    Attributes:

        receptionist_user_id (str):

        receptionist_user_and_note (List[ReceptionistContactUserAndNote]):

    """

    receptionist_user_id: str = field(metadata={"alias": "receptionistUserId"})

    receptionist_user_and_note: List[ReceptionistContactUserAndNote] = field(
        metadata={"alias": "receptionistUserAndNote"}
    )

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

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 UserBroadWorksReceptionistEnterpriseNoteModifyListRequest

client = Client()

command = UserBroadWorksReceptionistEnterpriseNoteModifyListRequest(
    receptionist_user_id=...,
    receptionist_user_and_note=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("UserBroadWorksReceptionistEnterpriseNoteModifyListRequest",
    receptionist_user_id=...,
    receptionist_user_and_note=...,
)

print(response)