UserAnnouncementFileAddRequest

Bases: OCIRequest

Add an announcement to the user announcement repository

The following elements are only used in AS data mode and ignored in XS data mode:
  announcementFileExternalId

The response is either a SuccessResponse or an ErrorResponse.

Attributes:

user_id (str):

announcement_file_name (Optional[str]):

announcement_file_external_id (Optional[str]):

announcement_file (LabeledMediaFileResource):

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

@dataclass(kw_only=True)
class UserAnnouncementFileAddRequest(OCIRequest):
    """Add an announcement to the user announcement repository

        The following elements are only used in AS data mode and ignored in XS data mode:
          announcementFileExternalId

        The response is either a SuccessResponse or an ErrorResponse.

    Attributes:

        user_id (str):

        announcement_file_name (Optional[str]):

        announcement_file_external_id (Optional[str]):

        announcement_file (LabeledMediaFileResource):

    """

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

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

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

    announcement_file: LabeledMediaFileResource = field(
        metadata={"alias": "announcementFile"}
    )

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 UserAnnouncementFileAddRequest

client = Client()

command = UserAnnouncementFileAddRequest(
    user_id=...,
    announcement_file_name=...,
    announcement_file_external_id=...,
    announcement_file=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("UserAnnouncementFileAddRequest",
    user_id=...,
    announcement_file_name=...,
    announcement_file_external_id=...,
    announcement_file=...,
)

print(response)