talkyzap-wapp-api 1.0.0

package/dist/whatsapp/models/Model.d.ts

@@ -0,0 +1,63 @@
+/*!
+ * Copyright 2021 WPPConnect Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { Stringable } from '../../types';
+import { WritableProperties } from '../../util';
+import { EventEmitter } from '../misc';
+export type ModelProxy<P, S, D> = P & S & Readonly<D> & {
+    readonly attributes: P & S;
+    readonly isState: true;
+    readonly mirrorMask: {
+        [key in keyof (P & S & D) as `change:${string & key}`]: number;
+    };
+    toJSON(): P;
+    serialize(): P;
+};
+export type ModelPropertiesContructor<Model, K extends keyof Model = any> = Partial<WritableProperties<Model>> & Required<WritableProperties<Pick<Model, K>>>;
+export interface ModelOptions {
+    _internalInitializationDoNotUse?: any;
+    collection?: any;
+    merge?: any;
+    parent?: any;
+    silent?: any;
+}
+/** @whatsapp 11290
+ * @whatsapp 411290 >= 2.2222.8
+ */
+export declare class Model<Collection = undefined> extends EventEmitter {
+    static Proxy: string;
+    static idClass?: any;
+    static allowedIds?: any[];
+    parent?: any;
+    collection?: Collection;
+    proxyName: string;
+    constructor(proterties?: any, options?: any);
+    initialize(): void;
+    incObservers(e?: boolean): void;
+    decObservers(): void;
+    hasObservers(): boolean;
+    addChild(id: Stringable, context: {
+        [key: string]: any;
+    }): void;
+    get<T extends keyof this>(attr: T): this[T];
+    set(...args: any): any;
+    hasUnfiredChanges(): boolean;
+    unset(ids: Stringable | Stringable[], t?: any): void;
+    clear(): void;
+    delete(): void;
+    reset(): void;
+    getDefault<T extends keyof this>(attr: T): any;
+    static isIdType(e: any): boolean;
+}

package/dist/whatsapp/models/ModelChatBase.d.ts

@@ -0,0 +1,45 @@
+/*!
+ * Copyright 2021 WPPConnect Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { ChatCollection } from '../collections';
+import { MsgKey, MsgLoad, Wid } from '../misc';
+import { Model } from './Model';
+import { MsgModel } from './MsgModel';
+export interface PropsChatBase {
+    id: Wid;
+    pendingMsgs: boolean;
+    labels?: string[];
+}
+export interface SessionChatBase {
+    msgChunks: MsgLoad[];
+    lastReceivedKey?: MsgKey;
+    unreadMsgAnchor: any;
+    disableUnreadAnchor: any;
+    msgsLength: number;
+    msgsChanged: number;
+}
+/** @whatsapp 58492
+ * @whatsapp 558492 >= 2.2222.8
+ */
+export declare class ModelChatBase extends Model<ChatCollection> {
+    msgs: MsgLoad;
+    onEmptyMRM(): void;
+    removeMsg(msg: MsgModel): void;
+    getAllCMCs(): MsgLoad[];
+    getAllMsgs(): MsgModel[];
+    replaceMsgsCollection(collecton: MsgLoad): void;
+    removeMsgsCollection(collecton: MsgLoad): void;
+    notifyMsgCollectionMerge(...args: any[]): void;
+}

package/dist/whatsapp/models/MsgButtonReplyMsgModel.d.ts

@@ -0,0 +1,39 @@
+/*!
+ * Copyright 2021 WPPConnect Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { MsgKey } from '../misc';
+import { Model, ModelOptions, ModelPropertiesContructor, ModelProxy } from './Model';
+interface Props {
+    id: MsgKey;
+    unsyncedButtonReplies?: any;
+}
+interface Session {
+    stale?: any;
+}
+interface Derived {
+}
+/** @whatsapp 52846
+ * @whatsapp 252846 >= 2.2222.8
+ */
+export declare interface MsgButtonReplyMsgModel extends ModelProxy<Props, Session, Derived> {
+}
+/** @whatsapp 52846
+ * @whatsapp 252846 >= 2.2222.8
+ */
+export declare class MsgButtonReplyMsgModel extends Model {
+    idClass: typeof MsgKey;
+    constructor(proterties?: ModelPropertiesContructor<MsgButtonReplyMsgModel>, options?: ModelOptions);
+}
+export {};

