

insightly-api
@ HEAD
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 |
using System.Collections.Generic; using Ninject; using TS.Insightly.API.Contract; using TS.Insightly.API.ICModule; using TS.Insightly.API.Interface; namespace TS.Insightly.API { /// <summary> /// Facade for the Insightly API. /// Uses RestSharp - https://github.com/restsharp/RestSharp/wiki /// Uses Ninject - http://www.ninject.org/index.html /// </summary> public class InsightlyAPI : IApi { #region Fields private readonly IContactController _contactController; private readonly IOrganisationController _organisationController; private readonly IProjectController _projectController; #endregion Fields /// <summary> /// Initializes a new instance of the <see cref="InsightlyAPI"/> class. /// </summary> /// <param name="apiKey">The API key.</param> public InsightlyAPI(string apiKey) { IKernel kernal = new StandardKernel(new ApiModule(apiKey)); _contactController = kernal.Get<IContactController>(); _organisationController = kernal.Get<IOrganisationController>(); _projectController = kernal.Get<IProjectController>(); } #region Contacts /// <summary> /// Gets the contact for the unique contact ID. /// Note that the Id is not the Id shown for the contact in the web browser, but /// the contact Id that is unique to insightly. /// </summary> /// <param name="contactId">The contact unique identifier.</param> /// <returns>The contact for the given id.</returns> public Contact GetContact(int contactId) { return _contactController.GetContact(contactId); } /// <summary> /// Gets the contacts for email address. /// </summary> /// <param name="emailAddress">The email address.</param> /// <returns>List of contacts with a matching email address or empty list if no matches found.</returns> public List<Contact> GetContactsForEmail(string emailAddress) { return _contactController.GetContactsForEmail(emailAddress); } /// <summary> /// Adds the new contact. /// </summary> /// <param name="newContact">The new contact.</param> /// <returns>The added contact if successful.</returns> public Contact AddNewContact(Contact newContact) { return _contactController.AddNewContact(newContact); } /// <summary> /// Adds the new contact if a contact does not already exist for the same email, /// first and last names as the given contact. /// </summary> /// <param name="newContact">The new contact.</param> /// <returns>Structure containing details of the add.</returns> public ContactAddResult AddNewContactIfNotExists(Contact newContact) { return _contactController.AddNewContactIfNotExists(newContact); } /// <summary> /// Deletes the contact. /// Note that the Id is not the Id shown for the contact in the web browser, but /// the contact Id that is unique to insightly. /// </summary> /// <param name="contactId">The contact unique identifier.</param> /// <returns><code>true</code> If the contact was deleted.</returns> public bool DeleteContact(int contactId) { return _contactController.DeleteContact(contactId); } /// <summary> /// Result for conditional contact add. /// </summary> public struct ContactAddResult { /// <summary> /// <code>true</code> If the condition check resulted in a new contact added. /// Note if there was an add failure <see cref="Contact"/> may not be valid. /// </summary> public bool NewContactAdded; /// <summary> /// The contact, if <see cref="NewContactAdded"/> was <code>true</code> this will /// be the newly added contact, otherwise it will be the existing contact. /// </summary> public Contact Contact; } #endregion Contacts #region Organisations /// <summary> /// Gets the organisation for the unique organisation ID. /// Note that the Id is not the Id shown for the organisation in the web browser, but /// the organisation Id that is unique to insightly. /// </summary> /// <param name="organisationId">The organisation unique identifier.</param> /// <returns>The organisation for the given id.</returns> public Organisation GetOrganisation(int organisationId) { return _organisationController.GetOrganisation(organisationId); } /// <summary> /// Gets organisations. /// </summary> /// <param name="fullDetails">if set to <c>true</c> return full details.</param> /// <returns>All organisations.</returns> public List<Organisation> GetOrganisations(bool fullDetails) { return _organisationController.GetOrganisations(fullDetails); } /// <summary> /// Gets organisations matching the given name. /// </summary> /// <param name="orgName">Name of the org to find.</param> /// <returns>List of organisations (basic details) matching the given name.</returns> public List<Organisation> GetOrganisationsForName(string orgName) { return _organisationController.GetOrganisationsForName(orgName); } /// <summary> /// Adds the new organisation. /// </summary> /// <param name="newOrganisation">The new organisation.</param> /// <returns>The added organisation if successful.</returns> public Organisation AddNewOrganisation(Organisation newOrganisation) { return _organisationController.AddNewOrganisation(newOrganisation); } /// <summary> /// Deletes the organisation. /// Note that the Id is not the Id shown for the organisation in the web browser, but /// the organisation Id that is unique to insightly. /// </summary> /// <param name="organisationId">The organisation unique identifier.</param> /// <returns><code>true</code> If the organisation was deleted.</returns> public bool DeleteOrganisation(int organisationId) { return _organisationController.DeleteOrganisation(organisationId); } #endregion Organisations #region Projects /// <summary> /// Gets the project for the unique organisation ID. /// Note that the Id is not the Id shown for the project in the web browser, but /// the project Id that is unique to insightly. /// </summary> /// <param name="projectId">The project unique identifier.</param> /// <returns>The project for the given id.</returns> public Project GetProject(int projectId) { return _projectController.GetProject(projectId); } /// <summary> /// Gets projects. /// </summary> /// <param name="fullDetails">if set to <c>true</c> return full details.</param> /// <returns>All projects.</returns> public List<Project> GetProjects(bool fullDetails) { return _projectController.GetProjects(fullDetails); } #endregion Projects } } |
Commits for insightly-api/trunk/Insightly/InsightlyAPI.cs
Revision | Author | Commited | Message |
---|---|---|---|
15
![]() |
|
Tue 01 Oct, 2013 13:47:15 +0000 | Refactored, added Ninject to load controllers for each part of the API. |
14
![]() |
|
Mon 30 Sep, 2013 15:36:43 +0000 | Refactor unit tests. |
13
![]() |
|
Mon 30 Sep, 2013 15:02:03 +0000 | Added basics for Project. |
10
![]() |
|
Tue 24 Sep, 2013 12:06:30 +0000 | Added basic organisation functionality, at the moment cannot link organisation to contact. |
9
![]() |
|
Tue 24 Sep, 2013 10:12:34 +0000 | Added AddNewContactIfNotExists that checks for existing email, first and last names before adding a contact. |
4
![]() |
|
Fri 20 Sep, 2013 15:08:23 +0000 | Added code and tests to add a basic contact with email address. |
3 |
|
Thu 19 Sep, 2013 14:44:24 +0000 | Initial working API retrieving a contact by it’s id and email address. |