Skip to content

ServiceProviderIntegratedIMPModifyRequest

Bases: OCIRequest

Modify the Integrated IMP service attributes for the service provider. The response is either a SuccessResponse or an ErrorResponse. If the service provider is within a reseller, useSystemServiceDomain means using reseller level service domain setting. And useSystemMessagingServer means using the reseller level messaging server setting.

The following elements are only used in AS data mode:
  servicePort
  useSystemMessagingServer
  provisioningUrl
  provisioningUserId
  provisioningPassword
  boshURL
  defaultImpIdType
  useResellerIMPIdSetting

The element useResellerIMPIdSetting is only applicable for a service provider within a reseller.

Attributes:

service_provider_id (str):

use_system_service_domain (Optional[bool]):

service_domain (Optional[Nillable[str]]):

service_port (Optional[Nillable[int]]):

use_system_messaging_server (Optional[bool]):

provisioning_url (Optional[Nillable[str]]):

provisioning_user_id (Optional[Nillable[str]]):

provisioning_password (Optional[Nillable[str]]):

bosh_url (Optional[Nillable[str]]):

default_imp_id_type (Optional[str]):

use_reseller_imp_id_setting (Optional[bool]):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class ServiceProviderIntegratedIMPModifyRequest(OCIRequest):
    """Modify the Integrated IMP service attributes for the service provider.
        The response is either a SuccessResponse or an ErrorResponse.
        If the service provider is within a reseller, useSystemServiceDomain means using reseller level service
        domain setting. And useSystemMessagingServer means using the reseller level messaging server setting.

        The following elements are only used in AS data mode:
          servicePort
          useSystemMessagingServer
          provisioningUrl
          provisioningUserId
          provisioningPassword
          boshURL
          defaultImpIdType
          useResellerIMPIdSetting

        The element useResellerIMPIdSetting is only applicable for a service provider within a reseller.

    Attributes:

        service_provider_id (str):

        use_system_service_domain (Optional[bool]):

        service_domain (Optional[Nillable[str]]):

        service_port (Optional[Nillable[int]]):

        use_system_messaging_server (Optional[bool]):

        provisioning_url (Optional[Nillable[str]]):

        provisioning_user_id (Optional[Nillable[str]]):

        provisioning_password (Optional[Nillable[str]]):

        bosh_url (Optional[Nillable[str]]):

        default_imp_id_type (Optional[str]):

        use_reseller_imp_id_setting (Optional[bool]):

    """

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

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

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

    service_port: Optional[Nillable[int]] = field(
        default=None, metadata={"alias": "servicePort"}
    )

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

    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"}
    )

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

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

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

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

client = Client()

command = ServiceProviderIntegratedIMPModifyRequest(
    service_provider_id=...,
    use_system_service_domain=...,
    service_domain=...,
    service_port=...,
    use_system_messaging_server=...,
    provisioning_url=...,
    provisioning_user_id=...,
    provisioning_password=...,
    bosh_url=...,
    default_imp_id_type=...,
    use_reseller_imp_id_setting=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("ServiceProviderIntegratedIMPModifyRequest",
    service_provider_id=...,
    use_system_service_domain=...,
    service_domain=...,
    service_port=...,
    use_system_messaging_server=...,
    provisioning_url=...,
    provisioning_user_id=...,
    provisioning_password=...,
    bosh_url=...,
    default_imp_id_type=...,
    use_reseller_imp_id_setting=...,
)

print(response)