dcfb-api-client

0.0.42 • Public • Published

dcfb-api-client

DcfbApiClient - JavaScript client for dcfb-api-client API spec for DCFB API. This SDK is automatically generated by the Swagger Codegen project:

  • API version: 0.0.1
  • Package version: 0.0.41
  • 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 dcfb-api-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 dcfb-api-client from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('dcfb-api-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 DcfbApiClient = require('dcfb-api-client');
 
var defaultClient = DcfbApiClient.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 DcfbApiClient.CategoriesApi()
 
var payload = new DcfbApiClient.Category(); // {Category} Payload
 
api.createCategory(payload).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
DcfbApiClient.CategoriesApi createCategory POST /categories Create category
DcfbApiClient.CategoriesApi deleteCategory DELETE /categories/{categoryId} deletes an category
DcfbApiClient.CategoriesApi findCategory GET /categories/{categoryId} Finds an category
DcfbApiClient.CategoriesApi listCategories GET /categories List categories
DcfbApiClient.CategoriesApi updateCategory PUT /categories/{categoryId} updates an category
DcfbApiClient.ItemsApi createItem POST /items Create item
DcfbApiClient.ItemsApi createItemReservation POST /items/{itemId}/reservations Create item reservation
DcfbApiClient.ItemsApi deleteItem DELETE /items/{itemId} deletes an item
DcfbApiClient.ItemsApi findItem GET /items/{itemId} Finds an item
DcfbApiClient.ItemsApi findItemReservation GET /items/{itemId}/reservations/{itemReservationId} Find item reservation
DcfbApiClient.ItemsApi listItems GET /items List items
DcfbApiClient.ItemsApi updateItem PUT /items/{itemId} updates an item
DcfbApiClient.LocationsApi createLocation POST /locations Create location
DcfbApiClient.LocationsApi deleteLocation DELETE /locations/{locationId} deletes an location
DcfbApiClient.LocationsApi findLocation GET /locations/{locationId} Finds an location
DcfbApiClient.LocationsApi listLocations GET /locations List locations
DcfbApiClient.LocationsApi updateLocation PUT /locations/{locationId} updates an location

Documentation for Models

Documentation for Authorization

bearer

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

Readme

Keywords

none

Package Sidebar

Install

npm i dcfb-api-client

Weekly Downloads

0

Version

0.0.42

License

Unlicense

Unpacked Size

447 kB

Total Files

142

Last publish

Collaborators

  • metatavu