list endpoints for products + tests

package.json

@@ -1,6 +1,6 @@
 {
   "name": "method-node",
-  "version": "1.1.3",
+  "version": "1.1.4",
   "description": "Node.js library for the Method API",
   "main": "dist/index.ts",
   "module": "dist/index.mjs",

src/resources/Account/Balances.ts

@@ -1,4 +1,4 @@
-import Resource from '../../resource';
+import Resource, { IResourceListOpts } from '../../resource';
 import Configuration, { IResponse } from '../../configuration';
 import type { IAccountBalance } from './types';
 
@@ -18,16 +18,15 @@ export default class AccountBalances extends Resource {
     return super._getWithId<IResponse<IAccountBalance>>(bal_id);
   }
 
-  // TODO: Add back in when we have a list endpoint
-  // /**
-  //  * Retrieves a list of Balance objects for an account.
-  //  *
-  //  * @returns Returns a list of Balances.
-  //  */
+  /**
+   * Retrieves a list of Balance objects for an account.
+   *
+   * @returns Returns a list of Balances.
+   */
 
-  // async list(opts?: IResourceListOpts) {
-  //   return super._list<IAccountBalance>(opts);
-  // }
+  async list(opts?: IResourceListOpts) {
+    return super._list<IResponse<IAccountBalance>>(opts);
+  }
 
   /**
    * Creates a new Balance request to retrieve the Account’s balance from the financial institution.

src/resources/Account/CardBrands.ts

@@ -1,4 +1,4 @@
-import Resource from '../../resource';
+import Resource, { IResourceListOpts } from '../../resource';
 import Configuration, { IResponse } from '../../configuration';
 import type { IAccountCardBrand } from './types';
 
@@ -18,6 +18,16 @@ export default class AccountCardBrand extends Resource {
     return super._getWithId<IResponse<IAccountCardBrand>>(cbrd_id);
   }
 
+  /**
+   * Retrieves a list of CardBrand objects for an account.
+   *
+   * @returns Returns a list of CardBrand objects.
+   */
+
+  async list(opts?: IResourceListOpts) {
+    return super._list<IResponse<IAccountCardBrand>>(opts);
+  }
+
   /**
    * Creates a new CardBrand request to retrieve the Account’s card brand.
    *

src/resources/Account/Payoffs.ts

@@ -1,4 +1,4 @@
-import Resource from '../../resource';
+import Resource, { IResourceListOpts } from '../../resource';
 import Configuration, { IResponse } from '../../configuration';
 import type { IAccountPayoff } from './types';
 
@@ -18,16 +18,15 @@ export default class AccountPayoffs extends Resource {
     return super._getWithId<IResponse<IAccountPayoff>>(pyf_id);
   }
 
-  // TODO: Add back in when we have a list endpoint
-  // /**
-  //  * Retrieves a list of Payoff requests for a specific account.
-  //  *
-  //  * @returns Returns a list of Payoffs.
-  //  */
+  /**
+   * Retrieves a list of Payoff requests for a specific account.
+   *
+   * @returns Returns a list of Payoffs.
+   */
 
-  // async list(opts?: IResourceListOpts) {
-  //   return super._list<IAccountPayoff>(opts);
-  // }
+  async list(opts?: IResourceListOpts) {
+    return super._list<IResponse<IAccountPayoff>>(opts);
+  }
 
   /**
    * Creates a new Payoff request to retrieve a payoff quote from the Account’s financial institution / lender.

src/resources/Account/Sensitive.ts

@@ -1,4 +1,4 @@
-import Resource from '../../resource';
+import Resource, { IResourceListOpts } from '../../resource';
 import Configuration, { IResponse } from '../../configuration';
 import type { IAccountSensitive, IAccountSensitiveCreateOpts } from './types';
 
@@ -18,6 +18,16 @@ export default class AccountSensitive extends Resource {
     return super._getWithId<IResponse<IAccountSensitive>>(astv_id);
   }
 
+  /**
+   * Retrieves a list of Sensitive objects for an account.
+   *
+   * @returns Returns a list of Sensitive objects.
+   */
+
+  async list(opts?: IResourceListOpts) {
+    return super._list<IResponse<IAccountSensitive>>(opts);
+  }
+
   /**
    * Creates a new Sensitive request to retrieve sensitive Account information.
    *

src/resources/Account/VerificationSessions.ts

@@ -1,4 +1,4 @@
-import Resource from '../../resource';
+import Resource, { IResourceListOpts } from '../../resource';
 import Configuration, { IResponse } from '../../configuration';
 import type {
   IAccountVerificationSession,
@@ -22,6 +22,16 @@ export default class AccountVerificationSession extends Resource {
     return super._getWithId<IResponse<IAccountVerificationSession>>(avf_id);
   }
 
+  /**
+   * Retrieves a list of AccountVerificationSession objects for an account.
+   *
+   * @returns Returns a list of AccountVerificationSession objects.
+   */
+
+  async list(opts?: IResourceListOpts) {
+    return super._list<IResponse<IAccountVerificationSession>>(opts);
+  }
+
   /**
    * Creates an AccountVerificationSession of the provided type.
    *

src/resources/Entity/Attributes.ts

@@ -1,4 +1,4 @@
-import Resource from '../../resource';
+import Resource, { IResourceListOpts } from '../../resource';
 import Configuration, { IResponse } from '../../configuration';
 import type { IEntityAttributes } from './types';
 
@@ -18,6 +18,16 @@ export default class EntityAttributes extends Resource {
     return super._getWithId<IResponse<IEntityAttributes>>(attr_id);
   }
 
+  /**
+   * Retrieves a list of Attributes objects for an entity.
+   *
+   * @returns Returns a list of Attributes objects.
+   */
+
+  async list(opts?: IResourceListOpts) {
+    return super._list<IResponse<IEntityAttributes>>(opts);
+  }
+
   /**
    * Creates a new Attributes request to retrieve the Entity’s attributes.
    *

src/resources/Entity/Connect.ts

@@ -1,4 +1,4 @@
-import Resource from '../../resource';
+import Resource, { IResourceListOpts } from '../../resource';
 import Configuration, { IResponse } from '../../configuration';
 import type { IEntityConnect } from './types';
 
@@ -18,6 +18,16 @@ export default class EntityConnect extends Resource {
     return super._getWithId<IResponse<IEntityConnect>>(cxn_id);
   }
 
+  /**
+   * Retrieves a list of Connect objects for an entity.
+   *
+   * @returns Returns a list of Connect objects.
+   */
+
+  async list(opts?: IResourceListOpts) {
+    return super._list<IResponse<IEntityConnect>>(opts);
+  }
+
   /**
    * Creates a new Connect request to connect all liability accounts for the Entity.
    *

src/resources/Entity/CreditScores.ts

@@ -1,4 +1,4 @@
-import Resource from '../../resource';
+import Resource, { IResourceListOpts } from '../../resource';
 import Configuration, { IResponse } from '../../configuration';
 import type { IEntityCreditScores } from './types';
 
@@ -18,6 +18,16 @@ export default class EntityCreditScores extends Resource {
     return super._getWithId<IResponse<IEntityCreditScores>>(crs_id);
   }
 
+  /**
+   * Retrieves a list of CreditScore objects for an entity.
+   *
+   * @returns Returns a list of CreditScore objects.
+   */
+
+  async list(opts?: IResourceListOpts) {
+    return super._list<IResponse<IEntityCreditScores>>(opts);
+  }
+
   /**
    * Creates a new Credit Score request to retrieve the Entity’s credit score.
    *

src/resources/Entity/Identities.ts

@@ -1,4 +1,4 @@
-import Resource from '../../resource';
+import Resource, { IResourceListOpts } from '../../resource';
 import Configuration, { IResponse } from '../../configuration';
 import type { IEntityIdentity } from './types';
 
@@ -18,6 +18,16 @@ export default class EntityIdentities extends Resource {
     return super._getWithId<IResponse<IEntityIdentity>>(idn_id);
   }
 
+  /**
+   * Retrieves a list of Identity objects for an entity.
+   *
+   * @returns Returns a list of Identity objects.
+   */
+
+  async list(opts?: IResourceListOpts) {
+    return super._list<IResponse<IEntityIdentity>>(opts);
+  }
+
   /**
    * Creates a new Identity request to retrieve the identity of an Entity, based off the PII that has been passed in to Method so far.
    *

src/resources/Entity/VerificationSessions.ts

@@ -1,4 +1,4 @@
-import Resource from '../../resource';
+import Resource, { IResourceListOpts } from '../../resource';
 import Configuration, { IResponse } from '../../configuration';
 import type {
   IEntityVerificationSession,
@@ -22,6 +22,16 @@ export default class EntityVerificationSession extends Resource {
     return super._getWithId<IResponse<IEntityVerificationSession>>(evf_id);
   }
 
+  /**
+   * Retrieves a list of VerificationSession objects for an entity.
+   *
+   * @returns Returns a list of VerificationSession objects.
+   */
+
+  async list(opts?: IResourceListOpts) {
+    return super._list<IResponse<IEntityVerificationSession>>(opts);
+  }
+
   /**
    * Create a verification session.
    *

src/resources/Webhook/index.ts

@@ -72,6 +72,8 @@ export interface IWebhook {
   created_at: string;
   updated_at: string;
   expand_event: boolean;
+  error: object | null;
+  status: string | null;
 };
 
 export interface IWebhookCreateOpts {