@p7m/grisbi-backend

GrisbiBackend - JavaScript client for @p7m/grisbi-backend

API POS-Daten

Dies ist die REST-API des P7M-Services, der für die Verwaltung von POS-Daten zuständig ist.

Wie in jeder REST-Schnittstelle gilt die übliche CRUD-Semantik (Create, Read, Update, Delete), so dass für die vier Typen des Zugriffs auf ein Objekt vier verschiedene HTTP-Verben benutzt werden: POST: Erstellen eines neuen Objektes GET: Lesen eines bestehenden Objektes PUT: Ändern eines bestehenden Objektes DELETE: Löschen eines bestehenden Objektes This SDK is automatically generated by the OpenAPI Generator project:

• API version: 0.2.0
• Package version: 0.2.0
• Generator version: 7.13.0-SNAPSHOT
• 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 @p7m/grisbi-backend --save

Finally, you need to build the module:

npm run build

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

To use the link you just defined in your project, switch to the directory you want to use your @p7m/grisbi-backend from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

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 GrisbiBackend = require('@p7m/grisbi-backend');

var defaultClient = GrisbiBackend.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth
var oauth = defaultClient.authentications['oauth'];
oauth.accessToken = "YOUR ACCESS TOKEN"

var api = new GrisbiBackend.ArticleApi()
api.getArticleHierarchy().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://grisbi.p7m.de/v1

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- GrisbiBackend.ArticleApi | getArticleHierarchy | GET /article/hierarchy | Abfrage der kompletten Hierarchie aller Artikel GrisbiBackend.ArticleApi | getArticleManufacturerIdArticleTypeIdArticleNameIdArticleDetailId | GET /article/{manufacturer_id}/{type_id}/{name_id}/{detail_id} | Abfrage der kompletten Daten eines Artikels GrisbiBackend.ArticleDetailApi | deleteArticleManufacturerIdArticleTypeIdArticleNameIdArticleDetailId | DELETE /article/{manufacturer_id}/{type_id}/{name_id}/{detail_id} | Löscht das angegebene Artikeldetail GrisbiBackend.ArticleDetailApi | getArticleManufacturerIdArticleTypeIdArticleNameId | GET /article/{manufacturer_id}/{type_id}/{name_id} | Abfrage aller Artikeldetails eines Artikelnamens GrisbiBackend.ArticleDetailApi | postArticleManufacturerIdArticleTypeIdArticleNameId | POST /article/{manufacturer_id}/{type_id}/{name_id} | Hiermit wird ein neues Artikeldetail im System angelegt GrisbiBackend.ArticleDetailApi | putArticleManufacturerIdArticleTypeIdArticleNameIdArticleDetailId | PUT /article/{manufacturer_id}/{type_id}/{name_id}/{detail_id} | Ändern eines bestehenden Artikeldetails GrisbiBackend.ArticleManufacturerApi | deleteArticleManufacturerId | DELETE /article/{manufacturer_id} | Löschen eines Herstellers. GrisbiBackend.ArticleManufacturerApi | getArticle | GET /article | Abfrage aller Herstler (manufacturer) GrisbiBackend.ArticleManufacturerApi | postArticle | POST /article | Hiermit wird ein neuer Hersteller (manufacturer) im System angelegt GrisbiBackend.ArticleManufacturerApi | putArticleManufacturerId | PUT /article/{manufacturer_id} | Ändern eines bestehenden Herstellers (manufacturer) GrisbiBackend.ArticleNameApi | deleteArticleManufacturerIdArticleTypeIdArticleNameId | DELETE /article/{manufacturer_id}/{type_id}/{name_id} | Löscht den angegebenen Artikelnamen GrisbiBackend.ArticleNameApi | getArticleManufacturerIdArticleTypeId | GET /article/{manufacturer_id}/{type_id} | Abfrage aller Artikelnamen für einen Artikeltypen GrisbiBackend.ArticleNameApi | postArticleManufacturerIdArticleTypeId | POST /article/{manufacturer_id}/{type_id} | Hiermit wird ein neuer Artikelname im System angelegt GrisbiBackend.ArticleNameApi | putArticleManufacturerIdArticleTypeIdArticleNameId | PUT /article/{manufacturer_id}/{type_id}/{name_id} | Ändern eines bestehenden Artikelnamens GrisbiBackend.ArticleTypeApi | deleteArticleManufacturerIdTypeId | DELETE /article/{manufacturer_id}/{type_id} | Löscht den angelegten Artikeltypen GrisbiBackend.ArticleTypeApi | getArticleManufacturerId | GET /article/{manufacturer_id} | Abfrage aller Typen für einen Hersteller GrisbiBackend.ArticleTypeApi | postArticleManufacturerId | POST /article/{manufacturer_id} | Hiermit wird ein neuer Artikeltyp im System angelegt GrisbiBackend.ArticleTypeApi | putArticleManufacturerIdArticleTypeId | PUT /article/{manufacturer_id}/{type_id} | Ändern eines bestehenden Artikeltyps

Documentation for Models

• GrisbiBackend.Article
• GrisbiBackend.ArticleDetail
• GrisbiBackend.ArticleDetailData
• GrisbiBackend.ArticleHierarchy
• GrisbiBackend.ArticleManufacturer
• GrisbiBackend.ArticleManufacturerHierarchy
• GrisbiBackend.ArticleName
• GrisbiBackend.ArticleNameHierarchy
• GrisbiBackend.ArticleType
• GrisbiBackend.ArticleTypeData
• GrisbiBackend.ArticleTypeHierarchy
• GrisbiBackend.ListWrapperArticleManufacturer
• GrisbiBackend.ListWrapperArticleManufacturerDataInner
• GrisbiBackend.NewArticleDetail
• GrisbiBackend.NewArticleManufacturer
• GrisbiBackend.NewArticleName
• GrisbiBackend.NewArticleType

Documentation for Authorization

Authentication schemes defined for the API:

oauth

• Type: OAuth
• Flow: accessCode
• Authorization URL: https://login.p7m.de/auth/authorize
• Scopes: N/A