keap-client
v0.0.7
Published
A client to work with Infusionsoft/Keap API.
Downloads
168
Readme
keap-client
This library is currently under development.
This library is a wrapper for the Keap/Infusionsoft REST API. It provides a set of classes and interfaces to make it easier for you to interact with the API from your code.
Installation
$ npm install keap-clientUsage
import { KeapClient } from 'keap-client';
let apiKey = 'Your_api_key', //your api key from Keap/infusionsoft
requestTimeout = 3000, // the time limit to wait for a response from the api
retries = 3; // amount of retries you want the api to do if the request failed
//requestTimeout and retries are optional
const keap = new KeapClient({ apiKey, requestTimeout, retries })
// each model
const contact: Contact = await keap.Contact.getContact(1);
// use the instance
contact.update({ email_opted_in: true });
contact.applyTags(['tag1', 'tag2']);Available models
- ✅ Account Info
- ⬜️ Affiliate
- ⬜️ Appointment
- ⬜️ Campaign
- ⬜️ Company
- ✅ Contact
- ✅ E-Commerce
- ⬜️ Email
- ⬜️ Email Address
- ⬜️ File
- ⬜️ Locale
- ⬜️ Merchant
- ⬜️ Note
- ✅ Opportunity
- ✅ Product
- ⬜️ REST Hooks
- ⬜️ Setting
- ⬜️ Tags
- ⬜️ Task
- ⬜️ User Info
- ⬜️ Users