@p7m/billing-backend 0.1.1

package/README.md

@@ -0,0 +1,176 @@
+# @p7m/billing-backend
+
+BillingBackend - JavaScript client for @p7m/billing-backend
+# API for managing billing of customers
+
+The purpose of this API is to manage customers, articles, recurring billing, and payments.
+
+The caller has to be authenticated with the system and provide a JWT token in the Authorization header of
+the HTTP request. When using the API you typically get this token by authenticating first with OAuth 2.0.
+
+When you are trying this API using the Swagger interface, you need to click the `Authorize` button and then again
+the Authorize button in the pop-up that gets opened.
+This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 0.1.1
+- Package version: 0.1.1
+- 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/billing-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/billing-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 BillingBackend = require('@p7m/billing-backend');
+
+var defaultClient = BillingBackend.ApiClient.instance;
+// Configure OAuth2 access token for authorization: oauth
+var oauth = defaultClient.authentications['oauth'];
+oauth.accessToken = "YOUR ACCESS TOKEN"
+
+var api = new BillingBackend.BankAccountApi()
+api.getBankAccounts().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://billing.api.p7m.de/v1*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*BillingBackend.BankAccountApi* | [**getBankAccounts**](docs/BankAccountApi.md#getBankAccounts) | **GET** /bankaccounts | Get a list of all bank accounts
+*BillingBackend.BankAccountApi* | [**postBankAccounts**](docs/BankAccountApi.md#postBankAccounts) | **POST** /bankaccounts | Create a new bank account
+*BillingBackend.CustomerApi* | [**getCustomers**](docs/CustomerApi.md#getCustomers) | **GET** /customers | Get a list of all customers
+*BillingBackend.CustomerApi* | [**getCustomersId**](docs/CustomerApi.md#getCustomersId) | **GET** /customers/{customer_id} | Request a single customer by its ID
+*BillingBackend.CustomerApi* | [**postCustomers**](docs/CustomerApi.md#postCustomers) | **POST** /customers | Create a new customer
+*BillingBackend.CustomerApi* | [**pubCustomersId**](docs/CustomerApi.md#pubCustomersId) | **PUT** /customers/{customer_id} | Update an existing customer
+*BillingBackend.InvoiceApi* | [**getCurrencies**](docs/InvoiceApi.md#getCurrencies) | **GET** /currencies | Get a list of all (available) currencies
+*BillingBackend.InvoiceApi* | [**getInvoices**](docs/InvoiceApi.md#getInvoices) | **GET** /invoices | Get a list of all invoices
+*BillingBackend.InvoiceApi* | [**getInvoicesId**](docs/InvoiceApi.md#getInvoicesId) | **GET** /invoices/{invoice_id} | Get a single invoice by its ID
+*BillingBackend.InvoiceApi* | [**postInvoices**](docs/InvoiceApi.md#postInvoices) | **POST** /invoices | Create a new invoice
+*BillingBackend.InvoiceApi* | [**postInvoicesInvoiceId**](docs/InvoiceApi.md#postInvoicesInvoiceId) | **POST** /invoices/{invoice_id} | Create a new invoice position
+
+
+## Documentation for Models
+
+ - [BillingBackend.BankAccount](docs/BankAccount.md)
+ - [BillingBackend.BankAccountData](docs/BankAccountData.md)
+ - [BillingBackend.Currency](docs/Currency.md)
+ - [BillingBackend.CurrencyData](docs/CurrencyData.md)
+ - [BillingBackend.Customer](docs/Customer.md)
+ - [BillingBackend.CustomerData](docs/CustomerData.md)
+ - [BillingBackend.DetailedInvoice](docs/DetailedInvoice.md)
+ - [BillingBackend.Invoice](docs/Invoice.md)
+ - [BillingBackend.InvoiceData](docs/InvoiceData.md)
+ - [BillingBackend.InvoicePosition](docs/InvoicePosition.md)
+ - [BillingBackend.NewBankAccount](docs/NewBankAccount.md)
+ - [BillingBackend.NewCustomer](docs/NewCustomer.md)
+ - [BillingBackend.NewInvoice](docs/NewInvoice.md)
+ - [BillingBackend.NewInvoicePosition](docs/NewInvoicePosition.md)
+ - [BillingBackend.Salutation](docs/Salutation.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
+