@adyen/api-library/lib/src/services/legalEntityManagement/documentsApi.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 { Document } from "../../typings/legalEntityManagement/models";
/**
 * API handler for DocumentsApi
 */
export declare class DocumentsApi extends Service {
    private readonly API_BASEPATH;
    private baseUrl;
    constructor(client: Client);
    /**
    * @summary Delete a document
    * @param id {@link string } The unique identifier of the document to be deleted.
    * @param requestOptions {@link IRequest.Options }
    * @return {@link void }
    */
    deleteDocument(id: string, requestOptions?: IRequest.Options): Promise<void>;
    /**
    * @summary Get a document
    * @param id {@link string } The unique identifier of the document.
    * @param requestOptions {@link IRequest.Options }
    * @param skipContent {@link boolean } Do not load document content while fetching the document.
    * @return {@link Document }
    */
    getDocument(id: string, skipContent?: boolean, requestOptions?: IRequest.Options): Promise<Document>;
    /**
    * @summary Update a document
    * @param id {@link string } The unique identifier of the document to be updated.
    * @param document {@link Document }
    * @param requestOptions {@link IRequest.Options }
    * @return {@link Document }
    */
    updateDocument(id: string, document: Document, requestOptions?: IRequest.Options): Promise<Document>;
    /**
    * @summary Upload a document for verification checks
    * @param document {@link Document }
    * @param requestOptions {@link IRequest.Options }
    * @return {@link Document }
    */
    uploadDocumentForVerificationChecks(document: Document, requestOptions?: IRequest.Options): Promise<Document>;
}