@vantagepay/vantagepay 0.15.0 → 0.15.1

package/README.md

@@ -31,9 +31,9 @@ The following options are available when creating an instance.
 ```js
 {
   // The partner URL you are integrating with, this will point to the local development server by default.
-  baseUrl: 'https://sandbox-api.vantagepay.dev/'
+  baseUrl: 'https://sandbox-api.vantagepay.dev/',
 
-  // Optional extra headers (string key/value pairs) that you may want to send to th e server with each call.
+  // Optional extra headers (string key/value pairs) that you may want to send to the server with each call.
   headers: {
     'X-EXAMPLE-HEADER': 'Test'
   },
@@ -45,7 +45,7 @@ The following options are available when creating an instance.
   retries: 3,
 
   // For additional request/response and signal logging which can be useful when debugging.
-  consoleLogging: false
+  consoleLogging: false,
 
   // The batch size limit when logs should immediately be sent to the server, the default is 100, use 0 to disable.
   logBatchSize: 100,
@@ -149,14 +149,14 @@ try {
     if (authError.mustChangePassword) {
       console.log('Navigate to a change password page, the token is internally set to allow calls to auth.changePassword()')
 
-      // A successfull change will automatically log you in.
+      // A successful change will automatically log you in.
       await VantagePayClient.auth.changePassword('NewComplexP@55word!')
     }
 
     if (authError.mustValidatePhoneNumber) {
       console.log('Navigate to the OTP page password page, the token is internally set to allow calls to auth.resendOtp() and auth.validateOtp()')
 
-      // A successfull OTP verification will automatically log you in.
+      // A successful OTP verification will automatically log you in.
       await VantagePayClient.auth.validateOtp('1234')
     }
 

package/dist/consumers/types.d.ts

@@ -154,6 +154,8 @@ export declare class Consumer {
     fullNameOfNextOfKin?: string;
     /** Gets or sets the contact number for a consumer's next of kin. */
     contactNumberForNextOfKin?: string;
+    /** Gets or sets an alternate contact number for the consumer. */
+    alternateContactNumber?: string;
     /** Gets or sets the invitation code for the consumer. */
     invitationCode?: string;
     /** Gets or sets a flag to indicate whether registration details have been captured by the consumer themselves. */
@@ -222,7 +224,9 @@ export declare enum ConsumerAttribute {
     MasterCardPAN = 2,
     RegistrationInvitationCode = 3,
     GMoneyWalletNumber = 4,
-    LinkedGcbBankAccountReferences = 5
+    LinkedGcbBankAccountReferences = 5,
+    MarketingConsent = 6,
+    CommunicationOutsideRegularHoursConsent = 7
 }
 /** Model to hold various attributes about a consumer. */
 export declare class ConsumerAttributeValue {

package/dist/merchants/types.d.ts

@@ -368,6 +368,19 @@ export declare class PosPermissions {
     canCloseAndAccessBatchReports: boolean;
     canEditDeviceSettings: boolean;
     canExceedMaximumSaleLimits: boolean;
+    canProcessCashWithdrawals: boolean;
+    canProcessCashDeposit: boolean;
+    canUseBalanceEnquiry: boolean;
+    canUseDebiCheck: boolean;
+    canUseManualCardEntry: boolean;
+    canProcessCancellations: boolean;
+    canProcessDepositsAndReversals: boolean;
+    canUsePreAuthorisation: boolean;
+    canUseIncrementalAuthorisation: boolean;
+    canOverrideAuthorisation: boolean;
+    canCancelAuthorisation: boolean;
+    canCompleteAuthorisation: boolean;
+    canAccessReports: boolean;
 }
 export declare enum SettlementTime {
     None = "None",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vantagepay/vantagepay",
-  "version": "0.15.0",
+  "version": "0.15.1",
   "description": "VantagePay API wrapper and SDK for integrating into VantagePay payment, consumer and merchant services.",
   "main": "./dist/index.js",
   "module": "./dist/index.m.js",
@@ -18,7 +18,7 @@
   },
   "dependencies": {
     "@microsoft/signalr": "^9.0.6",
-    "axios": "^1.13.0",
+    "axios": "^1.13.1",
     "axios-auth-refresh": "^3.3.6",
     "axios-retry": "^4.5.0",
     "pubsub-js": "^1.9.5",

package/dist/gmoney/index.d.ts

@@ -1,48 +0,0 @@
-import { BaseApi } from '../baseApi';
-import { OtpVerificationResponse, GMoneyConsumerCreateProfileRequest, GMoneyConsumerUpdateProfileRequest, GMoneyConsumerProfileResponse, GMoneyConsumerWalletResponse, TransactionReportResponse, LinkBankAccountRequest, TransactionReceiptResponse, GMoneyConsumerBankAccountResponse } from './types';
-import { TokenResponse } from '../authentication/types';
-import { FaceMovementDetectionLevel } from '../lookups/types';
-import { ConsumerBankAccount } from '../consumers/types';
-export declare class GMoney extends BaseApi {
-    private readonly branchesCache;
-    private readonly atmsCache;
-    private readonly agentsCache;
-    private readonly merchantNameCache;
-    private readonly customerNameCache;
-    private readonly bankAccountNameCache;
-    private clientContentCache;
-    private contactDetailsCache;
-    verifyMobileNumber(msisdn: string): Promise<OtpVerificationResponse>;
-    validateOtp(otpValue: string): Promise<OtpVerificationResponse>;
-    resendOtp(): Promise<void>;
-    createConsumerProfile(request: GMoneyConsumerCreateProfileRequest): Promise<TokenResponse>;
-    deleteConsumerProfile(): Promise<void>;
-    updateConsumerProfile(request: GMoneyConsumerUpdateProfileRequest): Promise<GMoneyConsumerProfileResponse>;
-    getConsumerProfile(): Promise<GMoneyConsumerProfileResponse>;
-    getWalletInformation(): Promise<GMoneyConsumerWalletResponse>;
-    changeWalletPin(tempPin: string, newPin: string): Promise<void>;
-    activateCustomer(oldPin: string, newPin: string): Promise<void>;
-    resetWalletPin(): Promise<void>;
-    saveConsumerSelfie(base64Image: string): Promise<string>;
-    linkGcbBankAccount(request: LinkBankAccountRequest): Promise<void>;
-    checkConsumerLiveness(base64Images: string[]): Promise<FaceMovementDetectionLevel>;
-    saveProfilePicture(base64Image: string): Promise<string>;
-    getBranches(limit?: number, latitude?: number, longitude?: number): Promise<any>;
-    getAtms(limit?: number, latitude?: number, longitude?: number): Promise<any>;
-    getAgents(limit?: number, latitude?: number, longitude?: number): Promise<any>;
-    getMerchantNameFromOrganizationCode(organizationCode: string): Promise<string>;
-    getCustomerNameFromWalletNumber(msisdn: string): Promise<string>;
-    getCustomerNameFromBankAccountNumber(accountNumber: string): Promise<string>;
-    getClientContent(): Promise<any>;
-    getContactDetails(): Promise<any>;
-    getRecentTransactions(limit?: number, successOnly?: boolean): Promise<TransactionReportResponse>;
-    getTransactionHistory(dateFrom?: string, dateTo?: string): Promise<TransactionReportResponse>;
-    getTransactionReceipt(paymentReference: string): Promise<TransactionReceiptResponse>;
-    forgotPassword(msisdn: string): Promise<void>;
-    getServiceStatus(): Promise<boolean>;
-    getAllLinkedBankAccounts(): Promise<ConsumerBankAccount[]>;
-    getLinkedBankAccountInformation(bankAccountReference: string): Promise<GMoneyConsumerBankAccountResponse>;
-    getLinkedBankAccountRecentTransactions(bankAccountReference: string, limit?: number): Promise<TransactionReportResponse>;
-    getLinkedBankAccountTransactionHistory(bankAccountReference: string): Promise<TransactionReportResponse>;
-    getLinkedBankAccountTransactionReceipt(paymentReference: string): Promise<TransactionReceiptResponse>;
-}

package/dist/gmoney/types.d.ts

@@ -1,136 +0,0 @@
-import { Gender, Currency } from '../lookups/types';
-import { KycStatusSummary } from '../consumers/types';
-import { PaymentStatusResponse } from '../payments/types';
-export interface ForgotPasswordRequest {
-    msisdn: string;
-}
-export interface GMoneyActivateCustomerRequest {
-    oldPin: string;
-    newPin: string;
-}
-export interface GMoneyChangePinRequest {
-    currentTemporaryPin: string;
-    newPin: string;
-}
-export interface GMoneyConsumerBankAccountResponse {
-    isGcbBankAccountLinked: boolean;
-    accountNumber: string | null;
-    accountStatus: string | null;
-    currency: Currency | null;
-    accountBalanceInCents: number | null;
-    lastTransactionCurrency: Currency | null;
-    lastTransactionAmountInCents: number | null;
-    lastTransactionDate: string | null;
-    lastTransactionDescription: string | null;
-}
-export interface GMoneyConsumerCreateProfileRequest {
-    firstName: string;
-    lastName: string;
-    ghanaCardIdNumber: string;
-    password: string;
-    emailAddress: string | null;
-    base64Image: string | null;
-}
-export interface GMoneyConsumerLivenessRequest {
-    base64Images: string[];
-}
-export interface GMoneyConsumerProfilePictureRequest {
-    base64Image: string | null;
-}
-export interface GMoneyConsumerProfileResponse {
-    alias: string | null;
-    firstName: string;
-    lastName: string;
-    dateOfBirth: string;
-    gender: Gender;
-    emailAddress: string;
-    mobileNumber: string;
-    profileImage: string | null;
-    rewardPointsInfo: GMoneyRewardPointsInfo | null;
-    ghanaCardId: string | null;
-}
-export interface GMoneyConsumerSelfieRequest {
-    base64Image: string | null;
-}
-export interface GMoneyConsumerUpdateProfileRequest {
-    alias: string | null;
-    dateOfBirth: string | null;
-    emailAddress: string;
-}
-export interface GMoneyConsumerWalletResponse {
-    isAccountLinked: boolean;
-    isGcbBankAccountLinked: boolean;
-    isWalletPinLocked: boolean;
-    isAccountKycVerified: boolean;
-    hasAccount: boolean;
-    gMoneyMobileWalletAccountNumber: string | null;
-    accountStatus: GMoneyIdentityStatus;
-    currency: Currency | null;
-    accountBalanceInCents: number | null;
-    lastTransactionCurrency: Currency | null;
-    lastTransactionAmountInCents: number | null;
-    lastTransactionDate: string | null;
-    lastTransactionDescription: string | null;
-    kycStatusSummary: KycStatusSummary;
-    selfieImageRequired: boolean;
-}
-export declare enum GMoneyIdentityStatus {
-    NoAccount = -2,
-    Unknown = -1,
-    New = 0,
-    PendingActive = 2,
-    Active = 3,
-    Suspended = 4,
-    Frozen = 5,
-    Closed = 6,
-    Capped = 7,
-    Dormant = 8
-}
-export interface GMoneyRewardPointsInfo {
-    pointsBalance: number;
-    rewardTier: GMoneyRewardTier;
-}
-export declare enum GMoneyRewardTier {
-    Basic = 0,
-    Bronze = 1,
-    Silver = 2,
-    Gold = 3
-}
-export interface LinkBankAccountRequest {
-    bankAccountName: string;
-    bankAccountNumber: string;
-}
-export interface OtpRequest {
-    msisdn: string;
-}
-export interface OtpVerificationResponse {
-    registrationRequired: boolean | null;
-    otpVerificationRequired: boolean | null;
-    selfieImageRequired: boolean | null;
-    previousProfileDeactivated: boolean | null;
-    accessToken: string | null;
-}
-export interface RequestBase {
-    createdDateTime: string;
-    originatorConversationId: string;
-    callbackUrl: string | null;
-    gMoneyWalletPin: string | null;
-    transactionBatchReference: string;
-    commentToCustomer: string;
-    isElevyExempt: boolean;
-}
-export interface TransactionReceiptResponse extends PaymentStatusResponse {
-    name: string | null;
-    receiptId: string | null;
-    iconUrl: string | null;
-}
-export interface TransactionReportResponse {
-    paymentReference: string;
-    name: string | null;
-    transactionCompletedDateUtc: string;
-    currency: string;
-    amountInCents: number;
-    isSuccess: boolean;
-    status: string;
-    iconUrl: string;
-}

package/dist/hubtel/index.d.ts

@@ -1,21 +0,0 @@
-import { AxiosInstance } from 'axios';
-import { BaseApi } from '../baseApi';
-import { Payments } from '../payments';
-import { PaymentStatusResponse } from '../payments/types';
-import { PayTvAccountRequest, TopupMobileAirtimeRequest, TopupMobileVoiceDataRequest, TopupMobileDataRequest, BundleData, HubtelMobileOperator } from './types';
-export declare class Hubtel extends BaseApi {
-    private readonly payments;
-    private readonly mobileDataBundlesCache;
-    private readonly mobileVoiceBundlesCache;
-    private mobileOperatorsCache;
-    constructor(axiosInstance: AxiosInstance, payments: Payments, consoleLogging?: boolean);
-    payDstv(request: PayTvAccountRequest): Promise<PaymentStatusResponse>;
-    payGotv(request: PayTvAccountRequest): Promise<PaymentStatusResponse>;
-    payStarTimesTv(request: PayTvAccountRequest): Promise<PaymentStatusResponse>;
-    topupMobileData(request: TopupMobileDataRequest): Promise<PaymentStatusResponse>;
-    topupMobileVoiceData(request: TopupMobileVoiceDataRequest): Promise<PaymentStatusResponse>;
-    topupMobileAirtime(request: TopupMobileAirtimeRequest): Promise<PaymentStatusResponse>;
-    getAvailableMobileDataBundles(mobileOperator: HubtelMobileOperator): Promise<BundleData[]>;
-    getAvailableMobileVoiceBundles(mobileOperator: HubtelMobileOperator): Promise<BundleData[]>;
-    getMobileOperators(): Promise<any>;
-}

package/dist/hubtel/types.d.ts

@@ -1,35 +0,0 @@
-import { BasePaymentRequest, PaymentSources } from '../payments/types';
-export interface BundleData {
-    bundleAmountInCents: number;
-    displayText: string;
-    bundleName: string;
-}
-export declare enum HubtelMobileOperator {
-    MTN = 1,
-    VDF = 2,
-    ATG = 3,
-    GLO = 4,
-    SFL = 5,
-    B4G = 6
-}
-export interface PayTvAccountRequest extends BasePaymentRequest {
-    paymentSources: PaymentSources | null;
-    accountNumber: string;
-}
-export interface TopupMobileAirtimeRequest extends BasePaymentRequest {
-    paymentSources: PaymentSources | null;
-    recipientMobileNumber: string | null;
-    recipientMobileOperator: HubtelMobileOperator;
-}
-export interface TopupMobileDataRequest extends BasePaymentRequest {
-    paymentSources: PaymentSources | null;
-    recipientMobileNumber: string | null;
-    recipientMobileOperator: HubtelMobileOperator;
-    bundleName: string | null;
-}
-export interface TopupMobileVoiceDataRequest extends BasePaymentRequest {
-    paymentSources: PaymentSources | null;
-    recipientMobileNumber: string | null;
-    recipientMobileOperator: HubtelMobileOperator;
-    bundleName: string | null;
-}

package/dist/transflow/index.d.ts

@@ -1,11 +0,0 @@
-import { AxiosInstance } from 'axios';
-import { BaseApi } from '../baseApi';
-import { Payments } from '../payments';
-import { PaymentStatusResponse } from '../payments/types';
-import { PayWaterAccountRequest, PayElectricityAccountRequest } from './types';
-export declare class TransFlow extends BaseApi {
-    private readonly payments;
-    constructor(axiosInstance: AxiosInstance, payments: Payments, consoleLogging?: boolean);
-    payElectricityAccount(request: PayElectricityAccountRequest): Promise<PaymentStatusResponse>;
-    payWaterAccount(request: PayWaterAccountRequest): Promise<PaymentStatusResponse>;
-}

package/dist/transflow/types.d.ts

@@ -1,11 +0,0 @@
-import { BasePaymentRequest, PaymentSources } from '../payments/types';
-export interface PayElectricityAccountRequest extends BasePaymentRequest {
-    paymentSources: PaymentSources | null;
-    accountNumber: string;
-}
-export interface PayWaterAccountRequest extends BasePaymentRequest {
-    paymentSources: PaymentSources | null;
-    accountReference: string;
-    accountHolderEmailAddress: string | null;
-    accountHolderMobileNumber: string | null;
-}