💥 Refacto the Invoice v4 Model (#40)

Author: Kvindee

.gitattributes

@@ -0,0 +1,21 @@
+# Auto-detect text files, ensure they use LF.
+*       text=auto eol=lf
+
+# These files are always considered text and should use LF.
+# See core.whitespace @ https://git-scm.com/docs/git-config for whitespace flags.
+*.java  text eol=lf whitespace=blank-at-eol,space-before-tab,tab-in-indent,tabwidth=2
+*.cs    text eol=lf whitespace=blank-at-eol,space-before-tab,tab-in-indent,tabwidth=2
+*.ts    text eol=lf whitespace=blank-at-eol,space-before-tab,tab-in-indent,tabwidth=2
+*.js    text eol=lf whitespace=blank-at-eol,space-before-tab,tab-in-indent,tabwidth=2
+*.json  text eol=lf whitespace=blank-at-eol,space-before-tab,tab-in-indent,tabwidth=2
+*.sh    text eol=lf whitespace=blank-at-eol diff=bash
+*.md    text eol=lf whitespace=blank-at-eol diff=markdown
+*.rst   text eol=lf whitespace=blank-at-eol
+*.cfg   text eol=lf whitespace=blank-at-eol
+*.toml  text eol=lf whitespace=blank-at-eol,space-before-tab,tab-in-indent,tabwidth=2
+
+# Exclude non-essential files from dist
+.gitattributes  export-ignore
+.gitignore      export-ignore
+tests/          export-ignore
+.github         export-ignore

README.md

@@ -20,37 +20,21 @@ Include the following maven dependency in your project to use the helper library
 ### Usage
 The `Client` class is the entry point for most of the helper library features.
 
-Configuring and using a client to parse invoices, receipts, financial documents, and passports
+Configuring and using a client to parse invoices (or receipts, passports, ...)
 ```java
-Client client = new Client("<MINDEE API KEY>");
-InvoiceV4Response invoiceResponse = client.loadDocument(new File("src/main/resources/invoices/invoice1.pdf"))
-  .parse(InvoiceV4Response.class, ParseParameters.builder()
-    .documentType("invoice")
-    .build());
-
- ReceiptV4Response receiptResponse = client.loadDocument(new File("src/main/resources/receipts/receipt1.pdf"))
-  .parse(ReceiptV4Response.class, ParseParameters.builder()
-    .documentType("receipt")
-    .build());
-
- FinancialDocumentResponse finDocResponse = client.loadDocument(new File("src/main/resources/findocs/findoc1.pdf"))
-  .parse(FinancialDocumentResponse.class, ParseParameters.builder()
-    .documentType("financial_doc")
-    .build());
-```
+MindeeClient mindeeClient = new MindeeClient(new MindeeSetings("<MINDEE API KEY>"));
 
-Custom documents are supported as well and can be parsed as follows:
-```java
-CustomDocumentResponse bill = client.loadDocument(new File("src/test/resources/custom/custom1.pdf"))
-  .parse(CustomDocumentResponse.class, ParseParameters.builder()
-    .documentType("bill_of_lading_line_items")
-    .accountName("<your account name>")
-    .build());
+DocumentToParse documentToParse = mindeeClient.loadDocument(new File("src/main/resources/invoices/invoice1.pdf"));
+
+Document<InvoiceV4Inference> invoiceDocument = mindeeClient.parse(
+  InvoiceV4Inference.class,
+  documentToParse);
 ```
 
-The Client `loadDocument` method supports multiple input types:
+Client supports multiple input types:
 
 * java.io.File file
+* InputStream fileAsStream, String filename
 * byte[] fileAsByteArray, String filename
 * String fileAsBase64String, String filename