Skip to content

UserModifyRequest22

Bases: OCIRequest

The following data elements are only used in AS data mode

contact[2]-contact[5]

The following elements are only used in AS data mode and will fail in XS data mode:
  trunkAddressing
  newUserExternalId
The following elements are only used in AS data mode and ignored in XS data mode:
  nameDialingName
  alternateUserIdList
  newUserExternalId

The following elements are only used in XS data mode and ignored in AS data mode:
  allowVideo

The allowVideo element can only be used by a system administrator.

The impId and impPassword are accepted when the Third-Party IMP service is assigned to the user;
when Integrated IMP service is assigned to the user and active, only the impPassword is accepted;
all other cases, the request fails if either field is changed.

Attributes:

user_id (str):

last_name (Optional[str]):

first_name (Optional[str]):

calling_line_id_last_name (Optional[str]):

calling_line_id_first_name (Optional[str]):

name_dialing_name (Optional[Nillable[NameDialingName]]):

hiragana_last_name (Optional[str]):

hiragana_first_name (Optional[str]):

phone_number (Optional[Nillable[str]]):

extension (Optional[Nillable[str]]):

calling_line_id_phone_number (Optional[Nillable[str]]):

old_password (Optional[str]):

new_password (Optional[Nillable[str]]):

department (Optional[Nillable[DepartmentKey]]):

language (Optional[str]):

time_zone (Optional[str]):

sip_alias_list (Optional[Nillable[ReplacementSIPAliasList]]):

endpoint (Optional[Nillable[Union[AccessDeviceMultipleIdentityAndContactEndpointModify22, TrunkAddressingMultipleContactModify22]]]):

title (Optional[Nillable[str]]):

pager_phone_number (Optional[Nillable[str]]):

mobile_phone_number (Optional[Nillable[str]]):

email_address (Optional[Nillable[str]]):

yahoo_id (Optional[Nillable[str]]):

address_location (Optional[Nillable[str]]):

address (Optional[StreetAddress]):

network_class_of_service (Optional[str]):

office_zone_name (Optional[str]):

primary_zone_name (Optional[str]):

imp_id (Optional[Nillable[str]]):

imp_password (Optional[Nillable[str]]):

alternate_user_id_list (Optional[Nillable[ReplacementAlternateUserIdEntryList]]):

allow_video (Optional[bool]):

new_user_external_id (Optional[Nillable[str]]):

