@stackfactor/client-api 1.0.1 → 1.0.2

package/lib/departmentTrainingPlans.js

@@ -1,6 +1,6 @@
-import axios from "./axios";
+const axios = require("./axios");
 
-export default {
+module.exports = {
   axios: axios,
 
   /**
@@ -10,7 +10,7 @@ export default {
    * @param {Array<Object>} activities
    * @param {String} token Authorization token
    */
-  createDepartmentTrainingPlan(name, summary, skill, activities, token) {
+  createDepartmentTrainingPlan: (name, summary, skill, activities, token) => {
     return new Promise(function (resolve, reject) {
       const requestData = {
         name: name ? name : "",
@@ -40,7 +40,7 @@ export default {
    * @param {String} id The id of the template to be deleted
    * @param {String} token Authorization token
    */
-  deleteDepartmentTrainingPlan(id, token) {
+  deleteDepartmentTrainingPlan: (id, token) => {
     return new Promise(function (resolve, reject) {
       const request = axios.delete(`api/v1/departmenttrainingplans/`, {
         headers: { authorization: token },
@@ -60,10 +60,10 @@ export default {
 
   /**
    * Get department traing plan information
-   * @param {number} id The id of the plan
+   * @param {Number} id The id of the plan
    * @param {String} token Authorization token
    */
-  getDepartmentTrainingPlanInformationById(id, version, token) {
+  getDepartmentTrainingPlanInformationById: (id, version, token) => {
     return new Promise(function (resolve, reject) {
       let confirmationRequest = axios.get(
         `api/v1/departmenttrainingplans/${id}/${version}`,
@@ -86,7 +86,7 @@ export default {
    * @param {Object} filter The filter used to select the plan
    * @param {String} token Authorization token
    */
-  getDepartmentTrainingPlanList(filter, version, token) {
+  getDepartmentTrainingPlanList: (filter, version, token) => {
     return new Promise(function (resolve, reject) {
       const requestData = {
         filter: filter ? filter : "",
@@ -114,7 +114,7 @@ export default {
    * @param {number} id The id of the plan to be published
    * @param {String} token Authorization token
    */
-  publishDepartmentTrainingPlan(id, token) {
+  publishDepartmentTrainingPlan: (id, token) => {
     return new Promise(function (resolve, reject) {
       let confirmationRequest = axios.post(
         `api/v1/departmenttrainingplans/publish/${id}`,
@@ -139,7 +139,7 @@ export default {
    * @param {Object} data Data used to update the plan
    * @param {String} token Authorization token
    */
-  setDepartmentTrainingPlanInformation(id, data, token) {
+  setDepartmentTrainingPlanInformation: (id, data, token) => {
     return new Promise(function (resolve, reject) {
       const requestData = {
         data: data,

package/lib/groups.js

@@ -1,9 +1,6 @@
-//
-// Group sepcific requests
-//
-import axios from "./axios";
+const axios = require("./axios");
 
-export default {
+module.exports = {
   axios: axios,
 
   /**
@@ -12,7 +9,7 @@ export default {
    * @param {Array<String>} permissions The permissions to be added
    * @param {String} authToken - Authentication token
    */
-  addPermissionsToGroup(groupId, permissions, authToken) {
+  addPermissionsToGroup: (groupId, permissions, authToken) => {
     return new Promise(function (resolve, reject) {
       const request = axios.post(
         `api/v1/groups/permissions/add`,
@@ -38,7 +35,7 @@ export default {
    * @param {Array<String>} users The users to be added
    * @param {String} authToken - Authentication token
    */
-  addUsersToGroup(groupId, users, authToken) {
+  addUsersToGroup: (groupId, users, authToken) => {
     return new Promise(function (resolve, reject) {
       const request = axios.post(
         `api/v1/groups/users/add`,
@@ -64,7 +61,7 @@ export default {
    * @param {String} description The description of the group
    * @param {String} authToken The authorization token
    */
-  createGroup(name, description, authToken) {
+  createGroup: (name, description, authToken) => {
     return new Promise(function (resolve, reject) {
       const request = axios.post(
         `api/v1/groups/group`,
@@ -90,7 +87,7 @@ export default {
    * @param {String} defaultGroupId The default group all the users will be moved to
    * @param {String} authToken The authentication token
    */
-  deleteGroup(groupId, defaultGroupId, authToken) {
+  deleteGroup: (groupId, defaultGroupId, authToken) => {
     return new Promise(function (resolve, reject) {
       const request = axios.delete(`api/v1/groups/delete`, {
         headers: { authorization: authToken },
@@ -111,10 +108,9 @@ export default {
 
   /**
    * Get all permissions
-   *
    * @param {String} authToken The authentication token
    */
-  getAllPermissions(authToken) {
+  getAllPermissions: (authToken) => {
     return new Promise(function (resolve, reject) {
       const request = axios.get(`api/v1/groups/permissions/getAllPermissions`, {
         headers: { authorization: authToken },
@@ -131,10 +127,10 @@ export default {
 
   /**
    * Get group by Id
-   * @param {*} groupId The group Id
+   * @param {String} groupId The group Id
    * @param {String} authToken The authentication token
    */
-  getGroupById(groupId, authToken) {
+  getGroupById: (groupId, authToken) => {
     return new Promise(function (resolve, reject) {
       const request = axios.get(`api/v1/groups/group/${groupId}`, {
         headers: { authorization: authToken },
@@ -151,9 +147,9 @@ export default {
 
   /**
    * Get groups for current tenant
-   * @param {*} authToken The authentication token
+   * @param {String} authToken The authentication token
    */
-  getGroups(authToken) {
+  getGroups: (authToken) => {
     return new Promise(function (resolve, reject) {
       const request = axios.get(`api/v1/groups/`, {
         headers: { authorization: authToken },
@@ -170,9 +166,9 @@ export default {
 
   /**
    * Get current user permissions
-   * @param {*} authToken The authentication token
+   * @param {String} authToken The authentication token
    */
-  getUserPermissions(authToken) {
+  getUserPermissions: (authToken) => {
     return new Promise(function (resolve, reject) {
       const request = axios.get(`api/v1/groups/users/getuserpermissions`, {
         headers: { authorization: authToken },
@@ -214,7 +210,7 @@ export default {
    * @param {Array<String>} permissions The permissions to be removed from the group
    * @param {String} authToken The authentication token
    */
-  removePermissionsFromGroup(groupId, permissions, authToken) {
+  removePermissionsFromGroup: (groupId, permissions, authToken) => {
     return new Promise(function (resolve, reject) {
       const request = axios.post(
         `api/v1/groups/permissions/remove/`,
@@ -240,7 +236,7 @@ export default {
    * @param {Array<String>} users The users to be removed from the group
    * @param {String} authToken The authentication token
    */
-  removeUsersFromGroup(groupId, users, authToken) {
+  removeUsersFromGroup: (groupId, users, authToken) => {
     return new Promise(function (resolve, reject) {
       const request = axios.post(
         `api/v1/groups/users/remove/`,
@@ -265,7 +261,7 @@ export default {
    * @param {String} groupId The group Id
    * @param {String} authToken The authentication token
    */
-  setDefault(groupId, authToken) {
+  setDefault: (groupId, authToken) => {
     return new Promise(function (resolve, reject) {
       const request = axios.put(
         `api/v1/groups/setDefault/`,
@@ -287,11 +283,11 @@ export default {
   /**
    * Update group
    * @param {String} groupId The group Id
-   * @param {string} name The updated name of the group
-   * @param {string} description The updated description of the group
+   * @param {String} name The updated name of the group
+   * @param {String} description The updated description of the group
    * @param {String} authToken The authentication token
    */
-  updateGroup(groupId, name, description, authToken) {
+  updateGroup: (groupId, name, description, authToken) => {
     return new Promise(function (resolve, reject) {
       const request = axios.patch(
         `api/v1/groups/group/`,

package/lib/integration.js

@@ -1,18 +1,18 @@
-/* eslint-disable no-undef */
-import axios, { errorToString } from "./axios";
-import axiosLib from "axios";
-import htmlParser from "node-html-parser";
-import htmlToText from "html2plaintext";
+const axios = require("./axios");
+const errorToString = axios.errorToString;
+const axiosLib = require("axios");
+const htmlParser = require("node-html-parser");
+const htmlToText = require("html2plaintext");
 
-export default {
+module.exports = {
   axios: axios,
 
   /**
    * Create integration and set information
-   * @param {object} data The new integration information
+   * @param {Object} data The new integration information
    * @param {String} token Authorization token
    */
-  createIntegration(data, token) {
+  createIntegration: (data, token) => {
     return new Promise(function (resolve, reject) {
       const requestData = {
         data: data,
@@ -35,7 +35,7 @@ export default {
    * @param {String} id The id of the integration to be deleted
    * @param {String} token Authorization token
    */
-  deleteIntegration(id, token) {
+  deleteIntegration: (id, token) => {
     return new Promise(function (resolve, reject) {
       const request = axios.delete(`api/v1/integrations/`, {
         headers: { authorization: token },
@@ -58,7 +58,7 @@ export default {
    * @param {String} id The id of the role template to be deleted
    * @param {String} token Authorization token
    */
-  discardIntegrationChanges(id, token) {
+  discardIntegrationChanges: (id, token) => {
     return new Promise(function (resolve, reject) {
       const data = {};
       const request = axios.get(`api/v1/integrations/discard/${id}`, {
@@ -81,7 +81,7 @@ export default {
    * @param {String} version The version of the integration to be received
    * @param {String} token Authorization token
    */
-  getIntegrationInformationById(id, version, token) {
+  getIntegrationInformationById: (id, version, token) => {
     return new Promise(function (resolve, reject) {
       let confirmationRequest = axios.get(
         `api/v1/integrations/${id}/${version}`,
@@ -107,13 +107,13 @@ export default {
    * @param {Boolean} includeSupportedCapabilities If true, the supported capabilities will be included in the response
    * @param {String} token Authorization token
    */
-  getIntegrationsList(
+  getIntegrationsList: (
     filter,
     type,
     version,
     includeSupportedCapabilities,
     token
-  ) {
+  ) => {
     return new Promise(function (resolve, reject) {
       const requestData = {
         includeSupportedCapabilities: includeSupportedCapabilities,
@@ -140,7 +140,7 @@ export default {
    * @param {String} verb The verb
    * @param {String} token Authorization token
    */
-  getContentInformationByUrl(url, verb, token) {
+  getContentInformationByUrl: (url, verb, token) => {
     return new Promise(function (resolve, reject) {
       const requestData = {
         url: url,
@@ -163,8 +163,12 @@ export default {
     });
   },
 
-  //get content information by url from the browser instead of the backend
-  getContentInformationByUrlFromBrowser(url) {
+  /**
+   * Get content information by url from the browser instead of the backend
+   * @param {String} url
+   * @returns {Object}
+   */
+  getContentInformationByUrlFromBrowser: (url) => {
     return new Promise(function (resolve, reject) {
       let domain = new URL(url);
       let instance = axiosLib.create({
@@ -241,7 +245,7 @@ export default {
    * @param {String} verb The verb
    * @param {String} token Authorization token
    */
-  getEnabledContentProviders(userId, token) {
+  getEnabledContentProviders: (userId, token) => {
     return new Promise(function (resolve, reject) {
       let confirmationRequest = axios.get(
         `api/v1/contentproviders/getenabledcontentproviders/${userId}`,
@@ -264,7 +268,7 @@ export default {
    * @param {String} id The id of the integration to be published
    * @param {String} token Authorization token
    */
-  publishIntegration(id, token) {
+  publishIntegration: (id, token) => {
     return new Promise(function (resolve, reject) {
       let confirmationRequest = axios.post(
         `api/v1/integrations/publish/${id}`,
@@ -289,7 +293,7 @@ export default {
    * @param {Object} data Data used to update the integration
    * @param {String} token Authorization token
    */
-  setIntegrationInformation(id, data, token) {
+  setIntegrationInformation: (id, data, token) => {
     return new Promise(function (resolve, reject) {
       const requestData = {
         data: data,
@@ -316,7 +320,7 @@ export default {
    * @param {String} id The id of the integration to be set as default
    * @param {String} token Authorization token
    */
-  setDefaultIntegration(id, token) {
+  setDefaultIntegration: (id, token) => {
     return new Promise(function (resolve, reject) {
       let confirmationRequest = axios.post(
         `api/v1/integrations/${id}/default`,

package/lib/integrationConfiguration.js

@@ -1,15 +1,15 @@
-import axios from "./axios";
+const axios = require("./axios");
 
 export default {
   axios: axios,
 
   /**
    * Get the integration configuration
-   * @param {[String]} ids
+   * @param {Array<String>} ids
    * @param {Number} type
    * @param {String} token Authorization token
    */
-  getIntegrationsConfiguration(ids, type, token) {
+  getIntegrationsConfiguration: (ids, type, token) => {
     return new Promise(function (resolve, reject) {
       let requestData = { type: type };
       if (ids) requestData.ids = ids;
@@ -37,7 +37,7 @@ export default {
    * @param {Object} configuration Data used to update the integration configuration
    * @param {String} token Authorization token
    */
-  saveIntegrationConfiguration(id, type, configuration, token) {
+  saveIntegrationConfiguration: (id, type, configuration, token) => {
     return new Promise(function (resolve, reject) {
       const requestData = {
         id: id,
@@ -68,7 +68,7 @@ export default {
    * @param {Object} configuration Configuration to be tested
    * @param {String} token Authorization token
    */
-  testIntegrationConfiguration(id, type, configuration, token) {
+  testIntegrationConfiguration: (id, type, configuration, token) => {
     return new Promise(function (resolve, reject) {
       const requestData = {
         id: id,

package/lib/integrations/contentgenerator.js

@@ -1,5 +1,4 @@
-/* eslint-disable no-undef */
-import axios from "../axios";
+const axios = require("../axios");
 
 export default {
   axios: axios,
@@ -11,7 +10,7 @@ export default {
    * @param {String} token
    * @returns {Object}
    */
-  generateContent(data, contentType, integrationId, token) {
+  generateContent: (data, contentType, integrationId, token) => {
     return new Promise(function (resolve, reject) {
       let data_ = {
         data: data,
@@ -42,7 +41,7 @@ export default {
    * @param {String} token
    * @returns {Object}
    */
-  generateContentAsync(
+  generateContentAsync: (
     id,
     data,
     contentType,
@@ -50,7 +49,7 @@ export default {
     integrationId,
     comments,
     token
-  ) {
+  ) => {
     return new Promise(function (resolve, reject) {
       let data_ = {
         data: data,

package/lib/logger.js

@@ -1,6 +1,6 @@
-import axios from "./axios";
+const axios = require("./axios");
 
-export default {
+module.exports = {
   axios: axios,
 
   /**
@@ -10,7 +10,7 @@ export default {
    * @param {Object} data
    * @param {String} token Authorization token
    */
-  comment(elementId, elementType, data, token) {
+  comment: (elementId, elementType, data, token) => {
     return new Promise(function (resolve, reject) {
       let confirmationRequest = axios.post(
         "api/v1/logger/comment/",
@@ -36,12 +36,12 @@ export default {
   /**
    * Get the list of logger entries for selected element
    * @param {String} elementId
-   * @param {number} page The results page
-   * @param {number} elementsPerPage The number of elements per page
+   * @param {Number} page The results page
+   * @param {Number} elementsPerPage The number of elements per page
    * @param {String} token
    * @returns
    */
-  getListByElementId(elementId, page, elementsPerPage, token) {
+  getListByElementId: (elementId, page, elementsPerPage, token) => {
     return new Promise(function (resolve, reject) {
       let data = {};
       if (elementsPerPage !== null) data.elementsPerPage = elementsPerPage;

package/lib/role.js

@@ -1,7 +1,6 @@
-import axios from "./axios";
+const axios = require("./axios");
 
-// eslint-disable-next-line no-undef
-export default {
+module.exports = {
   axios: axios,
 
   /**
@@ -9,7 +8,7 @@ export default {
    * @param {Object} data
    * @param {String} token Authorization token
    */
-  createRole(data, token) {
+  createRole: (data, token) => {
     return new Promise(function (resolve, reject) {
       let confirmationRequest = axios.put(
         "api/v1/roles",
@@ -34,7 +33,7 @@ export default {
    * @param {Object} data
    * @param {String} token Authorization token
    */
-  createRoleFromTemplate(templateId, data, token) {
+  createRoleFromTemplate: (templateId, data, token) => {
     return new Promise(function (resolve, reject) {
       const requestData = {
         templateId: templateId,
@@ -63,7 +62,7 @@ export default {
    * @param {String} comment The comment included with the deletion
    * @param {String} token Authorization token
    */
-  deleteRole(id, comment, token) {
+  deleteRole: (id, comment, token) => {
     return new Promise(function (resolve, reject) {
       const data = {
         id: id,
@@ -88,7 +87,7 @@ export default {
    * @param {String} id The id of the role to be deleted
    * @param {String} token Authorization token
    */
-  discardRoleChanges(id, token) {
+  discardRoleChanges: (id, token) => {
     return new Promise(function (resolve, reject) {
       const data = {};
       const request = axios.get(`api/v1/roles/discard/${id}`, {
@@ -110,7 +109,7 @@ export default {
    * @param {number} id The id of the role
    * @param {String} token Authorization token
    */
-  getRoleInformationById(id, version, token) {
+  getRoleInformationById: (id, version, token) => {
     return new Promise(function (resolve, reject) {
       let confirmationRequest = axios.get(
         `api/v1/roles/role/${id}/${version}`,
@@ -137,14 +136,14 @@ export default {
    * @param {Boolean} returnDefaultIfVersionNotAvailable Return the default version if published not available
    * @param {String} token Authorization token
    */
-  getRolesList(
+  getRolesList: (
     filter,
     version,
     includeDeleted,
     includeDetailedInformation,
     returnDefaultIfVersionNotAvailable,
     token
-  ) {
+  ) => {
     return new Promise(function (resolve, reject) {
       const requestData = {
         version: version,
@@ -172,7 +171,7 @@ export default {
    * @param {String} comment The comment to be include with the request
    * @param {String} token Authorization token
    */
-  publishRole(id, comment, token) {
+  publishRole: (id, comment, token) => {
     return new Promise(function (resolve, reject) {
       let data = {};
       if (comment) data.comment = comment;
@@ -195,7 +194,7 @@ export default {
    * @param {Object} data Data used to update the role
    * @param {String} token Authorization token
    */
-  setRoleInformation(id, data, token) {
+  setRoleInformation: (id, data, token) => {
     return new Promise(function (resolve, reject) {
       const requestData = {
         data: data,
@@ -220,7 +219,7 @@ export default {
    * @param {Array<Object>} roles
    * @param {String} token
    */
-  setUserRoles(id, roles, roleDescription, token) {
+  setUserRoles: (id, roles, roleDescription, token) => {
     return new Promise(function (resolve, reject) {
       const requestData = {
         roles: roles,
@@ -239,13 +238,14 @@ export default {
         });
     });
   },
+
   /**
    * Watch role
    * @param {String} id The id of the skill to be updated
    * @param {Boolean} watch Set to true or false
    * @param {String} token Authorization token
    */
-  watchRole(id, watch, token) {
+  watchRole: (id, watch, token) => {
     return new Promise(function (resolve, reject) {
       const requestData = {
         id: id,

package/lib/roleTemplate.js

@@ -1,6 +1,6 @@
-import axios from "./axios";
+const axios = require("./axios");
 
-export default {
+module.exports = {
   axios: axios,
 
   /**
@@ -8,7 +8,7 @@ export default {
    * @param {Object} data
    * @param {String} token Authorization token
    */
-  createRoleTemplate(data, token) {
+  createRoleTemplate: (data, token) => {
     return new Promise(function (resolve, reject) {
       const requestData = {
         data: data,
@@ -32,7 +32,7 @@ export default {
    * @param {String} comment The comment included with the deletion
    * @param {String} token Authorization token
    */
-  deleteRoleTemplate(id, comment, token) {
+  deleteRoleTemplate: (id, comment, token) => {
     return new Promise(function (resolve, reject) {
       const data = {
         id: id,
@@ -57,7 +57,7 @@ export default {
    * @param {String} id The id of the role template to be deleted
    * @param {String} token Authorization token
    */
-  discardRoleTemplateChanges(id, token) {
+  discardRoleTemplateChanges: (id, token) => {
     return new Promise(function (resolve, reject) {
       const data = {};
       const request = axios.get(`api/v1/roletemplates/discard/${id}`, {
@@ -79,7 +79,7 @@ export default {
    * @param {String} id The id of the template
    * @param {String} token Authorization token
    */
-  getRoleTemplateInformationById(id, version, token) {
+  getRoleTemplateInformationById: (id, version, token) => {
     return new Promise(function (resolve, reject) {
       let confirmationRequest = axios.get(
         `api/v1/roletemplates/${id}/${version}`,
@@ -103,7 +103,7 @@ export default {
    * @param {boolean} includeDeleted When true it will return the deleted records as well
    * @param {String} token Authorization token
    */
-  getRoleTemplateList(filter, version, includeDeleted, token) {
+  getRoleTemplateList: (filter, version, includeDeleted, token) => {
     return new Promise(function (resolve, reject) {
       const requestData = {
         version: version,
@@ -133,7 +133,7 @@ export default {
    * @param {String} comment The comment to be include with the request
    * @param {String} token Authorization token
    */
-  publishTemplate(id, comment, token) {
+  publishTemplate: (id, comment, token) => {
     return new Promise(function (resolve, reject) {
       let data = {};
       if (comment) data.comment = comment;
@@ -160,7 +160,7 @@ export default {
    * @param {Object} data Data used to update the template
    * @param {String} token Authorization token
    */
-  setTemplateInformation(id, data, token) {
+  setTemplateInformation: (id, data, token) => {
     return new Promise(function (resolve, reject) {
       const requestData = {
         data: data,
@@ -189,7 +189,7 @@ export default {
    * @param {Object} tags Updated template tags
    * @param {String} token Authorization token
    */
-  setTemplateTags(id, tags, token) {
+  setTemplateTags: (id, tags, token) => {
     return new Promise(function (resolve, reject) {
       const requestData = {
         tags: tags,
@@ -218,7 +218,7 @@ export default {
    * @param {Boolean} watch Set to true or false
    * @param {String} token Authorization token
    */
-  watchRoleTemplate(id, watch, token) {
+  watchRoleTemplate: (id, watch, token) => {
     return new Promise(function (resolve, reject) {
       const requestData = {
         id: id,