Source: shoppers.js

  1. /*jshint -W069 */
  2. /**
  3.  * 
  4.  * @class shoppers
  5.  * @param {(string|object)} [domainOrOptions] - The project domain or options object. If object, see the object's optional properties.
  6.  * @param {string} [domainOrOptions.domain] - The project domain
  7.  * @param {object} [domainOrOptions.token] - auth token - object with value property and optional headerOrQueryName and isQuery properties
  8.  */
  9. var shoppers = (function() {
  10.     'use strict';
  12.     var request = require('request');
  13.     var Q = require('q');
  15.     function shoppers(options) {
  16.         var domain = (typeof options === 'object') ? options.domain : options;
  17.         this.domain = domain ? domain : 'https://api.godaddy.com';
  18.         if (this.domain.length === 0) {
  19.             throw new Error('Domain parameter must be specified as a string.');
  20.         }
  21.         this.token = (typeof options === 'object') ? (options.token ? options.token : {}) : {};
  22.     }
  24.     /**
  25.      * Set Token
  26.      * @method
  27.      * @name shoppers#setToken
  28.      * @param {string} value - token's value
  29.      * @param {string} headerOrQueryName - the header or query name to send the token at
  30.      * @param {boolean} isQuery - true if send the token as query param, otherwise, send as header param
  31.      *
  32.      */
  33.     shoppers.prototype.setToken = function(value, headerOrQueryName, isQuery) {
  34.         this.token.value = value;
  35.         this.token.headerOrQueryName = headerOrQueryName;
  36.         this.token.isQuery = isQuery;
  37.     };
  39.     /**
  40.      * Update details for the specified Shopper
  41.      * @method
  42.      * @name shoppers#update
  43.      * @param {string} shopperId - The ID of the Shopper to update
  44.      * @param {ShopperUpdate} shopper - The Shopper details to update
  45.      * 
  46.      */
  47.     shoppers.prototype.update = function(parameters) {
  48.         if (parameters === undefined) {
  49.             parameters = {};
  50.         }
  51.         var deferred = Q.defer();
  53.         var domain = this.domain;
  54.         var path = '/v1/shoppers/{shopperId}';
  56.         var body;
  57.         var queryParameters = {};
  58.         var headers = {};
  59.         var form = {};
  61.         if (this.token.isQuery) {
  62.             queryParameters[this.token.headerOrQueryName] = this.token.value;
  63.         } else if (this.token.headerOrQueryName) {
  64.             headers[this.token.headerOrQueryName] = this.token.value;
  65.         } else {
  66.             headers['Authorization'] = 'Bearer ' + this.token.value;
  67.         }
  69.         path = path.replace('{shopperId}', parameters['shopperId']);
  71.         if (parameters['shopperId'] === undefined) {
  72.             deferred.reject(new Error('Missing required path parameter: shopperId'));
  73.             return deferred.promise;
  74.         }
  76.         if (parameters['shopper'] !== undefined) {
  77.             body = parameters['shopper'];
  78.         }
  80.         if (parameters['shopper'] === undefined) {
  81.             deferred.reject(new Error('Missing required body parameter: shopper'));
  82.             return deferred.promise;
  83.         }
  85.         if (parameters.$queryParameters) {
  86.             Object.keys(parameters.$queryParameters)
  87.                 .forEach(function(parameterName) {
  88.                     var parameter = parameters.$queryParameters[parameterName];
  89.                     queryParameters[parameterName] = parameter;
  90.                 });
  91.         }
  93.         var req = {
  94.             method: 'POST',
  95.             uri: domain + path,
  96.             qs: queryParameters,
  97.             headers: headers,
  98.             body: body
  99.         };
  100.         if (Object.keys(form).length > 0) {
  101.             req.form = form;
  102.         }
  103.         if (typeof(body) === 'object' && !(body instanceof Buffer)) {
  104.             req.json = true;
  105.         }
  106.         request(req, function(error, response, body) {
  107.             if (error) {
  108.                 deferred.reject(error);
  109.             } else {
  110.                 if (/^application\/(.*\\+)?json/.test(response.headers['content-type'])) {
  111.                     try {
  112.                         body = JSON.parse(body);
  113.                     } catch (e) {
  115.                     }
  116.                 }
  117.                 if (response.statusCode === 204) {
  118.                     deferred.resolve({
  119.                         response: response
  120.                     });
  121.                 } else if (response.statusCode >= 200 && response.statusCode <= 299) {
  122.                     deferred.resolve({
  123.                         response: response,
  124.                         body: body
  125.                     });
  126.                 } else {
  127.                     deferred.reject({
  128.                         response: response,
  129.                         body: body
  130.                     });
  131.                 }
  132.             }
  133.         });
  135.         return deferred.promise;
  136.     };
  137.     /**
  138.      * Get details for the specified Shopper
  139.      * @method
  140.      * @name shoppers#get
  141.      * @param {string} shopperId - Shopper whose details are to be retrieved
  142.      * 
  143.      */
  144.     shoppers.prototype.get = function(parameters) {
  145.         if (parameters === undefined) {
  146.             parameters = {};
  147.         }
  148.         var deferred = Q.defer();
  150.         var domain = this.domain;
  151.         var path = '/v1/shoppers/{shopperId}';
  153.         var body;
  154.         var queryParameters = {};
  155.         var headers = {};
  156.         var form = {};
  158.         if (this.token.isQuery) {
  159.             queryParameters[this.token.headerOrQueryName] = this.token.value;
  160.         } else if (this.token.headerOrQueryName) {
  161.             headers[this.token.headerOrQueryName] = this.token.value;
  162.         } else {
  163.             headers['Authorization'] = 'Bearer ' + this.token.value;
  164.         }
  166.         path = path.replace('{shopperId}', parameters['shopperId']);
  168.         if (parameters['shopperId'] === undefined) {
  169.             deferred.reject(new Error('Missing required path parameter: shopperId'));
  170.             return deferred.promise;
  171.         }
  173.         if (parameters.$queryParameters) {
  174.             Object.keys(parameters.$queryParameters)
  175.                 .forEach(function(parameterName) {
  176.                     var parameter = parameters.$queryParameters[parameterName];
  177.                     queryParameters[parameterName] = parameter;
  178.                 });
  179.         }
  181.         var req = {
  182.             method: 'GET',
  183.             uri: domain + path,
  184.             qs: queryParameters,
  185.             headers: headers,
  186.             body: body
  187.         };
  188.         if (Object.keys(form).length > 0) {
  189.             req.form = form;
  190.         }
  191.         if (typeof(body) === 'object' && !(body instanceof Buffer)) {
  192.             req.json = true;
  193.         }
  194.         request(req, function(error, response, body) {
  195.             if (error) {
  196.                 deferred.reject(error);
  197.             } else {
  198.                 if (/^application\/(.*\\+)?json/.test(response.headers['content-type'])) {
  199.                     try {
  200.                         body = JSON.parse(body);
  201.                     } catch (e) {
  203.                     }
  204.                 }
  205.                 if (response.statusCode === 204) {
  206.                     deferred.resolve({
  207.                         response: response
  208.                     });
  209.                 } else if (response.statusCode >= 200 && response.statusCode <= 299) {
  210.                     deferred.resolve({
  211.                         response: response,
  212.                         body: body
  213.                     });
  214.                 } else {
  215.                     deferred.reject({
  216.                         response: response,
  217.                         body: body
  218.                     });
  219.                 }
  220.             }
  221.         });
  223.         return deferred.promise;
  224.     };
  225.     /**
  226.      * Create a Subaccount owned by the authenticated Reseller
  227.      * @method
  228.      * @name shoppers#createSubaccount
  229.      * @param {SubaccountCreate} subaccount - The subaccount to create
  230.      * 
  231.      */
  232.     shoppers.prototype.createSubaccount = function(parameters) {
  233.         if (parameters === undefined) {
  234.             parameters = {};
  235.         }
  236.         var deferred = Q.defer();
  238.         var domain = this.domain;
  239.         var path = '/v1/shoppers/subaccount';
  241.         var body;
  242.         var queryParameters = {};
  243.         var headers = {};
  244.         var form = {};
  246.         if (this.token.isQuery) {
  247.             queryParameters[this.token.headerOrQueryName] = this.token.value;
  248.         } else if (this.token.headerOrQueryName) {
  249.             headers[this.token.headerOrQueryName] = this.token.value;
  250.         } else {
  251.             headers['Authorization'] = 'Bearer ' + this.token.value;
  252.         }
  254.         if (parameters['subaccount'] !== undefined) {
  255.             body = parameters['subaccount'];
  256.         }
  258.         if (parameters['subaccount'] === undefined) {
  259.             deferred.reject(new Error('Missing required body parameter: subaccount'));
  260.             return deferred.promise;
  261.         }
  263.         if (parameters.$queryParameters) {
  264.             Object.keys(parameters.$queryParameters)
  265.                 .forEach(function(parameterName) {
  266.                     var parameter = parameters.$queryParameters[parameterName];
  267.                     queryParameters[parameterName] = parameter;
  268.                 });
  269.         }
  271.         var req = {
  272.             method: 'POST',
  273.             uri: domain + path,
  274.             qs: queryParameters,
  275.             headers: headers,
  276.             body: body
  277.         };
  278.         if (Object.keys(form).length > 0) {
  279.             req.form = form;
  280.         }
  281.         if (typeof(body) === 'object' && !(body instanceof Buffer)) {
  282.             req.json = true;
  283.         }
  284.         request(req, function(error, response, body) {
  285.             if (error) {
  286.                 deferred.reject(error);
  287.             } else {
  288.                 if (/^application\/(.*\\+)?json/.test(response.headers['content-type'])) {
  289.                     try {
  290.                         body = JSON.parse(body);
  291.                     } catch (e) {
  293.                     }
  294.                 }
  295.                 if (response.statusCode === 204) {
  296.                     deferred.resolve({
  297.                         response: response
  298.                     });
  299.                 } else if (response.statusCode >= 200 && response.statusCode <= 299) {
  300.                     deferred.resolve({
  301.                         response: response,
  302.                         body: body
  303.                     });
  304.                 } else {
  305.                     deferred.reject({
  306.                         response: response,
  307.                         body: body
  308.                     });
  309.                 }
  310.             }
  311.         });
  313.         return deferred.promise;
  314.     };
  316.     return shoppers;
  317. })();
  319. exports.shoppers = shoppers;