e-invoice-api/client.d.mts

The official TypeScript library for the e-invoice API

import type { RequestInit, RequestInfo } from "./internal/builtin-types.mjs";
import type { PromiseOrValue, MergedRequestInit, FinalizedRequestInit } from "./internal/types.mjs";
export type { Logger, LogLevel } from "./internal/utils/log.mjs";
import * as Opts from "./internal/request-options.mjs";
import * as Errors from "./core/error.mjs";
import * as Pagination from "./core/pagination.mjs";
import { type DocumentsNumberPageParams, DocumentsNumberPageResponse } from "./core/pagination.mjs";
import * as Uploads from "./core/uploads.mjs";
import * as API from "./resources/index.mjs";
import { APIPromise } from "./core/api-promise.mjs";
import { DocumentState, Inbox, InboxListCreditNotesParams, InboxListInvoicesParams, InboxListParams, PaginatedDocumentResponse } from "./resources/inbox.mjs";
import { Certificate, Lookup, LookupRetrieveParams, LookupRetrieveParticipantsParams, LookupRetrieveParticipantsResponse, LookupRetrieveResponse } from "./resources/lookup.mjs";
import { Outbox, OutboxListDraftDocumentsParams, OutboxListReceivedDocumentsParams } from "./resources/outbox.mjs";
import { UblDocumentValidation, Validate, ValidateValidateJsonParams, ValidateValidatePeppolIDParams, ValidateValidatePeppolIDResponse, ValidateValidateUblParams } from "./resources/validate.mjs";
import { WebhookCreateParams, WebhookDeleteResponse, WebhookListResponse, WebhookResponse, WebhookUpdateParams, Webhooks } from "./resources/webhooks.mjs";
import { CurrencyCode, DocumentAttachmentCreate, DocumentCreate, DocumentCreateParams, DocumentDeleteResponse, DocumentDirection, DocumentResponse, DocumentSendParams, DocumentType, Documents, PaymentDetailCreate, UnitOfMeasureCode } from "./resources/documents/documents.mjs";
import { type Fetch } from "./internal/builtin-types.mjs";
import { HeadersLike, NullableHeaders } from "./internal/headers.mjs";
import { FinalRequestOptions, RequestOptions } from "./internal/request-options.mjs";
import { type LogLevel, type Logger } from "./internal/utils/log.mjs";
export interface ClientOptions {
    /**
     * Defaults to process.env['E_INVOICE_API_KEY'].
     */
    apiKey?: string | undefined;
    /**
     * Override the default base URL for the API, e.g., "https://api.example.com/v2/"
     *
     * Defaults to process.env['E_INVOICE_BASE_URL'].
     */
    baseURL?: string | null | undefined;
    /**
     * The maximum amount of time (in milliseconds) that the client should wait for a response
     * from the server before timing out a single request.
     *
     * Note that request timeouts are retried by default, so in a worst-case scenario you may wait
     * much longer than this timeout before the promise succeeds or fails.
     *
     * @unit milliseconds
     */
    timeout?: number | undefined;
    /**
     * Additional `RequestInit` options to be passed to `fetch` calls.
     * Properties will be overridden by per-request `fetchOptions`.
     */
    fetchOptions?: MergedRequestInit | undefined;
    /**
     * Specify a custom `fetch` function implementation.
     *
     * If not provided, we expect that `fetch` is defined globally.
     */
    fetch?: Fetch | undefined;
    /**
     * The maximum number of times that the client will retry a request in case of a
     * temporary failure, like a network error or a 5XX error from the server.
     *
     * @default 2
     */
    maxRetries?: number | undefined;
    /**
     * Default headers to include with every request to the API.
     *
     * These can be removed in individual requests by explicitly setting the
     * header to `null` in request options.
     */
    defaultHeaders?: HeadersLike | undefined;
    /**
     * Default query parameters to include with every request to the API.
     *
     * These can be removed in individual requests by explicitly setting the
     * param to `undefined` in request options.
     */
    defaultQuery?: Record<string, string | undefined> | undefined;
    /**
     * Set the log level.
     *
     * Defaults to process.env['E_INVOICE_LOG'] or 'warn' if it isn't set.
     */
    logLevel?: LogLevel | undefined;
    /**
     * Set the logger.
     *
     * Defaults to globalThis.console.
     */
    logger?: Logger | undefined;
}
/**
 * API Client for interfacing with the E Invoice API.
 */
