Skip to content

Latest commit

 

History

History
84 lines (61 loc) · 3.07 KB

README.md

File metadata and controls

84 lines (61 loc) · 3.07 KB
Raw

npm version

Teedy API

Unofficial Teedy API in form of a node module Teedy is a lightweight document management system packed with alot of amazing features such as OCR, a very useful web-ui with tag search and much more. visit their official website or repo to learn more.

I took the api-docs
provided by the official Teedy/sismics repo and converted it into swagger 3 with this tool,
from there, I used the official code-gen swagger tool in order to generate typescript-axios source code.

Api Docs can be found here

!----IMPORTANT REQUIREMENTS---!:

Requirements when installing/updating the module

git - in the environment path, used to clone Teedy repo
jre or jdk 8 - in the environment path, used to run the official swagger-codegen-cli.jar tool, from my tests , higher than version 8 don't work as far as I know.

Usage and examples

  • Install.
yarn add teedy-api
npm install teedy-api
  • Import/Require Usage example

perform login

import {UserApiFp} from "teedy-api";

const params = new URLSearchParams();
params.append('username', 'test');
params.append('password', 'test');
params.append('remember', "true");
const usersApi = UserApiFp({
    basePath: "https://demo.teedy.io/api/" //base url for the api
});
usersApi.userLoginPost({
    data: params,  //sent as form/urlencoded
})
    .then(r => r(/* optionally custom axios instance can be passed here for cookies etc...*/))
    .then(s => {
        //extract set-cookie from here
        console.log(s);
    });

Credits

Sismics company - for providing such an amazing software as open source.

Okoyl - Helped me along the way to plan, find relevant sources and tools to make this module possible.

License

The license chosen for this project can be found inside package.json: MIT I do not own any names or trademarks in this project. they belong to their respective companies.

Note to Sismics company

you may have this module-name(teedy-api) or ownership of the module/repo at any time. contact my email or open an issue from your official account.
I did not intend to infringe any trademarks.

Hopefully this module will save you some time, have fun and best of luck!