Ensure foreignId is updated across all resources (#77)

bmealhouse · web-flow · commit 0e2e168a20cb · 2022-06-23T06:49:27.000-05:00
* Ensure foreignId is updated across all resources

* Bump version
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@withabound/node-sdk",
-  "version": "1.3.1",
+  "version": "1.4.0",
   "description": "The Abound Node library provides convenient access to the Abound API from applications written in server-side JavaScript.",
   "author": "Abound <api@withabound.com>",
   "license": "MIT",
diff --git a/src/AboundClient.ts b/src/AboundClient.ts
@@ -1,5 +1,6 @@
 import { AxiosInstance } from "axios";
 import {
+  AccessTokens,
   Documents,
   Expenses,
   Incomes,
@@ -11,7 +12,6 @@ import {
   PaymentMethods,
   Users,
 } from "./resources";
-import AccessTokens from "./resources/AccessTokens";
 import { initAxios } from "./util/http";
 
 export enum Environment {
diff --git a/src/abound.ts b/src/abound.ts
@@ -2,6 +2,7 @@ export * from "./AboundClient";
 export { AboundClient as default } from "./AboundClient";
 
 // resources
+export * from "./resources/AccessTokens";
 export * from "./resources/Documents";
 export * from "./resources/Expenses";
 export * from "./resources/Incomes";
diff --git a/src/resources/Mileages.ts b/src/resources/Mileages.ts
@@ -1,4 +1,4 @@
-import { EmptyObject } from "./base/AboundResource";
+import { EmptyObject, Pagination } from "./base/AboundResource";
 import { AboundBulkResponse, AboundResponse } from "./base/AboundResponse";
 import { AboundUserScopedResource } from "./base/AboundUserScopedResource";
 
@@ -7,6 +7,13 @@ export interface MileageRequest {
   distance: number; // float
   date: string; // YYYY-MM-DD
   description?: string;
+  foreignId?: string;
+}
+
+// query params
+export interface MileageParameters extends Pagination {
+  foreignId?: string;
+  year?: string;
 }
 
 // response body
@@ -23,8 +30,11 @@ export default class Mileages extends AboundUserScopedResource<
 > {
   path = "/mileage";
 
-  public async list(userId: string): Promise<AboundBulkResponse<Mileage>> {
-    return super.listForUser(userId);
+  public async list(
+    userId: string,
+    parameters?: MileageParameters
+  ): Promise<AboundBulkResponse<Mileage>> {
+    return super.listForUser(userId, parameters);
   }
 
   public async create(
diff --git a/src/resources/PaymentMethods.ts b/src/resources/PaymentMethods.ts
@@ -9,6 +9,12 @@ export interface PaymentMethodRequest {
   accountType: AccountType;
   accountClass: AccountClass;
   notes?: Record<string, unknown>;
+  foreignId?: string;
+}
+
+// query params
+export interface PaymentMethodParameters extends Pagination {
+  foreignId?: string;
 }
 
 // response body
@@ -47,7 +53,7 @@ export default class PaymentMethods extends AboundUserScopedResource<
 
   public async list(
     userId: string,
-    parameters?: Pagination
+    parameters?: PaymentMethodParameters
   ): Promise<AboundBulkResponse<PaymentMethod>> {
     return super.listForUser(userId, parameters);
   }
diff --git a/src/resources/TaxPayments.ts b/src/resources/TaxPayments.ts
@@ -1,4 +1,4 @@
-import { Notes } from "./base/AboundResource";
+import { Notes, Pagination } from "./base/AboundResource";
 import { AboundBulkResponse, AboundResponse } from "./base/AboundResponse";
 import { AboundUserScopedResource } from "./base/AboundUserScopedResource";
 
@@ -10,6 +10,7 @@ export interface TaxPaymentRequest {
   entity: TaxPaymentEntity;
   paymentMethodId: string;
   notes?: Notes;
+  foreignId?: string;
 }
 
 export enum TaxPeriod {
@@ -62,6 +63,11 @@ export enum TaxPaymentEntity {
   WV = "WV",
 }
 
+// query params
+export interface TaxPaymentParameters extends Pagination {
+  foreignId?: string;
+}
+
 // response body
 export interface TaxPayment extends TaxPaymentRequest {
   taxPaymentId: Readonly<string>;
@@ -97,8 +103,11 @@ export default class TaxPayments extends AboundUserScopedResource<
     return super.createForUser(userId, { taxPayment });
   }
 
-  public async list(userId: string): Promise<AboundBulkResponse<TaxPayment>> {
-    return super.listForUser(userId);
+  public async list(
+    userId: string,
+    parameters?: TaxPaymentParameters
+  ): Promise<AboundBulkResponse<TaxPayment>> {
+    return super.listForUser(userId, parameters);
   }
 
   public async retrieve(userId: string, taxPaymentId: string) {
diff --git a/src/resources/index.ts b/src/resources/index.ts
@@ -1,10 +1,11 @@
-export { default as Users } from "./Users";
-export { default as PaymentMethods } from "./PaymentMethods";
-export { default as TaxPayments } from "./TaxPayments";
+export { default as AccessTokens } from "./AccessTokens";
+export { default as Documents } from "./Documents";
+export { default as Expenses } from "./Expenses";
 export { default as Incomes } from "./Incomes";
 export { default as Mileages } from "./Mileages";
-export { default as Expenses } from "./Expenses";
-export { default as Documents } from "./Documents";
-export { default as Taxes } from "./Taxes";
-export { default as TaxCategories } from "./TaxCategories";
 export { default as Payers } from "./Payers";
+export { default as PaymentMethods } from "./PaymentMethods";
+export { default as TaxCategories } from "./TaxCategories";
+export { default as Taxes } from "./Taxes";
+export { default as TaxPayments } from "./TaxPayments";
+export { default as Users } from "./Users";
diff --git a/src/util/version.ts b/src/util/version.ts
@@ -1,2 +1,2 @@
 // Generated by genversion.
-export const version = "1.3.1";
+export const version = "1.4.0";
diff --git a/tests/resources/Documents.spec.ts b/tests/resources/Documents.spec.ts
@@ -380,7 +380,7 @@ describe("Abound Documents", () => {
     });
   });
 
-  // TODO restore this test after the API properly returns a 200 response
+  // FIXME: restore this test after the API properly returns a 200 response
   describe.skip("retrieve", () => {
     it("returns a promise that resolves to an object that includes a single Document on success", async () => {
       const document: AboundResponse<Document> =
diff --git a/tests/resources/Incomes.spec.ts b/tests/resources/Incomes.spec.ts
@@ -130,6 +130,16 @@ Array [
 `);
     });
 
+    // FIXME: restore this test after sample data is properly returned by foreignId
+    it.skip("returns a promise that resolves to a list of filtered Incomes when querying by foreignId", async () => {
+      const incomes: AboundBulkResponse<Income> = await abound.incomes.list(
+        TEST_USER_ID,
+        { foreignId: "29SMN2KD9" }
+      );
+
+      expect(incomes.data).toMatchInlineSnapshot();
+    });
+
     it("returns a promise that resolves to the user's incomes with filters applied when provided", async () => {
       const incomes: AboundBulkResponse<Income> = await abound.incomes.list(
         TEST_USER_ID,
diff --git a/tests/resources/Mileages.spec.ts b/tests/resources/Mileages.spec.ts
@@ -37,6 +37,24 @@ describe("Abound Mileages", () => {
         ]
       `);
     });
+
+    it("returns a promise that resolves to a list of filtered Mileages when querying by foreignId", async () => {
+      const mileages: AboundBulkResponse<Mileage> = await abound.mileages.list(
+        TEST_USER_ID,
+        { foreignId: "29SMN2KD9" }
+      );
+
+      expect(mileages.data).toMatchInlineSnapshot(`
+        Array [
+          Object {
+            "date": "2020-01-09",
+            "description": "On-site Client Visit",
+            "distance": 23.1,
+            "transactionId": "mileageId_test4af7070cfb04a12552a1950e2f0afa660fba",
+          },
+        ]
+      `);
+    });
   });
 
   describe("create", () => {
diff --git a/tests/resources/Payers.spec.ts b/tests/resources/Payers.spec.ts
@@ -74,6 +74,29 @@ describe("Abound Payers", () => {
         ]
       `);
     });
+
+    it("returns a promise that resolves to a list of filtered Payers when querying by foreignId", async () => {
+      const payers: AboundBulkResponse<Payer> = await abound.payers.list({
+        foreignId: "29SMN2KD9",
+      });
+
+      expect(payers.data).toMatchInlineSnapshot(`
+Array [
+  Object {
+    "address": "1401 N Shoreline Blvd",
+    "address2": "Suite 1",
+    "city": "Mountain View",
+    "country": "US",
+    "foreignId": "your_foreign_id",
+    "name": "Hooli",
+    "payerId": "payerId_test3629d683f7534f096ccd8d236e24887c9891",
+    "phoneNumber": "6501014096",
+    "state": "CA",
+    "zipcode": "94043",
+  },
+]
+`);
+    });
   });
 
   describe("retrieve", () => {
diff --git a/tests/resources/PaymentMethods.spec.ts b/tests/resources/PaymentMethods.spec.ts
@@ -64,6 +64,26 @@ describe("Abound Payment Methods", () => {
         ]
       `);
     });
+
+    it("returns a promise that resolves to a list of filtered payment methods when querying by foreignId", async () => {
+      const paymentMethods: AboundBulkResponse<PaymentMethod> =
+        await abound.paymentMethods.list(TEST_USER_ID, {
+          foreignId: "29SMN2KD9",
+        });
+
+      expect(paymentMethods.data).toMatchInlineSnapshot(`
+Array [
+  Object {
+    "accountClass": "checking",
+    "accountNumberLast4": "7890",
+    "accountType": "personal",
+    "displayName": "(7890) personal checking",
+    "paymentMethodId": "paymentMethodId_test32920837fa800382b7ee5676f281fbfc18cb",
+    "status": "unverified",
+  },
+]
+`);
+    });
   });
 
   describe("retrieve", () => {
diff --git a/tests/resources/TaxPayments.spec.ts b/tests/resources/TaxPayments.spec.ts
@@ -75,6 +75,27 @@ describe("Abound Tax Payments", () => {
         ]
       `);
     });
+
+    it("returns a promise that resolves to a list of filtered tax payments when querying by foreignId", async () => {
+      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",
+  },
+]
+`);
+    });
   });
 
   describe("retrieve", () => {
diff --git a/tests/resources/users.spec.ts b/tests/resources/users.spec.ts
@@ -109,6 +109,38 @@ Array [
     "userId": "userId_test24b05d761ff58b5931bd07778c67b4e818e4",
   },
 ]
+`);
+    });
+
+    it("returns a promise that resolves to a list of filtered Users when querying by foreignId", async () => {
+      const users: AboundBulkResponse<User> = await abound.users.list({
+        foreignId: "29SMN2KD9",
+      });
+
+      expect(users.data).toMatchInlineSnapshot(`
+Array [
+  Object {
+    "business": Object {},
+    "email": "your_users_email@domain.com",
+    "foreignId": "your_foreign_id",
+    "profile": Object {
+      "address": "256 Byron Street",
+      "address2": "Suite 32",
+      "city": "Palo Alto",
+      "country": null,
+      "dateOfBirth": "1815-12-10",
+      "firstName": "Ada",
+      "ipAddress": null,
+      "lastName": "Lovelace",
+      "notes": null,
+      "phoneNumber": "6505551010",
+      "sourceIp": null,
+      "state": "CA",
+      "zipcode": "94306",
+    },
+    "userId": "userId_test24b05d761ff58b5931bd07778c67b4e818e4",
+  },
+]
 `);
     });
   });

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@withabound/node-sdk",`
`3`		`- "version": "1.3.1",`
	`3`	`+ "version": "1.4.0",`
`4`	`4`	`"description": "The Abound Node library provides convenient access to the Abound API from applications written in server-side JavaScript.",`
`5`	`5`	`"author": "Abound <[email protected]>",`
`6`	`6`	`"license": "MIT",`
Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,2 @@`
`1`	`1`	`// Generated by genversion.`
`2`		`-export const version = "1.3.1";`
	`2`	`+export const version = "1.4.0";`