assembly-payments
Version:
Assembly Payments API Typescript/Javascript Bindings
83 lines (82 loc) • 2.82 kB
TypeScript
import { Client } from '../client';
import { SingleDisbursement, Disbursements, Transactions, WalletAccount, BankAccount, Items, SingleUser } from '../types';
declare const _default: (client: Client) => {
/**
* @description Retrieve an ordered and paginated list of existing **Disbursements**. The list can be filtered by **Batch ID**.
*
* @tags Disbursements
* @name ListDisbursement
* @summary List Disbursements
* @request GET:/disbursements
* @secure
*/
listDisbursement: (params?: {
limit?: number | undefined;
offset?: number | undefined;
batch_id?: string | undefined;
} | undefined) => Promise<Disbursements>;
/**
* @description Get a disbursment using its ID
*
* @tags Disbursements
* @name ShowDisbursement
* @summary Show Disbursement
* @request GET:/disbursements/{id}
* @secure
*/
showDisbursement: (id: string) => Promise<SingleDisbursement>;
/**
* @description Get all the transactions relating to a disbursment ID
*
* @tags Disbursements
* @name ShowDisbursementTransactions
* @summary Show Disbursement Transactions
* @request GET:/disbursements/{id}/transactions
* @secure
*/
showDisbursementTransactions: (id: string, params?: {
limit?: number | undefined;
offset?: number | undefined;
} | undefined) => Promise<Transactions>;
/**
* @description Get all the wallet accounts relating to a disbursment ID
*
* @tags Disbursements
* @name ShowDisbursementWalletAccounts
* @summary Show Disbursement Wallet Accounts
* @request GET:/disbursements/{id}/wallet_accounts
* @secure
*/
showDisbursementWalletAccounts: (id: string) => Promise<WalletAccount>;
/**
* @description Get all the bank accounts relating to disbursement ID
*
* @tags Disbursements
* @name ShowDisbursementBankAccounts
* @summary Show Disbursement Bank Accounts
* @request GET:/disbursements/{id}/bank_accounts
* @secure
*/
showDisbursementBankAccounts: (id: string) => Promise<BankAccount>;
/**
* @description Get all the users relating to disbursement ID
*
* @tags Disbursements
* @name ShowDisbursementUsers
* @summary Show Disbursement Users
* @request GET:/disbursements/{id}/users
* @secure
*/
showDisbursementUsers: (id: string) => Promise<SingleUser>;
/**
* @description Get all the items relating to a disbursement ID
*
* @tags Disbursements
* @name ShowDisbursementItems
* @summary Show Disbursement Items
* @request GET:/disbursements/{id}/items
* @secure
*/
showDisbursementItems: (id: string) => Promise<Items>;
};
export default _default;