mattermost-mobile/types/api/users.d.ts

// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
// See LICENSE.txt for license information.

type UserNotifyProps = {
    auto_responder_active?: 'true' | 'false';
    auto_responder_message?: string;
    channel: 'true' | 'false';
    comments: 'never' | 'root' | 'any';
    desktop: 'default' | 'all' | 'mention' | 'none';
    desktop_notification_sound?: string;
    desktop_sound: 'true' | 'false';
    email: 'true' | 'false';
    first_name: 'true' | 'false';
    mark_unread?: 'all' | 'mention';
    mention_keys: string;
    highlight_keys: string;
    push: 'default' | 'all' | 'mention' | 'none';
    push_status: 'ooo' | 'offline' | 'away' | 'dnd' | 'online';
    user_id?: string;
    push_threads?: 'all' | 'mention';
    email_threads?: 'all' | 'mention';
    calls_desktop_sound: 'true' | 'false';
    calls_notification_sound: string;
    calls_mobile_sound: 'true' | 'false' | '';
    calls_mobile_notification_sound: string;
};

/**
 * CustomProfileAttribute
 * @description Value of a system property defined by a custom profile attribute field
 **/
type CustomProfileAttribute = {

    /** server assigned id **/
    id: string;

    /** id of the target element if empty it is a system property **/
    target_id: string;

    /** type of element this is assigned to. Possible values user, post, card... if empty it is a system property **/
    target_type: string;

    /** id of the group the field belongs to **/
    group_id: string;

    /** field id this value is referring to **/
    field_id: string;

    /** actual value **/
    value: string;
    create_at: number;
    update_at: number;
    delete_at: number;
}

type UserProfile = {
    id: string;
    create_at: number;
    update_at: number;
    delete_at: number;
    username: string;
    auth_data?: string;
    auth_service: string;
    email: string;
    email_verified?: boolean;
    nickname: string;
    first_name: string;
    last_name: string;
    position: string;
    roles: string;
    locale: string;
    notify_props: UserNotifyProps;
    props?: UserProps;
    terms_of_service_id?: string;
    terms_of_service_create_at?: number;
    timezone?: UserTimezone;
    is_bot?: boolean;
    last_picture_update?: number;
    remote_id?: string;
    status?: string;
    bot_description?: string;
    bot_last_icon_update?: number;
};

type UsersState = {
    currentUserId: string;
    isManualStatus: RelationOneToOne<UserProfile, boolean>;
    mySessions: any[];
    profiles: IDMappedObjects<UserProfile>;
    profilesInTeam: RelationOneToMany<Team, UserProfile>;
    profilesNotInTeam: RelationOneToMany<Team, UserProfile>;
    profilesWithoutTeam: Set<string>;
    profilesInChannel: RelationOneToMany<Channel, UserProfile>;
    profilesNotInChannel: RelationOneToMany<Channel, UserProfile>;
    statuses: RelationOneToOne<UserProfile, string>;
    stats: any;
};

type UserTimezone = {
    useAutomaticTimezone: boolean | string;
    automaticTimezone: string;
    manualTimezone: string;
};

type UserActivity = {
    [x in PostType]: {
        [y in $ID<UserProfile>]: | {
            ids: Array<$ID<UserProfile>>;
            usernames: Array<UserProfile['username']>;
        } | Array<$ID<UserProfile>>;
    };
};

type UserStatus = {
	user_id: string;
	status: string;
	manual: boolean;
	last_activity_at: number;
	active_channel?: string;
};

type UserProps = {
    [userPropsName: string]: any;
};

type UserCustomStatus = {
    emoji?: string;
    text?: string;
    expires_at?: string;
    duration?: CustomStatusDuration;
};

type CustomStatusDuration = '' | 'thirty_minutes' | 'one_hour' | 'four_hours' | 'today' | 'this_week' | 'date_and_time';

type SearchUserOptions = {
	team_id?: string;
	not_in_team?: string;
	in_channel_id?: string;
	not_in_channel_id?: string;
	in_group_id?: string;
	group_constrained?: boolean;
	allow_inactive?: boolean;
	without_team?: string;
	limit?: string;
};

type GetUsersOptions = {
    page?: number;
    per_page?: number;
	in_team?: string;
	not_in_team?: string;
	in_channel?: string;
	not_in_channel?: string;
	in_group?: string;
	group_constrained?: boolean;
	without_team?: boolean;
	active?: boolean;
	inactive?: boolean;
	role?: string;
	sort?: string;
	roles?: string;
	channel_roles?: string;
	team_roles?: string;
};

type LoginType = '' | 'magic_link';