Update w9 response type (#140)

Author: bmealhouse

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@withabound/node-sdk",
-  "version": "3.4.0",
+  "version": "3.5.0",
   "description": "The Abound Node library provides convenient access to the Abound API from applications written in server-side JavaScript.",
   "author": "Abound <[email protected]>",
   "license": "MIT",

package.json

@@ -15,7 +15,7 @@ import {
   Ten99NECFormFields,
 } from "./document-types/1099NEC";
 import { AccountStatementDocumentRequest } from "./document-types/AccountStatement";
-import { W9DocumentRequest } from "./document-types/W9";
+import { W9DocumentRequest, W9FormFields } from "./document-types/W9";
 
 export {
   StateTaxInfo,
@@ -50,13 +50,16 @@ export interface Document {
   readonly createdTimestamp: number;
 }
 
-interface BaseTen99Document {
+interface BaseDocument {
   readonly year: string;
   readonly documentId: string;
   readonly documentURL: string;
   readonly documentName: string;
   readonly creationDate?: string;
   readonly createdTimestamp: number;
+}
+
+interface BaseTen99Document extends BaseDocument {
   readonly status?: string;
   readonly message?: string;
 }
@@ -82,6 +85,13 @@ export interface Ten99NECDocument extends BaseTen99Document {
     Readonly<Ten99NECFormFields>;
 }
 
+export interface W9Document extends BaseDocument {
+  readonly type: DocumentType.W9;
+  readonly formData: Readonly<W9Payer> &
+    Readonly<W9User> &
+    Readonly<W9FormFields>;
+}
+
 interface User {
   readonly user: Readonly<{
     name: string;
@@ -107,6 +117,30 @@ interface Payer {
   }>;
 }
 
+interface W9User {
+  readonly user: Readonly<{
+    name: string;
+    businessName?: string;
+    address: string;
+    address2?: string;
+    city: string;
+    state: string;
+    zipcode: string;
+    country?: string;
+  }>;
+}
+
+interface W9Payer {
+  readonly payer?: Readonly<{
+    name: string;
+    address: string;
+    address2?: string;
+    city: string;
+    state: string;
+    zipcode: string;
+  }>;
+}
+
 export enum DocumentType {
   /** @deprecated Our v2 API is now deprecated and will become completely unavailable on Tuesday May 16, 2023. Please consider upgrading to our v3 API as a way to prepare for the sunsetting of v2. For more detail on these product changes, what endpoints are changing in v3 and how that may affect your company, please view our [API Changelog](https://docs.withabound.com/changelog). */
   ACCOUNT_STATEMENT = "accountStatement",
@@ -126,7 +160,8 @@ export type DocumentResponse =
   | Document
   | Ten99INTDocument
   | Ten99KDocument
-  | Ten99NECDocument;
+  | Ten99NECDocument
+  | W9Document;
 
 /**
  * See https://docs.withabound.com/reference/documents

src/resources/Documents.ts

@@ -1,10 +1,13 @@
 import { BaseDocumentRequest, DocumentType } from "../Documents";
 
 // request body
-export interface W9DocumentRequest extends BaseDocumentRequest {
+export interface W9DocumentRequest extends BaseDocumentRequest, W9FormFields {
   type: DocumentType.W9;
   payerId?: string; // The payer filing or issuing this form.
   year: number;
+}
+
+export interface W9FormFields {
   taxClassification: W9TaxClassification;
   exemptPayeeCode?: ExemptPayeeCode;
   exemptFatcaCode?: ExemptFatcaCode;

src/resources/document-types/W9.ts

@@ -1,2 +1,2 @@
 // Generated by genversion.
-export const version = "3.4.0";
+export const version = "3.5.0";

src/util/version.ts

@@ -258,11 +258,20 @@ describe("Abound Documents", () => {
           w9ToCreate,
         ]);
 
-        expect(response.data.at(0)).toMatchSnapshot({
+        const document = response.data.at(0);
+        expect(document).toMatchSnapshot({
           createdTimestamp: expect.any(Number),
           documentURL: expect.stringContaining(
             "https://tax-documents-sandbox.s3.us-west-2.amazonaws.com"
           ),
+          ...(document &&
+            "formData" in document &&
+            "certificationTimestamp" in document.formData &&
+            document?.formData?.certificationTimestamp && {
+              formData: {
+                certificationTimestamp: expect.any(Number),
+              },
+            }),
         });
       });
     });
@@ -277,6 +286,13 @@ describe("Abound Documents", () => {
             documentURL: expect.stringContaining(
               "https://tax-documents-sandbox.s3.us-west-2.amazonaws.com"
             ),
+            ...("formData" in document &&
+              "certificationTimestamp" in document.formData &&
+              document?.formData?.certificationTimestamp && {
+                formData: {
+                  certificationTimestamp: expect.any(Number),
+                },
+              }),
           });
         }
       });
@@ -292,6 +308,13 @@ describe("Abound Documents", () => {
             documentURL: expect.stringContaining(
               "https://tax-documents-sandbox.s3.us-west-2.amazonaws.com"
             ),
+            ...("formData" in document &&
+              "certificationTimestamp" in document.formData &&
+              document?.formData?.certificationTimestamp && {
+                formData: {
+                  certificationTimestamp: expect.any(Number),
+                },
+              }),
           });
         }
       });

tests/resources/Documents.spec.ts

@@ -236,6 +236,24 @@ Object {
   "documentId": "documentId_testefbd5d3d9ee9526ef9ff89a7c6b879174170",
   "documentName": "2021 Form W-9",
   "documentURL": StringContaining "https://tax-documents-sandbox.s3.us-west-2.amazonaws.com",
+  "formData": Object {
+    "accountNumbers": Array [
+      "430912910",
+    ],
+    "certificationTimestamp": Any<Number>,
+    "exemptFatcaCode": "A",
+    "exemptPayeeCode": "1",
+    "taxClassification": "soleProprietor",
+    "user": Object {
+      "address": "256 Byron Street",
+      "address2": "Suite 32",
+      "city": "Palo Alto",
+      "country": "US",
+      "name": "Ada Lovelace",
+      "state": "CA",
+      "zipcode": "94306",
+    },
+  },
   "type": "w9",
   "year": "2021",
 }
@@ -291,6 +309,19 @@ Object {
   "documentId": "documentId_testefbd5d3d9ee9526ef9ff89a7c6b879174170",
   "documentName": "2021 Form W-9",
   "documentURL": StringContaining "https://tax-documents-sandbox.s3.us-west-2.amazonaws.com",
+  "formData": Object {
+    "certificationTimestamp": Any<Number>,
+    "taxClassification": "individual",
+    "user": Object {
+      "address": "256 Byron Street",
+      "address2": "Suite 32",
+      "city": "Palo Alto",
+      "country": "US",
+      "name": "Ada Lovelace",
+      "state": "CA",
+      "zipcode": "94306",
+    },
+  },
   "type": "w9",
   "year": "2021",
 }
@@ -313,6 +344,19 @@ Object {
   "documentId": "documentId_testefbd5d3d9ee9526ef9ff89a7c6b879174170",
   "documentName": "2023 Form W-9",
   "documentURL": StringContaining "https://tax-documents-sandbox.s3.us-west-2.amazonaws.com",
+  "formData": Object {
+    "certificationTimestamp": Any<Number>,
+    "taxClassification": "individual",
+    "user": Object {
+      "address": "256 Byron Street",
+      "address2": "Suite 32",
+      "city": "Palo Alto",
+      "country": "US",
+      "name": "Ada Lovelace",
+      "state": "CA",
+      "zipcode": "94306",
+    },
+  },
   "type": "w9",
   "year": "2023",
 }