TutorialFlagGetRequest

Bases: OCIRequest

Get the tutorial flag setting for a user or admin. The response is either a TutorialFlagGetResponse or an ErrorResponse.

Attributes:

user_id (str):

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

@dataclass(kw_only=True)
class TutorialFlagGetRequest(OCIRequest):
    """Get the tutorial flag setting for a user or admin.
        The response is either a TutorialFlagGetResponse or an ErrorResponse.

    Attributes:

        user_id (str):

    """

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

Responses

Bases: OCIDataResponse

Response to the TutorialFlagGetRequest.

Attributes:

enable_tutorial (bool):

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

@dataclass(kw_only=True)
class TutorialFlagGetResponse(OCIDataResponse):
    """Response to the TutorialFlagGetRequest.

    Attributes:

        enable_tutorial (bool):

    """

    enable_tutorial: bool = field(metadata={"alias": "enableTutorial"})

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 TutorialFlagGetRequest

client = Client()

command = TutorialFlagGetRequest(
    user_id=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("TutorialFlagGetRequest",
    user_id=...,
)

print(response)