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

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- Literator.AnswerApi | orgsForumAnswerDeletePost | POST /orgs/forum/answer/delete | Delete Literator.AnswerApi | orgsForumAnswerGetIDsPost | POST /orgs/forum/answer/getIDs | GetIDs Literator.AnswerApi | orgsForumAnswerGetPost | POST /orgs/forum/answer/get | Get Literator.AnswerApi | orgsForumAnswerNewPost | POST /orgs/forum/answer/new | New Literator.ArchiveApi | boardsArchiveDoBoardPost | POST /boards/archive/do/board | Board Literator.ArchiveApi | projectsArchiveDoColumnEntryPost | POST /projects/archive/do/columnEntry | ColumnEntry Literator.ArchiveApi | projectsArchiveDoColumnPost | POST /projects/archive/do/column | Column Literator.AuthApi | authLoginPost | POST /auth/login | Login Literator.AuthApi | authRegisterPost | POST /auth/register | Register Literator.BoardApi | boardsGetIDPost | POST /boards/getID | GetID Literator.CECommentApi | projectsColumnEntryCommentDeletePost | POST /projects/columnEntry/comment/delete | Delete Literator.CECommentApi | projectsColumnEntryCommentGetIDsPost | POST /projects/columnEntry/comment/getIDs | GetIDs Literator.CECommentApi | projectsColumnEntryCommentGetPost | POST /projects/columnEntry/comment/get | Get Literator.CECommentApi | projectsColumnEntryCommentNewPost | POST /projects/columnEntry/comment/new | New Literator.ColumnApi | projectsColumnDeletePost | POST /projects/column/delete | Delete Literator.ColumnApi | projectsColumnEditPost | POST /projects/column/edit | Edit Literator.ColumnApi | projectsColumnGetIDsPost | POST /projects/column/getIDs | GetIDs Literator.ColumnApi | projectsColumnGetPost | POST /projects/column/get | Get Literator.ColumnApi | projectsColumnNewPost | POST /projects/column/new | New Literator.ColumnEntryApi | projectsColumnEntryDeletePost | POST /projects/columnEntry/delete | Delete Literator.ColumnEntryApi | projectsColumnEntryEditPost2 | POST /projects/columnEntry/edit | Move Literator.ColumnEntryApi | projectsColumnEntryGetIDsPost | POST /projects/columnEntry/getIDs | GetIDs Literator.ColumnEntryApi | projectsColumnEntryGetPost | POST /projects/columnEntry/get | Get Literator.ColumnEntryApi | projectsColumnEntryNewPost | POST /projects/columnEntry/new | New Literator.CommentApi | commentsGetPost | POST /comments/get | {{domain}}/comments/get Literator.CommentApi | commentsNewPost | POST /comments/new | New Literator.FileApi | projectsFileDeletePost | POST /projects/file/delete | Delete Literator.FileApi | projectsFileEditPost | POST /projects/file/edit | Edit Literator.FileApi | projectsFileGetIDsPost | POST /projects/file/getIDs | GetIDs Literator.FileApi | projectsFileGetPost | POST /projects/file/get | Get Literator.FileApi | projectsFileMovePost | POST /projects/file/move | Move Literator.FileApi | projectsFileNewPost | POST /projects/file/new | New Literator.FileCommentApi | projectsFileCommentDeletePost | POST /projects/file/comment/delete | Delete Literator.FileCommentApi | projectsFileCommentGetIDsPost | POST /projects/file/comment/getIDs | GetIDs Literator.FileCommentApi | projectsFileCommentGetPost | POST /projects/file/comment/get | Get Literator.FileCommentApi | projectsFileCommentNewPost | POST /projects/file/comment/new | New Literator.FileVersionApi | projectsFileVersionGetIDsPost | POST /projects/fileVersion/getIDs | GetIDs Literator.FileVersionApi | projectsFileVersionGetPost | POST /projects/fileVersion/get | Get Literator.FolderApi | projectsFolderDeletePost | POST /projects/folder/delete | Delete Literator.FolderApi | projectsFolderEditPost | POST /projects/folder/edit | Edit Literator.FolderApi | projectsFolderGetIDsPost | POST /projects/folder/getIDs | GetIDs Literator.FolderApi | projectsFolderGetPost | POST /projects/folder/get | Get Literator.FolderApi | projectsFolderNewPost | POST /projects/folder/new | New Literator.GetApi | postsGetByAuthorPost | POST /posts/getByAuthor | ByAuthor Literator.GetApi | postsGetByIDPost | POST /posts/getByID | ByID Literator.GetApi | postsGetByTagPost | POST /posts/getByTag | ByTag Literator.GetApi | postsGetPost | POST /posts/get | ByLink Literator.GetApi | projectsArchiveGetColumnEntryPost | POST /projects/archive/get/columnEntry | ColumnEntry Literator.GetApi | projectsArchiveGetColumnPost | POST /projects/archive/get/column | Column Literator.GetApi | projectsArchiveGetCommentPost | POST /projects/archive/get/comment | Comment Literator.IndexApi | myProfileGet | GET /myProfile | MyProfile Literator.IndexApi | profilePost | POST /profile | Profile Literator.IndexApi | vipGet | GET /vip | VIP Literator.LinkApi | orgsDeleteLinkPost | POST /orgs/deleteLink | Delete Literator.LinkApi | orgsJoinPost | POST /orgs/join | Join Literator.LinkApi | orgsNewLinkPost | POST /orgs/newLink | New Literator.OfferedPostApi | orgsPostsConfirmPost | POST /orgs/posts/confirm | Confirm Literator.OfferedPostApi | orgsPostsDeletePost | POST /orgs/posts/delete | Delete Literator.OfferedPostApi | orgsPostsEditPost | POST /orgs/posts/edit | Edit Literator.OfferedPostApi | orgsPostsGetIDsPost | POST /orgs/posts/getIDs | GetIDs Literator.OfferedPostApi | orgsPostsGetPost | POST /orgs/posts/get | Get Literator.OfferedPostApi | orgsPostsOfferPost | POST /orgs/posts/offer | Offer Literator.OrganizationApi | orgsDeletePost | POST /orgs/delete | Delete Literator.OrganizationApi | orgsEditPost | POST /orgs/edit | Edit Literator.OrganizationApi | orgsEditRulePost | POST /orgs/editRule | EditRule Literator.OrganizationApi | orgsGetPost | POST /orgs/get | Get Literator.OrganizationApi | orgsNewPost | POST /orgs/new | New Literator.PostsApi | postsEditPost | POST /posts/edit | Edit Literator.PostsApi | postsNewPost | POST /posts/new | New Literator.PreviousVerApi | postsPreviousGetIDsPost | POST /posts/previous/getIDs | GetIDs Literator.PreviousVerApi | postsPreviousGetPost | POST /posts/previous/get | Get Literator.ProjectsApi | projectsAddPost | POST /projects/add | Add Literator.ProjectsApi | projectsDeletePost | POST /projects/delete | Delete Literator.ProjectsApi | projectsEditPost | POST /projects/edit | Edit Literator.ProjectsApi | projectsGetPost | POST /projects/get | Get Literator.ProjectsApi | projectsNewPost | POST /projects/new | New Literator.TagApi | tagsGetAllPost | POST /tags/getAll | GetAll Literator.TagApi | tagsGetPost | POST /tags/get | Get Literator.TagApi | tagsNewPost | POST /tags/new | New Literator.ThreadApi | orgsForumThreadDeletePost | POST /orgs/forum/thread/delete | Delete Literator.ThreadApi | orgsForumThreadEditPost | POST /orgs/forum/thread/edit | Edit Literator.ThreadApi | orgsForumThreadGetIDsPost | POST /orgs/forum/thread/getIDs | GetIDs Literator.ThreadApi | orgsForumThreadGetPost | POST /orgs/forum/thread/get | Get Literator.ThreadApi | orgsForumThreadNewPost | POST /orgs/forum/thread/new | New

Documentation for Models

Documentation for Authorization

auth

• Type: OAuth
• Flow: implicit
• Authorization URL: http://example.com
• Scopes: N/A