letteraa

lettera

Lettera - JavaScript client for lettera

KSF Media's articles service

Changelog for V3:

• Unified ListArticle and RelatedArticle into a single type ArticleStub. NOTE: In contrast to the old types, ArticleStub.relatedArticles is now an optional value.
• Added endpoint /article/{uuid}/stub
• Removed deprecated endpoint /article/search

This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

• API version: 3.0.0
• Package version: 3.0.0
• Build package: org.openapitools.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 lettera --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 lettera from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('lettera') 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/KSF-Media/lettera-javascript-client then install it via:

    npm install KSF-Media/lettera-javascript-client --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 Lettera = require('lettera');


var api = new Lettera.ArticlesApi()
var uuid = null; // {String} 
var opts = {
  'authUser': null, // {String} 
  'authorization': "authorization_example", // {String} 
  'textonly': false // {Boolean} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.articleUuidGet(uuid, opts, callback);

Documentation for API Endpoints

All URIs are relative to http://http:/v3

Class	Method	HTTP request	Description
Lettera.ArticlesApi	articleUuidGet	GET /article/{uuid}
Lettera.ArticlesApi	articleUuidStubGet	GET /article/{uuid}/stub
Lettera.CategoriesApi	categoriesGet	GET /categories	Read categories
Lettera.ListsApi	frontpageGet	GET /frontpage	Returns a list for a front page
Lettera.ListsApi	latestGet	GET /latest	Returns a list of latest articles
Lettera.ListsApi	mostreadGet	GET /mostread	Returns a list of most read articles
Lettera.ListsApi	searchGet	GET /search	Returns a list of search results
Lettera.NotifiersApi	notifyPost	POST /notify	Listens to OC Notifier

Documentation for Models

• Lettera.Alignment
• Lettera.Article
• Lettera.ArticleStub
• Lettera.ArticleType
• Lettera.ArticleTypeDetails
• Lettera.Author
• Lettera.Block
• Lettera.BoxInfo
• Lettera.BoxType
• Lettera.Category
• Lettera.EventType
• Lettera.ImageInfo
• Lettera.Notification
• Lettera.Paper

Documentation for Authorization

All endpoints do not require authorization.