@edropin/courses-svc

e_dropin_courses

EDropinCourses - JavaScript client for e_dropin_courses Courses service for eDropin This SDK is automatically generated by the Swagger Codegen project:

• API version: 1.0.0
• Package version: 1.0.0
• Build package: io.swagger.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install e_dropin_courses --save

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

Finally, switch to the directory you want to use your e_dropin_courses from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('e_dropin_courses') in javascript files from the directory you ran the last command above from.

git

If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file, that's to say your javascript file where you actually use this library):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var EDropinCourses = require('e_dropin_courses');

var defaultClient = EDropinCourses.ApiClient.instance;

// Configure API key authorization: Authorization
var Authorization = defaultClient.authentications['Authorization'];
Authorization.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.apiKeyPrefix['Authorization'] = "Token"

// Configure API key authorization: ClientKey
var ClientKey = defaultClient.authentications['ClientKey'];
ClientKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ClientKey.apiKeyPrefix['X-Client-Key'] = "Token"

var api = new EDropinCourses.EcCoursesApi()

var courseId = "courseId_example"; // {String} Course Id

var accountId = "accountId_example"; // {String} Account Id

var permission = "permission_example"; // {String} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.checkAccountHasPermission(courseId, accountId, permission, callback);

Documentation for API Endpoints

All URIs are relative to https://courses-dot-edropin-playground.appspot.com/v1

Class	Method	HTTP request	Description
EDropinCourses.EcCoursesApi	checkAccountHasPermission	GET /courses/{courseId}/permissions/{accountId}/check	Check account has permission
EDropinCourses.EcCoursesApi	createCourse	POST /courses	Create Course
EDropinCourses.EcCoursesApi	deleteCourse	DELETE /courses/{courseId}	Delete an existing course
EDropinCourses.EcCoursesApi	getAccountPermissionForCourse	GET /courses/{courseId}/permissions/{accountId}	Get permission for account
EDropinCourses.EcCoursesApi	getAllCourses	GET /courses	Get Courses
EDropinCourses.EcCoursesApi	getCourse	GET /courses/{courseId}	Get a course from the directory
EDropinCourses.EcCoursesApi	getCoursePermission	GET /courses/{courseId}/all-permissions	List all event permissions
EDropinCourses.EcCoursesApi	getMultipleCourses	GET /courses/get-multi	Get Multiple Courses
EDropinCourses.EcCoursesApi	searchCourse	GET /courses/search	Search Courses
EDropinCourses.EcCoursesApi	setCoursePermission	PUT /courses/{courseId}/permissions/{accountId}	Set permission for event
EDropinCourses.EcCoursesApi	updateCourse	PUT /courses/{courseId}	Update an existing course
EDropinCourses.EcCoursesApi	upsertCourseProfile	PUT /courses/{courseId}/profiles	Update course profile roles
EDropinCourses.EcSubjectsApi	searchSubject	GET /subjects/search	Search Subjects

Documentation for Models

• EDropinCourses.EcBaseId
• EDropinCourses.EcCourseUpdate
• EDropinCourses.EcDefaultError
• EDropinCourses.EcPagedCourse
• EDropinCourses.EcPagedPermission
• EDropinCourses.EcPagedSubject
• EDropinCourses.EcPagination
• EDropinCourses.EcPermission
• EDropinCourses.EcPermissionCheck
• EDropinCourses.EcPermissionInput
• EDropinCourses.EcProfile
• EDropinCourses.EcSubjectUpdate
• EDropinCourses.EcCreator
• EDropinCourses.EcSubject
• EDropinCourses.EcCourse

Documentation for Authorization

Authorization

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header

ClientKey

• Type: API key
• API key parameter name: X-Client-Key
• Location: HTTP header