@vantagepay/vantagepay 0.15.0 → 0.15.2

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,
@@ -71,7 +71,7 @@ The API will respond with typical REST HTTP error status codes (4xx and 5xx) for
 
 ```js
 try {
- // ... Call a method on the client library.
+  // ... Call a method on the client library.
 } catch (error) {
   // First check if it's an API error.
   if (error instanceof ApiError) {
@@ -106,8 +106,7 @@ try {
       console.error('Unknown status code from VantagePay client library: ' + error.statusCode)
       throw error
     }
-  }
-  else {
+  } else {
     // Not a client library error...
     throw error
   }
@@ -149,14 +148,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) {
+    if (authError.mustValidatePhoneNumber || authError.mustValidateEmailAddress) {
       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/baseApi.d.ts

@@ -6,4 +6,5 @@ export declare abstract class BaseApi {
     protected readonly events: PubSubJS.Base<any, PubSubJS.Message>;
     constructor(axiosInstance: AxiosInstance, consoleLogging?: boolean);
     protected request<T>(endpoint: string, method: string, body?: any, token?: string | null): Promise<T>;
+    private convertDatesToIso;
 }

package/dist/consumers/index.d.ts

@@ -1,7 +1,7 @@
 import { BaseApi } from '../baseApi';
-import { BasicConsumer, Consumer, Message } from './types';
+import { Consumer, Message } from './types';
 export declare class Consumers extends BaseApi {
-    createConsumer(request: BasicConsumer): Promise<Consumer>;
+    createConsumer(request: Consumer): Promise<Consumer>;
     updateConsumer(request: Consumer): Promise<Consumer>;
     deleteConsumer(): Promise<void>;
     getConsumer(): Promise<Consumer>;

package/dist/consumers/types.d.ts

@@ -121,9 +121,9 @@ export declare class BeneficiaryCard {
 /** Model to hold the unique details for a mobile money beneficiary. */
 export declare class BeneficiaryMobileWallet {
     /**
-    * Mobile Station International Subscriber Directory Number (MSISDN) is a number used to identify a mobile phone number internationally.
-    *             This number includes a country code and a National Destination Code which identifies the subscriber's operator.
-    */
+     * Mobile Station International Subscriber Directory Number (MSISDN) is a number used to identify a mobile phone number internationally.
+     *             This number includes a country code and a National Destination Code which identifies the subscriber's operator.
+     */
     msisdn: string;
     /** The mobile wallet operator that owns the mobile money account. */
     mobileWalletOperator: MobileWalletOperator;
@@ -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,10 @@ export declare enum ConsumerAttribute {
     MasterCardPAN = 2,
     RegistrationInvitationCode = 3,
     GMoneyWalletNumber = 4,
-    LinkedGcbBankAccountReferences = 5
+    LinkedGcbBankAccountReferences = 5,
+    MarketingConsent = 6,
+    CommunicationOutsideRegularHoursConsent = 7,
+    PrimarySourceOfFunds = 8
 }
 /** Model to hold various attributes about a consumer. */
 export declare class ConsumerAttributeValue {
@@ -283,9 +288,9 @@ export declare class ConsumerFile {
 }
 export declare class ConsumerMobileWallet {
     /**
-    * Mobile Station International Subscriber Directory Number (MSISDN) is a number used to identify a mobile phone number internationally.
-    *             This number includes a country code and a National Destination Code which identifies the subscriber's operator.
-    */
+     * Mobile Station International Subscriber Directory Number (MSISDN) is a number used to identify a mobile phone number internationally.
+     *             This number includes a country code and a National Destination Code which identifies the subscriber's operator.
+     */
     msisdn: string;
     /** The mobile wallet operator that owns the mobile money account. */
     mobileWalletOperator: MobileWalletOperator;