export declare class EInvoice {
    #private;
    apiKey: string;
    baseURL: string;
    maxRetries: number;
    timeout: number;
    logger: Logger | undefined;
    logLevel: LogLevel | undefined;
    fetchOptions: MergedRequestInit | undefined;
    private fetch;
    protected idempotencyHeader?: string;
    private _options;
    /**
     * API Client for interfacing with the E Invoice API.
     *
     * @param {string | undefined} [opts.apiKey=process.env['E_INVOICE_API_KEY'] ?? undefined]
     * @param {string} [opts.baseURL=process.env['E_INVOICE_BASE_URL'] ?? https://api.e-invoice.be] - Override the default base URL for the API.
     * @param {number} [opts.timeout=1 minute] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out.
     * @param {MergedRequestInit} [opts.fetchOptions] - Additional `RequestInit` options to be passed to `fetch` calls.
     * @param {Fetch} [opts.fetch] - Specify a custom `fetch` function implementation.
     * @param {number} [opts.maxRetries=2] - The maximum number of times the client will retry a request.
     * @param {HeadersLike} opts.defaultHeaders - Default headers to include with every request to the API.
     * @param {Record<string, string | undefined>} opts.defaultQuery - Default query parameters to include with every request to the API.
     */
    constructor({ baseURL, apiKey, ...opts }?: ClientOptions);
    /**
     * Create a new client instance re-using the same options given to the current client with optional overriding.
     */
    withOptions(options: Partial<ClientOptions>): this;
    protected defaultQuery(): Record<string, string | undefined> | undefined;
    protected validateHeaders({ values, nulls }: NullableHeaders): void;
    protected authHeaders(opts: FinalRequestOptions): Promise<NullableHeaders | undefined>;
    /**
     * Basic re-implementation of `qs.stringify` for primitive types.
     */
    protected stringifyQuery(query: Record<string, unknown>): string;
    private getUserAgent;
    protected defaultIdempotencyKey(): string;
    protected makeStatusError(status: number, error: Object, message: string | undefined, headers: Headers): Errors.APIError;
    buildURL(path: string, query: Record<string, unknown> | null | undefined, defaultBaseURL?: string | undefined): string;
    /**
     * Used as a callback for mutating the given `FinalRequestOptions` object.
     */
    protected prepareOptions(options: FinalRequestOptions): Promise<void>;
    /**
     * Used as a callback for mutating the given `RequestInit` object.
     *
     * This is useful for cases where you want to add certain headers based off of
     * the request properties, e.g. `method` or `url`.
     */
    protected prepareRequest(request: RequestInit, { url, options }: {
        url: string;
        options: FinalRequestOptions;
    }): Promise<void>;
    get<Rsp>(path: string, opts?: PromiseOrValue<RequestOptions>): APIPromise<Rsp>;
    post<Rsp>(path: string, opts?: PromiseOrValue<RequestOptions>): APIPromise<Rsp>;
    patch<Rsp>(path: string, opts?: PromiseOrValue<RequestOptions>): APIPromise<Rsp>;
    put<Rsp>(path: string, opts?: PromiseOrValue<RequestOptions>): APIPromise<Rsp>;
    delete<Rsp>(path: string, opts?: PromiseOrValue<RequestOptions>): APIPromise<Rsp>;
    private methodRequest;
    request<Rsp>(options: PromiseOrValue<FinalRequestOptions>, remainingRetries?: number | null): APIPromise<Rsp>;
    private makeRequest;
    getAPIList<Item, PageClass extends Pagination.AbstractPage<Item> = Pagination.AbstractPage<Item>>(path: string, Page: new (...args: any[]) => PageClass, opts?: RequestOptions): Pagination.PagePromise<PageClass, Item>;
    requestAPIList<Item = unknown, PageClass extends Pagination.AbstractPage<Item> = Pagination.AbstractPage<Item>>(Page: new (...args: ConstructorParameters<typeof Pagination.AbstractPage>) => PageClass, options: FinalRequestOptions): Pagination.PagePromise<PageClass, Item>;
    fetchWithTimeout(url: RequestInfo, init: RequestInit | undefined, ms: number, controller: AbortController): Promise<Response>;
    private shouldRetry;
    private retryRequest;
    private calculateDefaultRetryTimeoutMillis;
    buildRequest(inputOptions: FinalRequestOptions, { retryCount }?: {
        retryCount?: number;
    }): Promise<{
        req: FinalizedRequestInit;
        url: string;
        timeout: number;
    }>;
    private buildHeaders;
    private buildBody;
    static EInvoice: typeof EInvoice;
    static DEFAULT_TIMEOUT: number;
    static EInvoiceError: typeof Errors.EInvoiceError;
    static APIError: typeof Errors.APIError;
    static APIConnectionError: typeof Errors.APIConnectionError;
    static APIConnectionTimeoutError: typeof Errors.APIConnectionTimeoutError;
    static APIUserAbortError: typeof Errors.APIUserAbortError;
    static NotFoundError: typeof Errors.NotFoundError;
    static ConflictError: typeof Errors.ConflictError;
    static RateLimitError: typeof Errors.RateLimitError;
    static BadRequestError: typeof Errors.BadRequestError;
    static AuthenticationError: typeof Errors.AuthenticationError;
    static InternalServerError: typeof Errors.InternalServerError;
    static PermissionDeniedError: typeof Errors.PermissionDeniedError;
    static UnprocessableEntityError: typeof Errors.UnprocessableEntityError;
    static toFile: typeof Uploads.toFile;
    documents: API.Documents;
    inbox: API.Inbox;
    outbox: API.Outbox;
    validate: API.Validate;
    lookup: API.Lookup;
    webhooks: API.Webhooks;
}
export declare namespace EInvoice {
    export type RequestOptions = Opts.RequestOptions;
    export import DocumentsNumberPage = Pagination.DocumentsNumberPage;
    export { type DocumentsNumberPageParams as DocumentsNumberPageParams, type DocumentsNumberPageResponse as DocumentsNumberPageResponse, };
    export { Documents as Documents, type CurrencyCode as CurrencyCode, type DocumentAttachmentCreate as DocumentAttachmentCreate, type DocumentCreate as DocumentCreate, type DocumentDirection as DocumentDirection, type DocumentResponse as DocumentResponse, type DocumentType as DocumentType, type PaymentDetailCreate as PaymentDetailCreate, type UnitOfMeasureCode as UnitOfMeasureCode, type DocumentDeleteResponse as DocumentDeleteResponse, type DocumentCreateParams as DocumentCreateParams, type DocumentSendParams as DocumentSendParams, };
    export { Inbox as Inbox, type DocumentState as DocumentState, type PaginatedDocumentResponse as PaginatedDocumentResponse, type InboxListParams as InboxListParams, type InboxListCreditNotesParams as InboxListCreditNotesParams, type InboxListInvoicesParams as InboxListInvoicesParams, };
    export { Outbox as Outbox, type OutboxListDraftDocumentsParams as OutboxListDraftDocumentsParams, type OutboxListReceivedDocumentsParams as OutboxListReceivedDocumentsParams, };
    export { Validate as Validate, type UblDocumentValidation as UblDocumentValidation, type ValidateValidatePeppolIDResponse as ValidateValidatePeppolIDResponse, type ValidateValidateJsonParams as ValidateValidateJsonParams, type ValidateValidatePeppolIDParams as ValidateValidatePeppolIDParams, type ValidateValidateUblParams as ValidateValidateUblParams, };
    export { Lookup as Lookup, type Certificate as Certificate, type LookupRetrieveResponse as LookupRetrieveResponse, type LookupRetrieveParticipantsResponse as LookupRetrieveParticipantsResponse, type LookupRetrieveParams as LookupRetrieveParams, type LookupRetrieveParticipantsParams as LookupRetrieveParticipantsParams, };
    export { Webhooks as Webhooks, type WebhookResponse as WebhookResponse, type WebhookListResponse as WebhookListResponse, type WebhookDeleteResponse as WebhookDeleteResponse, type WebhookCreateParams as WebhookCreateParams, type WebhookUpdateParams as WebhookUpdateParams, };
}
//# sourceMappingURL=client.d.mts.map