@mollie/api-client/dist/types/binders/methods/MethodsBinder.d.ts

Official Mollie API client for Node

import type TransformingNetworkClient from '../../communication/TransformingNetworkClient';
import type Method from '../../data/methods/Method';
import { type MethodData } from '../../data/methods/data';
import type Callback from '../../types/Callback';
import Binder from '../Binder';
import { type GetParameters, type ListParameters } from './parameters';
export default class MethodsBinder extends Binder<MethodData, Method> {
    protected readonly networkClient: TransformingNetworkClient;
    constructor(networkClient: TransformingNetworkClient);
    /**
     * Retrieve a single method by its ID. Note that if a method is not available on the website profile a status `404 Not found` is returned. When the method is not enabled, a status `403 Forbidden` is
     * returned. You can enable payments methods via the Enable payment method endpoint in the Profiles API, or via your [Mollie Dashboard](https://www.mollie.com/dashboard).
     *
     * If you do not know the method's ID, you can use the methods list endpoint to retrieve all payment methods that are available.
     *
     * Additionally, it is possible to check if Wallets such as Apple Pay are enabled by passing the wallet ID (`applepay`) as the method ID.
     *
     * @since 2.0.0
     * @see https://docs.mollie.com/reference/v2/methods-api/get-method
     */
    get(id: string, parameters?: GetParameters): Promise<Method>;
    get(id: string, parameters: GetParameters, callback: Callback<Method>): void;
    /**
     * Retrieve all enabled payment methods. The results are not paginated.
     *
     * -   For test mode, payment methods are returned that are enabled in the Dashboard (or the activation is pending).
     * -   For live mode, payment methods are returned that have been activated on your account and have been enabled in the Dashboard.
     *
     * New payment methods can be activated via the Enable payment method endpoint in the Profiles API.
     *
     * When using the `first` sequence type, methods will be returned if they can be used as a first payment in a recurring sequence and if they are enabled in the Dashboard.
     *
     * When using the `recurring` sequence type, payment methods that can be used for recurring payments or subscriptions will be returned. Enabling / disabling methods in the dashboard does not affect
     * how they can be used for recurring payments.
     *
     * @since 3.0.0
     * @see https://docs.mollie.com/reference/v2/methods-api/list-methods
     */
    list(parameters?: ListParameters): Promise<Method[]>;
    list(parameters: ListParameters, callback: Callback<Method[]>): void;
}