@vantagepay/vantagepay 0.15.0

package/dist/qr/index.d.ts

@@ -0,0 +1,6 @@
+import { BaseApi } from '../baseApi';
+export declare class QrCodes extends BaseApi {
+    private readonly qrCache;
+    decode(qrCode: string): Promise<any>;
+    generate(text: string, width?: number): Promise<string>;
+}

package/dist/reports/index.d.ts

@@ -0,0 +1,8 @@
+import { BaseApi } from '../baseApi';
+import { Currency } from '../lookups/types';
+import { SalesDetailsByDayResponse, SalesDetailsResponse, SalesMonthSummaryResponse } from './types';
+export declare class Reports extends BaseApi {
+    getRecentSales(limit?: number, successfulOnly?: boolean): Promise<SalesDetailsResponse[]>;
+    getDailySales(currency: Currency, dateFrom?: string, dateTo?: string): Promise<SalesDetailsByDayResponse[]>;
+    getSalesSummary(currency: Currency): Promise<SalesMonthSummaryResponse>;
+}

package/dist/reports/types.d.ts

@@ -0,0 +1,67 @@
+import { Currency } from '../lookups/types';
+import { TransactionIconType } from '../payments/types';
+export declare class SalesCategorySummaryResponse {
+    category: string;
+    transactionCount: number;
+    currency: Currency;
+    totalSalesInCents: number;
+}
+export declare class SalesDetailsByDayResponse {
+    date: Date;
+    transactionCount: number;
+    currency: Currency;
+    totalSalesInCents: number;
+    totalCashbackInCents: number;
+    totalCommissionFeesInCents: number;
+    totalServiceFeesInCents: number;
+    totalELevyFeesInCents: number;
+    totalUserFeesInCents: number;
+    totalTipsInCents: number;
+    paymentDetails?: SalesDetailsResponse[];
+}
+export declare class SalesDetailsResponse {
+    paymentReference: string;
+    shortPaymentReference: string;
+    channel: string;
+    transactionType: string;
+    category: string;
+    sourceCategory: string;
+    destinationCategory: string;
+    sourceFacility: string;
+    destinationFacility: string;
+    sourceTransactionTypeDescription: string;
+    destinationTransactionTypeDescription: string;
+    sourceAccount?: string;
+    destinationAccount?: string;
+    name?: string;
+    transactionCompletedDate: Date;
+    currency: Currency;
+    amountInCents: number;
+    cashbackAmountInCents: number;
+    commissionFeeAmountInCents: number;
+    serviceFeeAmountInCents: number;
+    eLevyFeeAmountInCents: number;
+    userFeeAmountInCents: number;
+    tipAmountInCents: number;
+    isSuccess: boolean;
+    status: string;
+    summaryStatus: string;
+    sourceStatus: string;
+    destinationStatus: string;
+    transactionIconType: TransactionIconType;
+    wasQrCodeInitiated: boolean;
+}
+export declare class SalesMonthSummaryResponse {
+    year: number;
+    month: number;
+    currency: Currency;
+    description: string;
+    totalSalesInCents: number;
+    periodTotals: SalesPeriodSummaryResponse[];
+}
+export declare class SalesPeriodSummaryResponse {
+    description: string;
+    currency: Currency;
+    totalSalesInCents: number;
+    categoryTotals?: SalesCategorySummaryResponse[];
+}

package/dist/system/index.d.ts

@@ -0,0 +1,4 @@
+import { BaseApi } from '../baseApi';
+export declare class System extends BaseApi {
+    ping(): Promise<void>;
+}

package/dist/tokens/types.d.ts

@@ -0,0 +1,38 @@
+import { Bank } from '../lookups/types';
+import { Month } from '../lookups/types';
+import { Currency } from '../lookups/types';
+export declare class BankAccountRequest {
+    accountNumber: string;
+    bank: Bank;
+}
+export declare class BankAccountResponse {
+    token: string;
+}
+export declare class CardRequest {
+    cardNumber: string;
+    nameOnCard: string;
+    expiryMonth: Month;
+    expiryYear: number;
+}
+/** 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. */
+export declare class CardResponse {
+    /** The card token that was generated by the system. */
+    token: string;
+    /** 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. */
+    requiresPayment: boolean;
+    /** A boolean value indicating whether this card needs to be verified before it can be activated for use on this system. */
+    requiresVerification: boolean;
+    /** 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. */
+    verificationAttemptsRemaining: number;
+    /** The currency in which the verification payment was made. */
+    paymentCurrency: Currency;
+    /** The amount, in cents, of the verification payment that was made. */
+    paymentAmountInCents: number;
+}
+/** A model to hold the details of a card verification submission. */
+export declare class VerifyCardRequest {
+    /** A card token. */
+    token: string;
+    /** The verification code that appeared on the credit card statement after the verification test payment was made. */
+    verificationCode: string;
+}

package/dist/transflow/index.d.ts

@@ -0,0 +1,11 @@
+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

@@ -0,0 +1,11 @@
+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;
+}

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@vantagepay/vantagepay",
+  "version": "0.15.0",
+  "description": "VantagePay API wrapper and SDK for integrating into VantagePay payment, consumer and merchant services.",
+  "main": "./dist/index.js",
+  "module": "./dist/index.m.js",
+  "unpkg": "./dist/index.umd.js",
+  "source": "./src/index.ts",
+  "repository": {
+    "type": "git",
+    "url": ""
+  },
+  "scripts": {
+    "build": "microbundle --tsconfig tsconfig.json",
+    "dev": "microbundle watch --tsconfig tsconfig.json",
+    "test": "jest --coverage",
+    "ncu": "npx npm-check-updates --interactive"
+  },
+  "dependencies": {
+    "@microsoft/signalr": "^9.0.6",
+    "axios": "^1.13.0",
+    "axios-auth-refresh": "^3.3.6",
+    "axios-retry": "^4.5.0",
+    "pubsub-js": "^1.9.5",
+    "qrcode": "^1.5.4"
+  },
+  "devDependencies": {
+    "@types/es6-promise": "^3.3.2",
+    "@types/jest": "^30.0.0",
+    "@types/pubsub-js": "^1.8.6",
+    "@types/qrcode": "^1.5.6",
+    "jest": "^30.2.0",
+    "microbundle": "0.15.1",
+    "ts-jest": "^29.4.5"
+  },
+  "keywords": [
+    "vantagepay",
+    "sdk",
+    "api",
+    "client"
+  ],
+  "author": "VantagePay <npm@vantagepay.com>",
+  "license": "MIT",
+  "files": [
+    "dist"
+  ]
+}