@davidbolaji/termii-node
Version:
Node.js SDK for Termii API – send SMS, voice, OTP, and manage messaging with ease.
50 lines • 4.95 kB
TypeScript
import { TokenService } from './endpoints';
import { InsightService } from './services/insights/InsightService';
import { CampaignService } from './services/messaging/campaign/CampaignService';
import { MessageService } from './services/messaging/MessageService';
import { SenderIdService } from './services/messaging/SenderIdService';
import { TemplatesService } from './services/messaging/TemplateService';
import { SotelService } from './services/sotel/SotelService';
export declare class Termii {
[key: string]: any;
private http;
readonly message: MessageService;
readonly sender: SenderIdService;
readonly template: TemplatesService;
readonly campaign: CampaignService;
readonly insight: InsightService;
readonly sotel: SotelService;
readonly token: TokenService;
constructor(apiKey: string, baseUrl?: string);
sendMessage(payload: Parameters<MessageService['sendMessage']>[0]): ReturnType<MessageService['sendMessage']>;
sendBulkMessage(payload: Parameters<MessageService['sendBulkMessage']>[0]): ReturnType<MessageService['sendBulkMessage']>;
sendTemplate(payload: Parameters<TemplatesService['sendTemplate']>[0]): ReturnType<TemplatesService['sendTemplate']>;
sendCampaign(payload: Parameters<CampaignService['campaign']['sendCampaign']>[0]): ReturnType<CampaignService['campaign']['sendCampaign']>;
fetchCampaigns(): ReturnType<CampaignService['campaign']['fetchCampaigns']>;
fetchCampaignHistory(campaignId: Parameters<CampaignService['campaign']['fetchCampaignHistory']>[0]): ReturnType<CampaignService['campaign']['fetchCampaignHistory']>;
retryCampaign(campaignId: Parameters<CampaignService['campaign']['retryCampaign']>[0]): ReturnType<CampaignService['campaign']['retryCampaign']>;
fetchContacts(phonebookId: Parameters<CampaignService['contact']['fetchContacts']>[0]): ReturnType<CampaignService['contact']['fetchContacts']>;
addContact(phonebookId: Parameters<CampaignService['contact']['addContact']>[0], contact: Parameters<CampaignService['contact']['addContact']>[1]): ReturnType<CampaignService['contact']['addContact']>;
uploadContacts(request: Parameters<CampaignService['contact']['uploadContacts']>[0]): ReturnType<CampaignService['contact']['uploadContacts']>;
deleteContact(contactId: Parameters<CampaignService['contact']['deleteContact']>[0]): ReturnType<CampaignService['contact']['deleteContact']>;
fetchPhonebooks(): ReturnType<CampaignService['phonebook']['fetchPhonebooks']>;
createPhonebook(payload: Parameters<CampaignService['phonebook']['createPhonebook']>[0]): ReturnType<CampaignService['phonebook']['createPhonebook']>;
updatePhonebook(phonebookId: Parameters<CampaignService['phonebook']['updatePhonebook']>[0], payload: Parameters<CampaignService['phonebook']['updatePhonebook']>[1]): ReturnType<CampaignService['phonebook']['updatePhonebook']>;
deletePhonebook(phonebookId: Parameters<CampaignService['phonebook']['deletePhonebook']>[0]): ReturnType<CampaignService['phonebook']['deletePhonebook']>;
fetchSenderIds(page: Parameters<SenderIdService['fetchSenderIds']>[0]): ReturnType<SenderIdService['fetchSenderIds']>;
requestSenderId(payload: Parameters<SenderIdService['requestSenderId']>[0]): ReturnType<SenderIdService['requestSenderId']>;
sendToken(payload: Parameters<TokenService['sendToken']>[0]): ReturnType<TokenService['sendToken']>;
sendVoiceToken(payload: Parameters<TokenService['sendVoiceToken']>[0]): ReturnType<TokenService['sendVoiceToken']>;
sendVoiceCall(payload: Parameters<TokenService['sendVoiceCall']>[0]): ReturnType<TokenService['sendVoiceCall']>;
sendEmailToken(payload: Parameters<TokenService["email"]["sendEmailToken"]>[0]): ReturnType<TokenService["email"]['sendEmailToken']>;
generateToken(payload: Parameters<TokenService["inApp"]["generate"]>[0]): ReturnType<TokenService["inApp"]["generate"]>;
verifyToken(payload: Parameters<TokenService["verify"]["verifyToken"]>[0]): ReturnType<TokenService["verify"]["verifyToken"]>;
getBalance(): ReturnType<InsightService['balance']['getBalance']>;
authenticateEsim(payload: Parameters<SotelService['esim']['authenticate']>[0]): ReturnType<SotelService['esim']['authenticate']>;
fetchEsimPlans(payload: Parameters<SotelService['esim']['fetchPlans']>[0]): ReturnType<SotelService['esim']['fetchPlans']>;
createEsim(payload: Parameters<SotelService['esim']['createEsim']>[0]): ReturnType<SotelService['esim']['createEsim']>;
getEsimQrCode(iccid: Parameters<SotelService['esim']['getQrCode']>[0]): ReturnType<SotelService['esim']['getQrCode']>;
getEsimUsage(iccid: Parameters<SotelService['esim']['getUsage']>[0]): ReturnType<SotelService['esim']['getUsage']>;
fetchEsims(page?: Parameters<SotelService['esim']['fetchEsims']>[0], size?: Parameters<SotelService['esim']['fetchEsims']>[1]): ReturnType<SotelService['esim']['fetchEsims']>;
}
//# sourceMappingURL=Termii.d.ts.map