You're Invited: Meet the Socket team at BSidesSF and RSAC - April 27 - May 1.RSVP →
Socket
Sign inDemoInstall
Socket
Sign inDemoInstall

@smarterservices/sp-public-client

Package Overview
Dependencies
Maintainers
4
Versions
111
Alerts
File Explorer

Advanced tools

License
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@smarterservices/sp-public-client - npm Package Compare versions

Comparing version

0.0.74
to
0.0.75

786

index.js

@@ -66,10 +66,8 @@ /*jshint -W069 */

/**
* Cancel session for a given exam
* Will return a full list of all institutions
* @method
* @name Client#cancelSession
* @param {string} examId -
* @param {string} sessionId -
* @name Client#listInstitutions
*
*/
Client.prototype.cancelSession = function(parameters) {
Client.prototype.listInstitutions = function(parameters) {
if (parameters === undefined) {

@@ -81,3 +79,3 @@ parameters = {};

var domain = this.domain;
var path = '/v1/exams/{exam_id}/sessions/{session_id}/cancel';
var path = '/v1/institutions';

@@ -89,16 +87,2 @@ var body;

path = path.replace('{exam_id}', parameters['examId']);
if (parameters['examId'] === undefined) {
deferred.reject(new Error('Missing required parameter: examId'));
return deferred.promise;
}
path = path.replace('{session_id}', parameters['sessionId']);
if (parameters['sessionId'] === undefined) {
deferred.reject(new Error('Missing required parameter: sessionId'));
return deferred.promise;
}
if (parameters.$queryParameters) {

@@ -112,3 +96,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);

@@ -118,9 +102,11 @@ return deferred.promise;

/**
* This endpoint is used to get an image list for an proctor
* This endpoint is used to get an image list for an user
* @method
* @name Client#listProctorImages
* @param {string} userId -
* @name Client#listImages
* @param {string} sessionId -
* @param {string} clientId -
* @param {string} type -
*
*/
Client.prototype.listProctorImages = function(parameters) {
Client.prototype.listImages = function(parameters) {
if (parameters === undefined) {

@@ -132,3 +118,3 @@ parameters = {};

var domain = this.domain;
var path = '/v1/proctor/{user_id}/images';
var path = '/v1/sessions/{session_id}/images';

@@ -140,9 +126,22 @@ var body;

path = path.replace('{user_id}', parameters['userId']);
path = path.replace('{session_id}', parameters['sessionId']);
if (parameters['userId'] === undefined) {
deferred.reject(new Error('Missing required parameter: userId'));
if (parameters['sessionId'] === undefined) {
deferred.reject(new Error('Missing required parameter: sessionId'));
return deferred.promise;
}
if (parameters['clientId'] !== undefined) {
queryParameters['client_id'] = parameters['clientId'];
}
if (parameters['clientId'] === undefined) {
deferred.reject(new Error('Missing required parameter: clientId'));
return deferred.promise;
}
if (parameters['type'] !== undefined) {
queryParameters['type'] = parameters['type'];
}
if (parameters.$queryParameters) {

@@ -161,10 +160,11 @@ Object.keys(parameters.$queryParameters)

/**
* This endpoint is used to upload headshot for a proctor
* This endpoint is used to upload images for a user
* @method
* @name Client#uploadProctorImage
* @param {string} userId -
* @name Client#uploadImage
* @param {string} token -
* @param {string} sessionId -
* @param {} body -
*
*/
Client.prototype.uploadProctorImage = function(parameters) {
Client.prototype.uploadImage = function(parameters) {
if (parameters === undefined) {

@@ -176,3 +176,3 @@ parameters = {};

var domain = this.domain;
var path = '/v1/proctor/{user_id}/images';
var path = '/v1/sessions/{session_id}/images';

@@ -184,9 +184,18 @@ var body;

path = path.replace('{user_id}', parameters['userId']);
if (parameters['token'] !== undefined) {
headers['token'] = parameters['token'];
}
if (parameters['userId'] === undefined) {
deferred.reject(new Error('Missing required parameter: userId'));
if (parameters['token'] === undefined) {
deferred.reject(new Error('Missing required parameter: token'));
return deferred.promise;
}
path = path.replace('{session_id}', parameters['sessionId']);
if (parameters['sessionId'] === undefined) {
deferred.reject(new Error('Missing required parameter: sessionId'));
return deferred.promise;
}
if (parameters['body'] !== undefined) {

@@ -209,9 +218,10 @@ body = parameters['body'];

/**
* List students for a given exam
* Join an existing session and get permissions
* @method
* @name Client#listStudents
* @param {string} examId -
* @name Client#joinSession
* @param {string} sessionId - Access Key
* @param {} body -
*
*/
Client.prototype.listStudents = function(parameters) {
Client.prototype.joinSession = function(parameters) {
if (parameters === undefined) {

@@ -223,3 +233,3 @@ parameters = {};

var domain = this.domain;
var path = '/v1/exams/{exam_id}/students';
var path = '/v1/sessions/{session_id}/join';

@@ -231,9 +241,13 @@ var body;

path = path.replace('{exam_id}', parameters['examId']);
path = path.replace('{session_id}', parameters['sessionId']);
if (parameters['examId'] === undefined) {
deferred.reject(new Error('Missing required parameter: examId'));
if (parameters['sessionId'] === undefined) {
deferred.reject(new Error('Missing required parameter: sessionId'));
return deferred.promise;
}
if (parameters['body'] !== undefined) {
body = parameters['body'];
}
if (parameters.$queryParameters) {

@@ -247,3 +261,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);

@@ -253,9 +267,9 @@ return deferred.promise;

/**
* Used to login and authenticate proctors
* List sessions for a given exam
* @method
* @name Client#proctorLogin
* @param {} body -
* @name Client#listSessions
* @param {string} examId -
*
*/
Client.prototype.proctorLogin = function(parameters) {
Client.prototype.listSessions = function(parameters) {
if (parameters === undefined) {

@@ -267,3 +281,3 @@ parameters = {};

var domain = this.domain;
var path = '/v1/proctors/login';
var path = '/v1/exams/{exam_id}/sessions';

@@ -275,4 +289,7 @@ var body;

if (parameters['body'] !== undefined) {
body = parameters['body'];
path = path.replace('{exam_id}', parameters['examId']);
if (parameters['examId'] === undefined) {
deferred.reject(new Error('Missing required parameter: examId'));
return deferred.promise;
}

@@ -288,3 +305,3 @@

this.request('POST', domain + path, parameters, body, headers, queryParameters, form, deferred);
this.request('GET', domain + path, parameters, body, headers, queryParameters, form, deferred);

@@ -294,9 +311,10 @@ return deferred.promise;

/**
* Will return return a list of courses for an institution
* Gets the zookeeper session history
* @method
* @name Client#listCourses
* @param {string} institutionId -
* @name Client#getProcesses
* @param {string} sessionId -
* @param {string} zookeeperId -
*
*/
Client.prototype.listCourses = function(parameters) {
Client.prototype.getProcesses = function(parameters) {
if (parameters === undefined) {

@@ -308,3 +326,3 @@ parameters = {};

var domain = this.domain;
var path = '/v1/institutions/{institution_id}/courses';
var path = '/v1/sessions/{session_id}/processes';

@@ -316,9 +334,18 @@ var body;

path = path.replace('{institution_id}', parameters['institutionId']);
path = path.replace('{session_id}', parameters['sessionId']);
if (parameters['institutionId'] === undefined) {
deferred.reject(new Error('Missing required parameter: institutionId'));
if (parameters['sessionId'] === undefined) {
deferred.reject(new Error('Missing required parameter: sessionId'));
return deferred.promise;
}
if (parameters['zookeeperId'] !== undefined) {
queryParameters['zookeeper_id'] = parameters['zookeeperId'];
}
if (parameters['zookeeperId'] === undefined) {
deferred.reject(new Error('Missing required parameter: zookeeperId'));
return deferred.promise;
}
if (parameters.$queryParameters) {

@@ -337,11 +364,10 @@ Object.keys(parameters.$queryParameters)

/**
* This endpoint is used to get an image list for an user
* Updates the session with the current running processes
* @method
* @name Client#listImages
* @name Client#sessionProcesses
* @param {string} sessionId -
* @param {string} clientId -
* @param {string} type -
* @param {} body -
*
*/
Client.prototype.listImages = function(parameters) {
Client.prototype.sessionProcesses = function(parameters) {
if (parameters === undefined) {

@@ -353,3 +379,3 @@ parameters = {};

var domain = this.domain;
var path = '/v1/sessions/{session_id}/images';
var path = '/v1/sessions/{session_id}/processes';

@@ -368,15 +394,6 @@ var body;

if (parameters['clientId'] !== undefined) {
queryParameters['client_id'] = parameters['clientId'];
if (parameters['body'] !== undefined) {
body = parameters['body'];
}
if (parameters['clientId'] === undefined) {
deferred.reject(new Error('Missing required parameter: clientId'));
return deferred.promise;
}
if (parameters['type'] !== undefined) {
queryParameters['type'] = parameters['type'];
}
if (parameters.$queryParameters) {

@@ -390,3 +407,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);

@@ -396,11 +413,10 @@ return deferred.promise;

/**
* This endpoint is used to upload images for a user
* Cancel session for a given exam
* @method
* @name Client#uploadImage
* @param {string} token -
* @name Client#cancelSession
* @param {string} examId -
* @param {string} sessionId -
* @param {} body -
*
*/
Client.prototype.uploadImage = function(parameters) {
Client.prototype.cancelSession = function(parameters) {
if (parameters === undefined) {

@@ -412,3 +428,3 @@ parameters = {};

var domain = this.domain;
var path = '/v1/sessions/{session_id}/images';
var path = '/v1/exams/{exam_id}/sessions/{session_id}/cancel';

@@ -420,8 +436,6 @@ var body;

if (parameters['token'] !== undefined) {
headers['token'] = parameters['token'];
}
path = path.replace('{exam_id}', parameters['examId']);
if (parameters['token'] === undefined) {
deferred.reject(new Error('Missing required parameter: token'));
if (parameters['examId'] === undefined) {
deferred.reject(new Error('Missing required parameter: examId'));
return deferred.promise;

@@ -437,6 +451,2 @@ }

if (parameters['body'] !== undefined) {
body = parameters['body'];
}
if (parameters.$queryParameters) {

@@ -455,9 +465,11 @@ Object.keys(parameters.$queryParameters)

/**
* List all exams for a course
* List all instructors for a course
* @method
* @name Client#listExams
* @name Client#listInstructors
* @param {string} courseId -
* @param {string} page -
* @param {string} pageSize -
*
*/
Client.prototype.listExams = function(parameters) {
Client.prototype.listInstructors = function(parameters) {
if (parameters === undefined) {

@@ -469,3 +481,3 @@ parameters = {};

var domain = this.domain;
var path = '/v1/courses/{course_id}/exams';
var path = '/v1/courses/{course_id}/instructors';

@@ -484,2 +496,10 @@ var body;

if (parameters['page'] !== undefined) {
queryParameters['page'] = parameters['page'];
}
if (parameters['pageSize'] !== undefined) {
queryParameters['page_size'] = parameters['pageSize'];
}
if (parameters.$queryParameters) {

@@ -498,13 +518,10 @@ Object.keys(parameters.$queryParameters)

/**
* Sign an agreement
* Returns the media token needed for the client to connect to the session.
* @method
* @name Client#signAgreements
* @param {string} token -
* @name Client#getMediaToken
* @param {string} sessionId -
* @param {string} agreementId -
* @param {string} versionId -
* @param {} body -
* @param {string} clientId -
*
*/
Client.prototype.signAgreements = function(parameters) {
Client.prototype.getMediaToken = function(parameters) {
if (parameters === undefined) {

@@ -516,3 +533,3 @@ parameters = {};

var domain = this.domain;
var path = '/v1/sessions/{session_id}/agreements/{agreement_id}/versions/{version_id}/sign';
var path = '/v1/sessions/{session_id}/clients/{client_id}/mediatoken';

@@ -524,11 +541,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['sessionId']);

@@ -541,20 +549,9 @@

path = path.replace('{agreement_id}', parameters['agreementId']);
path = path.replace('{client_id}', parameters['clientId']);
if (parameters['agreementId'] === undefined) {
deferred.reject(new Error('Missing required parameter: agreementId'));
if (parameters['clientId'] === undefined) {
deferred.reject(new Error('Missing required parameter: clientId'));
return deferred.promise;
}
path = path.replace('{version_id}', parameters['versionId']);
if (parameters['versionId'] === undefined) {
deferred.reject(new Error('Missing required parameter: versionId'));
return deferred.promise;
}
if (parameters['body'] !== undefined) {
body = parameters['body'];
}
if (parameters.$queryParameters) {

@@ -568,3 +565,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);

@@ -574,10 +571,11 @@ return deferred.promise;

/**
* Gets the zookeeper session history
* Get agreements to sign
* @method
* @name Client#getProcesses
* @name Client#getAgreements
* @param {string} token -
* @param {string} sessionId -
* @param {string} zookeeperId -
* @param {string} locationId -
*
*/
Client.prototype.getProcesses = function(parameters) {
Client.prototype.getAgreements = function(parameters) {
if (parameters === undefined) {

@@ -589,3 +587,3 @@ parameters = {};

var domain = this.domain;
var path = '/v1/sessions/{session_id}/processes';
var path = '/v1/sessions/{session_id}/agreements/location/{location_id}';

@@ -597,2 +595,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['sessionId']);

@@ -605,8 +612,6 @@

if (parameters['zookeeperId'] !== undefined) {
queryParameters['zookeeper_id'] = parameters['zookeeperId'];
}
path = path.replace('{location_id}', parameters['locationId']);
if (parameters['zookeeperId'] === undefined) {
deferred.reject(new Error('Missing required parameter: zookeeperId'));
if (parameters['locationId'] === undefined) {
deferred.reject(new Error('Missing required parameter: locationId'));
return deferred.promise;

@@ -628,10 +633,9 @@ }

/**
* Updates the session with the current running processes
* Used to login and authenticate proctors
* @method
* @name Client#sessionProcesses
* @param {string} sessionId -
* @name Client#proctorLogin
* @param {} body -
*
*/
Client.prototype.sessionProcesses = function(parameters) {
Client.prototype.proctorLogin = function(parameters) {
if (parameters === undefined) {

@@ -643,3 +647,3 @@ parameters = {};

var domain = this.domain;
var path = '/v1/sessions/{session_id}/processes';
var path = '/v1/proctors/login';

@@ -651,9 +655,2 @@ var body;

path = path.replace('{session_id}', parameters['sessionId']);
if (parameters['sessionId'] === undefined) {
deferred.reject(new Error('Missing required parameter: sessionId'));
return deferred.promise;
}
if (parameters['body'] !== undefined) {

@@ -671,3 +668,3 @@ body = parameters['body'];

this.request('PUT', domain + path, parameters, body, headers, queryParameters, form, deferred);
this.request('POST', domain + path, parameters, body, headers, queryParameters, form, deferred);

@@ -677,11 +674,10 @@ return deferred.promise;

/**
* Get session details for a given exam
* Get all the incident types
* @method
* @name Client#getSession
* @param {string} token -
* @param {string} examId -
* @param {string} sessionId -
* @name Client#getIncidentTypes
* @param {string} page -
* @param {string} pageSize -
*
*/
Client.prototype.getSession = function(parameters) {
Client.prototype.getIncidentTypes = function(parameters) {
if (parameters === undefined) {

@@ -693,3 +689,3 @@ parameters = {};

var domain = this.domain;
var path = '/v1/exams/{exam_id}/sessions/{session_id}';
var path = '/v1/incidents/types';

@@ -701,25 +697,10 @@ var body;

if (parameters['token'] !== undefined) {
headers['token'] = parameters['token'];
if (parameters['page'] !== undefined) {
queryParameters['page'] = parameters['page'];
}
if (parameters['token'] === undefined) {
deferred.reject(new Error('Missing required parameter: token'));
return deferred.promise;
if (parameters['pageSize'] !== undefined) {
queryParameters['page_size'] = parameters['pageSize'];
}
path = path.replace('{exam_id}', parameters['examId']);
if (parameters['examId'] === undefined) {
deferred.reject(new Error('Missing required parameter: examId'));
return deferred.promise;
}
path = path.replace('{session_id}', parameters['sessionId']);
if (parameters['sessionId'] === undefined) {
deferred.reject(new Error('Missing required parameter: sessionId'));
return deferred.promise;
}
if (parameters.$queryParameters) {

@@ -738,10 +719,9 @@ Object.keys(parameters.$queryParameters)

/**
* Will return start and end time for a users media
* List students for a given exam
* @method
* @name Client#videoSetup
* @param {string} userId -
* @param {} body -
* @name Client#listStudents
* @param {string} examId -
*
*/
Client.prototype.videoSetup = function(parameters) {
Client.prototype.listStudents = function(parameters) {
if (parameters === undefined) {

@@ -753,3 +733,3 @@ parameters = {};

var domain = this.domain;
var path = '/v1/{userId}/videoSetup';
var path = '/v1/exams/{exam_id}/students';

@@ -761,13 +741,9 @@ var body;

path = path.replace('{userId}', parameters['userId']);
path = path.replace('{exam_id}', parameters['examId']);
if (parameters['userId'] === undefined) {
deferred.reject(new Error('Missing required parameter: userId'));
if (parameters['examId'] === undefined) {
deferred.reject(new Error('Missing required parameter: examId'));
return deferred.promise;
}
if (parameters['body'] !== undefined) {
body = parameters['body'];
}
if (parameters.$queryParameters) {

@@ -781,3 +757,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);

@@ -787,11 +763,9 @@ return deferred.promise;

/**
* List all instructors for a course
* Will return detailed information about an institution
* @method
* @name Client#listInstructors
* @param {string} courseId -
* @param {string} page -
* @param {string} pageSize -
* @name Client#getInstitution
* @param {string} institutionId -
*
*/
Client.prototype.listInstructors = function(parameters) {
Client.prototype.getInstitution = function(parameters) {
if (parameters === undefined) {

@@ -803,3 +777,3 @@ parameters = {};

var domain = this.domain;
var path = '/v1/courses/{course_id}/instructors';
var path = '/v1/institutions/{institution_id}';

@@ -811,17 +785,9 @@ var body;

path = path.replace('{course_id}', parameters['courseId']);
path = path.replace('{institution_id}', parameters['institutionId']);
if (parameters['courseId'] === undefined) {
deferred.reject(new Error('Missing required parameter: courseId'));
if (parameters['institutionId'] === undefined) {
deferred.reject(new Error('Missing required parameter: institutionId'));
return deferred.promise;
}
if (parameters['page'] !== undefined) {
queryParameters['page'] = parameters['page'];
}
if (parameters['pageSize'] !== undefined) {
queryParameters['page_size'] = parameters['pageSize'];
}
if (parameters.$queryParameters) {

@@ -840,10 +806,9 @@ Object.keys(parameters.$queryParameters)

/**
* Get all the incident types
* This endpoint is used to get an image list for an proctor
* @method
* @name Client#getIncidentTypes
* @param {string} page -
* @param {string} pageSize -
* @name Client#listProctorImages
* @param {string} userId -
*
*/
Client.prototype.getIncidentTypes = function(parameters) {
Client.prototype.listProctorImages = function(parameters) {
if (parameters === undefined) {

@@ -855,3 +820,3 @@ parameters = {};

var domain = this.domain;
var path = '/v1/incidents/types';
var path = '/v1/proctor/{user_id}/images';

@@ -863,8 +828,7 @@ var body;

if (parameters['page'] !== undefined) {
queryParameters['page'] = parameters['page'];
}
path = path.replace('{user_id}', parameters['userId']);
if (parameters['pageSize'] !== undefined) {
queryParameters['page_size'] = parameters['pageSize'];
if (parameters['userId'] === undefined) {
deferred.reject(new Error('Missing required parameter: userId'));
return deferred.promise;
}

@@ -885,5 +849,5 @@

/**
* Will return an array of videos that contained signed urls and other metadata
* This endpoint is used to upload headshot for a proctor
* @method
* @name Client#getVideos
* @name Client#uploadProctorImage
* @param {string} userId -

@@ -893,3 +857,3 @@ * @param {} body -

*/
Client.prototype.getVideos = function(parameters) {
Client.prototype.uploadProctorImage = function(parameters) {
if (parameters === undefined) {

@@ -901,3 +865,3 @@ parameters = {};

var domain = this.domain;
var path = '/v1/{userId}/videos';
var path = '/v1/proctor/{user_id}/images';

@@ -909,3 +873,3 @@ var body;

path = path.replace('{userId}', parameters['userId']);
path = path.replace('{user_id}', parameters['userId']);

@@ -934,8 +898,10 @@ if (parameters['userId'] === undefined) {

/**
* Will return a full list of all institutions
* Will return start and end time for a users media
* @method
* @name Client#listInstitutions
* @name Client#videoSetup
* @param {string} userId -
* @param {} body -
*
*/
Client.prototype.listInstitutions = function(parameters) {
Client.prototype.videoSetup = function(parameters) {
if (parameters === undefined) {

@@ -947,3 +913,3 @@ parameters = {};

var domain = this.domain;
var path = '/v1/institutions';
var path = '/v1/{userId}/videoSetup';

@@ -955,34 +921,13 @@ var body;

if (parameters.$queryParameters) {
Object.keys(parameters.$queryParameters)
.forEach(function(parameterName) {
var parameter = parameters.$queryParameters[parameterName];
queryParameters[parameterName] = parameter;
});
path = path.replace('{userId}', parameters['userId']);
if (parameters['userId'] === undefined) {
deferred.reject(new Error('Missing required parameter: userId'));
return deferred.promise;
}
this.request('GET', domain + path, parameters, body, headers, queryParameters, form, deferred);
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 = {};
if (parameters['body'] !== undefined) {
body = parameters['body'];
}
var deferred = Q.defer();
var domain = this.domain;
var path = '/v1';
var body;
var queryParameters = {};
var headers = {};
var form = {};
if (parameters.$queryParameters) {

@@ -996,3 +941,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);

@@ -1002,10 +947,10 @@ return deferred.promise;

/**
* Returns the media token needed for the client to connect to the session.
* Get student details
* @method
* @name Client#getMediaToken
* @param {string} sessionId -
* @param {string} clientId -
* @name Client#getStudent
* @param {string} institutionId -
* @param {string} studentId -
*
*/
Client.prototype.getMediaToken = function(parameters) {
Client.prototype.getStudent = function(parameters) {
if (parameters === undefined) {

@@ -1017,3 +962,3 @@ parameters = {};

var domain = this.domain;
var path = '/v1/sessions/{session_id}/clients/{client_id}/mediatoken';
var path = '/v1/institutions/{institution_id}/students/{student_id}';

@@ -1025,13 +970,13 @@ var body;

path = path.replace('{session_id}', parameters['sessionId']);
path = path.replace('{institution_id}', parameters['institutionId']);
if (parameters['sessionId'] === undefined) {
deferred.reject(new Error('Missing required parameter: sessionId'));
if (parameters['institutionId'] === undefined) {
deferred.reject(new Error('Missing required parameter: institutionId'));
return deferred.promise;
}
path = path.replace('{client_id}', parameters['clientId']);
path = path.replace('{student_id}', parameters['studentId']);
if (parameters['clientId'] === undefined) {
deferred.reject(new Error('Missing required parameter: clientId'));
if (parameters['studentId'] === undefined) {
deferred.reject(new Error('Missing required parameter: studentId'));
return deferred.promise;

@@ -1053,10 +998,13 @@ }

/**
* Get instructor details
* Sign an agreement
* @method
* @name Client#getInstructor
* @param {string} courseId -
* @param {string} instructorId -
* @name Client#signAgreements
* @param {string} token -
* @param {string} sessionId -
* @param {string} agreementId -
* @param {string} versionId -
* @param {} body -
*
*/
Client.prototype.getInstructor = function(parameters) {
Client.prototype.signAgreements = function(parameters) {
if (parameters === undefined) {

@@ -1068,3 +1016,3 @@ parameters = {};

var domain = this.domain;
var path = '/v1/courses/{course_id}/instructors/{instructor_id}';
var path = '/v1/sessions/{session_id}/agreements/{agreement_id}/versions/{version_id}/sign';

@@ -1076,16 +1024,36 @@ var body;

path = path.replace('{course_id}', parameters['courseId']);
if (parameters['token'] !== undefined) {
headers['token'] = parameters['token'];
}
if (parameters['courseId'] === undefined) {
deferred.reject(new Error('Missing required parameter: courseId'));
if (parameters['token'] === undefined) {
deferred.reject(new Error('Missing required parameter: token'));
return deferred.promise;
}
path = path.replace('{instructor_id}', parameters['instructorId']);
path = path.replace('{session_id}', parameters['sessionId']);
if (parameters['instructorId'] === undefined) {
deferred.reject(new Error('Missing required parameter: instructorId'));
if (parameters['sessionId'] === undefined) {
deferred.reject(new Error('Missing required parameter: sessionId'));
return deferred.promise;
}
path = path.replace('{agreement_id}', parameters['agreementId']);
if (parameters['agreementId'] === undefined) {
deferred.reject(new Error('Missing required parameter: agreementId'));
return deferred.promise;
}
path = path.replace('{version_id}', parameters['versionId']);
if (parameters['versionId'] === undefined) {
deferred.reject(new Error('Missing required parameter: versionId'));
return deferred.promise;
}
if (parameters['body'] !== undefined) {
body = parameters['body'];
}
if (parameters.$queryParameters) {

@@ -1099,3 +1067,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);

@@ -1105,11 +1073,11 @@ return deferred.promise;

/**
* Get exam details
* List incidents for a given session
* @method
* @name Client#getExam
* @param {string} courseId -
* @param {string} examId -
* @param {string} enrollmentId -
* @name Client#listIncidents
* @param {string} sessionId -
* @param {string} page -
* @param {string} pageSize -
*
*/
Client.prototype.getExam = function(parameters) {
Client.prototype.listIncidents = function(parameters) {
if (parameters === undefined) {

@@ -1121,3 +1089,3 @@ parameters = {};

var domain = this.domain;
var path = '/v1/courses/{course_id}/exams/{exam_id}';
var path = '/v1/sessions/{session_id}/incidents';

@@ -1129,25 +1097,17 @@ var body;

path = path.replace('{course_id}', parameters['courseId']);
path = path.replace('{session_id}', parameters['sessionId']);
if (parameters['courseId'] === undefined) {
deferred.reject(new Error('Missing required parameter: courseId'));
if (parameters['sessionId'] === undefined) {
deferred.reject(new Error('Missing required parameter: sessionId'));
return deferred.promise;
}
path = path.replace('{exam_id}', parameters['examId']);
if (parameters['examId'] === undefined) {
deferred.reject(new Error('Missing required parameter: examId'));
return deferred.promise;
if (parameters['page'] !== undefined) {
queryParameters['page'] = parameters['page'];
}
if (parameters['enrollmentId'] !== undefined) {
queryParameters['enrollment_id'] = parameters['enrollmentId'];
if (parameters['pageSize'] !== undefined) {
queryParameters['page_size'] = parameters['pageSize'];
}
if (parameters['enrollmentId'] === undefined) {
deferred.reject(new Error('Missing required parameter: enrollmentId'));
return deferred.promise;
}
if (parameters.$queryParameters) {

@@ -1166,10 +1126,10 @@ Object.keys(parameters.$queryParameters)

/**
* Get student details
* Creates an incident for a given session
* @method
* @name Client#getStudent
* @param {string} institutionId -
* @param {string} studentId -
* @name Client#createIncident
* @param {string} sessionId -
* @param {} body -
*
*/
Client.prototype.getStudent = function(parameters) {
Client.prototype.createIncident = function(parameters) {
if (parameters === undefined) {

@@ -1181,3 +1141,3 @@ parameters = {};

var domain = this.domain;
var path = '/v1/institutions/{institution_id}/students/{student_id}';
var path = '/v1/sessions/{session_id}/incidents';

@@ -1189,14 +1149,11 @@ var body;

path = path.replace('{institution_id}', parameters['institutionId']);
path = path.replace('{session_id}', parameters['sessionId']);
if (parameters['institutionId'] === undefined) {
deferred.reject(new Error('Missing required parameter: institutionId'));
if (parameters['sessionId'] === undefined) {
deferred.reject(new Error('Missing required parameter: sessionId'));
return deferred.promise;
}
path = path.replace('{student_id}', parameters['studentId']);
if (parameters['studentId'] === undefined) {
deferred.reject(new Error('Missing required parameter: studentId'));
return deferred.promise;
if (parameters['body'] !== undefined) {
body = parameters['body'];
}

@@ -1212,3 +1169,3 @@

this.request('GET', domain + path, parameters, body, headers, queryParameters, form, deferred);
this.request('POST', domain + path, parameters, body, headers, queryParameters, form, deferred);

@@ -1263,11 +1220,8 @@ return deferred.promise;

/**
* List incidents for a given session
* Used to make sure that the api is current only
* @method
* @name Client#listIncidents
* @param {string} sessionId -
* @param {string} page -
* @param {string} pageSize -
* @name Client#health
*
*/
Client.prototype.listIncidents = function(parameters) {
Client.prototype.health = function(parameters) {
if (parameters === undefined) {

@@ -1279,3 +1233,3 @@ parameters = {};

var domain = this.domain;
var path = '/v1/sessions/{session_id}/incidents';
var path = '/v1';

@@ -1287,17 +1241,2 @@ var body;

path = path.replace('{session_id}', parameters['sessionId']);
if (parameters['sessionId'] === undefined) {
deferred.reject(new Error('Missing required parameter: sessionId'));
return deferred.promise;
}
if (parameters['page'] !== undefined) {
queryParameters['page'] = parameters['page'];
}
if (parameters['pageSize'] !== undefined) {
queryParameters['page_size'] = parameters['pageSize'];
}
if (parameters.$queryParameters) {

@@ -1316,10 +1255,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} examId -
* @param {string} sessionId -
* @param {} body -
*
*/
Client.prototype.createIncident = function(parameters) {
Client.prototype.getSession = function(parameters) {
if (parameters === undefined) {

@@ -1331,3 +1271,3 @@ parameters = {};

var domain = this.domain;
var path = '/v1/sessions/{session_id}/incidents';
var path = '/v1/exams/{exam_id}/sessions/{session_id}';

@@ -1339,2 +1279,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['examId']);
if (parameters['examId'] === undefined) {
deferred.reject(new Error('Missing required parameter: examId'));
return deferred.promise;
}
path = path.replace('{session_id}', parameters['sessionId']);

@@ -1347,6 +1303,2 @@

if (parameters['body'] !== undefined) {
body = parameters['body'];
}
if (parameters.$queryParameters) {

@@ -1360,3 +1312,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);

@@ -1472,9 +1424,9 @@ return deferred.promise;

/**
* Will return detailed information about an institution
* List all exams for a course
* @method
* @name Client#getInstitution
* @param {string} institutionId -
* @name Client#listExams
* @param {string} courseId -
*
*/
Client.prototype.getInstitution = function(parameters) {
Client.prototype.listExams = function(parameters) {
if (parameters === undefined) {

@@ -1486,3 +1438,3 @@ parameters = {};

var domain = this.domain;
var path = '/v1/institutions/{institution_id}';
var path = '/v1/courses/{course_id}/exams';

@@ -1494,6 +1446,6 @@ var body;

path = path.replace('{institution_id}', parameters['institutionId']);
path = path.replace('{course_id}', parameters['courseId']);
if (parameters['institutionId'] === undefined) {
deferred.reject(new Error('Missing required parameter: institutionId'));
if (parameters['courseId'] === undefined) {
deferred.reject(new Error('Missing required parameter: courseId'));
return deferred.promise;

@@ -1515,9 +1467,11 @@ }

/**
* List sessions for a given exam
* Get exam details
* @method
* @name Client#listSessions
* @name Client#getExam
* @param {string} courseId -
* @param {string} examId -
* @param {string} enrollmentId -
*
*/
Client.prototype.listSessions = function(parameters) {
Client.prototype.getExam = function(parameters) {
if (parameters === undefined) {

@@ -1529,3 +1483,3 @@ parameters = {};

var domain = this.domain;
var path = '/v1/exams/{exam_id}/sessions';
var path = '/v1/courses/{course_id}/exams/{exam_id}';

@@ -1537,2 +1491,9 @@ var body;

path = path.replace('{course_id}', parameters['courseId']);
if (parameters['courseId'] === undefined) {
deferred.reject(new Error('Missing required parameter: courseId'));
return deferred.promise;
}
path = path.replace('{exam_id}', parameters['examId']);

@@ -1545,2 +1506,11 @@

if (parameters['enrollmentId'] !== undefined) {
queryParameters['enrollment_id'] = parameters['enrollmentId'];
}
if (parameters['enrollmentId'] === undefined) {
deferred.reject(new Error('Missing required parameter: enrollmentId'));
return deferred.promise;
}
if (parameters.$queryParameters) {

@@ -1559,11 +1529,9 @@ Object.keys(parameters.$queryParameters)

/**
* Get agreements to sign
* Will return return a list of courses for an institution
* @method
* @name Client#getAgreements
* @param {string} token -
* @param {string} sessionId -
* @param {string} locationId -
* @name Client#listCourses
* @param {string} institutionId -
*
*/
Client.prototype.getAgreements = function(parameters) {
Client.prototype.listCourses = function(parameters) {
if (parameters === undefined) {

@@ -1575,3 +1543,3 @@ parameters = {};

var domain = this.domain;
var path = '/v1/sessions/{session_id}/agreements/location/{location_id}';
var path = '/v1/institutions/{institution_id}/courses';

@@ -1583,22 +1551,54 @@ var body;

if (parameters['token'] !== undefined) {
headers['token'] = parameters['token'];
}
path = path.replace('{institution_id}', parameters['institutionId']);
if (parameters['token'] === undefined) {
deferred.reject(new Error('Missing required parameter: token'));
if (parameters['institutionId'] === undefined) {
deferred.reject(new Error('Missing required parameter: institutionId'));
return deferred.promise;
}
path = path.replace('{session_id}', parameters['sessionId']);
if (parameters.$queryParameters) {
Object.keys(parameters.$queryParameters)
.forEach(function(parameterName) {
var parameter = parameters.$queryParameters[parameterName];
queryParameters[parameterName] = parameter;
});
}
if (parameters['sessionId'] === undefined) {
deferred.reject(new Error('Missing required parameter: sessionId'));
this.request('GET', domain + path, parameters, body, headers, queryParameters, form, deferred);
return deferred.promise;
};
/**
* Get instructor details
* @method
* @name Client#getInstructor
* @param {string} courseId -
* @param {string} instructorId -
*
*/
Client.prototype.getInstructor = function(parameters) {
if (parameters === undefined) {
parameters = {};
}
var deferred = Q.defer();
var domain = this.domain;
var path = '/v1/courses/{course_id}/instructors/{instructor_id}';
var body;
var queryParameters = {};
var headers = {};
var form = {};
path = path.replace('{course_id}', parameters['courseId']);
if (parameters['courseId'] === undefined) {
deferred.reject(new Error('Missing required parameter: courseId'));
return deferred.promise;
}
path = path.replace('{location_id}', parameters['locationId']);
path = path.replace('{instructor_id}', parameters['instructorId']);
if (parameters['locationId'] === undefined) {
deferred.reject(new Error('Missing required parameter: locationId'));
if (parameters['instructorId'] === undefined) {
deferred.reject(new Error('Missing required parameter: instructorId'));
return deferred.promise;

@@ -1620,10 +1620,10 @@ }

/**
* Join an existing session and get permissions
* Will return an array of videos that contained signed urls and other metadata
* @method
* @name Client#joinSession
* @param {string} sessionId - Access Key
* @name Client#getVideos
* @param {string} userId -
* @param {} body -
*
*/
Client.prototype.joinSession = function(parameters) {
Client.prototype.getVideos = function(parameters) {
if (parameters === undefined) {

@@ -1635,3 +1635,3 @@ parameters = {};

var domain = this.domain;
var path = '/v1/sessions/{session_id}/join';
var path = '/v1/{userId}/videos';

@@ -1643,6 +1643,6 @@ var body;

path = path.replace('{session_id}', parameters['sessionId']);
path = path.replace('{userId}', parameters['userId']);
if (parameters['sessionId'] === undefined) {
deferred.reject(new Error('Missing required parameter: sessionId'));
if (parameters['userId'] === undefined) {
deferred.reject(new Error('Missing required parameter: userId'));
return deferred.promise;

@@ -1649,0 +1649,0 @@ }

2

package.json

@@ -1,1 +0,1 @@

{"name":"@smarterservices/sp-public-client","version":"0.0.74","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.75","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}