SDK Resource Map

Every Convoso API endpoint is exposed through a typed resource on the client. This page maps each resource accessor to its methods, pagination support, and corresponding API reference docs.

Resource Overview

import { Convoso } from 'convoso-js';

const client = new Convoso({ authToken: '...' });

client.leads            // LeadsResource
client.lists            // ListsResource
client.dnc              // DncResource
client.callbacks        // CallbacksResource
client.callLogs         // CallLogsResource
client.campaigns        // CampaignsResource
client.agentMonitor     // AgentMonitorResource
client.agentPerformance // AgentPerformanceResource
client.agentProductivity // AgentProductivityResource
client.status           // StatusResource
client.revenue          // RevenueResource
client.users            // UsersResource
client.userActivity     // UserActivityResource
client.leadPost         // LeadPostResource
client.leadValidation   // LeadValidationResource
client.smsOptOut        // SmsOptOutResource

Full Method Reference

Accessor	Method	API Endpoint	Paginated	API Docs
client.leads	search()	POST /leads/search		Leads
client.leads	searchAll()	POST /leads/search	Yes	Leads
client.leads	insert()	POST /leads/insert		Leads
client.leads	update()	POST /leads/update		Leads
client.leads	delete()	POST /leads/delete		Leads
client.leads	getRecordings()	POST /leads/get-recordings		Leads
client.leads	getRecordingsAll()	POST /leads/get-recordings	Yes	Leads
client.lists	search()	POST /lists/search		Lists
client.lists	insert()	POST /lists/insert		Lists
client.lists	update()	POST /lists/update		Lists
client.lists	delete()	POST /lists/delete		Lists
client.dnc	search()	POST /dnc/search		DNC
client.dnc	searchAll()	POST /dnc/search	Yes	DNC
client.dnc	insert()	POST /dnc/insert		DNC
client.dnc	update()	POST /dnc/update		DNC
client.dnc	delete()	POST /dnc/delete		DNC
client.callbacks	search()	POST /callbacks/search		Callbacks
client.callbacks	searchAll()	POST /callbacks/search	Yes	Callbacks
client.callbacks	insert()	POST /callbacks/insert		Callbacks
client.callbacks	update()	POST /callbacks/update		Callbacks
client.callbacks	delete()	POST /callbacks/delete		Callbacks
client.callLogs	retrieve()	POST /log/retrieve		Call Logs
client.callLogs	retrieveAll()	POST /log/retrieve	Yes	Call Logs
client.callLogs	update()	POST /log/update		Call Logs
client.campaigns	search()	POST /campaigns/search		Campaigns
client.campaigns	status()	POST /campaigns/status		Campaigns
client.agentMonitor	search()	POST /agent-monitor/search		Agent Monitor
client.agentMonitor	logout()	POST /agent-monitor/logout		Agent Monitor
client.agentPerformance	search()	POST /agent-performance/search		Agent Performance
client.agentProductivity	search()	POST /agent-productivity/search		Agent Productivity
client.status	search()	POST /status/search		Status
client.status	insert()	POST /status/insert		Status
client.status	update()	POST /status/update		Status
client.revenue	update()	POST /revenue/update		Revenue
client.users	search()	POST /users/search		Users
client.users	recordings()	POST /users/recordings		Users
client.userActivity	search()	POST /user-activity/search		User Activity
client.leadPost	insert()	POST /lead-post-validation/insert		Lead Post
client.leadValidation	search()	POST /lead-validation/search		Lead Validation
client.smsOptOut	search()	POST /sms-opt-out/search		SMS Opt-Out
client.smsOptOut	searchAll()	POST /sms-opt-out/search	Yes	SMS Opt-Out
client.smsOptOut	insert()	POST /sms-opt-out/insert		SMS Opt-Out
client.smsOptOut	update()	POST /sms-opt-out/update		SMS Opt-Out

Paginated Resources Summary

These resources support auto-pagination via *All() async generator methods:

Resource	Paginated Method	Default Page Size
client.leads	searchAll()	100
client.leads	getRecordingsAll()	100
client.callbacks	searchAll()	100
client.callLogs	retrieveAll()	100
client.dnc	searchAll()	100
client.smsOptOut	searchAll()	100

See Auto-Pagination for usage details.