npm package: @p7m/grisbi-backend
Description: ## 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 O
Latest version: 0.2.0

# @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](https://openapi-generator.tech) 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](https://nodejs.org/)

#### npm

To publish the library as a [npm](https://www.npmjs.com/), please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages).

Then install it via:

```shell
npm install @p7m/grisbi-backend --save
```

Finally, you need to build the module:

```shell
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:

```shell
npm install
```

Next, [link](https://docs.npmjs.com/cli/link) it globally in npm with the following, also from `JAVASCRIPT_CLIENT_DIR`:

```shell
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:

```shell
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
```

Finally, you need to build the module:

```shell
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:

```shell
    npm install GIT_USER_ID/GIT_REPO_ID --save
```

### For browser

The library also works in the browser environment via npm and [browserify](http://browserify.org/). 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):

```shell
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:

```javascript
module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}
```

## Getting Started

Please follow the [installation](#installation) instruction and execute the following JS code:

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


## Documentation for Models

 - [GrisbiBackend.Article](docs/Article.md)
 - [GrisbiBackend.ArticleDetail](docs/ArticleDetail.md)
 - [GrisbiBackend.ArticleDetailData](docs/ArticleDetailData.md)
 - [GrisbiBackend.ArticleHierarchy](docs/ArticleHierarchy.md)
 - [GrisbiBackend.ArticleManufacturer](docs/ArticleManufacturer.md)
 - [GrisbiBackend.ArticleManufacturerHierarchy](docs/ArticleManufacturerHierarchy.md)
 - [GrisbiBackend.ArticleName](docs/ArticleName.md)
 - [GrisbiBackend.ArticleNameHierarchy](docs/ArticleNameHierarchy.md)
 - [GrisbiBackend.ArticleType](docs/ArticleType.md)
 - [GrisbiBackend.ArticleTypeData](docs/ArticleTypeData.md)
 - [GrisbiBackend.ArticleTypeHierarchy](docs/ArticleTypeHierarchy.md)
 - [GrisbiBackend.ListWrapperArticleManufacturer](docs/ListWrapperArticleManufacturer.md)
 - [GrisbiBackend.ListWrapperArticleManufacturerDataInner](docs/ListWrapperArticleManufacturerDataInner.md)
 - [GrisbiBackend.NewArticleDetail](docs/NewArticleDetail.md)
 - [GrisbiBackend.NewArticleManufacturer](docs/NewArticleManufacturer.md)
 - [GrisbiBackend.NewArticleName](docs/NewArticleName.md)
 - [GrisbiBackend.NewArticleType](docs/NewArticleType.md)


## 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