Skip to content

ServiceProviderConsolidatedAddRequest

Bases: OCIRequest

Add a service provider or enterprise. The response is either a SuccessResponse or an ErrorResponse. The following elements are only used in AS data mode and ignored in XS data mode: serviceProviderExtenalId provisioningSliceId

The following elements are ignored in AS and XS data mode:
servicePolicy,
callProcessingSliceId,
subscriberPartition.

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

The following data elements are only used in AS data mode:
  resellerId
  resellerName

The following elements are optional for the service provider. If the elements are included,
they will be either added, authorized, or modified on the service provider. Should any of the
following elements be rejected to due existing system settings, the service provider will not
be added and the response will be an ErrorResponse:
  domain
  admin
  groupServiceAuthorization
  userServiceAuthorization
  servicePack
  phoneNumber
  dnRange
  routingProfile
  meetMeConferencingAllocatedPorts
  trunkGroupMaxActiveCalls
  trunkGroupBurstingMaxActiveCalls
  voiceMessagingGroupSettings
  voiceMessagingVoicePortalScope

When a group or user service is included that is not activated or is not licensed,
the response will be an ErrorResponse.

Attributes:

is_enterprise (Optional[bool]):

use_custom_routing_profile (Optional[bool]):

service_provider_id (Optional[str]):

service_provider_external_id (Optional[str]):

default_domain (str):

service_provider_name (Optional[str]):

support_email (Optional[str]):

contact (Optional[Contact]):

address (Optional[StreetAddress]):

service_policy (Optional[str]):

call_processing_slice_id (Optional[str]):

provisioning_slice_id (Optional[str]):

subscriber_partition (Optional[str]):

preferred_data_center (Optional[str]):

reseller_id (Optional[str]):

reseller_name (Optional[str]):

domain (Optional[List[str]]):

admin (Optional[List[ServiceProviderAdmin]]):

group_service_authorization (Optional[List[GroupServiceAuthorization]]):

user_service_authorization (Optional[List[UserServiceAuthorization]]):

service_pack (Optional[List[ServicePack]]):

phone_number (Optional[List[str]]):

dn_range (Optional[List[DNRange]]):

routing_profile (Optional[Nillable[str]]):

meet_me_conferencing_allocated_ports (Optional[MeetMeConferencingConferencePorts]):

trunk_group_max_active_calls (Optional[UnboundedNonNegativeInt]):

trunk_group_bursting_max_active_calls (Optional[UnboundedNonNegativeInt]):

voice_messaging_group_settings (Optional[ServiceProviderVoiceMessagingGroupSettingsAdd]):

