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.77 to 0.0.78

784

index.js

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

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

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

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

@@ -89,2 +90,9 @@ var body;

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

@@ -97,6 +105,8 @@

path = path.replace('{session_id}', parameters['sessionId']);
if (parameters['enrollmentId'] !== undefined) {
queryParameters['enrollment_id'] = parameters['enrollmentId'];
}
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;

@@ -113,3 +123,3 @@ }

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

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

/**
* Gets the zookeeper session history
* Get student details
* @method
* @name Client#getProcesses
* @param {string} sessionId -
* @param {string} zookeeperId -
* @name Client#getStudent
* @param {string} institutionId -
* @param {string} studentId -
*
*/
Client.prototype.getProcesses = function(parameters) {
Client.prototype.getStudent = function(parameters) {
if (parameters === undefined) {

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

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

@@ -142,15 +152,13 @@ var body;

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

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

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

@@ -187,3 +194,3 @@ parameters = {};

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

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

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

@@ -221,11 +224,10 @@ return deferred.promise;

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

@@ -237,3 +239,3 @@ parameters = {};

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

@@ -245,25 +247,13 @@ 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['body'] !== undefined) {
body = parameters['body'];
}
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) {

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

@@ -283,9 +273,10 @@ return deferred.promise;

/**
* Used to login and authenticate proctors
* Will return return details about a single course
* @method
* @name Client#proctorLogin
* @param {} body -
* @name Client#getCourse
* @param {string} courseId -
* @param {string} institutionId -
*
*/
Client.prototype.proctorLogin = function(parameters) {
Client.prototype.getCourse = function(parameters) {
if (parameters === undefined) {

@@ -297,3 +288,3 @@ parameters = {};

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

@@ -305,6 +296,16 @@ 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('{institution_id}', parameters['institutionId']);
if (parameters['institutionId'] === undefined) {
deferred.reject(new Error('Missing required parameter: institutionId'));
return deferred.promise;
}
if (parameters.$queryParameters) {

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

@@ -324,11 +325,9 @@ return deferred.promise;

/**
* Get agreements to sign
* List all exams for a course
* @method
* @name Client#getAgreements
* @param {string} token -
* @param {string} sessionId -
* @param {string} locationId -
* @name Client#listExams
* @param {string} courseId -
*
*/
Client.prototype.getAgreements = function(parameters) {
Client.prototype.listExams = function(parameters) {
if (parameters === undefined) {

@@ -340,3 +339,3 @@ parameters = {};

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

@@ -348,25 +347,9 @@ 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;
}
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) {

@@ -385,9 +368,9 @@ Object.keys(parameters.$queryParameters)

/**
* This endpoint is used to get an image list for an proctor
* Used to login and authenticate proctors
* @method
* @name Client#listProctorImages
* @param {string} userId -
* @name Client#proctorLogin
* @param {} body -
*
*/
Client.prototype.listProctorImages = function(parameters) {
Client.prototype.proctorLogin = function(parameters) {
if (parameters === undefined) {

@@ -399,3 +382,3 @@ parameters = {};

var domain = this.domain;
var path = '/v1/proctor/{user_id}/images';
var path = '/v1/proctors/login';

@@ -407,7 +390,4 @@ var body;

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

@@ -423,3 +403,3 @@

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

@@ -429,10 +409,10 @@ return deferred.promise;

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

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

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

@@ -452,11 +432,14 @@ var body;

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

@@ -477,11 +460,10 @@

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

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

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

@@ -508,15 +490,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) {

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

@@ -536,11 +509,11 @@ return deferred.promise;

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

@@ -552,3 +525,3 @@ parameters = {};

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

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

@@ -577,6 +557,2 @@

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

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

@@ -596,5 +572,5 @@ return deferred.promise;

/**
* Join an existing session and get permissions
* Start a new session and create permissions
* @method
* @name Client#joinSession
* @name Client#startSession
* @param {string} sessionId - Access Key

@@ -604,3 +580,3 @@ * @param {} body -

*/
Client.prototype.joinSession = function(parameters) {
Client.prototype.startSession = function(parameters) {
if (parameters === undefined) {

@@ -612,3 +588,3 @@ parameters = {};

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

@@ -644,10 +620,11 @@ var body;

/**
* Will return return details about a single course
* List incidents for a given session
* @method
* @name Client#getCourse
* @param {string} courseId -
* @param {string} institutionId -
* @name Client#listIncidents
* @param {string} sessionId -
* @param {string} page -
* @param {string} pageSize -
*
*/
Client.prototype.getCourse = function(parameters) {
Client.prototype.listIncidents = function(parameters) {
if (parameters === undefined) {

@@ -659,3 +636,3 @@ parameters = {};

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

@@ -667,14 +644,15 @@ var body;

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

@@ -695,11 +673,10 @@

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

@@ -711,3 +688,3 @@ parameters = {};

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

@@ -719,17 +696,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['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) {

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

@@ -749,11 +722,9 @@ return deferred.promise;

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

@@ -765,3 +736,3 @@ parameters = {};

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

@@ -773,25 +744,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) {

@@ -810,13 +765,9 @@ Object.keys(parameters.$queryParameters)

/**
* Sign an agreement
* Will return detailed information about an institution
* @method
* @name Client#signAgreements
* @param {string} token -
* @param {string} sessionId -
* @param {string} agreementId -
* @param {string} versionId -
* @param {} body -
* @name Client#getInstitution
* @param {string} institutionId -
*
*/
Client.prototype.signAgreements = function(parameters) {
Client.prototype.getInstitution = function(parameters) {
if (parameters === undefined) {

@@ -828,3 +779,3 @@ parameters = {};

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

@@ -836,36 +787,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('{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) {

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

@@ -885,10 +809,8 @@ return deferred.promise;

/**
* Get all the incident types
* Will return a full list of all institutions
* @method
* @name Client#getIncidentTypes
* @param {string} page -
* @param {string} pageSize -
* @name Client#listInstitutions
*
*/
Client.prototype.getIncidentTypes = function(parameters) {
Client.prototype.listInstitutions = function(parameters) {
if (parameters === undefined) {

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

var domain = this.domain;
var path = '/v1/incidents/types';
var path = '/v1/institutions';

@@ -908,10 +830,2 @@ var body;

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

@@ -930,9 +844,9 @@ Object.keys(parameters.$queryParameters)

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

@@ -944,3 +858,3 @@ parameters = {};

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

@@ -952,6 +866,6 @@ 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;

@@ -973,10 +887,10 @@ }

/**
* Get student details
* Gets the zookeeper session history
* @method
* @name Client#getStudent
* @param {string} institutionId -
* @param {string} studentId -
* @name Client#getProcesses
* @param {string} sessionId -
* @param {string} zookeeperId -
*
*/
Client.prototype.getStudent = function(parameters) {
Client.prototype.getProcesses = function(parameters) {
if (parameters === undefined) {

@@ -988,3 +902,3 @@ parameters = {};

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

@@ -996,13 +910,15 @@ var body;

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

@@ -1024,10 +940,10 @@ }

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

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

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

@@ -1047,14 +963,11 @@ var body;

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

@@ -1070,3 +983,3 @@

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

@@ -1076,11 +989,11 @@ return deferred.promise;

/**
* List incidents for a given session
* Get history of current session
* @method
* @name Client#listIncidents
* @name Client#getAgreementHistory
* @param {string} token -
* @param {string} sessionId -
* @param {string} page -
* @param {string} pageSize -
* @param {string} agreementId -
*
*/
Client.prototype.listIncidents = function(parameters) {
Client.prototype.getAgreementHistory = function(parameters) {
if (parameters === undefined) {

@@ -1092,3 +1005,3 @@ parameters = {};

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

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

@@ -1108,8 +1030,7 @@

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

@@ -1130,10 +1051,9 @@

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

@@ -1145,3 +1065,3 @@ parameters = {};

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

@@ -1153,13 +1073,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) {

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

@@ -1179,9 +1095,11 @@ return deferred.promise;

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

@@ -1193,3 +1111,3 @@ parameters = {};

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

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

@@ -1222,9 +1153,11 @@ Object.keys(parameters.$queryParameters)

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

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

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

@@ -1244,9 +1177,22 @@ var body;

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

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

@@ -1266,9 +1212,11 @@ return deferred.promise;

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

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

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

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

@@ -1309,10 +1265,10 @@ Object.keys(parameters.$queryParameters)

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

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

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

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

@@ -1360,8 +1316,10 @@ }

/**
* Used to make sure that the api is current only
* Returns the media token needed for the client to connect to the session.
* @method
* @name Client#health
* @name Client#getMediaToken
* @param {string} sessionId -
* @param {string} clientId -
*
*/
Client.prototype.health = function(parameters) {
Client.prototype.getMediaToken = function(parameters) {
if (parameters === undefined) {

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

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

@@ -1381,2 +1339,16 @@ var body;

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

@@ -1440,9 +1412,8 @@ Object.keys(parameters.$queryParameters)

/**
* List students for a given exam
* Used to make sure that the api is current only
* @method
* @name Client#listStudents
* @param {string} examId -
* @name Client#health
*
*/
Client.prototype.listStudents = function(parameters) {
Client.prototype.health = function(parameters) {
if (parameters === undefined) {

@@ -1454,3 +1425,3 @@ parameters = {};

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

@@ -1462,9 +1433,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;
}
if (parameters.$queryParameters) {

@@ -1483,10 +1447,11 @@ Object.keys(parameters.$queryParameters)

/**
* Start a new session and create permissions
* Get agreements to sign
* @method
* @name Client#startSession
* @param {string} sessionId - Access Key
* @param {} body -
* @name Client#getAgreements
* @param {string} token -
* @param {string} sessionId -
* @param {string} locationId -
*
*/
Client.prototype.startSession = function(parameters) {
Client.prototype.getAgreements = function(parameters) {
if (parameters === undefined) {

@@ -1498,3 +1463,3 @@ parameters = {};

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

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

@@ -1514,4 +1488,7 @@

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

@@ -1527,3 +1504,3 @@

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

@@ -1533,11 +1510,13 @@ return deferred.promise;

/**
* Get history of current session
* Sign an agreement
* @method
* @name Client#getAgreementHistory
* @name Client#signAgreements
* @param {string} token -
* @param {string} sessionId -
* @param {string} agreementId -
* @param {string} versionId -
* @param {} body -
*
*/
Client.prototype.getAgreementHistory = function(parameters) {
Client.prototype.signAgreements = function(parameters) {
if (parameters === undefined) {

@@ -1549,3 +1528,3 @@ parameters = {};

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

@@ -1580,2 +1559,13 @@ var body;

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

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

@@ -1595,8 +1585,10 @@ return deferred.promise;

/**
* Will return a full list of all institutions
* Get all the incident types
* @method
* @name Client#listInstitutions
* @name Client#getIncidentTypes
* @param {string} page -
* @param {string} pageSize -
*
*/
Client.prototype.listInstitutions = function(parameters) {
Client.prototype.getIncidentTypes = function(parameters) {
if (parameters === undefined) {

@@ -1608,3 +1600,3 @@ parameters = {};

var domain = this.domain;
var path = '/v1/institutions';
var path = '/v1/incidents/types';

@@ -1616,2 +1608,10 @@ var body;

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

@@ -1618,0 +1618,0 @@ Object.keys(parameters.$queryParameters)

2

package.json

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

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