1.0.0 • Published 6 years ago

literatoapijs v1.0.0

Weekly downloads
2
License
ISC
Repository
github
Last release
6 years ago

literator

Literator - JavaScript client for literator List of routes to work with LiteratorAPI This SDK is automatically generated by the Swagger Codegen project:

  • API version: 1.3
  • Package version: 1.3
  • 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 literator --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 literator from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('literator') 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/YOUR_USERNAME/literator then install it via:

    npm install YOUR_USERNAME/literator --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 Literator = require('literator');

var defaultClient = Literator.ApiClient.instance;

// Configure OAuth2 access token for authorization: auth
var auth = defaultClient.authentications['auth'];
auth.accessToken = "YOUR ACCESS TOKEN"

var api = new Literator.AnswerApi()

var id = "id_example"; // {String} answerID

var threadId = "threadId_example"; // {String} threadID

var orgId = "orgId_example"; // {String} orgID


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.orgsForumAnswerDeletePost(id, threadId, orgId, callback);

Documentation for API Endpoints

All URIs are relative to http://example.com

ClassMethodHTTP requestDescription
Literator.AnswerApiorgsForumAnswerDeletePostPOST /orgs/forum/answer/deleteDelete
Literator.AnswerApiorgsForumAnswerGetIDsPostPOST /orgs/forum/answer/getIDsGetIDs
Literator.AnswerApiorgsForumAnswerGetPostPOST /orgs/forum/answer/getGet
Literator.AnswerApiorgsForumAnswerNewPostPOST /orgs/forum/answer/newNew
Literator.ArchiveApiboardsArchiveDoBoardPostPOST /boards/archive/do/boardBoard
Literator.ArchiveApiprojectsArchiveDoColumnEntryPostPOST /projects/archive/do/columnEntryColumnEntry
Literator.ArchiveApiprojectsArchiveDoColumnPostPOST /projects/archive/do/columnColumn
Literator.AuthApiauthLoginPostPOST /auth/loginLogin
Literator.AuthApiauthRegisterPostPOST /auth/registerRegister
Literator.BoardApiboardsGetIDPostPOST /boards/getIDGetID
Literator.CECommentApiprojectsColumnEntryCommentDeletePostPOST /projects/columnEntry/comment/deleteDelete
Literator.CECommentApiprojectsColumnEntryCommentGetIDsPostPOST /projects/columnEntry/comment/getIDsGetIDs
Literator.CECommentApiprojectsColumnEntryCommentGetPostPOST /projects/columnEntry/comment/getGet
Literator.CECommentApiprojectsColumnEntryCommentNewPostPOST /projects/columnEntry/comment/newNew
Literator.ColumnApiprojectsColumnDeletePostPOST /projects/column/deleteDelete
Literator.ColumnApiprojectsColumnEditPostPOST /projects/column/editEdit
Literator.ColumnApiprojectsColumnGetIDsPostPOST /projects/column/getIDsGetIDs
Literator.ColumnApiprojectsColumnGetPostPOST /projects/column/getGet
Literator.ColumnApiprojectsColumnNewPostPOST /projects/column/newNew
Literator.ColumnEntryApiprojectsColumnEntryDeletePostPOST /projects/columnEntry/deleteDelete
Literator.ColumnEntryApiprojectsColumnEntryEditPost2POST /projects/columnEntry/editMove
Literator.ColumnEntryApiprojectsColumnEntryGetIDsPostPOST /projects/columnEntry/getIDsGetIDs
Literator.ColumnEntryApiprojectsColumnEntryGetPostPOST /projects/columnEntry/getGet
Literator.ColumnEntryApiprojectsColumnEntryNewPostPOST /projects/columnEntry/newNew
Literator.CommentApicommentsGetPostPOST /comments/get{{domain}}/comments/get
Literator.CommentApicommentsNewPostPOST /comments/newNew
Literator.FileApiprojectsFileDeletePostPOST /projects/file/deleteDelete
Literator.FileApiprojectsFileEditPostPOST /projects/file/editEdit
Literator.FileApiprojectsFileGetIDsPostPOST /projects/file/getIDsGetIDs
Literator.FileApiprojectsFileGetPostPOST /projects/file/getGet
Literator.FileApiprojectsFileMovePostPOST /projects/file/moveMove
Literator.FileApiprojectsFileNewPostPOST /projects/file/newNew
Literator.FileCommentApiprojectsFileCommentDeletePostPOST /projects/file/comment/deleteDelete
Literator.FileCommentApiprojectsFileCommentGetIDsPostPOST /projects/file/comment/getIDsGetIDs
Literator.FileCommentApiprojectsFileCommentGetPostPOST /projects/file/comment/getGet
Literator.FileCommentApiprojectsFileCommentNewPostPOST /projects/file/comment/newNew
Literator.FileVersionApiprojectsFileVersionGetIDsPostPOST /projects/fileVersion/getIDsGetIDs
Literator.FileVersionApiprojectsFileVersionGetPostPOST /projects/fileVersion/getGet
Literator.FolderApiprojectsFolderDeletePostPOST /projects/folder/deleteDelete
Literator.FolderApiprojectsFolderEditPostPOST /projects/folder/editEdit
Literator.FolderApiprojectsFolderGetIDsPostPOST /projects/folder/getIDsGetIDs
Literator.FolderApiprojectsFolderGetPostPOST /projects/folder/getGet
Literator.FolderApiprojectsFolderNewPostPOST /projects/folder/newNew
Literator.GetApipostsGetByAuthorPostPOST /posts/getByAuthorByAuthor
Literator.GetApipostsGetByIDPostPOST /posts/getByIDByID
Literator.GetApipostsGetByTagPostPOST /posts/getByTagByTag
Literator.GetApipostsGetPostPOST /posts/getByLink
Literator.GetApiprojectsArchiveGetColumnEntryPostPOST /projects/archive/get/columnEntryColumnEntry
Literator.GetApiprojectsArchiveGetColumnPostPOST /projects/archive/get/columnColumn
Literator.GetApiprojectsArchiveGetCommentPostPOST /projects/archive/get/commentComment
Literator.IndexApimyProfileGetGET /myProfileMyProfile
Literator.IndexApiprofilePostPOST /profileProfile
Literator.IndexApivipGetGET /vipVIP
Literator.LinkApiorgsDeleteLinkPostPOST /orgs/deleteLinkDelete
Literator.LinkApiorgsJoinPostPOST /orgs/joinJoin
Literator.LinkApiorgsNewLinkPostPOST /orgs/newLinkNew
Literator.OfferedPostApiorgsPostsConfirmPostPOST /orgs/posts/confirmConfirm
Literator.OfferedPostApiorgsPostsDeletePostPOST /orgs/posts/deleteDelete
Literator.OfferedPostApiorgsPostsEditPostPOST /orgs/posts/editEdit
Literator.OfferedPostApiorgsPostsGetIDsPostPOST /orgs/posts/getIDsGetIDs
Literator.OfferedPostApiorgsPostsGetPostPOST /orgs/posts/getGet
Literator.OfferedPostApiorgsPostsOfferPostPOST /orgs/posts/offerOffer
Literator.OrganizationApiorgsDeletePostPOST /orgs/deleteDelete
Literator.OrganizationApiorgsEditPostPOST /orgs/editEdit
Literator.OrganizationApiorgsEditRulePostPOST /orgs/editRuleEditRule
Literator.OrganizationApiorgsGetPostPOST /orgs/getGet
Literator.OrganizationApiorgsNewPostPOST /orgs/newNew
Literator.PostsApipostsEditPostPOST /posts/editEdit
Literator.PostsApipostsNewPostPOST /posts/newNew
Literator.PreviousVerApipostsPreviousGetIDsPostPOST /posts/previous/getIDsGetIDs
Literator.PreviousVerApipostsPreviousGetPostPOST /posts/previous/getGet
Literator.ProjectsApiprojectsAddPostPOST /projects/addAdd
Literator.ProjectsApiprojectsDeletePostPOST /projects/deleteDelete
Literator.ProjectsApiprojectsEditPostPOST /projects/editEdit
Literator.ProjectsApiprojectsGetPostPOST /projects/getGet
Literator.ProjectsApiprojectsNewPostPOST /projects/newNew
Literator.TagApitagsGetAllPostPOST /tags/getAllGetAll
Literator.TagApitagsGetPostPOST /tags/getGet
Literator.TagApitagsNewPostPOST /tags/newNew
Literator.ThreadApiorgsForumThreadDeletePostPOST /orgs/forum/thread/deleteDelete
Literator.ThreadApiorgsForumThreadEditPostPOST /orgs/forum/thread/editEdit
Literator.ThreadApiorgsForumThreadGetIDsPostPOST /orgs/forum/thread/getIDsGetIDs
Literator.ThreadApiorgsForumThreadGetPostPOST /orgs/forum/thread/getGet
Literator.ThreadApiorgsForumThreadNewPostPOST /orgs/forum/thread/newNew

Documentation for Models

Documentation for Authorization

auth