@stackfactor/client-api 1.1.140 → 1.1.141

package/src/lib/constants.ts

@@ -1,90 +0,0 @@
-export const DOCUMENT_VERSION = {
-  DRAFT: "draft",
-  PUBLISHED: "published",
-} as const;
-
-export const RESPONSE_TYPE = {
-  MULTIPLE_CHOICES: 300,
-  MOVED_PERMANENTLY: 301,
-  FOUND: 302,
-  SEE_OTHER: 303,
-  NOT_MODIFIED: 304,
-  USE_PROXY: 305,
-  TEMPORARY_REDIRECT: 307,
-  BAD_REQUEST: 400,
-  UNAUTHORIZED: 401,
-  FORBIDDEN: 403,
-  NOT_FOUND: 404,
-  METHOD_NOT_ALLOWED: 405,
-  NOT_ACCEPTABLE: 406,
-  PROXY_AUTHENTICATION_REQUIRED: 407,
-  REQUEST_TIMEOUT: 408,
-  CONFLICT: 409,
-  GONE: 410,
-  LENGTH_REQUIRED: 411,
-  PRECONDITION_FAILED: 412,
-  REQUEST_ENTITY_TOO_LARGE: 413,
-  REQUEST_URI_TOO_LONG: 414,
-  UNSUPPORTED_MEDIA_TYPE: 415,
-  REQUESTED_RANGE_NOT_SATISFIABLE: 416,
-  EXPECTATION_FAILED: 417,
-  MISSING_ARGUMENTS: 419,
-  INVALID_ARGUMENTS: 420,
-  UNPROCESSABLE_ENTITY: 422,
-  INTERNAL_SERVER_ERROR: 500,
-  NOT_IMPLEMENTED: 501,
-  BAD_GATEWAY: 502,
-  SERVICE_UNAVAILABLE: 503,
-  GATEWAY_TIMEOUT: 504,
-  HTTP_VERSION_NOT_SUPPORTED: 505,
-  INITIALIZATION_FAILURE: 550,
-} as const;
-
-export const PERMISSIONS = {
-  ACCESS_TO_CONTENT_GENERATORS: "651d81d626fb9aafa4077520",
-  ADMIN_AUTHOR_CONTENT: "5ea3d1152839450e16e72bba",
-  ADMIN_PROMOTE_CONTENT: "5ea3d10bea252025c8ec351b",
-  ADMIN_MANAGE_CONTENT_PROVIDERS: "61970935cee185acf08111f6",
-  AUTHOR_CONTENT: "5fac210560e43de7c6b4a208",
-  BETA_TESTER: "5fac210b6c8f874bd7137b97",
-  MANAGE_BILLING: "5e1570cd03f676213bfdcd08",
-  MANAGE_CONTENT_PROVIDERS: "5f0fa12f16a720fde58ea820",
-  MANAGE_EXECUTIVE: "5fac2111b7e49e10c779b4a5",
-  MANAGE_GROUPS: "5dd612fe59e518ac87b8cf8e",
-  MANAGE_LEARNING_CONTENT: "64f54d20b7e49e10c779b4a6",
-  MANAGE_LEARNING_PATHS: "5dd61305a73c68b44c3f0827",
-  MANAGE_ORGANIZATION_INFORMATION: "5dd612d5338ea9a6ae6326da",
-  MANAGE_OWN_PROFILE_INFORMATION_AUTO_APP: "5fac210e7e6539d37a897c94",
-  MANAGE_OWN_PROFILE_SKIP_ASSESSMENT: "650fadb23956a2154ac890ac",
-  MANAGE_OWN_SKILL_SET_AUTO_APPROVE: "5fac21164351c6727a34cd4e",
-  MANAGE_SECURITY: "66ff566a911d938bc00618bf",
-  MANAGE_SETTINGS: "5e1570e087d836dc77888a5f",
-  MANAGE_TEAM_INFORMATION_AUTO_APPROVE: "5fac211e6c8f874bd7137b98",
-  MANAGE_TEAMS: "5dd61314afc2455a89b1a37b",
-  MANAGE_USERS: "5dd612e40f0bc559c41a2b29",
-  PROMOTE_CONTENT: "5fac2126427ce31f8a92c0cb",
-  TALENT_TRANSFORMATION_CHAMPION: "5fac210f7e6539d37a897c95",
-} as const;
-
-export const PERMISSION_DESCRIPTIONS: { [key: string]: string } = {
-  "5ea3d1152839450e16e72bba": "Author content",
-  "5ea3d10bea252025c8ec351b": "Promote content",
-  "61970935cee185acf08111f6": "Manage content providers",
-  "5fac210560e43de7c6b4a208": "Author content",
-  "5e1570cd03f676213bfdcd08": "Manage billing",
-  "5f0fa12f16a720fde58ea820": "Manage content providers",
-  "5fac2111b7e49e10c779b4a5": "Manage executive",
-  "5dd612fe59e518ac87b8cf8e": "Manage groups",
-  "64f54d20b7e49e10c779b4a6": "Manage learning content",
-  "5dd61305a73c68b44c3f0827": "Manage learning paths",
-  "5dd612d5338ea9a6ae6326da": "Manage organization information",
-  "5fac210e7e6539d37a897c94": "Auto approve own profile information updates",
-  "650fadb23956a2154ac890ac": "Skip assessment when updating own profile information",
-  "5fac21164351c6727a34cd4e": "Auto approve own skill set updates",
-  "66ff566a911d938bc00618bf": "Manage security",
-  "5e1570e087d836dc77888a5f": "Manage settings",
-  "5fac211e6c8f874bd7137b98": "Auto approve own team information updates",
-  "5dd61314afc2455a89b1a37b": "Manage teams",
-  "5dd612e40f0bc559c41a2b29": "Manage users",
-  "5fac2126427ce31f8a92c0cb": "Promote content",
-};

