@stackfactor/client-api 1.0.0

package/lib/skillAssessments.js

@@ -0,0 +1,139 @@
+import axios from "./axios";
+
+export default {
+  axios: axios,
+
+  /**
+   * Add new entry skill assessment
+   * @param {String} id
+   * @param {Object} data
+   * @param {String} comments
+   * @param {String} token Authorization token
+   */
+  addEntry(id, data, comments, token) {
+    return new Promise(function (resolve, reject) {
+      const requestData = {
+        comments: comments,
+        data: data,
+        id: id,
+      };
+      let confirmationRequest = axios.put(
+        "api/v1/skillassessments/addentry",
+        requestData,
+        {
+          headers: { authorization: token },
+        }
+      );
+      confirmationRequest
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+
+  /**
+   * Create skill assessment
+   * @param {Object} data
+   * @param {String} comments
+   * @param {String} userId
+   * @param {String} token Authorization token
+   */
+  create(data, comments, userId, token) {
+    return new Promise(function (resolve, reject) {
+      const requestData = {
+        comments: comments,
+        data: data,
+        userId: userId,
+      };
+      let confirmationRequest = axios.put(
+        "api/v1/skillassessments/",
+        requestData,
+        {
+          headers: { authorization: token },
+        }
+      );
+      confirmationRequest
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+
+  /**
+   * Delete skill assessment
+   * @param {number} id The id of the skill to be deleted
+   * @param {String} comments The comment included with the deletion
+   * @param {String} token Authorization token
+   */
+  deleteSkillAssessment(id, comments, token) {
+    return new Promise(function (resolve, reject) {
+      const data = {
+        id: id,
+      };
+      if (comments) data.comments = comments;
+      const request = axios.delete(`api/v1/skillassessments`, {
+        headers: { authorization: token },
+        data: data,
+      });
+      request
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+
+  /**
+   * Get skill assessment by id
+   * @param {String} id
+   * @param {String} token
+   */
+  getById(id, token) {
+    return new Promise(function (resolve, reject) {
+      let confirmationRequest = axios.get(`api/v1/skillassessments/${id}`, {
+        headers: { authorization: token },
+      });
+      confirmationRequest
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+
+  /**
+   * Get list
+   * @param {Object} userId The user used to select the skill
+   * @param {String} token Authorization token
+   */
+  getList(userId, token) {
+    return new Promise(function (resolve, reject) {
+      const requestData = {};
+      if (userId) requestData.userId = userId;
+      let confirmationRequest = axios.post(
+        `api/v1/skillassessments`,
+        requestData,
+        {
+          headers: { authorization: token },
+        }
+      );
+      confirmationRequest
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+};

package/lib/skillTemplate.js

@@ -0,0 +1,248 @@
+import axios from "./axios";
+
+export default {
+  axios: axios,
+
+  /**
+   * Create skill template and set information
+   * @param {Object} data
+   * @param {String} token Authorization token
+   */
+  createSkillTemplate(data, token) {
+    return new Promise(function (resolve, reject) {
+      const requestData = {
+        data: data,
+      };
+      let confirmationRequest = axios.put(
+        "api/v1/skilltemplates",
+        requestData,
+        { headers: { authorization: token } }
+      );
+      confirmationRequest
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+
+  /**
+   * Delete skill template
+   * @param {number} id The id of the template to be deleted
+   * @param {String} comment The comment included with the deletion
+   * @param {String} token Authorization token
+   */
+  deleteSkillTemplate(id, comment, token) {
+    const data = {
+      id: id,
+    };
+    if (comment) data.comment = comment;
+    return new Promise(function (resolve, reject) {
+      const request = axios.delete(`api/v1/skilltemplates/`, {
+        headers: { authorization: token },
+        data: data,
+      });
+      request
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+
+  /**
+   * Discard the skill template draft changes
+   * @param {String} id The id of the skill template to be deleted
+   * @param {String} token Authorization token
+   */
+  discardSkillTemplateChanges(id, token) {
+    return new Promise(function (resolve, reject) {
+      const data = {};
+      const request = axios.get(`api/v1/skilltemplates/discard/${id}`, {
+        headers: { authorization: token },
+        data: data,
+      });
+      request
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+
+  /**
+   * Get skill template information
+   * @param {String} id The id of the template
+   * @param {String} version The version of the template
+   * @param {String} token Authorization token
+   */
+  getSkillTemplateInformationById(id, version, token) {
+    return new Promise(function (resolve, reject) {
+      let confirmationRequest = axios.get(
+        `api/v1/skilltemplates/${id}/${version}`,
+        {
+          headers: { authorization: token },
+        }
+      );
+      confirmationRequest
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+
+  /**
+   * Get skill template list
+   * @param {Array<String>} filter The filter used to select the template
+   * @param {String} version The version to be retrieved
+   * @param {boolean} includeDeleted When true it will return the deleted records as well
+   * @param {String} token Authorization token
+   */
+  getSkillTemplateList(filter, version, includeDeleted, token) {
+    return new Promise(function (resolve, reject) {
+      const requestData = {
+        version: version,
+        includeDeleted: includeDeleted,
+      };
+      if (filter) requestData.filter = filter;
+      let confirmationRequest = axios.post(
+        `api/v1/skilltemplates`,
+        requestData,
+        {
+          headers: { authorization: token },
+        }
+      );
+      confirmationRequest
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+
+  /**
+   * Publish template
+   * @param {number} id The id of the template to be published
+   * @param {String} comment The comment to be include with the request
+   * @param {String} token Authorization token
+   */
+  publishTemplate(id, comment, token) {
+    return new Promise(function (resolve, reject) {
+      let data = {};
+      if (comment) data.comment = comment;
+
+      let confirmationRequest = axios.post(
+        `api/v1/skilltemplates/publish/${id}`,
+        data,
+        {
+          headers: { authorization: token },
+        }
+      );
+      confirmationRequest
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+
+  /**
+   * Set template profile information
+   * @param {String} id The id of the template to be updated
+   * @param {Object} data Data used to update the template
+   * @param {String} token Authorization token
+   */
+  setTemplateInformation(id, data, token) {
+    return new Promise(function (resolve, reject) {
+      const requestData = {
+        data: data,
+        id: id,
+      };
+      let confirmationRequest = axios.post(
+        `api/v1/skilltemplates/update`,
+        requestData,
+        {
+          headers: { authorization: token },
+        }
+      );
+      confirmationRequest
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+
+  /**
+   * Update the skill template tags
+   * @param {String} id The id of the template to be updated
+   * @param {Object} tags Updated template tags
+   * @param {String} token Authorization token
+   */
+  setTemplateTags(id, tags, token) {
+    return new Promise(function (resolve, reject) {
+      const requestData = {
+        tags: tags,
+        id: id,
+      };
+      let confirmationRequest = axios.post(
+        `api/v1/skilltemplates/updatetags/`,
+        requestData,
+        {
+          headers: { authorization: token },
+        }
+      );
+      confirmationRequest
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+
+  /**
+   * Watch skill template
+   * @param {String} id The id of the skill template to be updated
+   * @param {Boolean} watch Set to true or false
+   * @param {String} token Authorization token
+   */
+  watchSkillTemplate(id, watch, token) {
+    return new Promise(function (resolve, reject) {
+      const requestData = {
+        id: id,
+        watch: watch,
+      };
+      let confirmationRequest = axios.post(
+        `api/v1/skilltemplates/watch`,
+        requestData,
+        {
+          headers: { authorization: token },
+        }
+      );
+      confirmationRequest
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+};

package/lib/teams.js

@@ -0,0 +1,277 @@
+//
+// Team specific requests
+//
+import axios from "./axios";
+
+export default {
+  axios: axios,
+
+  /**
+   * Add users to team
+   * @param {String} teamId The team Id
+   * @param {Array<String>} users The users to be added
+   * @param {String} authToken - Authentication token
+   */
+  addUsersToTeam(teamId, users, authToken) {
+    return new Promise(function (resolve, reject) {
+      const request = axios.post(
+        `api/v1/teams/users/add`,
+        {
+          teamId: teamId,
+          users: users,
+        },
+        { headers: { authorization: authToken } }
+      );
+      request
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+
+  /**
+   * Create team
+   * @param {String} name The name of the team
+   * @param {String} managerId The id of the manager
+   * @param {String} description The description of the team
+   * @param {String} authToken The authorization token
+   */
+  createTeam(name, managerId, description, authToken) {
+    return new Promise(function (resolve, reject) {
+      const request = axios.post(
+        `api/v1/teams/team`,
+        {
+          name: name,
+          managerId: managerId,
+          description: description,
+        },
+        { headers: { authorization: authToken } }
+      );
+      request
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+
+  /**
+   * Delete team
+   * @param {String} teamId The team to be deleted
+   * @param {String} defaultTeamId The default team all the users will be moved to
+   * @param {String} authToken The authentication token
+   */
+  deleteTeam(teamId, defaultTeamId, authToken) {
+    return new Promise(function (resolve, reject) {
+      const request = axios.delete(`api/v1/teams/delete`, {
+        headers: { authorization: authToken },
+        data: {
+          id: teamId,
+          defaultTeamId: defaultTeamId,
+        },
+      });
+      request
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+
+  /**
+   * Get team by Id
+   * @param {String} teamId The team Id
+   * @param {Boolean} includeUserSummaryInformation True if request to load user summary information
+   * @param {String} authToken The authentication token
+   */
+  getTeamById(teamId, includeUserSummaryInformation, authToken) {
+    return new Promise(function (resolve, reject) {
+      const request = axios.post(
+        `api/v1/teams/team/${teamId}`,
+        {
+          includeUserSummaryInformation: includeUserSummaryInformation,
+        },
+        { headers: { authorization: authToken } }
+      );
+      request
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+
+  /**
+   * Get team roles
+   * @param {String} teamId The team Id
+   * @param {*} authToken The authentication token
+   */
+  getTeamByIdRoles(teamId, authToken) {
+    return new Promise(function (resolve, reject) {
+      const request = axios.get(`api/v1/teams/getroles/${teamId}`, {
+        headers: { authorization: authToken },
+      });
+      request
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+
+  /**
+   * Get teams for current tenant
+   * @param {String} userId
+   * @param {*} authToken The authentication token
+   */
+  getTeams(authToken) {
+    return new Promise(function (resolve, reject) {
+      const request = axios.get(`api/v1/teams/`, {
+        headers: { authorization: authToken },
+      });
+      request
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+
+  /**
+   * Get the team for the selected user
+   * @param {String} userId
+   * @param {Boolean} includeUserSummaryInformation True if request to load user summary information
+   * @param {String} authToken The authentication token
+   */
+  getTeamByUserId(userId, includeUserSummaryInformation, authToken) {
+    return new Promise(function (resolve, reject) {
+      const request = axios.post(
+        `/api/v1/teams/getuserteam/${userId ? userId : ""}`,
+        {
+          includeUserSummaryInformation: includeUserSummaryInformation,
+        },
+        { headers: { authorization: authToken } }
+      );
+      request
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+
+  /**
+   * Get top team in the organization, usually the executive team
+   * @param {Boolean} includeUserSummaryInformation True if request to load user summary information
+   * @param {String} authToken The authentication token
+   */
+  getTopTeam(includeUserSummaryInformation, authToken) {
+    return new Promise(function (resolve, reject) {
+      const request = axios.post(
+        `api/v1/teams/gettopteam`,
+        {
+          includeUserSummaryInformation: includeUserSummaryInformation,
+        },
+        { headers: { authorization: authToken } }
+      );
+      request
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+
+  /**
+   * Remove users from team
+   * @param {String} teamId The team Id
+   * @param {Array<String>} users The users to be removed from the team
+   * @param {String} authToken The authentication token
+   */
+  removeUsersFromTeam(teamId, users, authToken) {
+    return new Promise(function (resolve, reject) {
+      const request = axios.post(
+        `api/v1/teams/users/remove/`,
+        {
+          teamId: teamId,
+          users: users,
+        },
+        { headers: { authorization: authToken } }
+      );
+      request
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+
+  /*
+   * Set team as defualt
+   * @param {String} teamId The team Id
+   * @param {String} authToken The authentication token
+   */
+  setDefault(teamId, authToken) {
+    return new Promise(function (resolve, reject) {
+      const request = axios.put(
+        `api/v1/teams/setDefault/`,
+        {
+          id: teamId,
+        },
+        { headers: { authorization: authToken } }
+      );
+      request
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+
+  /**
+   * Update team
+   * @param {String} teamId The team Id
+   * @param {String} data The updated name of the team
+   * @param {String} authToken The authentication token
+   */
+  updateTeam(teamId, data, authToken) {
+    return new Promise(function (resolve, reject) {
+      const request = axios.patch(
+        `api/v1/teams/team/`,
+        {
+          id: teamId,
+          data: data,
+        },
+        { headers: { authorization: authToken } }
+      );
+      request
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+};