@vasrefil/api-toolkit 1.0.14 → 1.0.15

package/dist/interfaces/index.d.ts

@@ -3,3 +3,5 @@ export * from './status.interface';
 export * from './root-controller.interface';
 export * from './interface';
 export * from './env.interface';
+export * from './transaction.interface';
+export * from './voucher.interface';

package/dist/interfaces/index.js

@@ -19,3 +19,5 @@ __exportStar(require("./status.interface"), exports);
 __exportStar(require("./root-controller.interface"), exports);
 __exportStar(require("./interface"), exports);
 __exportStar(require("./env.interface"), exports);
+__exportStar(require("./transaction.interface"), exports);
+__exportStar(require("./voucher.interface"), exports);

package/dist/interfaces/transaction.interface.d.ts

@@ -0,0 +1,90 @@
+import { VoucherTypeI } from "./voucher.interface";
+export declare enum TransactionStatusI {
+    SUCCESS = "SUCCESS",
+    FAILED = "FAILED",
+    PROCESSING = "PROCESSING",
+    PENDING = "PENDING",
+    CANCELLED = "CANCELLED"
+}
+export declare enum TransactionTypeI {
+    VAS = "VAS",
+    EDUCATION = "EDUCATION",
+    PAYMENT = "PAYMENT",
+    FUNDS_TRANSFER = "FUNDS_TRANSFER",
+    WITHDRAW = "WITHDRAW",
+    EDUCATION_PAYMENT_WITHDRAW = "EDUCATION_PAYMENT_WITHDRAW",
+    VASPOINT_WITHDRAW = "VASPOINT_WITHDRAW",
+    ADMIN_CREDIT = "ADMIN_CREDIT",
+    ADMIN_DEBIT = "ADMIN_DEBIT",
+    PROMOTION = "PROMOTION"
+}
+export declare enum TransactionActionTypeI {
+    CREDIT = "CREDIT",
+    DEBIT = "DEBIT"
+}
+export declare enum TransactionServieTypeI {
+    AIRTIME = "AIRTIME",
+    DATA_BUNDLE = "DATA_BUNDLE",
+    CABLE_TV = "CABLE_TV",
+    ELECTRICITY = "ELECTRICITY",
+    DEPARTMENTAL_DUES = "DEPARTMENTAL_DUES",
+    HANDOUT = "HANDOUT",
+    FACULTY_DUES = "FACULTY_DUES",
+    CREDIT_WALLET = "CREDIT_WALLET",
+    CASHBACK_CREDIT = "CASHBACK_CREDIT",
+    DEBIT_WALLET = "DEBIT_WALLET"
+}
+export interface TransactionI {
+    _id?: string;
+    user_id: string;
+    reference_id: string;
+    service_type: TransactionServieTypeI;
+    service_provider: string | any;
+    amount: number;
+    recipient: string;
+    status: TransactionStatusI;
+    type: TransactionTypeI;
+    title: string;
+    action_type: TransactionActionTypeI;
+    total_amount: number;
+    platform_provider?: string;
+    plan_name?: string;
+    plan_id?: string;
+    meter_type?: string;
+    electricity_token?: string;
+    customer_name?: string;
+    customer_address?: string;
+    trans_id?: string;
+    service_fees?: number;
+    createdAt?: string;
+    debited_amount?: number;
+    beneficiary_name?: string;
+    transferred_fund_recipients?: any[];
+    description?: string;
+    reciever_amount?: number;
+    customer?: {
+        phone: string;
+    };
+    cabletv?: {
+        subscription_type: 'renew' | 'change';
+    };
+    metadata?: {
+        phone_is_ported: boolean;
+    };
+    voucher?: {
+        code: string;
+        amount: number;
+        redeem_id: string;
+        type: VoucherTypeI;
+    };
+    user_balance?: {
+        initial_balance: number;
+        final_balance: number;
+    };
+    profit?: number;
+    payment_sender_id?: string;
+    formatted_amount?: string;
+    formatted_total_amount?: string;
+    formatted_service_fees?: string;
+    formatted_debited_amount?: string;
+}