package/src/lib/dashboard.ts

@@ -1,83 +0,0 @@
-import { AxiosError, AxiosResponse } from "axios";
-import { client } from "./axiosClient";
-
-/**
- * Add a card to the dashboard
- * @param {String} id - the id of the card to be added to the dashboard
- * @param {Number} position - The position on the dashboard
- * @param {Object} data - The card settings data
- * @param {String} authToken - Authorization token
- * @returns {Promise<object>}
- */
-export const addCardToDashboard = (
-  id: string,
-  position: number,
-  data: object,
-  authToken: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
-    const request = client.put(
-      `/api/v1/dashboard/card`,
-      {
-        id: id,
-        position: position,
-        data: data || {},
-      },
-      { headers: { authorization: authToken } }
-    );
-    request
-      .then((response : AxiosResponse) => {
-        resolve(response.data);
-      })
-      .catch((error : AxiosError) => {
-        reject(error);
-      });
-  });
-};
-
-/**
- * Get the list of the cards from the dashboard
- * @param {String} authToken - Authorization token
- * @returns {Promise<object>}
- */
-export const getDashboardCardsList = (authToken: string): Promise<object> => {
-  return new Promise((resolve, reject) => {
-    const request = client.get(`/api/v1/dashboard/card`, {
-      headers: { authorization: authToken },
-    });
-    request
-      .then((response : AxiosResponse) => {
-        resolve(response.data);
-      })
-      .catch((error : AxiosError) => {
-        reject(error);
-      });
-  });
-};
-
-/**
- * Remove a card from the dashboard
- * @param {String} id - the id of the configuration element
- * @param {String} authToken - Authorization token
- * @returns {Promise<object>}
- */
-export const removeCardFromDashboard = (
-  id: string,
-  authToken: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
-    const request = client.delete(`/api/v1/dashboard/card`, {
-      headers: { authorization: authToken },
-      data: {
-        id: id,
-      },
-    });
-    request
-      .then((response : AxiosResponse) => {
-        resolve(response.data);
-      })
-      .catch((error : AxiosError) => {
-        reject(error);
-      });
-  });
-};

package/src/lib/departmentTrainingPlans.ts

