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.67 to 0.0.68

706

index.js

@@ -66,6 +66,5 @@ /*jshint -W069 */

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

@@ -75,3 +74,3 @@ * @param {string} page_size -

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

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

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

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

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

@@ -120,47 +112,2 @@ queryParameters['page'] = parameters['page'];

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

@@ -206,10 +153,9 @@ * @method

/**
* Cancel session for a given exam
* List sessions for a given exam
* @method
* @name Client#cancelSession
* @name Client#listSessions
* @param {string} exam_id -
* @param {string} session_id -
*
*/
Client.prototype.cancelSession = function(parameters) {
Client.prototype.listSessions = function(parameters) {
if (parameters === undefined) {

@@ -221,3 +167,3 @@ parameters = {};

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

@@ -236,9 +182,2 @@ var body;

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

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

@@ -258,13 +197,11 @@ return deferred.promise;

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

@@ -276,3 +213,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/{agreement_id}/history';

@@ -307,13 +244,2 @@ var body;

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

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

@@ -333,10 +259,11 @@ return deferred.promise;

/**
* Get all the incident types
* Get exam details
* @method
* @name Client#getIncidentTypes
* @param {string} page -
* @param {string} page_size -
* @name Client#getExam
* @param {string} course_id -
* @param {string} exam_id -
* @param {string} enrollment_id -
*
*/
Client.prototype.getIncidentTypes = function(parameters) {
Client.prototype.getExam = function(parameters) {
if (parameters === undefined) {

@@ -348,3 +275,3 @@ parameters = {};

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

@@ -356,10 +283,25 @@ var body;

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

@@ -378,10 +320,11 @@ Object.keys(parameters.$queryParameters)

/**
* Join an existing session and get permissions
* Get agreements to sign
* @method
* @name Client#joinSession
* @param {string} session_id - Access Key
* @param {} body -
* @name Client#getAgreements
* @param {string} token -
* @param {string} session_id -
* @param {string} location_id -
*
*/
Client.prototype.joinSession = function(parameters) {
Client.prototype.getAgreements = function(parameters) {
if (parameters === undefined) {

@@ -393,3 +336,3 @@ parameters = {};

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

@@ -401,2 +344,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['session_id']);

@@ -409,4 +361,7 @@

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

@@ -422,3 +377,3 @@

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

@@ -428,11 +383,9 @@ return deferred.promise;

/**
* Get exam details
* List all exams for a course
* @method
* @name Client#getExam
* @name Client#listExams
* @param {string} course_id -
* @param {string} exam_id -
* @param {string} enrollment_id -
*
*/
Client.prototype.getExam = function(parameters) {
Client.prototype.listExams = function(parameters) {
if (parameters === undefined) {

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

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

@@ -459,18 +412,2 @@ var body;

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

@@ -489,9 +426,9 @@ Object.keys(parameters.$queryParameters)

/**
* List students for a given exam
* This endpoint is used to get an image list for an proctor
* @method
* @name Client#listStudents
* @param {string} exam_id -
* @name Client#listProctorImages
* @param {string} user_id -
*
*/
Client.prototype.listStudents = function(parameters) {
Client.prototype.listProctorImages = function(parameters) {
if (parameters === undefined) {

@@ -503,3 +440,3 @@ parameters = {};

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

@@ -511,6 +448,6 @@ var body;

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

@@ -532,9 +469,10 @@ }

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

@@ -546,3 +484,3 @@ parameters = {};

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

@@ -554,9 +492,13 @@ var body;

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

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

@@ -576,10 +518,11 @@ return deferred.promise;

/**
* Gets the zookeeper session history
* Get session details for a given exam
* @method
* @name Client#getProcesses
* @name Client#getSession
* @param {string} token -
* @param {string} exam_id -
* @param {string} session_id -
* @param {string} zookeeper_id -
*
*/
Client.prototype.getProcesses = function(parameters) {
Client.prototype.getSession = function(parameters) {
if (parameters === undefined) {

@@ -591,3 +534,3 @@ parameters = {};

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

@@ -599,15 +542,22 @@ var body;

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

@@ -629,10 +579,10 @@ }

/**
* Updates the session with the current running processes
* Start a new session and create permissions
* @method
* @name Client#sessionProcesses
* @param {string} session_id -
* @name Client#startSession
* @param {string} session_id - Access Key
* @param {} body -
*
*/
Client.prototype.sessionProcesses = function(parameters) {
Client.prototype.startSession = function(parameters) {
if (parameters === undefined) {

@@ -644,3 +594,3 @@ parameters = {};

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

@@ -671,3 +621,3 @@ var body;

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

@@ -677,9 +627,9 @@ return deferred.promise;

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

@@ -691,3 +641,3 @@ parameters = {};

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

@@ -699,7 +649,4 @@ var body;

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

@@ -715,3 +662,3 @@

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

@@ -721,10 +668,9 @@ return deferred.promise;

/**
* This endpoint is used to upload headshot for a proctor
* Will return return a list of courses for an institution
* @method
* @name Client#uploadProctorImage
* @param {string} user_id -
* @param {} body -
* @name Client#listCourses
* @param {string} institution_id -
*
*/
Client.prototype.uploadProctorImage = function(parameters) {
Client.prototype.listCourses = function(parameters) {
if (parameters === undefined) {

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

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

@@ -744,13 +690,9 @@ var body;

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

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

@@ -770,10 +712,9 @@ return deferred.promise;

/**
* Get instructor details
* List students for a given exam
* @method
* @name Client#getInstructor
* @param {string} course_id -
* @param {string} instructor_id -
* @name Client#listStudents
* @param {string} exam_id -
*
*/
Client.prototype.getInstructor = function(parameters) {
Client.prototype.listStudents = function(parameters) {
if (parameters === undefined) {

@@ -785,3 +726,3 @@ parameters = {};

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

@@ -793,16 +734,9 @@ var body;

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

@@ -821,11 +755,13 @@ Object.keys(parameters.$queryParameters)

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

@@ -837,3 +773,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';

@@ -868,2 +804,13 @@ var body;

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

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

@@ -883,11 +830,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} exam_id -
* @name Client#getMediaToken
* @param {string} session_id -
* @param {string} client_id -
*
*/
Client.prototype.getSession = function(parameters) {
Client.prototype.getMediaToken = function(parameters) {
if (parameters === undefined) {

@@ -899,3 +845,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';

@@ -907,25 +853,16 @@ var body;

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

@@ -944,9 +881,11 @@ Object.keys(parameters.$queryParameters)

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

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

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

@@ -966,6 +905,17 @@ var body;

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

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

@@ -985,10 +935,10 @@ return deferred.promise;

/**
* Get student details
* Creates an incident for a given session
* @method
* @name Client#getStudent
* @param {string} institution_id -
* @param {string} student_id -
* @name Client#createIncident
* @param {string} session_id -
* @param {} body -
*
*/
Client.prototype.getStudent = function(parameters) {
Client.prototype.createIncident = function(parameters) {
if (parameters === undefined) {

@@ -1000,3 +950,3 @@ parameters = {};

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

@@ -1008,14 +958,11 @@ var body;

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

@@ -1031,3 +978,3 @@

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

@@ -1037,10 +984,8 @@ return deferred.promise;

/**
* Will return return details about a single course
* Will return a full list of all institutions
* @method
* @name Client#getCourse
* @param {string} course_id -
* @param {string} institution_id -
* @name Client#listInstitutions
*
*/
Client.prototype.getCourse = function(parameters) {
Client.prototype.listInstitutions = function(parameters) {
if (parameters === undefined) {

@@ -1052,3 +997,3 @@ parameters = {};

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

@@ -1060,16 +1005,2 @@ var body;

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

@@ -1088,10 +1019,10 @@ Object.keys(parameters.$queryParameters)

/**
* Returns the media token needed for the client to connect to the session.
* Will return return details about a single course
* @method
* @name Client#getMediaToken
* @param {string} session_id -
* @param {string} client_id -
* @name Client#getCourse
* @param {string} course_id -
* @param {string} institution_id -
*
*/
Client.prototype.getMediaToken = function(parameters) {
Client.prototype.getCourse = function(parameters) {
if (parameters === undefined) {

@@ -1103,3 +1034,3 @@ parameters = {};

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

@@ -1111,13 +1042,13 @@ var body;

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

@@ -1139,11 +1070,10 @@ }

/**
* Get agreements to sign
* Join an existing session and get permissions
* @method
* @name Client#getAgreements
* @param {string} token -
* @param {string} session_id -
* @param {string} location_id -
* @name Client#joinSession
* @param {string} session_id - Access Key
* @param {} body -
*
*/
Client.prototype.getAgreements = function(parameters) {
Client.prototype.joinSession = function(parameters) {
if (parameters === undefined) {

@@ -1155,3 +1085,3 @@ parameters = {};

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

@@ -1163,11 +1093,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['session_id']);

@@ -1180,7 +1101,4 @@

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

@@ -1196,3 +1114,3 @@

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

@@ -1312,11 +1230,8 @@ return deferred.promise;

/**
* List incidents for a given session
* Used to make sure that the api is current only
* @method
* @name Client#listIncidents
* @param {string} session_id -
* @param {string} page -
* @param {string} page_size -
* @name Client#health
*
*/
Client.prototype.listIncidents = function(parameters) {
Client.prototype.health = function(parameters) {
if (parameters === undefined) {

@@ -1328,3 +1243,3 @@ parameters = {};

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

@@ -1336,15 +1251,48 @@ var body;

path = path.replace('{session_id}', parameters['session_id']);
if (parameters.$queryParameters) {
Object.keys(parameters.$queryParameters)
.forEach(function(parameterName) {
var parameter = parameters.$queryParameters[parameterName];
queryParameters[parameterName] = parameter;
});
}
if (parameters['session_id'] === undefined) {
deferred.reject(new Error('Missing required parameter: session_id'));
return deferred.promise;
this.request('GET', domain + path, parameters, body, headers, queryParameters, form, deferred);
return deferred.promise;
};
/**
* Get instructor details
* @method
* @name Client#getInstructor
* @param {string} course_id -
* @param {string} instructor_id -
*
*/
Client.prototype.getInstructor = function(parameters) {
if (parameters === undefined) {
parameters = {};
}
var deferred = Q.defer();
if (parameters['page'] !== undefined) {
queryParameters['page'] = parameters['page'];
var domain = this.domain;
var path = '/v1/courses/{course_id}/instructors/{instructor_id}';
var body;
var queryParameters = {};
var headers = {};
var form = {};
path = path.replace('{course_id}', parameters['course_id']);
if (parameters['course_id'] === undefined) {
deferred.reject(new Error('Missing required parameter: course_id'));
return deferred.promise;
}
if (parameters['page_size'] !== undefined) {
queryParameters['page_size'] = parameters['page_size'];
path = path.replace('{instructor_id}', parameters['instructor_id']);
if (parameters['instructor_id'] === undefined) {
deferred.reject(new Error('Missing required parameter: instructor_id'));
return deferred.promise;
}

@@ -1365,10 +1313,11 @@

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

@@ -1380,3 +1329,3 @@ parameters = {};

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

@@ -1388,13 +1337,17 @@ var body;

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

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

@@ -1414,9 +1367,10 @@ return deferred.promise;

/**
* List sessions for a given exam
* Cancel session for a given exam
* @method
* @name Client#listSessions
* @name Client#cancelSession
* @param {string} exam_id -
* @param {string} session_id -
*
*/
Client.prototype.listSessions = function(parameters) {
Client.prototype.cancelSession = function(parameters) {
if (parameters === undefined) {

@@ -1428,3 +1382,3 @@ parameters = {};

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

@@ -1443,2 +1397,9 @@ var body;

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

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

@@ -1458,9 +1419,10 @@ return deferred.promise;

/**
* Will return return a list of courses for an institution
* Get student details
* @method
* @name Client#listCourses
* @name Client#getStudent
* @param {string} institution_id -
* @param {string} student_id -
*
*/
Client.prototype.listCourses = function(parameters) {
Client.prototype.getStudent = function(parameters) {
if (parameters === undefined) {

@@ -1472,3 +1434,3 @@ parameters = {};

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

@@ -1487,2 +1449,9 @@ var body;

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

@@ -1501,8 +1470,10 @@ Object.keys(parameters.$queryParameters)

/**
* Will return a full list of all institutions
* Gets the zookeeper session history
* @method
* @name Client#listInstitutions
* @name Client#getProcesses
* @param {string} session_id -
* @param {string} zookeeper_id -
*
*/
Client.prototype.listInstitutions = function(parameters) {
Client.prototype.getProcesses = function(parameters) {
if (parameters === undefined) {

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

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

@@ -1522,2 +1493,18 @@ var body;

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

@@ -1536,8 +1523,10 @@ Object.keys(parameters.$queryParameters)

/**
* Used to make sure that the api is current only
* Updates the session with the current running processes
* @method
* @name Client#health
* @name Client#sessionProcesses
* @param {string} session_id -
* @param {} body -
*
*/
Client.prototype.health = function(parameters) {
Client.prototype.sessionProcesses = function(parameters) {
if (parameters === undefined) {

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

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

@@ -1557,2 +1546,13 @@ var body;

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

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

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

2

package.json

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

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