warranty_life v1.0.6
warranty_life
WarrantyLife - JavaScript client for warranty_life Warranty life api definition for openapi 3.0.0 from here we generate api's This SDK is automatically generated by the OpenAPI Generator project:
- API version: 1.0.6
- Package version: 1.0.6
- 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 warranty_life --save
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
Finally, switch to the directory you want to use your warranty_life from, and run:
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
You should now be able to require('warranty_life')
in javascript files from the directory you ran the last
command above from.
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, that's to say your javascript file where you actually
use this library):
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 WarrantyLife = require('warranty_life');
var defaultClient = WarrantyLife.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'
var api = new WarrantyLife.CategoriesApi()
var categoryId = "categoryId_example"; // {String} Id for the category you would like to retrieve
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.categoriesCategoryIdGet(categoryId, callback);
Documentation for API Endpoints
All URIs are relative to https://sandbox.warrantylife.com/api/201308
Class | Method | HTTP request | Description |
---|---|---|---|
WarrantyLife.CategoriesApi | categoriesCategoryIdGet | GET /categories/{categoryId} | |
WarrantyLife.CategoriesApi | categoriesGet | GET /categories | List of all categories |
WarrantyLife.CustomerApi | customersCustomerIdGet | GET /customers/{customerId} | get customer by customer id |
WarrantyLife.CustomerApi | customersGet | GET /customers | get a customer by refId |
WarrantyLife.CustomerApi | customersPost | POST /customers | Add a new customer |
WarrantyLife.ItemsApi | itemsGet | GET /items | get an item |
WarrantyLife.ItemsApi | itemsItemIdGet | GET /items/{itemId} | get an item |
WarrantyLife.ItemsApi | itemsItemIdWarrantiesPost | POST /items/{itemId}/warranties | create warranty |
WarrantyLife.ItemsApi | itemsPost | POST /items | create new item |
WarrantyLife.ManufacturersApi | manufacturersGet | GET /manufacturers | get list of manufacturers |
WarrantyLife.ManufacturersApi | manufacturersManufacturerIdGet | GET /manufacturers/{manufacturerId} | specific manufacturer from warranty life id |
WarrantyLife.ManufacturersApi | manufacturersPost | POST /manufacturers | create new manufacturer |
WarrantyLife.ProductsApi | productsGet | GET /products | get a list of products |
WarrantyLife.ProductsApi | productsPost | POST /products | create new product |
WarrantyLife.ProductsApi | productsProductIdGet | GET /products/{productId} | get a single product by id |
WarrantyLife.VoucherBatchApi | voucherBatchPost | POST /voucher-batch | create a bunch of vouchers for warranties |
WarrantyLife.VoucherBatchApi | voucherVoucherCodePut | PUT /voucher/{voucherCode} | issue a warranty from the batch |
WarrantyLife.WarrantiesApi | itemsItemIdWarrantiesPost | POST /items/{itemId}/warranties | create warranty |
WarrantyLife.WarrantiesApi | warrantiesGet | GET /warranties | get warranty by query params |
WarrantyLife.WarrantiesApi | warrantiesPost | POST /warranties | create warranty |
WarrantyLife.WarrantiesApi | warrantiesWarrantyIdDelete | DELETE /warranties/{warrantyId} | delete an item |
WarrantyLife.WarrantiesApi | warrantiesWarrantyIdGet | GET /warranties/{warrantyId} | get an item |
WarrantyLife.WarrantyPlansApi | warrantyPlansGet | GET /warranty-plans | |
WarrantyLife.WarrantyPlansApi | warrantyPlansWarrantyPlanIdGet | GET /warranty-plans/{warrantyPlanId} |
Documentation for Models
- WarrantyLife.Body
- WarrantyLife.Category
- WarrantyLife.Customer
- WarrantyLife.InlineResponse403
- WarrantyLife.Item
- WarrantyLife.Manufacturer
- WarrantyLife.Product
- WarrantyLife.VoucherBatch
- WarrantyLife.Warranty
- WarrantyLife.WarrantyPlan
Documentation for Authorization
basicAuth
- Type: HTTP basic authentication