SearchCriteriaUserName

Bases: SearchCriteria

Criteria for searching for a user's full name. This search criterion will be compared against multiple combinations of first name and last name:

First Name + ' ' + Last Name
Last Name + ' ' + First Name
Last Name + ', ' + First Name
Hiragana Last Name + ' ' + Hiragana First Name

Note that when specific conditions are met, VON users will be included in the search results.

Attributes:

mode (str):

value (str):

is_case_insensitive (bool):

Source code in src/mercury_ocip/commands/commands.py

@dataclass(kw_only=True)
class SearchCriteriaUserName(SearchCriteria):
    """Criteria for searching for a user's full name.
        This search criterion will be compared against multiple combinations of first name and last name:

        First Name + ' ' + Last Name
        Last Name + ' ' + First Name
        Last Name + ', ' + First Name
        Hiragana Last Name + ' ' + Hiragana First Name

        Note that when specific conditions are met, VON users will be included in the search results.

    Attributes:

        mode (str):

        value (str):

        is_case_insensitive (bool):

    """

    mode: str = field(metadata={"alias": "mode"})

    value: str = field(metadata={"alias": "value"})

    is_case_insensitive: bool = field(
        default=True, metadata={"alias": "isCaseInsensitive"}
    )