Package com.netlang.limecrm

Class NLimeClient

java.lang.Object

com.netlang.net.NHttpClient

com.netlang.net.NRestClient

com.netlang.limecrm.NLimeClient

All Implemented Interfaces:

AutoCloseable

public class NLimeClient
extends NRestClient

REST Client for communicating with LIME CRM systems

		NLimeClient limeCrm1 = new NLimeClient("https://example.com/my_app/api/v1/","THE_API_KEY");
		List<NLimeCompany> companies1 = limeCrm1.listCompanies();
		limeCrm1.close();
  

Field Summary

Fields inherited from class com.netlang.net.NHttpClient

TYPE_API_KEY, TYPE_TOKEN

Constructor Summary

Constructors

Constructor	Description
NLimeClient(String baseUrl, String apiKey)

Method Summary

Modifier and Type	Method	Description
void	close()	Close
NLimeCompany	createCompany(NLimeCompany company)	Create a new company
org.json.JSONObject	createObjectFromJson(String objectType, org.json.JSONObject object)
NLimePerson	createPerson(NLimePerson person)
boolean	exists(String objectType, String params)
boolean	exists(org.json.JSONObject queryObj)
NLimeCompany	getCompany(long id)	Endpoint: /company/{id}/
org.json.JSONObject	getObjectAsJson(String objectType, long id)	Endpoint: /{objectType}/{id}/
long	getObjectId(org.json.JSONObject queryObj)
NLimePerson	getPerson(long id)	Endpoint: /person/{id}/
String	getUrl()
List<NLimeCompany>	listCompanies()	List all companies with LIME
org.json.JSONArray	listDeals(long companyId)	Endpoint: /company/{id}/deal/
List<NLimePerson>	listPersons(long companyId)	Endpoint: /company/{id}/person/
static void	main(String[] args)
NLimeCompany	updateCompany(NLimeCompany company)
org.json.JSONObject	updateObjectFromJson(String objectType, long id, org.json.JSONObject object)
NLimePerson	updatePerson(NLimePerson person)

Methods inherited from class com.netlang.net.NRestClient

deleteAsJson, getAsArray, getAsArray, getAsArray, getAsArray, getAsJson, getAsJson, getAsJson, getAsJson, getAsObject, getAsObject, getAsObject, getAsObject, getGetAsArray, makeObject, patch, patch, patchAsObject, patchAsObject, patchAsObject, patchAsObject, patchJson, patchJson, patchJsonGetArray, patchJsonGetArray, patchJsonGetEmpty, patchJsonGetEmpty, post, post, postAsObject, postAsObject, postAsObject, postAsObject, postJson, postJson, postJsonGetArray, postJsonGetArray, postJsonGetEmpty, postJsonGetEmpty, putGetAsArray, putGetAsArray, putGetAsJson, putGetAsJson, putGetAsJson, putGetAsObject, putGetAsObject, putGetAsObject, putJson, putJson, putJsonGetArray, putJsonGetArray

Methods inherited from class com.netlang.net.NHttpClient

addDefaultHeader, delete, delete, delete, get, get, get, get, patch, patch, post, post, post, post, post, postFile, postFile, postFile, postFile, postFile, postFile, put, put, putFile, putFile, putFile, putFile, putFile, putFile, setBaseUrl

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

NLimeClient

public NLimeClient(String baseUrl,
 String apiKey)

Parameters:

baseUrl - - https://example.com/my_app/

apiKey - - "x-api-key: ABC123"

Method Details

main

public static void main(String[] args)

listCompanies

public List<NLimeCompany> listCompanies()
                                 throws Exception

List all companies with LIME

Returns:

Throws:

Exception

getCompany

public NLimeCompany getCompany(long id)
                        throws Exception

Endpoint: /company/{id}/

Parameters:

id -

Throws:

Exception

getPerson

public NLimePerson getPerson(long id)
                      throws Exception

Endpoint: /person/{id}/

Parameters:

id -

Throws:

Exception

updateCompany

public NLimeCompany updateCompany(NLimeCompany company)
                           throws Exception

Parameters:

company -

Returns:

Throws:

Exception

createCompany

public NLimeCompany createCompany(NLimeCompany company)
                           throws Exception

Create a new company

Parameters:

company -

Returns:

Throws:

Exception

listDeals

public org.json.JSONArray listDeals(long companyId)
                             throws Exception

Endpoint: /company/{id}/deal/

Parameters:

limit -

Returns:

Throws:

Exception

listPersons

public List<NLimePerson> listPersons(long companyId)
                              throws Exception

Endpoint: /company/{id}/person/

Parameters:

limit -

withCoworker -

Returns:

Throws:

Exception

updatePerson

public NLimePerson updatePerson(NLimePerson person)
                         throws Exception

Throws:

Exception

createPerson

public NLimePerson createPerson(NLimePerson person)
                         throws Exception

Throws:

Exception

getObjectAsJson

public org.json.JSONObject getObjectAsJson(String objectType,
 long id)
                                    throws Exception

Endpoint: /{objectType}/{id}/

Parameters:

id -

Throws:

Exception

createObjectFromJson

public org.json.JSONObject createObjectFromJson(String objectType,
 org.json.JSONObject object)
                                         throws Exception

Throws:

Exception

updateObjectFromJson

public org.json.JSONObject updateObjectFromJson(String objectType,
 long id,
 org.json.JSONObject object)
                                         throws Exception

Throws:

Exception

exists

public boolean exists(String objectType,
 String params)
               throws Exception

Throws:

Exception

exists

public boolean exists(org.json.JSONObject queryObj)
               throws Exception

Throws:

Exception

getObjectId

public long getObjectId(org.json.JSONObject queryObj)
                 throws Exception

Throws:

Exception

getUrl

public String getUrl()

close

public void close()

Description copied from class: NHttpClient

Close

Specified by:

close in interface AutoCloseable

Overrides:

close in class NHttpClient