cisco-axl 1.1.3 → 1.1.5

package/examples/change_phone_model/changePhoneModel.js

@@ -23,6 +23,11 @@ let service = new axlService(
 (async () => {
   
   // Variable needed for script
+  var opts = {
+    clean: true,
+    removeAttributes: false,
+    dataContainerIdentifierTails: "_data",
+  };
 
   // What model are we going to convert our phone into?
   // You can get a list of models in CUCM with the SQL query: 'SELECT name from typemodel'
@@ -40,7 +45,7 @@ let service = new axlService(
   tags.name = phoneNameCopyingFrom;
 
   // Execute the AXL call. We set the true flag to clean the output (removes any blank or undefined settings)
-  var returnPhoneTags = await service.executeOperation(operation, tags, true);
+  var returnPhoneTags = await service.executeOperation(operation, tags, opts);
 
   // Now we're going to add a new phone based on the settings. We will updating a few new settings based on the model we will be converting to.
   operation = "addPhone";

package/examples/copy_phone/copyPhone.js

@@ -15,11 +15,17 @@ let service = new axlService(
 );
 
 (async () => {
+  var opts = {
+    clean: true,
+    removeAttributes: false,
+    dataContainerIdentifierTails: "_data",
+  };
+
   var operation = "getPhone";
   var tags = await service.getOperationTags(operation);
   tags.name = "CSFUSER001";
 
-  var returnPhoneTags = await service.executeOperation(operation, tags, true);
+  var returnPhoneTags = await service.executeOperation(operation, tags, opts);
 
   operation = "addPhone";
   returnPhoneTags.phone.name = "CSFWORDENJ";

package/examples/copy_sip_trunk/copySipTrunk.js

@@ -25,11 +25,13 @@ let service = new axlService(
 
   // Make a call to AXL to get the information for the trunk we are copying.
   // Note: we will be sending the clean flag to executeOperation. This will remove any keys in our return json that is empty, undefined or null.
-  var options = {
-    clean: true
+  var opts = {
+    clean: true,
+    removeAttributes: false,
+    dataContainerIdentifierTails: "_data",
   };
 
-  var returnTrunk = await service.executeOperation(operation, tags, options);
+  var returnTrunk = await service.executeOperation(operation, tags, opts);
 
   // Update the JSON with our new values
   operation = "addSipTrunk";

package/examples/templates/save_search_as_template/saveSearch.js

@@ -0,0 +1,52 @@
+const axlService = require("../../../index");
+const path = require("path");
+const fs = require("fs");
+
+/*
+
+This script will use getPhone to retrieve an existing phone and save as a JSON file. This file can then be edited to use as a template for other operations.
+
+*/
+
+// Set up new AXL service (DevNet sandbox credentials: https://devnetsandbox.cisco.com/)
+let service = new axlService(
+  "10.10.20.1",
+  "administrator",
+  "ciscopsdt",
+  "14.0"
+);
+
+(async () => {
+  var operation = "getPhone";
+  var tags = await service.getOperationTags(operation);
+  tags.name = "SEP112233445566";
+
+  // Options for executeOperation
+  var opts = {
+    clean: true, // Remove all null and empty tags
+    removeAttributes: true // Remove all attributes and uuid's
+  };
+
+  var returnPhoneTags = await service
+    .executeOperation(operation, tags, opts)
+    .catch((error) => {
+      console.log(error);
+    });
+
+  // Let's add some _data fields that we can use to add variables to our template.
+  returnPhoneTags._data = {
+    firstName: "Tom",
+    lastName: "Smith",
+  };
+
+  fs.writeFileSync(
+    path.resolve(__dirname, "template.json"),
+    JSON.stringify(returnPhoneTags, null, 2),
+    (err) => {
+      // throws an error, you could also catch it here
+      if (err) throw err;
+      // success case, the file was saved
+      console.log("Template saved!");
+    }
+  );
+})();

package/index.js

@@ -103,6 +103,7 @@ class axlService {
 
     var clean = opts?.clean ? opts.clean : false;
     var dataContainerIdentifierTails = opts?.dataContainerIdentifierTails ? opts.dataContainerIdentifierTails : '_data';
+    var removeAttributes = opts?.removeAttributes ? opts.removeAttributes : false;
      
     // Let's remove empty top level strings. Also filter out json-variables
     Object.keys(tags).forEach((k) => (tags[k] == '' || k.includes(dataContainerIdentifierTails)) && delete tags[k]);
@@ -132,7 +133,10 @@ class axlService {
             if (result?.hasOwnProperty("return")) {
               var output = result.return;
               if (clean) {
-                output = cleanObj(result.return);
+                cleanObj(output);
+              }
+              if(removeAttributes){
+                cleanAttributes(output);
               }
               resolve(output);
 
@@ -186,4 +190,22 @@ const cleanObj = (object) => {
   return object;
 };
 
+const cleanAttributes = (object) => {
+  Object.entries(object).forEach(([k, v]) => {
+    if (v && typeof v === "object") {
+      cleanAttributes(v);
+    }
+    if (
+      (v && typeof v === "object" && 'attributes' in object)
+    ) {
+      if (Array.isArray(object)) {
+        object.splice(k, 1);
+      } else {
+        delete object[k];
+      }
+    }
+  });
+  return object;
+};
+
 module.exports = axlService;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cisco-axl",
-  "version": "1.1.3",
+  "version": "1.1.5",
   "description": "A library to make Cisco AXL a lot easier",
   "main": "index.js",
   "scripts": {