@spritz-finance/service-client 0.5.2 → 0.5.4

package/lib/liabilities/liabilitiesServiceClient.d.ts

@@ -1,7 +1,7 @@
 export * as LiabilitiesClient from './liabilitiesServiceClient';
 import { CheckbookUser } from '../lib/graphClient/generated';
 import { ExternalBillInput } from '../payableAccounts/types';
-import { CheckbookCardResponse, CheckbookDebitCardResponse, CheckbookDigitalAccountResponse, CheckbookUpdateCardResponse, CreateCheckbookUserParams, CreateDebitCardInput, CreateDigitalAccountInput, CreateEntityParams, MethodFiEntity, RewardTransaction } from './types';
+import { CheckbookCardResponse, CheckbookDebitCardResponse, CheckbookDigitalAccountResponse, CheckbookUpdateCardResponse, CreateCheckbookUserParams, CreateDebitCardInput, CreateDigitalAccountInput, CreateEntityParams, DirectPaymentResponse, MethodFiEntity, RewardTransaction } from './types';
 export declare function getRewardTransaction(transactionId: string): Promise<RewardTransaction>;
 export declare function createMethodFiEntity(args: CreateEntityParams): Promise<MethodFiEntity>;
 export declare function getMethodFiEntity(userId: string): Promise<MethodFiEntity>;
@@ -26,3 +26,4 @@ export declare function addCashbackCredit(input: {
     rewardId: string;
 }): Promise<import("../types").ApiFailure | import("../types").ApiSuccess<RewardTransaction>>;
 export declare function getRewardTransactionsFor(userId: string): Promise<import("../types").ApiFailure | import("../types").ApiSuccess<RewardTransaction[]>>;
+export declare function getDirectPayment(directPaymentId: string): Promise<import("../types").ApiFailure | import("../types").ApiSuccess<DirectPaymentResponse>>;

package/lib/liabilities/liabilitiesServiceClient.js

@@ -23,7 +23,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getRewardTransactionsFor = exports.addCashbackCredit = exports.addPromotionCredit = exports.updateCheckbookVirtualCard = exports.getUserIdForDirectPayment = exports.getVirtualCardBalance = exports.createUSBillFromAccountNumber = exports.createCheckbookDigitalAccount = exports.createCheckbookDebitCard = exports.createCheckbookVirtualCard = exports.getCheckbookUser = exports.upsertCheckbookUser = exports.createCheckbookUser = exports.getMethodFiEntity = exports.createMethodFiEntity = exports.getRewardTransaction = exports.LiabilitiesClient = void 0;
+exports.getDirectPayment = exports.getRewardTransactionsFor = exports.addCashbackCredit = exports.addPromotionCredit = exports.updateCheckbookVirtualCard = exports.getUserIdForDirectPayment = exports.getVirtualCardBalance = exports.createUSBillFromAccountNumber = exports.createCheckbookDigitalAccount = exports.createCheckbookDebitCard = exports.createCheckbookVirtualCard = exports.getCheckbookUser = exports.upsertCheckbookUser = exports.createCheckbookUser = exports.getMethodFiEntity = exports.createMethodFiEntity = exports.getRewardTransaction = exports.LiabilitiesClient = void 0;
 exports.LiabilitiesClient = __importStar(require("./liabilitiesServiceClient"));
 const serviceClient_1 = require("../serviceClient");
 const LIABILITIES_ENDPOINT = '/liabilities';
@@ -129,3 +129,10 @@ async function getRewardTransactionsFor(userId) {
         .then((res) => res.data);
 }
 exports.getRewardTransactionsFor = getRewardTransactionsFor;
+const LIABILITIES_V2_ENDPOINT = '/v2/liabilities/api';
+async function getDirectPayment(directPaymentId) {
+    return serviceClient_1.baseClient
+        .get(`${LIABILITIES_V2_ENDPOINT}/direct-payment/${directPaymentId}`)
+        .then((res) => res.data);
+}
+exports.getDirectPayment = getDirectPayment;

package/lib/liabilities/types.d.ts

@@ -200,4 +200,110 @@ export type CheckbookUpdateCardResponse = {
     email: string;
     holder: string;
 };
