kykyapi-client v0.0.84

kykyapi-client

KykyapiClient - JavaScript client for kykyapi-client KYKY Lasi Oy - ERP API This SDK is automatically generated by the Swagger Codegen project:

• API version: 0.0.1
• Package version: 0.0.83
• Build package: io.swagger.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 kykyapi-client --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 kykyapi-client from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

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

var defaultClient = KykyapiClient.ApiClient.instance;

// Configure API key authorization: bearer
var bearer = defaultClient.authentications['bearer'];
bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new KykyapiClient.AttachmentsApi()

var body = new KykyapiClient.Attachment(); // {Attachment} Payload

api.createAttachment(body).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

All URIs are relative to https://localhost/v1

Documentation for Models

• KykyapiClient.Address
• KykyapiClient.Attachment
• KykyapiClient.BadRequest
• KykyapiClient.Catalogue
• KykyapiClient.CatalogueProduct
• KykyapiClient.CustomerOrganization
• KykyapiClient.CustomerRepresentative
• KykyapiClient.Forbidden
• KykyapiClient.InternalOrder
• KykyapiClient.InternalServerError
• KykyapiClient.InvoiceModel
• KykyapiClient.ListProduct
• KykyapiClient.NotFound
• KykyapiClient.NotImplemented
• KykyapiClient.PurchaseOfferRequest
• KykyapiClient.PurchaseOrder
• KykyapiClient.PurchaseOrderInvoice
• KykyapiClient.RowProduct
• KykyapiClient.RowProductDetail
• KykyapiClient.Sale
• KykyapiClient.SaleOffer
• KykyapiClient.SaleOrder
• KykyapiClient.Schematic
• KykyapiClient.StorageProduct

Documentation for Authorization

bearer

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header