Skip to content

ServiceProviderModifyRequest

Bases: OCIRequest

Modify the profile for a service provider or enterprise. The response is either a SuccessResponse or an ErrorResponse. The following elements are ignored in AS and XS data mode: servicePolicy, callProcessingSliceId, subscriberPartition.

The following element is only used in AS data mode and ignored
in XS data mode:
resellerId
resellerName
provisioningSliceId

The following element is only used by Reseller Administrator or Above:
resellerId
    resellerName

Only Provisioning admin and above can change the preferredDataCenter and provisioningSliceId.

The following elements are only used in AS data mode and ignored in XS data mode:
            defaultExtensionLength
            locationRoutingPrefixDigit
            locationCodeLength

Attributes:

service_provider_id (str):

default_domain (Optional[str]):

service_provider_name (Optional[Nillable[str]]):

support_email (Optional[Nillable[str]]):

contact (Optional[Contact]):

address (Optional[StreetAddress]):

use_service_provider_languages (Optional[bool]):

service_policy (Optional[Nillable[str]]):

call_processing_slice_id (Optional[Nillable[str]]):

provisioning_slice_id (Optional[Nillable[str]]):

subscriber_partition (Optional[Nillable[str]]):

preferred_data_center (Optional[Nillable[str]]):

default_extension_length (Optional[Nillable[int]]):

location_routing_prefix_digit (Optional[Nillable[int]]):

location_code_length (Optional[Nillable[int]]):

reseller_id (Optional[str]):

reseller_name (Optional[str]):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class ServiceProviderModifyRequest(OCIRequest):
    """Modify the profile for a service provider or enterprise.
        The response is either a SuccessResponse or an ErrorResponse.
        The following elements are ignored in AS and XS data mode:
        servicePolicy,
        callProcessingSliceId,
        subscriberPartition.


        The following element is only used in AS data mode and ignored
        in XS data mode:
        resellerId
        resellerName
        provisioningSliceId

        The following element is only used by Reseller Administrator or Above:
        resellerId
            resellerName

        Only Provisioning admin and above can change the preferredDataCenter and provisioningSliceId.

        The following elements are only used in AS data mode and ignored in XS data mode:
                    defaultExtensionLength
                    locationRoutingPrefixDigit
                    locationCodeLength

    Attributes:

        service_provider_id (str):

        default_domain (Optional[str]):

        service_provider_name (Optional[Nillable[str]]):

        support_email (Optional[Nillable[str]]):

        contact (Optional[Contact]):

        address (Optional[StreetAddress]):

        use_service_provider_languages (Optional[bool]):

        service_policy (Optional[Nillable[str]]):

        call_processing_slice_id (Optional[Nillable[str]]):

        provisioning_slice_id (Optional[Nillable[str]]):

        subscriber_partition (Optional[Nillable[str]]):

        preferred_data_center (Optional[Nillable[str]]):

        default_extension_length (Optional[Nillable[int]]):

        location_routing_prefix_digit (Optional[Nillable[int]]):

        location_code_length (Optional[Nillable[int]]):

        reseller_id (Optional[str]):

        reseller_name (Optional[str]):

    """

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

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

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

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

    contact: Optional[Contact] = field(default=None, metadata={"alias": "contact"})

    address: Optional[StreetAddress] = field(
        default=None, metadata={"alias": "address"}
    )

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

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

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

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

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

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

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

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

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

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

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

    def __post_init__(self):
        nillable_fields = [
            "service_provider_name",
            "support_email",
            "service_policy",
            "call_processing_slice_id",
            "provisioning_slice_id",
            "subscriber_partition",
            "preferred_data_center",
            "default_extension_length",
            "location_routing_prefix_digit",
            "location_code_length",
        ]
        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 ServiceProviderModifyRequest

client = Client()

command = ServiceProviderModifyRequest(
    service_provider_id=...,
    default_domain=...,
    service_provider_name=...,
    support_email=...,
    contact=...,
    address=...,
    use_service_provider_languages=...,
    service_policy=...,
    call_processing_slice_id=...,
    provisioning_slice_id=...,
    subscriber_partition=...,
    preferred_data_center=...,
    default_extension_length=...,
    location_routing_prefix_digit=...,
    location_code_length=...,
    reseller_id=...,
    reseller_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("ServiceProviderModifyRequest",
    service_provider_id=...,
    default_domain=...,
    service_provider_name=...,
    support_email=...,
    contact=...,
    address=...,
    use_service_provider_languages=...,
    service_policy=...,
    call_processing_slice_id=...,
    provisioning_slice_id=...,
    subscriber_partition=...,
    preferred_data_center=...,
    default_extension_length=...,
    location_routing_prefix_digit=...,
    location_code_length=...,
    reseller_id=...,
    reseller_name=...,
)

print(response)