@kiina/node-zendesk/lib/client/views.js

zendesk API client wrapper

//Views.js: Client for the zendesk API.


var util        = require('util'),
    Client      = require('./client').Client;

var Views = exports.Views = function (options) {
  this.jsonAPINames = [ 'views', 'view' ];
  Client.call(this, options);
};

// Inherit from Client base object
util.inherits(Views, Client);

// ######################################################## Views
// ====================================== Listing Views
Views.prototype.list = function (cb) {
  return this.requestAll('GET', ['views'], cb);//all
};

// ====================================== Listing Active Views
Views.prototype.listActive = function (cb) {
  return this.requestAll('GET', ['views', 'active'], cb);//all
};

// GET /api/v2/views/compact.json
// A compacted list of shared and personal views available to the current user
Views.prototype.listCompact = function (cb) {
  return this.requestAll('GET', ['views', 'compact'], cb);//all
};

// ====================================== Viewing Views
Views.prototype.show = function (viewID, cb) {
  return this.request('GET', ['views', viewID], cb);
};

// Create View
// POST /api/v2/views.json
Views.prototype.create = function (view, cb) {
  return this.request('POST', ['views'], view, cb);
};

// Update View
// PUT /api/v2/views/{id}.json
Views.prototype.update = function (viewID, viewData, cb) {
  return this.request('PUT', ['views', viewID], viewData, cb);
};

// Executing Views
// GET /api/v2/views/{id}/execute.json
// :params can be http://developer.zendesk.com/documentation/rest_api/views.html#previewing-views
Views.prototype.execute = function (viewID, params, cb) {
  return this.requestAll('GET', ['views', viewID, 'execute', params], cb);
};

// Getting Tickets from a view
// GET /api/v2/views/{id}/tickets.json
Views.prototype.tickets = function (viewID, cb) {
  return this.requestAll('GET', ['views', viewID, 'tickets'], cb);
};

// Previewing Views
// POST /api/v2/views/preview.json
// :params can be http://developer.zendesk.com/documentation/rest_api/views.html#previewing-views
Views.prototype.preview = function (params, cb) {
  return this.requestAll('POST', ['views', 'preview'], params, cb);
};

Views.prototype.showCount = function (viewID, cb) {
  return this.request('GET', ['views', viewID, 'count'], cb);
};

Views.prototype.showCounts = function (viewIDs, cb) {
  return this.request('GET', ['views', 'count_many', {ids: viewIDs}], cb);
};

// Exporting Views
// GET /api/v2/views/{id}/export.json
Views.prototype.export = function (viewID, cb) {
  return this.request('GET', ['views', viewID, 'export'], cb);
};