warranty_life_api v1.0.9

warranty_life_api

WarrantyLifeApi - JavaScript client for warranty_life_api Warranty life Api This SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.0.9
• Package version: 1.0.9
• 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_api --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_api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('warranty_life_api') 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 WarrantyLifeApi = require('warranty_life_api');

var defaultClient = WarrantyLifeApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new WarrantyLifeApi.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

Documentation for Models

• WarrantyLifeApi.Body
• WarrantyLifeApi.Category
• WarrantyLifeApi.Customer
• WarrantyLifeApi.InlineResponse403
• WarrantyLifeApi.Item
• WarrantyLifeApi.Manufacturer
• WarrantyLifeApi.Product
• WarrantyLifeApi.VoucherBatch
• WarrantyLifeApi.Warranty
• WarrantyLifeApi.WarrantyPlan

Documentation for Authorization

basicAuth

• Type: HTTP basic authentication