@veriko-mx/sdk 0.4.3

package/dist/cjs/resources.d.ts

@@ -0,0 +1,522 @@
+/**
+ * Las operaciones de la API, agrupadas por familia.
+ *
+ * Cada familia es una propiedad del cliente: `client.validations`,
+ * `client.webhooks` y `client.catalog`. Los tres métodos que estrenó la versión
+ * 0.1.0 siguen en la raíz del cliente, porque son el camino corto del caso de
+ * uso principal.
+ */
+import { type Transport } from './http.js';
+import { type EntityId, type Query } from './internal.js';
+import { type IterOptions, type Page } from './pagination.js';
+import { type ApiUsage, type Beneficiary, type BeneficiaryImportCommitted, type BeneficiaryImportJob, type BeneficiaryImportRow, type BeneficiaryImportStarted, type BeneficiaryLookup, type CreateBeneficiaryParams, type EditImportRowParams, type ExportBeneficiariesParams, type ExportUsageParams, type ImportPreviewParams, type ImportStartOptions, type ImportTemplateOptions, type ListBeneficiariesParams, type UpdateBeneficiaryParams, type UsageBreakdown, type UsageBreakdownParams, type UsageHeatmap, type UsageHeatmapParams, type UsageHistory, type UsageHistoryParams, type UsageLimits, type UsageSummary, type BillingSubscription, type DashboardSummary, type DashboardSummaryParams, type FinanceAccountingParams, type FinanceCepsParams, type FinanceParams, type FinancePreview, type FinancePreviewParams, type FinanceStatementParams, type FinanceSummary, type InsightsOverview, type InsightsTopBanks, type UserInsightsTopBanksParams, type InsightsTopBeneficiaries, type UserInsightsTopBeneficiariesParams, type InsightsTrends, type UserInsightsTrendsParams, type PublicPlanComparison, type PublicPlans, type UserProfile, type UserRetryPolicy, type BankList, type BanksOptions, type BanxicoStatus, type BanxicoTimeseries, type BinLookup, type CepDocument, type CepFormat, type CreateWebhookParams, type DeliveriesParams, type DownloadedFile, type ExportDeliveriesParams, type ExportValidationsParams, type GetValidationOptions, type IdempotentOptions, type ListValidationsParams, type QueuedValidation, type RetryAttempt, type RetryPolicy, type RetryStateResource, type TelegramDispatch, type TimeseriesParams, type UpdateWebhookParams, type ValidateOcrParams, type ValidateTransferParams, type Validation, type ValidationFilters, type ValidationStats, type ValidationSummary, type ValidationWithEtag, type WaitForOptions, type WebhookDelivery, type WebhookEndpoint, type WebhookTestResult } from './types.js';
+/**
+ * Los filtros de una consulta, con el nombre que la API espera.
+ *
+ * `test/spec.test.ts` compara las claves de este resultado con los parámetros de
+ * `GET /v1/validations`, de modo que un filtro nuevo del spec no pase inadvertido.
+ */
+export declare function filtersToQuery(filters: ValidationFilters): Query;
+/** Validaciones SPEI: crearlas, seguirlas y descargar lo que producen. */
+export declare class Validations {
+    private readonly transport;
+    constructor(transport: Transport);
+    /**
+     * Valida una transferencia SPEI contra el CEP de Banxico.
+     *
+     * `POST /v1/validate`. Devuelve el veredicto en `attributes.status`. Para
+     * volumen está `enqueue()`, que acepta la petición y deja el veredicto para
+     * después.
+     */
+    validate(params: ValidateTransferParams): Promise<Validation>;
+    /**
+     * Valida una transferencia a partir de la imagen del comprobante.
+     *
+     * `POST /v1/validate-ocr`. La imagen se lee del disco cuando `image` es una
+     * ruta, y se codifica en base64 aquí. Formatos: JPEG, PNG o WebP.
+     *
+     * `imageUrl` sirve para una imagen ya publicada en HTTPS. Si se envían las
+     * dos, la API sólo considera `image`.
+     */
+    validateOcr(params: ValidateOcrParams): Promise<Validation>;
+    /**
+     * Encola una validación por campos y devuelve el acuse.
+     *
+     * `POST /v1/validate?async=1`. Acepta los mismos argumentos que `validate()`.
+     * La API responde `202` con el identificador; el veredicto se recoge con
+     * `waitFor()`, o llega por webhook.
+     *
+     * @see https://docs.veriko.mx/es/concepts/async-validations
+     */
+    enqueue(params: ValidateTransferParams): Promise<QueuedValidation>;
+    /**
+     * Encola una validación por imagen y devuelve el acuse.
+     *
+     * `POST /v1/validate-ocr?async=1`. Acepta los mismos argumentos que
+     * `validateOcr()`.
+     */
+    enqueueOcr(params: ValidateOcrParams): Promise<QueuedValidation>;
+    private post;
+    /**
+     * Lee una validación por su identificador.
+     *
+     * `GET /v1/validations/{id}`. Con `ifNoneMatch` la API responde `304` cuando
+     * nada cambió desde ese `ETag`, y el SDK lo lanza como `ApiError` con
+     * `status` 304. El `ETag` de cada lectura queda en `etag`.
+     */
+    get(validationId: string, options?: GetValidationOptions): Promise<ValidationWithEtag>;
+    private read;
+    /**
+     * Lista las validaciones de la cuenta, con filtros y paginación.
+     *
+     * `GET /v1/validations`. Un listado trae menos campos que `get()`.
+     */
+    list(params?: ListValidationsParams): Promise<Page<ValidationSummary>>;
+    /**
+     * Recorre todas las validaciones que casan con los filtros.
+     *
+     * Pide cada página cuando la anterior se agota. `maxPages` acota el recorrido,
+     * y `page` fija la página de partida.
+     *
+     * ```ts
+     * for await (const validation of client.validations.iter({ status: 'valid' })) {
+     *   console.log(validation.id);
+     * }
+     * ```
+     */
+    iter(params?: ListValidationsParams & IterOptions): AsyncIterable<ValidationSummary>;
+    /**
+     * Los totales de las validaciones de la cuenta, con los mismos filtros.
+     *
+     * `GET /v1/validations/stats`.
+     */
+    stats(filters?: ValidationFilters): Promise<ValidationStats>;
+    /**
+     * Los intentos del ciclo de reintentos de una validación.
+     *
+     * `GET /v1/validations/{id}/retry-attempts`.
+     */
+    retryAttempts(validationId: string): Promise<RetryAttempt[]>;
+    /**
+     * Sondea una validación hasta que su veredicto queda firme.
+     *
+     * Es la pareja de `enqueue()`. Manda `If-None-Match` con el `ETag` de la
+     * respuesta anterior, así que un sondeo que no encuentra cambios no descarga
+     * otra vez el mismo cuerpo.
+     *
+     * Espera a `isSettled()`, no a `isTerminal()`: una validación con reintentos
+     * en marcha llega a `not_found` y sigue cambiando después.
+     *
+     * @throws {TimeoutError} Si se agota `timeoutMs` sin veredicto firme.
+     */
+    waitFor(validationId: string, options?: WaitForOptions): Promise<ValidationWithEtag>;
+    /**
+     * Descarga el CEP oficial de una validación en XML o en PDF.
+     *
+     * `GET /v1/validations/{id}/cep`. Devuelve el archivo: el XML que emitió
+     * Banxico, con su sello digital y su cadena original, o el PDF equivalente.
+     *
+     * Existe cuando la validación tiene comprobante (`hasCep()`). Cuando no, la
+     * API responde `404` con `cep_not_available` y el SDK lo lanza como
+     * `NotFoundError`.
+     */
+    cep(validationId: string, options?: {
+        format?: CepFormat;
+    }): Promise<CepDocument>;
+    /**
+     * Descarga la imagen del comprobante de una validación por OCR.
+     *
+     * `GET /v1/validations/{id}/image`.
+     */
+    image(validationId: string): Promise<DownloadedFile>;
+    /**
+     * Exporta el historial de validaciones en CSV o en XLSX.
+     *
+     * `GET /v1/validations/export`. Admite los mismos filtros que `list()`.
+     */
+    export(params?: ExportValidationsParams): Promise<DownloadedFile>;
+    /**
+     * Cambia la política de reintentos de una validación concreta.
+     *
+     * `PUT /v1/validations/{id}/retry-policy`. Devuelve el estado del ciclo de
+     * reintentos, no la validación completa.
+     */
+    setRetryPolicy(validationId: string, policy: RetryPolicy, options?: IdempotentOptions): Promise<RetryStateResource>;
+    /**
+     * Detiene el ciclo de reintentos pendientes de una validación.
+     *
+     * `POST /v1/validations/{id}/cancel-retries`. Si el ciclo ya no está activo,
+     * la API responde `422` con `retry_not_active`.
+     */
+    cancelRetries(validationId: string, options?: IdempotentOptions): Promise<RetryStateResource>;
+    /**
+     * Retira una validación del historial.
+     *
+     * `DELETE /v1/validations/{id}`. La API responde `204` y no devuelve cuerpo.
+     */
+    delete(validationId: string): Promise<void>;
+    /**
+     * Envía el comprobante al chat de Telegram vinculado a la cuenta.
+     *
+     * `POST /v1/validations/{id}/cep/send-telegram`. La API acusa con `202`: el
+     * envío ocurre después.
+     */
+    sendCepToTelegram(validationId: string): Promise<TelegramDispatch>;
+}
+/** Endpoints de webhook y su historial de entregas. */
+export declare class Webhooks {
+    private readonly transport;
+    constructor(transport: Transport);
+    /**
+     * Registra un endpoint y devuelve su secreto de firma.
+     *
+     * `POST /v1/webhooks`. El secreto viaja **una sola vez**, en
+     * `attributes.secret` de esta respuesta: guárdalo al recibirlo. Si se pierde,
+     * se rota con `regenerateSecret()`.
+     */
+    create(params: CreateWebhookParams): Promise<WebhookEndpoint>;
+    /**
+     * Lista los endpoints registrados, sin sus secretos.
+     *
+     * `GET /v1/webhooks`.
+     */
+    list(): Promise<WebhookEndpoint[]>;
+    /**
+     * Cambia la URL, los eventos suscritos, la etiqueta o el estado de un endpoint.
+     *
+     * `PUT /v1/webhooks/{id}`. Un endpoint que el sistema apagó se reactiva con
+     * `status: 'active'`; `auto_disabled` no se puede asignar desde la API.
+     */
+    update(webhookId: string, params: UpdateWebhookParams): Promise<WebhookEndpoint>;
+    /**
+     * Retira un endpoint.
+     *
+     * `DELETE /v1/webhooks/{id}`. La API responde `204`.
+     */
+    delete(webhookId: string): Promise<void>;
+    /**
+     * Envía un evento de prueba al endpoint.
+     *
+     * `POST /v1/webhooks/{id}/test`. Las entregas de prueba no cuentan para el
+     * contador de fallos consecutivos.
+     */
+    test(webhookId: string): Promise<WebhookTestResult>;
+    /**
+     * Rota el secreto de firma de un endpoint.
+     *
+     * `POST /v1/webhooks/{id}/regenerate-secret`. El secreto nuevo viene en
+     * `attributes.secret`, y es la última vez que la API lo entrega.
+     */
+    regenerateSecret(webhookId: string): Promise<WebhookEndpoint>;
+    /**
+     * Lista los intentos de entrega.
+     *
+     * Con `webhookId` consulta los de ese endpoint; sin él, los de todos. Los
+     * filtros `status` y `eventType` sólo existen en el listado global, así que con
+     * `webhookId` y un filtro la petición va a `GET /v1/webhooks/deliveries` con
+     * `endpoint_id`.
+     */
+    deliveries(params?: DeliveriesParams): Promise<Page<WebhookDelivery>>;
+    deliveries(webhookId: string, params?: DeliveriesParams): Promise<Page<WebhookDelivery>>;
+    /**
+     * Recorre todos los intentos de entrega, página a página.
+     *
+     * Acepta los mismos argumentos que `deliveries()`, más `maxPages`.
+     */
+    iterDeliveries(params?: DeliveriesParams & IterOptions): AsyncIterable<WebhookDelivery>;
+    iterDeliveries(webhookId: string, params?: DeliveriesParams & IterOptions): AsyncIterable<WebhookDelivery>;
+    /**
+     * Exporta el historial de entregas en CSV o en XLSX.
+     *
+     * Con `webhookId`, las de ese endpoint; sin él, las de todos. Como en
+     * `deliveries()`, un filtro con `webhookId` lleva la petición al listado global.
+     */
+    exportDeliveries(params?: ExportDeliveriesParams): Promise<DownloadedFile>;
+    exportDeliveries(webhookId: string, params?: ExportDeliveriesParams): Promise<DownloadedFile>;
+}
+/** Datos abiertos: el catálogo de bancos y el estado del servicio. */
+export declare class Catalog {
+    private readonly transport;
+    constructor(transport: Transport);
+    /**
+     * Lista las instituciones participantes en SPEI con su código.
+     *
+     * `GET /v1/public/banks`. Con `ifNoneMatch` la API responde `304` cuando el
+     * catálogo no cambió, y el SDK lo lanza como `ApiError` con `status` 304. El
+     * `ETag` de cada lectura queda en `etag`.
+     */
+    banks(options?: BanksOptions): Promise<BankList>;
+    /**
+     * Resuelve el banco emisor de una tarjeta por sus primeros dígitos.
+     *
+     * `GET /v1/public/bin-lookup/{bin}`.
+     */
+    binLookup(bin: string): Promise<BinLookup>;
+    /**
+     * Estado del servicio de consulta de Banxico.
+     *
+     * `GET /v1/status/banxico`. Sirve para distinguir un `cep_unavailable` propio de
+     * la transferencia de una caída del servicio.
+     */
+    banxicoStatus(): Promise<BanxicoStatus>;
+    /**
+     * Serie temporal de la salud del servicio de Banxico.
+     *
+     * `GET /v1/status/banxico/timeseries`.
+     */
+    banxicoTimeseries(params?: TimeseriesParams): Promise<BanxicoTimeseries>;
+}
+/** Cuentas beneficiarias guardadas y su importación masiva. */
+export declare class Beneficiaries {
+    private readonly transport;
+    constructor(transport: Transport);
+    /**
+     * Registra una cuenta beneficiaria.
+     *
+     * `POST /v1/beneficiaries`. El tipo se detecta por longitud: CLABE (18 dígitos),
+     * tarjeta (16) o celular DiMo (10). Para un celular, `bankCode` es obligatorio;
+     * en CLABE y tarjeta se deriva del número. Un alta de una cuenta archivada la
+     * reactiva.
+     */
+    create(params: CreateBeneficiaryParams): Promise<Beneficiary>;
+    /**
+     * Lista las cuentas beneficiarias guardadas.
+     *
+     * `GET /v1/beneficiaries`. Sin paginar: devuelve la lista completa.
+     * `withArchived: true` trae sólo las archivadas y `false` sólo las activas.
+     */
+    list(params?: ListBeneficiariesParams): Promise<Beneficiary[]>;
+    /**
+     * Cambia la etiqueta, la cuenta o el banco de un beneficiario.
+     *
+     * `PUT /v1/beneficiaries/{id}`. Un `accountNumber` nuevo vuelve a derivar el
+     * tipo y el banco; `bankCode` sólo se aplica sobre cuentas de tipo celular.
+     */
+    update(beneficiaryId: EntityId, params: UpdateBeneficiaryParams): Promise<Beneficiary>;
+    /**
+     * Archiva un beneficiario.
+     *
+     * `DELETE /v1/beneficiaries/{id}`. El registro no se borra: sale de la lista
+     * activa y se consulta con `withArchived: true`. Un alta posterior con la misma
+     * cuenta lo reactiva. La API responde `204`.
+     */
+    delete(beneficiaryId: EntityId): Promise<void>;
+    /**
+     * Resuelve una cuenta concreta dentro de la lista propia.
+     *
+     * `GET /v1/beneficiaries/lookup`. Devuelve los datos del banco cuando la cuenta
+     * está entre las guardadas; si no, la API responde `404`.
+     */
+    lookup(account: string): Promise<BeneficiaryLookup>;
+    /**
+     * Exporta la lista de beneficiarios en CSV o en XLSX.
+     *
+     * `GET /v1/beneficiaries/export`. Los números salen enmascarados salvo la CLABE;
+     * `limit` sólo baja el tope de 100 000 filas.
+     */
+    export(params?: ExportBeneficiariesParams): Promise<DownloadedFile>;
+    /**
+     * Descarga la plantilla para la importación masiva.
+     *
+     * `GET /v1/beneficiaries/imports/template`. Es el punto de partida del ciclo:
+     * descargar, rellenar, subir, revisar y confirmar.
+     */
+    importTemplate(options?: ImportTemplateOptions): Promise<DownloadedFile>;
+    /**
+     * Sube un archivo y abre un trabajo de importación.
+     *
+     * `POST /v1/beneficiaries/imports`. `file` son los bytes del archivo o su ruta,
+     * que el SDK lee del disco. `parseMode` es `template` (encabezados canónicos) o
+     * `free` (formato libre). La respuesta es un `202` con el trabajo en estado
+     * `pending`; nada se persiste hasta `importCommit()`.
+     */
+    importStart(file: Uint8Array | string, options?: ImportStartOptions): Promise<BeneficiaryImportStarted>;
+    /**
+     * Lee el estado de un trabajo de importación y sus contadores.
+     *
+     * `GET /v1/beneficiaries/imports/{id}`.
+     */
+    importStatus(importId: EntityId): Promise<BeneficiaryImportJob>;
+    /**
+     * Cancela una importación que todavía no se confirmó.
+     *
+     * `DELETE /v1/beneficiaries/imports/{id}`. Admite los estados `pending`,
+     * `parsing` y `preview_ready`; con uno terminal o en `committing`, la API
+     * responde `404`. Las cuentas que una confirmación ya persistió se archivan una
+     * a una con `delete()`. La API responde `204`.
+     */
+    importCancel(importId: EntityId): Promise<void>;
+    /**
+     * Lista las filas extraídas de la importación, paginadas.
+     *
+     * `GET /v1/beneficiaries/imports/{id}/preview`. Disponible en `preview_ready` o
+     * después. `buckets` filtra por grupo (`valid`, `correctable`, `fatal`,
+     * `duplicate_account`, `duplicate_alias`).
+     */
+    importPreview(importId: EntityId, params?: ImportPreviewParams): Promise<Page<BeneficiaryImportRow>>;
+    /**
+     * Recorre todas las filas de la vista previa, página a página.
+     *
+     * Acepta los mismos argumentos que `importPreview()`, más `maxPages`.
+     */
+    iterImportPreview(importId: EntityId, params?: ImportPreviewParams & IterOptions): AsyncIterable<BeneficiaryImportRow>;
+    /**
+     * Corrige una fila de la vista previa antes de confirmar.
+     *
+     * `PATCH /v1/beneficiaries/imports/{id}/rows/{row_id}`. Sólo los campos
+     * presentes se sobrescriben; la fila se reprocesa y su grupo puede cambiar con
+     * la corrección.
+     */
+    importEditRow(importId: EntityId, rowId: EntityId, params: EditImportRowParams): Promise<BeneficiaryImportRow>;
+    /**
+     * Quita una fila de la vista previa.
+     *
+     * `DELETE /v1/beneficiaries/imports/{id}/rows/{row_id}`. La API responde `204`.
+     */
+    importRemoveRow(importId: EntityId, rowId: EntityId): Promise<void>;
+    /**
+     * Confirma la importación y dispara la persistencia de sus filas.
+     *
+     * `POST /v1/beneficiaries/imports/{id}/commit`. La operación es asíncrona: la
+     * respuesta es un `202` con el trabajo en `committing`, y el resultado se sigue
+     * con `importWait()`.
+     */
+    importCommit(importId: EntityId): Promise<BeneficiaryImportCommitted>;
+    /**
+     * Sondea una importación hasta que su avance se detiene.
+     *
+     * Espera a `isImportSettled()`: `preview_ready` o un estado final. A diferencia
+     * de `validations.waitFor()`, aquí no hay `ETag` que reutilizar: el endpoint de
+     * estado no lo expone, así que cada sondeo descarga el cuerpo entero.
+     *
+     * @throws {TimeoutError} Si se agota `timeoutMs` sin llegar a un estado firme.
+     */
+    importWait(importId: EntityId, options?: WaitForOptions): Promise<BeneficiaryImportJob>;
+}
+/** Consumo y límites: la cuota del plan y el registro de actividad. */
+export declare class Usage {
+    private readonly transport;
+    constructor(transport: Transport);
+    /**
+     * Devuelve la cuota de validaciones del plan en curso.
+     *
+     * `GET /v1/usage/summary`. Trae el límite, lo consumido, lo restante y el nivel
+     * de aviso en `attributes.tone`.
+     */
+    summary(): Promise<UsageSummary>;
+    /**
+     * Devuelve el consumo mensual de los últimos `months` meses.
+     *
+     * `GET /v1/usage/history`. De más reciente a más antiguo. El límite que
+     * acompaña a cada fila es el de hoy, no el que regía aquel mes.
+     */
+    history(params?: UsageHistoryParams): Promise<UsageHistory>;
+    /**
+     * Desglosa el consumo por tipo de operación contabilizada.
+     *
+     * `GET /v1/usage/breakdown`. `period` es `current` para el mes en curso o una
+     * cadena `YYYY-MM`.
+     */
+    breakdown(params?: UsageBreakdownParams): Promise<UsageBreakdown>;
+    /**
+     * Devuelve los límites de tasa aplicables, por contexto.
+     *
+     * `GET /v1/usage/limits`. Sólo la configuración vigente, sin contadores en
+     * vivo; son ajenos a la cuota mensual de `summary()`.
+     */
+    limits(): Promise<UsageLimits>;
+    /**
+     * Devuelve las validaciones agrupadas por día y hora.
+     *
+     * `GET /v1/usage/heatmap`. Cubre los últimos `days` días (máximo 90) y sólo trae
+     * las celdas con al menos una validación.
+     */
+    heatmap(params?: UsageHeatmapParams): Promise<UsageHeatmap>;
+    /**
+     * Devuelve las métricas de uso de la API de la cuenta.
+     *
+     * `GET /v1/api/usage`. Reúne las peticiones de hoy y del mes, la cuota del plan,
+     * las últimas peticiones y el estado del servicio de Banxico.
+     */
+    apiUsage(): Promise<ApiUsage>;
+    /**
+     * Exporta el registro de actividad en CSV o en XLSX.
+     *
+     * `GET /v1/api/usage/export`. `from` y `to` acotan el rango, las dos inclusive;
+     * `limit` sólo baja el tope de 100 000 filas.
+     */
+    export(params?: ExportUsageParams): Promise<DownloadedFile>;
+}
+/** Perfil y preferencias de la cuenta autenticada. */
+export declare class Account {
+    private readonly transport;
+    constructor(transport: Transport);
+    /** `GET /v1/users/me`. */
+    myProfile(): Promise<UserProfile>;
+    profile(): Promise<UserProfile>;
+    /** `GET /v1/users/me/retry-policy`. */
+    getMyRetryPolicy(): Promise<UserRetryPolicy>;
+    retryPolicy(): Promise<UserRetryPolicy>;
+    /** `PUT /v1/users/me/retry-policy`. */
+    updateMyRetryPolicy(policy: RetryPolicy, options?: IdempotentOptions): Promise<UserRetryPolicy>;
+}
+/** Resumen del panel de la cuenta. */
+export declare class Dashboard {
+    private readonly transport;
+    constructor(transport: Transport);
+    /** `GET /v1/summary`. */
+    getSummary(params?: DashboardSummaryParams): Promise<DashboardSummary>;
+    summary(params?: DashboardSummaryParams): Promise<DashboardSummary>;
+}
+/** Catálogo de planes que no requiere clave de API. */
+export declare class Plans {
+    private readonly transport;
+    constructor(transport: Transport);
+    /** `GET /v1/plans/public`. */
+    listPublic(): Promise<PublicPlans>;
+    list(): Promise<PublicPlans>;
+    /** `GET /v1/plans/public/comparison`. */
+    getPublicPlanComparison(): Promise<PublicPlanComparison>;
+    comparison(): Promise<PublicPlanComparison>;
+}
+/** Métricas agregadas de la cuenta autenticada. */
+export declare class Insights {
+    private readonly transport;
+    constructor(transport: Transport);
+    getOverview(): Promise<InsightsOverview>;
+    overview(): Promise<InsightsOverview>;
+    getTrends(params?: UserInsightsTrendsParams): Promise<InsightsTrends>;
+    trends(params?: UserInsightsTrendsParams): Promise<InsightsTrends>;
+    getTopBanks(params?: UserInsightsTopBanksParams): Promise<InsightsTopBanks>;
+    topBanks(params?: UserInsightsTopBanksParams): Promise<InsightsTopBanks>;
+    getTopBeneficiaries(params?: UserInsightsTopBeneficiariesParams): Promise<InsightsTopBeneficiaries>;
+    topBeneficiaries(params?: UserInsightsTopBeneficiariesParams): Promise<InsightsTopBeneficiaries>;
+}
+/** Resúmenes y descargas financieras. */
+export declare class Finance {
+    private readonly transport;
+    constructor(transport: Transport);
+    getSummary(params: FinanceParams): Promise<FinanceSummary>;
+    summary(params: FinanceParams): Promise<FinanceSummary>;
+    getStatement(params: FinanceStatementParams): Promise<DownloadedFile>;
+    statement(params: FinanceStatementParams): Promise<DownloadedFile>;
+    private preview;
+    getMonthly(params: FinancePreviewParams): Promise<FinancePreview | DownloadedFile>;
+    monthly(params: FinancePreviewParams): Promise<FinancePreview | DownloadedFile>;
+    getCounterparties(params: FinancePreviewParams): Promise<FinancePreview | DownloadedFile>;
+    counterparties(params: FinancePreviewParams): Promise<FinancePreview | DownloadedFile>;
+    getByBank(params: FinancePreviewParams): Promise<FinancePreview | DownloadedFile>;
+    byBank(params: FinancePreviewParams): Promise<FinancePreview | DownloadedFile>;
+    getAccounting(params: FinanceAccountingParams): Promise<FinancePreview | DownloadedFile>;
+    accounting(params: FinanceAccountingParams): Promise<FinancePreview | DownloadedFile>;
+    getCeps(params: FinanceCepsParams): Promise<DownloadedFile>;
+    ceps(params: FinanceCepsParams): Promise<DownloadedFile>;
+}
+/** Suscripción activa de la cuenta autenticada. */
+export declare class Billing {
+    private readonly transport;
+    constructor(transport: Transport);
+    getSubscription(): Promise<BillingSubscription>;
+    subscription(): Promise<BillingSubscription>;
+}
+//# sourceMappingURL=resources.d.ts.map

