UserCommunicationBarringModifyRequest

Bases: OCIRequest

Modify the Communication Barring settings for a user. If useDefaultServiceProviderProfile is set to false, a profile name must be present. The response is either a SuccessResponse or an ErrorResponse. This command only applies to groups in an Enterprise. This command will fail for groups in a Service Provider.

Attributes:

user_id (str):

use_group_setting (Optional[bool]):

profile_name (Optional[Nillable[str]]):

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

@dataclass(kw_only=True)
class UserCommunicationBarringModifyRequest(OCIRequest):
    """Modify the Communication Barring settings for a user. If useDefaultServiceProviderProfile is set to false, a profile name must be present.
        The response is either a SuccessResponse or an ErrorResponse.
        This command only applies to groups in an Enterprise. This command will fail for groups in a Service Provider.

    Attributes:

        user_id (str):

        use_group_setting (Optional[bool]):

        profile_name (Optional[Nillable[str]]):

    """

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

    use_group_setting: Optional[bool] = field(
        default=None, metadata={"alias": "useGroupSetting"}
    )

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

    def __post_init__(self):
        nillable_fields = ["profile_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_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 UserCommunicationBarringModifyRequest

client = Client()

command = UserCommunicationBarringModifyRequest(
    user_id=...,
    use_group_setting=...,
    profile_name=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("UserCommunicationBarringModifyRequest",
    user_id=...,
    use_group_setting=...,
    profile_name=...,
)

print(response)