javascript-sdk-orders-api v1.0.0
javascript-sdk-orders-api
JavascriptSdkOrdersApi - JavaScript client for javascript-sdk-orders-api Orders API 9 This SDK is automatically generated by the OpenAPI Generator project:
- API version: 1.0.0
- Package version: 1.0.0
- 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 javascript-sdk-orders-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 javascript-sdk-orders-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/YOUR_USERNAME/javascript-sdk-orders-api then install it via:
npm install YOUR_USERNAME/javascript-sdk-orders-api --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 JavascriptSdkOrdersApi = require('javascript-sdk-orders-api');
var api = new JavascriptSdkOrdersApi.OrdersApi()
var newOrder = new JavascriptSdkOrdersApi.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 |
---|---|---|---|
JavascriptSdkOrdersApi.OrdersApi | createOrderAction | POST /orders | Creates a new order |
JavascriptSdkOrdersApi.OrdersApi | deleteOrderAction | DELETE /orders/{orderId} | Deletes order |
JavascriptSdkOrdersApi.OrdersApi | getOrderAction | GET /orders/{orderId} | Returns an order by ID |
JavascriptSdkOrdersApi.OrdersApi | listOrdersAction | GET /orders | Returns a list of orders |
JavascriptSdkOrdersApi.OrdersApi | updateOrderAction | PUT /orders/{orderId} | Updates order |
JavascriptSdkOrdersApi.StatusApi | status | GET /status | Return service status |
Documentation for Models
- JavascriptSdkOrdersApi.Error
- JavascriptSdkOrdersApi.NewOrder
- JavascriptSdkOrdersApi.NewOrderAddress
- JavascriptSdkOrdersApi.Order
- JavascriptSdkOrdersApi.Status
Documentation for Authorization
Endpoints do not require authorization.
10 months ago