Test-javascript-sdk NPM

test-javascript-sdk

TestJavascriptSdk - JavaScript client for test-javascript-sdk Orders API 9 This SDK is automatically generated by the OpenAPI Generator project:

API version: 1.0.0
Package version: 1.2.1
Build package: org.openapitools.codegen.languages.JavascriptClientCodegen For more information, please visit https://www.mavensolutions.tech

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 test-javascript-sdk --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 test-javascript-sdk 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/YOUR_USERNAME/test-javascript-sdk then install it via:

    npm install YOUR_USERNAME/test-javascript-sdk --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 TestJavascriptSdk = require('test-javascript-sdk');


var api = new TestJavascriptSdk.OrdersApi()
var newOrder = new TestJavascriptSdk.NewOrder(); // {NewOrder} NewOrder
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createOrderAction(newOrder, callback);

Documentation for API Endpoints

All URIs are relative to https://acme.mavendev.com/api

Class	Method	HTTP request	Description
TestJavascriptSdk.OrdersApi	createOrderAction	POST /orders	Creates a new order
TestJavascriptSdk.OrdersApi	deleteOrderAction	DELETE /orders/{orderId}	Deletes order
TestJavascriptSdk.OrdersApi	getOrderAction	GET /orders/{orderId}	Returns an order by ID
TestJavascriptSdk.OrdersApi	listOrdersAction	GET /orders	Returns a list of orders
TestJavascriptSdk.OrdersApi	updateOrderAction	PUT /orders/{orderId}	Updates order
TestJavascriptSdk.StatusApi	status	GET /status	Return service status