Support v3 API and add v2 deprecations (#127)

Author: bmealhouse

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@withabound/node-sdk",
-  "version": "3.2.0",
+  "version": "3.3.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

@@ -27,20 +27,27 @@ export interface AboundConfig {
   apiVersion: ApiVersion;
 }
 
-export type ApiVersion = "v2";
+export type ApiVersion = "v2" | "v3";
 
 export class AboundClient {
   // resources
   accessTokens: AccessTokens;
   documents: Documents;
+  /** @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). */
   expenses: Expenses;
+  /** @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). */
   incomes: Incomes;
   mailings: Mailings;
+  /** @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). */
   mileages: Mileages;
   payers: Payers;
+  /** @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). */
   paymentMethods: PaymentMethods;
+  /** @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). */
   taxes: Taxes;
+  /** @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). */
   taxCategories: TaxCategories;
+  /** @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). */
   taxPayments: TaxPayments;
   users: Users;
 

src/AboundClient.ts

@@ -42,6 +42,7 @@ export interface Document {
 }
 
 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",
   TEN99INT = "1099int",
   TEN99K = "1099k",

src/resources/Documents.ts

@@ -38,34 +38,39 @@ interface ExpensePredictions {
 
 /**
  * See https://docs.withabound.com/reference/expenses
+ * @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).
  */
 export default class Expenses extends AboundUserScopedResource<
   ExpenseRequest,
   Expense
 > {
   path = "/expenses";
 
+  /** @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). */
   public async create(
     userId: string,
     expenses: ExpenseRequest[]
   ): Promise<AboundBulkResponse<Expense>> {
     return super.bulkCreateForUser(userId, { expenses });
   }
 
+  /** @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). */
   public async list(
     userId: string,
     parameters?: ExpenseParameters
   ): Promise<AboundBulkResponse<Expense>> {
     return super.listForUser(userId, parameters);
   }
 
+  /** @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). */
   public async retrieve(
     userId: string,
     expenseId: string
   ): Promise<AboundResponse<Expense>> {
     return super.retrieveForUser(userId, expenseId);
   }
 
+  /** @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). */
   public async update(
     userId: string,
     expenseId: string,
@@ -74,6 +79,7 @@ export default class Expenses extends AboundUserScopedResource<
     return super.updateForUser(userId, expenseId, { expense });
   }
 
+  /** @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). */
   public async delete(
     userId: string,
     expenseId: string

src/resources/Expenses.ts

@@ -48,34 +48,39 @@ export enum IncomeType {
 
 /**
  * See https://docs.withabound.com/reference/incomes
+ * @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).
  */
 export default class Incomes extends AboundUserScopedResource<
   IncomeRequest,
   Income
 > {
   path = "/incomes";
 
+  /** @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). */
   public async create(
     userId: string,
     incomes: IncomeRequest[]
   ): Promise<AboundBulkResponse<Income>> {
     return super.bulkCreateForUser(userId, { incomes });
   }
 
+  /** @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). */
   public async list(
     userId: string,
     parameters?: IncomeParameters
   ): Promise<AboundBulkResponse<Income>> {
     return super.listForUser(userId, parameters);
   }
 
+  /** @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). */
   public async retrieve(
     userId: string,
     incomeId: string
   ): Promise<AboundResponse<Income>> {
     return super.retrieveForUser(userId, incomeId);
   }
 
+  /** @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). */
   public async update(
     userId: string,
     incomeId: string,
@@ -84,6 +89,7 @@ export default class Incomes extends AboundUserScopedResource<
     return super.updateForUser(userId, incomeId, { income });
   }
 
+  /** @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). */
   public async delete(
     userId: string,
     incomeId: string

src/resources/Incomes.ts

@@ -23,34 +23,39 @@ export interface Mileage extends MileageRequest {
 
 /**
  * See https://docs.withabound.com/reference/mileage
+ * @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).
  */
 export default class Mileages extends AboundUserScopedResource<
   MileageRequest,
   Mileage
 > {
   path = "/mileage";
 
+  /** @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). */
   public async list(
     userId: string,
     parameters?: MileageParameters
   ): Promise<AboundBulkResponse<Mileage>> {
     return super.listForUser(userId, parameters);
   }
 
+  /** @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). */
   public async create(
     userId: string,
     mileages: MileageRequest[]
   ): Promise<AboundBulkResponse<Mileage>> {
     return super.bulkCreateForUser(userId, { mileages });
   }
 
+  /** @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). */
   public async retrieve(
     userId: string,
     mileageId: string
   ): Promise<AboundResponse<Mileage>> {
     return super.retrieveForUser(userId, mileageId);
   }
 
+  /** @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). */
   public async update(
     userId: string,
     mileageId: string,
@@ -59,6 +64,7 @@ export default class Mileages extends AboundUserScopedResource<
     return super.updateForUser(userId, mileageId, { mileage });
   }
 
+  /** @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). */
   public async delete(
     userId: string,
     mileageId: string

src/resources/Mileages.ts

@@ -37,27 +37,31 @@ export enum AccountClass {
 
 /**
  * See https://docs.withabound.com/reference/payment-methods
+ * @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).
  */
 export default class PaymentMethods extends AboundUserScopedResource<
   PaymentMethodRequest,
   PaymentMethod
 > {
   path = "/paymentMethods";
 
+  /** @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). */
   public async create(
     userId: string,
     paymentMethod: PaymentMethodRequest
   ): Promise<AboundResponse<PaymentMethod>> {
     return super.createForUser(userId, { paymentMethod });
   }
 
+  /** @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). */
   public async list(
     userId: string,
     parameters?: PaymentMethodParameters
   ): Promise<AboundBulkResponse<PaymentMethod>> {
     return super.listForUser(userId, parameters);
   }
 
+  /** @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). */
   public async retrieve(
     userId: string,
     paymentMethodId: string

src/resources/PaymentMethods.ts

@@ -3,10 +3,12 @@ import { AboundResponse } from "./base/AboundResponse";
 
 /**
  * See https://docs.withabound.com/reference/tax-categories
+ * @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).
  */
 export default class TaxCategories extends AboundBaseResource<never, string[]> {
   path = "/taxCategories";
 
+  /** @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). */
   public async retrieve(year: string): Promise<AboundResponse<string[]>> {
     return super.retrieveBaseResource(year);
   }

src/resources/TaxCategories.ts

@@ -46,27 +46,31 @@ export enum TaxPaymentDocumentType {
 
 /**
  * See https://docs.withabound.com/reference/tax-payments
+ * @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).
  */
 export default class TaxPayments extends AboundUserScopedResource<
   TaxPaymentRequest,
   TaxPayment
 > {
   path = "/taxPayments";
 
+  /** @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). */
   public async create(
     userId: string,
     taxPayment: TaxPaymentRequest
   ): Promise<AboundResponse<TaxPayment>> {
     return super.createForUser(userId, { taxPayment });
   }
 
+  /** @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). */
   public async list(
     userId: string,
     parameters?: TaxPaymentParameters
   ): Promise<AboundBulkResponse<TaxPayment>> {
     return super.listForUser(userId, parameters);
   }
 
+  /** @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). */
   public async retrieve(userId: string, taxPaymentId: string) {
     return super.retrieveForUser(userId, taxPaymentId);
   }