https://github.com/sonofra/receipts-client
https://github.com/sonofra/receipts-client
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/sonofra/receipts-client
- Owner: sonOfRa
- Created: 2019-11-26T14:31:26.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-05-20T21:17:01.000Z (about 3 years ago)
- Last Synced: 2025-01-22T11:39:26.051Z (4 months ago)
- Language: Java
- Size: 46.9 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# receipts-client
Example API for receipts
- API version: 1.0.0-SNAPSHOT
- Build date: 2019-11-26T15:28:50.841+01:00[Europe/Berlin]
API for generating receipts and mailing them to users
*Automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen)*
## Requirements
Building the API client library requires:
1. Java 1.7+
2. Maven/Gradle
## Installation
To install the API client library to your local Maven repository, simply execute:
```shell
mvn clean install
```
To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:
```shell
mvn clean deploy
```
Refer to the [OSSRH Guide](http://central.sonatype.org/pages/ossrh-guide.html) for more information.
### Maven users
Add this dependency to your project's POM:
```xml
com.example
receipts-client
1.0.0-SNAPSHOT
compile
```
### Gradle users
Add this dependency to your project's build file:
```groovy
compile "com.example:receipts-client:1.0.0-SNAPSHOT"
```
### Others
At first generate the JAR by executing:
```shell
mvn clean package
```
Then manually install the following JARs:
* `target/receipts-client-1.0.0-SNAPSHOT.jar`
* `target/lib/*.jar`
## Getting Started
Please follow the [installation](#installation) instruction and execute the following Java code:
```java
import com.example.receipts.invoker.*;
import com.example.receipts.invoker.auth.*;
import com.example.receipts.model.*;
import com.example.receipts.api.ReceiptsApi;
import java.io.File;
import java.util.*;
public class ReceiptsApiExample {
public static void main(String[] args) {
ReceiptsApi apiInstance = new ReceiptsApi();
Receipt body = new Receipt(); // Receipt | Data for receipt
try {
apiInstance.newReceipt(body);
} catch (ApiException e) {
System.err.println("Exception when calling ReceiptsApi#newReceipt");
e.printStackTrace();
}
}
}
```
## Documentation for API Endpoints
All URIs are relative to *http://localhost:8080/v1*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*ReceiptsApi* | [**newReceipt**](docs/ReceiptsApi.md#newReceipt) | **POST** /receipt | Create new Receipt
## Documentation for Models
- [ApiError](docs/ApiError.md)
- [Discount](docs/Discount.md)
- [Receipt](docs/Receipt.md)
- [ReceiptItem](docs/ReceiptItem.md)
- [ReceiptTax](docs/ReceiptTax.md)
- [ReceiptTaxItem](docs/ReceiptTaxItem.md)
- [TseData](docs/TseData.md)
## Documentation for Authorization
All endpoints do not require authorization.
Authentication schemes defined for the API:
## Recommendation
It's recommended to create an instance of `ApiClient` per thread in a multithreaded environment to avoid any potential issues.
## Author