+export type DirectPaymentResponse = {
+    _id: string;
+    id: string;
+    userId: string;
+    accountId: string;
+    createdAt: string;
+    updatedAt: string;
+    status: 'CREATED' | 'TRANSACTION_PENDING' | 'TRANSACTION_FAILED' | 'INSUFFICIENT_FUNDS' | 'CONFIRMED' | 'PENDING' | 'FAILED' | 'FAILED_VALIDATION' | 'REFUNDED' | 'COMPLETED';
+    toAddress: string;
+    amount: number;
+    rewardsAmount: number;
+    feeAmount: number;
+    feeSubsidyAmount: number;
+    transactionFee: number;
+    feeDiscount: number;
+    source: 'Web' | 'Mobile' | 'MobileIOS' | 'MobileAndroid' | 'ExodusDappBrowser' | 'SuiWalletDappBrowser' | 'Integrator' | 'Widget' | 'PaymentAddress' | 'Subscription' | 'External' | 'Admin';
+    deliveryMethod: 'INSTANT' | 'STANDARD' | 'SAME_DAY';
+    tokenAddress: string;
+    network: string;
+    targetCurrency: string;
+    targetCurrencyRate: number;
+    targetCurrencyFee: number;
+    targetCurrencyAmount: number;
+    isToPaymentAddress: boolean;
+    paymentId: string;
+    amountDue: number;
+    totalAmount: number;
+    from?: string[];
+    instantPaymentFeeExempt?: boolean;
+    transactionHash?: string;
+    compoundTransactionIdentifier?: number;
+    transaction?: TransactionReference;
+    transactionReferences: TransactionReference[];
+    pointsRedemptionId?: string;
+    pointsRedemptionAmount?: number;
+    pointsRedemptionDiscount?: number;
+    paymentNote?: string;
+    pendingAlertAt?: string;
+    subscriptionId?: string;
+    utxoInvoiceId?: string;
+    message?: string;
+    paymentProvider?: 'METHOD_FI' | 'CHECKBOOK' | 'UNBLOCK' | 'BRIDGE' | 'RAIN';
+    externalPaymentId?: string;
+    integratorId?: string;
+    paymentAsset?: PaymentAssetResponse;
+    outputAsset?: PaymentAssetResponse;
+    invoice: InvoiceResponse | null;
+};
+interface TransactionReference {
+    hash: string;
+    network: string;
+    status: 'PENDING' | 'CONFIRMED';
+    asset?: string;
+    value?: number;
+    sourceToken?: PaymentEventToken;
+    paymentToken?: PaymentEventToken;
+    from?: string[];
+    to?: string;
+}
+interface PaymentEventToken {
+    address: string;
+    amountRaw: string;
+    amount: number;
+    decimals: number;
+    symbol: string;
+}
+interface PaymentAssetResponse {
+    symbol: string;
+    quantity: number;
+    usdMarketRate: number;
+    usdQuotedRate: number;
+    usdValue: number;
+    usdValueQuoted: number;
+    spread: number;
+}
+interface InvoiceResponse {
+    _id: string;
+    network: string;
+    address: string;
+    paymentReference: string;
+    expiry: string;
+    amountFiat: number;
+    amount: number;
+    marketRate: number;
+    quotedRate: number;
+    spreadAmount: number;
+    spread: number;
+    amountFiatAdjusted: number;
+    tokenAddress: string;
+    symbol: string;
+    status: 'CREATED' | 'PENDING' | 'CONFIRMED' | 'INSUFFICCIENT' | 'TRANSFERRED';
+    createdAt: string;
+    checked: boolean;
+    harvested: number;
+    decimals: number;
+    sweepTransaction?: unknown;
+    transaction?: {
+        transactionId: string;
+        amount: number;
+        direction: string;
+        firstSeenInMempool: string;
+        blockHash?: string;
+        blockTimestamp?: string;
+        from?: string[];
+    };
+}
 export {};

package/lib/payments/paymentsClient.d.ts

@@ -57,3 +57,6 @@ export declare function getAllPaymentsForUser(userId: string): Promise<import(".
 export declare function getUserPaymentById(userId: string, paymentId: string): Promise<import("../types").ApiFailure | import("../types").ApiSuccess<Payment>>;
 export declare function directPaymentsForRiskAnalysis(userId: string): Promise<import("../types").ApiFailure | import("../types").ApiSuccess<DirectPaymentModel[]>>;
 export declare function queryUserPayments(userId: string, input?: PaymentQueryFilter): Promise<import("../types").ApiFailure | import("../types").ApiSuccess<Payment[]>>;
+export declare function getVoidedLiabilities(): Promise<import("../types").ApiFailure | import("../types").ApiSuccess<{
+    total: number;
+}>>;

package/lib/payments/paymentsClient.js

@@ -23,7 +23,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.queryUserPayments = exports.directPaymentsForRiskAnalysis = exports.getUserPaymentById = exports.getAllPaymentsForUser = exports.getDirectPaymentDetails = exports.getDirectPaymentToken = exports.updateExternalPaymentStatus = exports.scheduleExternalPayment = exports.initializeExternalPayment = exports.getRewardFeeAmount = exports.getRewardTransactionVolume = exports.getValidPaymentsForUser = exports.getValidPaymentsForAccount = exports.validateDirectPayment = exports.validatePaymentAmount = exports.createDirectPayment = exports.PaymentsClient = void 0;
+exports.getVoidedLiabilities = exports.queryUserPayments = exports.directPaymentsForRiskAnalysis = exports.getUserPaymentById = exports.getAllPaymentsForUser = exports.getDirectPaymentDetails = exports.getDirectPaymentToken = exports.updateExternalPaymentStatus = exports.scheduleExternalPayment = exports.initializeExternalPayment = exports.getRewardFeeAmount = exports.getRewardTransactionVolume = exports.getValidPaymentsForUser = exports.getValidPaymentsForAccount = exports.validateDirectPayment = exports.validatePaymentAmount = exports.createDirectPayment = exports.PaymentsClient = void 0;
 exports.PaymentsClient = __importStar(require("./paymentsClient"));
 const serviceClient_1 = require("../serviceClient");
 const PAYMENTS_ENDPOINT = "/liabilities";
@@ -127,3 +127,9 @@ async function queryUserPayments(userId, input = {}) {
         .then((res) => res.data);
 }
 exports.queryUserPayments = queryUserPayments;
+async function getVoidedLiabilities() {
+    return serviceClient_1.baseClient
+        .get(`${PAYMENTS_ROUTER_ENDPOINT}/checkbook/voided-liabilities`)
+        .then((res) => res.data);
+}
+exports.getVoidedLiabilities = getVoidedLiabilities;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@spritz-finance/service-client",
-  "version": "0.5.2",
+  "version": "0.5.4",
   "gitHead": "06f8e96b7b38c34df26a38da329331940675e4f8",
   "description": "Service client",
   "license": "ISC",