@termii/node
Version:
Nodejs SDK wrapper for Termii API written with Typescript support
21 lines (20 loc) • 918 B
TypeScript
import { TermiiCore } from '../../../api';
import { ISenderIDResponse, IRequestSenderID, IRequestSenderIDResponse } from '../../../interfaces';
/**
* A class handling Sender ID functionalities, extends TermiiCore.
*/
export declare class SenderId extends TermiiCore {
constructor(apiKey: string);
/**
* Fetches sender IDs.
* @param {number} [page] - Optional page number for pagination.
* @returns {Promise<ISenderIDResponse>} - A promise containing the response with sender IDs.
*/
fetchSenderIDs(page?: number): Promise<ISenderIDResponse>;
/**
* Requests a new Sender ID.
* @param {IRequestSenderID} data - Data for requesting a new Sender ID.
* @returns {Promise<IRequestSenderIDResponse>} - A promise containing the response to the Sender ID request.
*/
requestSenderID(data: IRequestSenderID): Promise<IRequestSenderIDResponse>;
}