@itentialopensource/adapter-aruba_airwave 0.1.1 → 0.2.1

package/CHANGELOG.md

@@ -1,4 +1,20 @@
 
+## 0.2.1 [01-09-2023]
+
+* Fixed entity paths and updated package-lock
+
+See merge request itentialopensource/adapters/controller-orchestrator/adapter-aruba_airwave!2
+
+---
+
+## 0.2.0 [11-03-2022]
+
+* Add new call
+
+See merge request itentialopensource/adapters/controller-orchestrator/adapter-aruba_airwave!1
+
+---
+
 ## 0.1.1 [10-31-2022]
 
 * Bug fixes and performance improvements
@@ -6,4 +22,3 @@
 See commit 365fc74
 
 ---
-

package/adapter.js

@@ -1111,6 +1111,87 @@ class ArubaAirwave extends AdapterBaseCl {
     }
   }
 
+  /**
+   * @function moveDeviceToGroup
+   * @pronghornType method
+   * @name moveDeviceToGroup
+   * @summary Move device
+   * @param {Object} body - device_id, group_name, group_id
+   * @param {getCallback} callback - a callback function to return the result
+   * @return {object} results - An object containing the response of the action
+   *
+   * @route {PUT} /moveDeviceToGroup
+   * @roles admin
+   * @task true
+   */
+  /* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
+  moveDeviceToGroup(body, callback) {
+    const meth = 'adapter-moveDeviceToGroup';
+    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 (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 = [];
+    const bodyVars = body;
+
+    // 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
+    };
+
+    try {
+      // Make the call -
+      // identifyRequest(entity, action, requestObj, returnDataFlag, callback)
+      return this.requestHandlerInst.identifyRequest('DeviceAPIS', 'moveDeviceToGroup', 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', ['moveDeviceToGroup'], 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 aPLog
    * @pronghornType method

package/entities/DeviceAPIS/action.json

@@ -4,7 +4,7 @@
       "name": "deleteDevice",
       "protocol": "REST",
       "method": "DELETE",
-      "entitypath": "{base_path}/{version}/delete_device?{query}",
+      "entitypath": "{base_path}/{version}/api/delete_device?{query}",
       "requestSchema": "schema.json",
       "responseSchema": "schema.json",
       "timeout": 0,
@@ -25,7 +25,28 @@
       "name": "moveDeviceToFolder",
       "protocol": "REST",
       "method": "PUT",
-      "entitypath": "{base_path}/{version}/move_to_folder?{query}",
+      "entitypath": "{base_path}/{version}/api/move_to_folder?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "moveDeviceToGroup",
+      "protocol": "REST",
+      "method": "PUT",
+      "entitypath": "{base_path}/{version}/api/move_to_group?{query}",
       "requestSchema": "schema.json",
       "responseSchema": "schema.json",
       "timeout": 0,

package/entities/DeviceAPIS/schema.json

@@ -11,7 +11,8 @@
       "default": "aPSearch",
       "enum": [
         "deleteDevice",
-        "moveDeviceToFolder"
+        "moveDeviceToFolder",
+        "moveDeviceToGroup"
       ],
       "external_name": "ph_request_type"
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itentialopensource/adapter-aruba_airwave",
-  "version": "0.1.1",
+  "version": "0.2.1",
   "description": "This adapter integrates with system described as: Aruba Airwave",
   "main": "adapter.js",
   "wizardVersion": "2.43.5",

package/pronghorn.json

@@ -516,6 +516,41 @@
       },
       "task": true
     },
+    {
+      "name": "moveDeviceToGroup",
+      "summary": "Move device",
+      "description": "Move a device with device ID from one group to another group with group ID or group name in AirWave",
+      "input": [
+        {
+          "name": "body",
+          "type": "object",
+          "info": "device_id, group_name, group_id",
+          "description": "device_id, group_name, group_id",
+          "schema": {
+            "title": "body",
+            "type": "object"
+          },
+          "required": true
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "PUT",
+        "path": "/moveDeviceToGroup"
+      },
+      "task": true
+    },
     {
       "name": "aPLog",
       "summary": "AP Log",