@open-wa/wa-automate-types-only/dist/api/model/chat.d.ts

Types generated from the @open-wa/wa-automate package

import { ContactId, GroupChatId } from './aliases';
import { Contact } from './contact';
import { GroupMetadata } from './group-metadata';
export interface BaseChat {
    archive: boolean;
    changeNumberNewJid: any;
    changeNumberOldJid: any;
    /**
     * The contact related to this chat
     */
    contact: Contact;
    /**
     * Group metadata for this chat
     */
    groupMetadata: GroupMetadata;
    /**
     * If the chat is a group chat is restricted
     */
    isAnnounceGrpRestrict: any;
    /**
     * The title of the chat
     */
    formattedTitle?: string;
    /**
     * Whether your host account is able to send messages to this chat
     */
    canSend?: boolean;
    /**
     * Whether the chat is a group chat and the group is restricted
     */
    isReadOnly: boolean;
    kind: string;
    /**
     * The labels attached to this chat.
     */
    labels: any;
    /**
     * The ID of the last message received in this chat
     */
    lastReceivedKey: any;
    modifyTag: number;
    /**
     * The messages in the chat
     */
    msgs: any;
    /**
     * The expiration timestamp of the chat mute
     */
    muteExpiration: number;
    /**
     * The name of the chat
     */
    name: string;
    /**
     * Whether the chat is marked as spam
     */
    notSpam: boolean;
    /**
     * Messages that are pending to be sent
     */
    pendingMsgs: boolean;
    /**
     * Whether the chat is pinned
     */
    pin: number;
    /**
     * The presence state of the chat participant
     */
    presence: any;
    /**
     * The timestamp of the last interaction in the chat
     */
    t: number;
    /**
     * The number of undread messages in this chat
     */
    unreadCount: number;
    ack?: any;
    /**
     * @deprecated This is unreliable. Use the method [`isChatOnline`](https://open-wa.github.io/wa-automate-nodejs/classes/client.html#ischatonline) instead.
     */
    isOnline?: any;
    /**
     * @deprecated This is unreliable. Use the method [`getLastSeen`](https://open-wa.github.io/wa-automate-nodejs/classes/client.html#getlastseen) instead.
     */
    lastSeen?: any;
    /**
     * URL of the chat picture if available
     */
    pic?: string;
}
export interface SingleChat extends BaseChat {
    /**
     * The id of the chat
     */
    id: ContactId;
    /**
     * Whether the chat is a group chat
     */
    isGroup: false;
}
export interface GroupChat extends BaseChat {
    /**
     * The id of the chat
     */
    id: GroupChatId;
    /**
     * Whether the chat is a group chat
     */
    isGroup: true;
    /**
     * The type of the group
     */
    groupType: 'DEFAULT' | 'COMMUNITY' | 'LINKED_ANNOUNCEMENT_GROUP' | 'LINKED_GENERAL_GROUP' | 'LINKED_SUBGROUP';
}
export type Chat = SingleChat | GroupChat;
export interface LiveLocationChangedEvent {
    id: string;
    lat: number;
    lng: number;
    speed: number;
    lastUpdated: number;
    accuracy: number;
    degrees: any;
    /**
     * The message id that was sent when the liveLocation session was started.
     */
    msgId?: string;
}
/**
 * The ChatState represents the state you'd normally see represented under the chat name in the app.
 */
export declare enum ChatState {
    /**
     * `typing...`
     */
    TYPING = 0,
    /**
     * `recording audio...`
     */
    RECORDING = 1,
    /**
     * `online`
     */
    PAUSED = 2
}
/**
 * Chat types
 * @readonly
 * @enum {string}
 */
export declare enum ChatTypes {
    SOLO = "solo",
    GROUP = "group",
    UNKNOWN = "unknown"
}
/**
 * Valid durations for muting a chat using [[muteChat]]
 *
 * @readonly
 */
export declare enum ChatMuteDuration {
    /**
     * Mutes chat for 8 hours
     */
    EIGHT_HOURS = "EIGHT_HOURS",
    /**
     * Mutes chat for 1 week
     */
    ONE_WEEK = "ONE_WEEK",
    /**
     * Mutes chat forever
     */
    FOREVER = "FOREVER"
}
export interface GroupChatCreationParticipantAddResponse {
    /**
     * The resultant status code for adding the participant.
     *
     * 200 if the participant was added successfully during the creation of the group.
     *
     * 403 if the participant does not allow their account to be added to group chats. If you receive a 403, you will also get an `invite_code` and `invite_code_exp`
     */
    code: 200 | 400 | 403;
    /**
     * If the participant is not allowed to be added to group chats due to their privacy settings, you will receive an `invite_code` which you can send to them via a text.
     */
    invite_code?: string;
    /**
     * The expiry ts of the invite_code. It is a number wrapped in a string, in order to get the proper time you can use this:
     *
     * ```javascript
     *   new Date(Number(invite_code_exp)*1000)
     * ```
     */
    invite_code_exp?: string;
}
export interface GroupChatCreationResponse {
    /**
     * The resultant status code of the group chat creation.
     *
     * 200 if the group was created successfully.
     *
     * 400 if the initial participant does not exist
     */
    status: 200 | 400;
    /**
     * The group chat id
     */
    gid: GroupChatId;
    /**
     * The initial requested participants and their corresponding add responses
     */
    participants: {
        ContactId?: GroupChatCreationParticipantAddResponse;
    }[];
}
/**
 * Ephemeral duration can be 1 day, 7 days or 90 days. The default is 1 day.
 */
export type EphemeralDuration = 86400 | 604800 | 7776000;