waha.js
Version:
TypeScript SDK for WAHA (WhatsApp HTTP API)
74 lines (73 loc) • 2.05 kB
TypeScript
import { WahaBaseClient } from '../client';
import { MeInfo, SessionCreateRequest, SessionDTO, SessionInfo, SessionUpdateRequest } from '../types';
/**
* Sessions module for WAHA API
*/
export declare class SessionsModule {
private client;
/**
* Create a new Sessions module
* @param client Base client
*/
constructor(client: WahaBaseClient);
/**
* List all sessions
* @param all Include stopped sessions
* @returns List of sessions
*/
list(all?: boolean): Promise<SessionInfo[]>;
/**
* Create a new session
* @param data Session creation data
* @returns Created session
*/
create(data: SessionCreateRequest): Promise<SessionDTO>;
/**
* Get session information
* @param session Session name
* @returns Session information
*/
get(session: string): Promise<SessionInfo>;
/**
* Update a session
* @param session Session name
* @param data Update data
* @returns Updated session
*/
update(session: string, data: SessionUpdateRequest): Promise<SessionDTO>;
/**
* Delete a session
* @param session Session name
*/
delete(session: string): Promise<void>;
/**
* Get information about the authenticated account
* @param session Session name
* @returns Account information
*/
getMe(session?: string): Promise<MeInfo>;
/**
* Start a session
* @param session Session name
* @returns Started session
*/
start(session?: string): Promise<SessionDTO>;
/**
* Stop a session
* @param session Session name
* @returns Stopped session
*/
stop(session?: string): Promise<SessionDTO>;
/**
* Logout from a session
* @param session Session name
* @returns Session after logout
*/
logout(session?: string): Promise<SessionDTO>;
/**
* Restart a session
* @param session Session name
* @returns Restarted session
*/
restart(session?: string): Promise<SessionDTO>;
}