New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More →
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.83 to 0.0.84

754

index.js

@@ -111,13 +111,10 @@ /*jshint -W069 */

/**
* 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) {

@@ -129,3 +126,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';

@@ -137,11 +134,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']);

@@ -154,20 +142,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) {

@@ -181,3 +158,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);

@@ -187,8 +164,9 @@ return deferred.promise;

/**
* Used to make sure that the api is current only
* Will return detailed information about an institution
* @method
* @name Client#health
* @name Client#getInstitution
* @param {string} institutionId -
*
*/
Client.prototype.health = function(parameters) {
Client.prototype.getInstitution = function(parameters) {
if (parameters === undefined) {

@@ -200,3 +178,3 @@ parameters = {};

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

@@ -208,2 +186,9 @@ var body;

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

@@ -222,11 +207,11 @@ Object.keys(parameters.$queryParameters)

/**
* Get session details for a given exam
* Get agreements to sign
* @method
* @name Client#getSession
* @name Client#getAgreements
* @param {string} token -
* @param {string} examId -
* @param {string} sessionId -
* @param {string} locationId -
*
*/
Client.prototype.getSession = function(parameters) {
Client.prototype.getAgreements = function(parameters) {
if (parameters === undefined) {

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

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

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

@@ -283,5 +268,6 @@ }

/**
* Get all the incident types
* List all instructors for a course
* @method
* @name Client#getIncidentTypes
* @name Client#listInstructors
* @param {string} courseId -
* @param {string} page -

@@ -291,3 +277,3 @@ * @param {string} pageSize -

*/
Client.prototype.getIncidentTypes = function(parameters) {
Client.prototype.listInstructors = function(parameters) {
if (parameters === undefined) {

@@ -299,3 +285,3 @@ parameters = {};

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

@@ -307,2 +293,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;
}
if (parameters['page'] !== undefined) {

@@ -329,11 +322,8 @@ queryParameters['page'] = parameters['page'];

/**
* This endpoint is used to get an image list for an user
* Used to make sure that the api is current only
* @method
* @name Client#listImages
* @param {string} sessionId -
* @param {string} clientId -
* @param {string} type -
* @name Client#health
*
*/
Client.prototype.listImages = function(parameters) {
Client.prototype.health = function(parameters) {
if (parameters === undefined) {

@@ -345,3 +335,3 @@ parameters = {};

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

@@ -353,22 +343,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['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) {

@@ -387,11 +357,10 @@ Object.keys(parameters.$queryParameters)

/**
* This endpoint is used to upload images for a user
* Get instructor details
* @method
* @name Client#uploadImage
* @param {string} token -
* @param {string} sessionId -
* @param {} body -
* @name Client#getInstructor
* @param {string} courseId -
* @param {string} instructorId -
*
*/
Client.prototype.uploadImage = function(parameters) {
Client.prototype.getInstructor = function(parameters) {
if (parameters === undefined) {

@@ -403,3 +372,3 @@ parameters = {};

var domain = this.domain;
var path = '/v1/sessions/{session_id}/images';
var path = '/v1/courses/{course_id}/instructors/{instructor_id}';

@@ -411,22 +380,16 @@ var body;

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

@@ -440,3 +403,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);

@@ -446,8 +409,9 @@ return deferred.promise;

/**
* Will return a full list of all institutions
* Will return return a list of courses for an institution
* @method
* @name Client#listInstitutions
* @name Client#listCourses
* @param {string} institutionId -
*
*/
Client.prototype.listInstitutions = function(parameters) {
Client.prototype.listCourses = function(parameters) {
if (parameters === undefined) {

@@ -459,3 +423,3 @@ parameters = {};

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

@@ -467,2 +431,9 @@ var body;

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

@@ -481,9 +452,9 @@ Object.keys(parameters.$queryParameters)

/**
* Used to login and authenticate proctors
* List all exams for a course
* @method
* @name Client#proctorLogin
* @param {} body -
* @name Client#listExams
* @param {string} courseId -
*
*/
Client.prototype.proctorLogin = function(parameters) {
Client.prototype.listExams = function(parameters) {
if (parameters === undefined) {

@@ -495,3 +466,3 @@ parameters = {};

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

@@ -503,4 +474,7 @@ var body;

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

@@ -516,3 +490,3 @@

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

@@ -522,9 +496,10 @@ return deferred.promise;

/**
* List sessions for a given exam
* Start a new session and create permissions
* @method
* @name Client#listSessions
* @param {string} examId -
* @name Client#startSession
* @param {string} sessionId - Access Key
* @param {} body -
*
*/
Client.prototype.listSessions = function(parameters) {
Client.prototype.startSession = function(parameters) {
if (parameters === undefined) {

@@ -536,3 +511,3 @@ parameters = {};

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

@@ -544,9 +519,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) {

@@ -560,3 +539,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);

@@ -566,9 +545,10 @@ return deferred.promise;

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

@@ -580,3 +560,3 @@ parameters = {};

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

@@ -588,7 +568,8 @@ var body;

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

@@ -704,10 +685,9 @@

/**
* Will return return details about a single course
* List students for a given exam
* @method
* @name Client#getCourse
* @param {string} courseId -
* @param {string} institutionId -
* @name Client#listStudents
* @param {string} examId -
*
*/
Client.prototype.getCourse = function(parameters) {
Client.prototype.listStudents = function(parameters) {
if (parameters === undefined) {

@@ -719,3 +699,3 @@ parameters = {};

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

@@ -727,16 +707,9 @@ var body;

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

@@ -755,9 +728,13 @@ Object.keys(parameters.$queryParameters)

/**
* Will return return a list of courses for an institution
* Sign an agreement
* @method
* @name Client#listCourses
* @param {string} institutionId -
* @name Client#signAgreements
* @param {string} token -
* @param {string} sessionId -
* @param {string} agreementId -
* @param {string} versionId -
* @param {} body -
*
*/
Client.prototype.listCourses = function(parameters) {
Client.prototype.signAgreements = function(parameters) {
if (parameters === undefined) {

@@ -769,3 +746,3 @@ parameters = {};

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

@@ -777,9 +754,36 @@ var body;

path = path.replace('{institution_id}', parameters['institutionId']);
if (parameters['token'] !== undefined) {
headers['token'] = parameters['token'];
}
if (parameters['institutionId'] === undefined) {
deferred.reject(new Error('Missing required parameter: institutionId'));
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;
}
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) {

@@ -793,3 +797,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);

@@ -799,9 +803,10 @@ return deferred.promise;

/**
* This endpoint is used to get an image list for an proctor
* Get student details
* @method
* @name Client#listProctorImages
* @param {string} userId -
* @name Client#getStudent
* @param {string} institutionId -
* @param {string} studentId -
*
*/
Client.prototype.listProctorImages = function(parameters) {
Client.prototype.getStudent = function(parameters) {
if (parameters === undefined) {

@@ -813,3 +818,3 @@ parameters = {};

var domain = this.domain;
var path = '/v1/proctor/{user_id}/images';
var path = '/v1/institutions/{institution_id}/students/{student_id}';

@@ -821,9 +826,16 @@ var body;

path = path.replace('{user_id}', parameters['userId']);
path = path.replace('{institution_id}', parameters['institutionId']);
if (parameters['userId'] === undefined) {
deferred.reject(new Error('Missing required parameter: userId'));
if (parameters['institutionId'] === undefined) {
deferred.reject(new Error('Missing required parameter: institutionId'));
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.$queryParameters) {

@@ -842,10 +854,10 @@ Object.keys(parameters.$queryParameters)

/**
* This endpoint is used to upload headshot for a proctor
* Will return return details about a single course
* @method
* @name Client#uploadProctorImage
* @param {string} userId -
* @param {} body -
* @name Client#getCourse
* @param {string} courseId -
* @param {string} institutionId -
*
*/
Client.prototype.uploadProctorImage = function(parameters) {
Client.prototype.getCourse = function(parameters) {
if (parameters === undefined) {

@@ -857,3 +869,3 @@ parameters = {};

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

@@ -865,11 +877,14 @@ var body;

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

@@ -885,3 +900,3 @@

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

@@ -891,11 +906,9 @@ return deferred.promise;

/**
* List incidents for a given session
* Used to login and authenticate proctors
* @method
* @name Client#listIncidents
* @param {string} sessionId -
* @param {string} page -
* @param {string} pageSize -
* @name Client#proctorLogin
* @param {} body -
*
*/
Client.prototype.listIncidents = function(parameters) {
Client.prototype.proctorLogin = function(parameters) {
if (parameters === undefined) {

@@ -907,3 +920,3 @@ parameters = {};

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

@@ -915,17 +928,6 @@ 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) {
body = parameters['body'];
}
if (parameters['page'] !== undefined) {
queryParameters['page'] = parameters['page'];
}
if (parameters['pageSize'] !== undefined) {
queryParameters['page_size'] = parameters['pageSize'];
}
if (parameters.$queryParameters) {

@@ -939,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);

@@ -945,10 +947,9 @@ return deferred.promise;

/**
* Creates an incident for a given session
* List sessions for a given exam
* @method
* @name Client#createIncident
* @param {string} sessionId -
* @param {} body -
* @name Client#listSessions
* @param {string} examId -
*
*/
Client.prototype.createIncident = function(parameters) {
Client.prototype.listSessions = function(parameters) {
if (parameters === undefined) {

@@ -960,3 +961,3 @@ parameters = {};

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

@@ -968,13 +969,9 @@ var body;

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

@@ -988,3 +985,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);

@@ -994,11 +991,8 @@ return deferred.promise;

/**
* Get history of current session
* Will return a full list of all institutions
* @method
* @name Client#getAgreementHistory
* @param {string} token -
* @param {string} sessionId -
* @param {string} agreementId -
* @name Client#listInstitutions
*
*/
Client.prototype.getAgreementHistory = function(parameters) {
Client.prototype.listInstitutions = function(parameters) {
if (parameters === undefined) {

@@ -1010,3 +1004,3 @@ parameters = {};

var domain = this.domain;
var path = '/v1/sessions/{session_id}/agreements/{agreement_id}/history';
var path = '/v1/institutions';

@@ -1018,25 +1012,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']);
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;
}
if (parameters.$queryParameters) {

@@ -1055,10 +1026,10 @@ Object.keys(parameters.$queryParameters)

/**
* Will return start and end time for a users media
* Join an existing session and get permissions
* @method
* @name Client#videoSetup
* @param {string} userId -
* @name Client#joinSession
* @param {string} sessionId - Access Key
* @param {} body -
*
*/
Client.prototype.videoSetup = function(parameters) {
Client.prototype.joinSession = function(parameters) {
if (parameters === undefined) {

@@ -1070,3 +1041,3 @@ parameters = {};

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

@@ -1078,6 +1049,6 @@ var body;

path = path.replace('{userId}', 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;

@@ -1103,5 +1074,6 @@ }

/**
* Cancel session for a given exam
* Get session details for a given exam
* @method
* @name Client#cancelSession
* @name Client#getSession
* @param {string} token -
* @param {string} examId -

@@ -1111,3 +1083,3 @@ * @param {string} sessionId -

*/
Client.prototype.cancelSession = function(parameters) {
Client.prototype.getSession = function(parameters) {
if (parameters === undefined) {

@@ -1119,3 +1091,3 @@ parameters = {};

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

@@ -1127,2 +1099,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('{exam_id}', parameters['examId']);

@@ -1150,3 +1131,3 @@

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

@@ -1156,10 +1137,11 @@ return deferred.promise;

/**
* Returns the media token needed for the client to connect to the session.
* Get history of current session
* @method
* @name Client#getMediaToken
* @name Client#getAgreementHistory
* @param {string} token -
* @param {string} sessionId -
* @param {string} clientId -
* @param {string} agreementId -
*
*/
Client.prototype.getMediaToken = function(parameters) {
Client.prototype.getAgreementHistory = function(parameters) {
if (parameters === undefined) {

@@ -1171,3 +1153,3 @@ parameters = {};

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

@@ -1179,2 +1161,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']);

@@ -1187,6 +1178,6 @@

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

@@ -1208,10 +1199,11 @@ }

/**
* Get student details
* List incidents for a given session
* @method
* @name Client#getStudent
* @param {string} institutionId -
* @param {string} studentId -
* @name Client#listIncidents
* @param {string} sessionId -
* @param {string} page -
* @param {string} pageSize -
*
*/
Client.prototype.getStudent = function(parameters) {
Client.prototype.listIncidents = function(parameters) {
if (parameters === undefined) {

@@ -1223,3 +1215,3 @@ parameters = {};

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

@@ -1231,14 +1223,15 @@ 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['page'] !== undefined) {
queryParameters['page'] = parameters['page'];
}
if (parameters['studentId'] === undefined) {
deferred.reject(new Error('Missing required parameter: studentId'));
return deferred.promise;
if (parameters['pageSize'] !== undefined) {
queryParameters['page_size'] = parameters['pageSize'];
}

@@ -1259,9 +1252,10 @@

/**
* List all exams for a course
* Creates an incident for a given session
* @method
* @name Client#listExams
* @param {string} courseId -
* @name Client#createIncident
* @param {string} sessionId -
* @param {} body -
*
*/
Client.prototype.listExams = function(parameters) {
Client.prototype.createIncident = function(parameters) {
if (parameters === undefined) {

@@ -1273,3 +1267,3 @@ parameters = {};

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

@@ -1281,9 +1275,13 @@ 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;
}
if (parameters['body'] !== undefined) {
body = parameters['body'];
}
if (parameters.$queryParameters) {

@@ -1297,3 +1295,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);

@@ -1303,10 +1301,9 @@ return deferred.promise;

/**
* Get instructor details
* This endpoint is used to get an image list for an proctor
* @method
* @name Client#getInstructor
* @param {string} courseId -
* @param {string} instructorId -
* @name Client#listProctorImages
* @param {string} userId -
*
*/
Client.prototype.getInstructor = function(parameters) {
Client.prototype.listProctorImages = function(parameters) {
if (parameters === undefined) {

@@ -1318,3 +1315,3 @@ parameters = {};

var domain = this.domain;
var path = '/v1/courses/{course_id}/instructors/{instructor_id}';
var path = '/v1/proctor/{user_id}/images';

@@ -1326,16 +1323,9 @@ var body;

path = path.replace('{course_id}', parameters['courseId']);
path = path.replace('{user_id}', parameters['userId']);
if (parameters['courseId'] === undefined) {
deferred.reject(new Error('Missing required parameter: courseId'));
if (parameters['userId'] === undefined) {
deferred.reject(new Error('Missing required parameter: userId'));
return deferred.promise;
}
path = path.replace('{instructor_id}', parameters['instructorId']);
if (parameters['instructorId'] === undefined) {
deferred.reject(new Error('Missing required parameter: instructorId'));
return deferred.promise;
}
if (parameters.$queryParameters) {

@@ -1354,10 +1344,10 @@ Object.keys(parameters.$queryParameters)

/**
* Join an existing session and get permissions
* This endpoint is used to upload headshot for a proctor
* @method
* @name Client#joinSession
* @param {string} sessionId - Access Key
* @name Client#uploadProctorImage
* @param {string} userId -
* @param {} body -
*
*/
Client.prototype.joinSession = function(parameters) {
Client.prototype.uploadProctorImage = function(parameters) {
if (parameters === undefined) {

@@ -1369,3 +1359,3 @@ parameters = {};

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

@@ -1377,6 +1367,6 @@ var body;

path = path.replace('{session_id}', parameters['sessionId']);
path = path.replace('{user_id}', 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;

@@ -1402,10 +1392,11 @@ }

/**
* Start a new session and create permissions
* This endpoint is used to get an image list for an user
* @method
* @name Client#startSession
* @param {string} sessionId - Access Key
* @param {} body -
* @name Client#listImages
* @param {string} sessionId -
* @param {string} clientId -
* @param {string} type -
*
*/
Client.prototype.startSession = function(parameters) {
Client.prototype.listImages = function(parameters) {
if (parameters === undefined) {

@@ -1417,3 +1408,3 @@ parameters = {};

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

@@ -1432,6 +1423,15 @@ var body;

if (parameters['body'] !== undefined) {
body = parameters['body'];
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) {

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

@@ -1451,9 +1451,11 @@ return deferred.promise;

/**
* Will return detailed information about an institution
* This endpoint is used to upload images for a user
* @method
* @name Client#getInstitution
* @param {string} institutionId -
* @name Client#uploadImage
* @param {string} token -
* @param {string} sessionId -
* @param {} body -
*
*/
Client.prototype.getInstitution = function(parameters) {
Client.prototype.uploadImage = function(parameters) {
if (parameters === undefined) {

@@ -1465,3 +1467,3 @@ parameters = {};

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

@@ -1473,9 +1475,22 @@ var body;

path = path.replace('{institution_id}', parameters['institutionId']);
if (parameters['token'] !== undefined) {
headers['token'] = parameters['token'];
}
if (parameters['institutionId'] === undefined) {
deferred.reject(new Error('Missing required parameter: institutionId'));
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) {
body = parameters['body'];
}
if (parameters.$queryParameters) {

@@ -1489,3 +1504,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);

@@ -1495,11 +1510,11 @@ return deferred.promise;

/**
* List all instructors for a course
* Get exam details
* @method
* @name Client#listInstructors
* @name Client#getExam
* @param {string} courseId -
* @param {string} page -
* @param {string} pageSize -
* @param {string} examId -
* @param {string} enrollmentId -
*
*/
Client.prototype.listInstructors = function(parameters) {
Client.prototype.getExam = function(parameters) {
if (parameters === undefined) {

@@ -1511,3 +1526,3 @@ parameters = {};

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

@@ -1526,10 +1541,18 @@ var body;

if (parameters['page'] !== undefined) {
queryParameters['page'] = parameters['page'];
path = path.replace('{exam_id}', parameters['examId']);
if (parameters['examId'] === undefined) {
deferred.reject(new Error('Missing required parameter: examId'));
return deferred.promise;
}
if (parameters['pageSize'] !== undefined) {
queryParameters['page_size'] = parameters['pageSize'];
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) {

@@ -1548,11 +1571,10 @@ Object.keys(parameters.$queryParameters)

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

@@ -1564,3 +1586,3 @@ parameters = {};

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

@@ -1572,9 +1594,2 @@ 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']);

@@ -1587,8 +1602,6 @@

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

@@ -1605,3 +1618,3 @@ }

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

@@ -1611,11 +1624,10 @@ return deferred.promise;

/**
* Get agreements to sign
* Will return start and end time for a users media
* @method
* @name Client#getAgreements
* @param {string} token -
* @param {string} sessionId -
* @param {string} locationId -
* @name Client#videoSetup
* @param {string} userId -
* @param {} body -
*
*/
Client.prototype.getAgreements = function(parameters) {
Client.prototype.videoSetup = function(parameters) {
if (parameters === undefined) {

@@ -1627,3 +1639,3 @@ parameters = {};

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

@@ -1635,25 +1647,13 @@ var body;

if (parameters['token'] !== undefined) {
headers['token'] = parameters['token'];
}
path = path.replace('{userId}', parameters['userId']);
if (parameters['token'] === undefined) {
deferred.reject(new Error('Missing required parameter: token'));
if (parameters['userId'] === undefined) {
deferred.reject(new Error('Missing required parameter: userId'));
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) {
body = parameters['body'];
}
path = path.replace('{location_id}', parameters['locationId']);
if (parameters['locationId'] === undefined) {
deferred.reject(new Error('Missing required parameter: locationId'));
return deferred.promise;
}
if (parameters.$queryParameters) {

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

@@ -1670,0 +1670,0 @@ return deferred.promise;

2

package.json

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

{"name":"@smarterservices/sp-public-client","version":"0.0.83","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.84","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}
SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

About

Packages

npm

Go

Maven

PyPI

Rubygems

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc