product_management_api
v0.0.2
Published
This_API_exposes_endpoints_to_manage_employees_
Downloads
9
Readme
product_management_api
ProductManagementApi - JavaScript client for product_management_api This API exposes endpoints to manage employees. This SDK is automatically generated by the OpenAPI Generator project:
- API version: 1.0
- Package version: 1.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 product_management_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 product_management_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 ProductManagementApi = require('product_management_api');
var api = new ProductManagementApi.ClientControllerApi()
var id = "id_example"; // {String}
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.delete3(id, callback);
Documentation for API Endpoints
All URIs are relative to http://localhost:5173
Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- ProductManagementApi.ClientControllerApi | delete3 | DELETE /api/v1/client/{id} | ProductManagementApi.ClientControllerApi | get3 | GET /api/v1/client/{id} | ProductManagementApi.ClientControllerApi | insert3 | PUT /api/v1/client | ProductManagementApi.ClientControllerApi | listAll3 | POST /api/v1/client/list | ProductManagementApi.ClientControllerApi | test | POST /api/v1/client/test | ProductManagementApi.ClientControllerApi | update3 | POST /api/v1/client | ProductManagementApi.PaymentControllerApi | delete2 | DELETE /api/v1/payment/{id} | ProductManagementApi.PaymentControllerApi | get2 | GET /api/v1/payment/{id} | ProductManagementApi.PaymentControllerApi | insert2 | PUT /api/v1/payment | ProductManagementApi.PaymentControllerApi | listAll2 | POST /api/v1/payment/list | ProductManagementApi.PaymentControllerApi | update2 | POST /api/v1/payment | ProductManagementApi.ProductAttributeControllerApi | delete4 | DELETE /api/v1/attribute/{id} | ProductManagementApi.ProductAttributeControllerApi | get4 | GET /api/v1/attribute/{id} | ProductManagementApi.ProductAttributeControllerApi | insert4 | PUT /api/v1/attribute | ProductManagementApi.ProductAttributeControllerApi | listAll4 | POST /api/v1/attribute/list | ProductManagementApi.ProductAttributeControllerApi | update4 | POST /api/v1/attribute | ProductManagementApi.ProductTransactionControllerApi | callDelete | DELETE /api/v1/transaction/{id} | ProductManagementApi.ProductTransactionControllerApi | get | GET /api/v1/transaction/{id} | ProductManagementApi.ProductTransactionControllerApi | insert | PUT /api/v1/transaction | ProductManagementApi.ProductTransactionControllerApi | listAll | POST /api/v1/transaction/list | ProductManagementApi.ProductTransactionControllerApi | update | POST /api/v1/transaction | ProductManagementApi.StockControllerApi | delete1 | DELETE /api/v1/stock/{id} | ProductManagementApi.StockControllerApi | get1 | GET /api/v1/stock/{id} | ProductManagementApi.StockControllerApi | insert1 | PUT /api/v1/stock | ProductManagementApi.StockControllerApi | listAll1 | POST /api/v1/stock/list | ProductManagementApi.StockControllerApi | update1 | POST /api/v1/stock |
Documentation for Models
- ProductManagementApi.Client
- ProductManagementApi.ClientDTO
- ProductManagementApi.GenericResponseClientDTO
- ProductManagementApi.GenericResponseListClientDTO
- ProductManagementApi.GenericResponseListPaymentDTO
- ProductManagementApi.GenericResponseListProductAttributeDTO
- ProductManagementApi.GenericResponseListProductTransactionDTO
- ProductManagementApi.GenericResponseListStockDTO
- ProductManagementApi.GenericResponsePaymentDTO
- ProductManagementApi.GenericResponseProductAttributeDTO
- ProductManagementApi.GenericResponseProductTransactionDTO
- ProductManagementApi.GenericResponseStockDTO
- ProductManagementApi.Payment
- ProductManagementApi.PaymentDTO
- ProductManagementApi.ProductAttributeDTO
- ProductManagementApi.ProductDetail
- ProductManagementApi.ProductDetailDTO
- ProductManagementApi.ProductTransaction
- ProductManagementApi.ProductTransactionDTO
- ProductManagementApi.StockDTO
Documentation for Authorization
All endpoints do not require authorization.