mpp-sdk
Version:
SDK to talk to the Memento Payments Platform
49 lines (48 loc) • 2.14 kB
TypeScript
import { BaseEndpoint } from "./base.js";
import { InternalTransaction, InternalTransactionFilter, ReceiptUploadMethods, TransactionInput, TransactionReceipt } from "../types/transactions.js";
import { Category, CategoryFilter } from "../types/categories.js";
export default class TransactionsEndpoint extends BaseEndpoint {
/**
* Gets available transactions for current user
* @returns a list of available transactions
*/
list(filters?: InternalTransactionFilter): Promise<import("../index.js").MPPResult<InternalTransaction[]>>;
/**
* Gets available transactions for current user with the "missing_data" status
* @returns a list of available transactions
*/
todo(filters?: InternalTransactionFilter): Promise<import("../index.js").MPPResult<InternalTransaction[]>>;
/**
* Gets a transaction
* @param data
* @returns transaction
*/
get(id: string): Promise<import("../index.js").MPPResult<InternalTransaction>>;
/**
* Gets available transaction categories for current user
* @returns a list of available transaction categories
*/
categories(filters?: CategoryFilter): Promise<import("../index.js").MPPResult<Category[]>>;
/**
* Updates a transaction
* @returns the updated transaction object
*/
update(id: string, data: TransactionInput): Promise<import("../index.js").MPPResult<InternalTransaction>>;
/**
* Gets all receipts fro a transaction
* @returns a list of receipts for a transactions
*/
listReceipts(transaction_id: string): Promise<import("../index.js").MPPResult<TransactionReceipt[]>>;
/**
* Uploads a receipt for a transaction
* @returns a transaction receipt
*/
uploadReceipt(transaction_id: string, input: ReceiptUploadMethods): Promise<import("../index.js").MPPResult<TransactionReceipt>>;
/**
* Overrides the team of a transaction.
* @param transaction_id
* @param team_id
* @returns the affected transaction
*/
setTeam(transaction_id: string, team_id: string): Promise<import("../index.js").MPPResult<InternalTransaction>>;
}