@smarterservices/sp-public-client
Advanced tools
Comparing version 0.0.61 to 0.0.62
758
index.js
@@ -66,10 +66,11 @@ /*jshint -W069 */ | ||
/** | ||
* Start a new session and create permissions | ||
* List all instructors for a course | ||
* @method | ||
* @name Client#startSession | ||
* @param {string} session_id - Access Key | ||
* @param {} body - | ||
* @name Client#listInstructors | ||
* @param {string} course_id - | ||
* @param {string} page - | ||
* @param {string} page_size - | ||
* | ||
*/ | ||
Client.prototype.startSession = function(parameters) { | ||
Client.prototype.listInstructors = function(parameters) { | ||
if (parameters === undefined) { | ||
@@ -81,3 +82,3 @@ parameters = {}; | ||
var domain = this.domain; | ||
var path = '/v1/sessions/{session_id}/start'; | ||
var path = '/v1/courses/{course_id}/instructors'; | ||
@@ -89,13 +90,17 @@ 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']; | ||
if (parameters['page'] !== undefined) { | ||
queryParameters['page'] = parameters['page']; | ||
} | ||
if (parameters['page_size'] !== undefined) { | ||
queryParameters['page_size'] = parameters['page_size']; | ||
} | ||
if (parameters.$queryParameters) { | ||
@@ -109,3 +114,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); | ||
@@ -115,11 +120,10 @@ return deferred.promise; | ||
/** | ||
* Get exam details | ||
* Gets the zookeeper session history | ||
* @method | ||
* @name Client#getExam | ||
* @param {string} course_id - | ||
* @param {string} exam_id - | ||
* @param {string} enrollment_id - | ||
* @name Client#getProcesses | ||
* @param {string} session_id - | ||
* @param {string} zookeeper_id - | ||
* | ||
*/ | ||
Client.prototype.getExam = function(parameters) { | ||
Client.prototype.getProcesses = function(parameters) { | ||
if (parameters === undefined) { | ||
@@ -131,3 +135,3 @@ parameters = {}; | ||
var domain = this.domain; | ||
var path = '/v1/courses/{course_id}/exams/{exam_id}'; | ||
var path = '/v1/sessions/{session_id}/processes'; | ||
@@ -139,22 +143,15 @@ var body; | ||
path = path.replace('{course_id}', parameters['course_id']); | ||
path = path.replace('{session_id}', parameters['session_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; | ||
} | ||
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['zookeeper_id'] !== undefined) { | ||
queryParameters['zookeeper_id'] = parameters['zookeeper_id']; | ||
} | ||
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')); | ||
if (parameters['zookeeper_id'] === undefined) { | ||
deferred.reject(new Error('Missing required parameter: zookeeper_id')); | ||
return deferred.promise; | ||
@@ -176,9 +173,10 @@ } | ||
/** | ||
* List sessions for a given exam | ||
* Updates the session with the current running processes | ||
* @method | ||
* @name Client#listSessions | ||
* @param {string} exam_id - | ||
* @name Client#sessionProcesses | ||
* @param {string} session_id - | ||
* @param {} body - | ||
* | ||
*/ | ||
Client.prototype.listSessions = function(parameters) { | ||
Client.prototype.sessionProcesses = function(parameters) { | ||
if (parameters === undefined) { | ||
@@ -190,3 +188,3 @@ parameters = {}; | ||
var domain = this.domain; | ||
var path = '/v1/exams/{exam_id}/sessions'; | ||
var path = '/v1/sessions/{session_id}/processes'; | ||
@@ -198,9 +196,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) { | ||
@@ -214,3 +216,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); | ||
@@ -220,8 +222,10 @@ return deferred.promise; | ||
/** | ||
* Will return a full list of all institutions | ||
* Get instructor details | ||
* @method | ||
* @name Client#listInstitutions | ||
* @name Client#getInstructor | ||
* @param {string} course_id - | ||
* @param {string} instructor_id - | ||
* | ||
*/ | ||
Client.prototype.listInstitutions = function(parameters) { | ||
Client.prototype.getInstructor = function(parameters) { | ||
if (parameters === undefined) { | ||
@@ -233,3 +237,3 @@ parameters = {}; | ||
var domain = this.domain; | ||
var path = '/v1/institutions'; | ||
var path = '/v1/courses/{course_id}/instructors/{instructor_id}'; | ||
@@ -241,2 +245,16 @@ 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('{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) { | ||
@@ -255,9 +273,9 @@ Object.keys(parameters.$queryParameters) | ||
/** | ||
* List all exams for a course | ||
* This endpoint is used to get an image list for an proctor | ||
* @method | ||
* @name Client#listExams | ||
* @param {string} course_id - | ||
* @name Client#listProctorImages | ||
* @param {string} user_id - | ||
* | ||
*/ | ||
Client.prototype.listExams = function(parameters) { | ||
Client.prototype.listProctorImages = function(parameters) { | ||
if (parameters === undefined) { | ||
@@ -269,3 +287,3 @@ parameters = {}; | ||
var domain = this.domain; | ||
var path = '/v1/courses/{course_id}/exams'; | ||
var path = '/v1/proctor/{user_id}/images'; | ||
@@ -277,6 +295,6 @@ var body; | ||
path = path.replace('{course_id}', parameters['course_id']); | ||
path = path.replace('{user_id}', parameters['user_id']); | ||
if (parameters['course_id'] === undefined) { | ||
deferred.reject(new Error('Missing required parameter: course_id')); | ||
if (parameters['user_id'] === undefined) { | ||
deferred.reject(new Error('Missing required parameter: user_id')); | ||
return deferred.promise; | ||
@@ -298,11 +316,10 @@ } | ||
/** | ||
* Get agreements to sign | ||
* This endpoint is used to upload headshot for a proctor | ||
* @method | ||
* @name Client#getAgreements | ||
* @param {string} token - | ||
* @param {string} session_id - | ||
* @param {string} location_id - | ||
* @name Client#uploadProctorImage | ||
* @param {string} user_id - | ||
* @param {} body - | ||
* | ||
*/ | ||
Client.prototype.getAgreements = function(parameters) { | ||
Client.prototype.uploadProctorImage = function(parameters) { | ||
if (parameters === undefined) { | ||
@@ -314,3 +331,3 @@ parameters = {}; | ||
var domain = this.domain; | ||
var path = '/v1/sessions/{session_id}/agreements/location/{location_id}'; | ||
var path = '/v1/proctor/{user_id}/images'; | ||
@@ -322,25 +339,45 @@ var body; | ||
if (parameters['token'] !== undefined) { | ||
headers['token'] = parameters['token']; | ||
} | ||
path = path.replace('{user_id}', parameters['user_id']); | ||
if (parameters['token'] === undefined) { | ||
deferred.reject(new Error('Missing required parameter: token')); | ||
if (parameters['user_id'] === undefined) { | ||
deferred.reject(new Error('Missing required parameter: user_id')); | ||
return deferred.promise; | ||
} | ||
path = path.replace('{session_id}', parameters['session_id']); | ||
if (parameters['body'] !== undefined) { | ||
body = parameters['body']; | ||
} | ||
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; | ||
}); | ||
} | ||
path = path.replace('{location_id}', parameters['location_id']); | ||
this.request('POST', domain + path, parameters, body, headers, queryParameters, form, deferred); | ||
if (parameters['location_id'] === undefined) { | ||
deferred.reject(new Error('Missing required parameter: location_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) { | ||
@@ -407,10 +444,11 @@ Object.keys(parameters.$queryParameters) | ||
/** | ||
* Gets the zookeeper session history | ||
* Get exam details | ||
* @method | ||
* @name Client#getProcesses | ||
* @param {string} session_id - | ||
* @param {string} zookeeper_id - | ||
* @name Client#getExam | ||
* @param {string} course_id - | ||
* @param {string} exam_id - | ||
* @param {string} enrollment_id - | ||
* | ||
*/ | ||
Client.prototype.getProcesses = function(parameters) { | ||
Client.prototype.getExam = function(parameters) { | ||
if (parameters === undefined) { | ||
@@ -422,3 +460,3 @@ parameters = {}; | ||
var domain = this.domain; | ||
var path = '/v1/sessions/{session_id}/processes'; | ||
var path = '/v1/courses/{course_id}/exams/{exam_id}'; | ||
@@ -430,15 +468,22 @@ 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['zookeeper_id'] !== undefined) { | ||
queryParameters['zookeeper_id'] = parameters['zookeeper_id']; | ||
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['zookeeper_id'] === undefined) { | ||
deferred.reject(new Error('Missing required parameter: zookeeper_id')); | ||
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; | ||
@@ -460,10 +505,9 @@ } | ||
/** | ||
* Updates the session with the current running processes | ||
* Will return detailed information about an institution | ||
* @method | ||
* @name Client#sessionProcesses | ||
* @param {string} session_id - | ||
* @param {} body - | ||
* @name Client#getInstitution | ||
* @param {string} institution_id - | ||
* | ||
*/ | ||
Client.prototype.sessionProcesses = function(parameters) { | ||
Client.prototype.getInstitution = function(parameters) { | ||
if (parameters === undefined) { | ||
@@ -475,3 +519,3 @@ parameters = {}; | ||
var domain = this.domain; | ||
var path = '/v1/sessions/{session_id}/processes'; | ||
var path = '/v1/institutions/{institution_id}'; | ||
@@ -483,13 +527,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) { | ||
@@ -503,3 +543,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); | ||
@@ -509,10 +549,10 @@ return deferred.promise; | ||
/** | ||
* Cancel session for a given exam | ||
* Returns the media token needed for the client to connect to the session. | ||
* @method | ||
* @name Client#cancelSession | ||
* @param {string} exam_id - | ||
* @name Client#getMediaToken | ||
* @param {string} session_id - | ||
* @param {string} client_id - | ||
* | ||
*/ | ||
Client.prototype.cancelSession = function(parameters) { | ||
Client.prototype.getMediaToken = function(parameters) { | ||
if (parameters === undefined) { | ||
@@ -524,3 +564,3 @@ parameters = {}; | ||
var domain = this.domain; | ||
var path = '/v1/exams/{exam_id}/sessions/{session_id}/cancel'; | ||
var path = '/v1/sessions/{session_id}/clients/{client_id}/mediatoken'; | ||
@@ -532,13 +572,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; | ||
} | ||
path = path.replace('{session_id}', parameters['session_id']); | ||
path = path.replace('{client_id}', parameters['client_id']); | ||
if (parameters['session_id'] === undefined) { | ||
deferred.reject(new Error('Missing required parameter: session_id')); | ||
if (parameters['client_id'] === undefined) { | ||
deferred.reject(new Error('Missing required parameter: client_id')); | ||
return deferred.promise; | ||
@@ -555,3 +595,3 @@ } | ||
this.request('POST', domain + path, parameters, body, headers, queryParameters, form, deferred); | ||
this.request('GET', domain + path, parameters, body, headers, queryParameters, form, deferred); | ||
@@ -632,10 +672,11 @@ return deferred.promise; | ||
/** | ||
* Will return return details about a single course | ||
* Get agreements to sign | ||
* @method | ||
* @name Client#getCourse | ||
* @param {string} course_id - | ||
* @param {string} institution_id - | ||
* @name Client#getAgreements | ||
* @param {string} token - | ||
* @param {string} session_id - | ||
* @param {string} location_id - | ||
* | ||
*/ | ||
Client.prototype.getCourse = function(parameters) { | ||
Client.prototype.getAgreements = function(parameters) { | ||
if (parameters === undefined) { | ||
@@ -647,3 +688,3 @@ parameters = {}; | ||
var domain = this.domain; | ||
var path = '/v1/institutions/{institution_id}/courses/{course_id}'; | ||
var path = '/v1/sessions/{session_id}/agreements/location/{location_id}'; | ||
@@ -655,16 +696,25 @@ var body; | ||
path = path.replace('{course_id}', parameters['course_id']); | ||
if (parameters['token'] !== undefined) { | ||
headers['token'] = parameters['token']; | ||
} | ||
if (parameters['course_id'] === undefined) { | ||
deferred.reject(new Error('Missing required parameter: course_id')); | ||
if (parameters['token'] === undefined) { | ||
deferred.reject(new Error('Missing required parameter: token')); | ||
return deferred.promise; | ||
} | ||
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('{location_id}', parameters['location_id']); | ||
if (parameters['location_id'] === undefined) { | ||
deferred.reject(new Error('Missing required parameter: location_id')); | ||
return deferred.promise; | ||
} | ||
if (parameters.$queryParameters) { | ||
@@ -683,9 +733,10 @@ Object.keys(parameters.$queryParameters) | ||
/** | ||
* List students for a given exam | ||
* Join an existing session and get permissions | ||
* @method | ||
* @name Client#listStudents | ||
* @param {string} exam_id - | ||
* @name Client#joinSession | ||
* @param {string} session_id - Access Key | ||
* @param {} body - | ||
* | ||
*/ | ||
Client.prototype.listStudents = function(parameters) { | ||
Client.prototype.joinSession = function(parameters) { | ||
if (parameters === undefined) { | ||
@@ -697,3 +748,3 @@ parameters = {}; | ||
var domain = this.domain; | ||
var path = '/v1/exams/{exam_id}/students'; | ||
var path = '/v1/sessions/{session_id}/join'; | ||
@@ -705,9 +756,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) { | ||
@@ -721,3 +776,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); | ||
@@ -727,9 +782,9 @@ return deferred.promise; | ||
/** | ||
* Will return return a list of courses for an institution | ||
* List students for a given exam | ||
* @method | ||
* @name Client#listCourses | ||
* @param {string} institution_id - | ||
* @name Client#listStudents | ||
* @param {string} exam_id - | ||
* | ||
*/ | ||
Client.prototype.listCourses = function(parameters) { | ||
Client.prototype.listStudents = function(parameters) { | ||
if (parameters === undefined) { | ||
@@ -741,3 +796,3 @@ parameters = {}; | ||
var domain = this.domain; | ||
var path = '/v1/institutions/{institution_id}/courses'; | ||
var path = '/v1/exams/{exam_id}/students'; | ||
@@ -749,6 +804,6 @@ var body; | ||
path = path.replace('{institution_id}', parameters['institution_id']); | ||
path = path.replace('{exam_id}', parameters['exam_id']); | ||
if (parameters['institution_id'] === undefined) { | ||
deferred.reject(new Error('Missing required parameter: institution_id')); | ||
if (parameters['exam_id'] === undefined) { | ||
deferred.reject(new Error('Missing required parameter: exam_id')); | ||
return deferred.promise; | ||
@@ -770,11 +825,10 @@ } | ||
/** | ||
* Get history of current session | ||
* Will return return details about a single course | ||
* @method | ||
* @name Client#getAgreementHistory | ||
* @param {string} token - | ||
* @param {string} session_id - | ||
* @param {string} agreement_id - | ||
* @name Client#getCourse | ||
* @param {string} course_id - | ||
* @param {string} institution_id - | ||
* | ||
*/ | ||
Client.prototype.getAgreementHistory = function(parameters) { | ||
Client.prototype.getCourse = function(parameters) { | ||
if (parameters === undefined) { | ||
@@ -786,3 +840,3 @@ parameters = {}; | ||
var domain = this.domain; | ||
var path = '/v1/sessions/{session_id}/agreements/{agreement_id}/history'; | ||
var path = '/v1/institutions/{institution_id}/courses/{course_id}'; | ||
@@ -794,25 +848,16 @@ var body; | ||
if (parameters['token'] !== undefined) { | ||
headers['token'] = parameters['token']; | ||
} | ||
path = path.replace('{course_id}', parameters['course_id']); | ||
if (parameters['token'] === undefined) { | ||
deferred.reject(new Error('Missing required parameter: token')); | ||
if (parameters['course_id'] === undefined) { | ||
deferred.reject(new Error('Missing required parameter: course_id')); | ||
return deferred.promise; | ||
} | ||
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; | ||
} | ||
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) { | ||
@@ -831,10 +876,9 @@ Object.keys(parameters.$queryParameters) | ||
/** | ||
* Get instructor details | ||
* Used to login and authenticate proctors | ||
* @method | ||
* @name Client#getInstructor | ||
* @param {string} course_id - | ||
* @param {string} instructor_id - | ||
* @name Client#proctorLogin | ||
* @param {} body - | ||
* | ||
*/ | ||
Client.prototype.getInstructor = function(parameters) { | ||
Client.prototype.proctorLogin = function(parameters) { | ||
if (parameters === undefined) { | ||
@@ -846,3 +890,3 @@ parameters = {}; | ||
var domain = this.domain; | ||
var path = '/v1/courses/{course_id}/instructors/{instructor_id}'; | ||
var path = '/v1/proctors/login'; | ||
@@ -854,16 +898,6 @@ 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; | ||
if (parameters['body'] !== undefined) { | ||
body = parameters['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) { | ||
@@ -877,3 +911,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); | ||
@@ -883,11 +917,9 @@ return deferred.promise; | ||
/** | ||
* List incidents for a given session | ||
* Will return return a list of courses for an institution | ||
* @method | ||
* @name Client#listIncidents | ||
* @param {string} session_id - | ||
* @param {string} page - | ||
* @param {string} page_size - | ||
* @name Client#listCourses | ||
* @param {string} institution_id - | ||
* | ||
*/ | ||
Client.prototype.listIncidents = function(parameters) { | ||
Client.prototype.listCourses = function(parameters) { | ||
if (parameters === undefined) { | ||
@@ -899,3 +931,3 @@ parameters = {}; | ||
var domain = this.domain; | ||
var path = '/v1/sessions/{session_id}/incidents'; | ||
var path = '/v1/institutions/{institution_id}/courses'; | ||
@@ -907,17 +939,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['page'] !== undefined) { | ||
queryParameters['page'] = parameters['page']; | ||
} | ||
if (parameters['page_size'] !== undefined) { | ||
queryParameters['page_size'] = parameters['page_size']; | ||
} | ||
if (parameters.$queryParameters) { | ||
@@ -936,10 +960,11 @@ Object.keys(parameters.$queryParameters) | ||
/** | ||
* Creates an incident for a given session | ||
* Get session details for a given exam | ||
* @method | ||
* @name Client#createIncident | ||
* @name Client#getSession | ||
* @param {string} token - | ||
* @param {string} exam_id - | ||
* @param {string} session_id - | ||
* @param {} body - | ||
* | ||
*/ | ||
Client.prototype.createIncident = function(parameters) { | ||
Client.prototype.getSession = function(parameters) { | ||
if (parameters === undefined) { | ||
@@ -951,3 +976,3 @@ parameters = {}; | ||
var domain = this.domain; | ||
var path = '/v1/sessions/{session_id}/incidents'; | ||
var path = '/v1/exams/{exam_id}/sessions/{session_id}'; | ||
@@ -959,2 +984,18 @@ var body; | ||
if (parameters['token'] !== undefined) { | ||
headers['token'] = parameters['token']; | ||
} | ||
if (parameters['token'] === undefined) { | ||
deferred.reject(new Error('Missing required parameter: token')); | ||
return deferred.promise; | ||
} | ||
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']); | ||
@@ -967,6 +1008,2 @@ | ||
if (parameters['body'] !== undefined) { | ||
body = parameters['body']; | ||
} | ||
if (parameters.$queryParameters) { | ||
@@ -980,3 +1017,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); | ||
@@ -986,9 +1023,11 @@ return deferred.promise; | ||
/** | ||
* Used to login and authenticate proctors | ||
* Get history of current session | ||
* @method | ||
* @name Client#proctorLogin | ||
* @param {} body - | ||
* @name Client#getAgreementHistory | ||
* @param {string} token - | ||
* @param {string} session_id - | ||
* @param {string} agreement_id - | ||
* | ||
*/ | ||
Client.prototype.proctorLogin = function(parameters) { | ||
Client.prototype.getAgreementHistory = function(parameters) { | ||
if (parameters === undefined) { | ||
@@ -1000,3 +1039,3 @@ parameters = {}; | ||
var domain = this.domain; | ||
var path = '/v1/proctors/login'; | ||
var path = '/v1/sessions/{session_id}/agreements/{agreement_id}/history'; | ||
@@ -1008,43 +1047,22 @@ 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('{session_id}', parameters['session_id']); | ||
return deferred.promise; | ||
}; | ||
/** | ||
* This endpoint is used to get an image list for an proctor | ||
* @method | ||
* @name Client#listProctorImages | ||
* @param {string} user_id - | ||
* | ||
*/ | ||
Client.prototype.listProctorImages = function(parameters) { | ||
if (parameters === undefined) { | ||
parameters = {}; | ||
if (parameters['session_id'] === undefined) { | ||
deferred.reject(new Error('Missing required parameter: session_id')); | ||
return deferred.promise; | ||
} | ||
var deferred = Q.defer(); | ||
var domain = this.domain; | ||
var path = '/v1/proctor/{user_id}/images'; | ||
path = path.replace('{agreement_id}', parameters['agreement_id']); | ||
var body; | ||
var queryParameters = {}; | ||
var headers = {}; | ||
var form = {}; | ||
path = path.replace('{user_id}', parameters['user_id']); | ||
if (parameters['user_id'] === undefined) { | ||
deferred.reject(new Error('Missing required parameter: user_id')); | ||
if (parameters['agreement_id'] === undefined) { | ||
deferred.reject(new Error('Missing required parameter: agreement_id')); | ||
return deferred.promise; | ||
@@ -1066,10 +1084,10 @@ } | ||
/** | ||
* This endpoint is used to upload headshot for a proctor | ||
* Start a new session and create permissions | ||
* @method | ||
* @name Client#uploadProctorImage | ||
* @param {string} user_id - | ||
* @name Client#startSession | ||
* @param {string} session_id - Access Key | ||
* @param {} body - | ||
* | ||
*/ | ||
Client.prototype.uploadProctorImage = function(parameters) { | ||
Client.prototype.startSession = function(parameters) { | ||
if (parameters === undefined) { | ||
@@ -1081,3 +1099,3 @@ parameters = {}; | ||
var domain = this.domain; | ||
var path = '/v1/proctor/{user_id}/images'; | ||
var path = '/v1/sessions/{session_id}/start'; | ||
@@ -1089,6 +1107,6 @@ 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; | ||
@@ -1114,10 +1132,8 @@ } | ||
/** | ||
* Join an existing session and get permissions | ||
* Will return a full list of all institutions | ||
* @method | ||
* @name Client#joinSession | ||
* @param {string} session_id - Access Key | ||
* @param {} body - | ||
* @name Client#listInstitutions | ||
* | ||
*/ | ||
Client.prototype.joinSession = function(parameters) { | ||
Client.prototype.listInstitutions = function(parameters) { | ||
if (parameters === undefined) { | ||
@@ -1129,3 +1145,3 @@ parameters = {}; | ||
var domain = this.domain; | ||
var path = '/v1/sessions/{session_id}/join'; | ||
var path = '/v1/institutions'; | ||
@@ -1137,13 +1153,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) { | ||
body = parameters['body']; | ||
} | ||
if (parameters.$queryParameters) { | ||
@@ -1157,3 +1162,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); | ||
@@ -1163,8 +1168,10 @@ return deferred.promise; | ||
/** | ||
* Used to make sure that the api is current only | ||
* Get all the incident types | ||
* @method | ||
* @name Client#health | ||
* @name Client#getIncidentTypes | ||
* @param {string} page - | ||
* @param {string} page_size - | ||
* | ||
*/ | ||
Client.prototype.health = function(parameters) { | ||
Client.prototype.getIncidentTypes = function(parameters) { | ||
if (parameters === undefined) { | ||
@@ -1176,3 +1183,3 @@ parameters = {}; | ||
var domain = this.domain; | ||
var path = '/v1'; | ||
var path = '/v1/incidents/types'; | ||
@@ -1184,2 +1191,10 @@ var body; | ||
if (parameters['page'] !== undefined) { | ||
queryParameters['page'] = parameters['page']; | ||
} | ||
if (parameters['page_size'] !== undefined) { | ||
queryParameters['page_size'] = parameters['page_size']; | ||
} | ||
if (parameters.$queryParameters) { | ||
@@ -1198,11 +1213,9 @@ Object.keys(parameters.$queryParameters) | ||
/** | ||
* This endpoint is used to get an image list for an user | ||
* List sessions for a given exam | ||
* @method | ||
* @name Client#listImages | ||
* @param {string} session_id - | ||
* @param {string} client_id - | ||
* @param {string} type - | ||
* @name Client#listSessions | ||
* @param {string} exam_id - | ||
* | ||
*/ | ||
Client.prototype.listImages = function(parameters) { | ||
Client.prototype.listSessions = function(parameters) { | ||
if (parameters === undefined) { | ||
@@ -1214,3 +1227,3 @@ parameters = {}; | ||
var domain = this.domain; | ||
var path = '/v1/sessions/{session_id}/images'; | ||
var path = '/v1/exams/{exam_id}/sessions'; | ||
@@ -1222,22 +1235,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['client_id'] !== undefined) { | ||
queryParameters['client_id'] = parameters['client_id']; | ||
} | ||
if (parameters['client_id'] === undefined) { | ||
deferred.reject(new Error('Missing required parameter: client_id')); | ||
return deferred.promise; | ||
} | ||
if (parameters['type'] !== undefined) { | ||
queryParameters['type'] = parameters['type']; | ||
} | ||
if (parameters.$queryParameters) { | ||
@@ -1256,11 +1256,11 @@ Object.keys(parameters.$queryParameters) | ||
/** | ||
* This endpoint is used to upload images for a user | ||
* List incidents for a given session | ||
* @method | ||
* @name Client#uploadImage | ||
* @param {string} token - | ||
* @name Client#listIncidents | ||
* @param {string} session_id - | ||
* @param {} body - | ||
* @param {string} page - | ||
* @param {string} page_size - | ||
* | ||
*/ | ||
Client.prototype.uploadImage = function(parameters) { | ||
Client.prototype.listIncidents = function(parameters) { | ||
if (parameters === undefined) { | ||
@@ -1272,3 +1272,3 @@ parameters = {}; | ||
var domain = this.domain; | ||
var path = '/v1/sessions/{session_id}/images'; | ||
var path = '/v1/sessions/{session_id}/incidents'; | ||
@@ -1280,11 +1280,2 @@ var body; | ||
if (parameters['token'] !== undefined) { | ||
headers['token'] = parameters['token']; | ||
} | ||
if (parameters['token'] === undefined) { | ||
deferred.reject(new Error('Missing required parameter: token')); | ||
return deferred.promise; | ||
} | ||
path = path.replace('{session_id}', parameters['session_id']); | ||
@@ -1297,6 +1288,10 @@ | ||
if (parameters['body'] !== undefined) { | ||
body = parameters['body']; | ||
if (parameters['page'] !== undefined) { | ||
queryParameters['page'] = parameters['page']; | ||
} | ||
if (parameters['page_size'] !== undefined) { | ||
queryParameters['page_size'] = parameters['page_size']; | ||
} | ||
if (parameters.$queryParameters) { | ||
@@ -1310,3 +1305,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); | ||
@@ -1316,9 +1311,10 @@ return deferred.promise; | ||
/** | ||
* Will return detailed information about an institution | ||
* Creates an incident for a given session | ||
* @method | ||
* @name Client#getInstitution | ||
* @param {string} institution_id - | ||
* @name Client#createIncident | ||
* @param {string} session_id - | ||
* @param {} body - | ||
* | ||
*/ | ||
Client.prototype.getInstitution = function(parameters) { | ||
Client.prototype.createIncident = function(parameters) { | ||
if (parameters === undefined) { | ||
@@ -1330,3 +1326,3 @@ parameters = {}; | ||
var domain = this.domain; | ||
var path = '/v1/institutions/{institution_id}'; | ||
var path = '/v1/sessions/{session_id}/incidents'; | ||
@@ -1338,9 +1334,13 @@ 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['body'] !== undefined) { | ||
body = parameters['body']; | ||
} | ||
if (parameters.$queryParameters) { | ||
@@ -1354,3 +1354,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); | ||
@@ -1360,11 +1360,9 @@ return deferred.promise; | ||
/** | ||
* List all instructors for a course | ||
* List all exams for a course | ||
* @method | ||
* @name Client#listInstructors | ||
* @name Client#listExams | ||
* @param {string} course_id - | ||
* @param {string} page - | ||
* @param {string} page_size - | ||
* | ||
*/ | ||
Client.prototype.listInstructors = function(parameters) { | ||
Client.prototype.listExams = function(parameters) { | ||
if (parameters === undefined) { | ||
@@ -1376,3 +1374,3 @@ parameters = {}; | ||
var domain = this.domain; | ||
var path = '/v1/courses/{course_id}/instructors'; | ||
var path = '/v1/courses/{course_id}/exams'; | ||
@@ -1391,10 +1389,2 @@ var body; | ||
if (parameters['page'] !== undefined) { | ||
queryParameters['page'] = parameters['page']; | ||
} | ||
if (parameters['page_size'] !== undefined) { | ||
queryParameters['page_size'] = parameters['page_size']; | ||
} | ||
if (parameters.$queryParameters) { | ||
@@ -1413,6 +1403,5 @@ Object.keys(parameters.$queryParameters) | ||
/** | ||
* Get session details for a given exam | ||
* Cancel session for a given exam | ||
* @method | ||
* @name Client#getSession | ||
* @param {string} token - | ||
* @name Client#cancelSession | ||
* @param {string} exam_id - | ||
@@ -1422,3 +1411,3 @@ * @param {string} session_id - | ||
*/ | ||
Client.prototype.getSession = function(parameters) { | ||
Client.prototype.cancelSession = function(parameters) { | ||
if (parameters === undefined) { | ||
@@ -1430,3 +1419,3 @@ parameters = {}; | ||
var domain = this.domain; | ||
var path = '/v1/exams/{exam_id}/sessions/{session_id}'; | ||
var path = '/v1/exams/{exam_id}/sessions/{session_id}/cancel'; | ||
@@ -1438,11 +1427,2 @@ var body; | ||
if (parameters['token'] !== undefined) { | ||
headers['token'] = parameters['token']; | ||
} | ||
if (parameters['token'] === undefined) { | ||
deferred.reject(new Error('Missing required parameter: token')); | ||
return deferred.promise; | ||
} | ||
path = path.replace('{exam_id}', parameters['exam_id']); | ||
@@ -1470,3 +1450,3 @@ | ||
this.request('GET', domain + path, parameters, body, headers, queryParameters, form, deferred); | ||
this.request('POST', domain + path, parameters, body, headers, queryParameters, form, deferred); | ||
@@ -1476,10 +1456,11 @@ return deferred.promise; | ||
/** | ||
* Get all the incident types | ||
* This endpoint is used to get an image list for an user | ||
* @method | ||
* @name Client#getIncidentTypes | ||
* @param {string} page - | ||
* @param {string} page_size - | ||
* @name Client#listImages | ||
* @param {string} session_id - | ||
* @param {string} client_id - | ||
* @param {string} type - | ||
* | ||
*/ | ||
Client.prototype.getIncidentTypes = function(parameters) { | ||
Client.prototype.listImages = function(parameters) { | ||
if (parameters === undefined) { | ||
@@ -1491,3 +1472,3 @@ parameters = {}; | ||
var domain = this.domain; | ||
var path = '/v1/incidents/types'; | ||
var path = '/v1/sessions/{session_id}/images'; | ||
@@ -1499,10 +1480,22 @@ var body; | ||
if (parameters['page'] !== undefined) { | ||
queryParameters['page'] = parameters['page']; | ||
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['page_size'] !== undefined) { | ||
queryParameters['page_size'] = parameters['page_size']; | ||
if (parameters['client_id'] !== undefined) { | ||
queryParameters['client_id'] = parameters['client_id']; | ||
} | ||
if (parameters['client_id'] === undefined) { | ||
deferred.reject(new Error('Missing required parameter: client_id')); | ||
return deferred.promise; | ||
} | ||
if (parameters['type'] !== undefined) { | ||
queryParameters['type'] = parameters['type']; | ||
} | ||
if (parameters.$queryParameters) { | ||
@@ -1521,10 +1514,11 @@ Object.keys(parameters.$queryParameters) | ||
/** | ||
* Returns the media token needed for the client to connect to the session. | ||
* This endpoint is used to upload images for a user | ||
* @method | ||
* @name Client#getMediaToken | ||
* @name Client#uploadImage | ||
* @param {string} token - | ||
* @param {string} session_id - | ||
* @param {string} client_id - | ||
* @param {} body - | ||
* | ||
*/ | ||
Client.prototype.getMediaToken = function(parameters) { | ||
Client.prototype.uploadImage = function(parameters) { | ||
if (parameters === undefined) { | ||
@@ -1536,3 +1530,3 @@ parameters = {}; | ||
var domain = this.domain; | ||
var path = '/v1/sessions/{session_id}/clients/{client_id}/mediatoken'; | ||
var path = '/v1/sessions/{session_id}/images'; | ||
@@ -1544,2 +1538,11 @@ var body; | ||
if (parameters['token'] !== undefined) { | ||
headers['token'] = parameters['token']; | ||
} | ||
if (parameters['token'] === undefined) { | ||
deferred.reject(new Error('Missing required parameter: token')); | ||
return deferred.promise; | ||
} | ||
path = path.replace('{session_id}', parameters['session_id']); | ||
@@ -1552,7 +1555,4 @@ | ||
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']; | ||
} | ||
@@ -1568,3 +1568,3 @@ | ||
this.request('GET', domain + path, parameters, body, headers, queryParameters, form, deferred); | ||
this.request('POST', domain + path, parameters, body, headers, queryParameters, form, deferred); | ||
@@ -1571,0 +1571,0 @@ return deferred.promise; |
@@ -1,1 +0,1 @@ | ||
{"name":"@smarterservices/sp-public-client","version":"0.0.61","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.62","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} |