RC 2.1.1 - Updated types for fees and taxes from primitive to Object to allow null values and fix serialization issues. (#49)

<!--
We appreciate the effort for this pull request but before that please
make sure you read the contribution guidelines, then fill out the blanks
below.

Please format the PR title appropriately based on the type of change:
  <type>[!]: <description>
Where <type> is one of: docs, chore, feat, fix, test.
Add a '!' after the type for breaking changes (e.g. feat!: new breaking
feature).

**All third-party contributors acknowledge that any contributions they
provide will be made under the same open-source license that the
open-source project is provided under.**

Please enter each Issue number you are resolving in your PR after one of
the following words [Fixes, Closes, Resolves]. This will auto-link these
issues and close them when this PR is merged!
e.g.
Fixes #1
Closes #2
-->

# Fixes #

Updated types for fees and taxes from primitive to Object to allow null
values and fix serialization issues.

closes #48 

### Checklist

- [x] I acknowledge that all my contributions will be made under the
project's license
- [ ] I have made a material change to the repo (functionality, testing,
spelling, grammar)
- [ ] I have titled the PR appropriately
- [ ] I have updated my branch with the main branch
- [ ] I have added tests that prove my fix is effective or that my
feature works
- [ ] I have added the necessary documentation about the functionality
in the appropriate .md file
- [ ] I have added inline documentation to the code I modified

If you have questions, create a GitHub Issue in this repository.

---------

Co-authored-by: Daniel Morton <[email protected]>

Author: Aman Aalam

README.md

@@ -12,7 +12,7 @@ Add this dependency to your project's POM:
 <dependency>
     <groupId>com.trolley</groupId>
     <artifactId>java-sdk</artifactId>
-    <version>2.0.1</version>
+    <version>2.1.1</version>
 </dependency>
 ```
 

pom.xml

@@ -3,7 +3,7 @@
     <modelVersion>4.0.0</modelVersion>
     <groupId>com.trolley</groupId>
     <artifactId>java-sdk</artifactId>
-    <version>2.0.1</version>
+    <version>2.1.1</version>
     <description>Java SDK for Trolley API</description>
     <packaging>jar</packaging>
     <name>Trolley Java SDK</name>

src/main/java/com/trolley/types/InvoiceLine.java

@@ -27,14 +27,12 @@ public class InvoiceLine
     private Amount paidAmount;
     private String externalId;
 
-    @JsonInclude(JsonInclude.Include.NON_DEFAULT)
-    private boolean taxReportable;
+    private Boolean taxReportable;
 
     private List<String> tags;
     private InvoiceCategories category;
 
-    @JsonInclude(JsonInclude.Include.NON_DEFAULT)
-    private boolean forceUsTaxActivity;
+    private Boolean forceUsTaxActivity;
 
     public static enum InvoiceCategories{
         SERVICES("services"),
@@ -89,8 +87,8 @@ public InvoiceLine(
         InvoiceCategories category,
         String description, 
         String externalId,
-        boolean taxReportable, 
-        boolean forceUsTaxActivity,
+        Boolean taxReportable, 
+        Boolean forceUsTaxActivity,
         List<String> tags,
         String quantity,
         Amount discountAmount, 
@@ -223,11 +221,11 @@ public void setExternalId(String externalId) {
         this.externalId = externalId;
     }
 
-    public boolean isTaxReportable() {
+    public Boolean isTaxReportable() {
         return taxReportable;
     }
 
-    public void setTaxReportable(boolean taxReportable) {
+    public void setTaxReportable(Boolean taxReportable) {
         this.taxReportable = taxReportable;
     }
 
@@ -247,11 +245,11 @@ public void setCategory(InvoiceCategories category) {
         this.category = category;
     }
 
-    public boolean isForceUsTaxActivity() {
+    public Boolean isForceUsTaxActivity() {
         return forceUsTaxActivity;
     }
 
-    public void setForceUsTaxActivity(boolean forceUsTaxActivity) {
+    public void setForceUsTaxActivity(Boolean forceUsTaxActivity) {
         this.forceUsTaxActivity = forceUsTaxActivity;
     }
 

src/main/java/com/trolley/types/supporting/InvoicePaymentPart.java

@@ -1,15 +1,13 @@
 package com.trolley.types.supporting;
 
-import java.util.ArrayList;
-
 public class InvoicePaymentPart{
     private String invoiceId;
     private String invoiceLineId;
     private String paymentId;
     private Amount amount;
 
     //These fields are to hold values from parsed JSON, not for request body
-    private boolean coverFees;
+    private Boolean coverFees;
     private String memo;
     private String externalId;
     private String[] tags;
@@ -25,10 +23,10 @@ public InvoicePaymentPart(String invoiceId, String invoiceLineId, String payment
     }
 
     /**
-     * IMPORTANT: Use as request only while updating an InvoicePayment. For "Create Invoice Payment" request, use {@link InvoicePaymentRequest#InvoicePaymentRequest(String, boolean, String, String, String[], InvoicePaymentPart) InvoicePaymentRequest}.
+     * IMPORTANT: Use as request only while updating an InvoicePayment. For "Create Invoice Payment" request, use {@link InvoicePaymentRequest#InvoicePaymentRequest(String, Boolean, String, String, String[], InvoicePaymentPart) InvoicePaymentRequest}.
      */
     public InvoicePaymentPart(String invoiceId, String invoiceLineId, String paymentId, Amount amount,
-            boolean coverFees, String memo, String externalId, String[] tags) {
+            Boolean coverFees, String memo, String externalId, String[] tags) {
         this.invoiceId = invoiceId;
         this.invoiceLineId = invoiceLineId;
         this.paymentId = paymentId;
@@ -71,7 +69,7 @@ public void setAmount(Amount amount) {
         this.amount = amount;
     }
 
-    public boolean shouldCoverFees() {
+    public Boolean shouldCoverFees() {
         return coverFees;
     }
 

src/main/java/com/trolley/types/supporting/InvoicePaymentRequest.java

@@ -5,7 +5,7 @@
  */
 public class InvoicePaymentRequest{
     private String batchId;
-    private boolean coverFees;
+    private Boolean coverFees;
     private String memo;
     private String externalId;
     private String[] tags;
@@ -17,13 +17,13 @@ public InvoicePaymentRequest() {
     /**
      * Constructor to create a new request when you have more than one Invoices or InvoiceLines to create payment for.
      * @param batchId ID of the batch you'd want to add this payment to. If it's {@code null} or {@code ""}, a new payment will be created.
-     * @param coverFees Denotes whether you want to cover fees with this payment.
+     * @param coverFees Denotes whether you want to cover fees with this payment. If it's {@code null} the parameter will be ignored. 
      * @param memo A recipient viewable Memo that you'd want the created payment to have.
      * @param externalId A unique External ID that you'd want to assign to the created payment.
      * @param tags A {@code String[]} array where each element is a merchant-viewable tag that you want to assign to the created payment.
      * @param ids An {@code InvoicePaymentPart[]} array representing InvoicePaymentPart objects containing IDs and Amounts of Invoices and InvoiceLines you want to create payments for.
      */
-    public InvoicePaymentRequest(String batchId, boolean coverFees, String memo, String externalId,
+    public InvoicePaymentRequest(String batchId, Boolean coverFees, String memo, String externalId,
             String[] tags, InvoicePaymentPart[] ids) {
         this.batchId = batchId;
         this.coverFees = coverFees;
@@ -36,13 +36,13 @@ public InvoicePaymentRequest(String batchId, boolean coverFees, String memo, Str
     /**
      * Constructor to create a new request when you have only one Invoice/InvoiceLine to create a payment for.
      * @param batchId ID of the batch you'd want to add this payment to. If it's {@code null} or {@code ""}, a new payment will be created.
-     * @param coverFees Denotes whether you want to cover fees with this payment.
+     * @param coverFees Denotes whether you want to cover fees with this payment. If it's {@code null} the parameter will be ignored.
      * @param memo A recipient viewable Memo that you'd want the created payment to have.
      * @param externalId A unique External ID that you'd want to assign to the created payment.
      * @param tags A {@code String[]} array where each element is a merchant-viewable tag that you want to assign to the created payment.
      * @param paymentPart An {@code InvoicePaymentPart[]} array representing InvoicePaymentPart objects containing IDs and Amounts of Invoices and InvoiceLines you want to create payments for.
      */
-    public InvoicePaymentRequest(String batchId, boolean coverFees, String memo, String externalId,
+    public InvoicePaymentRequest(String batchId, Boolean coverFees, String memo, String externalId,
             String[] tags, InvoicePaymentPart paymentPart) {
         this.batchId = batchId;
         this.coverFees = coverFees;
@@ -60,11 +60,11 @@ public void setBatchId(String batchId) {
         this.batchId = batchId;
     }
 
-    public boolean shouldCoverFees() {
+    public Boolean shouldCoverFees() {
         return coverFees;
     }
 
-    public void setCoverFees(boolean coverFees) {
+    public void setCoverFees(Boolean coverFees) {
         this.coverFees = coverFees;
     }
 

src/test/java/com/trolley/integration/InvoiceTests.java

@@ -44,6 +44,8 @@ public void testInvoices() throws Exception {
 
         InvoiceLine invoiceLine = new InvoiceLine();
         invoiceLine.setUnitAmount(new Amount("100", "USD"));
+        invoiceLine.setForceUsTaxActivity(false);
+        invoiceLine.setTaxReportable(false);
 
         ArrayList<InvoiceLine> invoiceLines = new ArrayList<InvoiceLine>(){
             {
@@ -261,7 +263,7 @@ public void testInvoicePayments() throws Exception {
 
         InvoicePaymentRequest invoicePaymentRequest = new InvoicePaymentRequest(
             null,
-            false,
+            null,
             "Integration Test Payment",
             "ext-id-"+System.currentTimeMillis(),
             tags,
@@ -278,7 +280,7 @@ public void testInvoicePayments() throws Exception {
         paymentPart.setPaymentId(invoicePayment.getPaymentId());
         paymentPart.setAmount(new Amount("10","USD"));
         paymentPart.setExternalId("ext-id-"+System.currentTimeMillis());
-        paymentPart.setCoverFees(true);
+        paymentPart.setCoverFees(false);
 
         boolean paymentUpdateResult = client.invoicePayment.update(paymentPart);
         assertTrue(paymentUpdateResult);