fn_js

FnJs - JavaScript client for fn_js The open source serverless platform. This SDK is automatically generated by the Swagger Codegen project:

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

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

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

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

var api = new FnJs.AppsApi()

var app = "app_example"; // {String} Name of the app.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.appsAppDelete(app, callback);

Documentation for API Endpoints

All URIs are relative to https://127.0.0.1:8080/v1

Class	Method	HTTP request	Description
FnJs.AppsApi	appsAppDelete	DELETE /apps/{app}	Delete an app.
FnJs.AppsApi	appsAppGet	GET /apps/{app}	Get information for a app.
FnJs.AppsApi	appsAppPatch	PATCH /apps/{app}	Updates an app.
FnJs.AppsApi	appsGet	GET /apps	Get all app names.
FnJs.AppsApi	appsPost	POST /apps	Post new app
FnJs.CallApi	appsAppCallsCallGet	GET /apps/{app}/calls/{call}	Get call information
FnJs.CallApi	appsAppCallsCallLogDelete	DELETE /apps/{app}/calls/{call}/log	Delete call log entry
FnJs.CallApi	appsAppCallsCallLogGet	GET /apps/{app}/calls/{call}/log	Get call logs
FnJs.CallApi	appsAppCallsGet	GET /apps/{app}/calls	Get app-bound calls.
FnJs.LogApi	appsAppCallsCallLogDelete	DELETE /apps/{app}/calls/{call}/log	Delete call log entry
FnJs.LogApi	appsAppCallsCallLogGet	GET /apps/{app}/calls/{call}/log	Get call logs
FnJs.RoutesApi	appsAppRoutesGet	GET /apps/{app}/routes	Get route list by app name.
FnJs.RoutesApi	appsAppRoutesPost	POST /apps/{app}/routes	Create new Route
FnJs.RoutesApi	appsAppRoutesRouteDelete	DELETE /apps/{app}/routes/{route}	Deletes the route
FnJs.RoutesApi	appsAppRoutesRouteGet	GET /apps/{app}/routes/{route}	Gets route by name
FnJs.RoutesApi	appsAppRoutesRoutePatch	PATCH /apps/{app}/routes/{route}	Update a Route, Fails if the route or app does not exist. Accepts partial updates / skips validation of zero values.
FnJs.RoutesApi	appsAppRoutesRoutePut	PUT /apps/{app}/routes/{route}	Create a Route if it does not exist. Update if it does. Will also create app if it does not exist. Put does not skip validation of zero values

Documentation for Models

• FnJs.App
• FnJs.AppWrapper
• FnJs.AppsWrapper
• FnJs.Call
• FnJs.CallWrapper
• FnJs.CallsWrapper
• FnJs.Error
• FnJs.ErrorBody
• FnJs.Log
• FnJs.LogWrapper
• FnJs.Route
• FnJs.RouteWrapper
• FnJs.RoutesWrapper
• FnJs.Version

Documentation for Authorization

All endpoints do not require authorization.