Skip to content
/ ApiParser_csharp Public

C# class for using our company's API as part of the subscription

1 star 1 fork Branches Tags Activity
Star
Notifications You must be signed in to change notification settings

emailplatform/ApiParser_csharp

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

66 Commits
README.md
README.md
 
 

Repository files navigation

ApiParser C#

C# class for using our company's API as part of the subscription.


Installation

Install the NuGet package from the package manager console:

Install-Package ApiParser -Version 1.2.21

How to use

  1. Create instance from ApiParser.NET.dll
ApiParser parser = new ApiParser("API_USERNAME", "API_TOKEN", "json");
  1. Call method from ApiParser
int campaignid = 278;
float hours = 1;

object response = parser.ScheduleSendSMS(campaignid, hours);

Changelog:

Differences between v1.2.20 and v1.2.21


Method definition changed:

  • ScheduleSendSMS

Previous:

public string ScheduleSendSMS(int campaignid = 0, int[] lists = null, float hours = 0)

Now:

public string ScheduleSendSMS(int campaignid = 0, float hours = 0)
  • Removed: lists.

Removed method:

  • SendSMS
public string SendSMS(int campaignid = 0, string subject = "", string text = "", int subscriberid = 0, int listid = 0, string mobile = "", string mobilePrefix = "")

Differences between v1.2.18 and v1.2.20

New method:

  • RemoveOTMDocument
public string RemoveOTMDocument(int subscriberid = 0, int fieldid = 0, string path = "", int index = 0)

Differences between v1.2.17 and v1.2.18

New methods:

  • CreateSubAccount
public string CreateSubAccount(string accountName = "", string accountPassword = "", string ownerEmail = "", string[] allowedDomains = null)

  • InheritListsToSubAccount
public string InheritListsToSubAccount(string accountName = "", int[] inheritLists = null)

  • InheritSegmentsToSubAccount
public string InheritSegmentsToSubAccount(string accountName = "", int[] inheritSegments = null)

  • InheritNewsletterToSubAccount
public string InheritNewsletterToSubAccount(string accountName = "", int newsletterid = 0, string recipientsType = "", int[] recipientsid = null)

Differences between v1.2.16 and v1.2.17


Method definition changed:

  • UpdateOTMDocument

Previous:

public string UpdateOTMDocument(int subscriberid = 0, int fieldid = 0, Dictionary<string, object> values = null, string path = "");

Now:

public string UpdateOTMDocument(int subscriberid = 0, int listid = 0, string emailaddress = "", string mobileNumber = "", string mobilePrefix = "", int fieldid = 0, Dictionary<string, object> values = null, string path = "");
  • Added: listid, emailaddress, mobileNumber and mobilePrefix.

Differences between v1.2.15 and v1.2.16


Method definition changed:

  • GetSubscriberDetails

Previous: listid was required.

Now: listid is not required if subscriberid is specified.

Differences between v1.2.14.2 and v1.2.15

New methods:

  • UpdateOTMDocument
public string UpdateOTMDocument(int subscriberid = 0, int fieldid = 0, Dictionary<string, object> values = null, string path = "")

  • RemoveOTMDocument
 public string RemoveOTMDocument(int subscriberid = 0, int fieldid = 0, string path = "", int index = 0)

Method definition changed:

  • SendNewsletter

Previous:

public string SendNewsletter(int newsletterid = 0, int subscriberid = 0, string email = "", string senderEmail = "", string senderName = "", string replyEmail = "", string callbackUrl = "", bool reloadFeed = false)

Now:

public string SendNewsletter(int newsletterid = 0, int subscriberid = 0, string email = "", string senderEmail = "", string senderName = "", string replyEmail = "", string callbackUrl = "", bool reloadFeed = false, bool notifyOwner = false)
  • Added: notifyOwner

  • ScheduleSendNewsletter

Previous:

public string ScheduleSendNewsletter(int campaignid = 0, float hours = 0, bool saveSnapshots = true, bool reloadFeed = true)

Now:

public string ScheduleSendNewsletter(int campaignid = 0, float hours = 0, bool saveSnapshots = true, bool reloadFeed = true, bool notifyOwner = false)
  • Added: notifyOwner

  • ScheduleSendNewsletterToLists

Previous:

 public string ScheduleSendNewsletterToLists(int campaignid = 0, float timeToSend = 0, int[] listids = null, bool saveSnapshots = true, bool reloadFeed = true)

Now:

 public string ScheduleSendNewsletterToLists(int campaignid = 0, float timeToSend = 0, int[] listids = null, bool saveSnapshots = true, bool reloadFeed = true, bool notifyOwner = false)
  • Added: notifyOwner

  • ScheduleSendNewsletterToSegments

Previous:

 public string ScheduleSendNewsletterToSegments(int campaignid = 0, float timeToSend = 0, int[] segmentids = null, bool saveSnapshots = true, bool reloadFeed = true)

Now:

 public string ScheduleSendNewsletterToSegments(int campaignid = 0, float timeToSend = 0, int[] segmentids = null, bool saveSnapshots = true, bool reloadFeed = true, bool notifyOwner = false)
  • Added: notifyOwner

