@dataclass(kw_only=True)
class UserConsolidatedAddRequest22(OCIRequest):
    """The response is either SuccessResponse or ErrorResponse.

         In AS Data Mode:
           The group user limit will be increased by one if needed.

           The group will be added if it does not exist and if the command is executed by a Service
           Provider level administrator or above. If the group needs to be created, the
           groupProperties element must be set or the request will fail.
           The groupProperties element will be ignored if the group already exists.

           If the domain has not been assigned to the group, it will be added to group if the
           command is executed by a Service provider level administrator or above.
           If the domain has not been assigned to the service provider, it will be added to the
           service provider if the command is executed by a Provisioning level administrator or
           above. The command will fail otherwise.

           If the phoneNumber has not been assigned to the group and addPhoneNumberToGroup is set
           to true, it will be added to group if the command is executed by a service provider
           administrator or above and the number is already assigned to the service provider. The
           command will fail otherwise.

           The password is not required if external authentication is enabled.
           Alternate user ids can be added by a group level administrator or above.

           When sharedCallAppearanceAccessDeviceEndpoint element is included and the Shared Call
           Appearance is not included in the service/service pack of the request or in the
           \"new user template\", the request will fail.

           The userService/servicePack will be authorized to the group if it has not been
           authorized to the group if the command is executed by a Service Provider level
           administrator or above. The command will fail otherwise.
           The authorizedQuantity will be set to unlimited if not present.

           When thirdPartyVoiceMail elements are included and the Third Party Voice Mail Support
           service is not included in the service/service pack of the request or in the
           \"new user template\", the request will fail.

           When sipAuthenticationData element is included and the Authentication service is not
           included in the service/service pack of the request or in the \"new user template\",
           the request will fail.


         In XS data mode:
           only the System level administrator has the authorization level to execute the command.
           The group will be added if it does not exist. If the group needs to be created, the
           groupProperties element must be set or the request will fail.
           The groupProperties element will be ignored if the group already exists.

           If the phoneNumber has not been assigned to the group, it will be added to group and
           service provider if needed.

           When sharedCallAppearanceAccessDeviceEndpoint element is included and the Shared
           Call Appearance is not included in the service/service pack of the request, the request
           will fail.

         The following elements are ignored in XS data mode:
           addPhoneNumberToGroup
           nameDialingName
           alternateUserId
           passcode
           trunkAddressing
           thirdPartyVoiceMailServerSelection
           thirdPartyVoiceMailServerUserServer
           thirdPartyVoiceMailServerMailboxIdType
           thirdPartyVoiceMailMailboxURL
           sipAuthenticationData
           isPlace

    Attributes:

        service_provider_id (Optional[str]):

        group_id (Optional[str]):

        group_external_id (Optional[str]):

        group_properties (Optional[ConsolidatedGroupProperties]):

        user_id (str):

        user_external_id (Optional[str]):

        user_person_id (Optional[str]):

        add_phone_number_to_group (Optional[bool]):

        last_name (str):

        first_name (str):

        calling_line_id_last_name (str):

        calling_line_id_first_name (str):

        name_dialing_name (Optional[NameDialingName]):

        hiragana_last_name (Optional[str]):

        hiragana_first_name (Optional[str]):

        phone_number (Optional[str]):

        alternate_user_id (Optional[List[AlternateUserIdEntry]]):

        extension (Optional[str]):

        calling_line_id_phone_number (Optional[str]):

        password (Optional[str]):

        passcode (Optional[str]):

        department (Optional[DepartmentKey]):

        language (Optional[str]):

        time_zone (Optional[str]):

        alias (Optional[List[str]]):

        access_device_endpoint (Optional[ConsolidatedAccessDeviceMultipleIdentityEndpointAndContactAdd22]):

        trunk_addressing (Optional[TrunkAddressingMultipleContactAdd]):

        shared_call_appearance_access_device_endpoint (Optional[List[ConsolidatedSharedCallAppearanceAccessDeviceMultipleIdentityEndpointAdd22]]):

        title (Optional[str]):

        pager_phone_number (Optional[str]):

        mobile_phone_number (Optional[str]):

        email_address (Optional[str]):

        yahoo_id (Optional[str]):

        address_location (Optional[str]):

        address (Optional[StreetAddress]):

        network_class_of_service (Optional[str]):

        user_service (Optional[List[ConsolidatedUserServiceAssignment]]):

        service_pack (Optional[List[ConsolidatedServicePackAssignment]]):

        third_party_voice_mail_server_selection (Optional[str]):

        third_party_voice_mail_server_user_server (Optional[Nillable[str]]):

        third_party_voice_mail_server_mailbox_id_type (Optional[str]):

        third_party_voice_mail_mailbox_url (Optional[Nillable[str]]):

        sip_authentication_data (Optional[SIPAuthenticationUserNamePassword]):

        is_place (Optional[bool]):

    """

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

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

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

    group_properties: Optional[ConsolidatedGroupProperties] = field(
        default=None, metadata={"alias": "groupProperties"}
    )

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

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

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

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

    last_name: str = field(metadata={"alias": "lastName"})

    first_name: str = field(metadata={"alias": "firstName"})

    calling_line_id_last_name: str = field(metadata={"alias": "callingLineIdLastName"})

    calling_line_id_first_name: str = field(
        metadata={"alias": "callingLineIdFirstName"}
    )

    name_dialing_name: Optional[NameDialingName] = field(
        default=None, metadata={"alias": "nameDialingName"}
    )

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

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

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

    alternate_user_id: Optional[List[AlternateUserIdEntry]] = field(
        default=None, metadata={"alias": "alternateUserId"}
    )

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

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

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

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

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

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

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

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

    access_device_endpoint: Optional[
        ConsolidatedAccessDeviceMultipleIdentityEndpointAndContactAdd22
    ] = field(default=None, metadata={"alias": "accessDeviceEndpoint"})

    trunk_addressing: Optional[TrunkAddressingMultipleContactAdd] = field(
        default=None, metadata={"alias": "trunkAddressing"}
    )

    shared_call_appearance_access_device_endpoint: Optional[
        List[ConsolidatedSharedCallAppearanceAccessDeviceMultipleIdentityEndpointAdd22]
    ] = field(
        default=None, metadata={"alias": "sharedCallAppearanceAccessDeviceEndpoint"}
    )

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

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

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

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

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

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

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

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

    user_service: Optional[List[ConsolidatedUserServiceAssignment]] = field(
        default=None, metadata={"alias": "userService"}
    )

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

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

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

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

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

    sip_authentication_data: Optional[SIPAuthenticationUserNamePassword] = field(
        default=None, metadata={"alias": "sipAuthenticationData"}
    )

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

    def __post_init__(self):
        nillable_fields = [
            "third_party_voice_mail_server_user_server",
            "third_party_voice_mail_mailbox_url",
        ]
        for field_name in nillable_fields:
            value = getattr(self, field_name)
            if value == "" or value == "None":
                object.__setattr__(self, field_name, OCINil)

class SuccessResponse(OCIResponse):
    pass

class ErrorResponse(OCIResponse):
    errorCode: Optional[int] = None
    summary: str
    summaryEnglish: str
    detail: Optional[str] = None