Update CreateCheckPaymentRequest (#404)

* update counterparty type
added missing fields

* tiny test

* description is mandatory

Author: axshani

tests/checkPayments.spec.ts

@@ -1,4 +1,4 @@
-import { CheckPayment, Unit } from "../unit"
+import { CheckPayment, CreateCheckPaymentRequest, Unit } from "../unit"
 
 import dotenv from "dotenv"
 dotenv.config()
@@ -103,4 +103,42 @@ describe("Test Check Payments", () => {
 
         expect(payment.type).toBe("checkPayment")
     })
+
+    test("Test CreateCheckPayment Resource", () => {
+        const request: CreateCheckPaymentRequest = {
+          "type": "checkPayment",
+          "attributes": {
+            "amount": 100,
+            "sendDate": "2023-09-10",
+            "counterparty": {
+              "name": "John Doe",
+              "address": {
+                "street": "5230 Newell Rd",
+                "city": "Palo Alto",
+                "state": "CA",
+                "postalCode": "94303",
+                "country": "US"
+              }
+            },
+            "description": "test-request"
+          },
+          "relationships": {
+            "account": {
+              "data": {
+                "type": "depositAccount",
+                "id": "1043"
+                }
+              },
+              "customer": {
+                "data": {
+                  "type": "individualCustomer",
+                  "id": "2"
+              }
+            }
+          }
+        }
+
+        expect(request.type).toBe("checkPayment")
+        expect(request.attributes.amount).toBe(100)
+    })
 })

types/checkPayment.ts

@@ -1,4 +1,4 @@
-import { Tags, RelationshipsArray, Relationship, BaseListParams, Sort, Counterparty, BaseCreateRequestAttributes, CheckPaymentCounterparty } from "./common"
+import { Tags, RelationshipsArray, Relationship, BaseListParams, Sort, BaseCreateRequestAttributes, CheckPaymentCounterparty } from "./common"
 import { BasePaymentRelationships } from "./payments"
 
 export type StopPaymentStatus = "Active" | "Disabled"
@@ -288,15 +288,25 @@ export interface CreateCheckPaymentRequest extends BaseCreateRequestAttributes {
         sendDate?: string
 
         /**
-         * The payee's details . address1 may contain max 50 characters. address2 must be null. country must be "US".
+         * The payee's details. street and street2 combined may contain up to 50 characters. country must be "US".
          */
-        counterparty: Counterparty
+        counterparty: CheckPaymentCounterparty
+        
+        /**
+         * An internal description (maximum of 255 characters). This will not be printed on the check.
+         */
+        description: string
     }
 
     relationships: {
         /**
          * The [Deposit Account](https://docs.unit.co/deposit-accounts/) originating the payment.
          */
         account: Relationship
+
+        /**
+         * Link to the customer the the check will be signed by.
+         */
+        customer: Relationship
     }
 }

types/common.ts

@@ -225,6 +225,7 @@ export interface CheckPaymentCounterparty {
      */
     counterpartyMoved?: boolean
 }
+
 export interface Coordinates {
     /**
      * The longitude value.