regenerate types

lib/types/address.d.ts

@@ -1,7 +1,16 @@
-export var unused: {};
+export const unused: {};
 export type Address = {
+    /**
+     * - Street address
+     */
     addressLine1: string;
+    /**
+     * - Unit number
+     */
     addressLine2: string;
+    /**
+     * - 25 characters or less
+     */
     city: string;
     /**
      * - 2 characters

lib/types/avatars.d.ts

@@ -10,7 +10,8 @@ export class Avatars {
      */
     private moov;
     /**
-     * Gets a binary represention of an avatar.
+     * Gets a binary representation of an avatar.
+     * The `PROFILE_ENRICHMENT_READ` scope enum is required when making a request from the browser.
      *
      * @param {string} uniqueId - Any unique ID associated with an account such as AccountID, RepresentativeID, Routing Number, or User ID
      * @returns {Promise<Blob>} - Binary representation of the avatar.

lib/types/bankAccounts.d.ts

@@ -8,6 +8,7 @@ export class BankAccounts {
     moov: any;
     /**
      * Link a bank account to a Moov account
+     * The `BANK_ACCOUNTS_WRITE` scope enum is required when making a request from the browser.
      *
      * @param {string} accountID - Account on which to add the bank account
      * @param {BankAccountAdd} [bankAccount] - Optional bank account details
@@ -20,7 +21,7 @@ export class BankAccounts {
     link(accountID: string, bankAccount?: BankAccountAdd, plaidToken?: string, mxAuthorizationCode?: string): Promise<BankAccount>;
     /**
      * Retrieve bank account details (i.e. routing number or account type) associated with a specific Moov account.
-     *
+     * The `BANK_ACCOUNTS_READ` scope enum is required when making a request from the browser.
      * @param {string} accountID - Account on which to request bank account
      * @param {string} bankAccountID - ID of the bank account to retrieve
      * @returns {Promise<BankAccount>}
@@ -30,6 +31,7 @@ export class BankAccounts {
     get(accountID: string, bankAccountID: string): Promise<BankAccount>;
     /**
      * List all the bank accounts associated with a particular Moov account.
+     * The `BANK_ACCOUNTS_READ` scope enum is required when making a request from the browser.
      *
      * @param {string} accountID - Account on which to request bank account
      * @returns {Promise<BankAccount[]>}
@@ -39,6 +41,7 @@ export class BankAccounts {
     list(accountID: string): Promise<BankAccount[]>;
     /**
      * Discontinue using a specified bank account linked to a Moov account.
+     * The `BANK_ACCOUNTS_WRITE` scope enum is required when making a request from the browser.
      *
      * @param {string} accountID - Account on which to request bank account
      * @param {string} bankAccountID - ID of the bank account to disable
@@ -49,6 +52,7 @@ export class BankAccounts {
     disable(accountID: string, bankAccountID: string): Promise<void>;
     /**
      * Initiate a micro deposit for a bank account linked to a Moov account.
+     * The `BANK_ACCOUNTS_WRITE` scope enum is required when making a request from the browser.
      *
      * @param {string} accountID - Account on which to request bank account
      * @param {string} bankAccountID - ID of the bank account to disable
@@ -59,6 +63,7 @@ export class BankAccounts {
     initMicroDeposits(accountID: string, bankAccountID: string): Promise<void>;
     /**
      * Complete the micro-deposit validation process by passing the amounts of the two transfers.
+     * The `BANK_ACCOUNTS_WRITE` scope enum is required when making a request from the browser.
      *
      * @param {string} accountID - Account on which to request bank account
      * @param {string} bankAccountID - ID of the bank account to disable

lib/types/capabilities.d.ts

@@ -140,16 +140,16 @@ export namespace REQUIREMENT_ERROR_CODE {
  * @tag Capabilities
  */
 /**
- * Represents individual and business data necessary to facilitate the enabling of a capability for an account
+ * Represents individual and business data necessary to facilitate the enabling of a capability for an account.
  * @typedef Requirement
- * @property {Array.<CAPABILITY_REQUIREMENT>} currentlyDue
- * @property {Array.<RequirementError>} errors
+ * @property {Array.<CAPABILITY_REQUIREMENT>} currentlyDue - List of required documents and data
+ * @property {Array.<RequirementError>} errors - List of missing requirements
  * @tag Capabilities
  */
 /**
  * @typedef RequirementError
- * @property {Array.<CAPABILITY_REQUIREMENT>} requirement
- * @property {Array.<REQUIREMENT_ERROR_CODE>} errorCode
+ * @property {Array.<CAPABILITY_REQUIREMENT>} requirement - The unique ID of the missing requirement
+ * @property {Array.<REQUIREMENT_ERROR_CODE>} errorCode - List of relevant error codes (for example, `invalid-value`)
  *
  * @tag Capabilities
  */
@@ -161,7 +161,8 @@ export class Capabilities {
     constructor(moov: any);
     moov: any;
     /**
-     * Request a capability to be added to an account
+     * Request a capability to be added to an account.
+     * The `CAPABILITIES_WRITE` scope enum is required when making a request from the browser.
      *
      * @param {string} accountID - Account on which to request capabilities
      * @param {CAPABILITIES[]} capabilities - One or more capability to request
@@ -172,6 +173,7 @@ export class Capabilities {
     requestCapabilities(accountID: string, capabilities: CAPABILITIES[]): Promise<Capability[]>;
     /**
      * Retrieve a capability of an account
+     * The `CAPABILITIES_READ` scope enum is required when making a request from the browser.
      *
      * @param {string} accountID - Account on which to request capabilities
      * @param {CAPABILITIES} capability - Capability to retrieve
@@ -182,6 +184,7 @@ export class Capabilities {
     get(accountID: string, capability: any): Promise<Capability>;
     /**
      * List capabilities on an account
+     * The `CAPABILITIES_READ` scope enum is required when making a request from the browser.
      *
      * @param {string} accountID - Account on which to request capabilities
      * @returns {Promise<Capability[]>}
@@ -191,7 +194,7 @@ export class Capabilities {
     list(accountID: string): Promise<Capability[]>;
     /**
      * Disable a capability of an account
-     *
+     * The `CAPABILITIES_WRITE` scope enum is required when making a request from the browser.
      * @param {string} accountID - Account on which to request capabilities
      * @param {CAPABILITIES} capability - Capability to retrieve
      * @returns {Promise<void>}
@@ -238,14 +241,26 @@ export type Capability = {
     disabledOn: Date;
 };
 /**
- * Represents individual and business data necessary to facilitate the enabling of a capability for an account
+ * Represents individual and business data necessary to facilitate the enabling of a capability for an account.
  */
 export type Requirement = {
+    /**
+     * - List of required documents and data
+     */
     currentlyDue: Array<CAPABILITY_REQUIREMENT>;
+    /**
+     * - List of missing requirements
+     */
     errors: Array<RequirementError>;
 };
 export type RequirementError = {
+    /**
+     * - The unique ID of the missing requirement
+     */
     requirement: Array<CAPABILITY_REQUIREMENT>;
+    /**
+     * - List of relevant error codes (for example, `invalid-value`)
+     */
     errorCode: Array<REQUIREMENT_ERROR_CODE>;
 };
 //# sourceMappingURL=capabilities.d.ts.map

lib/types/cardDetails.d.ts

@@ -1,4 +1,4 @@
-export var unused: {};
+export const unused: {};
 export type CardDetails = {
     /**
      * -An optional override of the default card statement descriptor for a single transfer