From e8228274c0ec24a742ba7648c912fd631134acfc Mon Sep 17 00:00:00 2001 From: Zach Balder Date: Wed, 21 Aug 2024 13:53:49 -0400 Subject: [PATCH] regenerate types --- lib/types/accounts.d.ts | 204 ++++++++++---- lib/types/accounts.d.ts.map | 2 +- lib/types/address.d.ts | 11 +- lib/types/address.d.ts.map | 2 +- lib/types/avatars.d.ts | 3 +- lib/types/avatars.d.ts.map | 2 +- lib/types/bankAccounts.d.ts | 7 +- lib/types/bankAccounts.d.ts.map | 2 +- lib/types/capabilities.d.ts | 31 ++- lib/types/capabilities.d.ts.map | 2 +- lib/types/cardDetails.d.ts | 2 +- lib/types/cards.d.ts | 135 +++++++--- lib/types/cards.d.ts.map | 2 +- lib/types/enrichedAddress.d.ts | 85 +++--- lib/types/enrichedAddress.d.ts.map | 2 +- lib/types/enrichedProfile.d.ts | 111 ++++++-- lib/types/enrichedProfile.d.ts.map | 2 +- lib/types/institutions.d.ts | 34 ++- lib/types/institutions.d.ts.map | 2 +- lib/types/moov.d.ts | 2 +- lib/types/moov.d.ts.map | 2 +- lib/types/paymentMethods.d.ts | 4 +- lib/types/paymentMethods.d.ts.map | 2 +- lib/types/representatives.d.ts | 47 +++- lib/types/representatives.d.ts.map | 2 +- lib/types/transfers.d.ts | 419 ++++++++++++++++++++++------- lib/types/transfers.d.ts.map | 2 +- lib/types/wallets.d.ts | 8 +- lib/types/wallets.d.ts.map | 2 +- package-lock.json | 28 +- 30 files changed, 864 insertions(+), 295 deletions(-) diff --git a/lib/types/accounts.d.ts b/lib/types/accounts.d.ts index 30c3f1a..eb9f3e9 100644 --- a/lib/types/accounts.d.ts +++ b/lib/types/accounts.d.ts @@ -197,7 +197,7 @@ * @tag Accounts */ /** - * A token that can then be used to accept Moov's Terms of Service. Must be generated from a web browser. See https://docs.moov.io/moovjs/accounts/accounts/#platform-agreement for more details. + * A token that can then be used to accept Moov's Terms of Service. Must be generated from a web browser. See the [Moovjs](/moovjs/accounts/accounts/#platform-terms-of-service-agreement) documentation for more details. * @typedef TermsOfServiceToken * @property {string} token - An encrypted value used to record acceptance of Moov's Terms of Service * @tag Accounts @@ -214,36 +214,36 @@ /** * Profile for a Moov acocunt. May be business or individual. * @typedef Profile - * @property {BusinessProfile} [business] - * @property {IndividualProfile} [individual] + * @property {BusinessProfile} [business] - A business account + * @property {IndividualProfile} [individual] - An individual account * @tag Accounts */ /** * Describes a business account. * @typedef BusinessProfile - * @property {string} legalBusinessName - * @property {string} doingBusinessAs - * @property {"soleProprietorship"|"unincorporatedAssociation"|"trust"|"publicCorporation"|"privateCorporation"|"privateCorporation"|"llc"|"partnership"|"unincorporatedNonProfit"|"incorporatedNonProfit"} businessType - * @property {Address} address - * @property {Phone} phone - * @property {string} email - * @property {string} website - * @property {string} description - * @property {boolean} taxIDProvided - True if business's tax ID has been provided + * @property {string} legalBusinessName - Business's legal name + * @property {string} doingBusinessAs - Business's trade name (if different than the legal name) + * @property {"soleProprietorship"|"unincorporatedAssociation"|"trust"|"publicCorporation"|"privateCorporation"|"privateCorporation"|"llc"|"partnership"|"unincorporatedNonProfit"|"incorporatedNonProfit"} businessType - The legal registered type of the business + * @property {Address} address - Business's address + * @property {Phone} phone - Business's phone number + * @property {string} email - Business's email + * @property {string} website - Business's website + * @property {string} description - Description of the business + * @property {boolean} taxIDProvided - `true` if business's tax ID has been provided * @property {Representative[]} representatives - * @property {boolean} ownersProvided - True if business owner(s) have been provided - * @property {IndustryCodes} industryCodes + * @property {boolean} ownersProvided - `true` if business owner(s) have been provided + * @property {IndustryCodes} industryCodes - Business's industry code (for example, `mcc`) * @tag Accounts */ /** * Describes the individual associated with a non-business account. * @typedef IndividualProfile - * @property {Name} name - * @property {Phone} phone - * @property {string} email - * @property {Address} address - * @property {boolean} birthDateProvided - True if individual's birth date has been provided - * @property {boolean} governmentIDProvided - True if individual's government-issued ID has been provided + * @property {Name} name - Individual's name + * @property {Phone} phone - Individual's phone number + * @property {string} email - Individual's email address + * @property {Address} address - Individual's address + * @property {boolean} birthDateProvided - `true` if individual's birth date has been provided + * @property {boolean} governmentIDProvided - `true` if individual's government-issued ID has been provided * @tag Accounts */ /** @@ -255,20 +255,20 @@ /** * Standard industry codes for businesses. * @typedef IndustryCodes - * @property {string} naics - * @property {string} sic - * @property {string} mcc + * @property {string} naics - North American Industry Classification System + * @property {string} sic - Standard Industry Classification + * @property {string} mcc - Merchant Category Codes * @tag Accounts */ /** * Describes an individual who represents a business account. * @typedef Representative - * @property {Name} name - * @property {Phone} phone - * @property {string} email - * @property {Address} address - * @property {boolean} birthDateProvided - True if individual's birth date has been provided - * @property {boolean} governmentIDProvided - True if individual's government-issued ID has been provided + * @property {Name} name - Representative's first and last name + * @property {Phone} phone - Representative's phone number + * @property {string} email - Representative's email address + * @property {Address} address - Representative's address + * @property {boolean} birthDateProvided - `true` if individual's birth date has been provided + * @property {boolean} governmentIDProvided - `true` if individual's government-issued ID has been provided * @property {Responsibility[]} responsibilities * @property {string} createdOn - Date representative was recorded * @property {string} updatedOn - Date representative was last updated @@ -278,10 +278,10 @@ /** * Describes the responsibilities associated with a business representative. * @typedef Responsibility - * @property {boolean} isController - * @property {boolean} isOwner - * @property {number} ownershipPercentage - Required if `isOwner` is true - * @property {string} jobTitle + * @property {boolean} isController - `true` if representative has significant management responsibilities + * @property {boolean} isOwner - `true` if representative owns ≥25% of the business + * @property {number} ownershipPercentage - % of business representative owns (required if `isOwner` is `true`) + * @property {string} jobTitle - Job title of representative (for example, CEO) * @tag Accounts */ /** @@ -293,10 +293,10 @@ /** * Describes customer support contact information for a business account. * @typedef CustomerSupport - * @property {Phone} phone - * @property {string} email - * @property {Address} address - * @property {string} website + * @property {Phone} phone - Customer support phone number + * @property {string} email - Customer support email + * @property {Address} address - Customer support address + * @property {string} website - Customer support website * @tag Accounts */ /** @@ -311,7 +311,7 @@ */ /** * @typedef Countries - * @property {string[]} countries + * @property {string[]} countries - Countries of operation for an account * @tag Accounts */ /** @@ -333,7 +333,7 @@ export class Accounts { moov: any; /** * Create a new connected account. - * @tag Accounts + * The `ACCOUNTS_CREATE` scope enum is required when making a request from the browser. * * @param {AccountCreate} account - New account details * @returns {Promise} @@ -342,6 +342,7 @@ export class Accounts { create(account: AccountCreate): Promise; /** * Retrieves details for the list of accounts. + * The `ACCOUNTS_READ` scope enum is required when making a request from the browser. * * @param {string} accountID - Account to query * @param {AccountListCriteria} criteria - Optional criteria to limit the list returned. @@ -351,6 +352,7 @@ export class Accounts { list(accountID: string, criteria: AccountListCriteria): Promise; /** * Retrieves details for the account with the specified ID. + * The `PROFILE_READ` scope enum is required when making a request from the browser. * * @param {string} connectedAccountID - User account to query * @returns {Promise} @@ -359,6 +361,7 @@ export class Accounts { get(connectedAccountID: string): Promise; /** * Updates an existing account. Requires a complete Account object. + * The `PROFILE_WRITE` scope enum is required when making a request from the browser. * * @param {Account} account - Account to update * @returns {Promise} @@ -369,6 +372,7 @@ export class Accounts { /** * Updates an existing account. Does not require a complete Account object, * but the `accountID` property is required. + * The `PROFILE_WRITE` scope enum is required when making a request from the browser. * * @param {Account} account - Account to update * @returns {Promise} @@ -377,6 +381,7 @@ export class Accounts { patch(account: Account): Promise; /** * Retrieve the specified countries of operation for an account. + * The `PROFILE_READ` scope enum is required when making a request from the browser. * * @param {string} accountID - Account to query * @returns {Promise} @@ -385,9 +390,10 @@ export class Accounts { getCountries(accountID: string): Promise; /** * Assign the countries of operation for an account. This endpoint will always overwrite the previously assigned values. + * The `PROFILE_WRITE` scope enum is required when making a request from the browser. * * @param {string} accountID - Account to query - * @param {Countries} countries - Countries to add to the account. + * @param {Countries} countries - Countries to add to the account * @returns {Promise} * @tag Accounts */ @@ -473,7 +479,7 @@ export type AccountCreate = { settings: AccountSettings | null; }; /** - * A token that can then be used to accept Moov's Terms of Service. Must be generated from a web browser. See https://docs.moov.io/moovjs/accounts/accounts/#platform-agreement for more details. + * A token that can then be used to accept Moov's Terms of Service. Must be generated from a web browser. See the [Moovjs](/moovjs/accounts/accounts/#platform-terms-of-service-agreement) documentation for more details. */ export type TermsOfServiceToken = { /** @@ -485,55 +491,112 @@ export type TermsOfServiceToken = { * A person's name. */ export type Name = { + /** + * - A person's first name + */ firstName: string; + /** + * - A person's middle name + */ middleName: string; + /** + * - A person's last name + */ lastName: string; + /** + * - A person's suffix + */ suffix: string; }; /** * Profile for a Moov acocunt. May be business or individual. */ export type Profile = { + /** + * - A business account + */ business?: BusinessProfile; + /** + * - An individual account + */ individual?: IndividualProfile; }; /** * Describes a business account. */ export type BusinessProfile = { + /** + * - Business's legal name + */ legalBusinessName: string; + /** + * - Business's trade name (if different than the legal name) + */ doingBusinessAs: string; + /** + * - The legal registered type of the business + */ businessType: "soleProprietorship" | "unincorporatedAssociation" | "trust" | "publicCorporation" | "privateCorporation" | "privateCorporation" | "llc" | "partnership" | "unincorporatedNonProfit" | "incorporatedNonProfit"; + /** + * - Business's address + */ address: Address; + /** + * - Business's phone number + */ phone: Phone; + /** + * - Business's email + */ email: string; + /** + * - Business's website + */ website: string; + /** + * - Description of the business + */ description: string; /** - * - True if business's tax ID has been provided + * - `true` if business's tax ID has been provided */ taxIDProvided: boolean; representatives: Representative[]; /** - * - True if business owner(s) have been provided + * - `true` if business owner(s) have been provided */ ownersProvided: boolean; + /** + * - Business's industry code (for example, `mcc`) + */ industryCodes: IndustryCodes; }; /** * Describes the individual associated with a non-business account. */ export type IndividualProfile = { + /** + * - Individual's name + */ name: Name; + /** + * - Individual's phone number + */ phone: Phone; + /** + * - Individual's email address + */ email: string; + /** + * - Individual's address + */ address: Address; /** - * - True if individual's birth date has been provided + * - `true` if individual's birth date has been provided */ birthDateProvided: boolean; /** - * - True if individual's government-issued ID has been provided + * - `true` if individual's government-issued ID has been provided */ governmentIDProvided: boolean; }; @@ -551,24 +614,45 @@ export type Phone = { * Standard industry codes for businesses. */ export type IndustryCodes = { + /** + * - North American Industry Classification System + */ naics: string; + /** + * - Standard Industry Classification + */ sic: string; + /** + * - Merchant Category Codes + */ mcc: string; }; /** * Describes an individual who represents a business account. */ export type Representative = { + /** + * - Representative's first and last name + */ name: Name; + /** + * - Representative's phone number + */ phone: Phone; + /** + * - Representative's email address + */ email: string; + /** + * - Representative's address + */ address: Address; /** - * - True if individual's birth date has been provided + * - `true` if individual's birth date has been provided */ birthDateProvided: boolean; /** - * - True if individual's government-issued ID has been provided + * - `true` if individual's government-issued ID has been provided */ governmentIDProvided: boolean; responsibilities: Responsibility[]; @@ -589,12 +673,21 @@ export type Representative = { * Describes the responsibilities associated with a business representative. */ export type Responsibility = { + /** + * - `true` if representative has significant management responsibilities + */ isController: boolean; + /** + * - `true` if representative owns ≥25% of the business + */ isOwner: boolean; /** - * - Required if `isOwner` is true + * - % of business representative owns (required if `isOwner` is `true`) */ ownershipPercentage: number; + /** + * - Job title of representative (for example, CEO) + */ jobTitle: string; }; /** @@ -610,9 +703,21 @@ export type AccountVerification = { * Describes customer support contact information for a business account. */ export type CustomerSupport = { + /** + * - Customer support phone number + */ phone: Phone; + /** + * - Customer support email + */ email: string; + /** + * - Customer support address + */ address: Address; + /** + * - Customer support website + */ website: string; }; export type AccountSettings = { @@ -628,6 +733,9 @@ export type CardPaymentSettings = { statementDescriptor: string; }; export type Countries = { + /** + * - Countries of operation for an account + */ countries: string[]; }; export type AccountListCriteria = { diff --git a/lib/types/accounts.d.ts.map b/lib/types/accounts.d.ts.map index 4324c52..0e03641 100644 --- a/lib/types/accounts.d.ts.map +++ b/lib/types/accounts.d.ts.map @@ -1 +1 @@ -{"version":3,"file":"accounts.d.ts","sourceRoot":"","sources":["../accounts.js"],"names":[],"mappings":"AAIA,wBAAwB;AAExB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkFG;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiHG;AAEH;;;;;GAKG;AAEH;;;;;;;;GAQG;AAEH;;;;;;GAMG;AAEH;;;;;;;;;;;;;;;;GAgBG;AAEH;;;;;;;;;;GAUG;AAEH;;;;;GAKG;AAEH;;;;;;;GAOG;AAEH;;;;;;;;;;;;;;GAcG;AAEH;;;;;;;;GAQG;AAEH;;;;;GAKG;AAEH;;;;;;;;GAQG;AAEH;;;;GAIG;AAEH;;;;GAIG;AAEH;;;;GAIG;AAEH;;;;;;;;;GASG;AAEH;;;GAGG;AACH;IACE,uBAEC;IADC,UAAgB;IAGlB;;;;;;;OAOG;IACH,gBAJW,aAAa,GACX,QAAQ,OAAO,CAAC,CAa5B;IAED;;;;;;;OAOG;IACH,gBALW,MAAM,YACN,mBAAmB,GACjB,QAAQ,OAAO,EAAE,CAAC,CAwB9B;IAED;;;;;;OAMG;IACH,wBAJW,MAAM,GACJ,QAAQ,OAAO,CAAC,CAa5B;IAED;;;;;;;OAOG;IACH,gBALW,OAAO,GACL,QAAQ,OAAO,CAAC,CAS5B;IAED;;;;;;;OAOG;IACH,eAJW,OAAO,GACL,QAAQ,OAAO,CAAC,CAmB5B;IAED;;;;;;OAMG;IACH,wBAJW,MAAM,GACJ,QAAQ,SAAS,CAAC,CAc9B;IAED;;;;;;;OAOG;IACH,2BALW,MAAM,aACN,SAAS,GACP,QAAQ,SAAS,CAAC,CAgB9B;CACF;;;;;;;;eArfa,MAAM;;;;iBACN,YAAY,GAAC,UAAU;;;;iBACvB,MAAM;;;;aACN,OAAO;;;;cACP,MAAM;;;;eACN,MAAM;;;;kBACN,mBAAmB;;;;qBACnB,eAAe,GAAC,IAAI;;;;cACpB,eAAe,GAAC,IAAI;;;;eACpB,MAAM;;;;eACN,MAAM;;;;;;iBAyEN,YAAY,GAAC,UAAU;;;;aACvB,OAAO;;;;cACP,MAAM;;;;oBACN,mBAAmB,GAAC,IAAI;;;;eACxB,MAAM;;;;qBACN,eAAe,GAAC,IAAI;;;;cACpB,eAAe,GAAC,IAAI;;;;;;;;;WA8GpB,MAAM;;;;;;eAON,MAAM;gBACN,MAAM;cACN,MAAM;YACN,MAAM;;;;;;eAON,eAAe;iBACf,iBAAiB;;;;;;uBAOjB,MAAM;qBACN,MAAM;kBACN,oBAAoB,GAAC,2BAA2B,GAAC,OAAO,GAAC,mBAAmB,GAAC,oBAAoB,GAAC,oBAAoB,GAAC,KAAK,GAAC,aAAa,GAAC,yBAAyB,GAAC,uBAAuB;aAC5L,OAAO;WACP,KAAK;WACL,MAAM;aACN,MAAM;iBACN,MAAM;;;;mBACN,OAAO;qBACP,cAAc,EAAE;;;;oBAChB,OAAO;mBACP,aAAa;;;;;;UAOb,IAAI;WACJ,KAAK;WACL,MAAM;aACN,OAAO;;;;uBACP,OAAO;;;;0BACP,OAAO;;;;;;YAMP,MAAM;;;;kBACN,MAAM;;;;;;WAON,MAAM;SACN,MAAM;SACN,MAAM;;;;;;UAON,IAAI;WACJ,KAAK;WACL,MAAM;aACN,OAAO;;;;uBACP,OAAO;;;;0BACP,OAAO;sBACP,cAAc,EAAE;;;;eAChB,MAAM;;;;eACN,MAAM;;;;gBACN,MAAM;;;;;;kBAON,OAAO;aACP,OAAO;;;;yBACP,MAAM;cACN,MAAM;;;;;;;;;wBAON,YAAY,GAAC,SAAS,GAAC,UAAU,GAAC,QAAQ,GAAC,UAAU,GAAC,QAAQ;;;;;;WAO9D,KAAK;WACL,MAAM;aACN,OAAO;aACP,MAAM;;;;;;iBAMN,mBAAmB;;;;;;yBAMnB,MAAM;;;eAMN,MAAM,EAAE;;;;;;UAMR,IAAI;;;;WACJ,MAAM;;;;UACN,YAAY,GAAC,UAAU;;;;eACvB,MAAM;;;;WACN,MAAM;;;;UACN,MAAM"} \ No newline at end of file +{"version":3,"file":"accounts.d.ts","sourceRoot":"","sources":["../accounts.js"],"names":[],"mappings":"AAIA,wBAAwB;AAExB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkFG;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiHG;AAEH;;;;;GAKG;AAEH;;;;;;;;GAQG;AAEH;;;;;;GAMG;AAEH;;;;;;;;;;;;;;;;GAgBG;AAEH;;;;;;;;;;GAUG;AAEH;;;;;GAKG;AAEH;;;;;;;GAOG;AAEH;;;;;;;;;;;;;;GAcG;AAEH;;;;;;;;GAQG;AAEH;;;;;GAKG;AAEH;;;;;;;;GAQG;AAEH;;;;GAIG;AAEH;;;;GAIG;AAEH;;;;GAIG;AAEH;;;;;;;;;GASG;AAEH;;;GAGG;AACH;IACE,uBAEC;IADC,UAAgB;IAGlB;;;;;;;OAOG;IACH,gBAJW,aAAa,GACX,QAAQ,OAAO,CAAC,CAa5B;IAED;;;;;;;;OAQG;IACH,gBALW,MAAM,YACN,mBAAmB,GACjB,QAAQ,OAAO,EAAE,CAAC,CAwB9B;IAED;;;;;;;OAOG;IACH,wBAJW,MAAM,GACJ,QAAQ,OAAO,CAAC,CAa5B;IAED;;;;;;;;OAQG;IACH,gBALW,OAAO,GACL,QAAQ,OAAO,CAAC,CAS5B;IAED;;;;;;;;OAQG;IACH,eAJW,OAAO,GACL,QAAQ,OAAO,CAAC,CAmB5B;IAED;;;;;;;OAOG;IACH,wBAJW,MAAM,GACJ,QAAQ,SAAS,CAAC,CAc9B;IAED;;;;;;;;OAQG;IACH,2BALW,MAAM,aACN,SAAS,GACP,QAAQ,SAAS,CAAC,CAgB9B;CACF;;;;;;;;eA3fa,MAAM;;;;iBACN,YAAY,GAAC,UAAU;;;;iBACvB,MAAM;;;;aACN,OAAO;;;;cACP,MAAM;;;;eACN,MAAM;;;;kBACN,mBAAmB;;;;qBACnB,eAAe,GAAC,IAAI;;;;cACpB,eAAe,GAAC,IAAI;;;;eACpB,MAAM;;;;eACN,MAAM;;;;;;iBAyEN,YAAY,GAAC,UAAU;;;;aACvB,OAAO;;;;cACP,MAAM;;;;oBACN,mBAAmB,GAAC,IAAI;;;;eACxB,MAAM;;;;qBACN,eAAe,GAAC,IAAI;;;;cACpB,eAAe,GAAC,IAAI;;;;;;;;;WA8GpB,MAAM;;;;;;;;;eAON,MAAM;;;;gBACN,MAAM;;;;cACN,MAAM;;;;YACN,MAAM;;;;;;;;;eAON,eAAe;;;;iBACf,iBAAiB;;;;;;;;;uBAOjB,MAAM;;;;qBACN,MAAM;;;;kBACN,oBAAoB,GAAC,2BAA2B,GAAC,OAAO,GAAC,mBAAmB,GAAC,oBAAoB,GAAC,oBAAoB,GAAC,KAAK,GAAC,aAAa,GAAC,yBAAyB,GAAC,uBAAuB;;;;aAC5L,OAAO;;;;WACP,KAAK;;;;WACL,MAAM;;;;aACN,MAAM;;;;iBACN,MAAM;;;;mBACN,OAAO;qBACP,cAAc,EAAE;;;;oBAChB,OAAO;;;;mBACP,aAAa;;;;;;;;;UAOb,IAAI;;;;WACJ,KAAK;;;;WACL,MAAM;;;;aACN,OAAO;;;;uBACP,OAAO;;;;0BACP,OAAO;;;;;;YAMP,MAAM;;;;kBACN,MAAM;;;;;;;;;WAON,MAAM;;;;SACN,MAAM;;;;SACN,MAAM;;;;;;;;;UAON,IAAI;;;;WACJ,KAAK;;;;WACL,MAAM;;;;aACN,OAAO;;;;uBACP,OAAO;;;;0BACP,OAAO;sBACP,cAAc,EAAE;;;;eAChB,MAAM;;;;eACN,MAAM;;;;gBACN,MAAM;;;;;;;;;kBAON,OAAO;;;;aACP,OAAO;;;;yBACP,MAAM;;;;cACN,MAAM;;;;;;;;;wBAON,YAAY,GAAC,SAAS,GAAC,UAAU,GAAC,QAAQ,GAAC,UAAU,GAAC,QAAQ;;;;;;;;;WAO9D,KAAK;;;;WACL,MAAM;;;;aACN,OAAO;;;;aACP,MAAM;;;;;;iBAMN,mBAAmB;;;;;;yBAMnB,MAAM;;;;;;eAMN,MAAM,EAAE;;;;;;UAMR,IAAI;;;;WACJ,MAAM;;;;UACN,YAAY,GAAC,UAAU;;;;eACvB,MAAM;;;;WACN,MAAM;;;;UACN,MAAM"} \ No newline at end of file diff --git a/lib/types/address.d.ts b/lib/types/address.d.ts index 631e419..faba0b6 100644 --- a/lib/types/address.d.ts +++ b/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 diff --git a/lib/types/address.d.ts.map b/lib/types/address.d.ts.map index 21d2b9b..ba3c382 100644 --- a/lib/types/address.d.ts.map +++ b/lib/types/address.d.ts.map @@ -1 +1 @@ -{"version":3,"file":"address.d.ts","sourceRoot":"","sources":["../address.js"],"names":[],"mappings":";;kBAGc,MAAM;kBACN,MAAM;UACN,MAAM;;;;qBACN,MAAM;;;;gBACN,MAAM;;;;aACN,MAAM"} \ No newline at end of file +{"version":3,"file":"address.d.ts","sourceRoot":"","sources":["../address.js"],"names":[],"mappings":";;;;;kBAGc,MAAM;;;;kBACN,MAAM;;;;UACN,MAAM;;;;qBACN,MAAM;;;;gBACN,MAAM;;;;aACN,MAAM"} \ No newline at end of file diff --git a/lib/types/avatars.d.ts b/lib/types/avatars.d.ts index aa6a8b4..d86c354 100644 --- a/lib/types/avatars.d.ts +++ b/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} - Binary representation of the avatar. diff --git a/lib/types/avatars.d.ts.map b/lib/types/avatars.d.ts.map index 47f08c2..f88415b 100644 --- a/lib/types/avatars.d.ts.map +++ b/lib/types/avatars.d.ts.map @@ -1 +1 @@ -{"version":3,"file":"avatars.d.ts","sourceRoot":"","sources":["../avatars.js"],"names":[],"mappings":"AAGA;;;GAGG;AACH;IACE,uBAMC;IALC;;;OAGG;IACH,aAAgB;IAGlB;;;;;;;;;;;;;;OAcG;IACH,cAZW,MAAM,GACJ,QAAQ,IAAI,CAAC,CAsBzB;CACF"} \ No newline at end of file +{"version":3,"file":"avatars.d.ts","sourceRoot":"","sources":["../avatars.js"],"names":[],"mappings":"AAGA;;;GAGG;AACH;IACE,uBAMC;IALC;;;OAGG;IACH,aAAgB;IAGlB;;;;;;;;;;;;;;;OAeG;IACH,cAZW,MAAM,GACJ,QAAQ,IAAI,CAAC,CAsBzB;CACF"} \ No newline at end of file diff --git a/lib/types/bankAccounts.d.ts b/lib/types/bankAccounts.d.ts index b3568c4..f159903 100644 --- a/lib/types/bankAccounts.d.ts +++ b/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; /** * 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} @@ -30,6 +31,7 @@ export class BankAccounts { get(accountID: string, bankAccountID: string): Promise; /** * 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} @@ -39,6 +41,7 @@ export class BankAccounts { list(accountID: string): Promise; /** * 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; /** * 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; /** * 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 diff --git a/lib/types/bankAccounts.d.ts.map b/lib/types/bankAccounts.d.ts.map index 95de577..15aa57c 100644 --- a/lib/types/bankAccounts.d.ts.map +++ b/lib/types/bankAccounts.d.ts.map @@ -1 +1 @@ -{"version":3,"file":"bankAccounts.d.ts","sourceRoot":"","sources":["../bankAccounts.js"],"names":[],"mappings":"AAIA,wBAAwB;AAExB;;;GAGG;AACH;IACE,uBAEC;IADC,UAAgB;IAGlB;;;;;;;;;;OAUG;IACH,gBARW,MAAM,gBACN,cAAc,eACd,MAAM,wBACN,MAAM,GACJ,QAAQ,WAAW,CAAC,CA2DhC;IAED;;;;;;;;OAQG;IACH,eANW,MAAM,iBACN,MAAM,GACJ,QAAQ,WAAW,CAAC,CAgBhC;IAED;;;;;;;OAOG;IACH,gBALW,MAAM,GACJ,QAAQ,WAAW,EAAE,CAAC,CAelC;IAED;;;;;;;;OAQG;IACH,mBANW,MAAM,iBACN,MAAM,GACJ,QAAQ,IAAI,CAAC,CAgBzB;IAED;;;;;;;;OAQG;IACH,6BANW,MAAM,iBACN,MAAM,GACJ,QAAQ,IAAI,CAAC,CAgBzB;IAED;;;;;;;;;OASG;IACH,iCAPW,MAAM,iBACN,MAAM,WACN,MAAO,MAAM,CAAC,GACZ,QAAQ,IAAI,CAAC,CAkBzB;CACF"} \ No newline at end of file +{"version":3,"file":"bankAccounts.d.ts","sourceRoot":"","sources":["../bankAccounts.js"],"names":[],"mappings":"AAIA,wBAAwB;AAExB;;;GAGG;AACH;IACE,uBAEC;IADC,UAAgB;IAGlB;;;;;;;;;;;OAWG;IACH,gBARW,MAAM,gBACN,cAAc,eACd,MAAM,wBACN,MAAM,GACJ,QAAQ,WAAW,CAAC,CA2DhC;IAED;;;;;;;;OAQG;IACH,eANW,MAAM,iBACN,MAAM,GACJ,QAAQ,WAAW,CAAC,CAgBhC;IAED;;;;;;;;OAQG;IACH,gBALW,MAAM,GACJ,QAAQ,WAAW,EAAE,CAAC,CAelC;IAED;;;;;;;;;OASG;IACH,mBANW,MAAM,iBACN,MAAM,GACJ,QAAQ,IAAI,CAAC,CAgBzB;IAED;;;;;;;;;OASG;IACH,6BANW,MAAM,iBACN,MAAM,GACJ,QAAQ,IAAI,CAAC,CAgBzB;IAED;;;;;;;;;;OAUG;IACH,iCAPW,MAAM,iBACN,MAAM,WACN,MAAO,MAAM,CAAC,GACZ,QAAQ,IAAI,CAAC,CAkBzB;CACF"} \ No newline at end of file diff --git a/lib/types/capabilities.d.ts b/lib/types/capabilities.d.ts index c18d72a..2d20258 100644 --- a/lib/types/capabilities.d.ts +++ b/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.} currentlyDue - * @property {Array.} errors + * @property {Array.} currentlyDue - List of required documents and data + * @property {Array.} errors - List of missing requirements * @tag Capabilities */ /** * @typedef RequirementError - * @property {Array.} requirement - * @property {Array.} errorCode + * @property {Array.} requirement - The unique ID of the missing requirement + * @property {Array.} 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; /** * 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; /** * 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} @@ -191,7 +194,7 @@ export class Capabilities { list(accountID: string): Promise; /** * 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} @@ -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; + /** + * - List of missing requirements + */ errors: Array; }; export type RequirementError = { + /** + * - The unique ID of the missing requirement + */ requirement: Array; + /** + * - List of relevant error codes (for example, `invalid-value`) + */ errorCode: Array; }; //# sourceMappingURL=capabilities.d.ts.map \ No newline at end of file diff --git a/lib/types/capabilities.d.ts.map b/lib/types/capabilities.d.ts.map index 946eb6d..3ac744d 100644 --- a/lib/types/capabilities.d.ts.map +++ b/lib/types/capabilities.d.ts.map @@ -1 +1 @@ -{"version":3,"file":"capabilities.d.ts","sourceRoot":"","sources":["../capabilities.js"],"names":[],"mappings":";;;;AAGA,wBAAwB;AAExB;;;;GAIG;AACH;IACE;;;OAGG;;IAEH;;;OAGG;;IAEH;;;OAGG;;IAEH;;;OAGG;;IAEH;;;OAGG;;EAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAsQF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AAEH;;;;;;GAMG;AAEH;;;;;;GAMG;AAEH;;;GAGG;AACH;IACE,uBAEC;IADC,UAAgB;IAGlB;;;;;;;;OAQG;IACH,+BANW,MAAM,gBACN,YAAY,EAAE,GACZ,QAAQ,UAAU,EAAE,CAAC,CAiBjC;IAED;;;;;;;;OAQG;IACH,eANW,MAAM,oBAEJ,QAAQ,UAAU,CAAC,CAgB/B;IAED;;;;;;;OAOG;IACH,gBALW,MAAM,GACJ,QAAQ,UAAU,EAAE,CAAC,CAejC;IAED;;;;;;;;OAQG;IACH,mBANW,MAAM,oBAEJ,QAAQ,IAAI,CAAC,CAgBzB;CACF;;;;;;;;;;;;eApJa,MAAM;;;;;;;;kBAEN,MAAO,WAAW,CAAC;;;;oBACnB,MAAM;;;;eACN,IAAI;;;;eACJ,IAAI;;;;gBACJ,IAAI;;;;;;kBA8BJ,MAAO,sBAAsB,CAAC;YAC9B,MAAO,gBAAgB,CAAC;;;iBAMxB,MAAO,sBAAsB,CAAC;eAC9B,MAAO,sBAAsB,CAAC"} \ No newline at end of file +{"version":3,"file":"capabilities.d.ts","sourceRoot":"","sources":["../capabilities.js"],"names":[],"mappings":";;;;AAGA,wBAAwB;AAExB;;;;GAIG;AACH;IACE;;;OAGG;;IAEH;;;OAGG;;IAEH;;;OAGG;;IAEH;;;OAGG;;IAEH;;;OAGG;;EAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA8TF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AAEH;;;;;;GAMG;AAEH;;;;;;GAMG;AAEH;;;GAGG;AACH;IACE,uBAEC;IADC,UAAgB;IAGlB;;;;;;;;;OASG;IACH,+BANW,MAAM,gBACN,YAAY,EAAE,GACZ,QAAQ,UAAU,EAAE,CAAC,CAiBjC;IAED;;;;;;;;;OASG;IACH,eANW,MAAM,oBAEJ,QAAQ,UAAU,CAAC,CAgB/B;IAED;;;;;;;;OAQG;IACH,gBALW,MAAM,GACJ,QAAQ,UAAU,EAAE,CAAC,CAejC;IAED;;;;;;;;OAQG;IACH,mBANW,MAAM,oBAEJ,QAAQ,IAAI,CAAC,CAgBzB;CACF;;;;;;;;;;;;eAvJa,MAAM;;;;;;;;kBAEN,MAAO,WAAW,CAAC;;;;oBACnB,MAAM;;;;eACN,IAAI;;;;eACJ,IAAI;;;;gBACJ,IAAI;;;;;;;;;kBA8BJ,MAAO,sBAAsB,CAAC;;;;YAC9B,MAAO,gBAAgB,CAAC;;;;;;iBAMxB,MAAO,sBAAsB,CAAC;;;;eAC9B,MAAO,sBAAsB,CAAC"} \ No newline at end of file diff --git a/lib/types/cardDetails.d.ts b/lib/types/cardDetails.d.ts index f7d0ca0..c2f9368 100644 --- a/lib/types/cardDetails.d.ts +++ b/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 diff --git a/lib/types/cards.d.ts b/lib/types/cards.d.ts index 4533ec8..f06ac82 100644 --- a/lib/types/cards.d.ts +++ b/lib/types/cards.d.ts @@ -27,6 +27,10 @@ export namespace CARD_VERIFICATION_STATUS { * * @tag Cards */ +/** @template T + * @template K {extends keyof T} + * @typedef {Pick, K> & Omit} Optional + */ /** * Card information collected for acquisition. * @typedef LinkCard @@ -34,10 +38,20 @@ export namespace CARD_VERIFICATION_STATUS { * @property {CardExpiration} expiration - Card expiration date * @property {string} cardCvv - 3-4 digit card verification value * @property {string} holderName - Full name of the card holder - * @property {CardBillingAddress} billingAddress - The billing address of the card + * @property {Optional} billingAddress - The billing address of the card + * @property {boolean} [ cardOnFile = false ] - Indicates cardholder has authorized card to be stored for future payments. Only cards marked as card-on-file are eligible for automatic updates via card account updater * * @tag Cards */ +/** + * Card information that can be updated. + * @typedef UpdateCard + * @property {CardExpiration} expiration - Card expiration date + * @property {string} cardCvv - 3-4 digit card verification value + * @property {Optional} billingAddress - The billing address of the card +* + * @tag Cards + */ /** * Card billing address * @typedef CardBillingAddress @@ -74,35 +88,54 @@ export namespace CARD_VERIFICATION_STATUS { * @property {CardVerficationStatuses} cardVerfication - The results of submitting cardholder data to a card network for verification * @property {string} issuer - The name of the issuer * @property {string} issuerCountry - The country of the issuer + * @property {string} merchantAccountID + * @property {PaymentMethod[]} [paymentMethods] * * @example * { - "cardID": "ec7e1848-dc80-4ab0-8827-dd7fc0737b43", - "fingerprint": "9948962d92a1ce40c9f918cd9ece3a22bde62fb325a2f1fe2e833969de672ba3", - "brand": "American Express", - "cardType": "debit", - "lastFourCardNumber": "1234", - "bin": "123456", - "expiration": { - "month": "01", - "year": "21" - }, - "holderName": "Jules Jackson", - "billingAddress": { - "addressLine1": "123 Main Street", - "addressLine2": "Apt 302", - "city": "Boulder", - "stateOrProvince": "CO", - "postalCode": "80301", - "country": "US" - }, - "cardVerification": { - "cvv": "match", - "addressLine1": "match", - "postalCode": "match" - }, - "issuer": "GRINGOTTS BANK", - "issuerCountry": "US" + "billingAddress": { + "addressLine1": "123 Main Street", + "addressLine2": "Apt 302", + "city": "Boulder", + "country": "US", + "postalCode": "80301", + "stateOrProvince": "CO" + }, + "bin": "123456", + "brand": "Discover", + "cardAccountUpdater": { + "updateType": "number-update", + "updatedOn": "2019-08-24T14:15:22Z" + }, + "cardID": "ec7e1848-dc80-4ab0-8827-dd7fc0737b43", + "cardOnFile": true, + "cardType": "debit", + "cardVerification": { + "addressLine1": "match", + "cvv": "match", + "postalCode": "match" + }, + "domesticPushToCard": "fast-funds", + "expiration": { + "month": "01", + "year": "21" + }, + "fingerprint": "9948962d92a1ce40c9f918cd9ece3a22bde62fb325a2f1fe2e833969de672ba3", + "holderName": "Jules Jackson", + "issuer": "GRINGOTTS BANK", + "issuerCountry": "US", + "lastFourCardNumber": "1234", + "merchantAccountID": "50469144-f859-46dc-bdbd-9587c2fa7b42", + "paymentMethods": [ + { + "paymentMethodID": "9506dbf6-4208-44c3-ad8a-e4431660e1f2", + "paymentMethodType": "card-payment" + }, + { + "paymentMethodID": "3f9969cf-a1f3-4d83-8ddc-229a506651cf", + "paymentMethodType": "push-to-card" + } + ] } * * @tag Cards @@ -116,6 +149,7 @@ export class Cards { moov: any; /** * Retrieves details for the card with the specified ID. + * The `CARDS_READ` scope enum is required when making a request from the browser. * * @param {string} accountID - Account to query * @param {string} cardID - Card to query @@ -125,6 +159,7 @@ export class Cards { get(accountID: string, cardID: string): Promise; /** * Lists all the cards associated with a particular Moov account. + * The `CARDS_READ` scope enum is required when making a request from the browser. * * @param {string} accountID - Account to query * @returns {Promise} @@ -134,23 +169,39 @@ export class Cards { /** * Links a card to a Moov account. Only use this endpoint if you have provided Moov with a * copy of your PCI attestation of compliance. + * The `CARDS_WRITE` scope enum is required when making a request from the browser. * * @param {string} accountID - Account to link * @param {LinkCard} card - Card information + * @param {boolean} [waitForPaymentMethods = false] whether to wait for payment methods to be created and included in response + * @returns {Promise} + * @tag Cards + */ + link(accountID: string, card: LinkCard, waitForPaymentMethods?: boolean): Promise; + /** + * Updates a card in a Moov account. Only use this endpoint if you have provided Moov with a + * copy of your PCI attestation of compliance. + * The `CARDS_WRITE` scope enum is required when making a request from the browser. + * + * @param {string} accountID - Account linked to card + * @param {string} cardID - Card to update + * @param {UpdateCard} cardUpdates - Card information * @returns {Promise} * @tag Cards */ - link(accountID: string, card: LinkCard): Promise; + update(accountID: string, cardID: string, cardUpdates: UpdateCard): Promise; /** * Disables a card with the specified ID. + * The `CARDS_WRITE` scope enum is required when making a request from the browser. * - * @param {string} accountID - Account to query + * @param {string} accountID - Account to query * @param {string} cardID - Card to query * @returns {Promise} * @tag Cards */ disable(accountID: string, cardID: string): Promise; } +export type PaymentMethod = import('./paymentMethods.js').PaymentMethod; /** * Card account expiration date */ @@ -164,6 +215,7 @@ export type CardExpiration = { */ year: string; }; +export type Optional = Pick, K> & Omit; /** * Card information collected for acquisition. */ @@ -187,7 +239,28 @@ export type LinkCard = { /** * - The billing address of the card */ - billingAddress: CardBillingAddress; + billingAddress: Optional; + /** + * - Indicates cardholder has authorized card to be stored for future payments. Only cards marked as card-on-file are eligible for automatic updates via card account updater + */ + cardOnFile?: boolean; +}; +/** + * Card information that can be updated. + */ +export type UpdateCard = { + /** + * - Card expiration date + */ + expiration: CardExpiration; + /** + * - 3-4 digit card verification value + */ + cardCvv: string; + /** + * - The billing address of the card + */ + billingAddress: Optional; }; /** * Card billing address @@ -287,5 +360,7 @@ export type Card = { * - The country of the issuer */ issuerCountry: string; + merchantAccountID: string; + paymentMethods?: PaymentMethod[]; }; //# sourceMappingURL=cards.d.ts.map \ No newline at end of file diff --git a/lib/types/cards.d.ts.map b/lib/types/cards.d.ts.map index 937fc41..7b3574e 100644 --- a/lib/types/cards.d.ts.map +++ b/lib/types/cards.d.ts.map @@ -1 +1 @@ -{"version":3,"file":"cards.d.ts","sourceRoot":"","sources":["../cards.js"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;AAsFA;;;;;;;GAOG;AACH;;;;;;;;;;GAUG;AACH;;;;;;;;;;;GAWG;AAEH;;;;;;;;GAQG;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+CG;AAEH;;;GAGG;AACH;IACE,uBAEC;IADC,UAAgB;IAGlB;;;;;;;OAOG;IACH,eALW,MAAM,UACN,MAAM,GACJ,QAAQ,IAAI,CAAC,CAezB;IAED;;;;;;OAMG;IACH,gBAJW,MAAM,GACJ,QAAQ,IAAI,EAAE,CAAC,CAc3B;IAED;;;;;;;;OAQG;IACH,gBALW,MAAM,QACN,QAAQ,GACN,QAAQ,IAAI,CAAC,CAgBzB;IAED;;;;;;;OAOG;IACH,mBALW,MAAM,UACN,MAAM,GACJ,QAAQ,IAAI,CAAC,CAezB;CACF;;;;;;;;WAxLa,MAAM;;;;UACN,MAAM;;;;;;;;;gBAON,MAAM;;;;gBACN,cAAc;;;;aACd,MAAM;;;;gBACN,MAAM;;;;oBACN,kBAAkB;;;;;;;;;kBAOlB,MAAM;;;;kBACN,MAAM;;;;UACN,MAAM;;;;qBACN,MAAM;;;;gBACN,MAAM;;;;aACN,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;YAkBN,MAAM;;;;iBACN,MAAM;;;;;;;;;;;;wBAGN,MAAM;;;;SACN,MAAM;;;;gBACN,cAAc;;;;gBACd,MAAM;;;;oBACN,kBAAkB;;;;qBAClB,uBAAuB;;;;YACvB,MAAM;;;;mBACN,MAAM"} \ No newline at end of file +{"version":3,"file":"cards.d.ts","sourceRoot":"","sources":["../cards.js"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;AAwFA;;;;;;;GAOG;AAEF;;;GAGG;AAEJ;;;;;;;;;;;GAWG;AAEH;;;;;;;;GAQG;AAEH;;;;;;;;;;;GAWG;AAEH;;;;;;;;GAQG;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkEG;AAEH;;;GAGG;AACH;IACE,uBAEC;IADC,UAAgB;IAGlB;;;;;;;;OAQG;IACH,eALW,MAAM,UACN,MAAM,GACJ,QAAQ,IAAI,CAAC,CAezB;IAED;;;;;;;OAOG;IACH,gBAJW,MAAM,GACJ,QAAQ,IAAI,EAAE,CAAC,CAc3B;IAED;;;;;;;;;;OAUG;IACH,gBANW,MAAM,QACN,QAAQ,0BACR,OAAO,GACL,QAAQ,IAAI,CAAC,CAoBzB;IAED;;;;;;;;;;OAUG;IACD,kBANS,MAAM,UACN,MAAM,eACN,UAAU,GACR,QAAQ,IAAI,CAAC,CAiBvB;IAEH;;;;;;;;OAQG;IACH,mBALU,MAAM,UACL,MAAM,GACJ,QAAQ,IAAI,CAAC,CAezB;CACF;4BAzVa,OAAO,qBAAqB,EAAE,aAAa;;;;;;;;WAwF3C,MAAM;;;;UACN,MAAM;;6BAOL,KAAK,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,KAAK,CAAC,EAAE,CAAC,CAAC;;;;;;;;gBAMjC,MAAM;;;;gBACN,cAAc;;;;aACd,MAAM;;;;gBACN,MAAM;;;;oBACN,SAAS,kBAAkB,EAAE,cAAc,GAAG,cAAc,GAAG,MAAM,GAAG,iBAAiB,GAAG,SAAS,CAAC;;;;iBACtG,OAAO;;;;;;;;;gBAQP,cAAc;;;;aACd,MAAM;;;;oBACN,SAAS,kBAAkB,EAAE,cAAc,GAAG,cAAc,GAAG,MAAM,GAAG,iBAAiB,GAAG,SAAS,CAAC;;;;;;;;;kBAQtG,MAAM;;;;kBACN,MAAM;;;;UACN,MAAM;;;;qBACN,MAAM;;;;gBACN,MAAM;;;;aACN,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;YAkBN,MAAM;;;;iBACN,MAAM;;;;;;;;;;;;wBAGN,MAAM;;;;SACN,MAAM;;;;gBACN,cAAc;;;;gBACd,MAAM;;;;oBACN,kBAAkB;;;;qBAClB,uBAAuB;;;;YACvB,MAAM;;;;mBACN,MAAM;uBACN,MAAM;qBACN,aAAa,EAAE"} \ No newline at end of file diff --git a/lib/types/enrichedAddress.d.ts b/lib/types/enrichedAddress.d.ts index 4cf24d8..8576406 100644 --- a/lib/types/enrichedAddress.d.ts +++ b/lib/types/enrichedAddress.d.ts @@ -1,29 +1,29 @@ /** * @typedef EnrichedAddress - * @property {string} addressLine1 - * @property {string} addressLine2 - * @property {string} city - * @property {string} stateOrProvince - * @property {string} postalCode - * @property {number} entries + * @property {string} addressLine1 - Street address + * @property {string} addressLine2 - Unit number + * @property {string} city - 25 characters or less + * @property {string} stateOrProvince - 2 characters + * @property {string} postalCode - 5 characters + * @property {number} entries - The number of addresses matching the search criteria * * @tag Enrichment */ /** * @typedef EnrichedAddressGetCriteria - * @property {string} search - Partial or complete address to search. - * @property {number} [maxResults] - Optional Maximum number of results to return. - * @property {string} [includeCities] - Optional Limits results to a list of given cities. Example: "chicago;honolulu;portland" - * @property {string} [includeStates] - Optional Limits results to a list of given states. Example: "illinois;hawaii;oregon" - * @property {string} [includeZipcodes] - Optional Limits results to a list of given ZIP codes. Example: "60412;96818;97209" - * @property {string} [excludeStates] - Optional Exclude list of states from results. No include parameters may be used with this parameter. Example: "AZ;WA;SC" - * @property {string} [preferCities] - Optional Display results with the listed cities at the top. Example: "denver;aurora;omaha" - * @property {string} [preferStates] - Optional Display results with the listed states at the top. Example: "CO;MN;WI" - * @property {string} [preferZipcodes] - Optional Display results with the listed ZIP codes at the top. Example: "60412;96818;97209" - * @property {number} [preferRatio] - Optional Specifies the percentage of address suggestions that should be preferred and will appear at the top of the results. - * @property {"none"|"city"} [preferGeolocation] - Optional If omitted or set to city it uses the sender's IP address to determine location, then automatically adds the city and state to the preferCities value. This parameter takes precedence over other include or exclude parameters meaning that if it is not set to none you may see addresses from areas you do not wish to see. Example: "city" - * @property {string} [selected] - Optional Useful for narrowing results with addressLine2 suggestions such as Apt (denotes an apartment building with multiple residences). Example: "Apt" - * @property {"all"|"postal"} [source] - Optional Include results from alternate data sources. Allowed values are -- all (non-postal addresses) or postal (postal addresses only). + * @property {string} search - Partial or complete address to search + * @property {number} [maxResults] - Optional Maximum number of results to return + * @property {string} [includeCities] - Optional - Limits results to a list of given cities (example, "chicago;honolulu;portland") + * @property {string} [includeStates] - Optional - Limits results to a list of given states (example, "illinois;hawaii;oregon") + * @property {string} [includeZipcodes] - Optional - Limits results to a list of given ZIP codes (example, "60412;96818;97209") + * @property {string} [excludeStates] - Optional - Exclude list of states from results. No include parameters may be used with this parameter. Example: "AZ;WA;SC" + * @property {string} [preferCities] - Optional- Display results with the listed cities at the top (example, "denver;aurora;omaha") + * @property {string} [preferStates] - Optional - Display results with the listed states at the top (example, "CO;MN;WI") + * @property {string} [preferZipcodes] - Optional - Display results with the listed ZIP codes at the top (example, "60412;96818;97209") + * @property {number} [preferRatio] - Optional - Specifies the percentage of address suggestions that should be preferred and will appear at the top of the results + * @property {"none"|"city"} [preferGeolocation] - Optional - If omitted or set to city it uses the sender's IP address to determine location, then automatically adds the city and state to the preferCities value (example: "city"). This parameter takes precedence over other include or exclude parameters meaning that if it is not set to none you may see addresses from areas you do not wish to see. + * @property {string} [selected] - Optional - Useful for narrowing results with `addressLine2` suggestions such as Apt. Denotes an apartment building with multiple residences (example, "Apt"). + * @property {"all"|"postal"} [source] - Optional - Include results from alternate data sources. Allowed values are `all` (non-postal addresses) or `postal` (postal addresses only). * * @tag Enrichment * */ @@ -40,8 +40,9 @@ export class EnrichedAddresses { private moov; /** * Gets enriched address suggestions. + * The `PROFILE_ENRICHMENT_READ` scope enum is required when making a request from the browser. * - * @param {EnrichedAddressGetCriteria} criteria - Criterial for available search parameters. + * @param {EnrichedAddressGetCriteria} criteria - Criteria for available search parameters * @returns {Promise} * @tag Enrichment * @@ -60,64 +61,82 @@ export class EnrichedAddresses { get(criteria: EnrichedAddressGetCriteria): Promise; } export type EnrichedAddress = { + /** + * - Street address + */ addressLine1: string; + /** + * - Unit number + */ addressLine2: string; + /** + * - 25 characters or less + */ city: string; + /** + * - 2 characters + */ stateOrProvince: string; + /** + * - 5 characters + */ postalCode: string; + /** + * - The number of addresses matching the search criteria + */ entries: number; }; export type EnrichedAddressGetCriteria = { /** - * - Partial or complete address to search. + * - Partial or complete address to search */ search: string; /** - * - Optional Maximum number of results to return. + * - Optional Maximum number of results to return */ maxResults?: number; /** - * - Optional Limits results to a list of given cities. Example: "chicago;honolulu;portland" + * - Optional - Limits results to a list of given cities (example, "chicago;honolulu;portland") */ includeCities?: string; /** - * - Optional Limits results to a list of given states. Example: "illinois;hawaii;oregon" + * - Optional - Limits results to a list of given states (example, "illinois;hawaii;oregon") */ includeStates?: string; /** - * - Optional Limits results to a list of given ZIP codes. Example: "60412;96818;97209" + * - Optional - Limits results to a list of given ZIP codes (example, "60412;96818;97209") */ includeZipcodes?: string; /** - * - Optional Exclude list of states from results. No include parameters may be used with this parameter. Example: "AZ;WA;SC" + * - Optional - Exclude list of states from results. No include parameters may be used with this parameter. Example: "AZ;WA;SC" */ excludeStates?: string; /** - * - Optional Display results with the listed cities at the top. Example: "denver;aurora;omaha" + * - Optional- Display results with the listed cities at the top (example, "denver;aurora;omaha") */ preferCities?: string; /** - * - Optional Display results with the listed states at the top. Example: "CO;MN;WI" + * - Optional - Display results with the listed states at the top (example, "CO;MN;WI") */ preferStates?: string; /** - * - Optional Display results with the listed ZIP codes at the top. Example: "60412;96818;97209" + * - Optional - Display results with the listed ZIP codes at the top (example, "60412;96818;97209") */ preferZipcodes?: string; /** - * - Optional Specifies the percentage of address suggestions that should be preferred and will appear at the top of the results. + * - Optional - Specifies the percentage of address suggestions that should be preferred and will appear at the top of the results */ preferRatio?: number; /** - * - Optional If omitted or set to city it uses the sender's IP address to determine location, then automatically adds the city and state to the preferCities value. This parameter takes precedence over other include or exclude parameters meaning that if it is not set to none you may see addresses from areas you do not wish to see. Example: "city" + * - Optional - If omitted or set to city it uses the sender's IP address to determine location, then automatically adds the city and state to the preferCities value (example: "city"). This parameter takes precedence over other include or exclude parameters meaning that if it is not set to none you may see addresses from areas you do not wish to see. */ preferGeolocation?: "none" | "city"; /** - * - Optional Useful for narrowing results with addressLine2 suggestions such as Apt (denotes an apartment building with multiple residences). Example: "Apt" + * - Optional - Useful for narrowing results with `addressLine2` suggestions such as Apt. Denotes an apartment building with multiple residences (example, "Apt"). */ selected?: string; /** - * - Optional Include results from alternate data sources. Allowed values are -- all (non-postal addresses) or postal (postal addresses only). + * - Optional - Include results from alternate data sources. Allowed values are `all` (non-postal addresses) or `postal` (postal addresses only). */ source?: "all" | "postal"; }; diff --git a/lib/types/enrichedAddress.d.ts.map b/lib/types/enrichedAddress.d.ts.map index 2faf64e..09e3054 100644 --- a/lib/types/enrichedAddress.d.ts.map +++ b/lib/types/enrichedAddress.d.ts.map @@ -1 +1 @@ -{"version":3,"file":"enrichedAddress.d.ts","sourceRoot":"","sources":["../enrichedAddress.js"],"names":[],"mappings":"AAGA;;;;;;;;;;GAUG;AAEH;;;;;;;;;;;;;;;;;KAiBK;AAEL;;;GAGG;AACH;IACE,uBAMC;IALC;;;OAGG;IACH,aAAgB;IAGlB;;;;;;;;;;;;;;;;;;OAkBG;IACH,cAhBW,0BAA0B,GACxB,QAAQ,eAAe,EAAE,CAAC,CAyEtC;CACF;;kBAxHa,MAAM;kBACN,MAAM;UACN,MAAM;qBACN,MAAM;gBACN,MAAM;aACN,MAAM;;;;;;YAON,MAAM;;;;iBACN,MAAM;;;;oBACN,MAAM;;;;oBACN,MAAM;;;;sBACN,MAAM;;;;oBACN,MAAM;;;;mBACN,MAAM;;;;mBACN,MAAM;;;;qBACN,MAAM;;;;kBACN,MAAM;;;;wBACN,MAAM,GAAC,MAAM;;;;eACb,MAAM;;;;aACN,KAAK,GAAC,QAAQ"} \ No newline at end of file +{"version":3,"file":"enrichedAddress.d.ts","sourceRoot":"","sources":["../enrichedAddress.js"],"names":[],"mappings":"AAGA;;;;;;;;;;GAUG;AAEH;;;;;;;;;;;;;;;;;KAiBK;AAEL;;;GAGG;AACH;IACE,uBAMC;IALC;;;OAGG;IACH,aAAgB;IAGlB;;;;;;;;;;;;;;;;;;;OAmBG;IACH,cAhBW,0BAA0B,GACxB,QAAQ,eAAe,EAAE,CAAC,CAyEtC;CACF;;;;;kBAzHa,MAAM;;;;kBACN,MAAM;;;;UACN,MAAM;;;;qBACN,MAAM;;;;gBACN,MAAM;;;;aACN,MAAM;;;;;;YAON,MAAM;;;;iBACN,MAAM;;;;oBACN,MAAM;;;;oBACN,MAAM;;;;sBACN,MAAM;;;;oBACN,MAAM;;;;mBACN,MAAM;;;;mBACN,MAAM;;;;qBACN,MAAM;;;;kBACN,MAAM;;;;wBACN,MAAM,GAAC,MAAM;;;;eACb,MAAM;;;;aACN,KAAK,GAAC,QAAQ"} \ No newline at end of file diff --git a/lib/types/enrichedProfile.d.ts b/lib/types/enrichedProfile.d.ts index 50a7f76..a012613 100644 --- a/lib/types/enrichedProfile.d.ts +++ b/lib/types/enrichedProfile.d.ts @@ -7,54 +7,54 @@ */ /** * @typedef EnrichedBusinessProfile - * @property {string} legalBusinessName - * @property {EnrichedProfileAddress} address - * @property {string} email - * @property {EnrichedProfilePhone} phone + * @property {string} legalBusinessName - Business's legal name + * @property {EnrichedProfileAddress} address - Business's address + * @property {string} email - Business's email + * @property {EnrichedProfilePhone} phone - Business's phone * @property {EnrichedProfileIndustry} industryCodes - Describes industry specific identifiers - * @property {string} website + * @property {string} website - Business's website * * @tag Enrichment */ /** * @typedef EnrichedIndividualProfile - * @property {EnrichedProfileName} name - * @property {string} email - * @property {EnrichedProfileAddress} address + * @property {EnrichedProfileName} name - Individual's name + * @property {string} email - Individual's email + * @property {EnrichedProfileAddress} address - Individual's address * * @tag Enrichment */ /** * @typedef EnrichedProfileAddress - * @property {string} addressLine1 - * @property {string} addressLine2 - * @property {string} city - * @property {string} stateOrProvince - * @property {string} postalCode - * @property {string} country + * @property {string} addressLine1 - Street address + * @property {string} addressLine2 - Unit number + * @property {string} city - 25 characters or less + * @property {string} stateOrProvince - 2 characters + * @property {string} postalCode - 5 characters + * @property {string} country - 2 characters * * @tag Enrichment */ /** * @typedef EnrichedProfileIndustry - Describes industry specific identifiers - * @property {string} naics - * @property {string} sic + * @property {string} naics - North American Industry Classification System + * @property {string} sic - Standard Industrial Classification * * @tag Enrichment */ /** * @typedef EnrichedProfileName - * @property {string} firstName - * @property {string} middleName - * @property {string} lastName - * @property {string} suffix + * @property {string} firstName - First name + * @property {string} middleName - Middle name + * @property {string} lastName - Last name + * @property {string} suffix - Suffix * * @tag Enrichment */ /** * @typedef EnrichedProfilePhone - * @property {string} number - * @property {string} countryCode + * @property {string} number - Phone number + * @property {string} countryCode - Country code * * @tag Enrichment */ @@ -71,6 +71,7 @@ export class EnrichedProfiles { private moov; /** * Gets enriched profile data. + * The `PROFILE_ENRICHMENT_READ` scope enum is required when making a request from the browser. * * @param {string} email - Email address associated with the profile. * @returns {Promise} @@ -97,44 +98,110 @@ export type EnrichedProfile = { business: EnrichedBusinessProfile; }; export type EnrichedBusinessProfile = { + /** + * - Business's legal name + */ legalBusinessName: string; + /** + * - Business's address + */ address: EnrichedProfileAddress; + /** + * - Business's email + */ email: string; + /** + * - Business's phone + */ phone: EnrichedProfilePhone; /** * - Describes industry specific identifiers */ industryCodes: EnrichedProfileIndustry; + /** + * - Business's website + */ website: string; }; export type EnrichedIndividualProfile = { + /** + * - Individual's name + */ name: EnrichedProfileName; + /** + * - Individual's email + */ email: string; + /** + * - Individual's address + */ address: EnrichedProfileAddress; }; export type EnrichedProfileAddress = { + /** + * - Street address + */ addressLine1: string; + /** + * - Unit number + */ addressLine2: string; + /** + * - 25 characters or less + */ city: string; + /** + * - 2 characters + */ stateOrProvince: string; + /** + * - 5 characters + */ postalCode: string; + /** + * - 2 characters + */ country: string; }; /** * - Describes industry specific identifiers */ export type EnrichedProfileIndustry = { + /** + * - North American Industry Classification System + */ naics: string; + /** + * - Standard Industrial Classification + */ sic: string; }; export type EnrichedProfileName = { + /** + * - First name + */ firstName: string; + /** + * - Middle name + */ middleName: string; + /** + * - Last name + */ lastName: string; + /** + * - Suffix + */ suffix: string; }; export type EnrichedProfilePhone = { + /** + * - Phone number + */ number: string; + /** + * - Country code + */ countryCode: string; }; //# sourceMappingURL=enrichedProfile.d.ts.map \ No newline at end of file diff --git a/lib/types/enrichedProfile.d.ts.map b/lib/types/enrichedProfile.d.ts.map index 6f6f20f..517416e 100644 --- a/lib/types/enrichedProfile.d.ts.map +++ b/lib/types/enrichedProfile.d.ts.map @@ -1 +1 @@ -{"version":3,"file":"enrichedProfile.d.ts","sourceRoot":"","sources":["../enrichedProfile.js"],"names":[],"mappings":"AAGA;;;;;;GAMG;AAEH;;;;;;;;;;GAUG;AAEH;;;;;;;GAOG;AAEH;;;;;;;;;;GAUG;AAEH;;;;;;GAMG;AAEH;;;;;;;;GAQG;AAEH;;;;;;GAMG;AAEH;;;GAGG;AACH;IACE,uBAMC;IALC;;;OAGG;IACH,aAAgB;IAGlB;;;;;;;;;;;;;;OAcG;IACH,WAZW,MAAM,GACJ,QAAQ,eAAe,CAAC,CAyBpC;CACF;;;;;gBA5Ga,yBAAyB;;;;cACzB,uBAAuB;;;uBAOvB,MAAM;aACN,sBAAsB;WACtB,MAAM;WACN,oBAAoB;;;;mBACpB,uBAAuB;aACvB,MAAM;;;UAON,mBAAmB;WACnB,MAAM;aACN,sBAAsB;;;kBAOtB,MAAM;kBACN,MAAM;UACN,MAAM;qBACN,MAAM;gBACN,MAAM;aACN,MAAM;;;;;;WAON,MAAM;SACN,MAAM;;;eAON,MAAM;gBACN,MAAM;cACN,MAAM;YACN,MAAM;;;YAON,MAAM;iBACN,MAAM"} \ No newline at end of file +{"version":3,"file":"enrichedProfile.d.ts","sourceRoot":"","sources":["../enrichedProfile.js"],"names":[],"mappings":"AAGA;;;;;;GAMG;AAEH;;;;;;;;;;GAUG;AAEH;;;;;;;GAOG;AAEH;;;;;;;;;;GAUG;AAEH;;;;;;GAMG;AAEH;;;;;;;;GAQG;AAEH;;;;;;GAMG;AAEH;;;GAGG;AACH;IACE,uBAMC;IALC;;;OAGG;IACH,aAAgB;IAGlB;;;;;;;;;;;;;;;OAeG;IACH,WAZW,MAAM,GACJ,QAAQ,eAAe,CAAC,CAyBpC;CACF;;;;;gBA7Ga,yBAAyB;;;;cACzB,uBAAuB;;;;;;uBAOvB,MAAM;;;;aACN,sBAAsB;;;;WACtB,MAAM;;;;WACN,oBAAoB;;;;mBACpB,uBAAuB;;;;aACvB,MAAM;;;;;;UAON,mBAAmB;;;;WACnB,MAAM;;;;aACN,sBAAsB;;;;;;kBAOtB,MAAM;;;;kBACN,MAAM;;;;UACN,MAAM;;;;qBACN,MAAM;;;;gBACN,MAAM;;;;aACN,MAAM;;;;;;;;;WAON,MAAM;;;;SACN,MAAM;;;;;;eAON,MAAM;;;;gBACN,MAAM;;;;cACN,MAAM;;;;YACN,MAAM;;;;;;YAON,MAAM;;;;iBACN,MAAM"} \ No newline at end of file diff --git a/lib/types/institutions.d.ts b/lib/types/institutions.d.ts index 5c86b4c..c85818e 100644 --- a/lib/types/institutions.d.ts +++ b/lib/types/institutions.d.ts @@ -8,8 +8,8 @@ * @property {string} recordTypeCode - RecordTypeCode The code indicating the ABA number to be used to route or send ACH items to the RDFI - 0 = Institution is a Federal Reserve Bank - 1 = Send items to customer routing number - 2 = Send items to customer using new routing number field * @property {string} revised - Revised Date of last revision: YYYYMMDD, or blank * @property {string} newRoutingNumber - Institution's new routing number resulting from a merger or renumber - * @property {string} customerName - * @property {string} phoneNumber + * @property {string} customerName - Customer's name + * @property {string} phoneNumber - Phone number * @property {string} statusCode - Code is based on the customers receiver code * @property {string} viewCode - ViewCode is current view * @property {ACHInstitutionLocation} location - Location is the delivery address @@ -63,7 +63,7 @@ * @typedef WireInstitution * @property {string} routingNumber - Routing number for an Wire institution * @property {string} telegraphicName - The short name of financial institution - * @property {string} customerName + * @property {string} customerName - Customer's name * @property {WireInstitutionLocation} location - Location is the delivery address * @property {string} fundsTransferStatus - Designates funds transfer status - Y - Eligible - N - Ineligible * @property {string} fundsSettlementOnlyStatus - Designates funds settlement only status - S - Settlement-Only @@ -98,8 +98,8 @@ /** * ACH and Wire Institution participants * @typedef InstitutionParticipants - * @property {ACHInstitution[]} [achParticipants] - * @property {WireInstitution[]} [wireParticipants] + * @property {ACHInstitution[]} [achParticipants] - Array of ACH institutions + * @property {WireInstitution[]} [wireParticipants] - Array of Wire institutions * * @tag Institutions */ @@ -112,8 +112,9 @@ export class Institutions { moov: any; /** * Get information on a financial institution for ACH + * The `FED_READ` scope enum is required when making a request from the browser. * - * @param {ACHInstitutionSearchCriteria} criteria - Criteria for available search parameters. + * @param {ACHInstitutionSearchCriteria} criteria - Criteria for available search parameters * @returns {Promise} * * @tag Institutions @@ -121,8 +122,9 @@ export class Institutions { getACHInstitution(criteria: ACHInstitutionSearchCriteria): Promise; /** * Get information on a financial institution for WIRE + * The `FED_READ` scope enum is required when making a request from the browser. * - * @param {ACHInstitutionSearchCriteria} criteria - Criteria for available search parameters. + * @param {ACHInstitutionSearchCriteria} criteria - Criteria for available search parameters * @returns {Promise} * * @tag Institutions @@ -130,8 +132,9 @@ export class Institutions { getWireInstitution(criteria: ACHInstitutionSearchCriteria): Promise; /** * Get information on a financial institution + * The `FED_READ` scope enum is required when making a request from the browser. * - * @param {ACHInstitutionSearchCriteria} criteria - Criteria for available search parameters. + * @param {ACHInstitutionSearchCriteria} criteria - Criteria for available search parameters * @param {string} rail - The specific rail to check on, 'ach' or 'wire'. * @returns {Promise} * @@ -167,7 +170,13 @@ export type ACHInstitution = { * - Institution's new routing number resulting from a merger or renumber */ newRoutingNumber: string; + /** + * - Customer's name + */ customerName: string; + /** + * - Phone number + */ phoneNumber: string; /** * - Code is based on the customers receiver code @@ -240,6 +249,9 @@ export type WireInstitution = { * - The short name of financial institution */ telegraphicName: string; + /** + * - Customer's name + */ customerName: string; /** * - Location is the delivery address @@ -279,7 +291,13 @@ export type WireInstitutionLocation = { * ACH and Wire Institution participants */ export type InstitutionParticipants = { + /** + * - Array of ACH institutions + */ achParticipants?: ACHInstitution[]; + /** + * - Array of Wire institutions + */ wireParticipants?: WireInstitution[]; }; //# sourceMappingURL=institutions.d.ts.map \ No newline at end of file diff --git a/lib/types/institutions.d.ts.map b/lib/types/institutions.d.ts.map index f9d32d0..19f4237 100644 --- a/lib/types/institutions.d.ts.map +++ b/lib/types/institutions.d.ts.map @@ -1 +1 @@ -{"version":3,"file":"institutions.d.ts","sourceRoot":"","sources":["../institutions.js"],"names":[],"mappings":"AAGA,wBAAwB;AAExB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AAEH;;;;;;;;;;GAUG;AAEH;;;;;;;;;GASG;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AAEH;;;;;;;GAOG;AAEH;;;;;;;GAOG;AAEH;;;GAGG;AACH;IACE,uBAEC;IADC,UAAgB;IAGlB;;;;;;;OAOG;IACH,4BALW,4BAA4B,GAC1B,QAAQ,uBAAuB,CAAC,CAM5C;IAED;;;;;;;OAOG;IACH,6BALW,4BAA4B,GAC1B,QAAQ,uBAAuB,CAAC,CAM5C;IAED;;;;;;;;OAQG;IACH,yBANW,4BAA4B,QAC5B,MAAM,GACJ,QAAQ,uBAAuB,CAAC,CA0B5C;CACF;;;;;;;;mBA5Ka,MAAM;;;;gBACN,MAAM;;;;wBACN,MAAM;;;;oBACN,MAAM;;;;aACN,MAAM;;;;sBACN,MAAM;kBACN,MAAM;iBACN,MAAM;;;;gBACN,MAAM;;;;cACN,MAAM;;;;cACN,sBAAsB;;;;;;;;;aA6BtB,MAAM;;;;UACN,MAAM;;;;WACN,MAAM;;;;gBACN,MAAM;;;;yBACN,MAAM;;;;;;;;;WAQN,MAAM;;;;oBACN,MAAM;;;;YACN,MAAM;;;;WACN,MAAM;;;;;;;;;mBAQN,MAAM;;;;qBACN,MAAM;kBACN,MAAM;;;;cACN,uBAAuB;;;;yBACvB,MAAM;;;;+BACN,MAAM;;;;uCACN,MAAM;;;;UACN,MAAM;;;;;;;;;UAuBN,MAAM;;;;WACN,MAAM;;;;;;sBAQN,cAAc,EAAE;uBAChB,eAAe,EAAE"} \ No newline at end of file +{"version":3,"file":"institutions.d.ts","sourceRoot":"","sources":["../institutions.js"],"names":[],"mappings":"AAGA,wBAAwB;AAExB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AAEH;;;;;;;;;;GAUG;AAEH;;;;;;;;;GASG;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AAEH;;;;;;;GAOG;AAEH;;;;;;;GAOG;AAEH;;;GAGG;AACH;IACE,uBAEC;IADC,UAAgB;IAGlB;;;;;;;;OAQG;IACH,4BALW,4BAA4B,GAC1B,QAAQ,uBAAuB,CAAC,CAM5C;IAED;;;;;;;;OAQG;IACH,6BALW,4BAA4B,GAC1B,QAAQ,uBAAuB,CAAC,CAM5C;IAED;;;;;;;;;OASG;IACH,yBANW,4BAA4B,QAC5B,MAAM,GACJ,QAAQ,uBAAuB,CAAC,CA0B5C;CACF;;;;;;;;mBA/Ka,MAAM;;;;gBACN,MAAM;;;;wBACN,MAAM;;;;oBACN,MAAM;;;;aACN,MAAM;;;;sBACN,MAAM;;;;kBACN,MAAM;;;;iBACN,MAAM;;;;gBACN,MAAM;;;;cACN,MAAM;;;;cACN,sBAAsB;;;;;;;;;aA6BtB,MAAM;;;;UACN,MAAM;;;;WACN,MAAM;;;;gBACN,MAAM;;;;yBACN,MAAM;;;;;;;;;WAQN,MAAM;;;;oBACN,MAAM;;;;YACN,MAAM;;;;WACN,MAAM;;;;;;;;;mBAQN,MAAM;;;;qBACN,MAAM;;;;kBACN,MAAM;;;;cACN,uBAAuB;;;;yBACvB,MAAM;;;;+BACN,MAAM;;;;uCACN,MAAM;;;;UACN,MAAM;;;;;;;;;UAuBN,MAAM;;;;WACN,MAAM;;;;;;;;;sBAQN,cAAc,EAAE;;;;uBAChB,eAAe,EAAE"} \ No newline at end of file diff --git a/lib/types/moov.d.ts b/lib/types/moov.d.ts index e3750ae..88c7efc 100644 --- a/lib/types/moov.d.ts +++ b/lib/types/moov.d.ts @@ -1,5 +1,5 @@ /** - * Available scopes to request on OAuth tokens. + * For client-side integration, you'll need to request scopes when generating an OAuth token. See available scopes below: */ export type SCOPES = any; export namespace SCOPES { diff --git a/lib/types/moov.d.ts.map b/lib/types/moov.d.ts.map index 54df751..8afd2d4 100644 --- a/lib/types/moov.d.ts.map +++ b/lib/types/moov.d.ts.map @@ -1 +1 @@ -{"version":3,"file":"moov.d.ts","sourceRoot":"","sources":["../moov.js"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;AA0IA;;;;GAIG;AACH,kCAsBE;AAiBF;;;GAGG;AACH;IACE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH;QAjB+B,SAAS,EAA7B,MAAM;QACc,SAAS,EAA7B,MAAM;QACc,SAAS,EAA7B,MAAM;QACc,MAAM,EAA1B,MAAM;8BACN,MAAM,EAqChB;IAjBC;mBAxBS,MAAM;mBACN,MAAM;mBACN,MAAM;gBACN,MAAM;MAqBe;IAC9B,eAAoB;IACpB,2BAUC;IAED,oBAAqB;IACrB,4BAAyB;IACzB,sBAAsB;IAGxB;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,sBAjBW,MAAM,EAAE,cACR,MAAM,GACJ,QAAQ,KAAK,CAAC,CAiD1B;IAED;;;;;;;;;;;;;OAaG;IACH,sBAKC;IAED;;;;;;;;;;;OAWG;IACH,yBAKC;IAED;;;;;;;;;;;;OAYG;IACH,uBAKC;IAHG,kBAAiC;IAKrC;;;;;;;;;;;OAWG;IACH,iCAKC;IAHG,4BAA2C;IAK/C;;;;;;;;;;;OAWG;IACH,iCAKC;IAED;;;;;;;;;;;OAWG;IACH,mBAKC;IAHG,cAA6B;IAKjC;;;;;;;;;;;OAWG;IACH,2CAKC;IAHG,sCAAqD;IAKzD;;;;;;;;;;;OAWG;IACH,yCAKC;IAHG,oCAAmD;IAKvD;;;;;;;;;;;OAWG;IACH,qCAKC;IAHG,gCAA+C;IAKnD;;;;;;;;;;;OAWG;IACH,iCAKC;IAHG,4BAA2C;IAK/C;;;;;;;;;;;;OAYG;IACH,uCAKC;IAHG,kCAAiD;IAKrD;;;;;;;;;;;;OAYG;IACH,2BAKC;IAED;;;;;;;;;;;;OAYG;IACH,uBAKC;IAHG,kBAAiC;IAKrC;;;;;OAKG;IACH,iBAgBC;CACF;;;;;;;;;WApZa,MAAM;;;;eACN,IAAI;;;;kBACJ,MAAM"} \ No newline at end of file +{"version":3,"file":"moov.d.ts","sourceRoot":"","sources":["../moov.js"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;AA0IA;;;;GAIG;AACH,kCAsBE;AAiBF;;;GAGG;AACH;IACE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH;QAjB+B,SAAS,EAA7B,MAAM;QACc,SAAS,EAA7B,MAAM;QACc,SAAS,EAA7B,MAAM;QACc,MAAM,EAA1B,MAAM;8BACN,MAAM,EAkChB;IAdC;mBAxBS,MAAM;mBACN,MAAM;mBACN,MAAM;gBACN,MAAM;MAqBe;IAC9B,eAAoB;IACpB,2BAOC;IAED,oBAAqB;IACrB,4BAAyB;IACzB,sBAAsB;IAGxB;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,sBAjBW,MAAM,EAAE,cACR,MAAM,GACJ,QAAQ,KAAK,CAAC,CAiD1B;IAED;;;;;;;;;;;;;OAaG;IACH,sBAKC;IAED;;;;;;;;;;;OAWG;IACH,yBAKC;IAED;;;;;;;;;;;;OAYG;IACH,uBAKC;IAHG,kBAAiC;IAKrC;;;;;;;;;;;OAWG;IACH,iCAKC;IAHG,4BAA2C;IAK/C;;;;;;;;;;;OAWG;IACH,iCAKC;IAED;;;;;;;;;;;OAWG;IACH,mBAKC;IAHG,cAA6B;IAKjC;;;;;;;;;;;OAWG;IACH,2CAKC;IAHG,sCAAqD;IAKzD;;;;;;;;;;;OAWG;IACH,yCAKC;IAHG,oCAAmD;IAKvD;;;;;;;;;;;OAWG;IACH,qCAKC;IAHG,gCAA+C;IAKnD;;;;;;;;;;;OAWG;IACH,iCAKC;IAHG,4BAA2C;IAK/C;;;;;;;;;;;;OAYG;IACH,uCAKC;IAHG,kCAAiD;IAKrD;;;;;;;;;;;;OAYG;IACH,2BAKC;IAED;;;;;;;;;;;;OAYG;IACH,uBAKC;IAHG,kBAAiC;IAKrC;;;;;OAKG;IACH,iBAgBC;CACF;;;;;;;;;WAjZa,MAAM;;;;eACN,IAAI;;;;kBACJ,MAAM"} \ No newline at end of file diff --git a/lib/types/paymentMethods.d.ts b/lib/types/paymentMethods.d.ts index dc2f383..3d5a80c 100644 --- a/lib/types/paymentMethods.d.ts +++ b/lib/types/paymentMethods.d.ts @@ -16,7 +16,7 @@ export namespace PAYMENT_METHODS_TYPE { /** * Describes a Payment Method. * @typedef PaymentMethod - * @property {string} paymentMethodID - Payment method identifier + * @property {string} paymentMethodID - Payment Method identifier * @property {PAYMENT_METHODS_TYPE} paymentMethodType - Fingerprint of Bank Account * @property {WalletPaymentType} [wallet] - Optional wallet object when payment method type is 'moov-wallet'. * @property {BankAccount} [bankAccount] - Optional bank account object when payment method type is one of 'ach-debit-fund', 'ach-debit-collect', ach-credit-standard', or 'ach-credit-same-day'. @@ -49,6 +49,7 @@ export class PaymentMethods { moov: any; /** * Get the specified payment method associated with a Moov account. + * The `PAYMENT_METHODS_READ` scope enum is required when making a request from the browser. * * @param {string} accountID - Account on which to request bank account * @param {string} paymentMethodID - ID of the payment method to retrieve. Can be one of `walletID`, `cardID`, or `bankAccountID`. @@ -59,6 +60,7 @@ export class PaymentMethods { get(accountID: string, paymentMethodID: string): Promise; /** * Retrieve all of the payment methods associated with a Moov account. + * The `PAYMENT_METHODS_READ` scope enum is required when making a request from the browser. * * @param {string} accountID - Account on which to request bank account * @returns {Promise} diff --git a/lib/types/paymentMethods.d.ts.map b/lib/types/paymentMethods.d.ts.map index c829d78..3e9ce3f 100644 --- a/lib/types/paymentMethods.d.ts.map +++ b/lib/types/paymentMethods.d.ts.map @@ -1 +1 @@ -{"version":3,"file":"paymentMethods.d.ts","sourceRoot":"","sources":["../paymentMethods.js"],"names":[],"mappings":";;;;;;;;;AA2CA;;;;;GAKG;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AAEH;;;GAGG;AACH;IACE,uBAEC;IADC,UAAgB;IAGlB;;;;;;;;OAQG;IACH,eANW,MAAM,mBACN,MAAM,GACJ,QAAQ,aAAa,CAAC,CAgBlC;IAED;;;;;;;OAOG;IACH,gBALW,MAAM,GACJ,QAAQ,aAAa,EAAE,CAAC,CAepC;CACF;;;;;;;;cApFa,MAAM;;;;;;;;;qBAON,MAAM;;;;;;;;aAEN,iBAAiB;;;;kBACjB,WAAW"} \ No newline at end of file +{"version":3,"file":"paymentMethods.d.ts","sourceRoot":"","sources":["../paymentMethods.js"],"names":[],"mappings":";;;;;;;;;AA2CA;;;;;GAKG;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AAEH;;;GAGG;AACH;IACE,uBAEC;IADC,UAAgB;IAGlB;;;;;;;;;OASG;IACH,eANW,MAAM,mBACN,MAAM,GACJ,QAAQ,aAAa,CAAC,CAgBlC;IAED;;;;;;;;OAQG;IACH,gBALW,MAAM,GACJ,QAAQ,aAAa,EAAE,CAAC,CAepC;CACF;;;;;;;;cAtFa,MAAM;;;;;;;;;qBAON,MAAM;;;;;;;;aAEN,iBAAiB;;;;kBACjB,WAAW"} \ No newline at end of file diff --git a/lib/types/representatives.d.ts b/lib/types/representatives.d.ts index 77af0b7..a178ec6 100644 --- a/lib/types/representatives.d.ts +++ b/lib/types/representatives.d.ts @@ -91,9 +91,9 @@ */ /** * @typedef RepresentativeBirthDate - * @property {number} day - * @property {number} month - * @property {number} year - 4 digit year + * @property {number} day - 1 or 2 digit day of birth + * @property {number} month - 1 or 2 digit month of birth + * @property {number} year - 4 digit year of birth * * @tag Representatives */ @@ -106,8 +106,8 @@ */ /** * @typedef RepresentativeGovernmentID - * @property {GovernmentID} ssn - * @property {GovernmentID} itin + * @property {GovernmentID} ssn - Social Security Number + * @property {GovernmentID} itin - Individual Taxpayer Identification Number * * @tag Representatives */ @@ -116,9 +116,9 @@ * @property {RepresentativeName} name - Name for an individual * @property {RepresentativePhone} phone - Phone for an individual * @property {string} email - Email Address. string <= 255 characters - * @property {RepresentativeAddress} address - Address for an individual. - * @property {RepresentativeBirthDate} birthDate - Birthdate for an individual - * @property {RepresentativeGovernmentID} governmentID + * @property {RepresentativeAddress} address - Address for an individual + * @property {RepresentativeBirthDate} birthDate - Birth date for an individual + * @property {RepresentativeGovernmentID} governmentID - Social Security Number, or Individual Taxpayer Identification Number * @property {RepresentativeResponsibilities} responsibilities - Describes the job responsibilities of an individual * * @tag Representatives @@ -132,6 +132,8 @@ export class Representatives { moov: any; /** * Create representative + * The `REPRESENTATIVE_WRITE` scope enum is required when making a request from the browser. + * * @param {string} accountID - Account on which to add representative * @param {RepresentativeCreateUpdate} representative - Representative to add * @returns {Promise} @@ -141,6 +143,8 @@ export class Representatives { create(accountID: string, representative: RepresentativeCreateUpdate): Promise; /** * List representatives + * The `REPRESENTATIVE_READ` scope enum is required when making a request from the browser. + * * @param {string} accountID - Account on which to add representative * @returns {Promise} * @@ -149,6 +153,8 @@ export class Representatives { list(accountID: string): Promise; /** * Retrieve a specific representative associated with a given Moov account. + * The `REPRESENTATIVE_READ` scope enum is required when making a request from the browser. + * * @param {string} accountID - Account on which to add representative * @param {string} representativeID - Identifier of representative to retrieve * @returns {Promise} @@ -158,6 +164,8 @@ export class Representatives { get(accountID: string, representativeID: string): Promise; /** * Deletes a business representative associated with a Moov account. + * The `REPRESENTATIVE_WRITE` scope enum is required when making a request from the browser. + * * @param {string} accountID - Account on which to add representative * @param {string} representativeID - Identifier of representative to retrieve * @returns {Promise} @@ -167,6 +175,8 @@ export class Representatives { delete(accountID: string, representativeID: string): Promise; /** * Update a specific representative. + * The `REPRESENTATIVE_WRITE` scope enum is required when making a request from the browser. + * * @param {string} accountID - Account on which to add representative * @param {string} representativeID - Identifier of representative to retrieve * @param {RepresentativeCreateUpdate} representative - Representative to add @@ -304,10 +314,16 @@ export type RepresentativeResponsibilities = { jobTitle: string; }; export type RepresentativeBirthDate = { + /** + * - 1 or 2 digit day of birth + */ day: number; + /** + * - 1 or 2 digit month of birth + */ month: number; /** - * - 4 digit year + * - 4 digit year of birth */ year: number; }; @@ -322,7 +338,13 @@ export type GovernmentID = { lastFour: string; }; export type RepresentativeGovernmentID = { + /** + * - Social Security Number + */ ssn: GovernmentID; + /** + * - Individual Taxpayer Identification Number + */ itin: GovernmentID; }; export type RepresentativeCreateUpdate = { @@ -339,13 +361,16 @@ export type RepresentativeCreateUpdate = { */ email: string; /** - * - Address for an individual. + * - Address for an individual */ address: RepresentativeAddress; /** - * - Birthdate for an individual + * - Birth date for an individual */ birthDate: RepresentativeBirthDate; + /** + * - Social Security Number, or Individual Taxpayer Identification Number + */ governmentID: RepresentativeGovernmentID; /** * - Describes the job responsibilities of an individual diff --git a/lib/types/representatives.d.ts.map b/lib/types/representatives.d.ts.map index abb5a4d..410111e 100644 --- a/lib/types/representatives.d.ts.map +++ b/lib/types/representatives.d.ts.map @@ -1 +1 @@ -{"version":3,"file":"representatives.d.ts","sourceRoot":"","sources":["../representatives.js"],"names":[],"mappings":"AAGA,wBAAwB;AAExB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmDG;AAEH;;;;;;;;;GASG;AAEH;;;;;;;GAOG;AAEH;;;;;;;;;;GAUG;AAEH;;;;;;;;GAQG;AAEH;;;;;;;GAOG;AAEH;;;;;;GAMG;AAEH;;;;;;GAMG;AAEH;;;;;;;;;;;GAWG;AAEH;;;GAGG;AACH;IACE,uBAEC;IADC,UAAgB;IAGlB;;;;;;;OAOG;IACH,kBANW,MAAM,kBACN,0BAA0B,GACxB,QAAQ,cAAc,CAAC,CAiBnC;IAED;;;;;;OAMG;IACH,gBALW,MAAM,GACJ,QAAQ,cAAc,EAAE,CAAC,CAerC;IAED;;;;;;;OAOG;IACH,eANW,MAAM,oBACN,MAAM,GACJ,QAAQ,cAAc,CAAC,CAgBnC;IAED;;;;;;;OAOG;IACH,kBANW,MAAM,oBACN,MAAM,GACJ,QAAQ,IAAI,CAAC,CAgBzB;IAED;;;;;;;;OAQG;IACH,kBAPW,MAAM,oBACN,MAAM,kBACN,0BAA0B,GACxB,QAAQ,cAAc,CAAC,CAkBnC;CACF;;;;;;;;sBA1Pa,MAAM;;;;UACN,kBAAkB;;;;WAClB,mBAAmB;;;;WACnB,MAAM;;;;aACN,qBAAqB;;;;uBACrB,OAAO;;;;0BACP,OAAO;;;;sBACP,8BAA8B;;;;eAC9B,IAAI;;;;eACJ,IAAI;;;;gBACJ,IAAI;;;;;;;;;eA2CJ,MAAM;;;;gBACN,MAAM;;;;cACN,MAAM;;;;YACN,MAAM;;;;;;;;;YAQN,MAAM;;;;iBACN,MAAM;;;;;;kBAON,MAAM;;;;kBACN,MAAM;;;;UACN,MAAM;;;;qBACN,MAAM;;;;gBACN,MAAM;;;;aACN,MAAM;;;;;;kBAON,OAAO;;;;aACP,OAAO;;;;yBACP,MAAM;;;;cACN,MAAM;;;SAON,MAAM;WACN,MAAM;;;;UACN,MAAM;;;;;;UAON,MAAM;;;;cACN,MAAM;;;SAON,YAAY;UACZ,YAAY;;;;;;UAOZ,kBAAkB;;;;WAClB,mBAAmB;;;;WACnB,MAAM;;;;aACN,qBAAqB;;;;eACrB,uBAAuB;kBACvB,0BAA0B;;;;sBAC1B,8BAA8B"} \ No newline at end of file +{"version":3,"file":"representatives.d.ts","sourceRoot":"","sources":["../representatives.js"],"names":[],"mappings":"AAGA,wBAAwB;AAExB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmDG;AAEH;;;;;;;;;GASG;AAEH;;;;;;;GAOG;AAEH;;;;;;;;;;GAUG;AAEH;;;;;;;;GAQG;AAEH;;;;;;;GAOG;AAEH;;;;;;GAMG;AAEH;;;;;;GAMG;AAEH;;;;;;;;;;;GAWG;AAEH;;;GAGG;AACH;IACE,uBAEC;IADC,UAAgB;IAGlB;;;;;;;;;OASG;IACH,kBANW,MAAM,kBACN,0BAA0B,GACxB,QAAQ,cAAc,CAAC,CAiBnC;IAED;;;;;;;;OAQG;IACH,gBALW,MAAM,GACJ,QAAQ,cAAc,EAAE,CAAC,CAerC;IAED;;;;;;;;;OASG;IACH,eANW,MAAM,oBACN,MAAM,GACJ,QAAQ,cAAc,CAAC,CAgBnC;IAED;;;;;;;;;OASG;IACH,kBANW,MAAM,oBACN,MAAM,GACJ,QAAQ,IAAI,CAAC,CAgBzB;IAED;;;;;;;;;;OAUG;IACH,kBAPW,MAAM,oBACN,MAAM,kBACN,0BAA0B,GACxB,QAAQ,cAAc,CAAC,CAkBnC;CACF;;;;;;;;sBApQa,MAAM;;;;UACN,kBAAkB;;;;WAClB,mBAAmB;;;;WACnB,MAAM;;;;aACN,qBAAqB;;;;uBACrB,OAAO;;;;0BACP,OAAO;;;;sBACP,8BAA8B;;;;eAC9B,IAAI;;;;eACJ,IAAI;;;;gBACJ,IAAI;;;;;;;;;eA2CJ,MAAM;;;;gBACN,MAAM;;;;cACN,MAAM;;;;YACN,MAAM;;;;;;;;;YAQN,MAAM;;;;iBACN,MAAM;;;;;;kBAON,MAAM;;;;kBACN,MAAM;;;;UACN,MAAM;;;;qBACN,MAAM;;;;gBACN,MAAM;;;;aACN,MAAM;;;;;;kBAON,OAAO;;;;aACP,OAAO;;;;yBACP,MAAM;;;;cACN,MAAM;;;;;;SAON,MAAM;;;;WACN,MAAM;;;;UACN,MAAM;;;;;;UAON,MAAM;;;;cACN,MAAM;;;;;;SAON,YAAY;;;;UACZ,YAAY;;;;;;UAOZ,kBAAkB;;;;WAClB,mBAAmB;;;;WACnB,MAAM;;;;aACN,qBAAqB;;;;eACrB,uBAAuB;;;;kBACvB,0BAA0B;;;;sBAC1B,8BAA8B"} \ No newline at end of file diff --git a/lib/types/transfers.d.ts b/lib/types/transfers.d.ts index 96732d3..310257d 100644 --- a/lib/types/transfers.d.ts +++ b/lib/types/transfers.d.ts @@ -1,131 +1,132 @@ /** * @typedef CardDetails * @type {object} - * @property {string} dynamicDescriptor -An optional override of the default card statement descriptor for a single transfer. + * @property {string} dynamicDescriptor - An optional override of the default card statement descriptor for a single transfer * @property {"recurring"|"unscheduled"|null} merchantInitiatedType - Enum: [recurring unscheduled] Describes how the card transaction was initiated * @tag Cards */ /** * High-level account information associated with a payment method. * @typedef PaymentMethodAccount - * @property {string} accountID - * @property {string} email - * @property {string} displayName + * @property {string} accountID - Payment method identifier + * @property {string} email - Email associated with the payment method + * @property {string} displayName - Display name associated with the payment method * @tag Transfers */ /** * @typedef BankAccount - * @property {string} bankAccountID - * @property {string} fingerprint - * @property {"new"|"verified"|"verificationFailed"|"pending"|"errored"} status - * @property {string} holderName - * @property {"individual"|"business"} holderType - * @property {string} bankName + * @property {string} bankAccountID - Bank Account identifier + * @property {string} fingerprint - Fingerprint of the bank account + * @property {"new"|"verified"|"verificationFailed"|"pending"|"errored"} status - Bank account status + * @property {string} holderName - Name of the account holder + * @property {"individual"|"business"} holderType - Type of holder on a funding source + * @property {string} bankName - Name of the bank * @property {"checking"|"savings"|"unknown"} bankAccountType - * @property {string} routingNumber - * @property {string} lastFourAccountNumber + * @property {string} routingNumber - Bank account routing number + * @property {string} lastFourAccountNumber - Last four digits of the bank account number * @tag Transfers */ /** * @typedef Wallet - * @property {string} walletID + * @property {string} walletID - Wallet identifier * @tag Transfers */ /** * @typedef CardExpiration - * @property {string} month Two-character month - * @property {string} year Two-character year + * @property {string} month 2 characters + * @property {string} year 2 characters * @tag Transfers */ /** * The results of submitting cardholder data to a card network for verification. * @typedef CardVerification - * @property {"noMatch"|"match"|"notChecked"|"unavailable"} cvv - * @property {"noMatch"|"match"|"notChecked"|"unavailable"} addressLine1 - * @property {"noMatch"|"match"|"notChecked"|"unavailable"} postalCode + * @property {"noMatch"|"match"|"notChecked"|"unavailable"} cvv - Card Verification Value status + * @property {"noMatch"|"match"|"notChecked"|"unavailable"} addressLine1 - Address status + * @property {"noMatch"|"match"|"notChecked"|"unavailable"} postalCode - Postal code status * @tag Transfers */ /** * @typedef Card - * @property {string} cardID - * @property {string} fingerprint - * @property {"American Express"|"Discover"|"MasterCard"|"Visa"} brand - * @property {"debit"|"credit"|"prepaid"|"unknown"} cardType - * @property {string} lastFourCardNumber - * @property {string} bin - * @property {CardExpiration} expiration - * @property {string} holderName - * @property {Address} billingAddress - * @property {CardVerification} cardVerification + * @property {string} cardID - Card identifier + * @property {string} fingerprint - Fingerprint of the card + * @property {"American Express"|"Discover"|"MasterCard"|"Visa"} brand - Card brand + * @property {"debit"|"credit"|"prepaid"|"unknown"} cardType - Card type + * @property {string} lastFourCardNumber - Last four digits of the card number + * @property {string} bin - Bank Identification Number + * @property {CardExpiration} expiration - The card's expiration date + * @property {string} holderName - The cardholder's name + * @property {Address} billingAddress - The billing address associated with the card + * @property {CardVerification} cardVerification - The results of submitting cardholder data to a card network for verification * @tag Transfers */ /** * Models the reason for an ACH return or correction. * @typedef ACHCode - * @property {string} code - * @property {string} reason - * @property {string} description + * @property {string} code - Ach return code (for example, R01) + * @property {string} reason - The network's reason for the return or correction (for example, insufficient funds) + * @property {string} description - Explanation of the return code and reason * @tag Transfers */ /** * @typedef ACHDetails - * @property {"initiated"|"originated"|"corrected"|"returned"|"completed"} - * @property {string} traceNumber - * @property {ACHCode} [return] - * @property {ACHCode} [correction] + * @property {"initiated"|"originated"|"corrected"|"returned"|"completed"} status - ACH rail status + * @property {string} traceNumber - Tracking number that can be used by payment recipient to trace the payment with their external financial institution + * @property {ACHCode} [return] - ACH return information per Nacha specification + * @property {ACHCode} [correction] - ACH notification of change information per Nacha specification * @tag Transfers */ /** * @typedef PaymentMethod - * @property {string} paymentMethodID - * @property {"moov-wallet"|"ach-debit-fund"|"ach-debit-collect"|"ach-credit-standard"|"ach-credit-same-day"|"rtp-credit"|"card-payment"} paymentMethodType - * @property {PaymentMethodAccount} account - * @property {BankAccount} [bankAccount] - * @property {Wallet} [wallet] - * @property {Card} [card] - * @property {ACHDetails} [achDetails] - * @property {CardDetails} [cardDetails] + * @property {string} paymentMethodID - Payment method identifier + * @property {"moov-wallet"|"ach-debit-fund"|"ach-debit-collect"|"ach-credit-standard"|"ach-credit-same-day"|"rtp-credit"|"card-payment"} paymentMethodType - Allowed payment method types + * @property {PaymentMethodAccount} account - Account information associated with the payment method + * @property {BankAccount} [bankAccount] - Optional bank account object when payment method type is one of `ach-debit-fund`, `ach-debit-collect`, `ach-credit-standard`, or `ach-credit-same-day` + * @property {Card} [card] - Optional card object when payment method type is one of `card-payment` or `apple-pay` + * @property {Wallet} [wallet] - Optional wallet object when payment method type is `moov-wallet` + * @property {ACHDetails} [achDetails] - Information about ACH transfers and status details + * @property {CardDetails} [cardDetails] - Statement descriptor and recurring flag for card payments * @tag Transfers */ /** * @typedef Amount * @property {number} value - Integer quantity in the smallest unit of the specified currency. In USD this is cents, so $12.04 is 1204 and $0.99 would be 99. - * @property {string} currency - Three-letter ISO 4217 currency code + * @property {string} currency - 3 letter ISO 4217 currency code * @tag Transfers */ /** * @typedef Refund - * @property {string} refundID - * @property {string} createdOn - * @property {string} updatedOn - * @property {"created"|"pending"|"completed"|"failed"} status - * @property {Amount} amount + * @property {string} refundID - Refund identifier + * @property {string} createdOn - Date-time the refund was created on + * @property {string} updatedOn - Date-time the refund was updated on + * @property {"created"|"pending"|"completed"|"failed"} status - Refund status + * @property {Amount} amount - Refund amount * @tag Transfers */ /** * @typedef Transfer - * @property {string} transferID - * @property {string} createdAt - * @property {"created"|"pending"|"completed"|"failed"|"reversed"} status - * @property {PaymentMethod} source - * @property {PaymentMethod} destination - * @property {Amount} amount - * @property {string} description + * @property {string} transferID - Transfer identifier + * @property {string} createdAt - Deprecated (now createdOn) + * @property {string} createdOn - Date-time the transfer was created on + * @property {"created"|"pending"|"completed"|"failed"|"reversed"} status - Transfer status + * @property {PaymentMethod} source - `paymentMethodID` or `transferID` + * @property {PaymentMethod} destination - `paymentMethodID` + * @property {Amount} amount - Transfer amount + * @property {string} description - Transfer description (128 characters max) * @property {object} metadata - Arbitrary key-value pairs - * @property {Amount} [refundedAmount] - * @property {Refund[]} refunds - * @property {object} facilitatorFee + * @property {Amount} [refundedAmount] - The total refunded amount + * @property {Refund[]} refunds - Array of refunds associated with the transfer + * @property {object} facilitatorFee - Total or markup fee * @property {number} moovFee - Integer quantity of Moov fee in USD, so $0.11 would be 11 * @property {string} moovFeeDecimal - The precise fee charged - supports up to 9 decimals * @tag Transfers */ /** * @typedef TransferCreate - * @property {PaymentMethod} source - * @property {PaymentMethod} destination - * @property {Amount} amount - * @property {object} facilitatorFee - * @property {string} description + * @property {PaymentMethod} source - `paymentMethodID` or `transferID` + * @property {PaymentMethod} destination - `paymentMethodID` + * @property {Amount} amount - Transfer amount represented by an integer value and its currency + * @property {object} facilitatorFee - Total or markup fee + * @property {string} description - Transfer description (128 characters max) * @property {object} metadata - Arbitrary key-value pairs * * @example @@ -155,7 +156,7 @@ */ /** * @typedef TransferResponse - * @property {string} transferID + * @property {string} transferID - Transfer identifier * * @example * { @@ -177,37 +178,37 @@ * Criteria for finding available payment types for a transfer. * * @typedef TransferOptionsCriteria - * @property {object} [source] - * @property {string} [source.accountID] - * @property {string} [source.paymentMethodID] - * @property {object} [destination] - * @property {string} [destination.accountID] - * @property {string} [destination.paymentMethodID] - * @property {Amount} amount + * @property {object} [source] - `accountID` or `paymentMethodID` + * @property {string} [source.accountID] - `accountID` associated with the transfer source + * @property {string} [source.paymentMethodID] - `paymentMethodID` associated with the transfer source + * @property {object} [destination] - `accountID` or `paymentMethodID` + * @property {string} [destination.accountID] - `accountID` associated with the transfer destination + * @property {string} [destination.paymentMethodID] - `paymentMethodID` associated with the transfer destination + * @property {Amount} amount - Transfer amount represented by an integer value and its currency * @tag Transfers */ /** * @typedef TransferOptions - * @property {string} paymentMethodID + * @property {string} paymentMethodID - `paymentMethodID` associated with a transfer * @property {"moov-wallet"|"ach-debit-fund"|"ach-debit-collect"|"ach-credit-standard"|"ach-credit-same-day"|"rtp-credit"|"card-payment"} paymentMethodType - * @property {Wallet} wallet - Populated when `paymentMethodType` is "moov-wallet" + * @property {Wallet} wallet - Populated when `paymentMethodType` is `moov-wallet` * @property {BankAccount} bankAccount - Populated when `paymentMethodType` is one of the ACH or FTP variations - * @property {Card} card - Populated when `paymentMethodType` is "card-payment" + * @property {Card} card - Populated when `paymentMethodType` is `card-payment` * @tag Transfers */ /** * @typedef AvailableTransferOptions - * @property {TransferOptions[]} sourceOptions - * @property {TransferOptions[]} destinationOptions + * @property {TransferOptions[]} sourceOptions - Array of available payment methods for the source of a transfer + * @property {TransferOptions[]} destinationOptions - Array of available payment methods for the destination of a transfer * @tag Transfers */ /** * @typedef Refund - * @property {string} refundID - * @property {string} createdOn - * @property {string} updatedOn - * @property {"created"|"pending"|"completed"|"failed"} status - * @property {Amount} amount + * @property {string} refundID - Refund identifier + * @property {string} createdOn - Date-time the refund was created on + * @property {string} updatedOn - Date-time the refund was updated on + * @property {"created"|"pending"|"completed"|"failed"} status - Refund status + * @property {Amount} amount - Refund amount * @tag Transfers */ /** @@ -223,6 +224,7 @@ export class Transfers { private moov; /** * Creates a transfer to move money from a source to a destination. + * The `TRANSFERS_WRITE` scope enum is required when making a request from the browser. * * @param {TransferCreate} transfer - Subset of the Transfer object * @param {string} [idempotencyKey] - Optional UUID to prevent duplicate transfers @@ -253,8 +255,9 @@ export class Transfers { create(transfer: TransferCreate, idempotencyKey?: string): Promise; /** * Lists transfers that match the given criteria. + * The `TRANSFERS_READ` scope enum is required when making a request from the browser. * - * @param {TransferListCriteria} [criteria] + * @param {TransferListCriteria} [criteria] - Optional properties by which to query and filter a transfer list * @returns {Promise} - Matching transfers * @tag Transfers * @@ -277,8 +280,9 @@ export class Transfers { list(criteria?: TransferListCriteria): Promise; /** * Gets the details of a transfer. + * The `TRANSFERS_READ` scope enum is required when making a request from the browser. * - * @param {string} transferID + * @param {string} transferID - Transfer identifier * @returns {Promise} * @tag Transfers * @@ -293,8 +297,9 @@ export class Transfers { get(transferID: string): Promise; /** * Update the metadata on a transfer. + * The `TRANSFERS_WRITE` scope enum is required when making a request from the browser. * - * @param {string} transferID + * @param {string} transferID - Transfer identifier * @param {object} metadata - Arbitrary key-value pairs * @returns {Promise} * @tag Transfers @@ -313,6 +318,7 @@ export class Transfers { updateMetadata(transferID: string, metadata: object): Promise; /** * Gets the available payment options for a transfer. + * The `TRANSFERS_READ` scope enum is required when making a request from the browser. * * @param {TransferOptionsCriteria} transferOptionsCriteria - Criteria for available payment options * @returns {Promise} @@ -342,8 +348,9 @@ export class Transfers { getTransferOptions(transferOptionsCriteria: TransferOptionsCriteria): Promise; /** * Initiate a refund for a card transfer. + * The `TRANSFERS_WRITE` scope enum is required when making a request from the browser. * - * @param {string} transferID + * @param {string} transferID - Transfer identifier * @param {string} [idempotencyKey] - Optional UUID to prevent duplicate refunds * @returns {Promise} * @tag Transfers @@ -351,16 +358,20 @@ export class Transfers { * @example * const moov = new Moov(...); * try { - * const { transferID } = moov.transfers.refund("..."); + * const { transferID } = moov.transfers.refund( + * "...", + * { amount: 200 } // omit if creating a refund for the full amount + * ); * } catch (err) { * // ... * } */ - refund(transferID: string, idempotencyKey?: string): Promise; + refund(transferID: string, idempotencyKey?: string, refund: any): Promise; /** * List refunds for a card transfer. + * The `TRANSFERS_READ` scope enum is required when making a request from the browser. * - * @param {string} transferID + * @param {string} transferID - Transfer identifier * @returns {Promise} * @tag Transfers * @@ -375,9 +386,10 @@ export class Transfers { listRefunds(transferID: string): Promise; /** * Get details of a specific refund. + * The `TRANSFERS_READ` scope enum is required when making a request from the browser. * - * @param {string} transferID - * @param {string} refundID + * @param {string} transferID - Transfer identifier + * @param {string} refundID - Refund identifier * @returns {Promise} * @tag Transfers * @@ -393,7 +405,7 @@ export class Transfers { } export type CardDetails = { /** - * -An optional override of the default card statement descriptor for a single transfer + * - An optional override of the default card statement descriptor for a single transfer */ dynamicDescriptor: string; /** @@ -405,31 +417,67 @@ export type CardDetails = { * High-level account information associated with a payment method. */ export type PaymentMethodAccount = { + /** + * - Payment method identifier + */ accountID: string; + /** + * - Email associated with the payment method + */ email: string; + /** + * - Display name associated with the payment method + */ displayName: string; }; export type BankAccount = { + /** + * - Bank Account identifier + */ bankAccountID: string; + /** + * - Fingerprint of the bank account + */ fingerprint: string; + /** + * - Bank account status + */ status: "new" | "verified" | "verificationFailed" | "pending" | "errored"; + /** + * - Name of the account holder + */ holderName: string; + /** + * - Type of holder on a funding source + */ holderType: "individual" | "business"; + /** + * - Name of the bank + */ bankName: string; bankAccountType: "checking" | "savings" | "unknown"; + /** + * - Bank account routing number + */ routingNumber: string; + /** + * - Last four digits of the bank account number + */ lastFourAccountNumber: string; }; export type Wallet = { + /** + * - Wallet identifier + */ walletID: string; }; export type CardExpiration = { /** - * Two-character month + * 2 characters */ month: string; /** - * Two-character year + * 2 characters */ year: string; }; @@ -437,44 +485,128 @@ export type CardExpiration = { * The results of submitting cardholder data to a card network for verification. */ export type CardVerification = { + /** + * - Card Verification Value status + */ cvv: "noMatch" | "match" | "notChecked" | "unavailable"; + /** + * - Address status + */ addressLine1: "noMatch" | "match" | "notChecked" | "unavailable"; + /** + * - Postal code status + */ postalCode: "noMatch" | "match" | "notChecked" | "unavailable"; }; export type Card = { + /** + * - Card identifier + */ cardID: string; + /** + * - Fingerprint of the card + */ fingerprint: string; + /** + * - Card brand + */ brand: "American Express" | "Discover" | "MasterCard" | "Visa"; + /** + * - Card type + */ cardType: "debit" | "credit" | "prepaid" | "unknown"; + /** + * - Last four digits of the card number + */ lastFourCardNumber: string; + /** + * - Bank Identification Number + */ bin: string; + /** + * - The card's expiration date + */ expiration: CardExpiration; + /** + * - The cardholder's name + */ holderName: string; + /** + * - The billing address associated with the card + */ billingAddress: Address; + /** + * - The results of submitting cardholder data to a card network for verification + */ cardVerification: CardVerification; }; /** * Models the reason for an ACH return or correction. */ export type ACHCode = { + /** + * - Ach return code (for example, R01) + */ code: string; + /** + * - The network's reason for the return or correction (for example, insufficient funds) + */ reason: string; + /** + * - Explanation of the return code and reason + */ description: string; }; export type ACHDetails = { - "": "initiated" | "originated" | "corrected" | "returned" | "completed"; + /** + * - ACH rail status + */ + status: "initiated" | "originated" | "corrected" | "returned" | "completed"; + /** + * - Tracking number that can be used by payment recipient to trace the payment with their external financial institution + */ traceNumber: string; + /** + * - ACH return information per Nacha specification + */ return?: ACHCode; + /** + * - ACH notification of change information per Nacha specification + */ correction?: ACHCode; }; export type PaymentMethod = { + /** + * - Payment method identifier + */ paymentMethodID: string; + /** + * - Allowed payment method types + */ paymentMethodType: "moov-wallet" | "ach-debit-fund" | "ach-debit-collect" | "ach-credit-standard" | "ach-credit-same-day" | "rtp-credit" | "card-payment"; + /** + * - Account information associated with the payment method + */ account: PaymentMethodAccount; + /** + * - Optional bank account object when payment method type is one of `ach-debit-fund`, `ach-debit-collect`, `ach-credit-standard`, or `ach-credit-same-day` + */ bankAccount?: BankAccount; - wallet?: Wallet; + /** + * - Optional card object when payment method type is one of `card-payment` or `apple-pay` + */ card?: Card; + /** + * - Optional wallet object when payment method type is `moov-wallet` + */ + wallet?: Wallet; + /** + * - Information about ACH transfers and status details + */ achDetails?: ACHDetails; + /** + * - Statement descriptor and recurring flag for card payments + */ cardDetails?: CardDetails; }; export type Amount = { @@ -483,42 +615,110 @@ export type Amount = { */ value: number; /** - * - Three-letter ISO 4217 currency code + * - 3 letter ISO 4217 currency code */ currency: string; }; export type Refund = { + /** + * - Refund identifier + */ refundID: string; + /** + * - Date-time the refund was created on + */ createdOn: string; + /** + * - Date-time the refund was updated on + */ updatedOn: string; + /** + * - Refund status + */ status: "created" | "pending" | "completed" | "failed"; + /** + * - Refund amount + */ amount: Amount; }; export type Transfer = { + /** + * - Transfer identifier + */ transferID: string; + /** + * - Deprecated (now createdOn) + */ createdAt: string; + /** + * - Date-time the transfer was created on + */ + createdOn: string; + /** + * - Transfer status + */ status: "created" | "pending" | "completed" | "failed" | "reversed"; + /** + * - `paymentMethodID` or `transferID` + */ source: PaymentMethod; + /** + * - `paymentMethodID` + */ destination: PaymentMethod; + /** + * - Transfer amount + */ amount: Amount; + /** + * - Transfer description (128 characters max) + */ description: string; /** * - Arbitrary key-value pairs */ metadata: object; + /** + * - The total refunded amount + */ refundedAmount?: Amount; + /** + * - Array of refunds associated with the transfer + */ refunds: Refund[]; + /** + * - Total or markup fee + */ facilitatorFee: object; /** * - Integer quantity of Moov fee in USD, so $0.11 would be 11 */ moovFee: number; + /** + * - The precise fee charged - supports up to 9 decimals + */ + moovFeeDecimal: string; }; export type TransferCreate = { + /** + * - `paymentMethodID` or `transferID` + */ source: PaymentMethod; + /** + * - `paymentMethodID` + */ destination: PaymentMethod; + /** + * - Transfer amount represented by an integer value and its currency + */ amount: Amount; + /** + * - Total or markup fee + */ facilitatorFee: object; + /** + * - Transfer description (128 characters max) + */ description: string; /** * - Arbitrary key-value pairs @@ -526,6 +726,9 @@ export type TransferCreate = { metadata: object; }; export type TransferResponse = { + /** + * - Transfer identifier + */ transferID: string; }; export type TransferListCriteria = { @@ -558,21 +761,33 @@ export type TransferListCriteria = { * Criteria for finding available payment types for a transfer. */ export type TransferOptionsCriteria = { + /** + * - `accountID` or `paymentMethodID` + */ source?: { accountID?: string; paymentMethodID?: string; }; + /** + * - `accountID` or `paymentMethodID` + */ destination?: { accountID?: string; paymentMethodID?: string; }; + /** + * - Transfer amount represented by an integer value and its currency + */ amount: Amount; }; export type TransferOptions = { + /** + * - `paymentMethodID` associated with a transfer + */ paymentMethodID: string; paymentMethodType: "moov-wallet" | "ach-debit-fund" | "ach-debit-collect" | "ach-credit-standard" | "ach-credit-same-day" | "rtp-credit" | "card-payment"; /** - * - Populated when `paymentMethodType` is "moov-wallet" + * - Populated when `paymentMethodType` is `moov-wallet` */ wallet: Wallet; /** @@ -580,12 +795,18 @@ export type TransferOptions = { */ bankAccount: BankAccount; /** - * - Populated when `paymentMethodType` is "card-payment" + * - Populated when `paymentMethodType` is `card-payment` */ card: Card; }; export type AvailableTransferOptions = { + /** + * - Array of available payment methods for the source of a transfer + */ sourceOptions: TransferOptions[]; + /** + * - Array of available payment methods for the destination of a transfer + */ destinationOptions: TransferOptions[]; }; import { Address } from "./address.js"; diff --git a/lib/types/transfers.d.ts.map b/lib/types/transfers.d.ts.map index 63120d9..0472a49 100644 --- a/lib/types/transfers.d.ts.map +++ b/lib/types/transfers.d.ts.map @@ -1 +1 @@ -{"version":3,"file":"transfers.d.ts","sourceRoot":"","sources":["../transfers.js"],"names":[],"mappings":"AAKA;;;;;;GAMG;AAEH;;;;;;;GAOG;AAEH;;;;;;;;;;;;GAYG;AAEH;;;;GAIG;AAEH;;;;;GAKG;AAEH;;;;;;;GAOG;AAEH;;;;;;;;;;;;;GAaG;AAEH;;;;;;;GAOG;AAEH;;;;;;;GAOG;AAEH;;;;;;;;;;;GAWG;AAEH;;;;;GAKG;AAEH;;;;;;;;GAQG;AAEH;;;;;;;;;;;;;;;GAeG;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AAEH;;;;;;;;;GASG;AAEH;;;;;;;;;GASG;AAEH;;;;;;;;;;;;GAYG;AAEH;;;;;;;;GAQG;AAEH;;;;;GAKG;AAEH;;;;;;;;GAQG;AAEH;;;GAGG;AACH;IACE,uBAMC;IALC;;;OAGG;IACH,aAAgB;IAGlB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,iBA3BW,cAAc,mBACd,MAAM,GACJ,QAAQ,gBAAgB,CAAC,CA0CrC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,gBApBW,oBAAoB,GAClB,QAAQ,QAAQ,EAAE,CAAC,CAqD/B;IAED;;;;;;;;;;;;;;OAcG;IACH,gBAZW,MAAM,GACJ,QAAQ,QAAQ,CAAC,CAsB7B;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,2BAhBW,MAAM,YACN,MAAM,GACJ,QAAQ,QAAQ,CAAC,CA4B7B;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,4CAzBW,uBAAuB,GACrB,QAAQ,wBAAwB,CAAC,CAoC7C;IAED;;;;;;;;;;;;;;;OAeG;IACH,mBAbW,MAAM,mBACN,MAAM,GACJ,QAAQ,gBAAgB,CAAC,CA2BrC;IAED;;;;;;;;;;;;;;OAcG;IACH,wBAZW,MAAM,GACJ,QAAQ,MAAM,EAAE,CAAC,CAsB7B;IAED;;;;;;;;;;;;;;;OAeG;IACH,sBAbW,MAAM,YACN,MAAM,GACJ,QAAQ,MAAM,CAAC,CAuB3B;CACF;;;;;uBAliBa,MAAM;;;;2BACN,WAAW,GAAC,aAAa,GAAC,IAAI;;;;;;eAO9B,MAAM;WACN,MAAM;iBACN,MAAM;;;mBAMN,MAAM;iBACN,MAAM;YACN,KAAK,GAAC,UAAU,GAAC,oBAAoB,GAAC,SAAS,GAAC,SAAS;gBACzD,MAAM;gBACN,YAAY,GAAC,UAAU;cACvB,MAAM;qBACN,UAAU,GAAC,SAAS,GAAC,SAAS;mBAC9B,MAAM;2BACN,MAAM;;;cAMN,MAAM;;;;;;WAMN,MAAM;;;;UACN,MAAM;;;;;;SAON,SAAS,GAAC,OAAO,GAAC,YAAY,GAAC,aAAa;kBAC5C,SAAS,GAAC,OAAO,GAAC,YAAY,GAAC,aAAa;gBAC5C,SAAS,GAAC,OAAO,GAAC,YAAY,GAAC,aAAa;;;YAM5C,MAAM;iBACN,MAAM;WACN,kBAAkB,GAAC,UAAU,GAAC,YAAY,GAAC,MAAM;cACjD,OAAO,GAAC,QAAQ,GAAC,SAAS,GAAC,SAAS;wBACpC,MAAM;SACN,MAAM;gBACN,cAAc;gBACd,MAAM;oBACN,OAAO;sBACP,gBAAgB;;;;;;UAOhB,MAAM;YACN,MAAM;iBACN,MAAM;;;QAMN,WAAW,GAAC,YAAY,GAAC,WAAW,GAAC,UAAU,GAAC,WAAW;iBAC3D,MAAM;aACN,OAAO;iBACP,OAAO;;;qBAMP,MAAM;uBACN,aAAa,GAAC,gBAAgB,GAAC,mBAAmB,GAAC,qBAAqB,GAAC,qBAAqB,GAAC,YAAY,GAAC,cAAc;aAC1H,oBAAoB;kBACpB,WAAW;aACX,MAAM;WACN,IAAI;iBACJ,UAAU;kBACV,WAAW;;;;;;WAMX,MAAM;;;;cACN,MAAM;;;cAMN,MAAM;eACN,MAAM;eACN,MAAM;YACN,SAAS,GAAC,SAAS,GAAC,WAAW,GAAC,QAAQ;YACxC,MAAM;;;gBAMN,MAAM;eACN,MAAM;YACN,SAAS,GAAC,SAAS,GAAC,WAAW,GAAC,QAAQ,GAAC,UAAU;YACnD,aAAa;iBACb,aAAa;YACb,MAAM;iBACN,MAAM;;;;cACN,MAAM;qBACN,MAAM;aACN,MAAM,EAAE;oBACR,MAAM;;;;aACN,MAAM;;;YAMN,aAAa;iBACb,aAAa;YACb,MAAM;oBACN,MAAM;iBACN,MAAM;;;;cACN,MAAM;;;gBA+BN,MAAM;;;;;;iBAWN,MAAM,EAAE;;;;aACR,MAAM;;;;oBACN,MAAM;;;;kBACN,MAAM;;;;YACN,MAAM;;;;WACN,MAAM;;;;;;;QASU,SAAS,GAAzB,MAAM;QACU,eAAe,GAA/B,MAAM;;;QAEe,SAAS,GAA9B,MAAM;QACe,eAAe,GAApC,MAAM;;YACN,MAAM;;;qBAMN,MAAM;uBACN,aAAa,GAAC,gBAAgB,GAAC,mBAAmB,GAAC,qBAAqB,GAAC,qBAAqB,GAAC,YAAY,GAAC,cAAc;;;;YAC1H,MAAM;;;;iBACN,WAAW;;;;UACX,IAAI;;;mBAMJ,eAAe,EAAE;wBACjB,eAAe,EAAE"} \ No newline at end of file +{"version":3,"file":"transfers.d.ts","sourceRoot":"","sources":["../transfers.js"],"names":[],"mappings":"AAKA;;;;;;GAMG;AAEH;;;;;;;GAOG;AAEH;;;;;;;;;;;;GAYG;AAEH;;;;GAIG;AAEH;;;;;GAKG;AAEH;;;;;;;GAOG;AAEH;;;;;;;;;;;;;GAaG;AAEH;;;;;;;GAOG;AAEH;;;;;;;GAOG;AAEH;;;;;;;;;;;GAWG;AAEH;;;;;GAKG;AAEH;;;;;;;;GAQG;AAEH;;;;;;;;;;;;;;;;;GAiBG;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AAEH;;;;;;;;;GASG;AAEH;;;;;;;;;GASG;AAEH;;;;;;;;;;;;GAYG;AAEH;;;;;;;;GAQG;AAEH;;;;;GAKG;AAEH;;;;;;;;GAQG;AAEH;;;GAGG;AACH;IACE,uBAMC;IALC;;;OAGG;IACH,aAAgB;IAGlB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,iBA1BW,cAAc,mBACd,MAAM,GACJ,QAAQ,gBAAgB,CAAC,CAyCrC;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,gBApBW,oBAAoB,GAClB,QAAQ,QAAQ,EAAE,CAAC,CAqD/B;IAED;;;;;;;;;;;;;;;OAeG;IACH,gBAZW,MAAM,GACJ,QAAQ,QAAQ,CAAC,CAsB7B;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,2BAhBW,MAAM,YACN,MAAM,GACJ,QAAQ,QAAQ,CAAC,CA4B7B;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,4CAzBW,uBAAuB,GACrB,QAAQ,wBAAwB,CAAC,CAoC7C;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,mBAhBW,MAAM,mBACN,MAAM,gBACJ,QAAQ,gBAAgB,CAAC,CA+BrC;IAED;;;;;;;;;;;;;;;OAeG;IACH,wBAZW,MAAM,GACJ,QAAQ,MAAM,EAAE,CAAC,CAsB7B;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,sBAbW,MAAM,YACN,MAAM,GACJ,QAAQ,MAAM,CAAC,CAuB3B;CACF;;;;;uBA9iBa,MAAM;;;;2BACN,WAAW,GAAC,aAAa,GAAC,IAAI;;;;;;;;;eAO9B,MAAM;;;;WACN,MAAM;;;;iBACN,MAAM;;;;;;mBAMN,MAAM;;;;iBACN,MAAM;;;;YACN,KAAK,GAAC,UAAU,GAAC,oBAAoB,GAAC,SAAS,GAAC,SAAS;;;;gBACzD,MAAM;;;;gBACN,YAAY,GAAC,UAAU;;;;cACvB,MAAM;qBACN,UAAU,GAAC,SAAS,GAAC,SAAS;;;;mBAC9B,MAAM;;;;2BACN,MAAM;;;;;;cAMN,MAAM;;;;;;WAMN,MAAM;;;;UACN,MAAM;;;;;;;;;SAON,SAAS,GAAC,OAAO,GAAC,YAAY,GAAC,aAAa;;;;kBAC5C,SAAS,GAAC,OAAO,GAAC,YAAY,GAAC,aAAa;;;;gBAC5C,SAAS,GAAC,OAAO,GAAC,YAAY,GAAC,aAAa;;;;;;YAM5C,MAAM;;;;iBACN,MAAM;;;;WACN,kBAAkB,GAAC,UAAU,GAAC,YAAY,GAAC,MAAM;;;;cACjD,OAAO,GAAC,QAAQ,GAAC,SAAS,GAAC,SAAS;;;;wBACpC,MAAM;;;;SACN,MAAM;;;;gBACN,cAAc;;;;gBACd,MAAM;;;;oBACN,OAAO;;;;sBACP,gBAAgB;;;;;;;;;UAOhB,MAAM;;;;YACN,MAAM;;;;iBACN,MAAM;;;;;;YAMN,WAAW,GAAC,YAAY,GAAC,WAAW,GAAC,UAAU,GAAC,WAAW;;;;iBAC3D,MAAM;;;;aACN,OAAO;;;;iBACP,OAAO;;;;;;qBAMP,MAAM;;;;uBACN,aAAa,GAAC,gBAAgB,GAAC,mBAAmB,GAAC,qBAAqB,GAAC,qBAAqB,GAAC,YAAY,GAAC,cAAc;;;;aAC1H,oBAAoB;;;;kBACpB,WAAW;;;;WACX,IAAI;;;;aACJ,MAAM;;;;iBACN,UAAU;;;;kBACV,WAAW;;;;;;WAMX,MAAM;;;;cACN,MAAM;;;;;;cAMN,MAAM;;;;eACN,MAAM;;;;eACN,MAAM;;;;YACN,SAAS,GAAC,SAAS,GAAC,WAAW,GAAC,QAAQ;;;;YACxC,MAAM;;;;;;gBAMN,MAAM;;;;eACN,MAAM;;;;eACN,MAAM;;;;YACN,SAAS,GAAC,SAAS,GAAC,WAAW,GAAC,QAAQ,GAAC,UAAU;;;;YACnD,aAAa;;;;iBACb,aAAa;;;;YACb,MAAM;;;;iBACN,MAAM;;;;cACN,MAAM;;;;qBACN,MAAM;;;;aACN,MAAM,EAAE;;;;oBACR,MAAM;;;;aACN,MAAM;;;;oBACN,MAAM;;;;;;YAMN,aAAa;;;;iBACb,aAAa;;;;YACb,MAAM;;;;oBACN,MAAM;;;;iBACN,MAAM;;;;cACN,MAAM;;;;;;gBA8BN,MAAM;;;;;;iBAWN,MAAM,EAAE;;;;aACR,MAAM;;;;oBACN,MAAM;;;;kBACN,MAAM;;;;YACN,MAAM;;;;WACN,MAAM;;;;;;;;;;QASU,SAAS,GAAzB,MAAM;QACU,eAAe,GAA/B,MAAM;;;;;;QAEe,SAAS,GAA9B,MAAM;QACe,eAAe,GAApC,MAAM;;;;;YACN,MAAM;;;;;;qBAMN,MAAM;uBACN,aAAa,GAAC,gBAAgB,GAAC,mBAAmB,GAAC,qBAAqB,GAAC,qBAAqB,GAAC,YAAY,GAAC,cAAc;;;;YAC1H,MAAM;;;;iBACN,WAAW;;;;UACX,IAAI;;;;;;mBAMJ,eAAe,EAAE;;;;wBACjB,eAAe,EAAE"} \ No newline at end of file diff --git a/lib/types/wallets.d.ts b/lib/types/wallets.d.ts index c754b7d..4ce9a44 100644 --- a/lib/types/wallets.d.ts +++ b/lib/types/wallets.d.ts @@ -37,7 +37,7 @@ export namespace WALLET_TRANSACTION_STATUS { * @property {string} transactionID - UUID v4 * @property {WALLET_TRANSACTION_TYPE} transactionType - wallet transaction type. * @property {WALLET_TRANSACTION_SOURCE_TYPE} sourceType - where the transaction originated. - * @property {string} sourceID - ID of the source Moov object to which this transaction is related. Can be one of [walletID](https://docs.moov.io/api/#tag/Wallets/operation/getWalletForAccount), [cardID](https://docs.moov.io/api/#tag/Cards/operation/getCard), or [bankAccountID](https://docs.moov.io/api/#tag/Bank-accounts/operation/getBank). + * @property {string} sourceID - ID of the source Moov object to which this transaction is related. Can be one of [walletID](/api/sources/wallets/list/), [cardID](/api/sources/cards/list/), or [bankAccountID](/api/sources/bank-accounts/list/). * @property {WALLET_TRANSACTION_STATUS} status - wallet transaction status. * @property {string} memo - Detailed description of the transaction. * @property {string} createdOn - Date transaction was created. @@ -72,6 +72,7 @@ export class Wallets { moov: any; /** * Get information on a specific Moov wallet (e.g., the available balance). + * The `WALLETS_READ` scope enum is required when making a request from the browser. * * @param {string} accountID - Account on which to request wallet * @param {string} walletID - The ID for the wallet associated with an account @@ -82,6 +83,7 @@ export class Wallets { get(accountID: string, walletID: string): Promise; /** * List the wallets associated with a Moov account. + * The `WALLETS_READ` scope enum is required when making a request from the browser. * * @param {string} accountID - Account on which to request wallets * @returns {Promise} @@ -91,6 +93,7 @@ export class Wallets { list(accountID: string): Promise; /** * Get the details of a wallet transaction. + * The `WALLETS_READ` scope enum is required when making a request from the browser. * * @param {string} accountID - UUID v4 * @param {string} walletID - UUID v4 @@ -102,6 +105,7 @@ export class Wallets { getTransaction(accountID: string, walletID: string, transactionID: string): Promise; /** * List the transactions in a wallet. + * The `WALLETS_READ` scope enum is required when making a request from the browser. * * @param {string} accountID - UUID v4 * @param {string} walletID - UUID v4 @@ -143,7 +147,7 @@ export type WalletTransaction = { */ sourceType: any; /** - * - ID of the source Moov object to which this transaction is related. + * - ID of the source Moov object to which this transaction is related. Can be one of [walletID](/api/sources/wallets/list/), [cardID](/api/sources/cards/list/), or [bankAccountID](/api/sources/bank-accounts/list/). */ sourceID: string; /** diff --git a/lib/types/wallets.d.ts.map b/lib/types/wallets.d.ts.map index e6f714c..4cebc3d 100644 --- a/lib/types/wallets.d.ts.map +++ b/lib/types/wallets.d.ts.map @@ -1 +1 @@ -{"version":3,"file":"wallets.d.ts","sourceRoot":"","sources":["../wallets.js"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA2JA;;;;;;;;;;;;;;;;;GAiBG;AAEH;;;;;;;;;;;;;GAaG;AAEH;;;GAGG;AACH;IACE,uBAEC;IADC,UAAgB;IAGlB;;;;;;;;OAQG;IACH,eANW,MAAM,YACN,MAAM,GACJ,QAAQ,MAAM,CAAC,CAgB3B;IAED;;;;;;;OAOG;IACH,gBALW,MAAM,GACJ,QAAQ,MAAM,EAAE,CAAC,CAe7B;IAED;;;;;;;;;OASG;IACH,0BAPW,MAAM,YACN,MAAM,iBACN,MAAM,GACJ,QAAQ,iBAAiB,CAAC,CAiBtC;IAED;;;;;;;;;OASG;IACH,4BAPW,MAAM,YACN,MAAM,aACN,6BAA6B,GAC3B,QAAQ,MAAM,EAAE,CAAC,CAiB7B;CACF;;;;;;;;cA1Ra,MAAM;;;;sBACN,MAAM;;;;;;cAmJN,MAAM;;;;mBACN,MAAM;;;;;;;;;;;;cAGN,MAAM;;;;;;;;UAEN,MAAM;;;;eACN,MAAM;;;;kBACN,MAAM;;;;cACN,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;eAYN,MAAM;;;;;;;;2BAEN,MAAM;;;;yBACN,MAAM;;;;6BACN,MAAM;;;;2BACN,MAAM;;;;YACN,MAAM;;;;WACN,MAAM"} \ No newline at end of file +{"version":3,"file":"wallets.d.ts","sourceRoot":"","sources":["../wallets.js"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA2JA;;;;;;;;;;;;;;;;;GAiBG;AAEH;;;;;;;;;;;;;GAaG;AAEH;;;GAGG;AACH;IACE,uBAEC;IADC,UAAgB;IAGlB;;;;;;;;;OASG;IACH,eANW,MAAM,YACN,MAAM,GACJ,QAAQ,MAAM,CAAC,CAgB3B;IAED;;;;;;;;OAQG;IACH,gBALW,MAAM,GACJ,QAAQ,MAAM,EAAE,CAAC,CAe7B;IAED;;;;;;;;;;OAUG;IACH,0BAPW,MAAM,YACN,MAAM,iBACN,MAAM,GACJ,QAAQ,iBAAiB,CAAC,CAiBtC;IAED;;;;;;;;;;OAUG;IACH,4BAPW,MAAM,YACN,MAAM,aACN,6BAA6B,GAC3B,QAAQ,MAAM,EAAE,CAAC,CAiB7B;CACF;;;;;;;;cA9Ra,MAAM;;;;sBACN,MAAM;;;;;;cAmJN,MAAM;;;;mBACN,MAAM;;;;;;;;;;;;cAGN,MAAM;;;;;;;;UAEN,MAAM;;;;eACN,MAAM;;;;kBACN,MAAM;;;;cACN,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;eAYN,MAAM;;;;;;;;2BAEN,MAAM;;;;yBACN,MAAM;;;;6BACN,MAAM;;;;2BACN,MAAM;;;;YACN,MAAM;;;;WACN,MAAM"} \ No newline at end of file diff --git a/package-lock.json b/package-lock.json index d902aa5..5acedad 100644 --- a/package-lock.json +++ b/package-lock.json @@ -889,12 +889,12 @@ } }, "node_modules/braces": { - "version": "3.0.2", - "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.2.tgz", - "integrity": "sha512-b8um+L1RzM3WDSzvhm6gIz1yfTbBt6YTlcEKAvsmqCZZFw46z626lVj9j1yEPW33H5H+lBQpZMP1k8l+78Ha0A==", + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.3.tgz", + "integrity": "sha512-yQbXgO/OSZVD2IsiLlro+7Hf6Q18EJrKSEsdoMzKePKXct3gvD8oLcOQdIzGupr5Fj+EDe8gO/lxc1BzfMpxvA==", "dev": true, "dependencies": { - "fill-range": "^7.0.1" + "fill-range": "^7.1.1" }, "engines": { "node": ">=8" @@ -2112,9 +2112,9 @@ } }, "node_modules/fill-range": { - "version": "7.0.1", - "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.0.1.tgz", - "integrity": "sha512-qOo9F+dMUmC2Lcb4BbVvnKJxTPjCm+RRpe4gDuGrzkL7mEVl/djYSu2OdQ2Pa302N4oqkSg9ir6jaLWJ2USVpQ==", + "version": "7.1.1", + "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.1.1.tgz", + "integrity": "sha512-YsGpe3WHLK8ZYi4tWDg2Jy3ebRz2rXowDxnld4bkQB00cc/1Zw9AWnC0i9ztDJitivtQvaI9KaLyKrc+hBW0yg==", "dev": true, "dependencies": { "to-regex-range": "^5.0.1" @@ -6267,12 +6267,12 @@ } }, "braces": { - "version": "3.0.2", - "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.2.tgz", - "integrity": "sha512-b8um+L1RzM3WDSzvhm6gIz1yfTbBt6YTlcEKAvsmqCZZFw46z626lVj9j1yEPW33H5H+lBQpZMP1k8l+78Ha0A==", + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.3.tgz", + "integrity": "sha512-yQbXgO/OSZVD2IsiLlro+7Hf6Q18EJrKSEsdoMzKePKXct3gvD8oLcOQdIzGupr5Fj+EDe8gO/lxc1BzfMpxvA==", "dev": true, "requires": { - "fill-range": "^7.0.1" + "fill-range": "^7.1.1" } }, "cache-base": { @@ -7228,9 +7228,9 @@ } }, "fill-range": { - "version": "7.0.1", - "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.0.1.tgz", - "integrity": "sha512-qOo9F+dMUmC2Lcb4BbVvnKJxTPjCm+RRpe4gDuGrzkL7mEVl/djYSu2OdQ2Pa302N4oqkSg9ir6jaLWJ2USVpQ==", + "version": "7.1.1", + "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.1.1.tgz", + "integrity": "sha512-YsGpe3WHLK8ZYi4tWDg2Jy3ebRz2rXowDxnld4bkQB00cc/1Zw9AWnC0i9ztDJitivtQvaI9KaLyKrc+hBW0yg==", "dev": true, "requires": { "to-regex-range": "^5.0.1"