mindsight-sdk
v1.0.14
Published
Mindsight API wrapper
Downloads
14
Readme
How to use
- you should import mindsight to your application and after that create the object passing the mindsight token
import Mindsight from './index';
const mindsight = new Mindsight('token', 'base_url' );
- you can see the entire Mindsight API documentation right bellow
- https://sandbox-app.mindsight.com.br/api/v1/docs/
Assessments types
getAllExternalAssessmentTypes
- Returns a list of all the existing assessment types.
mindsight.getAllExternalAssessmentTypes(limit, offset).then((data) => {
//console.log(data)
});
getExternalAssessmentTypes
- Returns the given external assessment.
mindsight.getExternalAssessmentTypes(id).then((data) => {
//console.log(data);
});
Assessments
getAllExternalAssessment
- Returns a list of all the existing external assessments.
mindsight.getAllExternalAssessment(limit,offset,person,assessment_key).then((data) => {
//console.log(data);
});
getExternalAssessment
- Returns the given external assessment.
mindsight.getExternalAssessment(id,person,assessment_key).then((data) => {
//console.log(data);
});
deleteExternalAssessment
- Resets the external assessment.
mindsight.deleteExternalAssessment(id,person,assessment_key).then((data) => {
//console.log(data);
});
Functions
getAllFunctions
- Return a list of all the existing functions.
mindsight.getAllFunctions(limit,offset,name).then((data) => {
//console.log(data);
});
getFunctions
- Return the given function.
mindsight.getFunctions(id,name).then((data) => {
//console.log(data);
});
Logic
getAllLogic
- Return a list of all the existing logics.
mindsight.getAllLogic(limit, offset, person).then((data) => {
//console.log(data);
});
getLogic
- Returns the given logic assessment.
mindsight.getLogic(id, person).then((data) => {
//console.log(data);
});
deleteLogic
- Resets the logic assessment.
mindsight.deleteLogic(id, person).then((data) => {
//console.log(data);
});
Match
getAllMatches
- Return a list of all the existing matches.
mindsight.getAllMatches(limit, offset, person, function_id).then((data) => {
//console.log(data);
});
getMatches
- Returns the given match.
mindsight.getMatches(id, person, function_id).then((data) => {
//console.log(data);
});
Motivational
getAllMotivational
- Return a list of all the existing motivational assessments.
mindsight.getAllMotivational(limit, offset, person).then((data) => {
//console.log(data);
});
getMotivational
- Returns the given motivational assessment.
mindsight.getMotivational(id, person).then((data) => {
//console.log(data);
});
OCP
getAllOCP
- Returns the given ocp assessment.
mindsight.getAllOCP(limit, offset, person).then((data) => {
//console.log(data);
});
getOCP
- Resets the logic assessment.
mindsight.getOCP(id, person).then((data) => {
//console.log(data);
});
deleteOCP
- Resets the ocp assessment.
mindsight.deleteOCP(id, person).then((data) => {
//console.log(data);
});
Openings
getAllOpenings
- Return a list of all the existing openings.
mindsight.getAllOpenings(limit, offset, person).then((data) => {
//console.log(data);
});
createOpening
- Creates a new opening.
mindsight.createOpening({
"name": "new opening",
"public_name": "custom name",
"function": "http://server/api/v1/functions/132/"
}).then((data) => {
//console.log(data);
});
getOpening
- Returns the given opening.
mindsight.deleteLogic(id, function_id, name).then((data) => {
//console.log(data);
});
updateOpening
- Updates opening. All required items must be sent on the request.
mindsight.updateOpening(id, {
"name": "updated opening",
"public_name": "custom name",
"function": null
}).then((data) => {
//console.log(data);
});
partialUpdateOpening
- Updates opening even if the required items are not sent.
mindsight.updateOpening(id, {
"name": "updated opening",
"public_name": "custom name",
"function": null
}).then((data) => {
//console.log(data);
});
deleteOpening
- Deletes the given opening.
mindsight.deleteOpening(id).then((data) => {
//console.log(data);
});
People
getAllPeople
- Return a list of all the existing people.
mindsight.getAllPeople(limit, offset, id, email, cpf, updated_after, email_icontains, email_exact).then((data) => {
//console.log(data);
});
getPerson
- Returns the given person.
mindsight.getPerson(id, email, cpf, updated_after, email_icontains, email_exact).then((data) => {
//console.log(data);
});
updatePerson
- Updates person. All required items must be sent on the request.
mindsight.updatePerson(id, body, email, cpf, updated_after, email_icontains, email_exact).then((data) => {
//console.log(data);
});
partialUpdatePerson
- Updates person even if the required items are not sent.
mindsight.partialUpdatePerson(id, body, email, cpf, updated_after, email_icontains, email_exact).then((data) => {
//console.log(data);
});
deletePerson
- Deletes the given person.
mindsight.deletePerson(id, email, cpf, updated_after, email_icontains, email_exact).then((data) => {
//console.log(data);
});
ProfileMap
getAllProfileMap
- Return a list of all the existing profile map assessments.
mindsight.getAllProfileMap(limit, offset, person).then((data) => {
//console.log(data);
});
getProfileMap
- Returns the given profile map assessment.
mindsight.getProfileMap(id, person).then((data) => {
//console.log(data);
});
deleteProfileMap
- Resets the given profile map assessment.
mindsight.deleteProfileMap(id, person).then((data) => {
//console.log(data);
});
SJT
getAllSJT
- Return a list of all the existing SJT assessments.
mindsight.getAllSJT(limit, offset, person).then((data) => {
//console.log(data);
});
getSJT
- Returns the given SJT assessment.
mindsight.getSJT(id, person).then((data) => {
//console.log(data);
});
deleteSJT
- Resets the given SJT assessment.
mindsight.deleteSJT(id, person).then((data) => {
//console.log(data);
});
Subscriptions
getAllSubscriptions
- Return a list of all the existing subscriptions.
mindsight.getAllSubscriptions(limit, offset, person, opening).then((data) => {
//console.log(data);
});
createSubscription
- Creates a new subscription.
mindsight.createSubscription({
"person": "http://server/api/v1/people/57198/",
"opening": "http://server/api/v1/openings/1/"
}).then((data) => {
//console.log(data);
});
getSubscription
- Returns the given subscription.
mindsight.getSubscription(id, person, opening).then((data) => {
//console.log(data);
});
deleteSubscription
- Removes subscription.
mindsight.deleteSubscription(id, person).then((data) => {
//console.log(data);
});