What-happens-next-js NPM

what_happens_next_api

WhatHappensNextApi - JavaScript client for what_happens_next_api Documentation This SDK is automatically generated by the OpenAPI Generator project:

API version: 0.1
Package version: 0.1
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 what_happens_next_api --save

Finally, you need to build the module:

npm run build

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

To use the link you just defined in your project, switch to the directory you want to use your what_happens_next_api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --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):

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 WhatHappensNextApi = require('what_happens_next_api');

var defaultClient = WhatHappensNextApi.ApiClient.instance;
// Configure Bearer (JWT) access token for authorization: jwt
var jwt = defaultClient.authentications['jwt'];
jwt.accessToken = "YOUR ACCESS TOKEN"

var api = new WhatHappensNextApi.AssetsApi()
var opts = {
  'createAssetModel': new WhatHappensNextApi.CreateAssetModel() // {CreateAssetModel} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createAsset(opts, callback);

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
WhatHappensNextApi.AssetsApi	createAsset	POST /api/asset	Create asset
WhatHappensNextApi.AssetsApi	deleteAsset	DELETE /api/asset/{id}	Delete asset
WhatHappensNextApi.AssetsApi	listAssets	GET /api/assets	List assets
WhatHappensNextApi.AssetsApi	updateAsset	PUT /api/asset/{id}	Update asset
WhatHappensNextApi.StoriesApi	createStory	POST /api/story	Create story
WhatHappensNextApi.StoriesApi	deleteStory	DELETE /api/story/{id}	Delete story
WhatHappensNextApi.StoriesApi	getStory	GET /api/story/{id}	Get Story
WhatHappensNextApi.StoriesApi	listStories	GET /api/stories	List stories
WhatHappensNextApi.StoriesApi	updateStory	PUT /api/story/{id}	Update story
WhatHappensNextApi.WebsocketApi	createStoryEventMessage	POST /api/socket/story_event	Create Story Event
WhatHappensNextApi.WebsocketApi	getConnectionEndpoint	GET /api/socket/endpoint	Get endpoint
WhatHappensNextApi.WebsocketApi	pingMessage	POST /api/socket/default	Ping
WhatHappensNextApi.WebsocketApi	websocketConnect	POST /api/socket/connect	Create Connection
WhatHappensNextApi.WebsocketApi	websocketDisconnect	POST /api/socket/disconnect	Delete Connection