@@ -1,197 +0,0 @@
-import { AxiosError, AxiosResponse } from "axios";
-import { client } from "./axiosClient";
-
-interface Activity {
-  _id: string;
-}
-
-/**
- * Create department training plan and set information
- * @param {String} name
- * @param {String} summary
- * @param {String} skill
- * @param {Array<Activity>} activities
- * @param {String} token Authorization token
- * @returns {Promise<object>}
- */
-export const createDepartmentTrainingPlan = (
-  name: string,
-  summary: string,
-  skill: string,
-  activities: Array<Activity>,
-  token: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
-    const requestData = {
-      name: name || "",
-      summary: summary || "",
-      skill: skill || "",
-      activities: activities || [],
-    };
-    const confirmationRequest = client.put(
-      "api/v1/departmentTrainingPlans",
-      requestData,
-      {
-        headers: { authorization: token },
-      }
-    );
-    confirmationRequest
-      .then((response : AxiosResponse) => {
-        resolve(response.data);
-      })
-      .catch((error : AxiosError) => {
-        reject(error);
-      });
-  });
-};
-
-/**
- * Delete department training plan
- * @param {String} id The id of the template to be deleted
- * @param {String} token Authorization token
- * @returns {Promise<object>}
- */
-export const deleteDepartmentTrainingPlan = (
-  id: string,
-  token: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
-    const request = client.delete(`api/v1/departmenttrainingplans/`, {
-      headers: { authorization: token },
-      data: {
-        id: id,
-      },
-    });
-    request
-      .then((response : AxiosResponse) => {
-        resolve(response.data);
-      })
-      .catch((error : AxiosError) => {
-        reject(error);
-      });
-  });
-};
-
-/**
- * Get department training plan information
- * @param {Number} id The id of the plan
- * @param {String} version The version of the plan
- * @param {String} token Authorization token
- * @returns {Promise<object>}
- */
-export const getDepartmentTrainingPlanInformationById = (
-  id: number,
-  version: string,
-  token: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
-    const confirmationRequest = client.get(
-      `api/v1/departmenttrainingplans/${id}/${version}`,
-      {
-        headers: { authorization: token },
-      }
-    );
-    confirmationRequest
-      .then((response : AxiosResponse) => {
-        resolve(response.data);
-      })
-      .catch((error : AxiosError) => {
-        reject(error);
-      });
-  });
-};
-
-/**
- * Get department training plan list
- * @param {String} filter The filter used to select the plan
- * @param {String} version The version of the plan
- * @param {String} token Authorization token
- * @returns {Promise<object>}
- */
-export const getDepartmentTrainingPlanList = (
-  filter: string,
-  version: string,
-  token: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
-    const requestData = {
-      filter: filter || "",
-      version: version,
-    };
-    const confirmationRequest = client.post(
-      `api/v1/departmenttrainingplans`,
-      requestData,
-      {
-        headers: { authorization: token },
-      }
-    );
-    confirmationRequest
-      .then((response : AxiosResponse) => {
-        resolve(response.data);
-      })
-      .catch((error : AxiosError) => {
-        reject(error);
-      });
-  });
-};
-
-/**
- * Publish department training plan
- * @param {number} id The id of the plan to be published
- * @param {String} token Authorization token
- * @returns {Promise<object>}
- */
-export const publishDepartmentTrainingPlan = (
-  id: number,
-  token: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
-    const confirmationRequest = client.post(
-      `api/v1/departmenttrainingplans/publish/${id}`,
-      {},
-      {
-        headers: { authorization: token },
-      }
-    );
-    confirmationRequest
-      .then((response : AxiosResponse) => {
-        resolve(response.data);
-      })
-      .catch((error : AxiosError) => {
-        reject(error);
-      });
-  });
-};
-
-/**
- * Set department training plan profile information
- * @param {String} id The id of the plan to be updated
- * @param {Object} data Data used to update the plan
- * @param {String} token Authorization token
- * @returns {Promise<object>}
- */
-export const setDepartmentTrainingPlanInformation = (
-  id: string,
-  data: object,
-  token: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
-    const requestData = {
-      data: data,
-    };
-    const confirmationRequest = client.post(
-      `api/v1/departmenttrainingplans/${id}`,
-      requestData,
-      {
-        headers: { authorization: token },
-      }
-    );
-    confirmationRequest
-      .then((response : AxiosResponse) => {
-        resolve(response.data);
-      })
-      .catch((error : AxiosError) => {
-        reject(error);
-      });
-  });
-};