Differences between v1.2.14.1 and v1.2.14.2

Method result changed:

  • GetStatids
public object GetStatids(int listid = 0, int segmentid = 0, int campaignid = 0, string from = "", string to = "", int limit = 100, int offset = 0)

Differences between v1.2.14 and v1.2.14.1

New method:

  • GetSampleDataForOTM
public object GetSampleDataForOTM(int fieldid = 0)

Differences between v1.2.13 and v1.2.14

Method definition changed:

  • ScheduleSendNewsletter

Previous:

public string ScheduleSendNewsletter(int campaignid = 0, float hours = 0, bool saveSnapshots = true)

Now:

public string ScheduleSendNewsletter(int campaignid = 0, float hours = 0, bool saveSnapshots = true, bool reloadFeed = true)
  • Added: reloadFeed

  • ScheduleSendNewsletterToLists

Previous:

public function ScheduleSendNewsletterToLists(int campaignid = 0, float timeToSend = 0, int[] listids = null)

Now:

public function ScheduleSendNewsletterToLists(int campaignid = 0, float timeToSend = 0, int[] listids = null, bool saveSnapshots = true, bool reloadFeed = true)
  • Added: saveSnapshots and reloadFeed

  • ScheduleSendNewsletterToSegments

Previous:

public function ScheduleSendNewsletterToSegments(int campaignid = 0, float timeToSend = 0, int[] segmentids = null)

Now:

public function ScheduleSendNewsletterToSegments(int campaignid = 0, float timeToSend = 0, int[] segmentids = null, bool saveSnapshots = true, bool reloadFeed = true)
  • Added: saveSnapshots and reloadFeed

Differences between v1.2.12 and v1.2.13

New method:

  • CreateSegment
public string CreateSegment(string name = "", Dictionary<string, object> rules = null, string connector = "and")

Differences between v1.2.11 and v1.2.12

New method:

  • AddCustomFieldsToList
public string AddCustomFieldsToList(int listid = 0, int[] customFields = null)

Differences between v1.2.10 and v1.2.11

Method definition changed:

  • SendNewsletter

Previous:

public string SendNewsletter(int newsletterid = 0, int subscriberid = 0, string email = "", string senderEmail = "", string senderName = "", string replyEmail = "")

Now:

public string SendNewsletter(int newsletterid = 0, int subscriberid = 0, string email = "", string senderEmail = "", string senderName = "", string replyEmail = "", string callbackUrl = "", bool reloadFeed = false)
  • Added: callbackUrl and reloadFeed

Differences between v1.2.9 and v1.2.10

New methods:

  • ScheduleSendNewsletterToLists

Definition:

public string ScheduleSendNewsletterToLists(int campaignid = 0, float hours = 0, int[] listids = null)
  • ScheduleSendNewsletterToSegments

Definition:

public string ScheduleSendNewsletterToSegments(int campaignid = 0, float hours = 0, int[] segmentids = null)

Differences between v1.2.8 and v1.2.9

Method definition changed:

  • ScheduleSendNewsletter

Previous:

public string ScheduleSendNewsletter(int campaignid = 0, float hours = 0)

Now:

public string ScheduleSendNewsletter(int campaignid = 0, float hours = 0, bool saveSnapshots = true)
  • Added: saveSnapshots

New methods:

  • GetSentEmailCampaignEvents

Definition:

public string GetSentEmailCampaignEvents(string from = "", string to = "", int limit = 10, int offset = 0)
  • GetSentEmailCampaignWithTriggerEvents

Definition:

public string GetSentEmailCampaignWithTriggerEvents(string from = "", string to = "", int limit = 10, int offset = 0)
  • GetOpenCampaignEvents

Definition:

public string GetOpenCampaignEvents(string from = "", string to = "", int limit = 10, int offset = 0)
  • GetOpenTriggersEvents

Definition:

public string GetOpenTriggersEvents(string from = "", string to = "", int limit = 10, int offset = 0)
  • GetLinkClickCampaignEvents

Definition:

public string GetLinkClickCampaignEvents(string from = "", string to = "", int limit = 10, int offset = 0)
  • GetLinkClickTriggersEvents

Definition:

public string GetLinkClickTriggersEvents(string from = "", string to = "", int limit = 10, int offset = 0)
  • GetSentAutoresponderEvents

Definition:

public string GetSentAutoresponderEvents(string from = "", string to = "", int limit = 10, int offset = 0)
  • GetOpenAutoresponderEvents

Definition:

public string GetOpenAutoresponderEvents(string from = "", string to = "", int limit = 10, int offset = 0)
  • GetLinkClickAutoresponderEvents

Definition:

public string GetLinkClickAutoresponderEvents(string from = "", string to = "", int limit = 10, int offset = 0)
  • GetSentSMSCampaignEvents

Definition:

public string GetSentSMSCampaignEvents(string from = "", string to = "", int limit = 10, int offset = 0)

Differences between v1.2.7 and v1.2.8

Update on memory objects:


