botcast-sdk 1.0.0

package/dist/modules/instances.cjs

@@ -0,0 +1,138 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InstancesModule = void 0;
+const base_js_1 = require("./base.js");
+class InstancesModule extends base_js_1.BaseModule {
+    /**
+     * Retrieves the current live status of the WhatsApp instance.
+     */
+    async getStatus() {
+        return this.request({
+            method: 'GET',
+            path: this.buildPath('status'),
+        });
+    }
+    /**
+     * Fetches or generates a QR code string for device pairing.
+     */
+    async getQR() {
+        return this.request({
+            method: 'GET',
+            path: this.buildPath('qr'),
+        });
+    }
+    /**
+     * Generates an 8-digit phone pairing code for headless WhatsApp linking without scanning QR.
+     *
+     * @param phoneNumber Recipient phone number with country code (e.g. `201000000000` or `15551234567`)
+     */
+    async pairWithCode(phoneNumber) {
+        return this.request({
+            method: 'POST',
+            path: this.buildPath('pair-code'),
+            body: { phoneNumber },
+        });
+    }
+    /**
+     * Boots up the WhatsApp socket connection.
+     *
+     * @param force Force restart if already running
+     */
+    async start(force = false) {
+        return this.request({
+            method: 'POST',
+            path: this.buildPath('start'),
+            body: { force },
+        });
+    }
+    /**
+     * Stops the active WhatsApp socket session.
+     */
+    async stop() {
+        return this.request({
+            method: 'POST',
+            path: this.buildPath('stop'),
+        });
+    }
+    /**
+     * Logs out from WhatsApp and clears session keys.
+     */
+    async logout() {
+        return this.request({
+            method: 'POST',
+            path: this.buildPath('logout'),
+        });
+    }
+    /**
+     * Gets the list of allowed sandbox recipient phone numbers (for Dev instances).
+     */
+    async getAllowedNumbers() {
+        return this.request({
+            method: 'GET',
+            path: this.buildPath('allowed-numbers'),
+        });
+    }
+    /**
+     * Sets allowed sandbox phone numbers for a Dev instance.
+     *
+     * @param allowedNumbers Array of up to 3 phone numbers
+     */
+    async setAllowedNumbers(allowedNumbers) {
+        return this.request({
+            method: 'POST',
+            path: this.buildPath('allowed-numbers'),
+            body: { allowed_numbers: allowedNumbers },
+        });
+    }
+    /**
+     * Verifies if a phone number exists on WhatsApp and gets their JID / avatar.
+     *
+     * @param phoneNumber The phone number to check (with country code)
+     */
+    async checkNumber(phoneNumber) {
+        return this.request({
+            method: 'POST',
+            path: this.buildPath('check-number'),
+            body: { phone: phoneNumber },
+        });
+    }
+    /**
+     * Sets presence status (typing, recording audio, online/offline).
+     */
+    async setPresence(options) {
+        return this.request({
+            method: 'POST',
+            path: this.buildPath('presence'),
+            body: options,
+        });
+    }
+    /**
+     * Gets the instance's daily rate limits configuration.
+     */
+    async getLimits() {
+        return this.request({
+            method: 'GET',
+            path: this.buildPath('limits'),
+        });
+    }
+    /**
+     * Updates safety daily message limits and new contact limits.
+     */
+    async updateLimits(limits) {
+        return this.request({
+            method: 'POST',
+            path: this.buildPath('limits'),
+            body: limits,
+        });
+    }
+    /**
+     * Triggers contact & message sync from WhatsApp.
+     */
+    async sync() {
+        return this.request({
+            method: 'POST',
+            path: this.buildPath('sync'),
+        });
+    }
+}
+exports.InstancesModule = InstancesModule;

package/dist/modules/instances.d.ts

