Ichi-cat / javasriptGeneratedClient

notes

Notes - JavaScript client for notes Backend app with Notes and Notetasks 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.v3.generators.javascript.JavaScriptClientCodegen For more information, please visit https://localhost

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 notes --save

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

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 Notes = require('notes');
var defaultClient = Notes.ApiClient.instance;


var api = new Notes.CategoryApi()
var apiVersion = "apiVersion_example"; // {String} 
var opts = { 
  'body': new Notes.CreateCategoryVm() // {CreateCategoryVm} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createCategory(apiVersion, opts, callback);

Documentation for API Endpoints

All URIs are relative to /

Class	Method	HTTP request	Description
Notes.CategoryApi	createCategory	POST /Category
Notes.CategoryApi	deleteCategory	DELETE /Category/{id}
Notes.CategoryApi	getCategories	GET /Category
Notes.CategoryApi	updateCategory	PUT /Category
Notes.MatrixApi	getMatrices	GET /Matrix
Notes.NoteApi	createNote	POST /Note
Notes.NoteApi	deleteNote	DELETE /Note/{id}
Notes.NoteApi	getNoteById	GET /Note/{id}
Notes.NoteApi	getNotes	GET /Note
Notes.NoteApi	getNotesByCategoryId	GET /Note/ByCategory/{id}
Notes.NoteApi	updateNote	PUT /Note
Notes.NoteTaskApi	createNoteTask	POST /NoteTask
Notes.NoteTaskApi	deleteNoteTask	DELETE /NoteTask/{id}
Notes.NoteTaskApi	getNoteTaskById	GET /NoteTask/{id}
Notes.NoteTaskApi	getNoteTaskByMatrix	GET /NoteTask/bymatrix/{id}
Notes.NoteTaskApi	getNoteTaskByProgressCondition	GET /NoteTask/byprogresscondition/{id}
Notes.NoteTaskApi	getNoteTasks	GET /NoteTask
Notes.NoteTaskApi	updateNoteTask	PUT /NoteTask
Notes.ProgressConditionApi	getProgressConditions	GET /ProgressCondition

Documentation for Models

• Notes.CategoryDto
• Notes.CategoryListDto
• Notes.CreateCategoryVm
• Notes.CreateNoteTaskVm
• Notes.CreateNoteVm
• Notes.MatricesEnum
• Notes.MatrixDto
• Notes.MatrixListDto
• Notes.NoteDetailsDto
• Notes.NoteDto
• Notes.NoteListDto
• Notes.NoteTaskDetailsDto
• Notes.NoteTaskDto
• Notes.NoteTaskListDto
• Notes.ProblemDetails
• Notes.ProgressConditionDto
• Notes.ProgressConditionEnum
• Notes.ProgressConditionListDto
• Notes.UpdateCategoryVm
• Notes.UpdateNoteTaskVm
• Notes.UpdateNoteVm

Documentation for Authorization

oauth2