Merge pull request #91 from starkbank/feature/split-and-split-receiver

Add Split and Split Receiver resources

Author: wendel-stark

CHANGELOG.md

@@ -14,6 +14,8 @@ Given a version number MAJOR.MINOR.PATCH, increment:
 
 ## [Unreleased]
 ### Added
+- Split resource
+- SplitReceiver resource
 - update function to Deposit resource
 
 ## [2.15.0] - 2023-09-18

README.md

@@ -1,3 +1,4 @@
+
 # Stark Bank Java SDK
 
 Welcome to the Stark Bank Java SDK! This tool is made for Java 
@@ -49,6 +50,8 @@ is as easy as sending a text message to your client!
     - [CorporateBalance](#get-your-corporatebalance): View your corporate balance
     - [CorporateTransactions](#query-corporatetransactions): View the transactions that have affected your corporate balance
     - [CorporateEnums](#corporate-enums): Query enums related to the corporate purchases, such as merchant categories, countries and card purchase methods
+    - [Split](#query-splits): Split received Invoice payments between different receivers
+    - [SplitReceiver](#create-splitreceivers): Receiver of an Invoice split
     - [Webhooks](#create-a-webhook-subscription): Configure your webhook endpoints and subscriptions
     - [WebhookEvents](#process-webhook-events): Manage webhook events
     - [WebhookEventAttempts](#query-failed-webhook-event-delivery-attempts-information): Query failed webhook event deliveries
@@ -2481,15 +2484,168 @@ for (CardMethod method : methods) {
 }
 ```
 
+## Split
+
+Split an Invoice between different receivers.
+
+## Query Splits
+
+You can get a list of created Splits given some filters.
+
+```java
+import com.starkbank.*;
+import java.util.Map;
+import java.util.HashMap;
+
+Map<String, Object> params = new HashMap<>();
+params.put("limit", 10);
+
+Generator<Split> splits = Split.query(params);
+
+for (Split split : splits) {
+    System.out.println(split);
+}
+```
+
+## Get a Split
+
+To get a single Split by its id, run:
+
+```java
+import com.starkbank.*;
+
+Split split = Split.get("5155165527080960");
+
+System.out.println(split);
+```
+
+## Query Split Logs
+
+You can query Split Logs to check additional information.
+
+```java
+import com.starkbank.*;
+import java.util.Map;
+import java.util.HashMap;
+
+Map<String, Object> params = new HashMap<>();
+params.put("limit", 10);
+
+Generator<Split.Log> logs = Split.Log.query(params);
+
+for (Split.Log log : logs) {
+    System.out.println(log);
+}
+```
+
+## Get a Split Log
+
+You can also get a Split Log by specifying its id.
+
+```java
+import com.starkbank.*;
+
+Split.Log log = Split.Log.get("5155165527080960");
+
+System.out.println(log);
+```
+
+## Create SplitReceivers
+
+You can create receivers to an Invoice Split by using the SplitReceiver resource.
+
+```java
+import com.starkbank.*;
+import java.util.Map;
+import java.util.List;
+import java.util.HashMap;
+import java.util.ArrayList;
+
+Map<String, Object> data = new HashMap<>();
+data.put("name", "Daenerys Targaryen Stormborn");
+data.put("taxId", "594.739.480-42");
+data.put("bankCode", "341");
+data.put("branchCode", "2201");
+data.put("accountNumber", "76543-8");
+data.put("accountType", "salary");
+
+SplitReceiver receiver = SplitReceiver.create(new SplitReceiver(data));
+
+System.out.println(receiver);
+```
+
+## Query SplitReceivers
+
+You can get a list of created SplitReceivers given some filters.
+
+```java
+import com.starkbank.*;
+import java.util.Map;
+import java.util.HashMap;
+
+Map<String, Object> params = new HashMap<>();
+params.put("limit", 10);
+
+Generator<SplitReceiver> receivers = SplitReceiver.query(params);
+
+for (SplitReceiver receiver : receivers) {
+    System.out.println(receiver);
+}
+```
+
+## Get a SplitReceiver
+
+To get a single SplitReceiver by its id, run:
+
+```java
+import com.starkbank.*;
+
+SplitReceiver receiver = SplitReceiver.get("5155165527080960");
+
+System.out.println(receiver);
+```
+
+## Query SplitReceiver Logs
+
+You can query SplitReceiver Logs to check additional information.
+
+```java
+import com.starkbank.*;
+import java.util.Map;
+import java.util.HashMap;
+
+Map<String, Object> params = new HashMap<>();
+params.put("limit", 10);
+
+Generator<SplitReceiver.Log> logs = SplitReceiver.Log.query(params);
+
+for (Split.Log log : logs) {
+    System.out.println(log);
+}
+```
+
+## Get a SplitReceiver Log
+
+You can also get a SplitReceiver Log by specifying its id.
+
+```java
+import com.starkbank.*;
+
+SplitReceiver.Log log = SplitReceiver.Log.get("5155165527080960");
+
+System.out.println(log);
+```
+
 ## Create a webhook subscription
 
 To create a webhook subscription and be notified whenever an event occurs, run:
 
 ```java
 import com.starkbank.*;
+import java.util.Map;
 import java.util.HashMap;
 
-HashMap<String, Object> data = new HashMap<>();
+Map<String, Object> data = new HashMap<>();
 data.put("url", "https://winterfell.westeros.gov/events-from-stark-bank");
 data.put("subscriptions", new String[]{"boleto", "boleto-payment", "transfer", "utility-payment", "tax-payment", "boleto-holmes", "brcode-payment", "deposit", "invoice"});
 Webhook webhook = Webhook.create(data);

src/main/java/com/starkbank/Balance.java

@@ -1,12 +1,12 @@
 package com.starkbank;
 
-import com.starkbank.utils.Generator;
-import com.starkbank.utils.Resource;
 import com.starkbank.utils.Rest;
+import com.starkbank.utils.Resource;
+import com.starkbank.utils.Generator;
 
-import java.util.ArrayList;
-import java.util.HashMap;
 import java.util.List;
+import java.util.HashMap;
+import java.util.ArrayList;
 
 
 public final class Balance extends Resource {

src/main/java/com/starkbank/DictKey.java

@@ -1,14 +1,14 @@
 package com.starkbank;
 
-import com.starkbank.utils.Generator;
-import com.starkbank.utils.Resource;
 import com.starkbank.utils.Rest;
+import com.starkbank.utils.Resource;
+import com.starkbank.utils.Generator;
 import com.starkbank.utils.SubResource;
 
-import java.util.ArrayList;
-import java.util.HashMap;
-import java.util.List;
 import java.util.Map;
+import java.util.List;
+import java.util.HashMap;
+import java.util.ArrayList;
 
 public class DictKey extends Resource {
 

src/main/java/com/starkbank/Invoice.java

@@ -30,6 +30,7 @@ public final class Invoice extends Resource {
      * interest [number, default 0.0]: Invoice monthly interest for overdue payment in %. ex: 5.2
      * discounts [list of maps, default null]: list of maps with "percentage":number and "due":string pairs
      * rules [list of Invoice.Rules, default []]: list of Invoice.Rule objects for modifying invoice behavior. ex: [Invoice.Rule(key="allowedTaxIds", value=[ "012.345.678-90", "45.059.493/0001-73" ])]
+     * splits [list of Splits, default []]: list of Splits objects to indicate payment receivers. ex: [Split(amount=141, receiverId="5706627130851328")]
      * tags [list of strings, default null]: list of strings for tagging
      * descriptions [list of maps, default null]: list of maps with "key":string and (optional) "value":string pairs
      * pdf [string]: public Invoice PDF URL. ex: "https://invoice.starkbank.com/pdf/d454fa4e524441c1b0c1a729457ed9d8"
@@ -59,6 +60,7 @@ public final class Invoice extends Resource {
     public List<Invoice.Description> descriptions;
     public List<Invoice.Discount> discounts;
     public List<Invoice.Rule> rules;
+    public List<Split> splits;
     public String[] tags;
     public String pdf;
     public String link;
@@ -92,6 +94,7 @@ public final class Invoice extends Resource {
      * @param interest [number, default 0.0]: Invoice monthly interest for overdue payment in %. ex: 5.2
      * @param discounts [list of maps, default null]: list of maps with "percentage":number and "due":string or string pairs
      * @param rules [list of Invoice.Rules, default []]: list of Invoice.Rule objects for modifying invoice behavior. ex: [Invoice.Rule(key="allowedTaxIds", value=[ "012.345.678-90", "45.059.493/0001-73" ])]
+     * @param splits [list of Splits, default []]: list of Splits objects to indicate payment receivers. ex: [Split(amount=141, receiverId="5706627130851328")]
      * @param tags [list of strings, default null]: list of strings for tagging
      * @param descriptions [list of maps, default null]: list of maps with "key":string and (optional) "value":string pairs
      * @param pdf [string]: public Invoice PDF URL. ex: "https://invoice.starkbank.com/pdf/d454fa4e524441c1b0c1a729457ed9d8"
@@ -109,10 +112,10 @@ public final class Invoice extends Resource {
      * @param updated [string]: creation datetime for the Invoice. ex: "2020-03-10 10:30:00.000000+00:00"
      */
     public Invoice(Number amount, String due, String taxId, String name, Number expiration, Number fine,
-                   Number interest, List<Invoice.Description> descriptions, List<Invoice.Discount> discounts, List<Invoice.Rule> rules,
-                   String pdf, String link, String[] tags, Number nominalAmount, Number fineAmount, Number interestAmount,
-                   Number discountAmount, String id, String brcode, Integer fee, String[] transactionIds, String status,
-                   String created, String updated
+                   Number interest, List<Invoice.Description> descriptions, List<Invoice.Discount> discounts,
+                   List<Invoice.Rule> rules, List<Split> splits, String pdf, String link, String[] tags,
+                   Number nominalAmount, Number fineAmount, Number interestAmount, Number discountAmount, String id,
+                   String brcode, Integer fee, String[] transactionIds, String status,  String created, String updated
     ) {
         super(id);
         this.amount = amount;
@@ -124,6 +127,7 @@ public Invoice(Number amount, String due, String taxId, String name, Number expi
         this.interest = interest;
         this.discounts = discounts;
         this.rules = rules;
+        this.splits = splits;
         this.tags = tags;
         this.descriptions = descriptions;
         this.pdf = pdf;
@@ -162,6 +166,7 @@ public Invoice(Number amount, String due, String taxId, String name, Number expi
      * descriptions [list of maps, default null]: list of maps with "key":string and (optional) "value":string pairs
      * discounts [list of maps, default null]: list of maps with "percentage":number and "due":string pairs
      * rules [list of Invoice.Rules, default []]: list of Invoice.Rule objects for modifying invoice behavior. ex: [Invoice.Rule(key="allowedTaxIds", value=[ "012.345.678-90", "45.059.493/0001-73" ])]
+     * splits [list of Splits, default []]: list of Splits objects to indicate payment receivers. ex: [Split(amount=141, receiverId="5706627130851328")]
      * tags [list of strings, default null]: list of strings for tagging
      * <p>
      * Attributes (return-only):
@@ -193,6 +198,7 @@ public Invoice(Map<String, Object> data) throws Exception {
         this.discounts = parseDiscounts((List<Object>) dataCopy.remove("discounts"));
         this.tags = (String[]) dataCopy.remove("tags");
         this.rules = parseRules((List<Object>) dataCopy.remove("rules"));
+        this.splits = parseSplit((List<Object>) dataCopy.remove("splits"));
         this.descriptions = parseDescriptions((List<Object>) dataCopy.remove("descriptions"));
         this.pdf = null;
         this.link = null;
@@ -1066,6 +1072,25 @@ private List<Invoice.Rule> parseRules(List<Object> rules) throws Exception {
         return parsed;
     }
 
+    private List<Split> parseSplit(List<Object> splits) throws Exception {
+        if (splits == null)
+            return null;
+
+        List<Split> parsed = new ArrayList<>();
+        if (splits.size() == 0 || splits.get(0) instanceof Split) {
+            for (Object split : splits) {
+                parsed.add((Split) split);
+            }
+            return parsed;
+        }
+
+        for (Object split : splits) {
+            Split splitObject = new Split((Map<String, Object>) split);
+            parsed.add(splitObject);
+        }
+        return parsed;
+    }
+
     /**
      * Invoice.Rule object
      * <p>