@@ -0,0 +1,91 @@
+import { BaseModule } from './base.js';
+import { InstanceStatusResponse, InstanceQRResponse, PairCodeResponse, AllowedNumbersResponse, SetAllowedNumbersResponse, CheckNumberResponse, PresenceOptions, InstanceLimitsResponse, UpdateLimitsPayload } from '../types/index.js';
+export declare class InstancesModule extends BaseModule {
+    /**
+     * Retrieves the current live status of the WhatsApp instance.
+     */
+    getStatus(): Promise<InstanceStatusResponse>;
+    /**
+     * Fetches or generates a QR code string for device pairing.
+     */
+    getQR(): Promise<InstanceQRResponse>;
+    /**
+     * Generates an 8-digit phone pairing code for headless WhatsApp linking without scanning QR.
+     *
+     * @param phoneNumber Recipient phone number with country code (e.g. `201000000000` or `15551234567`)
+     */
+    pairWithCode(phoneNumber: string): Promise<PairCodeResponse>;
+    /**
+     * Boots up the WhatsApp socket connection.
+     *
+     * @param force Force restart if already running
+     */
+    start(force?: boolean): Promise<{
+        success: boolean;
+        instanceId: string;
+        status: string;
+        message: string;
+    }>;
+    /**
+     * Stops the active WhatsApp socket session.
+     */
+    stop(): Promise<{
+        success: boolean;
+        instanceId: string;
+        status: string;
+        message: string;
+    }>;
+    /**
+     * Logs out from WhatsApp and clears session keys.
+     */
+    logout(): Promise<{
+        success: boolean;
+        instanceId: string;
+        status: string;
+        message: string;
+    }>;
+    /**
+     * Gets the list of allowed sandbox recipient phone numbers (for Dev instances).
+     */
+    getAllowedNumbers(): Promise<AllowedNumbersResponse>;
+    /**
+     * Sets allowed sandbox phone numbers for a Dev instance.
+     *
+     * @param allowedNumbers Array of up to 3 phone numbers
+     */
+    setAllowedNumbers(allowedNumbers: string[]): Promise<SetAllowedNumbersResponse>;
+    /**
+     * Verifies if a phone number exists on WhatsApp and gets their JID / avatar.
+     *
+     * @param phoneNumber The phone number to check (with country code)
+     */
+    checkNumber(phoneNumber: string): Promise<CheckNumberResponse>;
+    /**
+     * Sets presence status (typing, recording audio, online/offline).
+     */
+    setPresence(options: PresenceOptions): Promise<{
+        success: boolean;
+        message: string;
+    }>;
+    /**
+     * Gets the instance's daily rate limits configuration.
+     */
+    getLimits(): Promise<InstanceLimitsResponse>;
+    /**
+     * Updates safety daily message limits and new contact limits.
+     */
+    updateLimits(limits: UpdateLimitsPayload): Promise<{
+        success: boolean;
+        message: string;
+        limits: any;
+    }>;
+    /**
+     * Triggers contact & message sync from WhatsApp.
+     */
+    sync(): Promise<{
+        success: boolean;
+        message: string;
+        contactsCount?: number;
+    }>;
+}
+//# sourceMappingURL=instances.d.ts.map

package/dist/modules/instances.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"instances.d.ts","sourceRoot":"","sources":["../../../src/modules/instances.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AACvC,OAAO,EACL,sBAAsB,EACtB,kBAAkB,EAClB,gBAAgB,EAChB,sBAAsB,EACtB,yBAAyB,EACzB,mBAAmB,EACnB,eAAe,EACf,sBAAsB,EACtB,mBAAmB,EACpB,MAAM,mBAAmB,CAAC;AAE3B,qBAAa,eAAgB,SAAQ,UAAU;IAC7C;;OAEG;IACU,SAAS,IAAI,OAAO,CAAC,sBAAsB,CAAC,CAKxD;IAED;;OAEG;IACU,KAAK,IAAI,OAAO,CAAC,kBAAkB,CAAC,CAKhD;IAED;;;;OAIG;IACU,YAAY,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAMxE;IAED;;;;OAIG;IACU,KAAK,CAAC,KAAK,GAAE,OAAe,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,UAAU,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC,CAM7H;IAED;;OAEG;IACU,IAAI,IAAI,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,UAAU,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC,CAKtG;IAED;;OAEG;IACU,MAAM,IAAI,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,UAAU,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC,CAKxG;IAED;;OAEG;IACU,iBAAiB,IAAI,OAAO,CAAC,sBAAsB,CAAC,CAKhE;IAED;;;;OAIG;IACU,iBAAiB,CAAC,cAAc,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,yBAAyB,CAAC,CAM3F;IAED;;;;OAIG;IACU,WAAW,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAM1E;IAED;;OAEG;IACU,WAAW,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC,CAMjG;IAED;;OAEG;IACU,SAAS,IAAI,OAAO,CAAC,sBAAsB,CAAC,CAKxD;IAED;;OAEG;IACU,YAAY,CAAC,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,OAAO,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,GAAG,CAAA;KAAE,CAAC,CAMlH;IAED;;OAEG;IACU,IAAI,IAAI,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,OAAO,EAAE,MAAM,CAAC;QAAC,aAAa,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAK1F;CACF"}

package/dist/modules/instances.js

