@vantagepay/vantagepay 0.17.4 → 0.18.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +68 -0
- package/LICENSE +21 -0
- package/README.md +267 -427
- package/dist/index.d.mts +12059 -0
- package/dist/index.d.ts +12039 -37
- package/dist/index.js +5992 -2
- package/dist/index.mjs +5697 -2
- package/package.json +25 -13
- package/dist/apiConfig.d.ts +0 -10
- package/dist/apiError.d.ts +0 -5
- package/dist/apiTokens.d.ts +0 -7
- package/dist/authentication/index.d.ts +0 -26
- package/dist/authentication/types.d.ts +0 -77
- package/dist/baseApi.d.ts +0 -10
- package/dist/common/types.d.ts +0 -137
- package/dist/consumers/index.d.ts +0 -25
- package/dist/consumers/types.d.ts +0 -622
- package/dist/content/index.d.ts +0 -7
- package/dist/devices/types.d.ts +0 -20
- package/dist/eventTypes.d.ts +0 -11
- package/dist/index.js.map +0 -1
- package/dist/index.mjs.map +0 -1
- package/dist/index.modern.mjs +0 -2
- package/dist/index.modern.mjs.map +0 -1
- package/dist/index.umd.js +0 -2
- package/dist/index.umd.js.map +0 -1
- package/dist/log/index.d.ts +0 -19
- package/dist/log/messageTemplate.d.ts +0 -10
- package/dist/log/types.d.ts +0 -20
- package/dist/lookups/index.d.ts +0 -31
- package/dist/lookups/types.d.ts +0 -1912
- package/dist/merchants/index.d.ts +0 -36
- package/dist/merchants/types.d.ts +0 -517
- package/dist/payments/index.d.ts +0 -38
- package/dist/payments/types.d.ts +0 -2036
- package/dist/qr/index.d.ts +0 -6
- package/dist/reports/index.d.ts +0 -10
- package/dist/reports/types.d.ts +0 -69
- package/dist/system/index.d.ts +0 -4
- package/dist/tokens/types.d.ts +0 -38
package/dist/qr/index.d.ts
DELETED
package/dist/reports/index.d.ts
DELETED
|
@@ -1,10 +0,0 @@
|
|
|
1
|
-
import { BaseApi } from '../baseApi';
|
|
2
|
-
import { Currency } from '../lookups/types';
|
|
3
|
-
import { TransactionDetailsByDayResponse, TransactionDetailsResponse, TransactionMonthSummaryResponse } from './types';
|
|
4
|
-
export declare class Reports extends BaseApi {
|
|
5
|
-
private dailyTransactionCache;
|
|
6
|
-
getRecentTransactions(limit?: number, successfulOnly?: boolean): Promise<TransactionDetailsResponse[]>;
|
|
7
|
-
getTransactionSummary(currency: Currency): Promise<TransactionMonthSummaryResponse>;
|
|
8
|
-
getAllTransactionDetails(currency: Currency, dateFrom?: string, dateTo?: string): Promise<TransactionDetailsResponse[]>;
|
|
9
|
-
getDailyTransactions(currency: Currency, dateFrom?: string, dateTo?: string): Promise<TransactionDetailsByDayResponse[]>;
|
|
10
|
-
}
|
package/dist/reports/types.d.ts
DELETED
|
@@ -1,69 +0,0 @@
|
|
|
1
|
-
import { Currency } from '../lookups/types';
|
|
2
|
-
import { TransactionIconType } from '../payments/types';
|
|
3
|
-
export declare class TransactionCategorySummaryResponse {
|
|
4
|
-
category: string;
|
|
5
|
-
transactionCount: number;
|
|
6
|
-
currency: Currency;
|
|
7
|
-
totalAmountInCents: number;
|
|
8
|
-
}
|
|
9
|
-
export declare class TransactionDetailsByDayResponse {
|
|
10
|
-
date: Date;
|
|
11
|
-
transactionCount: number;
|
|
12
|
-
currency: Currency;
|
|
13
|
-
totalCreditAmountInCents: number;
|
|
14
|
-
totalDebitAmountInCents: number;
|
|
15
|
-
totalAmountInCents: number;
|
|
16
|
-
totalCashbackInCents: number;
|
|
17
|
-
totalCommissionFeesInCents: number;
|
|
18
|
-
totalServiceFeesInCents: number;
|
|
19
|
-
totalELevyFeesInCents: number;
|
|
20
|
-
totalUserFeesInCents: number;
|
|
21
|
-
totalTipsInCents: number;
|
|
22
|
-
paymentDetails?: TransactionDetailsResponse[];
|
|
23
|
-
}
|
|
24
|
-
export declare class TransactionDetailsResponse {
|
|
25
|
-
paymentReference: string;
|
|
26
|
-
shortPaymentReference: string;
|
|
27
|
-
beneficiaryReference?: string;
|
|
28
|
-
productReference?: string;
|
|
29
|
-
channel: string;
|
|
30
|
-
transactionType: string;
|
|
31
|
-
sourceCategory: string;
|
|
32
|
-
destinationCategory: string;
|
|
33
|
-
sourceFacility: string;
|
|
34
|
-
destinationFacility: string;
|
|
35
|
-
sourceTransactionTypeDescription: string;
|
|
36
|
-
destinationTransactionTypeDescription: string;
|
|
37
|
-
sourceAccount?: string;
|
|
38
|
-
destinationAccount?: string;
|
|
39
|
-
name?: string;
|
|
40
|
-
transactionCompletedDate: Date;
|
|
41
|
-
currency: Currency;
|
|
42
|
-
amountInCents: number;
|
|
43
|
-
cashbackAmountInCents: number;
|
|
44
|
-
commissionFeeAmountInCents: number;
|
|
45
|
-
serviceFeeAmountInCents: number;
|
|
46
|
-
eLevyFeeAmountInCents: number;
|
|
47
|
-
userFeeAmountInCents: number;
|
|
48
|
-
tipAmountInCents: number;
|
|
49
|
-
isSuccess: boolean;
|
|
50
|
-
summaryStatus: string;
|
|
51
|
-
sourceStatus: string;
|
|
52
|
-
destinationStatus: string;
|
|
53
|
-
transactionIconType?: TransactionIconType;
|
|
54
|
-
wasQrCodeInitiated: boolean;
|
|
55
|
-
}
|
|
56
|
-
export declare class TransactionMonthSummaryResponse {
|
|
57
|
-
year: number;
|
|
58
|
-
month: number;
|
|
59
|
-
currency: Currency;
|
|
60
|
-
description: string;
|
|
61
|
-
totalAmountInCents: number;
|
|
62
|
-
periodTotals: TransactionPeriodSummaryResponse[];
|
|
63
|
-
}
|
|
64
|
-
export declare class TransactionPeriodSummaryResponse {
|
|
65
|
-
description: string;
|
|
66
|
-
currency: Currency;
|
|
67
|
-
totalAmountInCents: number;
|
|
68
|
-
categoryTotals?: TransactionCategorySummaryResponse[];
|
|
69
|
-
}
|
package/dist/system/index.d.ts
DELETED
package/dist/tokens/types.d.ts
DELETED
|
@@ -1,38 +0,0 @@
|
|
|
1
|
-
import { Bank } from '../lookups/types';
|
|
2
|
-
import { Month } from '../lookups/types';
|
|
3
|
-
import { Currency } from '../lookups/types';
|
|
4
|
-
export declare class BankAccountRequest {
|
|
5
|
-
accountNumber: string;
|
|
6
|
-
bank: Bank;
|
|
7
|
-
}
|
|
8
|
-
export declare class BankAccountResponse {
|
|
9
|
-
token: string;
|
|
10
|
-
}
|
|
11
|
-
export declare class CardRequest {
|
|
12
|
-
cardNumber: string;
|
|
13
|
-
nameOnCard: string;
|
|
14
|
-
expiryMonth: Month;
|
|
15
|
-
expiryYear: number;
|
|
16
|
-
}
|
|
17
|
-
/** A model to hold the details of a card response that is returned to a caller when they tokenize a card or verify a tokenized card. */
|
|
18
|
-
export declare class CardResponse {
|
|
19
|
-
/** The card token that was generated by the system. */
|
|
20
|
-
token: string;
|
|
21
|
-
/** A boolean value indicating whether the small test payment that is required to verify this card, if <see cref="P:ZGA.Core.Models.Tokens.CardResponse.RequiresVerification" />=True, has been completed yet. */
|
|
22
|
-
requiresPayment: boolean;
|
|
23
|
-
/** A boolean value indicating whether this card needs to be verified before it can be activated for use on this system. */
|
|
24
|
-
requiresVerification: boolean;
|
|
25
|
-
/** How many times verification of this card can still be attempted before the card is locked and it will no longer be possible to activate it. */
|
|
26
|
-
verificationAttemptsRemaining: number;
|
|
27
|
-
/** The currency in which the verification payment was made. */
|
|
28
|
-
paymentCurrency: Currency;
|
|
29
|
-
/** The amount, in cents, of the verification payment that was made. */
|
|
30
|
-
paymentAmountInCents: number;
|
|
31
|
-
}
|
|
32
|
-
/** A model to hold the details of a card verification submission. */
|
|
33
|
-
export declare class VerifyCardRequest {
|
|
34
|
-
/** A card token. */
|
|
35
|
-
token: string;
|
|
36
|
-
/** The verification code that appeared on the credit card statement after the verification test payment was made. */
|
|
37
|
-
verificationCode: string;
|
|
38
|
-
}
|