fellowshipone/lib/communications.js

Fellowship One (F1) API wrapper for Node.js

var util = require('util')
var _ = require('lodash')
var F1Resource = require('./f1resource')

/**
 * This is Communications in a non-household or person context. This means that
 * a household or person ID/object needs to be provided in the parameters for
 * all operations that need a context.
 *
 * @param {Object} f1 - the F1 object
 */
function Communications (f1, options) {
  var opts = options || {
    resourceName: 'communication'
  }
  if (!opts.resourceName) {
    opts.resourceName = 'communication'
  }
  F1Resource.call(this, f1, opts)
}

util.inherits(Communications, F1Resource)

/**
 * This implementation of create will first remove any communication.@generalType
 * property from the given params. This is because F1's API is too brittle to
 * handle it in a new Communications object, despite providing @generalType as
 * part of the CommunicationType object returned by a "show" operation.
 *
 * @param  {Object} params - params to populate the resource with.
 * @param  {Function} callback - called with (err, result)
 */
Communications.prototype.create = function (origParams, callback) {
  var params = _.clone(origParams)
  if (!!params.communicationType && !!params.communicationType['@generalType']) {
    delete params.communicationType['@generalType']
  }
  F1Resource.prototype.create.call(this, params, callback)
}

module.exports = Communications