javascript-sdk-customers-api v1.0.0
javascript-sdk-customers-api
JavascriptSdkCustomersApi - JavaScript client for javascript-sdk-customers-api API to manage customer data 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
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-customers-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-customers-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-customers-api then install it via:
npm install YOUR_USERNAME/javascript-sdk-customers-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 JavascriptSdkCustomersApi = require('javascript-sdk-customers-api');
var api = new JavascriptSdkCustomersApi.DefaultApi()
var customerId = 56; // {Number} ID of the customer to delete
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully.');
}
};
api.customersCustomerIdDelete(customerId, callback);
Documentation for API Endpoints
All URIs are relative to http://localhost
Class | Method | HTTP request | Description |
---|---|---|---|
JavascriptSdkCustomersApi.DefaultApi | customersCustomerIdDelete | DELETE /customers/{customerId} | Delete a customer |
JavascriptSdkCustomersApi.DefaultApi | customersCustomerIdGet | GET /customers/{customerId} | Get a customer by ID |
JavascriptSdkCustomersApi.DefaultApi | customersCustomerIdPut | PUT /customers/{customerId} | Update a customer |
JavascriptSdkCustomersApi.DefaultApi | customersGet | GET /customers | Get all customers |
JavascriptSdkCustomersApi.DefaultApi | customersPost | POST /customers | Create a new customer |
Documentation for Models
- JavascriptSdkCustomersApi.Customer
- JavascriptSdkCustomersApi.NewCustomer
- JavascriptSdkCustomersApi.UpdateCustomer
Documentation for Authorization
Endpoints do not require authorization.
10 months ago