up-bank-typescript/dist/services/transactions/index.d.ts

Typescript wrapper for Up Bank API

import { Fetch } from '../fetch';
import { TagIdentifier } from '../tags/types';
import { TransactionResponse, TransactionsParams, TransactionsResponse } from './types';
/**
 * Transactions represent the movement of money into and out of an account.
 * They have many characteristics that vary depending on the kind of
 * transaction. Transactions may be temporarily HELD (pending) or SETTLED,
 * typically depending on which payment method was used at the point of sale.
 */
export declare class Transactions {
    private fetch;
    constructor(fetch: Fetch);
    /**
     * Retrieve a list of all transactions across all accounts for the currently
     * authenticated user. The returned list is paginated and can be scrolled by
     * following the next and prev links where present. To narrow the results to
     * a specific date range pass one or both of filter[since] and filter[until]
     * in the query string. These filter parameters should not be used for
     * pagination. Results are ordered newest first to oldest last.
     * @param params
     */
    list(params?: TransactionsParams): Promise<TransactionsResponse>;
    /**
     * Retrieve a specific transaction by providing its unique identifier.
     * @param id The unique identifier for the transaction.
     */
    get(id: string): Promise<TransactionResponse>;
    /**
     * Associates one or more tags with a specific transaction. No more than 6
     * tags may be present on any single transaction. Duplicate tags are silently
     * ignored. An HTTP 204 is returned on success. The associated tags, along
     * with this request URL, are also exposed via the tags relationship on the
     * transaction resource returned from /transactions/{id}.
     * @param transaction The unique identifier for the transaction.
     * @param tags The tags to remove from the transaction.
     */
    addTags(transaction: string, tags: Array<TagIdentifier>): Promise<boolean>;
    /**
     * Disassociates one or more tags from a specific transaction. Tags that are
     * not associated are silently ignored. An HTTP 204 is returned on success.
     * The associated tags, along with this request URL, are also exposed via the
     * tags relationship on the transaction resource returned from /transactions/{id}.
     * @param transaction The unique identifier for the transaction.
     * @param tags The tags to remove from the transaction.
     */
    removeTags(transaction: string, tags: Array<TagIdentifier>): Promise<boolean>;
}