@adyen/api-library/lib/src/services/capital/dynamicOffersApi.d.ts

The Adyen API Library for NodeJS enables you to work with Adyen APIs.

import Service from "../../service";
import Client from "../../client";
import { IRequest } from "../../typings/requestOptions";
import { CalculateGrantOfferRequest } from "../../typings/capital/models";
import { CalculatedGrantOffer } from "../../typings/capital/models";
import { CreateGrantOfferRequest } from "../../typings/capital/models";
import { FinancingType } from "../../typings/capital/models";
import { GetDynamicOffersResponse } from "../../typings/capital/models";
import { GrantOffer } from "../../typings/capital/models";
/**
 * API handler for DynamicOffersApi
 */
export declare class DynamicOffersApi extends Service {
    private readonly API_BASEPATH;
    private baseUrl;
    constructor(client: Client);
    /**
    * @summary Calculate a preliminary offer for a selected financing amount
    * @param id {@link string } The unique identifier of the dynamic offer from which the user selected the financing amount.
    * @param calculateGrantOfferRequest {@link CalculateGrantOfferRequest }
    * @param requestOptions {@link IRequest.Options }
    * @return {@link CalculatedGrantOffer }
    */
    calculatePreliminaryOfferFromDynamicOffer(id: string, calculateGrantOfferRequest: CalculateGrantOfferRequest, requestOptions?: IRequest.Options): Promise<CalculatedGrantOffer>;
    /**
    * @summary Create a static offer for a selected financing amount
    * @param id {@link string } The unique identifier of the dynamic offer from which the user selected the financing amount.
    * @param createGrantOfferRequest {@link CreateGrantOfferRequest }
    * @param requestOptions {@link IRequest.Options }
    * @return {@link GrantOffer }
    */
    createStaticOfferFromDynamicOffer(id: string, createGrantOfferRequest: CreateGrantOfferRequest, requestOptions?: IRequest.Options): Promise<GrantOffer>;
    /**
    * @summary Get all available dynamic offers
    * @param requestOptions {@link IRequest.Options }
    * @param accountHolderId {@link string } (Required) The unique identifier of the account holder that the dynamic offer is for.
    * @param financingType {@link FinancingType } The type of financing that the offer is for. If the value is not specified, returns all available types.  Possible values: **businessFinancing**
    * @return {@link GetDynamicOffersResponse }
    */
    getAllDynamicOffers(accountHolderId: string, financingType?: FinancingType, requestOptions?: IRequest.Options): Promise<GetDynamicOffersResponse>;
}