@vantagepay/vantagepay 0.15.8 → 0.17.0

package/README.md

@@ -382,15 +382,17 @@ The library uses [pubsub-js](https://www.npmjs.com/package/pubsub-js) to publish
 
 These events can be useful if your application needs to react to certain things happening behind the scenes. It is especially useful when used to automatically receive payment status updates during payment processing.
 ```js
-import { VantagePay, OnApiRetry, OnAutomaticRefresh, OnSessionExpired } from '@vantagepay/vantagepay'
+import { VantagePay, OnApiRetry, OnAutomaticRefresh, OnSessionStarted, OnSessionExpired } from '@vantagepay/vantagepay'
 ...
 const onApiRetrySub = VantagePayClient.events.subscribe(OnApiRetry, (_, retryInfo) => console.log('API performed an automatic retry', retryInfo))
 const onAutoRefreshSub = VantagePayClient.events.subscribe(OnAutomaticRefresh, (_, tokenResponse) => console.log('Automatic refresh was triggered', tokenResponse))
+const onSessionStartedSub = VantagePayClient.events.subscribe(OnSessionStarted, () => console.log('Session started'))
 const onSessionExpiredSub = VantagePayClient.events.subscribe(OnSessionExpired, () => console.log('Session expired'))
 ...
 // Unsubscribe if you no longer want to receive events.
 VantagePayClient.events.unsubscribe(onApiRetrySub)
 VantagePayClient.events.unsubscribe(onAutoRefreshSub)
+VantagePayClient.events.unsubscribe(onSessionStartedSub)
 VantagePayClient.events.unsubscribe(onSessionExpiredSub)
 ```
 

package/dist/authentication/index.d.ts

@@ -11,7 +11,7 @@ export declare class Authentication extends BaseApi {
     checkFace(base64Image: string): Promise<FaceCheckResult>;
     changePassword(oldPassword: string, newPassword: string): Promise<TokenResponse>;
     forgotPassword(username: string): Promise<void>;
-    validateOtp(otpValue: string): Promise<void>;
+    validateOtp(otpValue: string): Promise<TokenResponse>;
     resendOtp(): Promise<void>;
     resendEmailAddressVerification(): Promise<void>;
     getCurrentConsumerReference(token?: string): string;

package/dist/common/types.d.ts

@@ -38,7 +38,8 @@ export declare enum AddressType {
 /** Model to hold account balance details. */
 export declare class Balance {
     currency: Currency;
-    amountInCents?: number;
+    availableAmountInCents?: number;
+    currentAmountInCents?: number;
 }
 export declare enum BankAccountType {
     SAVINGS = "SAVINGS",

package/dist/consumers/index.d.ts

@@ -6,6 +6,8 @@ export declare class Consumers extends BaseApi {
     updateConsumer(request: Consumer): Promise<Consumer>;
     deleteConsumer(): Promise<void>;
     getConsumer(): Promise<Consumer>;
+    getConsumerAgreement(): Promise<string>;
+    acceptConsumerAgreement(): Promise<void>;
     stopCard(cardReference: string, reason?: string): Promise<void>;
     getBankAccountBalance(bankAccountReference: string): Promise<Balance>;
     downloadFile(fileReference: string, queryParameters?: Record<string, string>): Promise<ConsumerFile | null>;

package/dist/consumers/types.d.ts

@@ -68,40 +68,9 @@ export declare class Beneficiary {
     /** A list of cards associated with a beneficiary. */
     cards: BeneficiaryCard[];
     /** A list of generic accounts (mobile numbers, meter numbers, etc) associated with a beneficiary. */
-    accounts: BeneficiaryAccount[];
+    genericAccounts: BeneficiaryGenericAccount[];
     isActive: boolean;
 }
-/** Model to hold the unique details for a generic beneficiary account (mobile number, meter number, etc). */
-export declare class BeneficiaryAccount {
-    /** The account number (can be a mobile number, meter number, etc). */
-    accountNumber: string;
-    /** The type of beneficiary account. */
-    beneficiaryAccountType: BeneficiaryAccountType;
-    beneficiaryAccountTypeName: string;
-    createdDate: Date;
-    /** A globally unique reference (UUID) generated by the system internally to identify a specific beneficiary account. */
-    reference?: string;
-    /** A 3 character ISO currency code. */
-    currency: Currency;
-    /** The details which add sufficient context behind the money transfer to the beneficiary. */
-    recipientReference?: string;
-    /** The details which add sufficient context behind the money transfer to the consumer. */
-    senderReference?: string;
-    /** A flag indicating whether the consumer requires a notification to be sent to the beneficiary after a successful money transfer. */
-    sendProofOfPayment: boolean;
-    /** The email address for the beneficiary. */
-    proofOfPaymentEmailAddress?: string;
-    /** The mobile number for the beneficiary. */
-    proofOfPaymentMobileNumber?: string;
-    isActive: boolean;
-}
-export declare enum BeneficiaryAccountType {
-    None = "None",
-    MobileNumber = "MobileNumber",
-    WaterMeter = "WaterMeter",
-    ElectricityMeter = "ElectricityMeter",
-    PayShap = "PayShap"
-}
 /** Model to hold the unique details for a bank account beneficiary. */
 export declare class BeneficiaryBankAccount {
     /** The bank account token that was generated by the system. */
@@ -161,6 +130,30 @@ export declare class BeneficiaryCard {
     proofOfPaymentMobileNumber?: string;
     isActive: boolean;
 }
+/** Model to hold the unique details for a beneficiary generic account (mobile number, meter number, etc). */
+export declare class BeneficiaryGenericAccount {
+    /** The account number (can be a mobile number, meter number, etc). */
+    accountNumber: string;
+    /** The type of generic account. */
+    genericAccountType: GenericAccountType;
+    genericAccountTypeName: string;
+    createdDate: Date;
+    /** A globally unique reference (UUID) generated by the system internally to identify a specific beneficiary account. */
+    reference?: string;
+    /** A 3 character ISO currency code. */
+    currency: Currency;
+    /** The details which add sufficient context behind the money transfer to the beneficiary. */
+    recipientReference?: string;
+    /** The details which add sufficient context behind the money transfer to the consumer. */
+    senderReference?: string;
+    /** A flag indicating whether the consumer requires a notification to be sent to the beneficiary after a successful money transfer. */
+    sendProofOfPayment: boolean;
+    /** The email address for the beneficiary. */
+    proofOfPaymentEmailAddress?: string;
+    /** The mobile number for the beneficiary. */
+    proofOfPaymentMobileNumber?: string;
+    isActive: boolean;
+}
 /** Model to hold the unique details for a mobile money beneficiary. */
 export declare class BeneficiaryMobileWallet {
     /**
@@ -269,10 +262,12 @@ export declare class ConsumerAccounts {
     bankAccounts: ConsumerBankAccount[];
     /** A list of mobile money / wallet accounts associated with a consumer. */
     mobileWallets: ConsumerMobileWallet[];
-    /** A list of locan accounts associated with a consumer. */
+    /** A list of loan accounts associated with a consumer. */
     loanAccounts: ConsumerLoanAccount[];
-    /** A list of locan accounts associated with a consumer. */
+    /** A list of insurance policies associated with a consumer. */
     insurancePolicies: ConsumerInsurancePolicy[];
+    /** A list of generic accounts (mobile numbers, meter numbers, etc) associated with a consumer. */
+    genericAccounts: ConsumerGenericAccount[];
     /** A list of cards associated with a consumer. */
     cards: ConsumerCard[];
 }
@@ -314,6 +309,7 @@ export declare class ConsumerBankAccount {
     accountName: string;
     isActive: boolean;
     iconUrl?: string;
+    linkedFileReferences: string[];
 }
 export declare class ConsumerCard {
     /** Additional customer information to facilitate the card payment. */
@@ -342,6 +338,7 @@ export declare class ConsumerCard {
     accountName: string;
     isActive: boolean;
     iconUrl?: string;
+    linkedFileReferences: string[];
 }
 export declare class ConsumerFile {
     fileType: ConsumerFileType;
@@ -353,6 +350,25 @@ export declare class ConsumerFile {
     base64Data?: string;
     createdDate: Date;
     lastUpdatedDate?: Date;
+    isActive: boolean;
+}
+/** Model to hold the unique details for a generic account (mobile number, meter number, etc). */
+export declare class ConsumerGenericAccount {
+    /** The account number (can be a mobile number, meter number, etc). */
+    accountNumber: string;
+    /** The type of generic account. */
+    genericAccountType: GenericAccountType;
+    genericAccountTypeName: string;
+    createdDate: Date;
+    /** A globally unique transaction reference (UUID) generated by the system internally to identify a specific consumer account. */
+    reference?: string;
+    /** A 3 character ISO currency code. */
+    currency: Currency;
+    /** The details which add sufficient context behind the account to the consumer. */
+    accountName: string;
+    isActive: boolean;
+    iconUrl?: string;
+    linkedFileReferences: string[];
 }
 export declare class ConsumerInsurancePolicy {
     policyNumber: string;
@@ -369,6 +385,7 @@ export declare class ConsumerInsurancePolicy {
     accountName: string;
     isActive: boolean;
     iconUrl?: string;
+    linkedFileReferences: string[];
 }
 export declare class ConsumerLoanAccount {
     contractNumber: string;
@@ -397,6 +414,7 @@ export declare class ConsumerLoanAccount {
     accountName: string;
     isActive: boolean;
     iconUrl?: string;
+    linkedFileReferences: string[];
 }
 export declare class ConsumerMobileWallet {
     /**
@@ -415,10 +433,20 @@ export declare class ConsumerMobileWallet {
     accountName: string;
     isActive: boolean;
     iconUrl?: string;
+    linkedFileReferences: string[];
 }
 export declare class Feedback {
     description?: string;
 }
+export declare enum GenericAccountType {
+    None = "None",
+    MobileNumber = "MobileNumber",
+    WaterMeter = "WaterMeter",
+    ElectricityMeter = "ElectricityMeter",
+    PayShap = "PayShap",
+    DStv = "DStv",
+    EasyPay = "EasyPay"
+}
 /** The KYC file result. */
 export declare class KycFileResult {
     /** Gets or sets the unique identifier for the KYC service provider used to retrieve the consumer KYC data. */

package/dist/eventTypes.d.ts

@@ -1,3 +1,4 @@
+export declare const OnSessionStarted: unique symbol;
 export declare const OnSessionExpired: unique symbol;
 export declare const OnAutomaticRefresh: unique symbol;
 export declare const OnApiRetry: unique symbol;

package/dist/index.d.ts

@@ -24,6 +24,17 @@ export * from './apiError';
 export * from './apiConfig';
 export { default as ApiTokens } from './apiTokens';
 export declare class VantagePay {
+    static OnSessionStarted: symbol;
+    static OnSessionExpired: symbol;
+    static OnAutomaticRefresh: symbol;
+    static OnApiRetry: symbol;
+    static OnPaymentStatusUpdate: symbol;
+    static OnPaymentComplete: symbol;
+    static OnRequires3DSecure: symbol;
+    static OnRequiresPin: symbol;
+    static OnRequiresConfirmation: symbol;
+    static OnRequiresAddress: symbol;
+    static OnComplete3DSecure: symbol;
     private readonly baseUrl;
     private readonly consoleLogging;
     private readonly logBatchSize;