paydunya/lib/invoice.js

PAYDUNYA Node.JS Library

/**
 * Invoice class
 * @param {object} setup Instance of paydunya.Setup
 * @param {object} store Instance of paydunya.Store
 */
function Invoice(setup, store){
  // validate input
  if (!(setup && store && setup.config['PAYDUNYA-MASTER-KEY'] && setup.config['PAYDUNYA-PRIVATE-KEY'] && setup.config['PAYDUNYA-TOKEN'] && store.name)) {
    throw new Error('Invalid parameters;');
  }

  this.baseURL = setup.baseURL;
  this.config = setup.config;

  if (store.return_url) this.returnURL = store.return_url;
  if (store.cancel_url) this.cancelURL = store.cancel_url;
  if (store.callback_url) this.callbackURL = store.callback_url;

  this.store = store;
  this.description = '';
  this.items = {};
  this.customData = {};
  this.taxes = {};
  this.channels = [];
  this.totalAmount = 0;
}


/**
 * Add an item to invoice
 * @param {string} name
 * @param {number} quantity
 * @param {number} unitPrice
 * @param {number} totalPrice
 * @param {string} description
 */
Invoice.prototype.addItem = function (name, quantity, unitPrice, totalPrice, description) {
  if (!name) throw new Error('Invalid parameters; name is required.');
  var position = Object.keys(this.items).length + 1;
  this.items['item_' + position] = {
    name: name,
    quantity: quantity || 0,
    unit_price: unitPrice || 0,
    total_price: totalPrice || 0
  }
  if (description) this.items['item_' + position].description = description;
};

/**
 * Add a tax
 * @param {string} name
 * @param {number} amount [description]
 */
Invoice.prototype.addTax = function (name, amount){
  if (!(name && typeof name === 'string' && typeof Number(amount) === 'number'))
    throw new Error('Invalid parameters.');
  var position = Object.keys(this.taxes).length + 1;
  this.taxes['tax_' + position] = {
    name: name,
    amount: Number(amount)
  };
};

/**
 * Add a payment channel
 * @param {string} channel
 */
Invoice.prototype.addChannel = function (channel){
  if (!(channel && typeof channel === 'string'))
    throw new Error('Invalid parameters.');
  this.channels.push(channel);
};

/**
 * Add many payment channels at once
 * @param {array} channels
 */
Invoice.prototype.addChannels = function (channels){
  if (!(channels && channels instanceof Array))
    throw new Error('Invalid parameters.');
  this.channels = [];
  for (var i = 0; i < channels.length; i++) {
    this.channels.push(channels[i]);
  }
};

/**
 * Add custom data key, value pairs to request
 * @param {string} title key
 * @param {string} value
 */
Invoice.prototype.addCustomData = function (title, value) {
  if (!(title && value)) throw new Error('Invalid parameters.');

  this.customData[title] = value;
};

/**
 * Generate the request body
 * @return {object}
 */
Invoice.prototype.generateRequestBody = function () {
  if (!(this.store && this.store.name && this.baseURL && this.totalAmount > 0))
    throw new Error("Invalid parameters. Initialize Invoice with valid instances of Setup and Store. Total amount must also be set.\neg: var invoice = new Invoice; invoice.init(setup, store); invoice.setTotalAmount(40)");

  var body = {
    invoice: {
      total_amount: this.totalAmount
    },
    store: this.store
  };
  if (this.description) body.invoice.description = this.description;
  if (Object.keys(this.channels).length > 0) body.invoice.channels = this.channels;
  if (Object.keys(this.items).length > 0) body.invoice.items = this.items;
  if (this.returnURL || this.cancelURL || this.callbackURL) {
    body.actions = {};
    if (this.returnURL) body.actions.return_url = this.returnURL;
    if (this.cancelURL) body.actions.cancel_url = this.cancelURL;
    if (this.callbackURL) body.actions.callback_url = this.callbackURL;
  }
  if (Object.keys(this.taxes).length > 0) body.invoice.taxes = this.taxes;
  if (Object.keys(this.customData).length > 0) body.custom_data = this.customData;

  return body;
};

module.exports = Invoice;