UserShInterfaceModifyRequest

Bases: OCIRequest

Modifies the Sh Interface non-transparent data associated with a Public User Identity. The response is a SuccessResponse or ErrorResponse.

Attributes:

public_user_identity (PublicUserIdentity):

scscf_name (Optional[Nillable[str]]):

ims_user_state (Optional[str]):

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

@dataclass(kw_only=True)
class UserShInterfaceModifyRequest(OCIRequest):
    """Modifies the Sh Interface non-transparent data associated with a Public User Identity.
        The response is a SuccessResponse or ErrorResponse.

    Attributes:

        public_user_identity (PublicUserIdentity):

        scscf_name (Optional[Nillable[str]]):

        ims_user_state (Optional[str]):

    """

    public_user_identity: PublicUserIdentity = field(
        metadata={"alias": "publicUserIdentity"}
    )

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

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

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

client = Client()

command = UserShInterfaceModifyRequest(
    public_user_identity=...,
    scscf_name=...,
    ims_user_state=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("UserShInterfaceModifyRequest",
    public_user_identity=...,
    scscf_name=...,
    ims_user_state=...,
)

print(response)