New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More
Socket
Sign inDemoInstall
Socket

@smarterservices/sp-public-client

Package Overview
Dependencies
Maintainers
4
Versions
111
Alerts
File Explorer

Advanced tools

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.71 to 0.0.72

790

index.js

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

/**
* Gets the zookeeper session history
* This endpoint is used to get an image list for an user
* @method
* @name Client#getProcesses
* @name Client#listImages
* @param {string} sessionId -
* @param {string} zookeeperId -
* @param {string} clientId -
* @param {string} type -
*
*/
Client.prototype.getProcesses = function(parameters) {
Client.prototype.listImages = function(parameters) {
if (parameters === undefined) {

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

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

@@ -96,11 +97,15 @@ var body;

if (parameters['zookeeperId'] !== undefined) {
queryParameters['zookeeper_id'] = parameters['zookeeperId'];
if (parameters['clientId'] !== undefined) {
queryParameters['client_id'] = parameters['clientId'];
}
if (parameters['zookeeperId'] === undefined) {
deferred.reject(new Error('Missing required parameter: zookeeperId'));
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) {

@@ -119,5 +124,6 @@ Object.keys(parameters.$queryParameters)

/**
* Updates the session with the current running processes
* This endpoint is used to upload images for a user
* @method
* @name Client#sessionProcesses
* @name Client#uploadImage
* @param {string} token -
* @param {string} sessionId -

@@ -127,3 +133,3 @@ * @param {} body -

*/
Client.prototype.sessionProcesses = function(parameters) {
Client.prototype.uploadImage = function(parameters) {
if (parameters === undefined) {

@@ -135,3 +141,3 @@ parameters = {};

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

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

@@ -163,3 +178,3 @@

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

@@ -169,8 +184,10 @@ return deferred.promise;

/**
* Used to make sure that the api is current only
* Will return start and end time for a users media
* @method
* @name Client#health
* @name Client#videoSetup
* @param {string} userId -
* @param {} body -
*
*/
Client.prototype.health = function(parameters) {
Client.prototype.videoSetup = function(parameters) {
if (parameters === undefined) {

@@ -182,3 +199,3 @@ parameters = {};

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

@@ -190,2 +207,13 @@ var body;

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

@@ -199,2 +227,50 @@ Object.keys(parameters.$queryParameters)

this.request('POST', domain + path, parameters, body, headers, queryParameters, form, deferred);
return deferred.promise;
};
/**
* Get student details
* @method
* @name Client#getStudent
* @param {string} institutionId -
* @param {string} studentId -
*
*/
Client.prototype.getStudent = function(parameters) {
if (parameters === undefined) {
parameters = {};
}
var deferred = Q.defer();
var domain = this.domain;
var path = '/v1/institutions/{institution_id}/students/{student_id}';
var body;
var queryParameters = {};
var headers = {};
var form = {};
path = path.replace('{institution_id}', parameters['institutionId']);
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) {
Object.keys(parameters.$queryParameters)
.forEach(function(parameterName) {
var parameter = parameters.$queryParameters[parameterName];
queryParameters[parameterName] = parameter;
});
}
this.request('GET', domain + path, parameters, body, headers, queryParameters, form, deferred);

@@ -205,2 +281,52 @@

/**
* List all instructors for a course
* @method
* @name Client#listInstructors
* @param {string} courseId -
* @param {string} page -
* @param {string} pageSize -
*
*/
Client.prototype.listInstructors = function(parameters) {
if (parameters === undefined) {
parameters = {};
}
var deferred = Q.defer();
var domain = this.domain;
var path = '/v1/courses/{course_id}/instructors';
var body;
var queryParameters = {};
var headers = {};
var form = {};
path = path.replace('{course_id}', parameters['courseId']);
if (parameters['courseId'] === undefined) {
deferred.reject(new Error('Missing required parameter: courseId'));
return deferred.promise;
}
if (parameters['page'] !== undefined) {
queryParameters['page'] = parameters['page'];
}
if (parameters['pageSize'] !== undefined) {
queryParameters['page_size'] = parameters['pageSize'];
}
if (parameters.$queryParameters) {
Object.keys(parameters.$queryParameters)
.forEach(function(parameterName) {
var parameter = parameters.$queryParameters[parameterName];
queryParameters[parameterName] = parameter;
});
}
this.request('GET', domain + path, parameters, body, headers, queryParameters, form, deferred);
return deferred.promise;
};
/**
* Used to login and authenticate proctors

@@ -301,8 +427,10 @@ * @method

/**
* Will return a full list of all institutions
* Join an existing session and get permissions
* @method
* @name Client#listInstitutions
* @name Client#joinSession
* @param {string} sessionId - Access Key
* @param {} body -
*
*/
Client.prototype.listInstitutions = function(parameters) {
Client.prototype.joinSession = function(parameters) {
if (parameters === undefined) {

@@ -314,3 +442,3 @@ parameters = {};

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

@@ -322,2 +450,13 @@ 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.$queryParameters) {

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

@@ -337,10 +476,10 @@ return deferred.promise;

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

@@ -352,3 +491,3 @@ parameters = {};

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

@@ -360,13 +499,13 @@ 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('{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;

@@ -383,3 +522,3 @@ }

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

@@ -389,11 +528,9 @@ return deferred.promise;

/**
* Get session details for a given exam
* Will return detailed information about an institution
* @method
* @name Client#getSession
* @param {string} token -
* @param {string} examId -
* @param {string} sessionId -
* @name Client#getInstitution
* @param {string} institutionId -
*
*/
Client.prototype.getSession = function(parameters) {
Client.prototype.getInstitution = function(parameters) {
if (parameters === undefined) {

@@ -405,3 +542,3 @@ parameters = {};

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

@@ -413,25 +550,9 @@ 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('{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) {

@@ -450,11 +571,9 @@ Object.keys(parameters.$queryParameters)

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

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

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

@@ -474,25 +593,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('{exam_id}', parameters['examId']);
if (parameters['examId'] === undefined) {
deferred.reject(new Error('Missing required parameter: examId'));
return deferred.promise;
}
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) {

@@ -511,9 +614,10 @@ Object.keys(parameters.$queryParameters)

/**
* This endpoint is used to get an image list for an proctor
* This endpoint is used to upload headshot for a proctor
* @method
* @name Client#listProctorImages
* @name Client#uploadProctorImage
* @param {string} userId -
* @param {} body -
*
*/
Client.prototype.listProctorImages = function(parameters) {
Client.prototype.uploadProctorImage = function(parameters) {
if (parameters === undefined) {

@@ -539,2 +643,6 @@ parameters = {};

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

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

@@ -554,5 +662,5 @@ return deferred.promise;

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

@@ -562,3 +670,3 @@ * @param {} body -

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

@@ -570,3 +678,3 @@ parameters = {};

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

@@ -578,3 +686,3 @@ var body;

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

@@ -603,11 +711,42 @@ if (parameters['userId'] === undefined) {

/**
* List all instructors for a course
* Used to make sure that the api is current only
* @method
* @name Client#listInstructors
* @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) {
Object.keys(parameters.$queryParameters)
.forEach(function(parameterName) {
var parameter = parameters.$queryParameters[parameterName];
queryParameters[parameterName] = parameter;
});
}
this.request('GET', domain + path, parameters, body, headers, queryParameters, form, deferred);
return deferred.promise;
};
/**
* Get instructor details
* @method
* @name Client#getInstructor
* @param {string} courseId -
* @param {string} page -
* @param {string} pageSize -
* @param {string} instructorId -
*
*/
Client.prototype.listInstructors = function(parameters) {
Client.prototype.getInstructor = function(parameters) {
if (parameters === undefined) {

@@ -619,3 +758,3 @@ parameters = {};

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

@@ -634,8 +773,7 @@ var body;

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

@@ -656,11 +794,8 @@

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

@@ -672,3 +807,3 @@ parameters = {};

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

@@ -680,25 +815,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) {

@@ -717,9 +829,10 @@ Object.keys(parameters.$queryParameters)

/**
* Will return return a list of courses for an institution
* Will return return details about a single course
* @method
* @name Client#listCourses
* @name Client#getCourse
* @param {string} courseId -
* @param {string} institutionId -
*
*/
Client.prototype.listCourses = function(parameters) {
Client.prototype.getCourse = function(parameters) {
if (parameters === undefined) {

@@ -731,3 +844,3 @@ parameters = {};

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

@@ -739,2 +852,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('{institution_id}', parameters['institutionId']);

@@ -760,10 +880,9 @@

/**
* Will return an array of videos that contained signed urls and other metadata
* Will return return a list of courses for an institution
* @method
* @name Client#getVideos
* @param {string} userId -
* @param {} body -
* @name Client#listCourses
* @param {string} institutionId -
*
*/
Client.prototype.getVideos = function(parameters) {
Client.prototype.listCourses = function(parameters) {
if (parameters === undefined) {

@@ -775,3 +894,3 @@ parameters = {};

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

@@ -783,13 +902,9 @@ var body;

path = path.replace('{userId}', 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;
}
if (parameters['body'] !== undefined) {
body = parameters['body'];
}
if (parameters.$queryParameters) {

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

@@ -880,11 +995,10 @@ return deferred.promise;

/**
* This endpoint is used to get an image list for an user
* Gets the zookeeper session history
* @method
* @name Client#listImages
* @name Client#getProcesses
* @param {string} sessionId -
* @param {string} clientId -
* @param {string} type -
* @param {string} zookeeperId -
*
*/
Client.prototype.listImages = function(parameters) {
Client.prototype.getProcesses = function(parameters) {
if (parameters === undefined) {

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

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

@@ -911,15 +1025,11 @@ var body;

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

@@ -938,6 +1048,5 @@ Object.keys(parameters.$queryParameters)

/**
* This endpoint is used to upload images for a user
* Updates the session with the current running processes
* @method
* @name Client#uploadImage
* @param {string} token -
* @name Client#sessionProcesses
* @param {string} sessionId -

@@ -947,3 +1056,3 @@ * @param {} body -

*/
Client.prototype.uploadImage = function(parameters) {
Client.prototype.sessionProcesses = function(parameters) {
if (parameters === undefined) {

@@ -955,3 +1064,3 @@ parameters = {};

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

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

@@ -992,3 +1092,3 @@

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

@@ -998,10 +1098,11 @@ return deferred.promise;

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

@@ -1013,3 +1114,3 @@ parameters = {};

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

@@ -1028,54 +1129,18 @@ var body;

path = path.replace('{institution_id}', parameters['institutionId']);
path = path.replace('{exam_id}', parameters['examId']);
if (parameters['institutionId'] === undefined) {
deferred.reject(new Error('Missing required parameter: institutionId'));
if (parameters['examId'] === undefined) {
deferred.reject(new Error('Missing required parameter: examId'));
return deferred.promise;
}
if (parameters.$queryParameters) {
Object.keys(parameters.$queryParameters)
.forEach(function(parameterName) {
var parameter = parameters.$queryParameters[parameterName];
queryParameters[parameterName] = parameter;
});
if (parameters['enrollmentId'] !== undefined) {
queryParameters['enrollment_id'] = parameters['enrollmentId'];
}
this.request('GET', domain + path, parameters, body, headers, queryParameters, form, deferred);
return deferred.promise;
};
/**
* Start a new session and create permissions
* @method
* @name Client#startSession
* @param {string} sessionId - Access Key
* @param {} body -
*
*/
Client.prototype.startSession = function(parameters) {
if (parameters === undefined) {
parameters = {};
}
var deferred = Q.defer();
var domain = this.domain;
var path = '/v1/sessions/{session_id}/start';
var body;
var queryParameters = {};
var headers = {};
var form = {};
path = path.replace('{session_id}', parameters['sessionId']);
if (parameters['sessionId'] === undefined) {
deferred.reject(new Error('Missing required parameter: sessionId'));
if (parameters['enrollmentId'] === undefined) {
deferred.reject(new Error('Missing required parameter: enrollmentId'));
return deferred.promise;
}
if (parameters['body'] !== undefined) {
body = parameters['body'];
}
if (parameters.$queryParameters) {

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

@@ -1095,9 +1160,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) {

@@ -1109,3 +1174,3 @@ parameters = {};

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

@@ -1117,6 +1182,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;

@@ -1138,10 +1203,11 @@ }

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

@@ -1153,3 +1219,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';

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

@@ -1169,6 +1244,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;

@@ -1190,11 +1265,9 @@ }

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

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

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

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

@@ -1243,10 +1308,10 @@ Object.keys(parameters.$queryParameters)

/**
* Creates an incident for a given session
* Start a new session and create permissions
* @method
* @name Client#createIncident
* @param {string} sessionId -
* @name Client#startSession
* @param {string} sessionId - Access Key
* @param {} body -
*
*/
Client.prototype.createIncident = function(parameters) {
Client.prototype.startSession = function(parameters) {
if (parameters === undefined) {

@@ -1258,3 +1323,3 @@ parameters = {};

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

@@ -1330,10 +1395,10 @@ var body;

/**
* Join an existing session and get permissions
* Get all the incident types
* @method
* @name Client#joinSession
* @param {string} sessionId - Access Key
* @param {} body -
* @name Client#getIncidentTypes
* @param {string} page -
* @param {string} pageSize -
*
*/
Client.prototype.joinSession = function(parameters) {
Client.prototype.getIncidentTypes = function(parameters) {
if (parameters === undefined) {

@@ -1345,3 +1410,3 @@ parameters = {};

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

@@ -1353,11 +1418,8 @@ 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['body'] !== undefined) {
body = parameters['body'];
if (parameters['pageSize'] !== undefined) {
queryParameters['page_size'] = parameters['pageSize'];
}

@@ -1373,3 +1435,3 @@

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

@@ -1379,9 +1441,10 @@ return deferred.promise;

/**
* List all exams for a course
* Returns the media token needed for the client to connect to the session.
* @method
* @name Client#listExams
* @param {string} courseId -
* @name Client#getMediaToken
* @param {string} sessionId -
* @param {string} clientId -
*
*/
Client.prototype.listExams = function(parameters) {
Client.prototype.getMediaToken = function(parameters) {
if (parameters === undefined) {

@@ -1393,3 +1456,3 @@ parameters = {};

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

@@ -1401,46 +1464,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.$queryParameters) {
Object.keys(parameters.$queryParameters)
.forEach(function(parameterName) {
var parameter = parameters.$queryParameters[parameterName];
queryParameters[parameterName] = parameter;
});
}
path = path.replace('{client_id}', parameters['clientId']);
this.request('GET', domain + path, parameters, body, headers, queryParameters, form, deferred);
return deferred.promise;
};
/**
* List students for a given exam
* @method
* @name Client#listStudents
* @param {string} examId -
*
*/
Client.prototype.listStudents = function(parameters) {
if (parameters === undefined) {
parameters = {};
}
var deferred = Q.defer();
var domain = this.domain;
var path = '/v1/exams/{exam_id}/students';
var body;
var queryParameters = {};
var headers = {};
var form = {};
path = path.replace('{exam_id}', parameters['examId']);
if (parameters['examId'] === undefined) {
deferred.reject(new Error('Missing required parameter: examId'));
if (parameters['clientId'] === undefined) {
deferred.reject(new Error('Missing required parameter: clientId'));
return deferred.promise;

@@ -1462,5 +1492,6 @@ }

/**
* Get all the incident types
* List incidents for a given session
* @method
* @name Client#getIncidentTypes
* @name Client#listIncidents
* @param {string} sessionId -
* @param {string} page -

@@ -1470,3 +1501,3 @@ * @param {string} pageSize -

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

@@ -1478,3 +1509,3 @@ parameters = {};

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

@@ -1486,2 +1517,9 @@ 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) {

@@ -1508,10 +1546,10 @@ queryParameters['page'] = parameters['page'];

/**
* Will return start and end time for a users media
* Creates an incident for a given session
* @method
* @name Client#videoSetup
* @param {string} userId -
* @name Client#createIncident
* @param {string} sessionId -
* @param {} body -
*
*/
Client.prototype.videoSetup = function(parameters) {
Client.prototype.createIncident = function(parameters) {
if (parameters === undefined) {

@@ -1523,3 +1561,3 @@ parameters = {};

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

@@ -1531,6 +1569,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;

@@ -1556,5 +1594,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 -

@@ -1564,3 +1603,3 @@ * @param {string} sessionId -

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

@@ -1572,3 +1611,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}';

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

@@ -1603,50 +1651,2 @@

this.request('POST', domain + path, parameters, body, headers, queryParameters, form, deferred);
return deferred.promise;
};
/**
* Get student details
* @method
* @name Client#getStudent
* @param {string} institutionId -
* @param {string} studentId -
*
*/
Client.prototype.getStudent = function(parameters) {
if (parameters === undefined) {
parameters = {};
}
var deferred = Q.defer();
var domain = this.domain;
var path = '/v1/institutions/{institution_id}/students/{student_id}';
var body;
var queryParameters = {};
var headers = {};
var form = {};
path = path.replace('{institution_id}', parameters['institutionId']);
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) {
Object.keys(parameters.$queryParameters)
.forEach(function(parameterName) {
var parameter = parameters.$queryParameters[parameterName];
queryParameters[parameterName] = parameter;
});
}
this.request('GET', domain + path, parameters, body, headers, queryParameters, form, deferred);

@@ -1653,0 +1653,0 @@

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

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

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc