@natterstefan/toggl-api/lib/api/projects.js

Toggl API for Node.js

'use strict';

var TogglClient = require('../client');
var utils = require('../utils');


/**
 * @see https://github.com/toggl/toggl_api_docs/blob/master/chapters/projects.md#create-project
 * @public
 * @param {Object} data New project data
 * @param {Function} callback <code>(err, projectData)</code>
 */
TogglClient.prototype.createProject = function createProject(data, callback) {
  if (!this.validateOptions('project-create', data, callback)) {
    return;
  }

  var req = {
    method: 'POST',
    body: {
      project: data
    }
  };

  this.apiRequest('/api/v8/projects', req, utils.wrapDataCallback(callback));
};


/**
 * @see https://github.com/toggl/toggl_api_docs/blob/master/chapters/projects.md#delete-a-project
 * @public
 * @param {Number|String} projectId Project ID
 * @param {Function} callback <code>(err)</code>
 */
TogglClient.prototype.deleteProject = function deleteProject(projectId,
  callback) {
  var req = {
    method: 'DELETE'
  };

  this.apiRequest('/api/v8/projects/' + projectId, req, callback);
};


/**
 * @see https://github.com/toggl/toggl_api_docs/blob/master/chapters/projects.md#delete-multiple-projects
 * @public
 * @param {Number[]|String[]} projectIds Project IDs
 * @param {Function} callback <code>(err)</code>
 */
TogglClient.prototype.deleteProjects = function deleteProjects(projectIds,
  callback) {
  if (arguments.length > 2 || !Array.isArray(projectIds)) {
    projectIds = [].slice.call(arguments, 0);
    callback = projectIds.pop();
  }

  this.deleteProject(projectIds.join(), callback);
};


/**
 * @see https://github.com/toggl/toggl_api_docs/blob/master/chapters/projects.md#get-project-data
 * @public
 * @param {Number|String} projectId Project ID
 * @param {Function} callback <code>(err, projectData)</code>
 */
TogglClient.prototype.getProjectData = function getProjectData(projectId,
  callback) {
  this.apiRequest('/api/v8/projects/' + projectId, {},
    utils.wrapDataCallback(callback));
};


/**
 * @see https://github.com/toggl/toggl_api_docs/blob/master/chapters/projects.md#get-project-tasks
 * @public
 * @param {Number|String} projectId Project ID
 * @param {Function} callback <code>(err, tasks)</code>
 */
TogglClient.prototype.getProjectTasks = function getProjectTasks(projectId,
  callback) {
  this.apiRequest('/api/v8/projects/' + projectId + '/tasks', {}, callback);
};


/**
 * @see https://github.com/toggl/toggl_api_docs/blob/master/chapters/projects.md#get-project-users
 * @public
 * @param {Number|String} projectId Project ID
 * @param {Function} callback <code>(err, users)</code>
 */
TogglClient.prototype.getProjectUsers = function getProjectUsers(projectId,
  callback) {
  this.apiRequest('/api/v8/projects/' + projectId + '/project_users', {}, callback);
};


/**
 * @see https://github.com/toggl/toggl_api_docs/blob/master/chapters/projects.md#update-project-data
 * @public
 * @param {Number|String} projectId project ID
 * @param {Object} data Project data
 * @param {Function} callback <code>(err, projectData)</code>
 */
TogglClient.prototype.updateProject = function updateProject(projectId, data,
  callback) {
  var req = {
    method: 'PUT',
    body: {
      project: data
    }
  };

  this.apiRequest('/api/v8/projects/' + projectId, req,
    utils.wrapDataCallback(callback));
};