package/dist/cjs/resources.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"resources.d.ts","sourceRoot":"","sources":["../../src/resources.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAQH,OAAO,EAIL,KAAK,SAAS,EACf,MAAM,WAAW,CAAC;AACnB,OAAO,EASL,KAAK,QAAQ,EACb,KAAK,KAAK,EACX,MAAM,eAAe,CAAC;AACvB,OAAO,EAA2B,KAAK,WAAW,EAAE,KAAK,IAAI,EAAE,MAAM,iBAAiB,CAAC;AACvF,OAAO,EAML,KAAK,QAAQ,EACb,KAAK,WAAW,EAChB,KAAK,0BAA0B,EAC/B,KAAK,oBAAoB,EACzB,KAAK,oBAAoB,EACzB,KAAK,wBAAwB,EAC7B,KAAK,iBAAiB,EACtB,KAAK,uBAAuB,EAC5B,KAAK,mBAAmB,EACxB,KAAK,yBAAyB,EAC9B,KAAK,iBAAiB,EACtB,KAAK,mBAAmB,EACxB,KAAK,kBAAkB,EAEvB,KAAK,qBAAqB,EAC1B,KAAK,uBAAuB,EAC5B,KAAK,uBAAuB,EAC5B,KAAK,cAAc,EACnB,KAAK,oBAAoB,EACzB,KAAK,YAAY,EACjB,KAAK,kBAAkB,EACvB,KAAK,YAAY,EACjB,KAAK,kBAAkB,EACvB,KAAK,WAAW,EAChB,KAAK,YAAY,EACjB,KAAK,mBAAmB,EACxB,KAAK,gBAAgB,EACrB,KAAK,sBAAsB,EAC3B,KAAK,uBAAuB,EAC5B,KAAK,iBAAiB,EACtB,KAAK,aAAa,EAClB,KAAK,cAAc,EACnB,KAAK,oBAAoB,EACzB,KAAK,sBAAsB,EAC3B,KAAK,cAAc,EACnB,KAAK,gBAAgB,EACrB,KAAK,gBAAgB,EACrB,KAAK,0BAA0B,EAC/B,KAAK,wBAAwB,EAC7B,KAAK,kCAAkC,EACvC,KAAK,cAAc,EACnB,KAAK,wBAAwB,EAC7B,KAAK,oBAAoB,EACzB,KAAK,WAAW,EAChB,KAAK,WAAW,EAChB,KAAK,eAAe,EAEpB,KAAK,QAAQ,EACb,KAAK,YAAY,EACjB,KAAK,aAAa,EAClB,KAAK,iBAAiB,EACtB,KAAK,SAAS,EACd,KAAK,WAAW,EAChB,KAAK,SAAS,EACd,KAAK,mBAAmB,EACxB,KAAK,gBAAgB,EACrB,KAAK,cAAc,EACnB,KAAK,sBAAsB,EAE3B,KAAK,uBAAuB,EAC5B,KAAK,oBAAoB,EACzB,KAAK,iBAAiB,EACtB,KAAK,qBAAqB,EAE1B,KAAK,gBAAgB,EACrB,KAAK,YAAY,EACjB,KAAK,WAAW,EAChB,KAAK,kBAAkB,EACvB,KAAK,gBAAgB,EACrB,KAAK,gBAAgB,EACrB,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,EACtB,KAAK,sBAAsB,EAC3B,KAAK,UAAU,EACf,KAAK,iBAAiB,EAGtB,KAAK,eAAe,EACpB,KAAK,iBAAiB,EACtB,KAAK,kBAAkB,EACvB,KAAK,cAAc,EACnB,KAAK,eAAe,EACpB,KAAK,eAAe,EAEpB,KAAK,iBAAiB,EACvB,MAAM,YAAY,CAAC;AA4BpB;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,OAAO,EAAE,iBAAiB,GAAG,KAAK,CAehE;AAmID,0EAA0E;AAC1E,qBAAa,WAAW;IACtB,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAY;gBAE1B,SAAS,EAAE,SAAS;IAMhC;;;;;;OAMG;IACG,QAAQ,CAAC,MAAM,EAAE,sBAAsB,GAAG,OAAO,CAAC,UAAU,CAAC;IAKnE;;;;;;;;OAQG;IACG,WAAW,CAAC,MAAM,EAAE,iBAAiB,GAAG,OAAO,CAAC,UAAU,CAAC;IAUjE;;;;;;;;OAQG;IACG,OAAO,CAAC,MAAM,EAAE,sBAAsB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAKxE;;;;;OAKG;IACG,UAAU,CAAC,MAAM,EAAE,iBAAiB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAUtE,OAAO,CAAC,IAAI;IAiBZ;;;;;;OAMG;IACG,GAAG,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,GAAE,oBAAyB,GAAG,OAAO,CAAC,kBAAkB,CAAC;YAMlF,IAAI;IAoBlB;;;;OAIG;IACG,IAAI,CAAC,MAAM,GAAE,qBAA0B,GAAG,OAAO,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;IAShF;;;;;;;;;;;OAWG;IACH,IAAI,CAAC,MAAM,GAAE,qBAAqB,GAAG,WAAgB,GAAG,aAAa,CAAC,iBAAiB,CAAC;IAQxF;;;;OAIG;IACG,KAAK,CAAC,OAAO,GAAE,iBAAsB,GAAG,OAAO,CAAC,eAAe,CAAC;IAStE;;;;OAIG;IACG,aAAa,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC;IAQlE;;;;;;;;;;;OAWG;IACG,OAAO,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,GAAE,cAAmB,GAAG,OAAO,CAAC,kBAAkB,CAAC;IA6B9F;;;;;;;;;OASG;IACG,GAAG,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,GAAE;QAAE,MAAM,CAAC,EAAE,SAAS,CAAA;KAAO,GAAG,OAAO,CAAC,WAAW,CAAC;IA2B3F;;;;OAIG;IACG,KAAK,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC;IAW1D;;;;OAIG;IACH,MAAM,CAAC,MAAM,GAAE,uBAA4B,GAAG,OAAO,CAAC,cAAc,CAAC;IAYrE;;;;;OAKG;IACG,cAAc,CAClB,YAAY,EAAE,MAAM,EACpB,MAAM,EAAE,WAAW,EACnB,OAAO,GAAE,iBAAsB,GAC9B,OAAO,CAAC,kBAAkB,CAAC;IAU9B;;;;;OAKG;IACG,aAAa,CACjB,YAAY,EAAE,MAAM,EACpB,OAAO,GAAE,iBAAsB,GAC9B,OAAO,CAAC,kBAAkB,CAAC;IAS9B;;;;OAIG;IACG,MAAM,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAOjD;;;;;OAKG;IACG,iBAAiB,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC;CAOzE;AAsBD,uDAAuD;AACvD,qBAAa,QAAQ;IACnB,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAY;gBAE1B,SAAS,EAAE,SAAS;IAIhC;;;;;;OAMG;IACG,MAAM,CAAC,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAAC,eAAe,CAAC;IAWnE;;;;OAIG;IACG,IAAI,IAAI,OAAO,CAAC,eAAe,EAAE,CAAC;IAKxC;;;;;OAKG;IACG,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAAC,eAAe,CAAC;IAqBtF;;;;OAIG;IACG,MAAM,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAO9C;;;;;OAKG;IACG,IAAI,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAQzD;;;;;OAKG;IACG,gBAAgB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC;IAUnE;;;;;;;OAOG;IACH,UAAU,CAAC,MAAM,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IACrE,UAAU,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IA8BxF;;;;OAIG;IACH,cAAc,CAAC,MAAM,CAAC,EAAE,gBAAgB,GAAG,WAAW,GAAG,aAAa,CAAC,eAAe,CAAC;IACvF,cAAc,CACZ,SAAS,EAAE,MAAM,EACjB,MAAM,CAAC,EAAE,gBAAgB,GAAG,WAAW,GACtC,aAAa,CAAC,eAAe,CAAC;IAmBjC;;;;;OAKG;IACH,gBAAgB,CAAC,MAAM,CAAC,EAAE,sBAAsB,GAAG,OAAO,CAAC,cAAc,CAAC;IAC1E,gBAAgB,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,sBAAsB,GAAG,OAAO,CAAC,cAAc,CAAC;CAgC9F;AAID,sEAAsE;AACtE,qBAAa,OAAO;IAClB,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAY;gBAE1B,SAAS,EAAE,SAAS;IAIhC;;;;;;OAMG;IACG,KAAK,CAAC,OAAO,GAAE,YAAiB,GAAG,OAAO,CAAC,QAAQ,CAAC;IAc1D;;;;OAIG;IACG,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC;IAQhD;;;;;OAKG;IACG,aAAa,IAAI,OAAO,CAAC,aAAa,CAAC;IAK7C;;;;OAIG;IACG,iBAAiB,CAAC,MAAM,GAAE,gBAAqB,GAAG,OAAO,CAAC,iBAAiB,CAAC;CAQnF;AAsDD,+DAA+D;AAC/D,qBAAa,aAAa;IACxB,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAY;gBAE1B,SAAS,EAAE,SAAS;IAMhC;;;;;;;OAOG;IACG,MAAM,CAAC,MAAM,EAAE,uBAAuB,GAAG,OAAO,CAAC,WAAW,CAAC;IAiBnE;;;;;OAKG;IACG,IAAI,CAAC,MAAM,GAAE,uBAA4B,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;IASxE;;;;;OAKG;IACG,MAAM,CAAC,aAAa,EAAE,QAAQ,EAAE,MAAM,EAAE,uBAAuB,GAAG,OAAO,CAAC,WAAW,CAAC;IAe5F;;;;;;OAMG;IACG,MAAM,CAAC,aAAa,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;IAOpD;;;;;OAKG;IACG,MAAM,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC;IASzD;;;;;OAKG;IACH,MAAM,CAAC,MAAM,GAAE,yBAA8B,GAAG,OAAO,CAAC,cAAc,CAAC;IAavE;;;;;OAKG;IACG,cAAc,CAAC,OAAO,GAAE,qBAA0B,GAAG,OAAO,CAAC,cAAc,CAAC;IAqBlF;;;;;;;OAOG;IACG,WAAW,CACf,IAAI,EAAE,UAAU,GAAG,MAAM,EACzB,OAAO,GAAE,kBAAuB,GAC/B,OAAO,CAAC,wBAAwB,CAAC;IAcpC;;;;OAIG;IACG,YAAY,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAQrE;;;;;;;OAOG;IACG,YAAY,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;IAOrD;;;;;;OAMG;IACG,aAAa,CACjB,QAAQ,EAAE,QAAQ,EAClB,MAAM,GAAE,mBAAwB,GAC/B,OAAO,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;IAStC;;;;OAIG;IACH,iBAAiB,CACf,QAAQ,EAAE,QAAQ,EAClB,MAAM,GAAE,mBAAmB,GAAG,WAAgB,GAC7C,aAAa,CAAC,oBAAoB,CAAC;IAQtC;;;;;;OAMG;IACG,aAAa,CACjB,QAAQ,EAAE,QAAQ,EAClB,KAAK,EAAE,QAAQ,EACf,MAAM,EAAE,mBAAmB,GAC1B,OAAO,CAAC,oBAAoB,CAAC;IAmBhC;;;;OAIG;IACG,eAAe,CAAC,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;IAOzE;;;;;;OAMG;IACG,YAAY,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,0BAA0B,CAAC;IAQ3E;;;;;;;;OAQG;IACG,UAAU,CACd,QAAQ,EAAE,QAAQ,EAClB,OAAO,GAAE,cAAmB,GAC3B,OAAO,CAAC,oBAAoB,CAAC;CAmBjC;AAID,uEAAuE;AACvE,qBAAa,KAAK;IAChB,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAY;gBAE1B,SAAS,EAAE,SAAS;IAIhC;;;;;OAKG;IACG,OAAO,IAAI,OAAO,CAAC,YAAY,CAAC;IAKtC;;;;;OAKG;IACG,OAAO,CAAC,MAAM,GAAE,kBAAuB,GAAG,OAAO,CAAC,YAAY,CAAC;IASrE;;;;;OAKG;IACG,SAAS,CAAC,MAAM,GAAE,oBAAyB,GAAG,OAAO,CAAC,cAAc,CAAC;IAS3E;;;;;OAKG;IACG,MAAM,IAAI,OAAO,CAAC,WAAW,CAAC;IAKpC;;;;;OAKG;IACG,OAAO,CAAC,MAAM,GAAE,kBAAuB,GAAG,OAAO,CAAC,YAAY,CAAC;IASrE;;;;;OAKG;IACG,QAAQ,IAAI,OAAO,CAAC,QAAQ,CAAC;IAKnC;;;;;OAKG;IACH,MAAM,CAAC,MAAM,GAAE,iBAAsB,GAAG,OAAO,CAAC,cAAc,CAAC;CAShE;AAID,sDAAsD;AACtD,qBAAa,OAAO;IACN,OAAO,CAAC,QAAQ,CAAC,SAAS;gBAAT,SAAS,EAAE,SAAS;IAEjD,0BAA0B;IACpB,SAAS,IAAI,OAAO,CAAC,WAAW,CAAC;IAKvC,OAAO,IAAI,OAAO,CAAC,WAAW,CAAC;IAI/B,uCAAuC;IACjC,gBAAgB,IAAI,OAAO,CAAC,eAAe,CAAC;IAQlD,WAAW,IAAI,OAAO,CAAC,eAAe,CAAC;IAIvC,uCAAuC;IACjC,mBAAmB,CACvB,MAAM,EAAE,WAAW,EACnB,OAAO,GAAE,iBAAsB,GAC9B,OAAO,CAAC,eAAe,CAAC;CAU5B;AAED,sCAAsC;AACtC,qBAAa,SAAS;IACR,OAAO,CAAC,QAAQ,CAAC,SAAS;gBAAT,SAAS,EAAE,SAAS;IAEjD,yBAAyB;IACnB,UAAU,CAAC,MAAM,GAAE,sBAA2B,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAShF,OAAO,CAAC,MAAM,GAAE,sBAA2B,GAAG,OAAO,CAAC,gBAAgB,CAAC;CAGxE;AAED,uDAAuD;AACvD,qBAAa,KAAK;IACJ,OAAO,CAAC,QAAQ,CAAC,SAAS;gBAAT,SAAS,EAAE,SAAS;IAEjD,8BAA8B;IACxB,UAAU,IAAI,OAAO,CAAC,WAAW,CAAC;IASxC,IAAI,IAAI,OAAO,CAAC,WAAW,CAAC;IAI5B,yCAAyC;IACnC,uBAAuB,IAAI,OAAO,CAAC,oBAAoB,CAAC;IAS9D,UAAU,IAAI,OAAO,CAAC,oBAAoB,CAAC;CAG5C;AAED,mDAAmD;AACnD,qBAAa,QAAQ;IACP,OAAO,CAAC,QAAQ,CAAC,SAAS;gBAAT,SAAS,EAAE,SAAS;IAE3C,WAAW,IAAI,OAAO,CAAC,gBAAgB,CAAC;IAK9C,QAAQ,IAAI,OAAO,CAAC,gBAAgB,CAAC;IAI/B,SAAS,CAAC,MAAM,GAAE,wBAA6B,GAAG,OAAO,CAAC,cAAc,CAAC;IAS/E,MAAM,CAAC,MAAM,GAAE,wBAA6B,GAAG,OAAO,CAAC,cAAc,CAAC;IAIhE,WAAW,CAAC,MAAM,GAAE,0BAA+B,GAAG,OAAO,CAAC,gBAAgB,CAAC;IASrF,QAAQ,CAAC,MAAM,GAAE,0BAA+B,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAItE,mBAAmB,CACvB,MAAM,GAAE,kCAAuC,GAC9C,OAAO,CAAC,wBAAwB,CAAC;IASpC,gBAAgB,CACd,MAAM,GAAE,kCAAuC,GAC9C,OAAO,CAAC,wBAAwB,CAAC;CAGrC;AA4BD,yCAAyC;AACzC,qBAAa,OAAO;IACN,OAAO,CAAC,QAAQ,CAAC,SAAS;gBAAT,SAAS,EAAE,SAAS;IAE3C,UAAU,CAAC,MAAM,EAAE,aAAa,GAAG,OAAO,CAAC,cAAc,CAAC;IAShE,OAAO,CAAC,MAAM,EAAE,aAAa,GAAG,OAAO,CAAC,cAAc,CAAC;IAIvD,YAAY,CAAC,MAAM,EAAE,sBAAsB,GAAG,OAAO,CAAC,cAAc,CAAC;IAUrE,SAAS,CAAC,MAAM,EAAE,sBAAsB,GAAG,OAAO,CAAC,cAAc,CAAC;IAIlE,OAAO,CAAC,OAAO;IAwBf,UAAU,CAAC,MAAM,EAAE,oBAAoB,GAAG,OAAO,CAAC,cAAc,GAAG,cAAc,CAAC;IAIlF,OAAO,CAAC,MAAM,EAAE,oBAAoB,GAAG,OAAO,CAAC,cAAc,GAAG,cAAc,CAAC;IAI/E,iBAAiB,CAAC,MAAM,EAAE,oBAAoB,GAAG,OAAO,CAAC,cAAc,GAAG,cAAc,CAAC;IAIzF,cAAc,CAAC,MAAM,EAAE,oBAAoB,GAAG,OAAO,CAAC,cAAc,GAAG,cAAc,CAAC;IAItF,SAAS,CAAC,MAAM,EAAE,oBAAoB,GAAG,OAAO,CAAC,cAAc,GAAG,cAAc,CAAC;IAIjF,MAAM,CAAC,MAAM,EAAE,oBAAoB,GAAG,OAAO,CAAC,cAAc,GAAG,cAAc,CAAC;IAI9E,aAAa,CAAC,MAAM,EAAE,uBAAuB,GAAG,OAAO,CAAC,cAAc,GAAG,cAAc,CAAC;IA+BxF,UAAU,CAAC,MAAM,EAAE,uBAAuB,GAAG,OAAO,CAAC,cAAc,GAAG,cAAc,CAAC;IAIrF,OAAO,CAAC,MAAM,EAAE,iBAAiB,GAAG,OAAO,CAAC,cAAc,CAAC;IAW3D,IAAI,CAAC,MAAM,EAAE,iBAAiB,GAAG,OAAO,CAAC,cAAc,CAAC;CAGzD;AAED,mDAAmD;AACnD,qBAAa,OAAO;IACN,OAAO,CAAC,QAAQ,CAAC,SAAS;gBAAT,SAAS,EAAE,SAAS;IAE3C,eAAe,IAAI,OAAO,CAAC,mBAAmB,CAAC;IAQrD,YAAY,IAAI,OAAO,CAAC,mBAAmB,CAAC;CAG7C"}