1.0.0 • Published 4 years ago

ibble_api v1.0.0

Weekly downloads
-
License
Unlicense
Repository
-
Last release
4 years ago

ibble_api

IbbleApi - JavaScript client for ibble_api asdfasd fasdf asdf asdf asdf asdf asdf as df This SDK is automatically generated by the Swagger Codegen project:

  • API version: 1.0.0
  • Package version: 1.0.0
  • Build package: io.swagger.codegen.v3.generators.javascript.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 ibble_api --save

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):

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 IbbleApi = require('ibble_api');

var api = new IbbleApi.InterestsApi()
var body = new IbbleApi.CreateManyInterestDto(); // {CreateManyInterestDto} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createManyBaseInterestControllerInterest(body, callback);

Documentation for API Endpoints

All URIs are relative to /

ClassMethodHTTP requestDescription
IbbleApi.InterestsApicreateManyBaseInterestControllerInterestPOST /api/v1/interests/bulkCreate many Interest
IbbleApi.InterestsApicreateOneBaseInterestControllerInterestPOST /api/v1/interestsCreate one Interest
IbbleApi.InterestsApideleteOneBaseInterestControllerInterestDELETE /api/v1/interests/{id}Delete one Interest
IbbleApi.InterestsApigetManyBaseInterestControllerInterestGET /api/v1/interestsRetrieve many Interest
IbbleApi.InterestsApigetOneBaseInterestControllerInterestGET /api/v1/interests/{id}Retrieve one Interest
IbbleApi.InterestsApireplaceOneBaseInterestControllerInterestPUT /api/v1/interests/{id}Replace one Interest
IbbleApi.InterestsApiupdateOneBaseInterestControllerInterestPATCH /api/v1/interests/{id}Update one Interest
IbbleApi.LinksApicreateOneBaseLinksControllerLinkPOST /api/v1/linksCreate one Link
IbbleApi.LinksApideleteOneBaseLinksControllerLinkDELETE /api/v1/links/{id}Delete one Link
IbbleApi.LinksApigetManyBaseLinksControllerLinkGET /api/v1/linksRetrieve many Link
IbbleApi.LinksApigetOneBaseLinksControllerLinkGET /api/v1/links/{id}Retrieve one Link
IbbleApi.TroughApitroughControllerRavagePOST /api/v1/trough/ravage
IbbleApi.TroughApitroughControllerScavengePOST /api/v1/trough/scavenge

Documentation for Models

Documentation for Authorization

api_key

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

bearer

1.0.0

4 years ago