@mollie/api-client/dist/types/data/settlements/SettlementHelper.d.ts

Official Mollie API client for Node

import type TransformingNetworkClient from '../../communication/TransformingNetworkClient';
import { type Capture } from '../../types';
import type Callback from '../../types/Callback';
import type Maybe from '../../types/Maybe';
import { type ThrottlingParameter } from '../../types/parameters';
import type Chargeback from '../chargebacks/Chargeback';
import Helper from '../Helper';
import type Invoice from '../invoices/Invoice';
import type Payment from '../payments/Payment';
import type Refund from '../refunds/Refund';
import { type SettlementData } from './data';
import type SettlementModel from './SettlementModel';
export default class SettlementHelper extends Helper<SettlementData, SettlementModel> {
    protected readonly links: SettlementData['_links'];
    constructor(networkClient: TransformingNetworkClient, links: SettlementData['_links']);
    /**
     * Returns the payments that are included in this settlement.
     *
     * @since 3.7.0
     */
    getPayments(parameters?: ThrottlingParameter): import("../../plumbing/iteration/HelpfulIterator").default<Payment>;
    /**
     * Returns the refunds that are included in this settlement.
     *
     * @since 3.7.0
     */
    getRefunds(parameters?: ThrottlingParameter): import("../../plumbing/iteration/HelpfulIterator").default<Refund>;
    /**
     * Returns the chargebacks that are included in this settlement.
     *
     * @since 3.7.0
     */
    getChargebacks(parameters?: ThrottlingParameter): import("../../plumbing/iteration/HelpfulIterator").default<Chargeback>;
    /**
     * Returns the captures that are included in this settlement.
     *
     * @since 3.7.0
     */
    getCaptures(parameters?: ThrottlingParameter): import("../../plumbing/iteration/HelpfulIterator").default<Capture>;
    /**
     * Returns the invoice that contains this settlement, if an invoice has been created for it.
     *
     * @since 4.6.0
     */
    getInvoice(): Promise<Invoice> | Promise<undefined>;
    getInvoice(callback: Callback<Maybe<Invoice>>): void;
}