InstantlyApiClient class

A client that calls endpoints in the Instantly API.

Constructors

InstantlyApiClient.new({required String apiKey})

Creates a new InstantlyApiClient to call the Instantly API.

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

addLeadsToCampaign({required String campaignId, List<Lead> leads = const []}) → Future<void>

Gets the leads for a campaign in the Instantly API.

addSendingAccount({required String campaignId, required String email}) → Future<void>

Adds an account to the list of accounts sending emails for a campaign in the Instantly API.

addToBlocklist({required String campaignId, required String emailOrDomain}) → Future<void>

Adds an email or domain to the blocklist for a campaign in the Instantly

checkAccountVitals({List<String> accounts = const []}) → Future<AccountVitals>

Gets the vitals for an account in the Instantly API.

countUnreadEmails() → Future<int?>

Counts the unread emails in the Instantly API.

deleteAccount({required String email}) → Future<void>

Deletes an account from the Instantly API.

deleteLeadsFromCampaign({required String campaignId, List<String> emails = const []}) → Future<void>

Gets the leads for a campaign in the Instantly API.

enableWarmup({required String email}) → Future<void>

Enables the warmup process for an account in the Instantly API.

getAccountStatus({required String email}) → Future<AccountStatus?>

Gets the status of an account in the Instantly API.

getCampaignAccounts({required String campaignId}) → Future<Campaign>

Gets the accounts that are sending emails for a campaign in the Instantly API.

getCampaignCounts({String? campaignId, String? startDate, String? endDate}) → Future<List<CampaignCount>>

Gets the counts for a campaign in the Instantly API.

getCampaignName({required String campaignId}) → Future<Campaign?>

Creates a new campaign in the Instantly API.

getCampaignStatus({required String campaignId}) → Future<Campaign?>

Gets the status of a campaign in the Instantly API.

getCampaignSummary({required String campaignId}) → Future<CampaignSummary?>

Gets the summary of a campaign in the Instantly API.

getOrSearchLead({required String email, String? campaignId}) → Future<Lead?>

Gets the leads for a campaign in the Instantly API.

launchCampaign({required String campaignId}) → Future<void>

Launches a campaign in the Instantly API.

listAccounts({int? limit, int? skip}) → Future<List<Account>>

Lists all accounts in the Instantly API.

listCampaigns({String? skip, String? limit}) → Future<List<Campaign>>

Lists all campaigns in the Instantly API.

listEmails() → Future<List<Email>>

Lists all emails in the Instantly API.

markAccountAsFixed({String? email}) → Future<void>

Marks an account as fixed in the Instantly API.

markThreadAsRead({required String threadId}) → Future<void>

Marks an email as read in the Instantly API.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

pauseCampaign({required String campaignId}) → Future<void>

Pauses a campaign in the Instantly API.

pauseWarmup({required String email}) → Future<void>

Disables the warmup status of an account in the Instantly API.

removeFromBlocklist({required String campaignId, required String emailOrDomain}) → Future<void>

Removes an email or domain from the blocklist for a campaign in the Instantly API.

removeSendingAccount({required String campaignId, required String email}) → Future<void>

Removes an account from the list of accounts sending emails for a campaign in the Instantly API.

setCampaignAccounts({required String campaignId, required List<String> accounts}) → Future<void>

Sets the accounts that are sending emails for a campaign in the Instantly API.

setCampaignName({required String campaignId, required String newName}) → Future<void>

Sets the name of a campaign in the Instantly API.

setCampaignSchedule({required String campaignId, required Schedule schedule}) → Future<void>

Gets the schedules for a campaign in the Instantly API.

toString() → String

A string representation of this object.

inherited

updateLeadStatus({required String campaignId, required String email, required String newStatus}) → Future<void>

Gets the leads for a campaign in the Instantly API.

updateLeadVariables({required String campaignId, required String email, required Map<String, dynamic> variables}) → Future<void>

Updates the variables for a lead in the Instantly API.

Operators

operator ==(Object other) → bool

The equality operator.

inherited