@stackfactor/client-api 1.1.152 → 1.1.154

package/dist/teams.js

@@ -1,252 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const axiosClient_1 = require("./axiosClient");
-/**
- * Add users to team
- * @param {String} teamId The team Id
- * @param {Array<String>} users The users to be added
- * @param {String} authToken - Authentication token
- * @returns {Promise<Object>}
- */
-const addUsersToTeam = (teamId, users, authToken) => {
-    return new Promise((resolve, reject) => {
-        const request = axiosClient_1.client.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
- * @returns {Promise<Object>}
- */
-const createTeam = (name, managerId, description, authToken) => {
-    return new Promise((resolve, reject) => {
-        const request = axiosClient_1.client.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
- * @returns {Promise<Object>}
- */
-const deleteTeam = (teamId, defaultTeamId, authToken) => {
-    return new Promise((resolve, reject) => {
-        const request = axiosClient_1.client.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
- * @returns {Promise<Object>}
- */
-const getTeamById = (teamId, includeUserSummaryInformation, authToken) => {
-    return new Promise((resolve, reject) => {
-        const request = axiosClient_1.client.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 {String} authToken The authentication token
- * @returns {Promise<Object>}
- */
-const getTeamByIdRoles = (teamId, authToken) => {
-    return new Promise((resolve, reject) => {
-        const request = axiosClient_1.client.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} authToken The authentication token
- * @returns {Promise<Object>}
- */
-const getTeams = (authToken) => {
-    return new Promise((resolve, reject) => {
-        const request = axiosClient_1.client.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
- * @returns {Promise<Object>}
- */
-const getTeamByUserId = (userId, includeUserSummaryInformation, authToken) => {
-    return new Promise((resolve, reject) => {
-        const request = axiosClient_1.client.post(`/api/v1/teams/getuserteam/${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
- * @returns {Promise<Object>}
- */
-const getTopTeam = (includeUserSummaryInformation, authToken) => {
-    return new Promise((resolve, reject) => {
-        const request = axiosClient_1.client.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
- * @returns {Promise<Object>}
- */
-const removeUsersFromTeam = (teamId, users, authToken) => {
-    return new Promise((resolve, reject) => {
-        const request = axiosClient_1.client.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 default
- * @param {String} teamId The team Id
- * @param {String} authToken The authentication token
- * @returns {Promise<Object>}
- */
-const setDefault = (teamId, authToken) => {
-    return new Promise((resolve, reject) => {
-        const request = axiosClient_1.client.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 {Object} data The updated data of the team
- * @param {String} authToken The authentication token
- * @returns {Promise<Object>}
- */
-const updateTeam = (teamId, data, authToken) => {
-    return new Promise((resolve, reject) => {
-        const request = axiosClient_1.client.patch(`api/v1/teams/team/`, {
-            id: teamId,
-            data: data,
-        }, { headers: { authorization: authToken } });
-        request
-            .then((response) => {
-            resolve(response.data);
-        })
-            .catch((error) => {
-            reject(error);
-        });
-    });
-};
-exports.default = {
-    addUsersToTeam,
-    createTeam,
-    deleteTeam,
-    getTeamById,
-    getTeamByIdRoles,
-    getTeams,
-    getTeamByUserId,
-    getTopTeam,
-    removeUsersFromTeam,
-    setDefault,
-    updateTeam,
-};

package/dist/tenants.js

@@ -1,52 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const axiosClient_1 = require("./axiosClient");
-/**
- * Get tenant information
- * @param {String} category Tenant information category
- * @param {String} token Authorization token
- * @returns {Promise<Object>}
- */
-const getTenantInformation = (category, token) => {
-    return new Promise((resolve, reject) => {
-        const requestData = {
-            categories: category,
-        };
-        let request = axiosClient_1.client.post("api/v1/tenants/tenant/get", requestData, {
-            headers: { authorization: token },
-        });
-        request
-            .then((response) => {
-            resolve(response.data ? response.data : null);
-        })
-            .catch((error) => {
-            reject(error);
-        });
-    });
-};
-/**
- * Set tenant profile information
- * @param {String} category Tenant information category
- * @param {Object} data New or updated tenant data information
- * @param {String} token Authorization token
- * @returns {Promise<Object>}
- */
-const setTenantInformation = (category, data, token) => {
-    return new Promise((resolve, reject) => {
-        const requestData = {
-            category: category,
-            data: data,
-        };
-        let confirmationRequest = axiosClient_1.client.post("api/v1/tenants/tenant/set", requestData, {
-            headers: { authorization: token },
-        });
-        confirmationRequest
-            .then((response) => {
-            resolve(response.data);
-        })
-            .catch((error) => {
-            reject(error);
-        });
-    });
-};
-exports.default = { getTenantInformation, setTenantInformation };

package/dist/trainingPlans.js

@@ -1,308 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const axiosClient_1 = require("./axiosClient");
-/**
- * Archive the training plan
- * @param {String} id The id of the training plan to be deleted
- * @param {String} token Authorization token
- */
-const archiveTrainingPlan = (id, token) => {
-    return new Promise((resolve, reject) => {
-        const request = axiosClient_1.client.get(`api/v1/trainingplans/archive/${id}`, {
-            headers: { authorization: token },
-        });
-        request
-            .then((response) => {
-            resolve(response.data);
-        })
-            .catch((error) => {
-            reject(error);
-        });
-    });
-};
-/**
- * Create training plan and set information
- * @param {Object} data
- * @param {Number} type
- * @param {Boolean} saveAsDraft Save as draft flag
- * @param {String} token Authorization token
- */
-const createTrainingPlan = (data, type, saveAsDraft, token) => {
-    return new Promise((resolve, reject) => {
-        const requestData = {
-            version: "1.0",
-            includeDeleted: false,
-            includeDetailedInformation: true,
-            returnDefaultIfVersionNotAvailable: true,
-            types: [type],
-        };
-        let confirmationRequest = axiosClient_1.client.put("api/v1/trainingplans", requestData, {
-            headers: { authorization: token },
-        });
-        confirmationRequest
-            .then((response) => {
-            resolve(response.data);
-        })
-            .catch((error) => {
-            reject(error);
-        });
-    });
-};
-/**
- * Delete training plan
- * @param {String} id The id of the training plan to be deleted
- * @param {String} comments The comments for approver
- * @param {String} token Authorization token
- */
-const deleteTrainingPlan = (id, comments, token) => {
-    return new Promise((resolve, reject) => {
-        const data = {
-            id: id,
-        };
-        if (comments)
-            data.comments = comments;
-        const request = axiosClient_1.client.delete(`api/v1/trainingplans/`, {
-            headers: { authorization: token },
-            data: data,
-        });
-        request
-            .then((response) => {
-            resolve(response.data);
-        })
-            .catch((error) => {
-            reject(error);
-        });
-    });
-};
-/**
- * Discard the training plan draft changes
- * @param {String} id The id of the training plan to be deleted
- * @param {String} token Authorization token
- */
-const discardTrainingPlanChanges = (id, token) => {
-    return new Promise((resolve, reject) => {
-        const request = axiosClient_1.client.get(`api/v1/trainingplans/discard/${id}`, {
-            headers: { authorization: token },
-        });
-        request
-            .then((response) => {
-            resolve(response.data);
-        })
-            .catch((error) => {
-            reject(error);
-        });
-    });
-};
-/**
- * Create a new baseline
- * @param {String} id The Id of the plan for which a new baseline is to be generated
- * @param {Object} data The data
- * @param {Boolean} returnMinimized If set to true just high level plan baseline information will be returned
- * @param {Boolean} saveBaseline If set to true it will save the baseline
- * @param {String} token Authorization token
- */
-const generateNewBaseline = (id, data, returnMinimized, saveBaseline, token) => {
-    return new Promise((resolve, reject) => {
-        const requestData = {
-            data: data,
-            returnMinimized: returnMinimized,
-            saveBaseline: saveBaseline,
-        };
-        if (id)
-            requestData.id = id;
-        let confirmationRequest = axiosClient_1.client.post("api/v1/trainingplans/generatenewbaseline", requestData, {
-            headers: { authorization: token },
-        });
-        confirmationRequest
-            .then((response) => {
-            resolve(response.data);
-        })
-            .catch((error) => {
-            reject(error);
-        });
-    });
-};
-/**
- * Get training plan information
- * @param {String} id The id of the training plan
- * @param {String} version The version of the training plan
- * @param {String} token Authorization token
- */
-const getTrainingPlanById = (id, version, token) => {
-    return new Promise((resolve, reject) => {
-        let confirmationRequest = axiosClient_1.client.get(`api/v1/trainingplans/${id}/${version}`, {
-            headers: { authorization: token },
-        });
-        confirmationRequest
-            .then((response) => {
-            resolve(response.data);
-        })
-            .catch((error) => {
-            reject(error);
-        });
-    });
-};
-/**
- * Get tasks summary for a recipient across all of the training plans
- * @param {String} token Authorization token
- */
-const getAllTrainingPlansTasksSummary = (token = null) => {
-    return new Promise((resolve, reject) => {
-        let confirmationRequest = axiosClient_1.client.get(`api/v1/trainingplans/taskssummary`, {
-            headers: token ? { authorization: token } : {},
-        });
-        confirmationRequest
-            .then((response) => {
-            resolve(response.data);
-        })
-            .catch((error) => {
-            reject(error);
-        });
-    });
-};
-/**
- * Get training plans list
- * @param {Array<string>} users The list of users for which the plans should be loaded
- * @param {Array<number>} types The types of plans to be loaded
- * @param {String} version The version of the document to be retrieved
- * @param {Array<string>} fields The fields to be selected
- * @param {Boolean} includeDeleted If set true it will return deleted plans too
- * @param {Boolean} includeDetailedInformation If set true it will return detailed information
- * @param {Boolean} returnDefaultIfVersionNotAvailable If set to true it will load the draft information if the plan was never published
- * @param {String} token Authorization token
- */
-const getListOfTrainingPlans = (users, types, version, fields, includeDeleted, includeDetailedInformation, returnDefaultIfVersionNotAvailable, token) => {
-    return new Promise((resolve, reject) => {
-        const requestData = {
-            version: version,
-            includeDeleted: includeDeleted,
-            includeDetailedInformation: includeDetailedInformation,
-            returnDefaultIfVersionNotAvailable: returnDefaultIfVersionNotAvailable,
-        };
-        if (fields)
-            requestData.fields = fields;
-        if (types)
-            requestData.types = types;
-        if (users)
-            requestData.users = users;
-        let confirmationRequest = axiosClient_1.client.post(`api/v1/trainingplans`, requestData, {
-            headers: { authorization: token },
-        });
-        confirmationRequest
-            .then((response) => {
-            resolve(response.data);
-        })
-            .catch((error) => {
-            reject(error);
-        });
-    });
-};
-/**
- * Publish training plan
- * @param {String} id The id of the template to be published
- * @param {String} comments The comments to be include with the request
- * @param {String} token Authorization token
- */
-const publishTrainingPlan = (id, comments, token) => {
-    return new Promise((resolve, reject) => {
-        let data = {};
-        if (comments)
-            data.comments = comments;
-        let confirmationRequest = axiosClient_1.client.post(`api/v1/trainingplans/publish/${id}`, data, {
-            headers: { authorization: token },
-        });
-        confirmationRequest
-            .then((response) => {
-            resolve(response.data);
-        })
-            .catch((error) => {
-            reject(error);
-        });
-    });
-};
-/**
- * Update training plan
- * @param {String} planId The ID of the training plan
- * @param {Object} data The updated data
- * @param {Boolean} saveAsDraft Save as draft flag
- * @param {String} token Authorization token
- */
-const updateTrainingPlan = (planId, data, saveAsDraft, token) => {
-    return new Promise((resolve, reject) => {
-        const requestData = {
-            data: data,
-            id: planId,
-            saveAsDraft,
-        };
-        let confirmationRequest = axiosClient_1.client.put(`api/v1/trainingplans/update/${planId}`, requestData, {
-            headers: { authorization: token },
-        });
-        confirmationRequest
-            .then((response) => {
-            resolve(response.data);
-        })
-            .catch((error) => {
-            reject(error);
-        });
-    });
-};
-/**
- * Update training plan task status
- * @param {String} id The ID of the training plan
- * @param {Number} status
- * @param {String} token
- * @returns {Promise<Object>}
- */
-const updateTrainingPlanTaskStatus = (id, status, token) => {
-    return new Promise((resolve, reject) => {
-        let data = {
-            id: id,
-            status: status,
-        };
-        let confirmationRequest = axiosClient_1.client.post(`api/v1/trainingplans/task`, data, {
-            headers: { authorization: token },
-        });
-        confirmationRequest
-            .then(() => {
-            resolve({});
-        })
-            .catch((error) => {
-            reject(error);
-        });
-    });
-};
-/**
- * Update a task
- * @param {String} planId
- * @param {Object} data Ordered array of objects containing the activity Id and the new status
- * @param {String} token Authorization token
- * @returns {Promise<Object>}
- */
-const updateActivities = (planId, data, token) => {
-    return new Promise((resolve, reject) => {
-        let confirmationRequest = axiosClient_1.client.post(`api/v1/trainingplans/${planId}/activities`, data, {
-            headers: { authorization: token },
-        });
-        confirmationRequest
-            .then(() => {
-            resolve({});
-        })
-            .catch((error) => {
-            reject(error);
-        });
-    });
-};
-exports.default = {
-    archiveTrainingPlan,
-    createTrainingPlan,
-    deleteTrainingPlan,
-    discardTrainingPlanChanges,
-    generateNewBaseline,
-    getAllTrainingPlansTasksSummary,
-    getTrainingPlanById,
-    getListOfTrainingPlans,
-    publishTrainingPlan,
-    updateTrainingPlan,
-    updateTrainingPlanTaskStatus,
-    updateActivities,
-};

package/dist/trainingPlansProficiencyLevels.js

@@ -1,98 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const axiosClient_1 = require("./axiosClient");
-/**
- * Get training plan proficiency level
- * @param {String} proficiencyLevelId
- * @param {String} token
- * @returns {Promise<Object>} An object containing the proficiency level information
- */
-const getTrainingPlanProficiencyLevel = (proficiencyLevelId, token) => {
-    return new Promise((resolve, reject) => {
-        let confirmationRequest = axiosClient_1.client.get(`api/v1/trainingplans/proficiencylevels/${proficiencyLevelId}`, {
-            headers: { authorization: token },
-        });
-        confirmationRequest
-            .then((response) => {
-            resolve(response.data);
-        })
-            .catch((error) => {
-            reject(error);
-        });
-    });
-};
-/**
- * Get training plan proficiency level list
- * @param {Boolean} includeDeleted If set true it will return deleted plans too
- * @param {Boolean} includeDetailedInformation If set to true it will return detailed information for each plan
- * @param {Boolean} includeArchived If set to true it will return all the closed items too
- * @param {String} token Authorization token
- * @returns {Promise<Object>}
- */
-const getTrainingPlanProficiencyLevelList = (includeDeleted, includeDetailedInformation, includeArchived, token) => {
-    return new Promise((resolve, reject) => {
-        const requestData = {
-            includeArchived: includeArchived,
-            includeDeleted: includeDeleted,
-            includeDetailedInformation: includeDetailedInformation,
-        };
-        let confirmationRequest = axiosClient_1.client.post(`api/v1/trainingplans/proficiencylevels`, requestData, {
-            headers: { authorization: token },
-        });
-        confirmationRequest
-            .then((response) => {
-            resolve(response.data);
-        })
-            .catch((error) => {
-            reject(error);
-        });
-    });
-};
-/**
- * Reorder training plan proficiency levels
- * @param {Array<Object>} order
- * @param {String} token
- * @returns {Promise<void>}
- */
-const reorderTrainingPlansProficiencyLevels = (order, token) => {
-    return new Promise((resolve, reject) => {
-        let confirmationRequest = axiosClient_1.client.post(`api/v1/trainingplans/proficiencylevels/reorder`, { order: order }, {
-            headers: { authorization: token },
-        });
-        confirmationRequest
-            .then(() => {
-            resolve();
-        })
-            .catch((error) => {
-            reject(error);
-        });
-    });
-};
-/**
- * Update a training plan proficiency level
- * @param {String} proficiencyLevelId
- * @param {Object} data Ordered array of objects containing the activity Id and the new status
- * @param {String} token
- * @returns {Promise<void>}
- */
-const updateTrainingPlanProficiencyLevel = (proficiencyLevelId, data, token) => {
-    return new Promise((resolve, reject) => {
-        let confirmationRequest = axiosClient_1.client.post(`api/v1/trainingplans/proficiencylevel/${proficiencyLevelId}`, data, {
-            headers: { authorization: token },
-        });
-        confirmationRequest
-            .then(() => {
-            resolve();
-        })
-            .catch((error) => {
-            reject(error);
-        });
-    });
-};
-const trainingPlanProficiencyLevel = {
-    getTrainingPlanProficiencyLevel,
-    getTrainingPlanProficiencyLevelList,
-    reorderTrainingPlansProficiencyLevels,
-    updateTrainingPlanProficiencyLevel,
-};
-exports.default = trainingPlanProficiencyLevel;