package/dist/whatsapp/models/MsgInfoModel.d.ts

@@ -0,0 +1,52 @@
+/*!
+ * Copyright 2021 WPPConnect Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { MsgInfoCollection, MsgInfoParticipantCollection } from '../collections';
+import { MsgKey } from '../misc';
+import { Model, ModelOptions, ModelPropertiesContructor, ModelProxy } from './Model';
+interface Props {
+    id: MsgKey;
+    usePlayReceipt?: any;
+    playedRemaining: number;
+    readRemaining: number;
+    deliveryRemaining: number;
+    deliveryPrivacyMode?: any;
+}
+interface Session {
+    stale?: any;
+}
+interface Derived {
+    settled?: any;
+}
+/**
+ * @whatsapp 54311
+ * @whatsapp 754311 >= 2.2222.8
+ * @whatsapp 738482 >= 2.2242.6
+ */
+export declare interface MsgInfoModel extends ModelProxy<Props, Session, Derived> {
+}
+/**
+ * @whatsapp 54311
+ * @whatsapp 738482 >= 2.2222.8
+ */
+export declare class MsgInfoModel extends Model<MsgInfoCollection> {
+    idClass: typeof MsgKey;
+    played: MsgInfoParticipantCollection;
+    read: MsgInfoParticipantCollection;
+    delivery: MsgInfoParticipantCollection;
+    constructor(proterties?: ModelPropertiesContructor<MsgInfoModel>, options?: ModelOptions);
+    getCollection(): MsgInfoCollection;
+}
+export {};

package/dist/whatsapp/models/MsgInfoParticipantModel.d.ts

@@ -0,0 +1,41 @@
+/*!
+ * Copyright 2021 WPPConnect Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { MsgInfoCollection } from '../collections';
+import { Wid } from '../misc';
+import { ContactModel } from './ContactModel';
+import { Model, ModelOptions, ModelPropertiesContructor, ModelProxy } from './Model';
+interface Props {
+    id: Wid;
+    t: number;
+}
+interface Session {
+    contact: ContactModel;
+}
+interface Derived {
+}
+/**
+ * @whatsapp 738482 >= 2.2242.6
+ */
+export declare interface MsgInfoParticipantModel extends ModelProxy<Props, Session, Derived> {
+}
+/**
+ * @whatsapp 738482 >= 2.2242.6
+ */
+export declare class MsgInfoParticipantModel extends Model<MsgInfoCollection> {
+    constructor(proterties?: ModelPropertiesContructor<MsgInfoParticipantModel>, options?: ModelOptions);
+    getCollection(): MsgInfoCollection;
+}
+export {};

package/dist/whatsapp/models/MsgModel.d.ts