Differences between v1.2.6 and v1.2.7

New method:

  • GetTrackingEvents

Definition:

public object GetTrackingEvents(int listid = 0, int subscriberid = 0, int limit = 100, int offset = 0)

Differences between v1.2.5 and v1.2.6

New methods:

  • GetLeadScore

Definition:

public object GetLeadScore(int subscriberid = 0)

  • SetLeadScore

Definition:

public object SetLeadScore(int subscriberid = 0, int? leadScore = null, string type = "add")

Differences between v1.2.4 and v1.2.5

New method:

  • LoadCustomField

Definition:

 public object LoadCustomField(int fieldid = 0, bool return_options = false, bool makeInstance = false)

Method condition changed:

  • GetCustomFields

Previous:

public object GetCustomFields(int[] lists = null)

Now:

public object GetCustomFields(int[] lists = null)
  • lists: is not required.

Differences between v1.2.3 and v1.2.4

New methods:

  • GetNewsletterSummary

Definition:

public object GetNewsletterSummary(int newsletterid = 0, int statid = 0, string from = "", string to = "")

  • GetStatids

Definition:

public object GetStatids(int listid = 0, int segmentid = 0, int campaignid = 0, string from = "", string to = "", int limit = 100, int offset = 0)

  • GetSnapshots

Definition:

public object GetSnapshots(int subscriberid = 0, int triggerid = 0, int autoresponderid = 0)

Differences between v1.2.2 and v1.2.3

Method definition changed:

  • ResubscribeContact

Previous:

public string ResubscribeContact(int listid = 0, string emailaddress = "", string mobileNumber = "", string mobilePrefix = "", bool add_to_autoresponders = false)

Now:

public string ResubscribeContact(int listid = 0, string emailaddress = "", string mobileNumber = "", string mobilePrefix = "", bool add_to_autoresponders = false, List<ContactFieldText> contactFields = null, List<Dictionary<string, object>> otmValues = null)
  • Added: contactFields and otmValues.

Differences between v1.2.1 and v1.2.2

New methods:

  • GetSegments

Definition:

public object GetSegments(int listid = 0, bool count_subscribers = false, int limit = 1000, int offset = 0)

  • GetTriggers

Definition:

public object GetTriggers(int listid = 0, int limit = 1000, int offset = 0)

Differences between v1.1.11 and v1.2.1

New methods:

  • AddToOTMDocument

Definition:

public string AddToOTMDocument(int listid = 0, int subscriberid = 0, string emailaddress = "", string mobile = "", string mobilePrefix = "", int fieldid = 0, Dictionary<string, object> values = null, string path = "")

  • GetSubscribersByCustomField

Definition:

public object GetSubscribersByCustomField(int listid = 0, List<ContactFieldText> data = null, bool activeonly = true, bool countonly = false, int limit = 1000, int offset = 0)

Differences between v1.1.10 and v1.1.11

New methods:

  • GetTriggerSummary

Definition:

public object GetTriggerSummary(int triggerid = 0, string from = "", string to = "")

  • GetAutoresponderSummary

Definition:

public object GetAutoresponderSummary(int autoresponderid = 0, string from = "", string to = "")

Differences between v1.1.9 and v1.1.10

New methods:

  • GetSegmentSummary

Definition:

public object GetSegmentSummary(int segmentid = 0, string from = "", string to = "")

  • GetRulesForSegment

Definition:

public object GetRulesForSegment(int segmentid = 0)

  • EditNewsletter

Definition:

public object EditNewsletter(int newsletterid = 0, string name = "", string subject = "")

  • SetTriggerStatus

Definition:

public object SetTriggerStatus(int triggerid = 0, bool status = false)

  • SetAutoresponderStatus

Definition:

public object SetAutoresponderStatus(int autoresponderid = 0, bool status = false)

Differences between v1.1.8 and v1.1.9

Method definition changed:

  • GetNewsletters

Previous:

public object GetNewsletters(bool countOnly = false, bool getLastSentDetails = false, bool content = true, string afterCreateDate = "", string newsletterNameLike = "")

Now:

public object GetNewsletters(bool countOnly = false, bool getLastSentDetails = false, bool content = true, string afterCreateDate = "", string newsletterNameLike = "", int limit = 100, int offset = 0)
  • Added: limit & offset.

New methods:

  • SendSMS

Definition:

public string SendSMS(int campaignid = 0, string subject = "", string text = "",  int subscriberid = 0, int listid = 0, string mobile = "", string mobilePrefix = "")

  • GetSubscribersFromSegment

Definition:

public object GetSubscribersFromSegment(int segmentid = 0, bool countonly = false, bool activeonly = true, int limit = 100, int offset = 0)

  • ViewNewsletter

Definition:

public object ViewNewsletter(int newsletterid = 0)

  • GetTriggersForSegment

Definition:

public object GetTriggersForSegment(int segmentid = 0)

About

C# class for using our company's API as part of the subscription

Resources

Readme
Activity

Stars

1 star

Watchers

0 watching

Forks

1 fork
Report repository

Releases

No releases published

Packages

No packages published