package/dist/interfaces/transaction.interface.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TransactionServieTypeI = exports.TransactionActionTypeI = exports.TransactionTypeI = exports.TransactionStatusI = void 0;
+var TransactionStatusI;
+(function (TransactionStatusI) {
+    TransactionStatusI["SUCCESS"] = "SUCCESS";
+    TransactionStatusI["FAILED"] = "FAILED";
+    TransactionStatusI["PROCESSING"] = "PROCESSING";
+    TransactionStatusI["PENDING"] = "PENDING";
+    TransactionStatusI["CANCELLED"] = "CANCELLED";
+})(TransactionStatusI || (exports.TransactionStatusI = TransactionStatusI = {}));
+var TransactionTypeI;
+(function (TransactionTypeI) {
+    TransactionTypeI["VAS"] = "VAS";
+    TransactionTypeI["EDUCATION"] = "EDUCATION";
+    TransactionTypeI["PAYMENT"] = "PAYMENT";
+    TransactionTypeI["FUNDS_TRANSFER"] = "FUNDS_TRANSFER";
+    TransactionTypeI["WITHDRAW"] = "WITHDRAW";
+    TransactionTypeI["EDUCATION_PAYMENT_WITHDRAW"] = "EDUCATION_PAYMENT_WITHDRAW";
+    TransactionTypeI["VASPOINT_WITHDRAW"] = "VASPOINT_WITHDRAW";
+    TransactionTypeI["ADMIN_CREDIT"] = "ADMIN_CREDIT";
+    TransactionTypeI["ADMIN_DEBIT"] = "ADMIN_DEBIT";
+    TransactionTypeI["PROMOTION"] = "PROMOTION";
+})(TransactionTypeI || (exports.TransactionTypeI = TransactionTypeI = {}));
+var TransactionActionTypeI;
+(function (TransactionActionTypeI) {
+    TransactionActionTypeI["CREDIT"] = "CREDIT";
+    TransactionActionTypeI["DEBIT"] = "DEBIT";
+})(TransactionActionTypeI || (exports.TransactionActionTypeI = TransactionActionTypeI = {}));
+var TransactionServieTypeI;
+(function (TransactionServieTypeI) {
+    TransactionServieTypeI["AIRTIME"] = "AIRTIME";
+    TransactionServieTypeI["DATA_BUNDLE"] = "DATA_BUNDLE";
+    TransactionServieTypeI["CABLE_TV"] = "CABLE_TV";
+    TransactionServieTypeI["ELECTRICITY"] = "ELECTRICITY";
+    TransactionServieTypeI["DEPARTMENTAL_DUES"] = "DEPARTMENTAL_DUES";
+    TransactionServieTypeI["HANDOUT"] = "HANDOUT";
+    TransactionServieTypeI["FACULTY_DUES"] = "FACULTY_DUES";
+    TransactionServieTypeI["CREDIT_WALLET"] = "CREDIT_WALLET";
+    TransactionServieTypeI["CASHBACK_CREDIT"] = "CASHBACK_CREDIT";
+    TransactionServieTypeI["DEBIT_WALLET"] = "DEBIT_WALLET";
+})(TransactionServieTypeI || (exports.TransactionServieTypeI = TransactionServieTypeI = {}));

package/dist/interfaces/voucher.interface.d.ts

@@ -0,0 +1,69 @@
+import { TransactionServieTypeI } from "./transaction.interface";
+import { UserI } from "./user.interface";
+export interface VoucherPayloadI {
+    transaction: VoucherTransactionI;
+}
+export interface VoucherTransactionI {
+    service_type: TransactionServieTypeI;
+    amount: number;
+    service_provider: string;
+    plan: string;
+    recipient: string;
+    customer?: {
+        email: string;
+        name: string;
+    };
+}
+export interface VoucherTransI {
+    code: string;
+    transaction: VoucherTransactionI;
+}
+export interface ValidateRedeemRespI {
+    message: string;
+    deductible_amount: number;
+    redeem_details?: {
+        _id: string;
+    };
+    validation_details?: ValidationDetailsI;
+}
+export interface ValidationDetailsI {
+    deductible_amount: number;
+    type: VoucherTypeI;
+    message: string;
+    discount: {
+        percentage: number;
+        is_capped: boolean;
+        capped_amount: number;
+    };
+}
+export interface ValidateDataPlanVoucherRespI {
+    status: boolean;
+    data?: ValidateRedeemRespI;
+    error?: any;
+}
+export interface ValidityChecksPayloadI {
+    user: UserI;
+    voucher: VoucherTransI;
+    options?: {
+        validate_user_payment?: boolean;
+    };
+}
+export declare enum VoucherTypeI {
+    DISCOUNT = "DISCOUNT",
+    CASHBACK = "CASHBACK",
+    VAS_GIFT = "VAS_GIFT"
+}
+export declare enum VoucherAmountTypeI {
+    FIXED = "FIXED",
+    PERCENTAGE = "PERCENTAGE"
+}
+export interface VoucherConfigI {
+    _id?: string;
+    amount: number;
+    amount_type: VoucherAmountTypeI;
+    is_capped?: boolean;
+    capped_amount?: number;
+}
+export interface ReferralConfigI extends VoucherConfigI {
+    id: string;
+}

package/dist/interfaces/voucher.interface.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VoucherAmountTypeI = exports.VoucherTypeI = void 0;
+var VoucherTypeI;
+(function (VoucherTypeI) {
+    VoucherTypeI["DISCOUNT"] = "DISCOUNT";
+    VoucherTypeI["CASHBACK"] = "CASHBACK";
+    VoucherTypeI["VAS_GIFT"] = "VAS_GIFT";
+})(VoucherTypeI || (exports.VoucherTypeI = VoucherTypeI = {}));
+var VoucherAmountTypeI;
+(function (VoucherAmountTypeI) {
+    VoucherAmountTypeI["FIXED"] = "FIXED";
+    VoucherAmountTypeI["PERCENTAGE"] = "PERCENTAGE";
+})(VoucherAmountTypeI || (exports.VoucherAmountTypeI = VoucherAmountTypeI = {}));

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@vasrefil/api-toolkit",
   "description": "This is Vasrefil API toolkit",
-  "version": "1.0.14",
+  "version": "1.0.15",
   "author": "Sodiq Alabi",
   "main": "dist/public-api.js",
   "types": "dist/public-api.d.ts",