package/src/lib/groups.ts

@@ -1,327 +0,0 @@
-import { AxiosError, AxiosResponse } from "axios";
-import { client } from "./axiosClient";
-
-/**
- * Add permissions to group
- * @param {String} groupId The group Id
- * @param {Array<String>} permissions The permissions to be added
- * @param {String} authToken - Authentication token
- * @returns {Promise<object>}
- */
-export const addPermissionsToGroup = (
-  groupId: string,
-  permissions: string[],
-  authToken: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
-    const request = client.post(
-      `api/v1/groups/permissions/add`,
-      {
-        groupId: groupId,
-        permissions: permissions,
-      },
-      { headers: { authorization: authToken } }
-    );
-    request
-      .then((response : AxiosResponse) => {
-        resolve(response.data);
-      })
-      .catch((error : AxiosError) => {
-        reject(error);
-      });
-  });
-};
-
-/**
- * Add users to group
- * @param {String} groupId The group Id
- * @param {Array<String>} users The users to be added
- * @param {String} authToken - Authentication token
- * @returns {Promise<object>}
- */
-export const addUsersToGroup = (
-  groupId: string,
-  users: string[],
-  authToken: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
-    const request = client.post(
-      `api/v1/groups/users/add`,
-      {
-        groupId: groupId,
-        users: users,
-      },
-      { headers: { authorization: authToken } }
-    );
-    request
-      .then((response : AxiosResponse) => {
-        resolve(response.data);
-      })
-      .catch((error : AxiosError) => {
-        reject(error);
-      });
-  });
-};
-
-/**
- * Create group
- * @param {String} name The name of the group
- * @param {String} description The description of the group
- * @param {String} authToken The authorization token
- * @returns {Promise<object>}
- */
-export const createGroup = (
-  name: string,
-  description: string,
-  authToken: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
-    const request = client.post(
-      `api/v1/groups/group`,
-      {
-        name: name,
-        description: description,
-      },
-      { headers: { authorization: authToken } }
-    );
-    request
-      .then((response : AxiosResponse) => {
-        resolve(response.data);
-      })
-      .catch((error : AxiosError) => {
-        reject(error);
-      });
-  });
-};
-
-/**
- * Delete group
- * @param {String} groupId The group to be deleted
- * @param {String} defaultGroupId The default group all the users will be moved to
- * @param {String} authToken The authentication token
- * @returns {Promise<object>}
- */
-export const deleteGroup = (
-  groupId: string,
-  defaultGroupId: string,
-  authToken: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
-    const request = client.delete(`api/v1/groups/delete`, {
-      headers: { authorization: authToken },
-      data: {
-        id: groupId,
-        defaultGroupId: defaultGroupId,
-      },
-    });
-    request
-      .then((response : AxiosResponse) => {
-        resolve(response.data);
-      })
-      .catch((error : AxiosError) => {
-        reject(error);
-      });
-  });
-};
-
-/**
- * Get all permissions
- * @param {String} authToken The authentication token
- * @returns {Promise<object>}
- */
-export const getAllPermissions = (authToken: string): Promise<object> => {
-  return new Promise((resolve, reject) => {
-    const request = client.get(`api/v1/groups/permissions/getAllPermissions`, {
-      headers: { authorization: authToken },
-    });
-    request
-      .then((response : AxiosResponse) => {
-        resolve(response.data);
-      })
-      .catch((error : AxiosError) => {
-        reject(error);
-      });
-  });
-};
-
-/**
- * Get group by Id
- * @param {String} groupId The group Id
- * @param {String} authToken The authentication token
- * @returns {Promise<object>}
- */
-export const getGroupById = (groupId: string, authToken: string): Promise<object> => {
-  return new Promise((resolve, reject) => {
-    const request = client.get(`api/v1/groups/group/${groupId}`, {
-      headers: { authorization: authToken },
-    });
-    request
-      .then((response : AxiosResponse) => {
-        resolve(response.data);
-      })
-      .catch((error : AxiosError) => {
-        reject(error);
-      });
-  });
-};
-
-/**
- * Get groups for current tenant
- * @param {String} authToken The authentication token
- * @returns {Promise<object>}
- */
-export const getGroups = (authToken: string): Promise<object> => {
-  return new Promise((resolve, reject) => {
-    const request = client.get(`api/v1/groups/`, {
-      headers: { authorization: authToken },
-    });
-    request
-      .then((response : AxiosResponse) => {
-        resolve(response.data);
-      })
-      .catch((error : AxiosError) => {
-        reject(error);
-      });
-  });
-};
-
-/**
- * Get current user permissions
- * @param {String} authToken The authentication token
- * @returns {Promise<object>}
- */
-export const getUserPermissions = (authToken: string): Promise<object> => {
-  return new Promise((resolve, reject) => {
-    const request = client.get(`api/v1/groups/users/getuserpermissions`, {
-      headers: { authorization: authToken },
-    });
-    request
-      .then((response : AxiosResponse) => {
-        resolve(response.data);
-      })
-      .catch((error : AxiosError) => {
-        reject(error);
-      });
-  });
-};
-
-/**
- * Remove permissions from group
- * @param {String} groupId The group Id
- * @param {Array<String>} permissions The permissions to be removed from the group
- * @param {String} authToken The authentication token
- * @returns {Promise<object>}
- */
-export const removePermissionsFromGroup = (
-  groupId: string,
-  permissions: string[],
-  authToken: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
-    const request = client.post(
-      `api/v1/groups/permissions/remove/`,
-      {
-        groupId: groupId,
-        permissions: permissions,
-      },
-      { headers: { authorization: authToken } }
-    );
-    request
-      .then((response : AxiosResponse) => {
-        resolve(response.data);
-      })
-      .catch((error : AxiosError) => {
-        reject(error);
-      });
-  });
-};
-
-/**
- * Remove users from group
- * @param {String} groupId The group Id
- * @param {Array<String>} users The users to be removed from the group
- * @param {String} authToken The authentication token
- * @returns {Promise<object>}
- */
-export const removeUsersFromGroup = (
-  groupId: string,
-  users: string[],
-  authToken: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
-    const request = client.post(
-      `api/v1/groups/users/remove/`,
-      {
-        groupId: groupId,
-        users: users,
-      },
-      { headers: { authorization: authToken } }
-    );
-    request
-      .then((response : AxiosResponse) => {
-        resolve(response.data);
-      })
-      .catch((error : AxiosError) => {
-        reject(error);
-      });
-  });
-};
-
-/**
- * Set group as default
- * @param {String} groupId The group Id
- * @param {String} authToken The authentication token
- * @returns {Promise<object>}
- */
-export const setDefault = (groupId: string, authToken: string): Promise<object> => {
-  return new Promise((resolve, reject) => {
-    const request = client.put(
-      `api/v1/groups/setDefault/`,
-      {
-        id: groupId,
-      },
-      { headers: { authorization: authToken } }
-    );
-    request
-      .then((response : AxiosResponse) => {
-        resolve(response.data);
-      })
-      .catch((error : AxiosError) => {
-        reject(error);
-      });
-  });
-};
-
-/**
- * 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} authToken The authentication token
- * @returns {Promise<object>}
- */
-export const updateGroup = (
-  groupId: string,
-  name: string,
-  description: string,
-  authToken: string
-): Promise<object> => {
-  return new Promise((resolve, reject) => {
-    const request = client.patch(
-      `api/v1/groups/group/`,
-      {
-        id: groupId,
-        name: name,
-        description: description,
-      },
-      { headers: { authorization: authToken } }
-    );
-    request
-      .then((response : AxiosResponse) => {
-        resolve(response.data);
-      })
-      .catch((error : AxiosError) => {
-        reject(error);
-      });
-  });
-};