Skip to content
This repository has been archived by the owner on Jul 29, 2022. It is now read-only.

Commit

Permalink
Fix errors and typos in XML comments
Browse files Browse the repository at this point in the history
  • Loading branch information
@Jericho
Jericho committed Apr 23, 2015
1 parent b4cb3ab commit b2fc067
Show file tree
Hide file tree
Showing 2 changed files with 58 additions and 49 deletions.
54 changes: 29 additions & 25 deletions CakeMail.RestClient/CakeMailRestClient.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ public CakeMailRestClient(string apiKey, IRestClient restClient)
}

/// <summary>
/// Initializes a new instance of the <see cref="ApiClient"/> class.
/// Initializes a new instance of the <see cref="CakeMailRestClient"/> class.
/// </summary>
/// <param name="apiKey">The API Key received from CakeMail</param>
/// <param name="host">The host where the API is hosted. The default is api.wbsrvc.com</param>
Expand Down Expand Up @@ -441,8 +441,7 @@ public long GetClientsCount(string userKey, ClientStatus? status = null, string
/// <param name="clientId">ID of the client.</param>
/// <param name="name">Name of the client</param>
/// <param name="status">Status of the client. Possible values: 'trial', 'active', 'suspended_by_reseller', 'deleted'</param>
/// <param name="parentId"></param>
/// <param name="name">Name of the client</param>
/// <param name="parentId">ID of the parent client</param>
/// <param name="address1">Address of the client</param>
/// <param name="address2">Address of the client</param>
/// <param name="city">City of the client</param>
Expand Down Expand Up @@ -750,14 +749,15 @@ public IEnumerable<List> GetLists(string userKey, ListStatus? status = null, str
/// <param name="name">Filter using the list name.</param>
/// <param name="clientId">Client ID of the client in which the list is located.</param>
/// <returns>The count of lists matching the filtering criteria</returns>
public long GetListsCount(string userKey, string name = null, long? clientId = null)
public long GetListsCount(string userKey, ListStatus? status = null, string name = null, long? clientId = null)
{
var path = "/List/GetList/";
var parameters = new List<KeyValuePair<string, object>>()
{
new KeyValuePair<string, object>("user_key", userKey),
new KeyValuePair<string, object>("count", "true")
};
if (status != null) parameters.Add(new KeyValuePair<string, object>("status", status.GetEnumMemberValue()));
if (name != null) parameters.Add(new KeyValuePair<string, object>("name", name));
if (clientId.HasValue) parameters.Add(new KeyValuePair<string, object>("client_id", clientId.Value));

Expand Down Expand Up @@ -1103,7 +1103,7 @@ public bool DeleteListMember(string userKey, long listId, long listMemberId, lon
/// <param name="listId">ID of the list.</param>
/// <param name="listMemberId">ID of the member.</param>
/// <param name="clientId">Client ID of the client in which the list is located.</param>
/// <returns>The <see cref=" Listmember">list mamber</see></returns>
/// <returns>The <see cref=" ListMember">list mamber</see></returns>
public ListMember GetListMember(string userKey, long listId, long listMemberId, long? clientId = null)
{
var path = "/List/GetRecord/";
Expand Down Expand Up @@ -1216,6 +1216,8 @@ public bool UpdateListMember(string userKey, long listId, long listMemberId, IEn
/// <param name="userKey">User Key of the user who initiates the call.</param>
/// <param name="listId">ID of the list.</param>
/// <param name="logType">Filter using the log action. Possible values: "subscribe", "in_queue", "opened", "clickthru", "forward", "unsubscribe", "view", "spam", "skipped"</param>
/// <param name="uniques">Return unique log items per member</param>
/// <param name="totals">Return all the log items</param>
/// <param name="start">Filter using a start date</param>
/// <param name="end">Filter using an end date</param>
/// <param name="limit">Limit the number of resulting log items.</param>
Expand Down Expand Up @@ -1250,6 +1252,8 @@ public IEnumerable<LogItem> GetListLogs(string userKey, long listId, LogType? lo
/// <param name="userKey">User Key of the user who initiates the call.</param>
/// <param name="listId">ID of the list.</param>
/// <param name="logType">Filter using the log action. Possible values: "subscribe", "in_queue", "opened", "clickthru", "forward", "unsubscribe", "view", "spam", "skipped"</param>
/// <param name="uniques">Return unique log items per member</param>
/// <param name="totals">Return all the log items</param>
/// <param name="start">Filter using a start date</param>
/// <param name="end">Filter using an end date</param>
/// <param name="clientId">Client ID of the client in which the list is located.</param>
Expand Down Expand Up @@ -1342,15 +1346,6 @@ public Segment GetSegment(string userKey, long segmentId, bool includeStatistics
/// <param name="segmentId">ID of the segment</param>
/// <param name="listId">ID of the list</param>
/// <param name="name">Name of the segment.</param>
/// <param name="language">Language of the segment. e.g.: 'en_US' for English (US)</param>
/// <param name="spamPolicyAccepted">Indicates if the anti-spam policy has been accepted</param>
/// <param name="status">Status of the segment. Possible values: 'active', 'archived', 'deleted'</param>
/// <param name="senderName">Name of the default sender of the segment.</param>
/// <param name="senderEmail">Email of the default sender of the segment.</param>
/// <param name="goto_oi">Redirection URL on subscribing to the segment.</param>
/// <param name="goto_di">Redirection URL on confirming the subscription to the segment.</param>
/// <param name="goto_oo">Redirection URL on unsubscribing to the segment.</param>
/// <param name="webhook">Webhook URL for the segment.</param>
/// <param name="query">Rules for the segment.</param>
/// <param name="clientId">Client ID of the client in which the segment is located.</param>
/// <returns>True if the segment was updated</returns>
Expand Down Expand Up @@ -1400,7 +1395,8 @@ public bool DeleteSegment(string userKey, long segmentId, long? clientId = null)
/// <param name="listId">ID of the list</param>
/// <param name="limit">Limit the number of resulting segments.</param>
/// <param name="offset">Offset the beginning of resulting segments.</param>
/// <param name="clientId">Client ID of the client in which the list is located.</param>
/// <param name="includeDetails">Retrieve all the stats for the segment</param>
/// <param name="clientId">ID of the client</param>
/// <returns>Enumeration of <see cref="Segment">segments</see> matching the filtering criteria</returns>
public IEnumerable<Segment> GetSegments(string userKey, long listId, int limit = 0, int offset = 0, bool includeDetails = true, long? clientId = null)
{
Expand Down Expand Up @@ -1502,7 +1498,7 @@ public bool DeleteMailing(string userKey, long mailingId, long? clientId = null)
/// Retrieve a mailing
/// </summary>
/// <param name="userKey">User Key of the user who initiates the call.</param>
/// <param name="listId">ID of the mailing</param>
/// <param name="mailingId">ID of the mailing</param>
/// <param name="clientId">Client ID of the client in which the mailing is located.</param>
/// <returns>The <see cref="Mailing">mailing</see></returns>
public Mailing GetMailing(string userKey, long mailingId, long? clientId = null)
Expand Down Expand Up @@ -2220,7 +2216,7 @@ public IEnumerable<SuppressDomainResult> AddDomainsToSuppressionList(string user
/// Add localparts to the suppression list
/// </summary>
/// <param name="userKey">User Key of the user who initiates the call.</param>
/// <param name="domains">The localparts to add to the suppression list</param>
/// <param name="localParts">The localparts to add to the suppression list</param>
/// <param name="clientId">Client ID of the client.</param>
/// <returns>An enumeration of <see cref="SuppressLocalPartResult">results</see>. Each item in this enumeration indicates the result of adding a localpart to the suppression list.</returns>
public IEnumerable<SuppressLocalPartResult> AddLocalPartsToSuppressionList(string userKey, IEnumerable<string> localParts, long? clientId = null)
Expand Down Expand Up @@ -2307,7 +2303,7 @@ public IEnumerable<SuppressDomainResult> RemoveDomainsFromSuppressionList(string
/// Remove localparts from the suppression list
/// </summary>
/// <param name="userKey">User Key of the user who initiates the call.</param>
/// <param name="domains">The localparts to remove from the suppression list</param>
/// <param name="localParts">The localparts to remove from the suppression list</param>
/// <param name="clientId">ID of the client.</param>
/// <returns>An enumeration of <see cref="SuppressLocalPartResult">results</see>. Each item in this enumeration indicates the result of removing a localpart from the suppression list.</returns>
public IEnumerable<SuppressLocalPartResult> RemoveLocalPartsFromSuppressionList(string userKey, IEnumerable<string> localParts, long? clientId = null)
Expand Down Expand Up @@ -2474,6 +2470,10 @@ public long GetSuppressedLocalPartsCount(string userKey, long? clientId = null)

#region Methods related to TIMEZONES

/// <summary>
/// Retrieve the list of all timezones known to the CakeMail system
/// </summary>
/// <returns>An enumeration of all <see cref="Timezone">timezones</see>.</returns>
public IEnumerable<Timezone> GetTimezones()
{
var path = "/Client/GetTimezones/";
Expand Down Expand Up @@ -2532,7 +2532,7 @@ public long CreateTrigger(string userKey, string name, long listId, long? campai
/// Retrieve a trigger
/// </summary>
/// <param name="userKey">User Key of the user who initiates the call.</param>
/// <param name="triggerID">ID of the trigger</param>
/// <param name="triggerId">ID of the trigger</param>
/// <param name="clientId">Client ID of the client in which the trigger is located.</param>
/// <returns>The <see cref="Trigger">trigger</see></returns>
public Trigger GetTrigger(string userKey, long triggerId, long? clientId = null)
Expand All @@ -2553,7 +2553,7 @@ public Trigger GetTrigger(string userKey, long triggerId, long? clientId = null)
/// Update a trigger
/// </summary>
/// <param name="userKey">User Key of the user who initiates the call.</param>
/// <param name="triggerID">ID of the trigger</param>
/// <param name="triggerId">ID of the trigger</param>
/// <param name="campaignId">ID of the campaign you want to associate the trigger with.</param>
/// <param name="name">Name of the trigger</param>
/// <param name="action">Action of the trigger. Possible values: 'opt-in', 'douopt-in', 'opt-out', 'specific', 'annual'</param>
Expand All @@ -2571,7 +2571,7 @@ public Trigger GetTrigger(string userKey, long triggerId, long? clientId = null)
/// <param name="trackingParameters">Additional tracking parameters for links.</param>
/// <param name="delay">Delay (in seconds) to be used when the trigger is unleashed.</param>
/// <param name="status">Status of the trigger. Possible values: 'active', 'inactive'</param>
/// <param name="dateField">Datetime field to be used for trigger with action 'specific' or 'annual'.</param>
/// <param name="date">DateTime to be used for trigger with action 'specific' or 'annual'.</param>
/// <param name="clientId">Client ID of the client in which the trigger is located.</param>
/// <returns>True if the trigger was updated</returns>
public bool UpdateTrigger(string userKey, long triggerId, long? campaignId = null, string name = null, TriggerAction? action = null, MessageEncoding? encoding = null, TransferEncoding? transferEncoding = null, string subject = null, string senderEmail = null, string senderName = null, string replyTo = null, string htmlContent = null, string textContent = null, bool? trackOpens = null, bool? trackClicksInHtml = null, bool? trackClicksInText = null, string trackingParameters = null, int? delay = null, TriggerStatus? status = null, DateTime? date = null, long? clientId = null)
Expand Down Expand Up @@ -3120,7 +3120,8 @@ public IEnumerable<TemplateCategoryVisibility> GetTemplateCategoryVisibility(str
/// Get a count of permissions for a given template category.
/// </summary>
/// <param name="userKey">User Key of the user who initiates the call.</param>
/// <param name="clientId">Client ID of the client in which the category is located.</param>
/// <param name="categoryId">ID of the category</param>
/// <param name="clientId">ID of the client</param>
/// <returns>The count of permissions matching the filtering criteria</returns>
public long GetTemplateCategoryVisibilityCount(string userKey, long categoryId, long? clientId = null)
{
Expand Down Expand Up @@ -3193,7 +3194,7 @@ public long CreateTemplate(string userKey, IDictionary<string, string> labels, s
/// Delete a template
/// </summary>
/// <param name="userKey">User Key of the user who initiates the call.</param>
/// <param name="categoryId">ID of the template</param>
/// <param name="templateId">ID of the template</param>
/// <param name="clientId">Client ID of the client in which the template is located.</param>
/// <returns>True if the template is deleted</returns>
public bool DeleteTemplate(string userKey, long templateId, long? clientId = null)
Expand Down Expand Up @@ -3235,6 +3236,7 @@ public Template GetTemplate(string userKey, long templateId, long? clientId = nu
/// Retrieve the templates matching the filtering criteria.
/// </summary>
/// <param name="userKey">User Key of the user who initiates the call.</param>
/// <param name="categoryId">ID of the category</param>
/// <param name="limit">Limit the number of resulting templates.</param>
/// <param name="offset">Offset the beginning of resulting templates.</param>
/// <param name="clientId">Client ID of the client in which the templates are located.</param>
Expand All @@ -3260,6 +3262,7 @@ public IEnumerable<Template> GetTemplates(string userKey, long? categoryId = nul
/// Get a count of templates matching the filtering criteria.
/// </summary>
/// <param name="userKey">User Key of the user who initiates the call.</param>
/// <param name="categoryId">ID of the category</param>
/// <param name="clientId">Client ID of the client in which the templates are located.</param>
/// <returns>The count of templates matching the filtering criteria</returns>
public long GetTemplatesCount(string userKey, long? categoryId = null, long? clientId = null)
Expand Down Expand Up @@ -3381,7 +3384,7 @@ public bool DeleteUser(string userKey, long userId, long? clientId = null)
/// Retrieve a user
/// </summary>
/// <param name="userKey">User Key of the user who initiates the call.</param>
/// <param name="userID">ID of the user</param>
/// <param name="userId">ID of the user</param>
/// <param name="clientId">ID of the client</param>
/// <returns>The <see cref="User">user</see></returns>
public User GetUser(string userKey, long userId, long? clientId = null)
Expand Down Expand Up @@ -3450,6 +3453,7 @@ public long GetUsersCount(string userKey, UserStatus? status = null, long? clien
/// Update a user
/// </summary>
/// <param name="userKey">User Key of the user who initiates the call.</param>
/// <param name="userId">ID of the user.</param>
/// <param name="email">Email address of the user.</param>
/// <param name="password">Password of the user.</param>
/// <param name="firstName">First name of the user.</param>
Expand Down Expand Up @@ -3496,7 +3500,7 @@ public bool UpdateUser(string userKey, long userId, string email = null, string
/// <param name="email">Email address of the user.</param>
/// <param name="password">Password of the user.</param>
/// <param name="clientId">ID of the client</param>
/// <returns>The <see cref="LoginIngo">login information</see> for the user</returns>
/// <returns>The <see cref="LoginInfo">login information</see> for the user</returns>
public LoginInfo Login(string email, string password, long? clientId = null)
{
var path = "/User/Login/";
Expand Down
Loading

0 comments on commit b2fc067

Please sign in to comment.