User updates (#78)

* Update user types and tests

* Fix user tests

* Fix tests after rebase

* Cleanup PR diffs

Author: bmealhouse

package-lock.json

@@ -43,6 +43,7 @@
     "lint-staged": "11.1.2",
     "prettier": "2.4.1",
     "ts-jest": "27.0.5",
+    "type-fest": "2.14.0",
     "typescript": "4.4.3",
     "xo": "0.39.x"
   },

package.json

@@ -1,12 +1,15 @@
+import { Except } from "type-fest";
 import { AboundBaseResource } from "./base/AboundBaseResource";
-import { Pagination } from "./base/AboundResource";
+import { Notes, Pagination } from "./base/AboundResource";
 import { AboundBulkResponse, AboundResponse } from "./base/AboundResponse";
 
 // request body
 export interface UserRequest {
   email?: string;
   foreignId?: string;
+  notes?: Notes;
   profile?: UserProfile;
+  business?: UserBusiness;
 }
 
 export interface UserProfile {
@@ -21,7 +24,32 @@ export interface UserProfile {
   phoneNumber?: string; // no country code, numerical digits only
   dateOfBirth?: string; // YYYY-MM-DD
   socialSecurityNumber?: string; // no hyphens, numerical digits only
-  ipAddress?: string;
+}
+
+export interface UserBusiness {
+  ein: string; // no hyphens, numerical digits only
+  name: string;
+  taxClassification?: TaxClassification;
+  address?: string;
+  address2?: string;
+  city?: string;
+  state?: string;
+  country?: string; // The user's country of residence. Adhering to the ISO 3166-2 format.
+  zipcode?: string;
+}
+
+export enum TaxClassification {
+  C_CORPORATION = "cCorporation",
+  ESTATE = "estate",
+  INDIVIDUAL = "individual",
+  LLC_PARTNERSHIP = "llcPartnership",
+  LLC_C_CORPORATION = "llcCCorporation",
+  LLC_S_CORPORATION = "llcSCorporation",
+  PARTNERSHIP = "partnership",
+  S_CORPORATION = "sCorporation",
+  SINGLE_MEMBER_LLC = "singleMemberLlc",
+  SOLE_PROPRIETOR = "soleProprietor",
+  TRUST = "trust",
 }
 
 // query params
@@ -32,6 +60,30 @@ export interface UserParameters extends Pagination {
 // response body
 export interface User extends UserRequest {
   userId: Readonly<string>;
+  einVerification: TinVerification;
+  ssnVerification: TinVerification;
+}
+
+// list response body
+export type BaseUser = Except<
+  User,
+  "business" | "einVerification" | "profile" | "ssnVerification"
+>;
+
+export interface TinVerification {
+  status: TinVerificationStatus;
+  message?: string;
+  lastVerifiedTimestamp?: number;
+  unlockTimestamp?: number;
+}
+
+export enum TinVerificationStatus {
+  ERROR = "error",
+  LOCKED_OUT = "lockedOut",
+  MISMATCH = "mismatch",
+  PENDING = "pending",
+  UNVERIFIED = "unverified",
+  VERIFIED = "verified",
 }
 
 // The raw `User` object returned from the APIs returns one deprecated field, which the SDK will remove.
@@ -55,8 +107,20 @@ export default class Users extends AboundBaseResource<
 
   public async list(
     parameters?: UserParameters
-  ): Promise<AboundBulkResponse<User>> {
-    return super.listBaseResource(parameters);
+  ): Promise<AboundBulkResponse<BaseUser>> {
+    const response = await super.listBaseResource(parameters);
+    return {
+      ...response,
+      data: response.data.map<BaseUser>(
+        ({
+          business,
+          einVerification,
+          profile,
+          ssnVerification,
+          ...baseUser
+        }) => baseUser
+      ),
+    };
   }
 
   public async create(user: UserRequest): Promise<AboundResponse<User>> {

src/resources/Users.ts

@@ -80,21 +80,23 @@ describe("Abound Tax Payments", () => {
       const taxPayments: AboundBulkResponse<TaxPayment> =
         await abound.taxPayments.list(TEST_USER_ID, { foreignId: "29SMN2KD9" });
 
-      expect(taxPayments.data).toMatchInlineSnapshot(`
-Array [
-  Object {
-    "amount": 154.66,
-    "createdDate": "2022-06-22",
-    "entity": "IRS",
-    "notes": Object {},
-    "paymentMethodId": "paymentMethodId_test32920837fa800382b7ee5676f281fbfc18cb",
-    "period": "Q2",
-    "status": "created",
-    "taxPaymentId": "taxPaymentId_test614d255d3048f6f7b3b5bb219b18f0f065d3",
-    "year": "2020",
-  },
-]
-`);
+      expect(taxPayments.data[0]).toMatchInlineSnapshot(
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+        { createdDate: expect.any(String) },
+        `
+        Object {
+          "amount": 154.66,
+          "createdDate": Any<String>,
+          "entity": "IRS",
+          "notes": Object {},
+          "paymentMethodId": "paymentMethodId_test32920837fa800382b7ee5676f281fbfc18cb",
+          "period": "Q2",
+          "status": "created",
+          "taxPaymentId": "taxPaymentId_test614d255d3048f6f7b3b5bb219b18f0f065d3",
+          "year": "2020",
+        }
+      `
+      );
     });
   });