@@ -0,0 +1,392 @@
+/*!
+ * Copyright 2021 WPPConnect Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { TextFontStyle } from '../../enums';
+import { ButtonCollection, MsgCollection, TemplateButtonCollection } from '../collections';
+import { ACK } from '../enums';
+import { MediaObject, MsgKey, Wid } from '../misc';
+import { ChatModel, MediaDataModel } from '.';
+import { Model, ModelOptions, ModelPropertiesContructor, ModelProxy } from './Model';
+interface Props {
+    id: MsgKey;
+    rowId?: any;
+    serverId?: number;
+    body?: string;
+    type?: string;
+    subtype?: string | null;
+    t?: number;
+    notifyName?: any;
+    from?: Wid;
+    to?: Wid;
+    author?: Wid;
+    self?: string;
+    /**
+     * See {@link Constants}
+     */
+    ack?: ACK;
+    invis?: any;
+    isNewMsg: boolean;
+    star?: any;
+    recvFresh?: any;
+    caption?: string;
+    interactiveAnnotations?: any;
+    clientUrl?: any;
+    loc?: any;
+    lat?: number;
+    lng?: number;
+    isLive: boolean;
+    accuracy?: number;
+    speed?: number;
+    degrees?: number;
+    comment?: string;
+    sequence?: number;
+    shareDuration?: number;
+    finalLat?: any;
+    finalLng?: any;
+    finalAccuracy?: any;
+    finalThumbnail?: any;
+    finalSpeed?: any;
+    finalDegrees?: any;
+    finalTimeOffset?: any;
+    deprecatedMms3Url?: any;
+    directPath?: any;
+    mimetype?: any;
+    waveform?: any;
+    duration?: number;
+    filehash?: any;
+    encFilehash?: any;
+    size?: any;
+    filename?: any;
+    streamingSidecar?: any;
+    mediaKey?: any;
+    mediaKeyTimestamp?: any;
+    pageCount?: any;
+    isGif: boolean;
+    gifAttribution?: any;
+    isViewOnce: boolean;
+    streamable?: any;
+    width?: any;
+    height?: any;
+    thumbnailDirectPath?: any;
+    thumbnailSha256?: any;
+    thumbnailEncSha256?: any;
+    thumbnailHeight?: any;
+    thumbnailWidth?: any;
+    scanLengths?: any;
+    scansSidecar?: any;
+    isFromTemplate: boolean;
+    devicesAdded?: any;
+    devicesRemoved?: any;
+    isThisDeviceAdded: boolean;
+    firstFrameLength?: any;
+    firstFrameSidecar?: any;
+    isAnimated: boolean;
+    canonicalUrl: boolean;
+    matchedText?: any;
+    thumbnail?: any;
+    thumbnailHQ?: any;
+    richPreviewType?: any;
+    doNotPlayInline?: any;
+    title?: string;
+    description?: any;
+    businessOwnerJid?: any;
+    productId?: any;
+    currencyCode?: any;
+    priceAmount1000?: any;
+    salePriceAmount1000?: any;
+    retailerId?: any;
+    url?: any;
+    productImageCount?: any;
+    sessionId?: any;
+    recipients?: any;
+    broadcast?: any;
+    /** @deprecated */
+    quotedMsgId?: MsgKey;
+    quotedMsg?: MsgModel;
+    quotedStanzaID?: any;
+    quotedRemoteJid?: any;
+    quotedParticipant?: any;
+    quotedGroupSubject?: any;
+    quotedParentGroupJid?: any;
+    mentionedJidList?: Wid[];
+    footer?: string;
+    hydratedButtons?: Array<{
+        index?: number;
+        quickReplyButton?: {
+            displayText: string;
+            id: string;
+        };
+        urlButton?: {
+            displayText: string;
+            url: string;
+        };
+        callButton?: {
+            displayText: string;
+            phoneNumber: string;
+        };
+    }>;
+    buttons?: TemplateButtonCollection;
+    selectedId?: any;
+    selectedIndex?: any;
+    multicast?: any;
+    urlText?: string | null;
+    urlNumber?: string | null;
+    clearMedia?: any;
+    isVcardOverMmsDocument: boolean;
+    vcardList?: any;
+    vcardFormattedName?: any;
+    protocolMessageKey?: any;
+    templateParams?: any;
+    textColor?: number;
+    backgroundColor?: number;
+    font?: TextFontStyle;
+    isForwarded: boolean;
+    forwardingScore?: any;
+    labels?: any;
+    paymentCurrency?: any;
+    paymentAmount1000?: any;
+    paymentMessageReceiverJid?: any;
+    paymentTransactionTimestamp?: any;
+    paymentStatus?: any;
+    paymentTxnStatus?: any;
+    paymentNoteMsg?: any;
+    paymentRequestMessageKey?: any;
+    paymentExpiryTimestamp?: any;
+    ephemeralStartTimestamp?: any;
+    ephemeralDuration?: number;
+    ephemeralSettingTimestamp?: number;
+    ephemeralOutOfSync?: any;
+    ephemeralSharedSecret?: any;
+    disappearingModeInitiator?: any;
+    bizPrivacyStatus?: any;
+    privacyModeWhenSent?: any;
+    verifiedBizName?: any;
+    inviteCode?: any;
+    inviteCodeExp?: any;
+    inviteGrp?: any;
+    inviteGrpName?: any;
+    inviteGrpJpegThum?: any;
+    sellerJid?: any;
+    message?: any;
+    orderTitle?: any;
+    itemCount?: any;
+    orderId?: any;
+    surface?: any;
+    status?: any;
+    token?: any;
+    totalAmount1000?: any;
+    totalCurrencyCode?: any;
+    historySyncMetaData?: any;
+    mdDowngrade?: any;
+    isCaptionByUser: boolean;
+    isSendFailure: boolean;
+    appStateSyncKeyShare?: any;
+    appStateSyncKeyRequest?: any;
+    appStateFatalExceptionNotification?: any;
+    broadcastParticipants?: any;
+    broadcastEphSettings?: any;
+    broadcastId?: any;
+    ctwaContext?: any;
+    list?: {
+        buttonText: string;
+        description: string;
+        footerText?: string;
+        title?: string;
+        sections: Array<{
+            title: string;
+            rows: Array<{
+                title: string;
+                description: string;
+                rowId: string;
+            }>;
+        }>;
+        listType: number;
+    };
+    listResponse?: any;
+    productListItemCount?: any;
+    productHeaderImageRejected?: any;
+    isDynamicReplyButtonsMsg: boolean;
+    dynamicReplyButtons?: Array<{
+        buttonId: string;
+        buttonText: {
+            displayText: string;
+        };
+        type: number;
+    }>;
+    replyButtons?: ButtonCollection;
+    buttonsResponse?: any;
+    selectedButtonId?: string;
+    interactiveMessage?: any;
+    isMdHistoryMsg: boolean;
+}
+interface Session {
+    stale?: any;
+    sendDeferred?: any;
+    local?: true;
+    search?: any;
+    msgChunk?: any;
+    phoneUploading?: any;
+    startOfDay?: any;
+    startOfDaySkew?: any;
+    isQuotedMsgAvailable: boolean;
+    senderObj?: any;
+    mediaData?: MediaDataModel;
+    forwardedFromWeb?: any;
+    linksIndexParsed?: any;
+    quotedMsgKey?: MsgKey;
+}
+interface Derived {
+    /**
+     * @deprecated
+     */
+    chat?: ChatModel;
+    hasTemplateButtons: boolean;
+    ephemeralExpirationTimestamp?: any;
+    isEphemeral: boolean;
+    isQuickReply: boolean;
+    isFutureproof: boolean;
+    /**
+     * @deprecated
+     */
+    isGroupMsg: boolean;
+    isStatusV3: boolean;
+    isPSA: boolean;
+    isRTL: boolean;
+    asProductInquiry?: any;
+    statusV3TextBg?: any;
+    isSentByMe: boolean;
+    isSentByMeFromWeb: boolean;
+    isInternational: boolean;
+    isNotification: boolean;
+    asGroupNotification?: any;
+    asBroadcastNotification?: any;
+    isBizNotification: boolean;
+    asProduct?: any;
+    asAlbumAsset?: any;
+    asGroupedSticker?: any;
+    isMedia: boolean;
+    asDoc?: any;
+    asImage?: any;
+    asVideo?: any;
+    asMms?: any;
+    asPollCreation?: any;
+    asPollUpdate?: any;
+    asUrl?: any;
+    asRevoked?: any;
+    asViewOnce?: any;
+    asVisualMedia?: any;
+    numTimesForwarded?: any;
+    isFrequentlyForwarded: boolean;
+    eventType?: any;
+    sender?: Wid;
+    text?: any;
+    containsEmoji?: any;
+    isFailed: boolean;
+    vcard?: any;
+    isUnsentMedia: boolean;
+    dir?: any;
+    rtl?: any;
+    linkPreview?: {
+        title?: string;
+        description?: string;
+        canonicalUrl?: string;
+        matchedText: string;
+        richPreviewType: number;
+        thumbnail?: string;
+        doNotPlayInline: boolean;
+    };
+    isGroupsV4InviteExpired: boolean;
+    isPersistent: boolean;
+    isRevokedByMe: boolean;
+    isUnreadType: boolean;
+    isUserCreatedType: boolean;
+    supportsMessageFooter?: any;
+    supportsMessageFooterLinks?: any;
+    hasBodyOrFooter: boolean;
+    initialPageSize?: any;
+    productListHeaderImage?: any;
+    pollInvalidated?: boolean;
+    pollName?: string;
+    pollOptions?: any;
+    pollSelectableOptionsCount?: number;
+    pollUpdateParentKey?: any;
+    nativeFlowName?: string;
+    interactivePayload?: any;
+}
+/** @whatsapp 17304 */
+export declare interface MsgModel extends ModelProxy<Props, Session, Derived> {
+}
+/** @whatsapp 17304 */
+export declare class MsgModel extends Model {
+    idClass: typeof MsgKey;
+    constructor(proterties: ModelPropertiesContructor<MsgModel, 'id'>, options?: ModelOptions);
+    mediaObject?: MediaObject;
+    getLinks(e?: number): any;
+    getHeaderLinks(): any;
+    getFooterLinks(): any;
+    getGalleryLinks(): any;
+    getSuspiciousLinks(): any;
+    hasSymbol(): boolean;
+    mayFail(): any;
+    isUnsentPhoneMsg(): boolean;
+    canReply?(): boolean;
+    canPrivateReply(): boolean;
+    canPrivateReplyInRestrictedGrp(): boolean;
+    canForward(): boolean;
+    canQuickForward(): boolean;
+    canStar(): boolean;
+    interactiveButtonsReleased(): any;
+    isGroupLeave(): boolean;
+    isTrusted(): boolean;
+    getVcardWids(): any;
+    getLocObject(): any;
+    resumeRemoteUpload(): any;
+    forceRMR(): any;
+    isForcingRMR(): boolean;
+    cancelDownload(): boolean;
+    resumeUpload(): any;
+    cancelUpload(): boolean;
+    waitForPhoneUpload(): any;
+    downloadMedia(e?: any): any;
+    applyUpdate(e?: any): any;
+    waitForPrep(): any;
+    /**
+     * @deprecated
+     * @whatsapp < 2.2245.8
+     */
+    quotedMsgObj?(): any;
+    getQuotedMsgAdminGroupJid(): any;
+    msgContextInfo(chatId: Wid): any;
+    displayName(e?: any, t?: any): any;
+    isQuoted(e?: any): boolean;
+    isMentioned(e?: any): boolean;
+    mentionMap(): any;
+    updateAck(e?: any, t?: any): any;
+    avParams(): any;
+    resend(): any;
+    onCiphertextDecrypted(): any;
+    onViewOnceMediaStatusChanged(): any;
+    canRevoke(): boolean;
+    getWamMessageType(): any;
+    getWamMediaType(): any;
+    getForwardingScoreWhenForwarded(): any;
+    updateEphemeralStartTimestamp(e?: any): any;
+    isExpired(): boolean;
+    getCollection(): MsgCollection;
+    isDownloadable(): boolean;
+    safe(): any;
+    unsafe(): any;
+}
+export {};

