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

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- KykyapiClient.AttachmentsApi | createAttachment | POST /attachments | create attachment KykyapiClient.AttachmentsApi | findAttachment | GET /attachments/{attachmentId} | Find a attachment by id KykyapiClient.AttachmentsApi | findAttachmentData | GET /attachments/{attachmentId}/data | Find a attachment data by id KykyapiClient.CataloguesApi | createCatalogue | POST /catalogues | Create catalogue KykyapiClient.CataloguesApi | deleteCatalogue | DELETE /catalogues/{catalogueId} | Delete catalogue KykyapiClient.CataloguesApi | findCatalogue | GET /catalogues/{catalogueId} | Find catalogue KykyapiClient.CataloguesApi | listCatalogues | GET /catalogues | List catalogues KykyapiClient.CataloguesApi | updateCatalogue | PUT /catalogues/{catalogueId} | Update catalogue KykyapiClient.CustomerOrganizationApi | createCustomerOrganization | POST /customerOrganizations | Create customer organization KykyapiClient.CustomerOrganizationApi | deleteCustomerOrganization | DELETE /customerOrganizations/{customerOrganizationId} | Delete customer organization KykyapiClient.CustomerOrganizationApi | findCustomerOrganization | GET /customerOrganizations/{customerOrganizationId} | Find customer organization KykyapiClient.CustomerOrganizationApi | listCustomerOrganizations | GET /customerOrganizations | List customerOrganizations KykyapiClient.CustomerOrganizationApi | updateCustomerOrganization | PUT /customerOrganizations/{customerOrganizationId} | Update customer organization KykyapiClient.CustomerRepresentativeApi | createCustomerRepresentative | POST /customerRepresentatives | Create customer representative KykyapiClient.CustomerRepresentativeApi | deleteCustomerRepresentative | DELETE /customerRepresentatives/{customerRepresentativeId} | Delete customer representative KykyapiClient.CustomerRepresentativeApi | findCustomerRepresentative | GET /customerRepresentatives/{customerRepresentativeId} | Find customer representative KykyapiClient.CustomerRepresentativeApi | listCustomerRepresentatives | GET /customerRepresentatives | List customer representatives KykyapiClient.CustomerRepresentativeApi | updateCustomerRepresentative | PUT /customerRepresentatives/{customerRepresentativeId} | Update customer representative KykyapiClient.InternalOrderApi | createInternalOrder | POST /internalOrders | Create internal order KykyapiClient.InternalOrderApi | deleteInternalOrder | DELETE /internalOrders/{internalOrderId} | Delete internal order KykyapiClient.InternalOrderApi | findInternalOrder | GET /internalOrders/{internalOrderId} | Find internal order KykyapiClient.InternalOrderApi | listInternalOrders | GET /internalOrders | List internal orders KykyapiClient.InternalOrderApi | updateInternalOrder | PUT /internalOrders/{internalOrderId} | Update internal order KykyapiClient.InvoicesApi | createInvoice | POST /invoices | Create invoice KykyapiClient.ListProductApi | createListProduct | POST /listProducts | Create list product KykyapiClient.ListProductApi | deleteListProduct | DELETE /listProducts/{listProductId} | Delete a list product KykyapiClient.ListProductApi | findListProduct | GET /listProducts/{listProductId} | Find a list product KykyapiClient.ListProductApi | listListProducts | GET /listProducts | List list products KykyapiClient.ListProductApi | updateListProduct | PUT /listProducts/{listProductId} | Update list product KykyapiClient.PurchaseOfferRequestApi | createPurchaseOfferRequest | POST /purchaseOfferRequests | Create purchase offer request KykyapiClient.PurchaseOfferRequestApi | deletePurchaseOfferRequest | DELETE /purchaseOfferRequests/{purchaseOfferRequestId} | Delete purchase offer request KykyapiClient.PurchaseOfferRequestApi | findPurchaseOfferRequest | GET /purchaseOfferRequests/{purchaseOfferRequestId} | Find purchase offer request KykyapiClient.PurchaseOfferRequestApi | getPurchaseOfferRequestsPdf | GET /purchaseOfferRequests/{purchaseOfferRequestId}/pdf | Get purchase offer request PDF KykyapiClient.PurchaseOfferRequestApi | listPurchaseOfferRequests | GET /purchaseOfferRequests | List purchase offer requests KykyapiClient.PurchaseOfferRequestApi | updatePurchaseOfferRequest | PUT /purchaseOfferRequests/{purchaseOfferRequestId} | Update purchase offer request KykyapiClient.PurchaseOrderApi | createPurchaseOrder | POST /purchaseOrders | Create purchase order KykyapiClient.PurchaseOrderApi | deletePurchaseOrder | DELETE /purchaseOrders/{purchaseOrderId} | Delete purchase order KykyapiClient.PurchaseOrderApi | findPurchaseOrder | GET /purchaseOrders/{purchaseOrderId} | Find purchase order KykyapiClient.PurchaseOrderApi | getPurchaseOrderPdf | GET /purchaseOrders/{purchaseOrderId}/pdf | Get purchase order PDF KykyapiClient.PurchaseOrderApi | listPurchaseOrders | GET /purchaseOrders | List purchase orders KykyapiClient.PurchaseOrderApi | updatePurchaseOrder | PUT /purchaseOrders/{purchaseOrderId} | Update purchase order KykyapiClient.RowProductApi | createRowProduct | POST /rowProducts | Create row product KykyapiClient.RowProductApi | deleteRowProduct | DELETE /rowProducts/{rowProductId} | Delete row product KykyapiClient.RowProductApi | findRowProduct | GET /rowProducts/{rowProductId} | Find row product KykyapiClient.RowProductApi | listRowProducts | GET /rowProducts | List row products KykyapiClient.RowProductApi | updateRowProduct | PUT /rowProducts/{rowProductId} | Update row product KykyapiClient.SaleApi | createSale | POST /sales | Create sale KykyapiClient.SaleApi | deleteSale | DELETE /sales/{saleId} | Delete sale KykyapiClient.SaleApi | findSale | GET /sales/{saleId} | Find sale KykyapiClient.SaleApi | listSales | GET /sales | List sales KykyapiClient.SaleApi | updateSale | PUT /sales/{saleId} | Update sale KykyapiClient.SaleOfferApi | createSaleOffer | POST /saleOffers | Create sale offer KykyapiClient.SaleOfferApi | deleteSaleOffer | DELETE /saleOffers/{saleOfferId} | Delete sale offer KykyapiClient.SaleOfferApi | findSaleOffer | GET /saleOffers/{saleOfferId} | Find sale offer KykyapiClient.SaleOfferApi | getSaleOfferPdf | GET /saleOffers/{saleOfferId}/pdf | Get sale offer PDF KykyapiClient.SaleOfferApi | listSaleOffers | GET /saleOffers | List sale offers KykyapiClient.SaleOfferApi | updateSaleOffer | PUT /saleOffers/{saleOfferId} | Update sale offer KykyapiClient.SaleOrderApi | createSaleOrder | POST /saleOrders | Create sale order KykyapiClient.SaleOrderApi | deleteSaleOrder | DELETE /saleOrders/{saleOrderId} | Delete sale order KykyapiClient.SaleOrderApi | findSaleOrder | GET /saleOrders/{saleOrderId} | Find sale order KykyapiClient.SaleOrderApi | getSaleOrderPdf | GET /saleOrders/{saleOrderId}/pdf | Get sale order PDF KykyapiClient.SaleOrderApi | listSaleOrders | GET /saleOrders | List sale orders KykyapiClient.SaleOrderApi | updateSaleOrder | PUT /saleOrders/{saleOrderId} | Update sale order KykyapiClient.SchematicApi | createSchematic | POST /schematics | Create schematic KykyapiClient.SchematicApi | findSchematic | GET /schematics/{schematicId} | Find schematic KykyapiClient.SchematicApi | findSchematicData | GET /schematics/{schematicId}/data | Find schematic data KykyapiClient.SchematicApi | listSchematics | GET /schematics | List schematics KykyapiClient.SchematicApi | updateSchematic | PUT /schematics/{schematicId} | Update schematic KykyapiClient.SchematicApi | updateSchematicData | PUT /schematics/{schematicId}/data | Update schematic data KykyapiClient.StorageProductApi | createStorageProduct | POST /storageProducts | Create storage product KykyapiClient.StorageProductApi | findStorageProduct | GET /storageProducts/{storageProductId} | Find a storage product KykyapiClient.StorageProductApi | listStorageProducts | GET /storageProducts | List list products KykyapiClient.StorageProductApi | updateStorageProduct | PUT /storageProducts/{storageProductId} | Update storage product

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