Installation
This client is intended for server side use only.
npm install caymland-js --save
Playground
You can play and watch everything working
node bin/playground.js
Usage
const Caymland = require('caymland-js')
const client = new Caymland({
baseUrl: 'https://instance.caymland.app',
auth: {
username: 'username',
password: 'password'
}
})
Resources
Contact
const response = await client.contacts.get(contactId)
const response = await client.contacts.list()
const response = await client.contacts.list({ search: 'john.doe@caymland.com' })
const response = await client.contacts.create({
firstname: 'John',
lastname: 'Doe',
email: 'john.doe@caymland.com',
owner: 1
})
const response = await client.contacts.delete(contactId)
const response = await client.contacts.edit(contactId, {
firstname: 'John',
lastname: 'Doe',
email: 'john.doe@caymland.com',
owner: 1
})
const response = await client.contacts.editOrCreate(contactId, {
firstname: 'John',
lastname: 'Doe',
email: 'john.doe@caymland.com',
owner: 1
})
const response = await client.contacts.addPoints(contactId, 10)
const response = await client.contacts.subtractPoints(contactId, 10)
const response = await client.contacts.getNotes(contactId)
const response = await client.contacts.getActivityEvents(contactId)
const response = await client.contacts.getCompanies(contactId)
const response = await client.contacts.addUTMTags(contactId, {
utm_campaign: 'utm campaign tag',
utm_source: 'utm source tag',
utm_medium: 'utm medium tag',
utm_content: 'utm content tag',
utm_term: 'utm term tag'
})
const response = await client.contacts.removeUTMTags(contactId, utmId)
const response = await client.contacts.listSegments(contactId)
Segment
const response = await client.segments.addContact(1, 2)
const response = await client.segments.removeContact(1, 2)
Company
const response = await client.companies.get(1)
const response = await client.companies.list({
name: 'Field Control'
})
const response = await client.companies.create(2)
const response = await client.companies.edit(1, 2)
const response = await client.companies.editOrCreate(1, 2)
const response = await client.companies.delete(1)
const response = await client.companies.addContact(1, 2)
const response = await client.companies.removeContact(1, 2)
Users
const response = await client.users.get(1)
const response = await client.users.list(1)
const response = await client.users.getSelf()