new_user_person_id (Optional[Nillable[str]]):
Source code in src/mercury_ocip_fast/commands/commands.py
110338
110339
110340
110341
110342
110343
110344
110345
110346
110347
110348
110349
110350
110351
110352
110353
110354
110355
110356
110357
110358
110359
110360
110361
110362
110363
110364
110365
110366
110367
110368
110369
110370
110371
110372
110373
110374
110375
110376
110377
110378
110379
110380
110381
110382
110383
110384
110385
110386
110387
110388
110389
110390
110391
110392
110393
110394
110395
110396
110397
110398
110399
110400
110401
110402
110403
110404
110405
110406
110407
110408
110409
110410
110411
110412
110413
110414
110415
110416
110417
110418
110419
110420
110421
110422
110423
110424
110425
110426
110427
110428
110429
110430
110431
110432
110433
110434
110435
110436
110437
110438
110439
110440
110441
110442
110443
110444
110445
110446
110447
110448
110449
110450
110451
110452
110453
110454
110455
110456
110457
110458
110459
110460
110461
110462
110463
110464
110465
110466
110467
110468
110469
110470
110471
110472
110473
110474
110475
110476
110477
110478
110479
110480
110481
110482
110483
110484
110485
110486
110487
110488
110489
110490
110491
110492
110493
110494
110495
110496
110497
110498
110499
110500
110501
110502
110503
110504
110505
110506
110507
110508
110509
110510
110511
110512
110513
110514
110515
110516
110517
110518
110519
110520
110521
110522
110523
110524
110525
110526
110527
110528
110529
110530
110531
110532
110533
110534
110535
110536
110537
110538
110539
110540
110541
110542
110543
110544
110545
110546
110547
110548
110549
110550
110551
110552
110553
110554
110555
110556
110557
110558
110559
110560
110561
110562
110563
110564
110565
110566
110567
110568
110569
110570
110571
110572
110573
110574
110575
110576
110577
110578
110579
@dataclass(kw_only=True)
class UserModifyRequest22(OCIRequest):
    """The following data elements are only used in AS data mode:
          contact[2]-contact[5]
        The following elements are only used in AS data mode and will fail in XS data mode:
          trunkAddressing
          newUserExternalId
        The following elements are only used in AS data mode and ignored in XS data mode:
          nameDialingName
          alternateUserIdList
          newUserExternalId

        The following elements are only used in XS data mode and ignored in AS data mode:
          allowVideo

        The allowVideo element can only be used by a system administrator.

        The impId and impPassword are accepted when the Third-Party IMP service is assigned to the user;
        when Integrated IMP service is assigned to the user and active, only the impPassword is accepted;
        all other cases, the request fails if either field is changed.

    Attributes:

        user_id (str):

        last_name (Optional[str]):

        first_name (Optional[str]):

        calling_line_id_last_name (Optional[str]):

        calling_line_id_first_name (Optional[str]):

        name_dialing_name (Optional[Nillable[NameDialingName]]):

        hiragana_last_name (Optional[str]):

        hiragana_first_name (Optional[str]):

        phone_number (Optional[Nillable[str]]):

        extension (Optional[Nillable[str]]):

        calling_line_id_phone_number (Optional[Nillable[str]]):

        old_password (Optional[str]):

        new_password (Optional[Nillable[str]]):

        department (Optional[Nillable[DepartmentKey]]):

        language (Optional[str]):

        time_zone (Optional[str]):

        sip_alias_list (Optional[Nillable[ReplacementSIPAliasList]]):

        endpoint (Optional[Nillable[Union[AccessDeviceMultipleIdentityAndContactEndpointModify22, TrunkAddressingMultipleContactModify22]]]):

        title (Optional[Nillable[str]]):

        pager_phone_number (Optional[Nillable[str]]):

        mobile_phone_number (Optional[Nillable[str]]):

        email_address (Optional[Nillable[str]]):

        yahoo_id (Optional[Nillable[str]]):

        address_location (Optional[Nillable[str]]):

        address (Optional[StreetAddress]):

        network_class_of_service (Optional[str]):

        office_zone_name (Optional[str]):

        primary_zone_name (Optional[str]):

        imp_id (Optional[Nillable[str]]):

        imp_password (Optional[Nillable[str]]):

        alternate_user_id_list (Optional[Nillable[ReplacementAlternateUserIdEntryList]]):

        allow_video (Optional[bool]):

        new_user_external_id (Optional[Nillable[str]]):

        new_user_person_id (Optional[Nillable[str]]):

    """

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

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

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

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

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

    name_dialing_name: Optional[Nillable[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[Nillable[str]] = field(
        default=None, metadata={"alias": "phoneNumber"}
    )

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

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

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

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

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

    sip_alias_list: Optional[Nillable[ReplacementSIPAliasList]] = field(
        default=None, metadata={"alias": "sipAliasList"}
    )

    endpoint: Optional[
        Nillable[
            Union[
                AccessDeviceMultipleIdentityAndContactEndpointModify22,
                TrunkAddressingMultipleContactModify22,
            ]
        ]
    ] = field(default=None, metadata={"alias": "endpoint"})

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

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

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

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

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

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

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

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

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

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

    alternate_user_id_list: Optional[Nillable[ReplacementAlternateUserIdEntryList]] = (
        field(default=None, metadata={"alias": "alternateUserIdList"})
    )

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

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

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

    def __post_init__(self):
        nillable_fields = [
            "name_dialing_name",
            "phone_number",
            "extension",
            "calling_line_id_phone_number",
            "new_password",
            "department",
            "sip_alias_list",
            "endpoint",
            "title",
            "pager_phone_number",
            "mobile_phone_number",
            "email_address",
            "yahoo_id",
            "address_location",
            "imp_id",
            "imp_password",
            "alternate_user_id_list",
            "new_user_external_id",
            "new_user_person_id",
        ]
        for field_name in nillable_fields:
            value = getattr(self, field_name)
            if value == "" or value == "None":
                object.__setattr__(self, field_name, OCINil)

Responses

:: mercury_ocip_fast.commands.base_command.ErrorResponse

:: mercury_ocip_fast.commands.base_command.SuccessResponse

Example Usage

from mercury_ocip_fast.client import Client
from mercury_ocip_fast.commands import UserModifyRequest22

client = Client()

command = UserModifyRequest22(
    user_id=...,
    last_name=...,
    first_name=...,
    calling_line_id_last_name=...,
    calling_line_id_first_name=...,
    name_dialing_name=...,
    hiragana_last_name=...,
    hiragana_first_name=...,
    phone_number=...,
    extension=...,
    calling_line_id_phone_number=...,
    old_password=...,
    new_password=...,
    department=...,
    language=...,
    time_zone=...,
    sip_alias_list=...,
    endpoint=...,
    title=...,
    pager_phone_number=...,
    mobile_phone_number=...,
    email_address=...,
    yahoo_id=...,
    address_location=...,
    address=...,
    network_class_of_service=...,
    office_zone_name=...,
    primary_zone_name=...,
    imp_id=...,
    imp_password=...,
    alternate_user_id_list=...,
    allow_video=...,
    new_user_external_id=...,
    new_user_person_id=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("UserModifyRequest22",
    user_id=...,
    last_name=...,
    first_name=...,
    calling_line_id_last_name=...,
    calling_line_id_first_name=...,
    name_dialing_name=...,
    hiragana_last_name=...,
    hiragana_first_name=...,
    phone_number=...,
    extension=...,
    calling_line_id_phone_number=...,
    old_password=...,
    new_password=...,
    department=...,
    language=...,
    time_zone=...,
    sip_alias_list=...,
    endpoint=...,
    title=...,
    pager_phone_number=...,
    mobile_phone_number=...,
    email_address=...,
    yahoo_id=...,
    address_location=...,
    address=...,
    network_class_of_service=...,
    office_zone_name=...,
    primary_zone_name=...,
    imp_id=...,
    imp_password=...,
    alternate_user_id_list=...,
    allow_video=...,
    new_user_external_id=...,
    new_user_person_id=...,
)

print(response)