@@ -0,0 +1,134 @@
+import { BaseModule } from './base.js';
+export class InstancesModule extends BaseModule {
+    /**
+     * Retrieves the current live status of the WhatsApp instance.
+     */
+    async getStatus() {
+        return this.request({
+            method: 'GET',
+            path: this.buildPath('status'),
+        });
+    }
+    /**
+     * Fetches or generates a QR code string for device pairing.
+     */
+    async getQR() {
+        return this.request({
+            method: 'GET',
+            path: this.buildPath('qr'),
+        });
+    }
+    /**
+     * Generates an 8-digit phone pairing code for headless WhatsApp linking without scanning QR.
+     *
+     * @param phoneNumber Recipient phone number with country code (e.g. `201000000000` or `15551234567`)
+     */
+    async pairWithCode(phoneNumber) {
+        return this.request({
+            method: 'POST',
+            path: this.buildPath('pair-code'),
+            body: { phoneNumber },
+        });
+    }
+    /**
+     * Boots up the WhatsApp socket connection.
+     *
+     * @param force Force restart if already running
+     */
+    async start(force = false) {
+        return this.request({
+            method: 'POST',
+            path: this.buildPath('start'),
+            body: { force },
+        });
+    }
+    /**
+     * Stops the active WhatsApp socket session.
+     */
+    async stop() {
+        return this.request({
+            method: 'POST',
+            path: this.buildPath('stop'),
+        });
+    }
+    /**
+     * Logs out from WhatsApp and clears session keys.
+     */
+    async logout() {
+        return this.request({
+            method: 'POST',
+            path: this.buildPath('logout'),
+        });
+    }
+    /**
+     * Gets the list of allowed sandbox recipient phone numbers (for Dev instances).
+     */
+    async getAllowedNumbers() {
+        return this.request({
+            method: 'GET',
+            path: this.buildPath('allowed-numbers'),
+        });
+    }
+    /**
+     * Sets allowed sandbox phone numbers for a Dev instance.
+     *
+     * @param allowedNumbers Array of up to 3 phone numbers
+     */
+    async setAllowedNumbers(allowedNumbers) {
+        return this.request({
+            method: 'POST',
+            path: this.buildPath('allowed-numbers'),
+            body: { allowed_numbers: allowedNumbers },
+        });
+    }
+    /**
+     * Verifies if a phone number exists on WhatsApp and gets their JID / avatar.
+     *
+     * @param phoneNumber The phone number to check (with country code)
+     */
+    async checkNumber(phoneNumber) {
+        return this.request({
+            method: 'POST',
+            path: this.buildPath('check-number'),
+            body: { phone: phoneNumber },
+        });
+    }
+    /**
+     * Sets presence status (typing, recording audio, online/offline).
+     */
+    async setPresence(options) {
+        return this.request({
+            method: 'POST',
+            path: this.buildPath('presence'),
+            body: options,
+        });
+    }
+    /**
+     * Gets the instance's daily rate limits configuration.
+     */
+    async getLimits() {
+        return this.request({
+            method: 'GET',
+            path: this.buildPath('limits'),
+        });
+    }
+    /**
+     * Updates safety daily message limits and new contact limits.
+     */
+    async updateLimits(limits) {
+        return this.request({
+            method: 'POST',
+            path: this.buildPath('limits'),
+            body: limits,
+        });
+    }
+    /**
+     * Triggers contact & message sync from WhatsApp.
+     */
+    async sync() {
+        return this.request({
+            method: 'POST',
+            path: this.buildPath('sync'),
+        });
+    }
+}

package/dist/modules/messages.cjs

