monster_crm-sdk v0.0.6

Gordon

Ratonale

This is a package for interacting with the CRM designed to make it easy to do so. It batches requests and sends them to the CRM in a single request, meaning that the most requests that can happen is 1 per table per seconds. We have also added a few quality of life features such as typescript interfaces so that you know exactly what fields you can modify and what tables you have access to.

Usage

npm install monster_crm-sdk

Create a Reservation

import {Crm} from 'monster_crm-sdk';

const crm = new Crm(<username>, <password>, options?);

const res = await crm.tables.masterReservations.setReservation({
  'Any Additional Notes': 'hello world',
  'TestReservation': true
})

Update a Reservation

import {Crm} from 'monster_crm-sdk';

const crm = new Crm(<username>, <password>, options?);

const res = await crm.tables.masterReservations.setReservation({
  'Any Additional Notes': 'hello world',
  'TestReservation': true
}, '<hash>')

Update/Create a Dateleg

If you would like to create a new one, just omit the hash.

import {Crm} from 'monster_crm-sdk';

const crm = new Crm(<user>, <password>)
const res = await crm.tables.dateLegs.setLeg({
  'Flight Info': 'hello world'
}, <hash>)

Write to a Date Field

import {Crm} from 'monster_crm-sdk';

const crm = new Crm(<user>, <password>)
const formattedDate = crm.formatCrmDate(new Date())

const res = await crm.tables.masterReservations.setReservation({
  'Any Additional Notes': 'hello world',
  'TestReservation': true
  'Date of Booking': formattedDate
}, '<hash>')

Write to the Email Activity Table

import {Crm} from 'monster_crm-sdk';

const crm = new Crm(<user>, <password>)

const res = crm.tables.EmailActivity.setEmail({
  emailFrom: <from>,
  emailTo: <to>,
  emailSubject: <subject>,
  relatedReservation: <reservationId>
})

Use the Caching Feature

The caching feature allows you to create a record out of order in the CRM, for example a common thing you might see is that you need to create a reservation before creating a new payment. With the caching feature you can create both at the same time. Here is an example using a date-leg.

import {Crm} from 'monster_crm-sdk';

const crm = new Crm(<user>, <password>)

const reservationId = crm.idFromCache('master-reservations')

const reservationResponse = crm.tables.masterReservations.setReservation({
'Guest Full Name': 'hello world',
'Reservation ID#': reservationId
})

const dateleg = crm.tables.dateLegs.setLeg({
"Related Reservation": reservationId,
'Flight Info': 'hello world'
})

const [res, dl] = await Promise.all([reservationResponse, dateleg])
// both reservation and dateleg were created simultaniously

Id from Cache values

• master-reservations
• date-legs

Options

Return types

When you read from a table the return type is an object with the keys the labels of the fields, and the values being the values of the fields When you write to a table the return type is a string, which is either the record id 'updated', 'not updated'

Table Write Information

master-reservations

date-legs

payments

email-activity