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.84 to 0.0.85

850

index.js

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

/**
* Will return an array of videos that contained signed urls and other metadata
* Get session details for a given exam
* @method
* @name Client#getVideos
* @param {string} userId -
* @param {} body -
* @name Client#getSession
* @param {string} token -
* @param {string} examId -
* @param {string} sessionId -
*
*/
Client.prototype.getVideos = function(parameters) {
Client.prototype.getSession = function(parameters) {
if (parameters === undefined) {

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

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

@@ -89,47 +90,18 @@ 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;
}
if (parameters['body'] !== undefined) {
body = parameters['body'];
}
path = path.replace('{exam_id}', parameters['examId']);
if (parameters.$queryParameters) {
Object.keys(parameters.$queryParameters)
.forEach(function(parameterName) {
var parameter = parameters.$queryParameters[parameterName];
queryParameters[parameterName] = parameter;
});
if (parameters['examId'] === undefined) {
deferred.reject(new Error('Missing required parameter: examId'));
return deferred.promise;
}
this.request('POST', domain + path, parameters, body, headers, queryParameters, form, deferred);
return deferred.promise;
};
/**
* Returns the media token needed for the client to connect to the session.
* @method
* @name Client#getMediaToken
* @param {string} sessionId -
* @param {string} clientId -
*
*/
Client.prototype.getMediaToken = function(parameters) {
if (parameters === undefined) {
parameters = {};
}
var deferred = Q.defer();
var domain = this.domain;
var path = '/v1/sessions/{session_id}/clients/{client_id}/mediatoken';
var body;
var queryParameters = {};
var headers = {};
var form = {};
path = path.replace('{session_id}', parameters['sessionId']);

@@ -142,9 +114,2 @@

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

@@ -163,9 +128,11 @@ Object.keys(parameters.$queryParameters)

/**
* Will return detailed information about an institution
* List incidents for a given session
* @method
* @name Client#getInstitution
* @param {string} institutionId -
* @name Client#listIncidents
* @param {string} sessionId -
* @param {string} page -
* @param {string} pageSize -
*
*/
Client.prototype.getInstitution = function(parameters) {
Client.prototype.listIncidents = function(parameters) {
if (parameters === undefined) {

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

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

@@ -185,9 +152,17 @@ var body;

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

@@ -206,11 +181,10 @@ Object.keys(parameters.$queryParameters)

/**
* Get agreements to sign
* Creates an incident for a given session
* @method
* @name Client#getAgreements
* @param {string} token -
* @name Client#createIncident
* @param {string} sessionId -
* @param {string} locationId -
* @param {} body -
*
*/
Client.prototype.getAgreements = function(parameters) {
Client.prototype.createIncident = function(parameters) {
if (parameters === undefined) {

@@ -222,3 +196,3 @@ parameters = {};

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

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

@@ -247,7 +212,4 @@

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

@@ -263,3 +225,3 @@

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

@@ -269,11 +231,10 @@ return deferred.promise;

/**
* List all instructors for a course
* Will return an array of videos that contained signed urls and other metadata
* @method
* @name Client#listInstructors
* @param {string} courseId -
* @param {string} page -
* @param {string} pageSize -
* @name Client#getVideos
* @param {string} userId -
* @param {} body -
*
*/
Client.prototype.listInstructors = function(parameters) {
Client.prototype.getVideos = function(parameters) {
if (parameters === undefined) {

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

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

@@ -293,17 +254,13 @@ var body;

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

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

@@ -403,9 +360,10 @@ return deferred.promise;

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

@@ -417,3 +375,3 @@ parameters = {};

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

@@ -425,9 +383,13 @@ var body;

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

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

@@ -447,9 +409,10 @@ return deferred.promise;

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

@@ -461,3 +424,3 @@ parameters = {};

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

@@ -476,2 +439,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) {

@@ -490,10 +460,10 @@ Object.keys(parameters.$queryParameters)

/**
* Start a new session and create permissions
* Get student details
* @method
* @name Client#startSession
* @param {string} sessionId - Access Key
* @param {} body -
* @name Client#getStudent
* @param {string} institutionId -
* @param {string} studentId -
*
*/
Client.prototype.startSession = function(parameters) {
Client.prototype.getStudent = function(parameters) {
if (parameters === undefined) {

@@ -505,3 +475,3 @@ parameters = {};

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

@@ -513,9 +483,49 @@ var body;

path = path.replace('{session_id}', parameters['sessionId']);
path = path.replace('{institution_id}', parameters['institutionId']);
if (parameters['sessionId'] === undefined) {
deferred.reject(new Error('Missing required parameter: sessionId'));
if (parameters['institutionId'] === undefined) {
deferred.reject(new Error('Missing required parameter: institutionId'));
return deferred.promise;
}
path = path.replace('{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);
return deferred.promise;
};
/**
* Used to login and authenticate proctors
* @method
* @name Client#proctorLogin
* @param {} body -
*
*/
Client.prototype.proctorLogin = function(parameters) {
if (parameters === undefined) {
parameters = {};
}
var deferred = Q.defer();
var domain = this.domain;
var path = '/v1/proctors/login';
var body;
var queryParameters = {};
var headers = {};
var form = {};
if (parameters['body'] !== undefined) {

@@ -538,10 +548,9 @@ body = parameters['body'];

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

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

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

@@ -561,8 +570,7 @@ var body;

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

@@ -583,10 +591,10 @@

/**
* Gets the zookeeper session history
* This endpoint is used to upload headshot for a proctor
* @method
* @name Client#getProcesses
* @param {string} sessionId -
* @param {string} zookeeperId -
* @name Client#uploadProctorImage
* @param {string} userId -
* @param {} body -
*
*/
Client.prototype.getProcesses = function(parameters) {
Client.prototype.uploadProctorImage = function(parameters) {
if (parameters === undefined) {

@@ -598,3 +606,3 @@ parameters = {};

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

@@ -606,18 +614,13 @@ 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;
}
if (parameters['zookeeperId'] !== undefined) {
queryParameters['zookeeper_id'] = parameters['zookeeperId'];
if (parameters['body'] !== undefined) {
body = parameters['body'];
}
if (parameters['zookeeperId'] === undefined) {
deferred.reject(new Error('Missing required parameter: zookeeperId'));
return deferred.promise;
}
if (parameters.$queryParameters) {

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

@@ -637,10 +640,11 @@ return deferred.promise;

/**
* Updates the session with the current running processes
* List all instructors for a course
* @method
* @name Client#sessionProcesses
* @param {string} sessionId -
* @param {} body -
* @name Client#listInstructors
* @param {string} courseId -
* @param {string} page -
* @param {string} pageSize -
*
*/
Client.prototype.sessionProcesses = function(parameters) {
Client.prototype.listInstructors = function(parameters) {
if (parameters === undefined) {

@@ -652,3 +656,3 @@ parameters = {};

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

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

@@ -680,3 +688,3 @@ Object.keys(parameters.$queryParameters)

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

@@ -686,9 +694,9 @@ return deferred.promise;

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

@@ -700,3 +708,3 @@ parameters = {};

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

@@ -728,13 +736,11 @@ var body;

/**
* Sign an agreement
* Get agreements to sign
* @method
* @name Client#signAgreements
* @name Client#getAgreements
* @param {string} token -
* @param {string} sessionId -
* @param {string} agreementId -
* @param {string} versionId -
* @param {} body -
* @param {string} locationId -
*
*/
Client.prototype.signAgreements = function(parameters) {
Client.prototype.getAgreements = function(parameters) {
if (parameters === undefined) {

@@ -746,3 +752,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}/agreements/location/{location_id}';

@@ -770,20 +776,9 @@ var body;

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

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

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

/**
* Get student details
* Will return detailed information about an institution
* @method
* @name Client#getStudent
* @name Client#getInstitution
* @param {string} institutionId -
* @param {string} studentId -
*
*/
Client.prototype.getStudent = function(parameters) {
Client.prototype.getInstitution = function(parameters) {
if (parameters === undefined) {

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

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

@@ -833,9 +827,2 @@ var 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) {

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

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

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

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

@@ -877,16 +863,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) {

@@ -905,9 +884,11 @@ Object.keys(parameters.$queryParameters)

/**
* Used to login and authenticate proctors
* Get history of current session
* @method
* @name Client#proctorLogin
* @param {} body -
* @name Client#getAgreementHistory
* @param {string} token -
* @param {string} sessionId -
* @param {string} agreementId -
*
*/
Client.prototype.proctorLogin = function(parameters) {
Client.prototype.getAgreementHistory = function(parameters) {
if (parameters === undefined) {

@@ -919,3 +900,3 @@ parameters = {};

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

@@ -927,6 +908,25 @@ var body;

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

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

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

/**
* List sessions for a given exam
* This endpoint is used to get an image list for an user
* @method
* @name Client#listSessions
* @param {string} examId -
* @name Client#listImages
* @param {string} sessionId -
* @param {string} clientId -
* @param {string} type -
*
*/
Client.prototype.listSessions = function(parameters) {
Client.prototype.listImages = function(parameters) {
if (parameters === undefined) {

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

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

@@ -968,9 +970,22 @@ 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['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) {

@@ -989,8 +1004,11 @@ Object.keys(parameters.$queryParameters)

/**
* Will return a full list of all institutions
* This endpoint is used to upload images for a user
* @method
* @name Client#listInstitutions
* @name Client#uploadImage
* @param {string} token -
* @param {string} sessionId -
* @param {} body -
*
*/
Client.prototype.listInstitutions = function(parameters) {
Client.prototype.uploadImage = function(parameters) {
if (parameters === undefined) {

@@ -1002,3 +1020,3 @@ parameters = {};

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

@@ -1010,2 +1028,22 @@ 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;
}
if (parameters['body'] !== undefined) {
body = parameters['body'];
}
if (parameters.$queryParameters) {

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

@@ -1025,10 +1063,10 @@ return deferred.promise;

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

@@ -1040,3 +1078,3 @@ parameters = {};

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

@@ -1048,11 +1086,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'];
}

@@ -1068,3 +1103,3 @@

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

@@ -1074,11 +1109,10 @@ return deferred.promise;

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

@@ -1090,3 +1124,3 @@ parameters = {};

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

@@ -1098,25 +1132,16 @@ var body;

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

@@ -1135,11 +1160,11 @@ Object.keys(parameters.$queryParameters)

/**
* Get history of current session
* Get exam details
* @method
* @name Client#getAgreementHistory
* @param {string} token -
* @param {string} sessionId -
* @param {string} agreementId -
* @name Client#getExam
* @param {string} courseId -
* @param {string} examId -
* @param {string} enrollmentId -
*
*/
Client.prototype.getAgreementHistory = function(parameters) {
Client.prototype.getExam = function(parameters) {
if (parameters === undefined) {

@@ -1151,3 +1176,3 @@ parameters = {};

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

@@ -1159,22 +1184,22 @@ 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('{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;
}
path = path.replace('{agreement_id}', parameters['agreementId']);
if (parameters['enrollmentId'] !== undefined) {
queryParameters['enrollment_id'] = parameters['enrollmentId'];
}
if (parameters['agreementId'] === undefined) {
deferred.reject(new Error('Missing required parameter: agreementId'));
if (parameters['enrollmentId'] === undefined) {
deferred.reject(new Error('Missing required parameter: enrollmentId'));
return deferred.promise;

@@ -1196,11 +1221,10 @@ }

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

@@ -1212,3 +1236,3 @@ parameters = {};

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

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

@@ -1228,10 +1259,2 @@

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

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

@@ -1251,10 +1274,10 @@ return deferred.promise;

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

@@ -1266,3 +1289,3 @@ parameters = {};

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

@@ -1298,9 +1321,13 @@ var body;

/**
* This endpoint is used to get an image list for an proctor
* Sign an agreement
* @method
* @name Client#listProctorImages
* @param {string} userId -
* @name Client#signAgreements
* @param {string} token -
* @param {string} sessionId -
* @param {string} agreementId -
* @param {string} versionId -
* @param {} body -
*
*/
Client.prototype.listProctorImages = function(parameters) {
Client.prototype.signAgreements = function(parameters) {
if (parameters === undefined) {

@@ -1312,3 +1339,3 @@ parameters = {};

var domain = this.domain;
var path = '/v1/proctor/{user_id}/images';
var path = '/v1/sessions/{session_id}/agreements/{agreement_id}/versions/{version_id}/sign';

@@ -1320,9 +1347,36 @@ 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;
}
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) {

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

@@ -1342,10 +1396,10 @@ return deferred.promise;

/**
* This endpoint is used to upload headshot for a proctor
* Gets the zookeeper session history
* @method
* @name Client#uploadProctorImage
* @param {string} userId -
* @param {} body -
* @name Client#getProcesses
* @param {string} sessionId -
* @param {string} zookeeperId -
*
*/
Client.prototype.uploadProctorImage = function(parameters) {
Client.prototype.getProcesses = function(parameters) {
if (parameters === undefined) {

@@ -1357,3 +1411,3 @@ parameters = {};

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

@@ -1365,13 +1419,18 @@ var body;

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

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

@@ -1391,11 +1450,10 @@ return deferred.promise;

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

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

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

@@ -1422,15 +1480,6 @@ var body;

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

@@ -1444,3 +1493,3 @@ Object.keys(parameters.$queryParameters)

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

@@ -1450,11 +1499,10 @@ return deferred.promise;

/**
* This endpoint is used to upload images for a user
* Will return start and end time for a users media
* @method
* @name Client#uploadImage
* @param {string} token -
* @param {string} sessionId -
* @name Client#videoSetup
* @param {string} userId -
* @param {} body -
*
*/
Client.prototype.uploadImage = function(parameters) {
Client.prototype.videoSetup = function(parameters) {
if (parameters === undefined) {

@@ -1466,3 +1514,3 @@ parameters = {};

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

@@ -1474,18 +1522,9 @@ 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) {

@@ -1508,11 +1547,9 @@ body = parameters['body'];

/**
* Get exam details
* Will return return a list of courses for an institution
* @method
* @name Client#getExam
* @param {string} courseId -
* @param {string} examId -
* @param {string} enrollmentId -
* @name Client#listCourses
* @param {string} institutionId -
*
*/
Client.prototype.getExam = function(parameters) {
Client.prototype.listCourses = function(parameters) {
if (parameters === undefined) {

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

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

@@ -1532,25 +1569,9 @@ var body;

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

@@ -1569,10 +1590,8 @@ Object.keys(parameters.$queryParameters)

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

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

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

@@ -1592,16 +1611,2 @@ var body;

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

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

@@ -1621,10 +1626,9 @@ return deferred.promise;

/**
* Will return start and end time for a users media
* List all exams for a course
* @method
* @name Client#videoSetup
* @param {string} userId -
* @param {} body -
* @name Client#listExams
* @param {string} courseId -
*
*/
Client.prototype.videoSetup = function(parameters) {
Client.prototype.listExams = function(parameters) {
if (parameters === undefined) {

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

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

@@ -1644,13 +1648,9 @@ var body;

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

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

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

2

package.json

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

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