Skip to content

GroupIntegratedIMPModifyRequest

Bases: OCIRequest

Modify the Integrated IMP service attributes for the group. The response is either a SuccessResponse or an ErrorResponse.

The following elements can only be used by a reseller administrator or above:
  useServiceProviderMessagingServer
  provisioningUrl
  provisioningUserId
  provisioningPassword

Attributes:

service_provider_id (str):

group_id (str):

use_service_provider_setting (Optional[bool]):

service_domain (Optional[Nillable[str]]):

use_service_provider_messaging_server (Optional[bool]):

provisioning_url (Optional[Nillable[str]]):

provisioning_user_id (Optional[Nillable[str]]):

provisioning_password (Optional[Nillable[str]]):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class GroupIntegratedIMPModifyRequest(OCIRequest):
    """Modify the Integrated IMP service attributes for the group.
        The response is either a SuccessResponse or an ErrorResponse.

        The following elements can only be used by a reseller administrator or above:
          useServiceProviderMessagingServer
          provisioningUrl
          provisioningUserId
          provisioningPassword

    Attributes:

        service_provider_id (str):

        group_id (str):

        use_service_provider_setting (Optional[bool]):

        service_domain (Optional[Nillable[str]]):

        use_service_provider_messaging_server (Optional[bool]):

        provisioning_url (Optional[Nillable[str]]):

        provisioning_user_id (Optional[Nillable[str]]):

        provisioning_password (Optional[Nillable[str]]):

    """

    service_provider_id: str = field(metadata={"alias": "serviceProviderId"})

    group_id: str = field(metadata={"alias": "groupId"})

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

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

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

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

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

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

    def __post_init__(self):
        nillable_fields = [
            "service_domain",
            "provisioning_url",
            "provisioning_user_id",
            "provisioning_password",
        ]
        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 GroupIntegratedIMPModifyRequest

client = Client()

command = GroupIntegratedIMPModifyRequest(
    service_provider_id=...,
    group_id=...,
    use_service_provider_setting=...,
    service_domain=...,
    use_service_provider_messaging_server=...,
    provisioning_url=...,
    provisioning_user_id=...,
    provisioning_password=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("GroupIntegratedIMPModifyRequest",
    service_provider_id=...,
    group_id=...,
    use_service_provider_setting=...,
    service_domain=...,
    use_service_provider_messaging_server=...,
    provisioning_url=...,
    provisioning_user_id=...,
    provisioning_password=...,
)

print(response)