@vantagepay/vantagepay 0.17.2 → 0.17.4

package/dist/common/types.d.ts

@@ -91,6 +91,13 @@ export declare class IdentityDocument {
     /** Gets or sets the date at which the identification document expires. */
     expiryDate?: Date;
 }
+export declare enum LimitResetPeriod {
+    PerTransaction = "PerTransaction",
+    Daily = "Daily",
+    Weekly = "Weekly",
+    Monthly = "Monthly",
+    Yearly = "Yearly"
+}
 /** Model to hold location data. */
 export declare class Location {
     /** A latitude value expressed as a 64 bit floating point number (required). */
@@ -113,3 +120,18 @@ export declare class SwitchEnvironmentInfo {
     accessToken: string;
     apiBaseUrl: string;
 }
+export declare enum TransactionLimitType {
+    Unknown = "Unknown",
+    CashWithdrawal = "CashWithdrawal",
+    Transfer = "Transfer",
+    Payment = "Payment",
+    Deposit = "Deposit",
+    Online = "Online",
+    Instant = "Instant",
+    Lotto = "Lotto",
+    PrepaidAirtime = "PrepaidAirtime",
+    PrepaidElectricity = "PrepaidElectricity",
+    PrepaidWater = "PrepaidWater",
+    PayShap = "PayShap",
+    Ussd = "Ussd"
+}

package/dist/consumers/index.d.ts

@@ -1,18 +1,22 @@
 import { BaseApi } from '../baseApi';
-import { Balance, ContactDetails } from '../common/types';
-import { Consumer, ConsumerFile, Message } from './types';
+import { Balance, ContactDetails, LimitResetPeriod, TransactionLimitType } from '../common/types';
+import { BasicConsumer, Consumer, ConsumerFile, Message, BankAccountLimit } from './types';
 export declare class Consumers extends BaseApi {
-    createConsumer(request: Consumer): Promise<Consumer>;
+    createConsumer(request: Consumer): Promise<BasicConsumer>;
     updateConsumer(request: Consumer): Promise<Consumer>;
     deleteConsumer(): Promise<void>;
     getConsumer(): Promise<Consumer>;
     getConsumerAgreement(): Promise<string>;
     acceptConsumerAgreement(): Promise<void>;
     stopCard(cardReference: string, reason?: string): Promise<void>;
-    stopDebitOrder(debitOrderReference: string): Promise<void>;
-    disputeDebitOrder(debitOrderReference: string): Promise<void>;
+    stopDebitOrders(debitOrderReferences: string[]): Promise<void>;
+    disputeDebitOrders(debitOrderReferences: string[]): Promise<void>;
     getBankAccountBalance(bankAccountReference: string): Promise<Balance>;
+    getBankAccountLimits(bankAccountReference: string): Promise<BankAccountLimit[]>;
+    changeBankAccountLimit(bankAccountReference: string, limitType: TransactionLimitType, resetPeriod: LimitResetPeriod, newLimitAmountInCents: number): Promise<void>;
     downloadFile(fileReference: string, queryParameters?: Record<string, string>): Promise<ConsumerFile | null>;
+    emailFile(fileReference: string, emailAddress: string, queryParameters?: Record<string, string>): Promise<void>;
+    smsFile(fileReference: string, msisdn: string, queryParameters?: Record<string, string>): Promise<void>;
     submitFeedback(description: string): Promise<void>;
     getAllMessages(): Promise<Message[]>;
     getMessage(messageReference: string): Promise<Message>;

package/dist/consumers/types.d.ts

@@ -17,6 +17,8 @@ import { LoanStatus } from '../lookups/types';
 import { KycProvider } from '../lookups/types';
 import { KycStatus } from '../lookups/types';
 import { KycVerificationType } from '../lookups/types';
+import { TransactionLimitType } from '../common/types';
+import { LimitResetPeriod } from '../common/types';
 /** Model to hold basic consumer details. */
 export declare class BasicConsumer {
     /** Gets or sets the consumer reference. */
@@ -191,6 +193,15 @@ export declare class CardSettings {
     allowTapToPay: boolean;
     /** Gets or sets a value indicating whether a PIN should always be requested for transactions with this card. */
     alwaysAskForPin: boolean;
+    /** Gets or sets a value indicating whether online banking is enabled. */
+    isOnlineBankingEnabled: boolean;
+    onlineBankingLastUsedDate?: Date;
+    /** Gets or sets a value indicating whether mobile banking features are enabled. */
+    isMobileBankingEnabled: boolean;
+    mobileBankingLastUsedDate?: Date;
+    /** Gets or sets a value indicating whether USSD banking functionality is enabled. */
+    isUssdBankingEnabled: boolean;
+    ussdBankingLastUsedDate?: Date;
 }
 /** Model to hold detailed consumer details. */
 export declare class Consumer {
@@ -304,8 +315,8 @@ 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;
+    /** Gets or sets the card settings and preferences that apply to this bank account and all linked cards. When updated, these settings cascade to all linked cards. */
+    linkedCardSettings?: CardSettings;
     /** Collection of debit orders linked to this bank account. */
     debitOrders: DebitOrder[];
     createdDate: Date;
@@ -357,6 +368,7 @@ export declare class ConsumerFile {
     kycResults: KycFileResult[];
     reference?: string;
     yourReference?: string;
+    description?: string;
     fileName: string;
     mimeType: string;
     base64Data?: string;
@@ -501,15 +513,11 @@ export declare class DebitOrder {
     disputedDate?: Date;
     /** Whether the debit order action date is in the future. */
     isFuture: boolean;
-    /** Provider-specific metadata (not serialized to clients). */
-    metadata: {
-        [key: string]: string;
-    };
 }
 /** Request to dispute a debit order. */
-export declare class DisputeDebitOrderRequest {
-    /** The debit order reference to dispute. */
-    debitOrderReference: string;
+export declare class DisputeDebitOrdersRequest {
+    /** The debit order references to dispute. */
+    debitOrderReferences: string[];
 }
 export declare class Feedback {
     description?: string;
@@ -586,7 +594,29 @@ export declare class StopCardRequest {
     reason?: string;
 }
 /** Request to stop a debit order. */
-export declare class StopDebitOrderRequest {
-    /** The debit order reference to stop. */
-    debitOrderReference: string;
+export declare class StopDebitOrdersRequest {
+    /** The debit order references to stop. */
+    debitOrderReferences: string[];
+}
+export declare class BankAccountLimit {
+    /** The transaction limit type (ATM, Payment, Transfer, etc.). */
+    transactionLimitType: TransactionLimitType;
+    transactionLimitTypeName: string;
+    /** The reset period for this limit (PerTransaction, Daily, Weekly, Monthly, Yearly). */
+    resetPeriod: LimitResetPeriod;
+    resetPeriodName: string;
+    /** The maximum amount allowed in cents for this transaction type and reset period. */
+    limitAmountInCents: number;
+    /** The amount already used in cents for this transaction type and reset period. */
+    usedAmountInCents: number;
+    /** The amount remaining in cents for this transaction type and reset period. */
+    remainingAmountInCents: number;
+}
+export declare class BankAccountLimitChange {
+    /** The transaction limit type (ATM, Payment, Transfer, etc.). */
+    transactionLimitType: TransactionLimitType;
+    /** The reset period for this limit (PerTransaction, Daily, Weekly, Monthly, Yearly). */
+    resetPeriod: LimitResetPeriod;
+    /** The maximum amount allowed in cents for this transaction type and reset period. */
+    newLimitAmountInCents: number;
 }