@itentialopensource/adapter-robustel 0.1.1

package/adapter.js

@@ -0,0 +1,1660 @@
+/* @copyright Itential, LLC 2019 (pre-modifications) */
+
+/* eslint import/no-dynamic-require: warn */
+/* eslint object-curly-newline: warn */
+
+// Set globals
+/* global log */
+
+/* Required libraries.  */
+const path = require('path');
+const cryptoJS = require('crypto-js');
+const querystring = require('querystring');
+
+/* Fetch in the other needed components for the this Adaptor */
+const AdapterBaseCl = require(path.join(__dirname, 'adapterBase.js'));
+
+/**
+ * This is the adapter/interface into Robustel
+ */
+
+/* GENERAL ADAPTER FUNCTIONS */
+class Robustel extends AdapterBaseCl {
+  /**
+   * Robustel Adapter
+   * @constructor
+   */
+  /* Working on changing the way we do Emit methods due to size and time constrainsts
+  constructor(prongid, properties) {
+    // Instantiate the AdapterBase super class
+    super(prongid, properties);
+
+    const restFunctionNames = this.getWorkflowFunctions();
+
+    // Dynamically bind emit functions
+    for (let i = 0; i < restFunctionNames.length; i += 1) {
+      // Bind function to have name fnNameEmit for fnName
+      const version = restFunctionNames[i].match(/__v[0-9]+/);
+      const baseFnName = restFunctionNames[i].replace(/__v[0-9]+/, '');
+      const fnNameEmit = version ? `${baseFnName}Emit${version}` : `${baseFnName}Emit`;
+      this[fnNameEmit] = function (...args) {
+        // extract the callback
+        const callback = args[args.length - 1];
+        // slice the callback from args so we can insert our own
+        const functionArgs = args.slice(0, args.length - 1);
+        // create a random name for the listener
+        const eventName = `${restFunctionNames[i]}:${Math.random().toString(36)}`;
+        // tell the calling class to start listening
+        callback({ event: eventName, status: 'received' });
+        // store parent for use of this context later
+        const parent = this;
+        // store emission function
+        const func = function (val, err) {
+          parent.removeListener(eventName, func);
+          parent.emit(eventName, val, err);
+        };
+        // Use apply to call the function in a specific context
+        this[restFunctionNames[i]].apply(this, functionArgs.concat([func])); // eslint-disable-line prefer-spread
+      };
+    }
+
+    // Uncomment if you have things to add to the constructor like using your own properties.
+    // Otherwise the constructor in the adapterBase will be used.
+    // Capture my own properties - they need to be defined in propertiesSchema.json
+    // if (this.allProps && this.allProps.myownproperty) {
+    //   mypropvariable = this.allProps.myownproperty;
+    // }
+  }
+  */
+
+  /**
+   * @callback healthCallback
+   * @param {Object} reqObj - the request to send into the healthcheck
+   * @param {Callback} callback - The results of the call
+   */
+  healthCheck(reqObj, callback) {
+    // you can modify what is passed into the healthcheck by changing things in the newReq
+    let newReq = null;
+    if (reqObj) {
+      newReq = Object.assign(...reqObj);
+    }
+    super.healthCheck(newReq, callback);
+  }
+
+  /**
+   * @getWorkflowFunctions
+   */
+  getWorkflowFunctions(inIgnore) {
+    let myIgnore = ['getAuthorization', 'hasEntities', 'hasDevices'];
+    if (!inIgnore && Array.isArray(inIgnore)) {
+      myIgnore = inIgnore;
+    } else if (!inIgnore && typeof inIgnore === 'string') {
+      myIgnore = [inIgnore];
+    }
+
+    // The generic adapter functions should already be ignored (e.g. healthCheck)
+    // you can add specific methods that you do not want to be workflow functions to ignore like below
+    // myIgnore.push('myMethodNotInWorkflow');
+
+    return super.getWorkflowFunctions(myIgnore);
+  }
+
+  /**
+   * updateAdapterConfiguration is used to update any of the adapter configuration files. This
+   * allows customers to make changes to adapter configuration without having to be on the
+   * file system.
+   *
+   * @function updateAdapterConfiguration
+   * @param {string} configFile - the name of the file being updated (required)
+   * @param {Object} changes - an object containing all of the changes = formatted like the configuration file (required)
+   * @param {string} entity - the entity to be changed, if an action, schema or mock data file (optional)
+   * @param {string} type - the type of entity file to change, (action, schema, mock) (optional)
+   * @param {string} action - the action to be changed, if an action, schema or mock data file (optional)
+   * @param {Callback} callback - The results of the call
+   */
+  updateAdapterConfiguration(configFile, changes, entity, type, action, callback) {
+    const origin = `${this.id}-adapter-updateAdapterConfiguration`;
+    log.trace(origin);
+    super.updateAdapterConfiguration(configFile, changes, entity, type, action, callback);
+  }
+
+  /**
+   * See if the API path provided is found in this adapter
+   *
+   * @function findPath
+   * @param {string} apiPath - the api path to check on
+   * @param {Callback} callback - The results of the call
+   */
+  findPath(apiPath, callback) {
+    const origin = `${this.id}-adapter-findPath`;
+    log.trace(origin);
+    super.findPath(apiPath, callback);
+  }
+
+  /**
+    * @summary Suspends adapter
+    *
+    * @function suspend
+    * @param {Callback} callback - callback function
+    */
+  suspend(mode, callback) {
+    const origin = `${this.id}-adapter-suspend`;
+    log.trace(origin);
+    try {
+      return super.suspend(mode, callback);
+    } catch (error) {
+      log.error(`${origin}: ${error}`);
+      return callback(null, error);
+    }
+  }
+
+  /**
+    * @summary Unsuspends adapter
+    *
+    * @function unsuspend
+    * @param {Callback} callback - callback function
+    */
+  unsuspend(callback) {
+    const origin = `${this.id}-adapter-unsuspend`;
+    log.trace(origin);
+    try {
+      return super.unsuspend(callback);
+    } catch (error) {
+      log.error(`${origin}: ${error}`);
+      return callback(null, error);
+    }
+  }
+
+  /**
+    * @summary Get the Adaoter Queue
+    *
+    * @function getQueue
+    * @param {Callback} callback - callback function
+    */
+  getQueue(callback) {
+    const origin = `${this.id}-adapter-getQueue`;
+    log.trace(origin);
+    return super.getQueue(callback);
+  }
+
+  /**
+  * @summary Runs troubleshoot scripts for adapter
+  *
+  * @function troubleshoot
+  * @param {Object} props - the connection, healthcheck and authentication properties
+  *
+  * @param {boolean} persistFlag - whether the adapter properties should be updated
+  * @param {Callback} callback - The results of the call
+  */
+  troubleshoot(props, persistFlag, callback) {
+    const origin = `${this.id}-adapter-troubleshoot`;
+    log.trace(origin);
+    try {
+      return super.troubleshoot(props, persistFlag, this, callback);
+    } catch (error) {
+      log.error(`${origin}: ${error}`);
+      return callback(null, error);
+    }
+  }
+
+  /**
+    * @summary runs healthcheck script for adapter
+    *
+    * @function runHealthcheck
+    * @param {Adapter} adapter - adapter instance to troubleshoot
+    * @param {Callback} callback - callback function
+    */
+  runHealthcheck(callback) {
+    const origin = `${this.id}-adapter-runHealthcheck`;
+    log.trace(origin);
+    try {
+      return super.runHealthcheck(this, callback);
+    } catch (error) {
+      log.error(`${origin}: ${error}`);
+      return callback(null, error);
+    }
+  }
+
+  /**
+    * @summary runs connectivity check script for adapter
+    *
+    * @function runConnectivity
+    * @param {Callback} callback - callback function
+    */
+  runConnectivity(callback) {
+    const origin = `${this.id}-adapter-runConnectivity`;
+    log.trace(origin);
+    try {
+      return super.runConnectivity(callback);
+    } catch (error) {
+      log.error(`${origin}: ${error}`);
+      return callback(null, error);
+    }
+  }
+
+  /**
+    * @summary runs basicGet script for adapter
+    *
+    * @function runBasicGet
+    * @param {Callback} callback - callback function
+    */
+  runBasicGet(callback) {
+    const origin = `${this.id}-adapter-runBasicGet`;
+    log.trace(origin);
+    try {
+      return super.runBasicGet(callback);
+    } catch (error) {
+      log.error(`${origin}: ${error}`);
+      return callback(null, error);
+    }
+  }
+
+  /**
+   * @summary moves entites into Mongo DB
+   *
+   * @function moveEntitiesToDB
+   * @param {getCallback} callback - a callback function to return the result (Generics)
+   *                                  or the error
+   */
+  moveEntitiesToDB(callback) {
+    const origin = `${this.id}-adapter-moveEntitiesToDB`;
+    log.trace(origin);
+    try {
+      return super.moveEntitiesToDB(callback);
+    } catch (err) {
+      log.error(`${origin}: ${err}`);
+      return callback(null, err);
+    }
+  }
+
+  /**
+   * @summary Determines if this adapter supports the specific entity
+   *
+   * @function hasEntity
+   * @param {String} entityType - the entity type to check for
+   * @param {String/Array} entityId - the specific entity we are looking for
+   *
+   * @param {Callback} callback - An array of whether the adapter can has the
+   *                              desired capability or an error
+   */
+  hasEntity(entityType, entityId, callback) {
+    const origin = `${this.id}-adapter-hasEntity`;
+    log.trace(origin);
+
+    // Make the call -
+    // verifyCapability(entityType, actionType, entityId, callback)
+    return this.verifyCapability(entityType, null, entityId, callback);
+  }
+
+  /**
+   * @summary Provides a way for the adapter to tell north bound integrations
+   * whether the adapter supports type, action and specific entity
+   *
+   * @function verifyCapability
+   * @param {String} entityType - the entity type to check for
+   * @param {String} actionType - the action type to check for
+   * @param {String/Array} entityId - the specific entity we are looking for
+   *
+   * @param {Callback} callback - An array of whether the adapter can has the
+   *                              desired capability or an error
+   */
+  verifyCapability(entityType, actionType, entityId, callback) {
+    const meth = 'adapterBase-verifyCapability';
+    const origin = `${this.id}-${meth}`;
+    log.trace(origin);
+
+    // if caching
+    if (this.caching) {
+      // Make the call - verifyCapability(entityType, actionType, entityId, callback)
+      return this.requestHandlerInst.verifyCapability(entityType, actionType, entityId, (results, error) => {
+        if (error) {
+          return callback(null, error);
+        }
+
+        // if the cache needs to be updated, update and try again
+        if (results && results[0] === 'needupdate') {
+          switch (entityType) {
+            case 'template_entity': {
+              // if the cache is invalid, update the cache
+              return this.getEntities(null, null, null, null, (data, err) => {
+                if (err) {
+                  const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Could not update entity: $VARIABLE$, cache', [entityType], null, null, null);
+                  log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+                  return callback(null, errorObj);
+                }
+
+                // need to check the cache again since it has been updated
+                return this.requestHandlerInst.verifyCapability(entityType, actionType, entityId, (vcapable, verror) => {
+                  if (verror) {
+                    return callback(null, verror);
+                  }
+
+                  return this.capabilityResults(vcapable, callback);
+                });
+              });
+            }
+            default: {
+              // unsupported entity type
+              const result = [false];
+
+              // put false in array for all entities
+              if (Array.isArray(entityId)) {
+                for (let e = 1; e < entityId.length; e += 1) {
+                  result.push(false);
+                }
+              }
+
+              return callback(result);
+            }
+          }
+        }
+
+        // return the results
+        return this.capabilityResults(results, callback);
+      });
+    }
+
+    // if no entity id
+    if (!entityId) {
+      // need to check the cache again since it has been updated
+      return this.requestHandlerInst.verifyCapability(entityType, actionType, null, (vcapable, verror) => {
+        if (verror) {
+          return callback(null, verror);
+        }
+
+        return this.capabilityResults(vcapable, callback);
+      });
+    }
+
+    // if not caching
+    switch (entityType) {
+      case 'template_entity': {
+        // need to get the entities to check
+        return this.getEntities(null, null, null, null, (data, err) => {
+          if (err) {
+            const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Could not update entity: $VARIABLE$, cache', [entityType], null, null, null);
+            log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+            return callback(null, errorObj);
+          }
+
+          // need to check the cache again since it has been updated
+          return this.requestHandlerInst.verifyCapability(entityType, actionType, null, (vcapable, verror) => {
+            if (verror) {
+              return callback(null, verror);
+            }
+
+            // is the entity in the list?
+            const isEntity = this.entityInList(entityId, data.response, callback);
+            const res = [];
+
+            // not found
+            for (let i = 0; i < isEntity.length; i += 1) {
+              if (vcapable) {
+                res.push(isEntity[i]);
+              } else {
+                res.push(false);
+              }
+            }
+
+            return callback(res);
+          });
+        });
+      }
+      default: {
+        // unsupported entity type
+        const result = [false];
+
+        // put false in array for all entities
+        if (Array.isArray(entityId)) {
+          for (let e = 1; e < entityId.length; e += 1) {
+            result.push(false);
+          }
+        }
+
+        return callback(result);
+      }
+    }
+  }
+
+  /**
+   * @summary Updates the cache for all entities by call the get All entity method
+   *
+   * @function updateEntityCache
+   *
+   */
+  updateEntityCache() {
+    const origin = `${this.id}-adapter-updateEntityCache`;
+    log.trace(origin);
+
+    if (this.caching) {
+      // if the cache is invalid, update the cache
+      this.getEntities(null, null, null, null, (data, err) => {
+        if (err) {
+          log.trace(`${origin}: Could not load template_entity into cache - ${err}`);
+        }
+      });
+    }
+  }
+
+  /**
+   * Makes the requested generic call
+   *
+   * @function genericAdapterRequest
+   * @param {String} uriPath - the path of the api call - do not include the host, port, base path or version (required)
+   * @param {String} restMethod - the rest method (GET, POST, PUT, PATCH, DELETE) (required)
+   * @param {Object} queryData - the parameters to be put on the url (optional).
+   *                 Can be a stringified Object.
+   * @param {Object} requestBody - the body to add to the request (optional).
+   *                 Can be a stringified Object.
+   * @param {Object} addlHeaders - additional headers to be put on the call (optional).
+   *                 Can be a stringified Object.
+   * @param {getCallback} callback - a callback function to return the result (Generics)
+   *                 or the error
+   */
+  genericAdapterRequest(uriPath, restMethod, queryData, requestBody, addlHeaders, callback) {
+    const meth = 'adapter-genericAdapterRequest';
+    const origin = `${this.id}-${meth}`;
+    log.trace(origin);
+
+    if (this.suspended && this.suspendMode === 'error') {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'AD.600', [], null, null, null);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+
+    /* HERE IS WHERE YOU VALIDATE DATA */
+    if (uriPath === undefined || uriPath === null || uriPath === '') {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['uriPath'], null, null, null);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+    if (restMethod === undefined || restMethod === null || restMethod === '') {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['restMethod'], null, null, null);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+
+    /* HERE IS WHERE YOU SET THE DATA TO PASS INTO REQUEST */
+    // remove any leading / and split the uripath into path variables
+    let myPath = uriPath;
+    while (myPath.indexOf('/') === 0) {
+      myPath = myPath.substring(1);
+    }
+    const pathVars = myPath.split('/');
+    const queryParamsAvailable = queryData;
+    const queryParams = {};
+    const bodyVars = requestBody;
+
+    // loop in template. long callback arg name to avoid identifier conflicts
+    Object.keys(queryParamsAvailable).forEach((thisKeyInQueryParamsAvailable) => {
+      if (queryParamsAvailable[thisKeyInQueryParamsAvailable] !== undefined && queryParamsAvailable[thisKeyInQueryParamsAvailable] !== null
+          && queryParamsAvailable[thisKeyInQueryParamsAvailable] !== '') {
+        queryParams[thisKeyInQueryParamsAvailable] = queryParamsAvailable[thisKeyInQueryParamsAvailable];
+      }
+    });
+
+    let usePath = uriPath;
+    if (queryParams && Object.keys(queryParams).length > 0) {
+      usePath = `${uriPath}?${querystring(queryData)}`;
+    }
+    const callSign = this.getAuthorization(restMethod, usePath, bodyVars);
+
+    // if the callAuth was unsuccessful
+    if (callSign === -1) {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['call signature'], null, null, null);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+
+    // set up the request object - payload, uriPathVars, uriQuery, uriOptions, addlHeaders
+    const reqObj = {
+      payload: bodyVars,
+      uriPathVars: pathVars,
+      uriQuery: queryParams,
+      uriOptions: {},
+      addlHeaders: callSign
+    };
+    // add headers if provided
+    if (addlHeaders) {
+      reqObj.addlHeaders = addlHeaders;
+    }
+
+    // determine the call and return flag
+    let action = 'getGenerics';
+    let returnF = true;
+    if (restMethod.toUpperCase() === 'POST') {
+      action = 'createGeneric';
+    } else if (restMethod.toUpperCase() === 'PUT') {
+      action = 'updateGeneric';
+    } else if (restMethod.toUpperCase() === 'PATCH') {
+      action = 'patchGeneric';
+    } else if (restMethod.toUpperCase() === 'DELETE') {
+      action = 'deleteGeneric';
+      returnF = false;
+    }
+
+    try {
+      // Make the call -
+      // identifyRequest(entity, action, requestObj, returnDataFlag, callback)
+      return this.requestHandlerInst.identifyRequest('.generic', action, reqObj, returnF, (irReturnData, irReturnError) => {
+        // if we received an error or their is no response on the results
+        // return an error
+        if (irReturnError) {
+          /* HERE IS WHERE YOU CAN ALTER THE ERROR MESSAGE */
+          return callback(null, irReturnError);
+        }
+        if (!Object.hasOwnProperty.call(irReturnData, 'response')) {
+          const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Invalid Response', ['genericAdapterRequest'], null, null, null);
+          log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+          return callback(null, errorObj);
+        }
+
+        /* HERE IS WHERE YOU CAN ALTER THE RETURN DATA */
+        // return the response
+        return callback(irReturnData, null);
+      });
+    } catch (ex) {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Caught Exception', null, null, null, ex);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+  }
+
+  /* BROKER CALLS */
+  /**
+   * @summary Determines if this adapter supports any in a list of entities
+   *
+   * @function hasEntities
+   * @param {String} entityType - the entity type to check for
+   * @param {Array} entityList - the list of entities we are looking for
+   *
+   * @param {Callback} callback - A map where the entity is the key and the
+   *                              value is true or false
+   */
+  hasEntities(entityType, entityList, callback) {
+    const origin = `${this.id}-adapter-hasEntities`;
+    log.trace(origin);
+
+    switch (entityType) {
+      case 'Device':
+        return this.hasDevices(entityList, callback);
+      default:
+        return callback(null, `${this.id} does not support entity ${entityType}`);
+    }
+  }
+
+  /**
+   * @summary Helper method for hasEntities for the specific device case
+   *
+   * @param {Array} deviceList - array of unique device identifiers
+   * @param {Callback} callback - A map where the device is the key and the
+   *                              value is true or false
+   */
+  hasDevices(deviceList, callback) {
+    const origin = `${this.id}-adapter-hasDevices`;
+    log.trace(origin);
+
+    const findings = deviceList.reduce((map, device) => {
+      // eslint-disable-next-line no-param-reassign
+      map[device] = false;
+      log.debug(`In reduce: ${JSON.stringify(map)}`);
+      return map;
+    }, {});
+    const apiCalls = deviceList.map((device) => new Promise((resolve) => {
+      this.getDevice(device, (result, error) => {
+        if (error) {
+          log.debug(`In map error: ${JSON.stringify(device)}`);
+          return resolve({ name: device, found: false });
+        }
+        log.debug(`In map: ${JSON.stringify(device)}`);
+        return resolve({ name: device, found: true });
+      });
+    }));
+    Promise.all(apiCalls).then((results) => {
+      results.forEach((device) => {
+        findings[device.name] = device.found;
+      });
+      log.debug(`FINDINGS: ${JSON.stringify(findings)}`);
+      return callback(findings);
+    }).catch((errors) => {
+      log.error('Unable to do device lookup.');
+      return callback(null, { code: 503, message: 'Unable to do device lookup.', error: errors });
+    });
+  }
+
+  /**
+   * @summary Get Appliance that match the deviceName
+   *
+   * @function getDevice
+   * @param {String} deviceName - the deviceName to find (required)
+   *
+   * @param {getCallback} callback - a callback function to return the result
+   *                                 (appliance) or the error
+   */
+  getDevice(deviceName, callback) {
+    const meth = 'adapter-getDevice';
+    const origin = `${this.id}-${meth}`;
+    log.trace(origin);
+
+    if (this.suspended && this.suspendMode === 'error') {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'AD.600', [], null, null, null);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+
+    /* HERE IS WHERE YOU VALIDATE DATA */
+    if (deviceName === undefined || deviceName === null || deviceName === '' || deviceName.length === 0) {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['deviceName'], null, null, null);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+
+    try {
+      // need to get the device so we can convert the deviceName to an id
+      // !! if we can do a lookup by name the getDevicesFiltered may not be necessary
+      const opts = {
+        filter: {
+          name: deviceName
+        }
+      };
+      return this.getDevicesFiltered(opts, (devs, ferr) => {
+        // if we received an error or their is no response on the results return an error
+        if (ferr) {
+          return callback(null, ferr);
+        }
+        if (devs.list.length < 1) {
+          const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, `Did Not Find Device ${deviceName}`, [], null, null, null);
+          log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+          return callback(null, errorObj);
+        }
+        // get the uuid from the device
+        const { uuid } = devs.list[0];
+
+        // !! using Generic makes it easier on the Adapter Builder (just need to change the path)
+        // !! you can also replace with a specific call if that is easier
+        const uriPath = `/call/toget/device/${uuid}`;
+        return this.genericAdapterRequest(uriPath, 'GET', {}, {}, {}, (result, error) => {
+          // if we received an error or their is no response on the results return an error
+          if (error) {
+            return callback(null, error);
+          }
+          if (!result.response || !result.response.applianceMo) {
+            const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Invalid Response', ['getDevice'], null, null, null);
+            log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+            return callback(null, errorObj);
+          }
+
+          // return the response
+          // !! format the data we send back
+          // !! these fields are config manager fields you need to map to the data we receive
+          const thisDevice = result.response;
+          thisDevice.name = thisDevice.systemName;
+          thisDevice.ostype = `System-${thisDevice.systemType}`;
+          thisDevice.port = thisDevice.systemPort;
+          thisDevice.ipaddress = thisDevice.systemIP;
+          return callback(thisDevice);
+        });
+      });
+    } catch (ex) {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Caught Exception', null, null, null, ex);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+  }
+
+  /**
+   * @summary Get Appliances that match the filter
+   *
+   * @function getDevicesFiltered
+   * @param {Object} options - the data to use to filter the appliances (optional)
+   *
+   * @param {getCallback} callback - a callback function to return the result
+   *                                 (appliances) or the error
+   */
+  getDevicesFiltered(options, callback) {
+    const meth = 'adapter-getDevicesFiltered';
+    const origin = `${this.id}-${meth}`;
+    log.trace(origin);
+
+    // verify the required fields have been provided
+    if (options === undefined || options === null || options === '' || options.length === 0) {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['options'], null, null, null);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+    log.debug(`Device Filter Options: ${JSON.stringify(options)}`);
+
+    // TODO - get pagination working
+    // const nextToken = options.start;
+    // const maxResults = options.limit;
+
+    // set up the filter of Device Names
+    let filterName = [];
+    if (options && options.filter && options.filter.name) {
+      // when this hack is removed, remove the lint ignore above
+      if (Array.isArray(options.filter.name)) {
+        // eslint-disable-next-line prefer-destructuring
+        filterName = options.filter.name;
+      } else {
+        filterName = [options.filter.name];
+      }
+    }
+
+    // TODO - get sort and order working
+    /*
+    if (options && options.sort) {
+      reqObj.uriOptions.sort = JSON.stringify(options.sort);
+    }
+    if (options && options.order) {
+      reqObj.uriOptions.order = options.order;
+    }
+    */
+    try {
+      // !! using Generic makes it easier on the Adapter Builder (just need to change the path)
+      // !! you can also replace with a specific call if that is easier
+      const uriPath = '/call/toget/devices';
+      return this.genericAdapterRequest(uriPath, 'GET', {}, {}, {}, (result, error) => {
+        // if we received an error or their is no response on the results return an error
+        if (error) {
+          return callback(null, error);
+        }
+        if (!result.response) {
+          const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Invalid Response', ['getDevicesFiltered'], null, null, null);
+          log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+          return callback(null, errorObj);
+        }
+
+        // !! go through the response - may have to look for sub object
+        // handle an array of devices
+        if (Array.isArray(result.response)) {
+          const myDevices = [];
+
+          for (let d = 0; d < result.response.length; d += 1) {
+            // !! format the data we send back
+            // !! these fields are config manager fields you need to map to the data we receive
+            const thisDevice = result.response;
+            thisDevice.name = thisDevice.systemName;
+            thisDevice.ostype = `System-${thisDevice.systemType}`;
+            thisDevice.port = thisDevice.systemPort;
+            thisDevice.ipaddress = thisDevice.systemIP;
+
+            // if there is no filter - return the device
+            if (filterName.length === 0) {
+              myDevices.push(thisDevice);
+            } else {
+              // if we have to match a filter
+              let found = false;
+              for (let f = 0; f < filterName.length; f += 1) {
+                if (thisDevice.name.indexOf(filterName[f]) >= 0) {
+                  found = true;
+                  break;
+                }
+              }
+              // matching device
+              if (found) {
+                myDevices.push(thisDevice);
+              }
+            }
+          }
+          log.debug(`${origin}: Found #${myDevices.length} devices.`);
+          log.debug(`Devices: ${JSON.stringify(myDevices)}`);
+          return callback({ total: myDevices.length, list: myDevices });
+        }
+        // handle a single device response
+        // !! format the data we send back
+        // !! these fields are config manager fields you need to map to the data we receive
+        const thisDevice = result.response;
+        thisDevice.name = thisDevice.systemName;
+        thisDevice.ostype = `System-${thisDevice.systemType}`;
+        thisDevice.port = thisDevice.systemPort;
+        thisDevice.ipaddress = thisDevice.systemIP;
+
+        // if there is no filter - return the device
+        if (filterName.length === 0) {
+          log.debug(`${origin}: Found #1 device.`);
+          log.debug(`Device: ${JSON.stringify(thisDevice)}`);
+          return callback({ total: 1, list: [thisDevice] });
+        }
+
+        // if there is a filter need to check for matching device
+        let found = false;
+        for (let f = 0; f < filterName.length; f += 1) {
+          if (thisDevice.name.indexOf(filterName[f]) >= 0) {
+            found = true;
+            break;
+          }
+        }
+        // matching device
+        if (found) {
+          log.debug(`${origin}: Found #1 device.`);
+          log.debug(`Device Found: ${JSON.stringify(thisDevice)}`);
+          return callback({ total: 1, list: [thisDevice] });
+        }
+        // not a matching device
+        log.debug(`${origin}: No matching device found.`);
+        return callback({ total: 0, list: [] });
+      });
+    } catch (ex) {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Caught Exception', null, null, null, ex);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+  }
+
+  /**
+   * @summary Gets the status for the provided appliance
+   *
+   * @function isAlive
+   * @param {String} deviceName - the deviceName of the appliance. (required)
+   *
+   * @param {configCallback} callback - callback function to return the result
+   *                                    (appliance isAlive) or the error
+   */
+  isAlive(deviceName, callback) {
+    const meth = 'adapter-isAlive';
+    const origin = `${this.id}-${meth}`;
+    log.trace(origin);
+
+    // verify the required fields have been provided
+    if (deviceName === undefined || deviceName === null || deviceName === '' || deviceName.length === 0) {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['deviceName'], null, null, null);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+
+    try {
+      // need to get the device so we can convert the deviceName to an id
+      // !! if we can do a lookup by name the getDevicesFiltered may not be necessary
+      const opts = {
+        filter: {
+          name: deviceName
+        }
+      };
+      return this.getDevicesFiltered(opts, (devs, ferr) => {
+        // if we received an error or their is no response on the results return an error
+        if (ferr) {
+          return callback(null, ferr);
+        }
+        if (devs.list.length < 1) {
+          const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, `Did Not Find Device ${deviceName}`, [], null, null, null);
+          log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+          return callback(null, errorObj);
+        }
+        // get the uuid from the device
+        const { uuid } = devs.list[0];
+
+        // !! using Generic makes it easier on the Adapter Builder (just need to change the path)
+        // !! you can also replace with a specific call if that is easier
+        const uriPath = `/call/toget/status/${uuid}`;
+        return this.genericAdapterRequest(uriPath, 'GET', {}, {}, {}, (result, error) => {
+          // if we received an error or their is no response on the results return an error
+          if (error) {
+            return callback(null, error);
+          }
+          // !! should update this to make sure we are checking for the appropriate object/field
+          if (!result.response || !result.response.returnObj || !Object.hasOwnProperty.call(result.response.returnObj, 'statusField')) {
+            const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Invalid Response', ['isAlive'], null, null, null);
+            log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+            return callback(null, errorObj);
+          }
+
+          // !! return the response - Update to the appropriate object/field
+          return callback(!result.response.returnObj.statusField);
+        });
+      });
+    } catch (ex) {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Caught Exception', null, null, null, ex);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+  }
+
+  /**
+   * @summary Gets a config for the provided Appliance
+   *
+   * @function getConfig
+   * @param {String} deviceName - the deviceName of the appliance. (required)
+   * @param {String} format - the desired format of the config. (optional)
+   *
+   * @param {configCallback} callback - callback function to return the result
+   *                                    (appliance config) or the error
+   */
+  getConfig(deviceName, format, callback) {
+    const meth = 'adapter-getConfig';
+    const origin = `${this.id}-${meth}`;
+    log.trace(origin);
+
+    // verify the required fields have been provided
+    if (deviceName === undefined || deviceName === null || deviceName === '' || deviceName.length === 0) {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['deviceName'], null, null, null);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+
+    try {
+      // need to get the device so we can convert the deviceName to an id
+      // !! if we can do a lookup by name the getDevicesFiltered may not be necessary
+      const opts = {
+        filter: {
+          name: deviceName
+        }
+      };
+      return this.getDevicesFiltered(opts, (devs, ferr) => {
+        // if we received an error or their is no response on the results return an error
+        if (ferr) {
+          return callback(null, ferr);
+        }
+        if (devs.list.length < 1) {
+          const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, `Did Not Find Device ${deviceName}`, [], null, null, null);
+          log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+          return callback(null, errorObj);
+        }
+        // get the uuid from the device
+        const { uuid } = devs.list[0];
+
+        // !! using Generic makes it easier on the Adapter Builder (just need to change the path)
+        // !! you can also replace with a specific call if that is easier
+        const uriPath = `/call/toget/config/${uuid}`;
+        return this.genericAdapterRequest(uriPath, 'GET', {}, {}, {}, (result, error) => {
+          // if we received an error or their is no response on the results return an error
+          if (error) {
+            return callback(null, error);
+          }
+
+          // return the result
+          const newResponse = {
+            response: JSON.stringify(result.response, null, 2)
+          };
+          return callback(newResponse);
+        });
+      });
+    } catch (ex) {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Caught Exception', null, null, null, ex);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+  }
+
+  /**
+   * @summary Gets the device count from the system
+   *
+   * @function getCount
+   *
+   * @param {getCallback} callback - callback function to return the result
+   *                                    (count) or the error
+   */
+  getCount(callback) {
+    const meth = 'adapter-getCount';
+    const origin = `${this.id}-${meth}`;
+    log.trace(origin);
+
+    // verify the required fields have been provided
+
+    try {
+      // !! using Generic makes it easier on the Adapter Builder (just need to change the path)
+      // !! you can also replace with a specific call if that is easier
+      const uriPath = '/call/toget/count';
+      return this.genericAdapterRequest(uriPath, 'GET', {}, {}, {}, (result, error) => {
+        // if we received an error or their is no response on the results return an error
+        if (error) {
+          return callback(null, error);
+        }
+
+        // return the result
+        return callback({ count: result.response });
+      });
+    } catch (ex) {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Caught Exception', null, null, null, ex);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+  }
+
+  /**
+   * @callback healthCallback
+   * @param {Object} result - the result of the get request (contains an id and a status)
+   */
+  /**
+   * @callback getCallback
+   * @param {Object} result - the result of the get request (entity/ies)
+   * @param {String} error - any error that occurred
+   */
+  /**
+   * @callback createCallback
+   * @param {Object} item - the newly created entity
+   * @param {String} error - any error that occurred
+   */
+  /**
+   * @callback updateCallback
+   * @param {String} status - the status of the update action
+   * @param {String} error - any error that occurred
+   */
+  /**
+   * @callback deleteCallback
+   * @param {String} status - the status of the delete action
+   * @param {String} error - any error that occurred
+   */
+
+  /**
+   * @summary Gets the hcma authorization for the call
+   *
+   * @function getAuthorization
+   * @param {String} method - the method for the action we are setting authorization for
+   * @param {String} uripath - the path for the action we are setting authorization for
+   * @param {String} body - the body for the action we are setting authorization for
+   *
+   *  @return {Object} the headers to add to the request
+   */
+  getAuthorization(method, uripath, body) {
+    const origin = `${this.id}-adapter-getAuthorization`;
+    log.trace(origin);
+
+    // Account Info - properties (username, password)
+    const apiVersion = this.allProps.authentication.api_version;
+    const signatureVersion = this.allProps.authentication.signature_version;
+    const uniqueCode = this.allProps.authentication.unique_code;
+    const clientId = this.allProps.authentication.client_id;
+    const clisecret = this.allProps.authentication.client_secret;
+
+    // if missing accessId or accessKey
+    if (!apiVersion || !signatureVersion || !clientId || !uniqueCode || !clisecret) {
+      return -1;
+    }
+
+    let usePath = `${this.allProps.base_path}/${uripath}`;
+    usePath = usePath.replace(/\/\//g, '/');
+    let useQuery = '';
+
+    // need to extract the query from the uriPath
+    if (usePath.split('?').length === 2) {
+      const parts = usePath.split('?');
+      useQuery = `${parts[1]}`;
+      usePath = `${parts[0]}`;
+    }
+
+    // Get time + 10 seconds
+    // const epoch = (new Date()).getTime();
+    const epoch = (new Date()).getTime() + 10000;
+    // const moment = require('moment');
+    // const tepoch = moment().add(10, 'seconds').valueOf()
+
+    // add the timestamp into the result - will be added as headers
+    const result = {
+      apiVersion,
+      signatureVersion,
+      uniqueCode,
+      clientId,
+      timestamp: epoch
+    };
+
+    try {
+      let commandType = '';
+      if (body) {
+        commandType = `&${JSON.stringify(body)}`;
+      }
+      let canostring = `apiVersion=${apiVersion}&clientId=${clientId}&signatureVersion=${signatureVersion}&timestamp=${epoch}&uniqueCode=${uniqueCode}`;
+      if (useQuery) {
+        canostring = `apiVersion=${apiVersion}&clientId=${clientId}&${useQuery}&signatureVersion=${signatureVersion}&timestamp=${epoch}&uniqueCode=${uniqueCode}`;
+      }
+
+      // DO WE USE BODY ON A POST CALL
+      const stringtosign = method + usePath + canostring + commandType + clisecret;
+
+      // get the signature - HMAC256 and Hex
+      const accessKey = clientId + uniqueCode;
+      const sign = cryptoJS.HmacSHA256(stringtosign, accessKey);
+      const signHex = cryptoJS.enc.Hex.stringify(sign);
+      // const sign = crypto.createHmac('sha256', accessKey).update(stringtosign).digest('hex');
+      // const signHex = Buffer.from((sign).toString('base64'));
+
+      // add the signature into the result - will be added as headers
+      result.signature = signHex;
+      return result;
+    } catch (ex) {
+      log.error(`Took exception creating signature: ${ex}`);
+      return -1;
+    }
+  }
+
+  /**
+   * @function getDeviceTotal
+   * @pronghornType method
+   * @name getDeviceTotal
+   * @summary Get Device Total
+   *
+   * @param {getCallback} callback - a callback function to return the result
+   * @return {object} results - An object containing the response of the action
+   *
+   * @route {GET} /getDeviceTotal
+   * @roles admin
+   * @task true
+   */
+  /* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
+  getDeviceTotal(callback) {
+    const meth = 'adapter-getDeviceTotal';
+    const origin = `${this.id}-${meth}`;
+    log.trace(origin);
+
+    if (this.suspended && this.suspendMode === 'error') {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'AD.600', [], null, null, null);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+
+    /* HERE IS WHERE YOU VALIDATE DATA */
+
+    /* HERE IS WHERE YOU SET THE DATA TO PASS INTO REQUEST */
+    const queryParamsAvailable = {};
+    const queryParams = {};
+    const pathVars = [];
+    const bodyVars = {};
+    const callSign = this.getAuthorization('GET', '/dashboard/deviceTotal', null);
+
+    // if the callAuth was unsuccessful
+    if (callSign === -1) {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['call signature'], null, null, null);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+
+    // loop in template. long callback arg name to avoid identifier conflicts
+    Object.keys(queryParamsAvailable).forEach((thisKeyInQueryParamsAvailable) => {
+      if (queryParamsAvailable[thisKeyInQueryParamsAvailable] !== undefined && queryParamsAvailable[thisKeyInQueryParamsAvailable] !== null
+          && queryParamsAvailable[thisKeyInQueryParamsAvailable] !== '') {
+        queryParams[thisKeyInQueryParamsAvailable] = queryParamsAvailable[thisKeyInQueryParamsAvailable];
+      }
+    });
+
+    // set up the request object - payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, filter, priority, event
+    // see adapter code documentation for more information on the request object's fields
+    const reqObj = {
+      payload: bodyVars,
+      uriPathVars: pathVars,
+      uriQuery: queryParams,
+      addlHeaders: callSign
+    };
+
+    try {
+      // Make the call -
+      // identifyRequest(entity, action, requestObj, returnDataFlag, callback)
+      return this.requestHandlerInst.identifyRequest('Dashboard', 'getDeviceTotal', reqObj, true, (irReturnData, irReturnError) => {
+        // if we received an error or their is no response on the results
+        // return an error
+        if (irReturnError) {
+          /* HERE IS WHERE YOU CAN ALTER THE ERROR MESSAGE */
+          return callback(null, irReturnError);
+        }
+        if (!Object.hasOwnProperty.call(irReturnData, 'response')) {
+          const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Invalid Response', ['getDeviceTotal'], null, null, null);
+          log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+          return callback(null, errorObj);
+        }
+
+        /* HERE IS WHERE YOU CAN ALTER THE RETURN DATA */
+        // return the response
+        return callback(irReturnData, null);
+      });
+    } catch (ex) {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Caught Exception', null, null, null, ex);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+  }
+
+  /**
+   * @function getNetworkTotal
+   * @pronghornType method
+   * @name getNetworkTotal
+   * @summary Get Network Total
+   *
+   * @param {getCallback} callback - a callback function to return the result
+   * @return {object} results - An object containing the response of the action
+   *
+   * @route {GET} /getNetworkTotal
+   * @roles admin
+   * @task true
+   */
+  /* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
+  getNetworkTotal(callback) {
+    const meth = 'adapter-getNetworkTotal';
+    const origin = `${this.id}-${meth}`;
+    log.trace(origin);
+
+    if (this.suspended && this.suspendMode === 'error') {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'AD.600', [], null, null, null);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+
+    /* HERE IS WHERE YOU VALIDATE DATA */
+
+    /* HERE IS WHERE YOU SET THE DATA TO PASS INTO REQUEST */
+    const queryParamsAvailable = {};
+    const queryParams = {};
+    const pathVars = [];
+    const bodyVars = {};
+    const callSign = this.getAuthorization('GET', '/dashboard/networkTotal', null);
+
+    // if the callAuth was unsuccessful
+    if (callSign === -1) {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['call signature'], null, null, null);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+
+    // loop in template. long callback arg name to avoid identifier conflicts
+    Object.keys(queryParamsAvailable).forEach((thisKeyInQueryParamsAvailable) => {
+      if (queryParamsAvailable[thisKeyInQueryParamsAvailable] !== undefined && queryParamsAvailable[thisKeyInQueryParamsAvailable] !== null
+          && queryParamsAvailable[thisKeyInQueryParamsAvailable] !== '') {
+        queryParams[thisKeyInQueryParamsAvailable] = queryParamsAvailable[thisKeyInQueryParamsAvailable];
+      }
+    });
+
+    // set up the request object - payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, filter, priority, event
+    // see adapter code documentation for more information on the request object's fields
+    const reqObj = {
+      payload: bodyVars,
+      uriPathVars: pathVars,
+      uriQuery: queryParams,
+      addlHeaders: callSign
+    };
+
+    try {
+      // Make the call -
+      // identifyRequest(entity, action, requestObj, returnDataFlag, callback)
+      return this.requestHandlerInst.identifyRequest('Dashboard', 'getNetworkTotal', reqObj, true, (irReturnData, irReturnError) => {
+        // if we received an error or their is no response on the results
+        // return an error
+        if (irReturnError) {
+          /* HERE IS WHERE YOU CAN ALTER THE ERROR MESSAGE */
+          return callback(null, irReturnError);
+        }
+        if (!Object.hasOwnProperty.call(irReturnData, 'response')) {
+          const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Invalid Response', ['getNetworkTotal'], null, null, null);
+          log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+          return callback(null, errorObj);
+        }
+
+        /* HERE IS WHERE YOU CAN ALTER THE RETURN DATA */
+        // return the response
+        return callback(irReturnData, null);
+      });
+    } catch (ex) {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Caught Exception', null, null, null, ex);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+  }
+
+  /**
+   * @function getDeviceDetails
+   * @pronghornType method
+   * @name getDeviceDetails
+   * @summary Get Device Details
+   *
+   * @param {string} serialNumber - serial number
+   * @param {getCallback} callback - a callback function to return the result
+   * @return {object} results - An object containing the response of the action
+   *
+   * @route {POST} /getDeviceDetails
+   * @roles admin
+   * @task true
+   */
+  /* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
+  getDeviceDetails(serialNumber, callback) {
+    const meth = 'adapter-getDeviceDetails';
+    const origin = `${this.id}-${meth}`;
+    log.trace(origin);
+
+    if (this.suspended && this.suspendMode === 'error') {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'AD.600', [], null, null, null);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+
+    /* HERE IS WHERE YOU VALIDATE DATA */
+    if (serialNumber === undefined || serialNumber === null || serialNumber === '') {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['serialNumber'], null, null, null);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+
+    /* HERE IS WHERE YOU SET THE DATA TO PASS INTO REQUEST */
+    const queryParamsAvailable = {};
+    const queryParams = {};
+    const pathVars = [serialNumber];
+    const bodyVars = {};
+    const callSign = this.getAuthorization('GET', `/device/devices/${serialNumber}`, null);
+
+    // if the callAuth was unsuccessful
+    if (callSign === -1) {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['call signature'], null, null, null);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+
+    // loop in template. long callback arg name to avoid identifier conflicts
+    Object.keys(queryParamsAvailable).forEach((thisKeyInQueryParamsAvailable) => {
+      if (queryParamsAvailable[thisKeyInQueryParamsAvailable] !== undefined && queryParamsAvailable[thisKeyInQueryParamsAvailable] !== null
+          && queryParamsAvailable[thisKeyInQueryParamsAvailable] !== '') {
+        queryParams[thisKeyInQueryParamsAvailable] = queryParamsAvailable[thisKeyInQueryParamsAvailable];
+      }
+    });
+
+    // set up the request object - payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, filter, priority, event
+    // see adapter code documentation for more information on the request object's fields
+    const reqObj = {
+      payload: bodyVars,
+      uriPathVars: pathVars,
+      uriQuery: queryParams,
+      addlHeaders: callSign
+    };
+
+    try {
+      // Make the call -
+      // identifyRequest(entity, action, requestObj, returnDataFlag, callback)
+      return this.requestHandlerInst.identifyRequest('Device', 'getDeviceDetails', reqObj, true, (irReturnData, irReturnError) => {
+        // if we received an error or their is no response on the results
+        // return an error
+        if (irReturnError) {
+          /* HERE IS WHERE YOU CAN ALTER THE ERROR MESSAGE */
+          return callback(null, irReturnError);
+        }
+        if (!Object.hasOwnProperty.call(irReturnData, 'response')) {
+          const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Invalid Response', ['getDeviceDetails'], null, null, null);
+          log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+          return callback(null, errorObj);
+        }
+
+        /* HERE IS WHERE YOU CAN ALTER THE RETURN DATA */
+        // return the response
+        return callback(irReturnData, null);
+      });
+    } catch (ex) {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Caught Exception', null, null, null, ex);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+  }
+
+  /**
+   * @function getDeviceFirmwareList
+   * @pronghornType method
+   * @name getDeviceFirmwareList
+   * @summary Get Device Firmware List
+   *
+   * @param {string} serialNumber - device serial number
+   * @param {getCallback} callback - a callback function to return the result
+   * @return {object} results - An object containing the response of the action
+   *
+   * @route {POST} /getDeviceFirmwareList
+   * @roles admin
+   * @task true
+   */
+  /* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
+  getDeviceFirmwareList(serialNumber, callback) {
+    const meth = 'adapter-getDeviceFirmwareList';
+    const origin = `${this.id}-${meth}`;
+    log.trace(origin);
+
+    if (this.suspended && this.suspendMode === 'error') {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'AD.600', [], null, null, null);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+
+    /* HERE IS WHERE YOU VALIDATE DATA */
+    if (serialNumber === undefined || serialNumber === null || serialNumber === '') {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['serialNumber'], null, null, null);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+
+    /* HERE IS WHERE YOU SET THE DATA TO PASS INTO REQUEST */
+    const queryParamsAvailable = {};
+    const queryParams = {};
+    const pathVars = [serialNumber];
+    const bodyVars = {};
+    const callSign = this.getAuthorization('GET', `/devices/${serialNumber}/firmwares`, null);
+
+    // if the callAuth was unsuccessful
+    if (callSign === -1) {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['call signature'], null, null, null);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+
+    // loop in template. long callback arg name to avoid identifier conflicts
+    Object.keys(queryParamsAvailable).forEach((thisKeyInQueryParamsAvailable) => {
+      if (queryParamsAvailable[thisKeyInQueryParamsAvailable] !== undefined && queryParamsAvailable[thisKeyInQueryParamsAvailable] !== null
+          && queryParamsAvailable[thisKeyInQueryParamsAvailable] !== '') {
+        queryParams[thisKeyInQueryParamsAvailable] = queryParamsAvailable[thisKeyInQueryParamsAvailable];
+      }
+    });
+
+    // set up the request object - payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, filter, priority, event
+    // see adapter code documentation for more information on the request object's fields
+    const reqObj = {
+      payload: bodyVars,
+      uriPathVars: pathVars,
+      uriQuery: queryParams,
+      addlHeaders: callSign
+    };
+
+    try {
+      // Make the call -
+      // identifyRequest(entity, action, requestObj, returnDataFlag, callback)
+      return this.requestHandlerInst.identifyRequest('Device', 'getDeviceFirmwareList', reqObj, true, (irReturnData, irReturnError) => {
+        // if we received an error or their is no response on the results
+        // return an error
+        if (irReturnError) {
+          /* HERE IS WHERE YOU CAN ALTER THE ERROR MESSAGE */
+          return callback(null, irReturnError);
+        }
+        if (!Object.hasOwnProperty.call(irReturnData, 'response')) {
+          const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Invalid Response', ['getDeviceFirmwareList'], null, null, null);
+          log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+          return callback(null, errorObj);
+        }
+
+        /* HERE IS WHERE YOU CAN ALTER THE RETURN DATA */
+        // return the response
+        return callback(irReturnData, null);
+      });
+    } catch (ex) {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Caught Exception', null, null, null, ex);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+  }
+
+  /**
+   * @function runCommandOnDevice
+   * @pronghornType method
+   * @name runCommandOnDevice
+   * @summary Run Command on Device
+   *
+   * @param {} serialNumber - device serial number
+   * @param {object} body - { commandType: , softwareVersionId: }
+   * @param {getCallback} callback - a callback function to return the result
+   * @return {object} results - An object containing the response of the action
+   *
+   * @route {POST} /runCommandOnDevice
+   * @roles admin
+   * @task true
+   */
+  /* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
+  runCommandOnDevice(serialNumber, body, callback) {
+    const meth = 'adapter-runCommandOnDevice';
+    const origin = `${this.id}-${meth}`;
+    log.trace(origin);
+
+    if (this.suspended && this.suspendMode === 'error') {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'AD.600', [], null, null, null);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+
+    /* HERE IS WHERE YOU VALIDATE DATA */
+    if (serialNumber === undefined || serialNumber === null || serialNumber === '') {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['serialNumber'], null, null, null);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+    if (body === undefined || body === null || body === '') {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['body'], null, null, null);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+
+    /* HERE IS WHERE YOU SET THE DATA TO PASS INTO REQUEST */
+    const queryParamsAvailable = {};
+    const queryParams = {};
+    const pathVars = [serialNumber];
+    const bodyVars = body;
+    const callSign = this.getAuthorization('PUT', `/devices/${serialNumber}`, bodyVars);
+
+    // if the callAuth was unsuccessful
+    if (callSign === -1) {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['call signature'], null, null, null);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+
+    // loop in template. long callback arg name to avoid identifier conflicts
+    Object.keys(queryParamsAvailable).forEach((thisKeyInQueryParamsAvailable) => {
+      if (queryParamsAvailable[thisKeyInQueryParamsAvailable] !== undefined && queryParamsAvailable[thisKeyInQueryParamsAvailable] !== null
+          && queryParamsAvailable[thisKeyInQueryParamsAvailable] !== '') {
+        queryParams[thisKeyInQueryParamsAvailable] = queryParamsAvailable[thisKeyInQueryParamsAvailable];
+      }
+    });
+
+    // set up the request object - payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, filter, priority, event
+    // see adapter code documentation for more information on the request object's fields
+    const reqObj = {
+      payload: bodyVars,
+      uriPathVars: pathVars,
+      uriQuery: queryParams,
+      addlHeaders: callSign
+    };
+
+    try {
+      // Make the call -
+      // identifyRequest(entity, action, requestObj, returnDataFlag, callback)
+      return this.requestHandlerInst.identifyRequest('Device', 'runCommandOnDevice', reqObj, true, (irReturnData, irReturnError) => {
+        // if we received an error or their is no response on the results
+        // return an error
+        if (irReturnError) {
+          /* HERE IS WHERE YOU CAN ALTER THE ERROR MESSAGE */
+          return callback(null, irReturnError);
+        }
+        if (!Object.hasOwnProperty.call(irReturnData, 'response')) {
+          const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Invalid Response', ['runCommandOnDevice'], null, null, null);
+          log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+          return callback(null, errorObj);
+        }
+
+        /* HERE IS WHERE YOU CAN ALTER THE RETURN DATA */
+        // return the response
+        return callback(irReturnData, null);
+      });
+    } catch (ex) {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Caught Exception', null, null, null, ex);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+  }
+
+  /**
+   * @function getFirmwareUpdateResult
+   * @pronghornType method
+   * @name getFirmwareUpdateResult
+   * @summary Get Firmware Update Result
+   *
+   * @param {string} commandId - commandId
+   * @param {getCallback} callback - a callback function to return the result
+   * @return {object} results - An object containing the response of the action
+   *
+   * @route {POST} /getFirmwareUpdateResult
+   * @roles admin
+   * @task true
+   */
+  /* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
+  getFirmwareUpdateResult(commandId, callback) {
+    const meth = 'adapter-getFirmwareUpdateResult';
+    const origin = `${this.id}-${meth}`;
+    log.trace(origin);
+
+    if (this.suspended && this.suspendMode === 'error') {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'AD.600', [], null, null, null);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+
+    /* HERE IS WHERE YOU VALIDATE DATA */
+    if (commandId === undefined || commandId === null || commandId === '') {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['commandId'], null, null, null);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+
+    /* HERE IS WHERE YOU SET THE DATA TO PASS INTO REQUEST */
+    const queryParamsAvailable = {};
+    const queryParams = {};
+    const pathVars = [commandId];
+    const bodyVars = {};
+    const callSign = this.getAuthorization('GET', `/command/${commandId}`, null);
+
+    // if the callAuth was unsuccessful
+    if (callSign === -1) {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['call signature'], null, null, null);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+
+    // loop in template. long callback arg name to avoid identifier conflicts
+    Object.keys(queryParamsAvailable).forEach((thisKeyInQueryParamsAvailable) => {
+      if (queryParamsAvailable[thisKeyInQueryParamsAvailable] !== undefined && queryParamsAvailable[thisKeyInQueryParamsAvailable] !== null
+          && queryParamsAvailable[thisKeyInQueryParamsAvailable] !== '') {
+        queryParams[thisKeyInQueryParamsAvailable] = queryParamsAvailable[thisKeyInQueryParamsAvailable];
+      }
+    });
+
+    // set up the request object - payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, filter, priority, event
+    // see adapter code documentation for more information on the request object's fields
+    const reqObj = {
+      payload: bodyVars,
+      uriPathVars: pathVars,
+      uriQuery: queryParams,
+      addlHeaders: callSign
+    };
+
+    try {
+      // Make the call -
+      // identifyRequest(entity, action, requestObj, returnDataFlag, callback)
+      return this.requestHandlerInst.identifyRequest('Device', 'getFirmwareUpdateResult', reqObj, true, (irReturnData, irReturnError) => {
+        // if we received an error or their is no response on the results
+        // return an error
+        if (irReturnError) {
+          /* HERE IS WHERE YOU CAN ALTER THE ERROR MESSAGE */
+          return callback(null, irReturnError);
+        }
+        if (!Object.hasOwnProperty.call(irReturnData, 'response')) {
+          const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Invalid Response', ['getFirmwareUpdateResult'], null, null, null);
+          log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+          return callback(null, errorObj);
+        }
+
+        /* HERE IS WHERE YOU CAN ALTER THE RETURN DATA */
+        // return the response
+        return callback(irReturnData, null);
+      });
+    } catch (ex) {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Caught Exception', null, null, null, ex);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+  }
+}
+
+module.exports = Robustel;