/// <summary>
/// Delete all blocks.
/// </summary>
/// <param name="onBehalfOf">The user to impersonate.</param>
/// <param name="cancellationToken">Cancellation token.</param>
/// <returns>
/// The async task.
/// </returns>
public Task DeleteAllAsync(string onBehalfOf = null, CancellationToken cancellationToken = default)
{
var data = new StrongGridJsonObject();
data.AddProperty("delete_all", true);
return(_client
.DeleteAsync(_endpoint)
.OnBehalfOf(onBehalfOf)
.WithJsonBody(data)
.WithCancellationToken(cancellationToken)
.AsMessage());
}
/// <summary>
/// Delete all blocks.
/// </summary>
/// <param name="cancellationToken">Cancellation token</param>
/// <returns>
/// The async task.
/// </returns>
public Task DeleteAllAsync(CancellationToken cancellationToken = default(CancellationToken))
{
var data = new JObject
{
{ "delete_all", true }
};
return(_client
.DeleteAsync(_endpoint)
.WithJsonBody(data)
.WithCancellationToken(cancellationToken)
.AsMessage());
}
/// <summary>
/// Delete all invalid emails.
/// </summary>
/// <param name="onBehalfOf">The user to impersonate.</param>
/// <param name="cancellationToken">Cancellation token.</param>
/// <returns>
/// The async task.
/// </returns>
public Task DeleteAllAsync(string onBehalfOf = null, CancellationToken cancellationToken = default)
{
var data = new JObject
{
{ "delete_all", true }
};
return(_client
.DeleteAsync(_endpoint)
.OnBehalfOf(onBehalfOf)
.WithJsonBody(data)
.WithCancellationToken(cancellationToken)
.AsMessage());
}
/// <summary>
/// Delete the cancellation/pause of a scheduled send.
/// </summary>
/// <param name="batchId">The batch identifier.</param>
/// <param name="cancellationToken">Cancellation token.</param>
/// <returns>
/// The async task.
/// </returns>
public Task Resume(string batchId, CancellationToken cancellationToken = default)
{
return(_client
.DeleteAsync($"{_endpoint}/{batchId}")
.WithCancellationToken(cancellationToken)
.AsMessage());
}
/// <summary>
/// Delete a recipient email from the global suppressions group.
/// </summary>
/// <param name="email">email address to be removed from the global suppressions group</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>
/// The async task.
/// </returns>
public Task RemoveAsync(string email, CancellationToken cancellationToken = default(CancellationToken))
{
return(_client
.DeleteAsync($"{_endpoint}/{email}")
.WithCancellationToken(cancellationToken)
.AsMessage());
}
/// <summary>
/// Remove an IP address from warmup mode.
/// </summary>
/// <param name="address">The IP address.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>The async task.</returns>
public Task StopWarmupAsync(string address, CancellationToken cancellationToken = default(CancellationToken))
{
return(_client
.DeleteAsync($"{_endpoint}/warmup/{address}")
.WithCancellationToken(cancellationToken)
.AsMessage());
}
/// <summary>
/// Revoke an existing API Key
/// </summary>
/// <param name="keyId">The key identifier.</param>
/// <param name="cancellationToken">Cancellation token</param>
/// <returns>
/// The async task.
/// </returns>
public Task DeleteAsync(string keyId, CancellationToken cancellationToken = default(CancellationToken))
{
return(_client
.DeleteAsync($"{_endpoint}/{keyId}")
.WithCancellationToken(cancellationToken)
.AsMessage());
}
/// <summary>
/// Delete an alert.
/// </summary>
/// <param name="alertId">The alert identifier.</param>
/// <param name="onBehalfOf">The user to impersonate.</param>
/// <param name="cancellationToken">Cancellation token.</param>
/// <returns>
/// The async task.
/// </returns>
public Task DeleteAsync(long alertId, string onBehalfOf = null, CancellationToken cancellationToken = default)
{
return(_client
.DeleteAsync($"{_endpoint}/{alertId}")
.WithCancellationToken(cancellationToken)
.AsMessage());
}
/// <summary>
/// Disassociate a Sub Account from the Master Account.
/// </summary>
/// <param name="accountId">The account Id that must be disassociated from its master account.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>
/// The async task.
/// </returns>
/// <remarks>
/// This will leave the Sub Account intact but it will no longer be associated with the master account.
/// </remarks>
public Task DisassociateAsync(long accountId, CancellationToken cancellationToken = default)
{
return(_client
.DeleteAsync($"accounts/{accountId}")
.WithCancellationToken(cancellationToken)
.AsMessage());
}
/// <summary>
/// Delete a recipient email from the suppressions list for a group.
/// </summary>
/// <param name="groupId">ID of the suppression group to delete</param>
/// <param name="email">Email address to remove from the suppression group</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>
/// The async task.
/// </returns>
public Task RemoveAddressFromSuppressionGroupAsync(int groupId, string email, CancellationToken cancellationToken = default(CancellationToken))
{
return(_client
.DeleteAsync($"{_endpoint}/groups/{groupId}/suppressions/{email}")
.WithCancellationToken(cancellationToken)
.AsMessage());
}
/// <summary>
/// Delete the inbound parse webhook settings for a specvific hostname.
/// </summary>
/// <param name="hostname">The hostname associated with the inbound parse setting that you want to delete.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>
/// The async task.
/// </returns>
public Task DeleteInboundParseWebhookSettings(string hostname, CancellationToken cancellationToken = default(CancellationToken))
{
return(_client
.DeleteAsync($"{_inboundParseWebhookEndpoint}/settings/{hostname}")
.WithCancellationToken(cancellationToken)
.AsMessage());
}
/// <summary>
/// Delete a meeting.
/// </summary>
/// <param name="userId">The user Id or email address.</param>
/// <param name="meetingId">The meeting ID.</param>
/// <param name="occurrenceId">The meeting occurrence id.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>
/// The async task.
/// </returns>
public Task DeleteAsync(string userId, long meetingId, string occurrenceId = null, CancellationToken cancellationToken = default)
{
return(_client
.DeleteAsync($"meetings/{meetingId}")
.WithArgument("occurrence_id", occurrenceId)
.WithCancellationToken(cancellationToken)
.AsMessage());
}
/// <summary>
/// Delete a recipient email from the global suppressions group.
/// </summary>
/// <param name="email">email address to be removed from the global suppressions group.</param>
/// <param name="onBehalfOf">The user to impersonate.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>
/// The async task.
/// </returns>
public Task RemoveAsync(string email, string onBehalfOf = null, CancellationToken cancellationToken = default)
{
return(_client
.DeleteAsync($"{_endpoint}/{email}")
.OnBehalfOf(onBehalfOf)
.WithCancellationToken(cancellationToken)
.AsMessage());
}
/// <summary>
/// Delete a segment.
/// </summary>
/// <param name="segmentId">The segment identifier.</param>
/// <param name="deleteMatchingContacts">if set to <c>true</c> [delete matching contacts].</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>
/// The async task.
/// </returns>
public Task DeleteAsync(long segmentId, bool deleteMatchingContacts = false, CancellationToken cancellationToken = default(CancellationToken))
{
return(_client
.DeleteAsync($"{_endpoint}/{segmentId}")
.WithArgument("delete_contacts", deleteMatchingContacts ? "true" : "false")
.WithCancellationToken(cancellationToken)
.AsMessage());
}
/// <summary>
/// Delete the inbound parse webhook settings for a specific hostname.
/// </summary>
/// <param name="hostname">The hostname associated with the inbound parse setting that you want to delete.</param>
/// <param name="onBehalfOf">The user to impersonate.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>
/// The async task.
/// </returns>
public Task DeleteInboundParseWebhookSettingsAsync(string hostname, string onBehalfOf = null, CancellationToken cancellationToken = default)
{
return(_client
.DeleteAsync($"{_inboundParseWebhookEndpoint}/settings/{hostname}")
.OnBehalfOf(onBehalfOf)
.WithCancellationToken(cancellationToken)
.AsMessage());
}
/// <summary>
/// Delete a webinar.
/// </summary>
/// <param name="webinarId">The webinar ID.</param>
/// <param name="occurrenceId">The webinar occurrence id.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>
/// The async task.
/// </returns>
public Task DeleteAsync(long webinarId, string occurrenceId = null, CancellationToken cancellationToken = default)
{
return(_client
.DeleteAsync($"webinars/{webinarId}")
.WithArgument("occurrence_id", occurrenceId)
.WithCancellationToken(cancellationToken)
.AsMessage());
}
/// <summary>
/// Delete a webinar.
/// </summary>
/// <param name="webinarId">The webinar ID.</param>
/// <param name="occurrenceId">The webinar occurrence id.</param>
/// <param name="sendNotification">If true, a notification email is sent to the panelists and registrants.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>
/// The async task.
/// </returns>
public Task DeleteAsync(long webinarId, string occurrenceId = null, bool sendNotification = false, CancellationToken cancellationToken = default)
{
return(_client
.DeleteAsync($"webinars/{webinarId}")
.WithArgument("occurrence_id", occurrenceId)
.WithArgument("cancel_webinar_reminder", sendNotification.ToString().ToLower())
.WithCancellationToken(cancellationToken)
.AsMessage());
}
/// <summary>
/// Delete contacts.
/// </summary>
/// <param name="contactId">The contact identifier.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>
/// The async task.
/// </returns>
public Task DeleteAsync(IEnumerable <string> contactId, CancellationToken cancellationToken = default(CancellationToken))
{
var data = JArray.FromObject(contactId.ToArray());
return(_client
.DeleteAsync(_endpoint)
.WithJsonBody(data)
.WithCancellationToken(cancellationToken)
.AsMessage());
}
/// <summary>
/// Delete a meeting.
/// </summary>
/// <param name="meetingId">The meeting ID.</param>
/// <param name="occurrenceId">The meeting occurrence id.</param>
/// <param name="notifyHost">If true, a notification email is sent to the host and alternative host.</param>
/// <param name="notifyRegistrants">If true, a notification email is sent to the registrants.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>
/// The async task.
/// </returns>
public Task DeleteAsync(long meetingId, string occurrenceId = null, bool notifyHost = true, bool notifyRegistrants = false, CancellationToken cancellationToken = default)
{
return(_client
.DeleteAsync($"meetings/{meetingId}")
.WithArgument("occurrence_id", occurrenceId)
.WithArgument("schedule_for_reminder", notifyHost.ToString().ToLower())
.WithArgument("cancel_meeting_reminder", notifyRegistrants.ToString().ToLower())
.WithCancellationToken(cancellationToken)
.AsMessage());
}
/// <summary>
/// Delete contacts.
/// </summary>
/// <param name="contactId">The contact identifier.</param>
/// <param name="onBehalfOf">The user to impersonate.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>
/// The async task.
/// </returns>
public Task DeleteAsync(IEnumerable <string> contactId, string onBehalfOf = null, CancellationToken cancellationToken = default)
{
var data = contactId.ToArray();
return(_client
.DeleteAsync(_endpoint)
.OnBehalfOf(onBehalfOf)
.WithJsonBody(data)
.WithCancellationToken(cancellationToken)
.AsMessage());
}
/// <summary>
/// Delete a whitelabel domain.
/// </summary>
/// <param name="domainId">The identifier.</param>
/// <param name="cancellationToken">Cancellation token</param>
/// <returns>
/// The async task.
/// </returns>
public Task DeleteDomainAsync(long domainId, CancellationToken cancellationToken = default(CancellationToken))
{
return(_client
.DeleteAsync($"{_endpoint}/domains/{domainId}")
.WithCancellationToken(cancellationToken)
.AsMessage());
}
/// <summary>
/// Delete an authenticated domain.
/// </summary>
/// <param name="domainId">The identifier.</param>
/// <param name="onBehalfOf">The user to impersonate.</param>
/// <param name="cancellationToken">Cancellation token.</param>
/// <returns>
/// The async task.
/// </returns>
public Task DeleteDomainAsync(long domainId, string onBehalfOf = null, CancellationToken cancellationToken = default)
{
return(_client
.DeleteAsync($"{_endpoint}/domains/{domainId}")
.OnBehalfOf(onBehalfOf)
.WithCancellationToken(cancellationToken)
.AsMessage());
}
/// <summary>
/// Delete a user.
/// </summary>
/// <param name="userId">The user Id or email address.</param>
/// <param name="transferEmail">Transfer email.</param>
/// <param name="transferMeetings">Transfer meetings.</param>
/// <param name="transferWebinars">Transfer webinars.</param>
/// <param name="transferRecordings">Transfer recordings.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>
/// The async task.
/// </returns>
public Task DeleteAsync(string userId, string transferEmail, bool transferMeetings, bool transferWebinars, bool transferRecordings, CancellationToken cancellationToken = default)
{
return(_client
.DeleteAsync($"users/{userId}")
.WithArgument("action", "delete")
.WithArgument("transfer_email", transferEmail)
.WithArgument("transfer_meetings", transferMeetings.ToString().ToLower())
.WithArgument("transfer_webinars", transferWebinars.ToString().ToLower())
.WithArgument("transfer_recordings", transferRecordings.ToString().ToLower())
.WithCancellationToken(cancellationToken)
.AsMessage());
}
