intercom.io.js

  var request = require('request'),
      qs = require('qs'),
      _ = require('lodash'),
      debug = require('debug')('intercom.io'),
  
  

  
      IntercomError = require('./IntercomError'),
      url = require('url'),
      Q = require('q');
  
  
  

  
  var defaultOptions = {
    endpoint: 'https://api.intercom.io/'
  };
  
  
  

  
  function Intercom(appId, apiKey, options) {
  
  

  
    if (_.isObject(appId) && !_.isString(appId) && ((appId.apiKey && appId.appId) || appId.personalAccessToken)) {
      apiKey = appId.apiKey || '';
      options = _.omit(appId, 'apiKey', 'appId');
      appId = appId.appId || appId.personalAccessToken;
    }
  
  
  

  
    if (!appId) {
      throw new IntercomError('Invalid App ID: ' + appId);
    }
  
  
  

  
    if (!apiKey) {
      throw new IntercomError('Invalid API Key: ' + apiKey);
    }
  
  
  

  
    this.appId = appId;
    this.apiKey = apiKey || '';
  
  
  

  
    this.options = _.defaults(options || {}, Intercom.defaultOptions);
  
  
  

  
    this.endpoint = this.options.endpoint;
  }
  
  
  

  
  Intercom.defaultOptions = defaultOptions;
  
  
  

  
  Intercom.create = function(appId, apiKey, options) {
    return new Intercom(appId, apiKey, options);
  };
  
  
  

  
  Intercom.prototype.request = function(method, path, parameters, cb) {
    debug('Requesting [%s] %s with data %o', method, this.endpoint + path, parameters);
  
    var url = _.includes(path, this.endpoint) ? path : this.endpoint + path;
  
    var requestOptions = {
      method: method,
      url: url
    };
  
    if (method === 'GET') {
      requestOptions.qs = parameters;
      requestOptions.headers = {
        'Accept': 'application/json'
      };
    } else {
  
  

  
      requestOptions.body = JSON.stringify(parameters);
      requestOptions.headers = {
        'Accept': 'application/json',
        'Content-Type' : 'application/json'
      };
    }
  
    requestOptions.auth = {
        username: this.appId,
        password: this.apiKey || ''
      };
  
  
  

  
    var deferred = Q.defer();
  
    request(requestOptions, function(err, res, data) {
      if (err) {
  
  

  
        return deferred.reject(err);
      }
  
  
  

  
      var parsed;
      if (data) {
        debug('Received response %s', data);
  
        try {
          parsed = JSON.parse(data);
  
          if (parsed && (parsed.error || parsed.errors)) {
            err = new IntercomError(data);
  
  
  

  
            return deferred.reject(err);
          }
        } catch (exception) {
  
  

  
        }
      }
  
      var headers = res.headers;
      data = parsed || data;
      data.meta = {
        ratelimit_limit: headers['x-ratelimit-limit'],
        ratelimit_remaining: headers['x-ratelimit-remaining'],
        ratelimit_reset: headers['x-ratelimit-reset']
      };
  
  
  

  
      return deferred.resolve(data);
    });
  
  
  

  
    return deferred.promise.nodeify(cb);
  };
  
  
  

  
  Intercom.prototype.getPages = function(path, parameters, cb) {
  
  

  
    var self = this;
  
    var rootPromise = this.request('GET', path, parameters);
  
    function requestNextPage(pages, nextUrl, parameters) {
      return self.request('GET', nextUrl, parameters).then(function(root) {
        var next = _.get(root, 'pages.next');
        if(next) {
          pages.push(root);
          return requestNextPage(pages, next, parameters);
        }
        return pages.concat(root);
      });
    }
  
    function getAllPages(root) {
      var next = _.get(root, 'pages.next');
      if (next) {
        return requestNextPage([root], next, parameters);
      }
      return root;
    }
  
    function gatherPages (acc, result) {
      return acc.concat(result[path]);
    }
  
    return rootPromise.then(function (root) {
      return root;
    }).then(function (root) {
      return getAllPages(root);
    }).then(function (results) {
      return results.reduce(gatherPages, []);
    }).nodeify(cb);
  };
  
  
  

  
  Intercom.prototype.date = function(date) {
    if (date === undefined) {
      date = new Date();
    }
  
    if (date && _.isDate(date) && date.getTime) {
      return Math.floor(date.getTime() / 1000);
    }
  
    return Math.floor((new Date(date)) / 1000);
  };
  
  
  

  
  Intercom.prototype.getUsers = function(options, cb) {
    if (_.isFunction(options)) {
      cb = options;
      options = {};
    }
  
    return this.request('GET', 'users', options, cb);
  };
  
  Intercom.prototype.getUser = function(userObj, cb) {
    return this.request('GET', 'users', userObj, cb);
  };
  
  Intercom.prototype.viewUser = function(userObj, cb) {
    if (userObj && userObj.hasOwnProperty('id')) {
        return this.request('GET', 'users' + '/' + userObj.id, {}, cb);
    } else {
        return this.request('GET', 'users', userObj, cb);
    }
  };
  
  Intercom.prototype.createUser = function(userObj, cb) {
    return this.request('POST', 'users', userObj, cb);
  };
  
  Intercom.prototype.updateUser = function(userObj, cb) {
    return this.request('POST', 'users', userObj, cb);
  };
  
  Intercom.prototype.deleteUser = function(userObj, cb) {
    if (userObj && userObj.hasOwnProperty('id')) {
      return this.request('DELETE', 'users' + '/' + userObj.id, {}, cb);
    }
    else {
      return this.request('DELETE', 'users', userObj, cb);
    }
  };
  
  Intercom.prototype.bulkAddUsers = function(userObj, cb) {
    return this.request('POST', 'bulk/users', userObj, cb);
  };
  
  
  
  

  
  Intercom.prototype.createContact = function(obj, cb) {
    return this.request('POST', 'contacts', obj, cb);
  };
  Intercom.prototype.updateContact = Intercom.prototype.createContact;
  
  Intercom.prototype.deleteContact = function(obj, cb) {
    return this.request('DELETE', 'contacts', obj, cb);
  };
  
  Intercom.prototype.getContact = function(options, cb) {
    if (_.isFunction(options)) {
      cb = options;
      options = {};
    }
  
    return this.request('GET', 'contacts', options, cb);
  };
  Intercom.prototype.getContacts = Intercom.prototype.viewContact = Intercom.prototype.getContact;
  
  Intercom.prototype.convertContact = function(obj, cb) {
    return this.request('POST', 'contacts/convert', obj, cb);
  };
  
  
  

  
  Intercom.prototype.listCompanies = function(companyObj, cb) {
    return this.request('GET', 'companies', companyObj, cb);
  };
  
  Intercom.prototype.viewCompany = function(companyObj, cb) {
    if (companyObj && companyObj.hasOwnProperty('id')) {
        return this.request('GET', 'companies/' + companyObj.id, {}, cb);
    } else {
        return this.request('GET', 'companies', companyObj, cb);
    }
  };
  
  Intercom.prototype.createCompany = function(companyObj, cb) {
    return this.request('POST', 'companies', companyObj, cb);
  };
  
  Intercom.prototype.updateCompany = function(companyObj, cb) {
    return this.request('POST', 'companies', companyObj, cb);
  };
  
  
  

  
  
  Intercom.prototype.listCompanyUsers = function(companyObj, cb) {
    if (companyObj && companyObj.hasOwnProperty('id')) {
        return this.request('GET', 'companies/' + companyObj.id + '/users', {}, cb);
    } else {
        return this.request('GET', 'companies', companyObj, cb);
    }
  };
  
  
  

  
  Intercom.prototype.listAdmins = function(adminObj, cb) {
    return this.request('GET', 'admins', adminObj, cb);
  };
  
  
  

  
  Intercom.prototype.createNote = function(noteObj, cb) {
    return this.request('POST', 'notes', noteObj, cb);
  };
  
  Intercom.prototype.listNotes = function(noteObj, cb) {
    return this.request('GET', 'notes', noteObj, cb);
  };
  
  Intercom.prototype.viewNote = function(noteObj, cb) {
    if (noteObj && noteObj.hasOwnProperty('id')) {
      return this.request('GET', 'notes/' + noteObj.id, {}, cb);
    } else {
      return this.request('GET', 'notes', noteObj, cb);
    }
  };
  
  
  

  
  Intercom.prototype.getTag = function(tagObj, cb) {
    return this.request('GET', 'tags', tagObj, cb);
  };
  
  Intercom.prototype.createTag = function(tagObj, cb) {
    return this.request('POST', 'tags', tagObj, cb);
  };
  
  Intercom.prototype.deleteTag = function(tagObj, cb) {
    return this.request('DELETE', 'tags/' + tagObj.id, {}, cb);
  };
  
  Intercom.prototype.updateTag = function(tagObj, cb) {
  
  

  
    return this.request('POST', 'tags', tagObj, cb);
  };
  
  
  

  
  Intercom.prototype.listSegments = function(segmentObj, cb) {
    return this.request('GET', 'segments', segmentObj, cb);
  };
  
  Intercom.prototype.viewSegment = function(segmentObj, cb) {
    if (segmentObj && segmentObj.hasOwnProperty('id')) {
      return this.request('GET', 'segments/' + segmentObj.id || segmentObj.segment_id, {}, cb);
    } else {
      return this.request('GET', 'segments', segmentObj, cb);
    }
  };
  
  
  

  
  Intercom.prototype.createEvent = function(eventObj, cb) {
    return this.request('POST', 'events', eventObj, cb);
  };
  
  
  

  
  Intercom.prototype.getCounts = function(countObj, cb) {
    return this.request('GET', 'counts', countObj, cb);
  };
  
  
  

  
  Intercom.prototype.createUserMessage = function(messageObj, cb) {
    return this.request('POST', 'messages', messageObj, cb);
  };
  
  Intercom.prototype.listConversations = function (convObj, cb) {
    return this.request('GET', 'conversations', convObj, cb);
  };
  
  Intercom.prototype.getConversation = function (convObj, cb) {
    if (convObj && convObj.hasOwnProperty('id')) {
      return this.request('GET', 'conversations/' + convObj.id, {}, cb);
    } else {
      return this.request('GET', 'conversations', convObj, cb);
    }
  };
  
  
  

  
  Intercom.prototype.replyConversation = function (convObj, cb) {
    if (convObj && convObj.hasOwnProperty('id')) {
      return this.request('POST', 'conversations/' + convObj.id + '/reply', convObj, cb);
    } else {
      return this.request('POST', 'conversations/last/reply', convObj, cb);
    }
  };
  
  

  
  Intercom.prototype.closeConversation = Intercom.prototype.replyConversation;
  
  Intercom.prototype.markConversationAsRead = function (convObj, cb) {
    if (convObj && convObj.hasOwnProperty('id')) {
      return this.request('PUT', 'conversations/' + convObj.id , convObj, cb);
    } else {
      return this.request('PUT', 'conversations/last', convObj, cb);
    }
  };
  
  
  

  
  module.exports = Intercom;