@smarterservices/sp-public-client
Advanced tools
Comparing version 0.0.66 to 0.0.67
768
index.js
@@ -66,5 +66,55 @@ /*jshint -W069 */ | ||
/** | ||
* Join an existing session and get permissions | ||
* List all instructors for a course | ||
* @method | ||
* @name Client#joinSession | ||
* @name Client#listInstructors | ||
* @param {string} course_id - | ||
* @param {string} page - | ||
* @param {string} page_size - | ||
* | ||
*/ | ||
Client.prototype.listInstructors = function(parameters) { | ||
if (parameters === undefined) { | ||
parameters = {}; | ||
} | ||
var deferred = Q.defer(); | ||
var domain = this.domain; | ||
var path = '/v1/courses/{course_id}/instructors'; | ||
var body; | ||
var queryParameters = {}; | ||
var headers = {}; | ||
var form = {}; | ||
path = path.replace('{course_id}', parameters['course_id']); | ||
if (parameters['course_id'] === undefined) { | ||
deferred.reject(new Error('Missing required parameter: course_id')); | ||
return deferred.promise; | ||
} | ||
if (parameters['page'] !== undefined) { | ||
queryParameters['page'] = parameters['page']; | ||
} | ||
if (parameters['page_size'] !== undefined) { | ||
queryParameters['page_size'] = parameters['page_size']; | ||
} | ||
if (parameters.$queryParameters) { | ||
Object.keys(parameters.$queryParameters) | ||
.forEach(function(parameterName) { | ||
var parameter = parameters.$queryParameters[parameterName]; | ||
queryParameters[parameterName] = parameter; | ||
}); | ||
} | ||
this.request('GET', domain + path, parameters, body, headers, queryParameters, form, deferred); | ||
return deferred.promise; | ||
}; | ||
/** | ||
* Start a new session and create permissions | ||
* @method | ||
* @name Client#startSession | ||
* @param {string} session_id - Access Key | ||
@@ -74,3 +124,3 @@ * @param {} body - | ||
*/ | ||
Client.prototype.joinSession = function(parameters) { | ||
Client.prototype.startSession = function(parameters) { | ||
if (parameters === undefined) { | ||
@@ -82,3 +132,3 @@ parameters = {}; | ||
var domain = this.domain; | ||
var path = '/v1/sessions/{session_id}/join'; | ||
var path = '/v1/sessions/{session_id}/start'; | ||
@@ -114,10 +164,9 @@ var body; | ||
/** | ||
* Will return return details about a single course | ||
* Will return detailed information about an institution | ||
* @method | ||
* @name Client#getCourse | ||
* @param {string} course_id - | ||
* @name Client#getInstitution | ||
* @param {string} institution_id - | ||
* | ||
*/ | ||
Client.prototype.getCourse = function(parameters) { | ||
Client.prototype.getInstitution = function(parameters) { | ||
if (parameters === undefined) { | ||
@@ -129,3 +178,3 @@ parameters = {}; | ||
var domain = this.domain; | ||
var path = '/v1/institutions/{institution_id}/courses/{course_id}'; | ||
var path = '/v1/institutions/{institution_id}'; | ||
@@ -137,9 +186,2 @@ var body; | ||
path = path.replace('{course_id}', parameters['course_id']); | ||
if (parameters['course_id'] === undefined) { | ||
deferred.reject(new Error('Missing required parameter: course_id')); | ||
return deferred.promise; | ||
} | ||
path = path.replace('{institution_id}', parameters['institution_id']); | ||
@@ -165,2 +207,50 @@ | ||
/** | ||
* Cancel session for a given exam | ||
* @method | ||
* @name Client#cancelSession | ||
* @param {string} exam_id - | ||
* @param {string} session_id - | ||
* | ||
*/ | ||
Client.prototype.cancelSession = function(parameters) { | ||
if (parameters === undefined) { | ||
parameters = {}; | ||
} | ||
var deferred = Q.defer(); | ||
var domain = this.domain; | ||
var path = '/v1/exams/{exam_id}/sessions/{session_id}/cancel'; | ||
var body; | ||
var queryParameters = {}; | ||
var headers = {}; | ||
var form = {}; | ||
path = path.replace('{exam_id}', parameters['exam_id']); | ||
if (parameters['exam_id'] === undefined) { | ||
deferred.reject(new Error('Missing required parameter: exam_id')); | ||
return deferred.promise; | ||
} | ||
path = path.replace('{session_id}', parameters['session_id']); | ||
if (parameters['session_id'] === undefined) { | ||
deferred.reject(new Error('Missing required parameter: session_id')); | ||
return deferred.promise; | ||
} | ||
if (parameters.$queryParameters) { | ||
Object.keys(parameters.$queryParameters) | ||
.forEach(function(parameterName) { | ||
var parameter = parameters.$queryParameters[parameterName]; | ||
queryParameters[parameterName] = parameter; | ||
}); | ||
} | ||
this.request('POST', domain + path, parameters, body, headers, queryParameters, form, deferred); | ||
return deferred.promise; | ||
}; | ||
/** | ||
* Sign an agreement | ||
@@ -279,11 +369,10 @@ * @method | ||
/** | ||
* List incidents for a given session | ||
* Join an existing session and get permissions | ||
* @method | ||
* @name Client#listIncidents | ||
* @param {string} session_id - | ||
* @param {string} page - | ||
* @param {string} page_size - | ||
* @name Client#joinSession | ||
* @param {string} session_id - Access Key | ||
* @param {} body - | ||
* | ||
*/ | ||
Client.prototype.listIncidents = function(parameters) { | ||
Client.prototype.joinSession = function(parameters) { | ||
if (parameters === undefined) { | ||
@@ -295,3 +384,3 @@ parameters = {}; | ||
var domain = this.domain; | ||
var path = '/v1/sessions/{session_id}/incidents'; | ||
var path = '/v1/sessions/{session_id}/join'; | ||
@@ -310,10 +399,6 @@ var body; | ||
if (parameters['page'] !== undefined) { | ||
queryParameters['page'] = parameters['page']; | ||
if (parameters['body'] !== undefined) { | ||
body = parameters['body']; | ||
} | ||
if (parameters['page_size'] !== undefined) { | ||
queryParameters['page_size'] = parameters['page_size']; | ||
} | ||
if (parameters.$queryParameters) { | ||
@@ -327,3 +412,3 @@ Object.keys(parameters.$queryParameters) | ||
this.request('GET', domain + path, parameters, body, headers, queryParameters, form, deferred); | ||
this.request('POST', domain + path, parameters, body, headers, queryParameters, form, deferred); | ||
@@ -333,10 +418,11 @@ return deferred.promise; | ||
/** | ||
* Creates an incident for a given session | ||
* Get exam details | ||
* @method | ||
* @name Client#createIncident | ||
* @param {string} session_id - | ||
* @param {} body - | ||
* @name Client#getExam | ||
* @param {string} course_id - | ||
* @param {string} exam_id - | ||
* @param {string} enrollment_id - | ||
* | ||
*/ | ||
Client.prototype.createIncident = function(parameters) { | ||
Client.prototype.getExam = function(parameters) { | ||
if (parameters === undefined) { | ||
@@ -348,3 +434,3 @@ parameters = {}; | ||
var domain = this.domain; | ||
var path = '/v1/sessions/{session_id}/incidents'; | ||
var path = '/v1/courses/{course_id}/exams/{exam_id}'; | ||
@@ -356,13 +442,25 @@ var body; | ||
path = path.replace('{session_id}', parameters['session_id']); | ||
path = path.replace('{course_id}', parameters['course_id']); | ||
if (parameters['session_id'] === undefined) { | ||
deferred.reject(new Error('Missing required parameter: session_id')); | ||
if (parameters['course_id'] === undefined) { | ||
deferred.reject(new Error('Missing required parameter: course_id')); | ||
return deferred.promise; | ||
} | ||
if (parameters['body'] !== undefined) { | ||
body = parameters['body']; | ||
path = path.replace('{exam_id}', parameters['exam_id']); | ||
if (parameters['exam_id'] === undefined) { | ||
deferred.reject(new Error('Missing required parameter: exam_id')); | ||
return deferred.promise; | ||
} | ||
if (parameters['enrollment_id'] !== undefined) { | ||
queryParameters['enrollment_id'] = parameters['enrollment_id']; | ||
} | ||
if (parameters['enrollment_id'] === undefined) { | ||
deferred.reject(new Error('Missing required parameter: enrollment_id')); | ||
return deferred.promise; | ||
} | ||
if (parameters.$queryParameters) { | ||
@@ -376,3 +474,3 @@ Object.keys(parameters.$queryParameters) | ||
this.request('POST', domain + path, parameters, body, headers, queryParameters, form, deferred); | ||
this.request('GET', domain + path, parameters, body, headers, queryParameters, form, deferred); | ||
@@ -382,11 +480,9 @@ return deferred.promise; | ||
/** | ||
* Get history of current session | ||
* List students for a given exam | ||
* @method | ||
* @name Client#getAgreementHistory | ||
* @param {string} token - | ||
* @param {string} session_id - | ||
* @param {string} agreement_id - | ||
* @name Client#listStudents | ||
* @param {string} exam_id - | ||
* | ||
*/ | ||
Client.prototype.getAgreementHistory = function(parameters) { | ||
Client.prototype.listStudents = function(parameters) { | ||
if (parameters === undefined) { | ||
@@ -398,3 +494,3 @@ parameters = {}; | ||
var domain = this.domain; | ||
var path = '/v1/sessions/{session_id}/agreements/{agreement_id}/history'; | ||
var path = '/v1/exams/{exam_id}/students'; | ||
@@ -406,25 +502,9 @@ var body; | ||
if (parameters['token'] !== undefined) { | ||
headers['token'] = parameters['token']; | ||
} | ||
path = path.replace('{exam_id}', parameters['exam_id']); | ||
if (parameters['token'] === undefined) { | ||
deferred.reject(new Error('Missing required parameter: token')); | ||
if (parameters['exam_id'] === undefined) { | ||
deferred.reject(new Error('Missing required parameter: exam_id')); | ||
return deferred.promise; | ||
} | ||
path = path.replace('{session_id}', parameters['session_id']); | ||
if (parameters['session_id'] === undefined) { | ||
deferred.reject(new Error('Missing required parameter: session_id')); | ||
return deferred.promise; | ||
} | ||
path = path.replace('{agreement_id}', parameters['agreement_id']); | ||
if (parameters['agreement_id'] === undefined) { | ||
deferred.reject(new Error('Missing required parameter: agreement_id')); | ||
return deferred.promise; | ||
} | ||
if (parameters.$queryParameters) { | ||
@@ -443,10 +523,9 @@ Object.keys(parameters.$queryParameters) | ||
/** | ||
* Get instructor details | ||
* List all exams for a course | ||
* @method | ||
* @name Client#getInstructor | ||
* @name Client#listExams | ||
* @param {string} course_id - | ||
* @param {string} instructor_id - | ||
* | ||
*/ | ||
Client.prototype.getInstructor = function(parameters) { | ||
Client.prototype.listExams = function(parameters) { | ||
if (parameters === undefined) { | ||
@@ -458,3 +537,3 @@ parameters = {}; | ||
var domain = this.domain; | ||
var path = '/v1/courses/{course_id}/instructors/{instructor_id}'; | ||
var path = '/v1/courses/{course_id}/exams'; | ||
@@ -473,9 +552,2 @@ var body; | ||
path = path.replace('{instructor_id}', parameters['instructor_id']); | ||
if (parameters['instructor_id'] === undefined) { | ||
deferred.reject(new Error('Missing required parameter: instructor_id')); | ||
return deferred.promise; | ||
} | ||
if (parameters.$queryParameters) { | ||
@@ -494,9 +566,10 @@ Object.keys(parameters.$queryParameters) | ||
/** | ||
* Will return detailed information about an institution | ||
* Gets the zookeeper session history | ||
* @method | ||
* @name Client#getInstitution | ||
* @param {string} institution_id - | ||
* @name Client#getProcesses | ||
* @param {string} session_id - | ||
* @param {string} zookeeper_id - | ||
* | ||
*/ | ||
Client.prototype.getInstitution = function(parameters) { | ||
Client.prototype.getProcesses = function(parameters) { | ||
if (parameters === undefined) { | ||
@@ -508,3 +581,3 @@ parameters = {}; | ||
var domain = this.domain; | ||
var path = '/v1/institutions/{institution_id}'; | ||
var path = '/v1/sessions/{session_id}/processes'; | ||
@@ -516,9 +589,18 @@ var body; | ||
path = path.replace('{institution_id}', parameters['institution_id']); | ||
path = path.replace('{session_id}', parameters['session_id']); | ||
if (parameters['institution_id'] === undefined) { | ||
deferred.reject(new Error('Missing required parameter: institution_id')); | ||
if (parameters['session_id'] === undefined) { | ||
deferred.reject(new Error('Missing required parameter: session_id')); | ||
return deferred.promise; | ||
} | ||
if (parameters['zookeeper_id'] !== undefined) { | ||
queryParameters['zookeeper_id'] = parameters['zookeeper_id']; | ||
} | ||
if (parameters['zookeeper_id'] === undefined) { | ||
deferred.reject(new Error('Missing required parameter: zookeeper_id')); | ||
return deferred.promise; | ||
} | ||
if (parameters.$queryParameters) { | ||
@@ -537,9 +619,10 @@ Object.keys(parameters.$queryParameters) | ||
/** | ||
* List students for a given exam | ||
* Updates the session with the current running processes | ||
* @method | ||
* @name Client#listStudents | ||
* @param {string} exam_id - | ||
* @name Client#sessionProcesses | ||
* @param {string} session_id - | ||
* @param {} body - | ||
* | ||
*/ | ||
Client.prototype.listStudents = function(parameters) { | ||
Client.prototype.sessionProcesses = function(parameters) { | ||
if (parameters === undefined) { | ||
@@ -551,3 +634,3 @@ parameters = {}; | ||
var domain = this.domain; | ||
var path = '/v1/exams/{exam_id}/students'; | ||
var path = '/v1/sessions/{session_id}/processes'; | ||
@@ -559,9 +642,13 @@ var body; | ||
path = path.replace('{exam_id}', parameters['exam_id']); | ||
path = path.replace('{session_id}', parameters['session_id']); | ||
if (parameters['exam_id'] === undefined) { | ||
deferred.reject(new Error('Missing required parameter: exam_id')); | ||
if (parameters['session_id'] === undefined) { | ||
deferred.reject(new Error('Missing required parameter: session_id')); | ||
return deferred.promise; | ||
} | ||
if (parameters['body'] !== undefined) { | ||
body = parameters['body']; | ||
} | ||
if (parameters.$queryParameters) { | ||
@@ -575,3 +662,3 @@ Object.keys(parameters.$queryParameters) | ||
this.request('GET', domain + path, parameters, body, headers, queryParameters, form, deferred); | ||
this.request('PUT', domain + path, parameters, body, headers, queryParameters, form, deferred); | ||
@@ -581,9 +668,9 @@ return deferred.promise; | ||
/** | ||
* Will return return a list of courses for an institution | ||
* This endpoint is used to get an image list for an proctor | ||
* @method | ||
* @name Client#listCourses | ||
* @param {string} institution_id - | ||
* @name Client#listProctorImages | ||
* @param {string} user_id - | ||
* | ||
*/ | ||
Client.prototype.listCourses = function(parameters) { | ||
Client.prototype.listProctorImages = function(parameters) { | ||
if (parameters === undefined) { | ||
@@ -595,3 +682,3 @@ parameters = {}; | ||
var domain = this.domain; | ||
var path = '/v1/institutions/{institution_id}/courses'; | ||
var path = '/v1/proctor/{user_id}/images'; | ||
@@ -603,6 +690,6 @@ var body; | ||
path = path.replace('{institution_id}', parameters['institution_id']); | ||
path = path.replace('{user_id}', parameters['user_id']); | ||
if (parameters['institution_id'] === undefined) { | ||
deferred.reject(new Error('Missing required parameter: institution_id')); | ||
if (parameters['user_id'] === undefined) { | ||
deferred.reject(new Error('Missing required parameter: user_id')); | ||
return deferred.promise; | ||
@@ -624,8 +711,10 @@ } | ||
/** | ||
* Used to make sure that the api is current only | ||
* This endpoint is used to upload headshot for a proctor | ||
* @method | ||
* @name Client#health | ||
* @name Client#uploadProctorImage | ||
* @param {string} user_id - | ||
* @param {} body - | ||
* | ||
*/ | ||
Client.prototype.health = function(parameters) { | ||
Client.prototype.uploadProctorImage = function(parameters) { | ||
if (parameters === undefined) { | ||
@@ -637,3 +726,3 @@ parameters = {}; | ||
var domain = this.domain; | ||
var path = '/v1'; | ||
var path = '/v1/proctor/{user_id}/images'; | ||
@@ -645,2 +734,13 @@ var body; | ||
path = path.replace('{user_id}', parameters['user_id']); | ||
if (parameters['user_id'] === undefined) { | ||
deferred.reject(new Error('Missing required parameter: user_id')); | ||
return deferred.promise; | ||
} | ||
if (parameters['body'] !== undefined) { | ||
body = parameters['body']; | ||
} | ||
if (parameters.$queryParameters) { | ||
@@ -654,3 +754,3 @@ Object.keys(parameters.$queryParameters) | ||
this.request('GET', domain + path, parameters, body, headers, queryParameters, form, deferred); | ||
this.request('POST', domain + path, parameters, body, headers, queryParameters, form, deferred); | ||
@@ -660,11 +760,10 @@ return deferred.promise; | ||
/** | ||
* Get exam details | ||
* Get instructor details | ||
* @method | ||
* @name Client#getExam | ||
* @name Client#getInstructor | ||
* @param {string} course_id - | ||
* @param {string} exam_id - | ||
* @param {string} enrollment_id - | ||
* @param {string} instructor_id - | ||
* | ||
*/ | ||
Client.prototype.getExam = function(parameters) { | ||
Client.prototype.getInstructor = function(parameters) { | ||
if (parameters === undefined) { | ||
@@ -676,3 +775,3 @@ parameters = {}; | ||
var domain = this.domain; | ||
var path = '/v1/courses/{course_id}/exams/{exam_id}'; | ||
var path = '/v1/courses/{course_id}/instructors/{instructor_id}'; | ||
@@ -691,18 +790,9 @@ var body; | ||
path = path.replace('{exam_id}', parameters['exam_id']); | ||
path = path.replace('{instructor_id}', parameters['instructor_id']); | ||
if (parameters['exam_id'] === undefined) { | ||
deferred.reject(new Error('Missing required parameter: exam_id')); | ||
if (parameters['instructor_id'] === undefined) { | ||
deferred.reject(new Error('Missing required parameter: instructor_id')); | ||
return deferred.promise; | ||
} | ||
if (parameters['enrollment_id'] !== undefined) { | ||
queryParameters['enrollment_id'] = parameters['enrollment_id']; | ||
} | ||
if (parameters['enrollment_id'] === undefined) { | ||
deferred.reject(new Error('Missing required parameter: enrollment_id')); | ||
return deferred.promise; | ||
} | ||
if (parameters.$queryParameters) { | ||
@@ -721,11 +811,11 @@ Object.keys(parameters.$queryParameters) | ||
/** | ||
* Get agreements to sign | ||
* Get history of current session | ||
* @method | ||
* @name Client#getAgreements | ||
* @name Client#getAgreementHistory | ||
* @param {string} token - | ||
* @param {string} session_id - | ||
* @param {string} location_id - | ||
* @param {string} agreement_id - | ||
* | ||
*/ | ||
Client.prototype.getAgreements = function(parameters) { | ||
Client.prototype.getAgreementHistory = function(parameters) { | ||
if (parameters === undefined) { | ||
@@ -737,3 +827,3 @@ parameters = {}; | ||
var domain = this.domain; | ||
var path = '/v1/sessions/{session_id}/agreements/location/{location_id}'; | ||
var path = '/v1/sessions/{session_id}/agreements/{agreement_id}/history'; | ||
@@ -761,6 +851,6 @@ var body; | ||
path = path.replace('{location_id}', parameters['location_id']); | ||
path = path.replace('{agreement_id}', parameters['agreement_id']); | ||
if (parameters['location_id'] === undefined) { | ||
deferred.reject(new Error('Missing required parameter: location_id')); | ||
if (parameters['agreement_id'] === undefined) { | ||
deferred.reject(new Error('Missing required parameter: agreement_id')); | ||
return deferred.promise; | ||
@@ -782,9 +872,11 @@ } | ||
/** | ||
* Used to login and authenticate proctors | ||
* Get session details for a given exam | ||
* @method | ||
* @name Client#proctorLogin | ||
* @param {} body - | ||
* @name Client#getSession | ||
* @param {string} token - | ||
* @param {string} exam_id - | ||
* @param {string} session_id - | ||
* | ||
*/ | ||
Client.prototype.proctorLogin = function(parameters) { | ||
Client.prototype.getSession = function(parameters) { | ||
if (parameters === undefined) { | ||
@@ -796,3 +888,3 @@ parameters = {}; | ||
var domain = this.domain; | ||
var path = '/v1/proctors/login'; | ||
var path = '/v1/exams/{exam_id}/sessions/{session_id}'; | ||
@@ -804,56 +896,25 @@ var body; | ||
if (parameters['body'] !== undefined) { | ||
body = parameters['body']; | ||
if (parameters['token'] !== undefined) { | ||
headers['token'] = parameters['token']; | ||
} | ||
if (parameters.$queryParameters) { | ||
Object.keys(parameters.$queryParameters) | ||
.forEach(function(parameterName) { | ||
var parameter = parameters.$queryParameters[parameterName]; | ||
queryParameters[parameterName] = parameter; | ||
}); | ||
if (parameters['token'] === undefined) { | ||
deferred.reject(new Error('Missing required parameter: token')); | ||
return deferred.promise; | ||
} | ||
this.request('POST', domain + path, parameters, body, headers, queryParameters, form, deferred); | ||
path = path.replace('{exam_id}', parameters['exam_id']); | ||
return deferred.promise; | ||
}; | ||
/** | ||
* List all instructors for a course | ||
* @method | ||
* @name Client#listInstructors | ||
* @param {string} course_id - | ||
* @param {string} page - | ||
* @param {string} page_size - | ||
* | ||
*/ | ||
Client.prototype.listInstructors = function(parameters) { | ||
if (parameters === undefined) { | ||
parameters = {}; | ||
if (parameters['exam_id'] === undefined) { | ||
deferred.reject(new Error('Missing required parameter: exam_id')); | ||
return deferred.promise; | ||
} | ||
var deferred = Q.defer(); | ||
var domain = this.domain; | ||
var path = '/v1/courses/{course_id}/instructors'; | ||
path = path.replace('{session_id}', parameters['session_id']); | ||
var body; | ||
var queryParameters = {}; | ||
var headers = {}; | ||
var form = {}; | ||
path = path.replace('{course_id}', parameters['course_id']); | ||
if (parameters['course_id'] === undefined) { | ||
deferred.reject(new Error('Missing required parameter: course_id')); | ||
if (parameters['session_id'] === undefined) { | ||
deferred.reject(new Error('Missing required parameter: session_id')); | ||
return deferred.promise; | ||
} | ||
if (parameters['page'] !== undefined) { | ||
queryParameters['page'] = parameters['page']; | ||
} | ||
if (parameters['page_size'] !== undefined) { | ||
queryParameters['page_size'] = parameters['page_size']; | ||
} | ||
if (parameters.$queryParameters) { | ||
@@ -872,10 +933,9 @@ Object.keys(parameters.$queryParameters) | ||
/** | ||
* Start a new session and create permissions | ||
* Used to login and authenticate proctors | ||
* @method | ||
* @name Client#startSession | ||
* @param {string} session_id - Access Key | ||
* @name Client#proctorLogin | ||
* @param {} body - | ||
* | ||
*/ | ||
Client.prototype.startSession = function(parameters) { | ||
Client.prototype.proctorLogin = function(parameters) { | ||
if (parameters === undefined) { | ||
@@ -887,3 +947,3 @@ parameters = {}; | ||
var domain = this.domain; | ||
var path = '/v1/sessions/{session_id}/start'; | ||
var path = '/v1/proctors/login'; | ||
@@ -895,9 +955,2 @@ var body; | ||
path = path.replace('{session_id}', parameters['session_id']); | ||
if (parameters['session_id'] === undefined) { | ||
deferred.reject(new Error('Missing required parameter: session_id')); | ||
return deferred.promise; | ||
} | ||
if (parameters['body'] !== undefined) { | ||
@@ -920,8 +973,10 @@ body = parameters['body']; | ||
/** | ||
* Will return a full list of all institutions | ||
* Get student details | ||
* @method | ||
* @name Client#listInstitutions | ||
* @name Client#getStudent | ||
* @param {string} institution_id - | ||
* @param {string} student_id - | ||
* | ||
*/ | ||
Client.prototype.listInstitutions = function(parameters) { | ||
Client.prototype.getStudent = function(parameters) { | ||
if (parameters === undefined) { | ||
@@ -933,3 +988,3 @@ parameters = {}; | ||
var domain = this.domain; | ||
var path = '/v1/institutions'; | ||
var path = '/v1/institutions/{institution_id}/students/{student_id}'; | ||
@@ -941,60 +996,16 @@ var body; | ||
if (parameters.$queryParameters) { | ||
Object.keys(parameters.$queryParameters) | ||
.forEach(function(parameterName) { | ||
var parameter = parameters.$queryParameters[parameterName]; | ||
queryParameters[parameterName] = parameter; | ||
}); | ||
} | ||
path = path.replace('{institution_id}', parameters['institution_id']); | ||
this.request('GET', domain + path, parameters, body, headers, queryParameters, form, deferred); | ||
return deferred.promise; | ||
}; | ||
/** | ||
* Get session details for a given exam | ||
* @method | ||
* @name Client#getSession | ||
* @param {string} token - | ||
* @param {string} exam_id - | ||
* @param {string} session_id - | ||
* | ||
*/ | ||
Client.prototype.getSession = function(parameters) { | ||
if (parameters === undefined) { | ||
parameters = {}; | ||
} | ||
var deferred = Q.defer(); | ||
var domain = this.domain; | ||
var path = '/v1/exams/{exam_id}/sessions/{session_id}'; | ||
var body; | ||
var queryParameters = {}; | ||
var headers = {}; | ||
var form = {}; | ||
if (parameters['token'] !== undefined) { | ||
headers['token'] = parameters['token']; | ||
} | ||
if (parameters['token'] === undefined) { | ||
deferred.reject(new Error('Missing required parameter: token')); | ||
if (parameters['institution_id'] === undefined) { | ||
deferred.reject(new Error('Missing required parameter: institution_id')); | ||
return deferred.promise; | ||
} | ||
path = path.replace('{exam_id}', parameters['exam_id']); | ||
path = path.replace('{student_id}', parameters['student_id']); | ||
if (parameters['exam_id'] === undefined) { | ||
deferred.reject(new Error('Missing required parameter: exam_id')); | ||
if (parameters['student_id'] === undefined) { | ||
deferred.reject(new Error('Missing required parameter: student_id')); | ||
return deferred.promise; | ||
} | ||
path = path.replace('{session_id}', parameters['session_id']); | ||
if (parameters['session_id'] === undefined) { | ||
deferred.reject(new Error('Missing required parameter: session_id')); | ||
return deferred.promise; | ||
} | ||
if (parameters.$queryParameters) { | ||
@@ -1013,9 +1024,10 @@ Object.keys(parameters.$queryParameters) | ||
/** | ||
* List sessions for a given exam | ||
* Will return return details about a single course | ||
* @method | ||
* @name Client#listSessions | ||
* @param {string} exam_id - | ||
* @name Client#getCourse | ||
* @param {string} course_id - | ||
* @param {string} institution_id - | ||
* | ||
*/ | ||
Client.prototype.listSessions = function(parameters) { | ||
Client.prototype.getCourse = function(parameters) { | ||
if (parameters === undefined) { | ||
@@ -1027,3 +1039,3 @@ parameters = {}; | ||
var domain = this.domain; | ||
var path = '/v1/exams/{exam_id}/sessions'; | ||
var path = '/v1/institutions/{institution_id}/courses/{course_id}'; | ||
@@ -1035,9 +1047,16 @@ var body; | ||
path = path.replace('{exam_id}', parameters['exam_id']); | ||
path = path.replace('{course_id}', parameters['course_id']); | ||
if (parameters['exam_id'] === undefined) { | ||
deferred.reject(new Error('Missing required parameter: exam_id')); | ||
if (parameters['course_id'] === undefined) { | ||
deferred.reject(new Error('Missing required parameter: course_id')); | ||
return deferred.promise; | ||
} | ||
path = path.replace('{institution_id}', parameters['institution_id']); | ||
if (parameters['institution_id'] === undefined) { | ||
deferred.reject(new Error('Missing required parameter: institution_id')); | ||
return deferred.promise; | ||
} | ||
if (parameters.$queryParameters) { | ||
@@ -1056,9 +1075,10 @@ Object.keys(parameters.$queryParameters) | ||
/** | ||
* This endpoint is used to get an image list for an proctor | ||
* Returns the media token needed for the client to connect to the session. | ||
* @method | ||
* @name Client#listProctorImages | ||
* @param {string} user_id - | ||
* @name Client#getMediaToken | ||
* @param {string} session_id - | ||
* @param {string} client_id - | ||
* | ||
*/ | ||
Client.prototype.listProctorImages = function(parameters) { | ||
Client.prototype.getMediaToken = function(parameters) { | ||
if (parameters === undefined) { | ||
@@ -1070,3 +1090,3 @@ parameters = {}; | ||
var domain = this.domain; | ||
var path = '/v1/proctor/{user_id}/images'; | ||
var path = '/v1/sessions/{session_id}/clients/{client_id}/mediatoken'; | ||
@@ -1078,9 +1098,16 @@ var body; | ||
path = path.replace('{user_id}', parameters['user_id']); | ||
path = path.replace('{session_id}', parameters['session_id']); | ||
if (parameters['user_id'] === undefined) { | ||
deferred.reject(new Error('Missing required parameter: user_id')); | ||
if (parameters['session_id'] === undefined) { | ||
deferred.reject(new Error('Missing required parameter: session_id')); | ||
return deferred.promise; | ||
} | ||
path = path.replace('{client_id}', parameters['client_id']); | ||
if (parameters['client_id'] === undefined) { | ||
deferred.reject(new Error('Missing required parameter: client_id')); | ||
return deferred.promise; | ||
} | ||
if (parameters.$queryParameters) { | ||
@@ -1099,10 +1126,11 @@ Object.keys(parameters.$queryParameters) | ||
/** | ||
* This endpoint is used to upload headshot for a proctor | ||
* Get agreements to sign | ||
* @method | ||
* @name Client#uploadProctorImage | ||
* @param {string} user_id - | ||
* @param {} body - | ||
* @name Client#getAgreements | ||
* @param {string} token - | ||
* @param {string} session_id - | ||
* @param {string} location_id - | ||
* | ||
*/ | ||
Client.prototype.uploadProctorImage = function(parameters) { | ||
Client.prototype.getAgreements = function(parameters) { | ||
if (parameters === undefined) { | ||
@@ -1114,3 +1142,3 @@ parameters = {}; | ||
var domain = this.domain; | ||
var path = '/v1/proctor/{user_id}/images'; | ||
var path = '/v1/sessions/{session_id}/agreements/location/{location_id}'; | ||
@@ -1122,50 +1150,22 @@ var body; | ||
path = path.replace('{user_id}', parameters['user_id']); | ||
if (parameters['token'] !== undefined) { | ||
headers['token'] = parameters['token']; | ||
} | ||
if (parameters['user_id'] === undefined) { | ||
deferred.reject(new Error('Missing required parameter: user_id')); | ||
if (parameters['token'] === undefined) { | ||
deferred.reject(new Error('Missing required parameter: token')); | ||
return deferred.promise; | ||
} | ||
if (parameters['body'] !== undefined) { | ||
body = parameters['body']; | ||
} | ||
path = path.replace('{session_id}', parameters['session_id']); | ||
if (parameters.$queryParameters) { | ||
Object.keys(parameters.$queryParameters) | ||
.forEach(function(parameterName) { | ||
var parameter = parameters.$queryParameters[parameterName]; | ||
queryParameters[parameterName] = parameter; | ||
}); | ||
if (parameters['session_id'] === undefined) { | ||
deferred.reject(new Error('Missing required parameter: session_id')); | ||
return deferred.promise; | ||
} | ||
this.request('POST', domain + path, parameters, body, headers, queryParameters, form, deferred); | ||
path = path.replace('{location_id}', parameters['location_id']); | ||
return deferred.promise; | ||
}; | ||
/** | ||
* List all exams for a course | ||
* @method | ||
* @name Client#listExams | ||
* @param {string} course_id - | ||
* | ||
*/ | ||
Client.prototype.listExams = function(parameters) { | ||
if (parameters === undefined) { | ||
parameters = {}; | ||
} | ||
var deferred = Q.defer(); | ||
var domain = this.domain; | ||
var path = '/v1/courses/{course_id}/exams'; | ||
var body; | ||
var queryParameters = {}; | ||
var headers = {}; | ||
var form = {}; | ||
path = path.replace('{course_id}', parameters['course_id']); | ||
if (parameters['course_id'] === undefined) { | ||
deferred.reject(new Error('Missing required parameter: course_id')); | ||
if (parameters['location_id'] === undefined) { | ||
deferred.reject(new Error('Missing required parameter: location_id')); | ||
return deferred.promise; | ||
@@ -1297,10 +1297,11 @@ } | ||
/** | ||
* Get student details | ||
* List incidents for a given session | ||
* @method | ||
* @name Client#getStudent | ||
* @param {string} institution_id - | ||
* @param {string} student_id - | ||
* @name Client#listIncidents | ||
* @param {string} session_id - | ||
* @param {string} page - | ||
* @param {string} page_size - | ||
* | ||
*/ | ||
Client.prototype.getStudent = function(parameters) { | ||
Client.prototype.listIncidents = function(parameters) { | ||
if (parameters === undefined) { | ||
@@ -1312,3 +1313,3 @@ parameters = {}; | ||
var domain = this.domain; | ||
var path = '/v1/institutions/{institution_id}/students/{student_id}'; | ||
var path = '/v1/sessions/{session_id}/incidents'; | ||
@@ -1320,14 +1321,15 @@ var body; | ||
path = path.replace('{institution_id}', parameters['institution_id']); | ||
path = path.replace('{session_id}', parameters['session_id']); | ||
if (parameters['institution_id'] === undefined) { | ||
deferred.reject(new Error('Missing required parameter: institution_id')); | ||
if (parameters['session_id'] === undefined) { | ||
deferred.reject(new Error('Missing required parameter: session_id')); | ||
return deferred.promise; | ||
} | ||
path = path.replace('{student_id}', parameters['student_id']); | ||
if (parameters['page'] !== undefined) { | ||
queryParameters['page'] = parameters['page']; | ||
} | ||
if (parameters['student_id'] === undefined) { | ||
deferred.reject(new Error('Missing required parameter: student_id')); | ||
return deferred.promise; | ||
if (parameters['page_size'] !== undefined) { | ||
queryParameters['page_size'] = parameters['page_size']; | ||
} | ||
@@ -1348,10 +1350,10 @@ | ||
/** | ||
* Returns the media token needed for the client to connect to the session. | ||
* Creates an incident for a given session | ||
* @method | ||
* @name Client#getMediaToken | ||
* @name Client#createIncident | ||
* @param {string} session_id - | ||
* @param {string} client_id - | ||
* @param {} body - | ||
* | ||
*/ | ||
Client.prototype.getMediaToken = function(parameters) { | ||
Client.prototype.createIncident = function(parameters) { | ||
if (parameters === undefined) { | ||
@@ -1363,3 +1365,3 @@ parameters = {}; | ||
var domain = this.domain; | ||
var path = '/v1/sessions/{session_id}/clients/{client_id}/mediatoken'; | ||
var path = '/v1/sessions/{session_id}/incidents'; | ||
@@ -1378,7 +1380,4 @@ var body; | ||
path = path.replace('{client_id}', parameters['client_id']); | ||
if (parameters['client_id'] === undefined) { | ||
deferred.reject(new Error('Missing required parameter: client_id')); | ||
return deferred.promise; | ||
if (parameters['body'] !== undefined) { | ||
body = parameters['body']; | ||
} | ||
@@ -1394,3 +1393,3 @@ | ||
this.request('GET', domain + path, parameters, body, headers, queryParameters, form, deferred); | ||
this.request('POST', domain + path, parameters, body, headers, queryParameters, form, deferred); | ||
@@ -1400,10 +1399,9 @@ return deferred.promise; | ||
/** | ||
* Gets the zookeeper session history | ||
* List sessions for a given exam | ||
* @method | ||
* @name Client#getProcesses | ||
* @param {string} session_id - | ||
* @param {string} zookeeper_id - | ||
* @name Client#listSessions | ||
* @param {string} exam_id - | ||
* | ||
*/ | ||
Client.prototype.getProcesses = function(parameters) { | ||
Client.prototype.listSessions = function(parameters) { | ||
if (parameters === undefined) { | ||
@@ -1415,3 +1413,3 @@ parameters = {}; | ||
var domain = this.domain; | ||
var path = '/v1/sessions/{session_id}/processes'; | ||
var path = '/v1/exams/{exam_id}/sessions'; | ||
@@ -1423,18 +1421,9 @@ var body; | ||
path = path.replace('{session_id}', parameters['session_id']); | ||
path = path.replace('{exam_id}', parameters['exam_id']); | ||
if (parameters['session_id'] === undefined) { | ||
deferred.reject(new Error('Missing required parameter: session_id')); | ||
if (parameters['exam_id'] === undefined) { | ||
deferred.reject(new Error('Missing required parameter: exam_id')); | ||
return deferred.promise; | ||
} | ||
if (parameters['zookeeper_id'] !== undefined) { | ||
queryParameters['zookeeper_id'] = parameters['zookeeper_id']; | ||
} | ||
if (parameters['zookeeper_id'] === undefined) { | ||
deferred.reject(new Error('Missing required parameter: zookeeper_id')); | ||
return deferred.promise; | ||
} | ||
if (parameters.$queryParameters) { | ||
@@ -1453,10 +1442,9 @@ Object.keys(parameters.$queryParameters) | ||
/** | ||
* Updates the session with the current running processes | ||
* Will return return a list of courses for an institution | ||
* @method | ||
* @name Client#sessionProcesses | ||
* @param {string} session_id - | ||
* @param {} body - | ||
* @name Client#listCourses | ||
* @param {string} institution_id - | ||
* | ||
*/ | ||
Client.prototype.sessionProcesses = function(parameters) { | ||
Client.prototype.listCourses = function(parameters) { | ||
if (parameters === undefined) { | ||
@@ -1468,3 +1456,3 @@ parameters = {}; | ||
var domain = this.domain; | ||
var path = '/v1/sessions/{session_id}/processes'; | ||
var path = '/v1/institutions/{institution_id}/courses'; | ||
@@ -1476,13 +1464,9 @@ var body; | ||
path = path.replace('{session_id}', parameters['session_id']); | ||
path = path.replace('{institution_id}', parameters['institution_id']); | ||
if (parameters['session_id'] === undefined) { | ||
deferred.reject(new Error('Missing required parameter: session_id')); | ||
if (parameters['institution_id'] === undefined) { | ||
deferred.reject(new Error('Missing required parameter: institution_id')); | ||
return deferred.promise; | ||
} | ||
if (parameters['body'] !== undefined) { | ||
body = parameters['body']; | ||
} | ||
if (parameters.$queryParameters) { | ||
@@ -1496,3 +1480,3 @@ Object.keys(parameters.$queryParameters) | ||
this.request('PUT', domain + path, parameters, body, headers, queryParameters, form, deferred); | ||
this.request('GET', domain + path, parameters, body, headers, queryParameters, form, deferred); | ||
@@ -1502,10 +1486,8 @@ return deferred.promise; | ||
/** | ||
* Cancel session for a given exam | ||
* Will return a full list of all institutions | ||
* @method | ||
* @name Client#cancelSession | ||
* @param {string} exam_id - | ||
* @param {string} session_id - | ||
* @name Client#listInstitutions | ||
* | ||
*/ | ||
Client.prototype.cancelSession = function(parameters) { | ||
Client.prototype.listInstitutions = function(parameters) { | ||
if (parameters === undefined) { | ||
@@ -1517,3 +1499,3 @@ parameters = {}; | ||
var domain = this.domain; | ||
var path = '/v1/exams/{exam_id}/sessions/{session_id}/cancel'; | ||
var path = '/v1/institutions'; | ||
@@ -1525,16 +1507,34 @@ var body; | ||
path = path.replace('{exam_id}', parameters['exam_id']); | ||
if (parameters['exam_id'] === undefined) { | ||
deferred.reject(new Error('Missing required parameter: exam_id')); | ||
return deferred.promise; | ||
if (parameters.$queryParameters) { | ||
Object.keys(parameters.$queryParameters) | ||
.forEach(function(parameterName) { | ||
var parameter = parameters.$queryParameters[parameterName]; | ||
queryParameters[parameterName] = parameter; | ||
}); | ||
} | ||
path = path.replace('{session_id}', parameters['session_id']); | ||
this.request('GET', domain + path, parameters, body, headers, queryParameters, form, deferred); | ||
if (parameters['session_id'] === undefined) { | ||
deferred.reject(new Error('Missing required parameter: session_id')); | ||
return deferred.promise; | ||
return deferred.promise; | ||
}; | ||
/** | ||
* Used to make sure that the api is current only | ||
* @method | ||
* @name Client#health | ||
* | ||
*/ | ||
Client.prototype.health = function(parameters) { | ||
if (parameters === undefined) { | ||
parameters = {}; | ||
} | ||
var deferred = Q.defer(); | ||
var domain = this.domain; | ||
var path = '/v1'; | ||
var body; | ||
var queryParameters = {}; | ||
var headers = {}; | ||
var form = {}; | ||
if (parameters.$queryParameters) { | ||
@@ -1548,3 +1548,3 @@ Object.keys(parameters.$queryParameters) | ||
this.request('POST', domain + path, parameters, body, headers, queryParameters, form, deferred); | ||
this.request('GET', domain + path, parameters, body, headers, queryParameters, form, deferred); | ||
@@ -1551,0 +1551,0 @@ return deferred.promise; |
@@ -1,1 +0,1 @@ | ||
{"name":"@smarterservices/sp-public-client","version":"0.0.66","description":"the middle layer to microservice architecture for SP that handles tasks like proxying to backend api's,formatting responces,checking permissions","main":"index.js","dependencies":{"q":"latest","request":"latest"},"scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"author":"jordan piepkow","license":null} | ||
{"name":"@smarterservices/sp-public-client","version":"0.0.67","description":"the middle layer to microservice architecture for SP that handles tasks like proxying to backend api's,formatting responces,checking permissions","main":"index.js","dependencies":{"q":"latest","request":"latest"},"scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"author":"jordan piepkow","license":null} |