@vantagepay/vantagepay 0.15.5 → 0.15.7

package/dist/authentication/types.d.ts

@@ -21,6 +21,10 @@ export declare class LoginCredentials {
     username: string;
     /** Gets or sets the password (required). */
     password: string;
+    /** Indicates whether the user is locked out. */
+    isLockedOut: boolean;
+    /** Gets the reason (if any) of why the user has been locked out. */
+    reasonForLockout?: string;
 }
 /** Provides details for the reason why a login attempt failed (401 errors). */
 export declare class LoginErrorResponse {

package/dist/common/types.d.ts

@@ -1,4 +1,5 @@
 import { Country } from '../lookups/types';
+import { Currency } from '../lookups/types';
 import { IdentityDocumentType } from '../lookups/types';
 /** Model to hold address details. */
 export declare class Address {
@@ -34,6 +35,11 @@ export declare enum AddressType {
     BILL = "BILL",
     SHIP = "SHIP"
 }
+/** Model to hold account balance details. */
+export declare class Balance {
+    currency: Currency;
+    amountInCents?: number;
+}
 export declare enum BankAccountType {
     SAVINGS = "SAVINGS",
     CURRENT = "CURRENT",

package/dist/consumers/index.d.ts

@@ -1,11 +1,14 @@
 import { BaseApi } from '../baseApi';
-import { ContactDetails } from '../common/types';
-import { Consumer, Message } from './types';
+import { Balance, ContactDetails } from '../common/types';
+import { Consumer, ConsumerFile, Message } from './types';
 export declare class Consumers extends BaseApi {
     createConsumer(request: Consumer): Promise<Consumer>;
     updateConsumer(request: Consumer): Promise<Consumer>;
     deleteConsumer(): Promise<void>;
     getConsumer(): Promise<Consumer>;
+    stopCard(cardReference: string, reason?: string): Promise<void>;
+    getBankAccountBalance(bankAccountReference: string): Promise<Balance>;
+    downloadFile(fileReference: string, queryParameters?: Record<string, string>): Promise<ConsumerFile | null>;
     submitFeedback(description: string): Promise<void>;
     getAllMessages(): Promise<Message[]>;
     getMessage(messageReference: string): Promise<Message>;

package/dist/consumers/types.d.ts

@@ -1,9 +1,9 @@
 import { Country } from '../lookups/types';
 import { Gender } from '../lookups/types';
 import { Language } from '../lookups/types';
-import { Bank } from '../lookups/types';
-import { BankAccountType } from '../common/types';
 import { Currency } from '../lookups/types';
+import { BankAccountType } from '../common/types';
+import { Bank } from '../lookups/types';
 import { Month } from '../lookups/types';
 import { MobileWalletOperator } from '../lookups/types';
 import { LoginCredentials } from '../authentication/types';
@@ -53,29 +53,70 @@ export declare class Beneficiary {
     reference?: string;
     /** The beneficiary name. */
     name: string;
+    /** The contact number for this beneficiary. */
+    contactNumber?: string;
+    /** The date and time of the last transaction made to this beneficiary account. */
+    lastTransactionDate?: Date;
+    /** The amount in cents of the last transaction made to this beneficiary account. */
+    lastTransactionAmountInCents?: number;
+    /** The currency of the last transaction made to this beneficiary account. */
+    lastTransactionCurrency?: Currency;
     /** A list of bank accounts associated with a beneficiary. */
     bankAccounts: BeneficiaryBankAccount[];
     /** A list of mobile wallets associated with a beneficiary. */
     mobileWallets: BeneficiaryMobileWallet[];
     /** 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[];
+    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. */
     token?: string;
     accountNumber: string;
-    bank: Bank;
-    bankName: string;
     /** The bank account type. */
     bankAccountType: BankAccountType;
     bankAccountTypeName: string;
+    bank: Bank;
+    bankName: string;
     /** The branch code associated with the bank which holds the bank account. */
     routingCode?: string;
     createdDate: Date;
     /** A globally unique reference (UUID) generated by the system internally to identify a specific beneficiary account. */
-    reference: string;
+    reference?: string;
     /** A 3 character ISO currency code. */
     currency: Currency;
     /** The details which add sufficient context behind the money transfer to the beneficiary. */
@@ -105,7 +146,7 @@ export declare class BeneficiaryCard {
     cardIssuer: string;
     createdDate: Date;
     /** A globally unique reference (UUID) generated by the system internally to identify a specific beneficiary account. */
-    reference: string;
+    reference?: string;
     /** A 3 character ISO currency code. */
     currency: Currency;
     /** The details which add sufficient context behind the money transfer to the beneficiary. */
@@ -132,7 +173,7 @@ export declare class BeneficiaryMobileWallet {
     mobileWalletOperatorName: string;
     createdDate: Date;
     /** A globally unique reference (UUID) generated by the system internally to identify a specific beneficiary account. */
-    reference: string;
+    reference?: string;
     /** A 3 character ISO currency code. */
     currency: Currency;
     /** The details which add sufficient context behind the money transfer to the beneficiary. */
@@ -147,12 +188,21 @@ export declare class BeneficiaryMobileWallet {
     proofOfPaymentMobileNumber?: string;
     isActive: boolean;
 }
+/** Model to hold consumer card settings and preferences. */
+export declare class CardSettings {
+    /** Gets or sets a value indicating whether tap to pay functionality is allowed for this card. */
+    allowTapToPay: boolean;
+    /** Gets or sets a value indicating whether a PIN should always be requested for transactions with this card. */
+    alwaysAskForPin: boolean;
+}
 /** Model to hold detailed consumer details. */
 export declare class Consumer {
     /** The date and time this consumer record was created. */
     createdDate: Date;
     /** Gets or sets the login credentials that this consumer can use to access their data. */
     loginCredentials?: LoginCredentials;
+    /** Gets or sets the preferred name of the consumer. */
+    preferredName?: string;
     /** Gets or sets the full name of a consumer's next of kin. */
     fullNameOfNextOfKin?: string;
     /** Gets or sets the contact number for a consumer's next of kin. */
@@ -248,11 +298,13 @@ export declare class ConsumerBankAccount {
     accountNumber: string;
     /** The bank account type. */
     bankAccountType?: BankAccountType;
+    bankAccountTypeName?: string;
     bank: Bank;
+    bankName: string;
     branchName?: string;
     /** The branch code associated with the bank which holds the bank account. */
     routingCode?: string;
-    hasActiveCard: boolean;
+    linkedCardReferences: string[];
     createdDate: Date;
     /** A globally unique transaction reference (UUID) generated by the system internally to identify a specific consumer account. */
     reference?: string;
@@ -277,6 +329,10 @@ export declare class ConsumerCard {
     expiryMonth: Month;
     /** The year in which the card expires. */
     expiryYear: number;
+    /** Gets the list of linked bank account references. */
+    linkedBankAccountReferences: string[];
+    /** Gets or sets the card settings and preferences. */
+    settings?: CardSettings;
     createdDate: Date;
     /** A globally unique transaction reference (UUID) generated by the system internally to identify a specific consumer account. */
     reference?: string;
@@ -401,7 +457,7 @@ export declare enum KycStatusSummary {
 /** Model to hold consumer message details. */
 export declare class Message {
     /** A globally unique transaction reference (UUID) generated by the system internally to identify a specific message. */
-    reference: string;
+    reference?: string;
     /** A globally unique transaction reference (UUID) generated by the system internally to identify a specific consumer. */
     consumerReference: string;
     /** A short text string which briefly summarizes the message details. */
@@ -418,3 +474,10 @@ export declare class RewardPointsInfo {
     rewardTier: number;
     creditTransactionCount: number;
 }
+/** Request to stop a consumer card. */
+export declare class StopCardRequest {
+    /** The card reference to stop. */
+    cardReference?: string;
+    /** The reason for stopping the card. */
+    reason?: string;
+}