@apihawk/document-sdk/lib/services/document-sdk.d.ts

The ApiHawk Document SDK

import { BilliaSDKServiceBase } from '@apihawk/billia-sdk';
import { IRestPaginatedResource } from '@apihawk/billia-sdk';
import { ApiHawkConnectorService } from '@apihawk/connector';
import { IDocumentArchiveEntity } from './document-sdk.types';
export declare class DocumentSDK extends BilliaSDKServiceBase {
    private apiUrl;
    /**
     * Document Manager SDK
     *
     * @param api - Apihawk Connector instance
     * @param apiUrl - the URL to the document manager API
     */
    constructor(api: ApiHawkConnectorService, apiUrl: string);
    /**
     * Lists documents with pagination.
     *
     * @param {number} page
     * @param {number} pageSize
     * @param {{document_id?: number | number[]; file_name?: string; file?: string; status?: string; columns?: string[]}} query
     * @returns {Promise<IRestPaginatedResource<IDocumentArchiveEntity>>}
     */
    listDocuments(page?: number, pageSize?: number, query?: {
        document_id?: number | number[];
        file_name?: string;
        file?: string;
        status?: string;
        columns?: string[];
    }): Promise<IRestPaginatedResource<IDocumentArchiveEntity>>;
    /**
     * Gets a document by ID.
     *
     * @param {number} id
     * @returns {Promise<IDocumentArchiveEntity>}
     */
    getDocument(id: number): Promise<IDocumentArchiveEntity>;
    private documentMapper;
}