package/dist/whatsapp/models/MuteModel.d.ts

@@ -0,0 +1,54 @@
+/*!
+ * Copyright 2021 WPPConnect Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { MuteCollection } from '../collections';
+import { Wid } from '../misc';
+import { Model, ModelOptions, ModelPropertiesContructor, ModelProxy } from './Model';
+interface Props {
+    id: Wid;
+    expiration: number;
+}
+interface Session {
+    stale?: any;
+    promises?: any;
+}
+interface Derived {
+    isMuted: boolean;
+}
+/** @whatsapp 40214
+ * @whatsapp 440214 >= 2.2222.8
+ */
+export declare interface MuteModel extends ModelProxy<Props, Session, Derived> {
+}
+/** @whatsapp 40214
+ * @whatsapp 440214 >= 2.2222.8
+ */
+export declare class MuteModel extends Model<MuteCollection> {
+    idClass: typeof Wid;
+    allowedIds?: any;
+    constructor(proterties?: ModelPropertiesContructor<MuteModel>, options?: ModelOptions);
+    setMute(expiration?: number, isAutoMuted?: boolean, sendDevice?: boolean): any;
+    mute(args: {
+        expiration: number;
+        sendDevice?: boolean;
+        isAutoMuted?: boolean;
+    }): Promise<number>;
+    canMute(): boolean;
+    unmute(args: {
+        sendDevice?: boolean;
+    }): Promise<void>;
+    getCollection(): MuteCollection;
+}
+export {};