Source

sites.js

  1. const common = require('./common');
  3. /**
  4.  * A module related to xMatters sites.<br><br>
  5.  * {@link https://help.xmatters.com/xmapi/index.html#sites}
  6.  *
  7.  * @module sites
  8.  */
  10. /**
  11.  * Get a site from xMatters<br><br>
  12.  *
  13.  * {@link https://help.xmatters.com/xmapi/index.html#get-a-site}
  14.  *
  15.  * @param {module:environments.xMattersEnvironment} env The xmtoolbox representation of an xMatters instance.
  16.  * @param {string} siteId The unique identifier (id) or name (name) of the site.<br><br>
  17.  * Examples:<br>
  18.  * - London Building B2
  19.  * - b2341d69-8b83-4660-b8c8-f2e728f675f9<br>
  20.  * @param {Object} query A json object representing the query string parameters for this request.
  21.  * @returns {Promise<Site>} Site Object Requested
  22.  */
  23. async function get(env, siteId, query, throwError) {
  24.   return common.get(env, '/api/xm/1/sites/', siteId, query, 'Site', throwError);
  25. }
  27. /**
  28.  * Get all sites from xMatters matching the query. Please refer to the link below for the available query parameters.<br><br>
  29.  *
  30.  * {@link https://help.xmatters.com/xmapi/index.html#get-sites}
  31.  *
  32.  * @param {module:environments.xMattersEnvironment} env The xmtoolbox representation of an xMatters instance.
  33.  * @param {Object} query A json object representing the query string parameters for this request.
  34.  * @returns {Promise<Site[]>} Array of Site Objects Requested
  35.  */
  36. async function getMany(env, query) {
  37.   return common.getMany(env, '/api/xm/1/sites', query, 'Sites');
  38. }
  40. /**
  41.  * Create a site in xMatters<br><br>
  42.  *
  43.  * {@link https://help.xmatters.com/xmapi/index.html#create-a-site}
  44.  *
  45.  * @param {module:environments.xMattersEnvironment} env The xmtoolbox representation of an xMatters instance.
  46.  * @param {Site} site {@link https://help.xmatters.com/xmapi/index.html#site-object}
  47.  * @returns {Promise<Site>} Site Object Created
  48.  */
  49. async function create(env, site) {
  50.   return common.create(env, '/api/xm/1/sites', site, 'Site', true);
  51. }
  53. /**
  54.  * Update a site in xMatters<br><br>
  55.  *
  56.  * {@link https://help.xmatters.com/xmapi/index.html#modify-or-update-a-site}
  57.  *
  58.  * @param {module:environments.xMattersEnvironment} env The xmtoolbox representation of an xMatters instance.
  59.  * @param {Site} site {@link https://help.xmatters.com/xmapi/index.html#site-object}
  60.  * @param {string} siteId The unique identifier (id) for the site.<br><br>
  61.  * Examples:<br>
  62.  * - b2341d69-8b83-4660-b8c8-f2e728f675f9<br>
  63.  * @returns {Promise<Site>} Site Object Updated
  64.  */
  65. async function update(env, site, siteId) {
  66.   return common.update(env, '/api/xm/1/sites/', site, siteId, 'Site');
  67. }
  69. /**
  70.  * Delete a site in xMatters<br><br>
  71.  *
  72.  * {@link https://help.xmatters.com/xmapi/index.html#delete-a-site}
  73.  * @param {module:environments.xMattersEnvironment} env The xmtoolbox representation of an xMatters instance.
  74.  * @param {string} siteId The unique identifier (id) or name (name) of the site.<br><br>
  75.  * Examples:<br>
  76.  * - London Building B2
  77.  * - b2341d69-8b83-4660-b8c8-f2e728f675f9<br>
  78.  * @returns {Promise}
  79.  * @name delete
  80.  */
  81. async function _delete(env, siteId) {
  82.   return common.delete(env, '/api/xm/1/sites/', siteId, 'Site');
  83. }
  85. /**
  86.  * Transforms an array of records exported from xMatters to the format needed to import into xMatters.
  87.  * @param {module:environments.xMattersEnvironment} destination The xmtoolbox representation of the target or destination xMatters instance.
  88.  * @param {Site[]} sites Array of site objects to transform.
  89.  * @returns {Promise}
  90.  */
  91. async function exportToImport(destination, sites) {
  92.   return common.convertDefaultInitial(sites, convert);
  94.   function convert(site) {
  95.     {
  96.       {
  97.         if (site.latitude) site.latitude = Number(site.latitude);
  98.         if (site.longitude) site.longitude = Number(site.longitude);
  99.         return site;
  100.       }
  101.     }
  102.   }
  103. }
  105. /**
  106.  * The key values from the object that can be synchronized.
  107.  */
  108. const fields = [
  109.   //'id',
  110.   'name',
  111.   'country',
  112.   'language',
  113.   'timezone',
  114.   //'externallyOwned',
  115.   'status',
  116.   'address1',
  117.   'address2',
  118.   'postalCode',
  119.   'postalCode',
  120.   'city',
  121.   'state',
  122.   'country',
  123.   'latitude',
  124.   'longitude',
  125. ];
  127. /**
  128.  * Synchronizes an array of objects from a source with destination objects and updates the destination as necessary.
  129.  * @param {module:environments.xMattersEnvironment} destination The xmtoolbox representation of the target or destination xMatters instance.
  130.  * @param {Site[]} sourceSites An array of the site objects to synchronize from the source data.
  131.  * @param {Site[]} destinationSites An array of the site objects to synchronize from the destination data.
  132.  * @param {Object} options
  133.  */
  134. async function sync(destination, sourceSites, destinationSites, options) {
  135.   return common.syncObject(
  136.     'Site',
  137.     sourceSites,
  138.     destinationSites,
  139.     destination,
  140.     'name',
  141.     fields,
  142.     create,
  143.     update,
  144.     _delete,
  145.     options
  146.   );
  147. }
  149. module.exports = {
  150.   get,
  151.   getMany,
  152.   create,
  153.   update,
  154.   delete: _delete,
  155.   exportToImport,
  156.   fields,
  157.   sync,
  158. };