@vantagepay/vantagepay 0.16.0 → 0.17.1

package/dist/common/types.d.ts

@@ -5,6 +5,8 @@ import { IdentityDocumentType } from '../lookups/types';
 export declare class Address {
     /** Gets the address reference. */
     reference?: string;
+    /** Gets or sets the address external reference if linked to another system. */
+    yourReference?: string;
     /** Gets or sets the type of address the details are referring to. */
     addressType: AddressType;
     /** Gets or sets first line of the address (required). */
@@ -46,7 +48,8 @@ export declare enum BankAccountType {
     CURRENT = "CURRENT",
     FIXED = "FIXED",
     MONEYMARKET = "MONEYMARKET",
-    CODA = "CODA"
+    CODA = "CODA",
+    BOND = "BOND"
 }
 /** Model to capture generic contact/lead data. */
 export declare class ContactDetails {

package/dist/consumers/types.d.ts

@@ -12,6 +12,8 @@ import { Device } from '../devices/types';
 import { Address } from '../common/types';
 import { CardHolder } from '../payments/types';
 import { ConsumerFileType } from '../lookups/types';
+import { InsurancePolicyStatus } from '../lookups/types';
+import { LoanStatus } from '../lookups/types';
 import { KycProvider } from '../lookups/types';
 import { KycStatus } from '../lookups/types';
 import { KycVerificationType } from '../lookups/types';
@@ -51,6 +53,8 @@ export declare class BasicConsumer {
 export declare class Beneficiary {
     /** A globally unique transaction reference (UUID) generated by the system internally to identify a specific beneficiary. */
     reference?: string;
+    /** Gets or sets the beneficiary external reference if linked to another system. */
+    yourReference?: string;
     /** The beneficiary name. */
     name: string;
     /** The contact number for this beneficiary. */
@@ -68,40 +72,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[];
-    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;
+    genericAccounts: BeneficiaryGenericAccount[];
     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 +134,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 {
     /**
@@ -273,6 +270,8 @@ export declare class ConsumerAccounts {
     loanAccounts: ConsumerLoanAccount[];
     /** 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[];
 }
@@ -305,12 +304,16 @@ export declare class ConsumerBankAccount {
     /** The branch code associated with the bank which holds the bank account. */
     routingCode?: string;
     linkedCardReferences: string[];
+    /** Gets or sets the card settings and preferences. */
+    cardSettings?: CardSettings;
     createdDate: Date;
     /** A globally unique transaction reference (UUID) generated by the system internally to identify a specific consumer account. */
     reference?: string;
+    /** Gets or sets the external reference if linked to another system. */
+    yourReference?: string;
     /** A 3 character ISO currency code. */
     currency: Currency;
-    /** The details which add sufficient context behind the account to the consumer. */
+    /** The name of the account. */
     accountName: string;
     isActive: boolean;
     iconUrl?: string;
@@ -333,13 +336,15 @@ export declare class ConsumerCard {
     /** Gets the list of linked bank account references. */
     linkedBankAccountReferences: string[];
     /** Gets or sets the card settings and preferences. */
-    settings?: CardSettings;
+    cardSettings?: CardSettings;
     createdDate: Date;
     /** A globally unique transaction reference (UUID) generated by the system internally to identify a specific consumer account. */
     reference?: string;
+    /** Gets or sets the external reference if linked to another system. */
+    yourReference?: string;
     /** A 3 character ISO currency code. */
     currency: Currency;
-    /** The details which add sufficient context behind the account to the consumer. */
+    /** The name of the account. */
     accountName: string;
     isActive: boolean;
     iconUrl?: string;
@@ -357,25 +362,60 @@ export declare class ConsumerFile {
     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;
+    /** Gets or sets the external reference if linked to another system. */
+    yourReference?: string;
+    /** A 3 character ISO currency code. */
+    currency: Currency;
+    /** The name of the account. */
+    accountName: string;
+    isActive: boolean;
+    iconUrl?: string;
+    linkedFileReferences: string[];
+}
 export declare class ConsumerInsurancePolicy {
     policyNumber: string;
     coverAmountInCents: number;
     premiumAmountInCents: number;
     description?: string;
-    beneficiaryName?: string;
+    beneficiaries: ConsumerInsurancePolicyBeneficiary[];
+    status: InsurancePolicyStatus;
     createdDate: Date;
     /** A globally unique transaction reference (UUID) generated by the system internally to identify a specific consumer account. */
     reference?: string;
+    /** Gets or sets the external reference if linked to another system. */
+    yourReference?: string;
     /** A 3 character ISO currency code. */
     currency: Currency;
-    /** The details which add sufficient context behind the account to the consumer. */
+    /** The name of the account. */
     accountName: string;
     isActive: boolean;
     iconUrl?: string;
     linkedFileReferences: string[];
 }
+export declare class ConsumerInsurancePolicyBeneficiary {
+    reference?: string;
+    firstName: string;
+    lastName: string;
+    contactNumber?: string;
+    dateOfBirth?: Date;
+    relationship?: string;
+    percentage: number;
+}
 export declare class ConsumerLoanAccount {
     contractNumber: string;
+    loanType: string;
+    loanSource: string;
+    status: LoanStatus;
     originalCapitalInCents: number;
     settlementAmountInCents: number;
     outstandingBalanceInCents: number;
@@ -383,9 +423,11 @@ export declare class ConsumerLoanAccount {
     arrearsAmountInCents: number;
     installmentsRemaining: number;
     annualInterestRatePercentage: number;
-    nextInstallmentDate: Date;
+    nextInstallmentDate?: Date;
+    lastPaymentDate?: Date;
     startDate: Date;
     endDate: Date;
+    term: number;
     /** Whether the loan is currently in arrears (past due). */
     isInArrears: boolean;
     /** Whether the loan has been fully paid. */
@@ -395,9 +437,11 @@ export declare class ConsumerLoanAccount {
     createdDate: Date;
     /** A globally unique transaction reference (UUID) generated by the system internally to identify a specific consumer account. */
     reference?: string;
+    /** Gets or sets the external reference if linked to another system. */
+    yourReference?: string;
     /** A 3 character ISO currency code. */
     currency: Currency;
-    /** The details which add sufficient context behind the account to the consumer. */
+    /** The name of the account. */
     accountName: string;
     isActive: boolean;
     iconUrl?: string;
@@ -414,9 +458,11 @@ export declare class ConsumerMobileWallet {
     createdDate: Date;
     /** A globally unique transaction reference (UUID) generated by the system internally to identify a specific consumer account. */
     reference?: string;
+    /** Gets or sets the external reference if linked to another system. */
+    yourReference?: string;
     /** A 3 character ISO currency code. */
     currency: Currency;
-    /** The details which add sufficient context behind the account to the consumer. */
+    /** The name of the account. */
     accountName: string;
     isActive: boolean;
     iconUrl?: string;
@@ -425,6 +471,15 @@ export declare class ConsumerMobileWallet {
 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. */