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.73 to 0.0.74

818

index.js

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

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

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

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

@@ -90,8 +89,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;

@@ -107,9 +104,2 @@ }

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

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

@@ -129,9 +119,9 @@ return deferred.promise;

/**
* Will return detailed information about an institution
* This endpoint is used to get an image list for an proctor
* @method
* @name Client#getInstitution
* @param {string} institutionId -
* @name Client#listProctorImages
* @param {string} userId -
*
*/
Client.prototype.getInstitution = function(parameters) {
Client.prototype.listProctorImages = function(parameters) {
if (parameters === undefined) {

@@ -143,3 +133,3 @@ parameters = {};

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

@@ -151,6 +141,6 @@ var body;

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

@@ -172,9 +162,10 @@ }

/**
* List students for a given exam
* This endpoint is used to upload headshot for a proctor
* @method
* @name Client#listStudents
* @param {string} examId -
* @name Client#uploadProctorImage
* @param {string} userId -
* @param {} body -
*
*/
Client.prototype.listStudents = function(parameters) {
Client.prototype.uploadProctorImage = function(parameters) {
if (parameters === undefined) {

@@ -186,3 +177,3 @@ parameters = {};

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

@@ -194,9 +185,13 @@ var body;

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

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

@@ -216,11 +211,9 @@ return deferred.promise;

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

@@ -232,3 +225,3 @@ parameters = {};

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

@@ -240,11 +233,2 @@ var body;

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

@@ -257,9 +241,2 @@

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

@@ -278,10 +255,9 @@ Object.keys(parameters.$queryParameters)

/**
* Get student details
* Used to login and authenticate proctors
* @method
* @name Client#getStudent
* @param {string} institutionId -
* @param {string} studentId -
* @name Client#proctorLogin
* @param {} body -
*
*/
Client.prototype.getStudent = function(parameters) {
Client.prototype.proctorLogin = function(parameters) {
if (parameters === undefined) {

@@ -293,3 +269,3 @@ parameters = {};

var domain = this.domain;
var path = '/v1/institutions/{institution_id}/students/{student_id}';
var path = '/v1/proctors/login';

@@ -301,16 +277,6 @@ 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['body'] !== undefined) {
body = parameters['body'];
}
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) {

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

@@ -370,8 +336,11 @@ return deferred.promise;

/**
* Will return a full list of all institutions
* This endpoint is used to get an image list for an user
* @method
* @name Client#listInstitutions
* @name Client#listImages
* @param {string} sessionId -
* @param {string} clientId -
* @param {string} type -
*
*/
Client.prototype.listInstitutions = function(parameters) {
Client.prototype.listImages = function(parameters) {
if (parameters === undefined) {

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

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

@@ -391,2 +360,22 @@ 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) {

@@ -405,9 +394,11 @@ Object.keys(parameters.$queryParameters)

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

@@ -419,3 +410,3 @@ parameters = {};

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

@@ -427,9 +418,22 @@ 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) {
body = parameters['body'];
}
if (parameters.$queryParameters) {

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

@@ -449,10 +453,9 @@ return deferred.promise;

/**
* This endpoint is used to upload headshot for a proctor
* List all exams for a course
* @method
* @name Client#uploadProctorImage
* @param {string} userId -
* @param {} body -
* @name Client#listExams
* @param {string} courseId -
*
*/
Client.prototype.uploadProctorImage = function(parameters) {
Client.prototype.listExams = function(parameters) {
if (parameters === undefined) {

@@ -464,3 +467,3 @@ parameters = {};

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

@@ -472,13 +475,9 @@ 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'];
}
if (parameters.$queryParameters) {

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

@@ -498,10 +497,13 @@ return deferred.promise;

/**
* Will return start and end time for a users media
* Sign an agreement
* @method
* @name Client#videoSetup
* @param {string} userId -
* @name Client#signAgreements
* @param {string} token -
* @param {string} sessionId -
* @param {string} agreementId -
* @param {string} versionId -
* @param {} body -
*
*/
Client.prototype.videoSetup = function(parameters) {
Client.prototype.signAgreements = function(parameters) {
if (parameters === undefined) {

@@ -513,3 +515,3 @@ parameters = {};

var domain = this.domain;
var path = '/v1/{userId}/videoSetup';
var path = '/v1/sessions/{session_id}/agreements/{agreement_id}/versions/{version_id}/sign';

@@ -521,9 +523,32 @@ var body;

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

@@ -546,11 +571,10 @@ body = parameters['body'];

/**
* List incidents for a given session
* Gets the zookeeper session history
* @method
* @name Client#listIncidents
* @name Client#getProcesses
* @param {string} sessionId -
* @param {string} page -
* @param {string} pageSize -
* @param {string} zookeeperId -
*
*/
Client.prototype.listIncidents = function(parameters) {
Client.prototype.getProcesses = function(parameters) {
if (parameters === undefined) {

@@ -562,3 +586,3 @@ parameters = {};

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

@@ -577,8 +601,9 @@ var body;

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

@@ -599,5 +624,5 @@

/**
* Creates an incident for a given session
* Updates the session with the current running processes
* @method
* @name Client#createIncident
* @name Client#sessionProcesses
* @param {string} sessionId -

@@ -607,3 +632,3 @@ * @param {} body -

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

@@ -615,3 +640,3 @@ parameters = {};

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

@@ -642,3 +667,3 @@ var body;

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

@@ -648,10 +673,11 @@ return deferred.promise;

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

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

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

@@ -671,16 +697,25 @@ var body;

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

@@ -699,10 +734,10 @@ Object.keys(parameters.$queryParameters)

/**
* Get all the incident types
* Will return start and end time for a users media
* @method
* @name Client#getIncidentTypes
* @param {string} page -
* @param {string} pageSize -
* @name Client#videoSetup
* @param {string} userId -
* @param {} body -
*
*/
Client.prototype.getIncidentTypes = function(parameters) {
Client.prototype.videoSetup = function(parameters) {
if (parameters === undefined) {

@@ -714,3 +749,3 @@ parameters = {};

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

@@ -722,8 +757,11 @@ var body;

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

@@ -739,3 +777,3 @@

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

@@ -745,13 +783,11 @@ return deferred.promise;

/**
* Sign an agreement
* List all instructors for a course
* @method
* @name Client#signAgreements
* @param {string} token -
* @param {string} sessionId -
* @param {string} agreementId -
* @param {string} versionId -
* @param {} body -
* @name Client#listInstructors
* @param {string} courseId -
* @param {string} page -
* @param {string} pageSize -
*
*/
Client.prototype.signAgreements = function(parameters) {
Client.prototype.listInstructors = function(parameters) {
if (parameters === undefined) {

@@ -763,3 +799,3 @@ parameters = {};

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

@@ -771,36 +807,17 @@ 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']);
if (parameters['sessionId'] === undefined) {
deferred.reject(new Error('Missing required parameter: sessionId'));
return deferred.promise;
if (parameters['page'] !== undefined) {
queryParameters['page'] = parameters['page'];
}
path = path.replace('{agreement_id}', parameters['agreementId']);
if (parameters['agreementId'] === undefined) {
deferred.reject(new Error('Missing required parameter: agreementId'));
return deferred.promise;
if (parameters['pageSize'] !== undefined) {
queryParameters['page_size'] = parameters['pageSize'];
}
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) {

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

@@ -820,10 +837,10 @@ return deferred.promise;

/**
* Will return return details about a single course
* Get all the incident types
* @method
* @name Client#getCourse
* @param {string} courseId -
* @param {string} institutionId -
* @name Client#getIncidentTypes
* @param {string} page -
* @param {string} pageSize -
*
*/
Client.prototype.getCourse = function(parameters) {
Client.prototype.getIncidentTypes = function(parameters) {
if (parameters === undefined) {

@@ -835,3 +852,3 @@ parameters = {};

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

@@ -843,14 +860,8 @@ 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) {
queryParameters['page'] = parameters['page'];
}
path = path.replace('{institution_id}', parameters['institutionId']);
if (parameters['institutionId'] === undefined) {
deferred.reject(new Error('Missing required parameter: institutionId'));
return deferred.promise;
if (parameters['pageSize'] !== undefined) {
queryParameters['page_size'] = parameters['pageSize'];
}

@@ -871,10 +882,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) {

@@ -886,3 +897,3 @@ parameters = {};

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

@@ -894,6 +905,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;

@@ -919,11 +930,8 @@ }

/**
* Get exam details
* Will return a full list of all institutions
* @method
* @name Client#getExam
* @param {string} courseId -
* @param {string} examId -
* @param {string} enrollmentId -
* @name Client#listInstitutions
*
*/
Client.prototype.getExam = function(parameters) {
Client.prototype.listInstitutions = function(parameters) {
if (parameters === undefined) {

@@ -935,3 +943,3 @@ parameters = {};

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

@@ -943,25 +951,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']);
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) {

@@ -980,11 +965,8 @@ Object.keys(parameters.$queryParameters)

/**
* List all instructors for a course
* Used to make sure that the api is current only
* @method
* @name Client#listInstructors
* @param {string} courseId -
* @param {string} page -
* @param {string} pageSize -
* @name Client#health
*
*/
Client.prototype.listInstructors = function(parameters) {
Client.prototype.health = function(parameters) {
if (parameters === undefined) {

@@ -996,3 +978,3 @@ parameters = {};

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

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

@@ -1033,10 +1000,10 @@ Object.keys(parameters.$queryParameters)

/**
* Gets the zookeeper session history
* Returns the media token needed for the client to connect to the session.
* @method
* @name Client#getProcesses
* @name Client#getMediaToken
* @param {string} sessionId -
* @param {string} zookeeperId -
* @param {string} clientId -
*
*/
Client.prototype.getProcesses = function(parameters) {
Client.prototype.getMediaToken = function(parameters) {
if (parameters === undefined) {

@@ -1048,3 +1015,3 @@ parameters = {};

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

@@ -1063,8 +1030,6 @@ var body;

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

@@ -1086,10 +1051,10 @@ }

/**
* Updates the session with the current running processes
* Get instructor details
* @method
* @name Client#sessionProcesses
* @param {string} sessionId -
* @param {} body -
* @name Client#getInstructor
* @param {string} courseId -
* @param {string} instructorId -
*
*/
Client.prototype.sessionProcesses = function(parameters) {
Client.prototype.getInstructor = function(parameters) {
if (parameters === undefined) {

@@ -1101,3 +1066,3 @@ parameters = {};

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

@@ -1109,11 +1074,14 @@ var body;

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

@@ -1129,3 +1097,3 @@

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

@@ -1135,9 +1103,11 @@ return deferred.promise;

/**
* Used to login and authenticate proctors
* Get exam details
* @method
* @name Client#proctorLogin
* @param {} body -
* @name Client#getExam
* @param {string} courseId -
* @param {string} examId -
* @param {string} enrollmentId -
*
*/
Client.prototype.proctorLogin = function(parameters) {
Client.prototype.getExam = function(parameters) {
if (parameters === undefined) {

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

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

@@ -1157,6 +1127,25 @@ 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;
}
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) {

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

@@ -1176,10 +1165,10 @@ return deferred.promise;

/**
* Get instructor details
* Get student details
* @method
* @name Client#getInstructor
* @param {string} courseId -
* @param {string} instructorId -
* @name Client#getStudent
* @param {string} institutionId -
* @param {string} studentId -
*
*/
Client.prototype.getInstructor = function(parameters) {
Client.prototype.getStudent = function(parameters) {
if (parameters === undefined) {

@@ -1191,3 +1180,3 @@ parameters = {};

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

@@ -1199,13 +1188,13 @@ 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;
}
path = path.replace('{instructor_id}', parameters['instructorId']);
path = path.replace('{student_id}', parameters['studentId']);
if (parameters['instructorId'] === undefined) {
deferred.reject(new Error('Missing required parameter: instructorId'));
if (parameters['studentId'] === undefined) {
deferred.reject(new Error('Missing required parameter: studentId'));
return deferred.promise;

@@ -1227,10 +1216,10 @@ }

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

@@ -1242,3 +1231,3 @@ parameters = {};

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

@@ -1250,6 +1239,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;

@@ -1275,10 +1264,11 @@ }

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

@@ -1290,3 +1280,3 @@ parameters = {};

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

@@ -1298,9 +1288,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']);

@@ -1313,2 +1296,10 @@

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

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

@@ -1328,11 +1319,10 @@ return deferred.promise;

/**
* Get history of current session
* Creates an incident for a given session
* @method
* @name Client#getAgreementHistory
* @param {string} token -
* @name Client#createIncident
* @param {string} sessionId -
* @param {string} agreementId -
* @param {} body -
*
*/
Client.prototype.getAgreementHistory = function(parameters) {
Client.prototype.createIncident = function(parameters) {
if (parameters === undefined) {

@@ -1344,3 +1334,3 @@ parameters = {};

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

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

@@ -1369,7 +1350,4 @@

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

@@ -1385,3 +1363,3 @@

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

@@ -1391,9 +1369,10 @@ return deferred.promise;

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

@@ -1405,3 +1384,3 @@ parameters = {};

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

@@ -1413,9 +1392,16 @@ var body;

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

@@ -1434,8 +1420,11 @@ Object.keys(parameters.$queryParameters)

/**
* Used to make sure that the api is current only
* Get history of current session
* @method
* @name Client#health
* @name Client#getAgreementHistory
* @param {string} token -
* @param {string} sessionId -
* @param {string} agreementId -
*
*/
Client.prototype.health = function(parameters) {
Client.prototype.getAgreementHistory = function(parameters) {
if (parameters === undefined) {

@@ -1447,3 +1436,3 @@ parameters = {};

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

@@ -1455,2 +1444,25 @@ 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) {

@@ -1469,9 +1481,9 @@ Object.keys(parameters.$queryParameters)

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

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

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

@@ -1491,6 +1503,6 @@ 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;

@@ -1512,10 +1524,9 @@ }

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

@@ -1527,3 +1538,3 @@ parameters = {};

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

@@ -1535,13 +1546,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) {

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

@@ -1561,11 +1568,11 @@ return deferred.promise;

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

@@ -1577,3 +1584,3 @@ parameters = {};

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

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

@@ -1593,15 +1609,9 @@

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

@@ -1620,11 +1630,10 @@ Object.keys(parameters.$queryParameters)

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

@@ -1636,3 +1645,3 @@ parameters = {};

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

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

@@ -1655,0 +1655,0 @@

2

package.json

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

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