@@ -0,0 +1,217 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MessagesModule = void 0;
+const base_js_1 = require("./base.js");
+class MessagesModule extends base_js_1.BaseModule {
+    /**
+     * Sends a raw message payload to the Botcast gateway.
+     */
+    async send(payload) {
+        return this.request({
+            method: 'POST',
+            path: this.buildPath('send'),
+            body: payload,
+        });
+    }
+    /**
+     * Sends a plain text message.
+     *
+     * @param recipient Target phone number or JID
+     * @param text The message text
+     * @param options Additional options (mentions, quoted message, etc.)
+     */
+    async sendText(recipient, text, options) {
+        return this.send({
+            recipient,
+            type: 'text',
+            text,
+            ...options,
+        });
+    }
+    /**
+     * Sends an automated OTP verification code.
+     *
+     * @param recipient Target phone number
+     * @param options OTP configuration (code, app name, expiry minutes)
+     */
+    async sendOTP(recipient, options) {
+        return this.request({
+            method: 'POST',
+            path: this.buildPath('otp'),
+            body: {
+                recipient,
+                ...options,
+            },
+        });
+    }
+    /**
+     * Sends an image from a URL or Base64 string.
+     */
+    async sendImage(recipient, imageSource, options) {
+        return this.send({
+            recipient,
+            type: 'image',
+            ...imageSource,
+            ...options,
+        });
+    }
+    /**
+     * Sends a video from a URL or Base64 string.
+     */
+    async sendVideo(recipient, videoSource, options) {
+        return this.send({
+            recipient,
+            type: 'video',
+            ...videoSource,
+            ...options,
+        });
+    }
+    /**
+     * Sends an audio file from a URL or Base64 string.
+     */
+    async sendAudio(recipient, audioSource, options) {
+        return this.send({
+            recipient,
+            type: 'audio',
+            ...audioSource,
+            ...options,
+        });
+    }
+    /**
+     * Sends a voice note (push-to-talk waveform audio).
+     */
+    async sendVoice(recipient, audioSource, options) {
+        return this.send({
+            recipient,
+            type: 'voice',
+            ptt: true,
+            ...audioSource,
+            ...options,
+        });
+    }
+    /**
+     * Sends a document / PDF / file from a URL or Base64 string.
+     */
+    async sendDocument(recipient, docSource, options) {
+        return this.send({
+            recipient,
+            type: 'document',
+            ...docSource,
+            ...options,
+        });
+    }
+    /**
+     * Sends an animated or static sticker.
+     */
+    async sendSticker(recipient, stickerSource, options) {
+        return this.send({
+            recipient,
+            type: 'sticker',
+            ...stickerSource,
+            ...options,
+        });
+    }
+    /**
+     * Sends GPS location coordinates.
+     */
+    async sendLocation(recipient, location, options) {
+        return this.send({
+            recipient,
+            type: 'location',
+            ...location,
+            ...options,
+        });
+    }
+    /**
+     * Sends a contact vCard card.
+     */
+    async sendContact(recipient, contact, options) {
+        return this.request({
+            method: 'POST',
+            path: this.buildPath('messages/contact'),
+            body: {
+                recipient,
+                ...contact,
+                ...options,
+            },
+        });
+    }
+    /**
+     * Sends an interactive single/multiple choice poll.
+     */
+    async sendPoll(recipient, poll, options) {
+        return this.send({
+            recipient,
+            type: 'poll',
+            poll,
+            ...options,
+        });
+    }
+    /**
+     * Forwards an existing message to another chat.
+     */
+    async forward(recipient, message) {
+        return this.request({
+            method: 'POST',
+            path: this.buildPath('messages/forward'),
+            body: { recipient, message },
+        });
+    }
+    /**
+     * Edits the text content of a previously sent message.
+     */
+    async edit(recipient, key, newText) {
+        return this.request({
+            method: 'POST',
+            path: this.buildPath('messages/edit'),
+            body: { recipient, key, text: newText },
+        });
+    }
+    /**
+     * Deletes a message for everyone in the chat.
+     */
+    async delete(recipient, key) {
+        return this.request({
+            method: 'POST',
+            path: this.buildPath('messages/delete'),
+            body: { recipient, key },
+        });
+    }
+    /**
+     * Marks one or more messages as read (sends blue double tick).
+     */
+    async markAsRead(keys) {
+        const keyList = Array.isArray(keys) ? keys : [keys];
+        return this.request({
+            method: 'POST',
+            path: this.buildPath('messages/read'),
+            body: { keys: keyList },
+        });
+    }
+    /**
+     * Sends an emoji reaction to a message (pass empty string `""` to remove reaction).
+     */
+    async react(recipient, key, emoji) {
+        return this.request({
+            method: 'POST',
+            path: this.buildPath('messages/reaction'),
+            body: { recipient, key, emoji },
+        });
+    }
+    /**
+     * Pins a message in a conversation.
+     *
+     * @param recipient Target chat
+     * @param key Message key
+     * @param type 1 to pin, 0 to unpin (default: 1)
+     * @param duration Duration in seconds (e.g. 86400 for 24h, 604800 for 7d, 2592000 for 30d)
+     */
+    async pin(recipient, key, type = 1, duration = 86400) {
+        return this.request({
+            method: 'POST',
+            path: this.buildPath('messages/pin'),
+            body: { recipient, key, type, time: duration },
+        });
+    }
+}
+exports.MessagesModule = MessagesModule;