voice_messaging_group_voice_portal_scope (Optional[str]):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class ServiceProviderConsolidatedAddRequest(OCIRequest):
    """Add a service provider or enterprise.
        The response is either a SuccessResponse or an ErrorResponse.
        The following elements are only used in AS data mode and ignored in XS data mode:
          serviceProviderExtenalId
          provisioningSliceId

        The following elements are ignored in AS and XS data mode:
        servicePolicy,
        callProcessingSliceId,
        subscriberPartition.

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

        The following data elements are only used in AS data mode:
          resellerId
          resellerName

        The following elements are optional for the service provider. If the elements are included,
        they will be either added, authorized, or modified on the service provider. Should any of the
        following elements be rejected to due existing system settings, the service provider will not
        be added and the response will be an ErrorResponse:
          domain
          admin
          groupServiceAuthorization
          userServiceAuthorization
          servicePack
          phoneNumber
          dnRange
          routingProfile
          meetMeConferencingAllocatedPorts
          trunkGroupMaxActiveCalls
          trunkGroupBurstingMaxActiveCalls
          voiceMessagingGroupSettings
          voiceMessagingVoicePortalScope

        When a group or user service is included that is not activated or is not licensed,
        the response will be an ErrorResponse.

    Attributes:

        is_enterprise (Optional[bool]):

        use_custom_routing_profile (Optional[bool]):

        service_provider_id (Optional[str]):

        service_provider_external_id (Optional[str]):

        default_domain (str):

        service_provider_name (Optional[str]):

        support_email (Optional[str]):

        contact (Optional[Contact]):

        address (Optional[StreetAddress]):

        service_policy (Optional[str]):

        call_processing_slice_id (Optional[str]):

        provisioning_slice_id (Optional[str]):

        subscriber_partition (Optional[str]):

        preferred_data_center (Optional[str]):

        reseller_id (Optional[str]):

        reseller_name (Optional[str]):

        domain (Optional[List[str]]):

        admin (Optional[List[ServiceProviderAdmin]]):

        group_service_authorization (Optional[List[GroupServiceAuthorization]]):

        user_service_authorization (Optional[List[UserServiceAuthorization]]):

        service_pack (Optional[List[ServicePack]]):

        phone_number (Optional[List[str]]):

        dn_range (Optional[List[DNRange]]):

        routing_profile (Optional[Nillable[str]]):

        meet_me_conferencing_allocated_ports (Optional[MeetMeConferencingConferencePorts]):

        trunk_group_max_active_calls (Optional[UnboundedNonNegativeInt]):

        trunk_group_bursting_max_active_calls (Optional[UnboundedNonNegativeInt]):

        voice_messaging_group_settings (Optional[ServiceProviderVoiceMessagingGroupSettingsAdd]):

        voice_messaging_group_voice_portal_scope (Optional[str]):

    """

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

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

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

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

    default_domain: str = field(metadata={"alias": "defaultDomain"})

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

    support_email: Optional[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"}
    )

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

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

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

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

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

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

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

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

    admin: Optional[List[ServiceProviderAdmin]] = field(
        default=None, metadata={"alias": "admin"}
    )

    group_service_authorization: Optional[List[GroupServiceAuthorization]] = field(
        default=None, metadata={"alias": "groupServiceAuthorization"}
    )

    user_service_authorization: Optional[List[UserServiceAuthorization]] = field(
        default=None, metadata={"alias": "userServiceAuthorization"}
    )

    service_pack: Optional[List[ServicePack]] = field(
        default=None, metadata={"alias": "servicePack"}
    )

    phone_number: Optional[List[str]] = field(
        default=None, metadata={"alias": "phoneNumber"}
    )

    dn_range: Optional[List[DNRange]] = field(
        default=None, metadata={"alias": "dnRange"}
    )

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

    meet_me_conferencing_allocated_ports: Optional[
        MeetMeConferencingConferencePorts
    ] = field(default=None, metadata={"alias": "meetMeConferencingAllocatedPorts"})

    trunk_group_max_active_calls: Optional[UnboundedNonNegativeInt] = field(
        default=None, metadata={"alias": "trunkGroupMaxActiveCalls"}
    )

    trunk_group_bursting_max_active_calls: Optional[UnboundedNonNegativeInt] = field(
        default=None, metadata={"alias": "trunkGroupBurstingMaxActiveCalls"}
    )

    voice_messaging_group_settings: Optional[
        ServiceProviderVoiceMessagingGroupSettingsAdd
    ] = field(default=None, metadata={"alias": "voiceMessagingGroupSettings"})

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

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

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

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 ServiceProviderConsolidatedAddRequest

client = Client()

command = ServiceProviderConsolidatedAddRequest(
    is_enterprise=...,
    use_custom_routing_profile=...,
    service_provider_id=...,
    service_provider_external_id=...,
    default_domain=...,
    service_provider_name=...,
    support_email=...,
    contact=...,
    address=...,
    service_policy=...,
    call_processing_slice_id=...,
    provisioning_slice_id=...,
    subscriber_partition=...,
    preferred_data_center=...,
    reseller_id=...,
    reseller_name=...,
    domain=...,
    admin=...,
    group_service_authorization=...,
    user_service_authorization=...,
    service_pack=...,
    phone_number=...,
    dn_range=...,
    routing_profile=...,
    meet_me_conferencing_allocated_ports=...,
    trunk_group_max_active_calls=...,
    trunk_group_bursting_max_active_calls=...,
    voice_messaging_group_settings=...,
    voice_messaging_group_voice_portal_scope=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("ServiceProviderConsolidatedAddRequest",
    is_enterprise=...,
    use_custom_routing_profile=...,
    service_provider_id=...,
    service_provider_external_id=...,
    default_domain=...,
    service_provider_name=...,
    support_email=...,
    contact=...,
    address=...,
    service_policy=...,
    call_processing_slice_id=...,
    provisioning_slice_id=...,
    subscriber_partition=...,
    preferred_data_center=...,
    reseller_id=...,
    reseller_name=...,
    domain=...,
    admin=...,
    group_service_authorization=...,
    user_service_authorization=...,
    service_pack=...,
    phone_number=...,
    dn_range=...,
    routing_profile=...,
    meet_me_conferencing_allocated_ports=...,
    trunk_group_max_active_calls=...,
    trunk_group_bursting_max_active_calls=...,
    voice_messaging_group_settings=...,
    voice_messaging_group_voice_portal_scope=...,
)

print(response)