@artu-ai/compliance-sdk 0.13.4 → 0.17.0

package/dist/resources/mx/av/mpc/alerts.d.ts

@@ -0,0 +1,271 @@
+/**
+ * MPC (Mutuo, Préstamos y Créditos) Alerts Resource
+ *
+ * Extends MexAlertsResource with MPC-specific behavior:
+ * - Accepts flattened CreateMPCAlertInput (MPC fields at root level)
+ * - Returns MexMPCAlert models
+ */
+import type { AlertItemFilter, AlertItemSort, AlertSort, AtomicBatchResult, CreateAlertInput, CreateAlertItemInput, CreateMPCAlertInput, CreateMPCAlertItemInput, GenerateResult, ListOptions, MPCAlertFilter, MPCAlertItemFilter, MPCAlertSort, MpcAlertDefaultsInput, PaginatedResponse, PartialBatchResult, UpdateAlertInput, UpdateAlertItemInput, UpdateMPCAlertInput, UpdateMPCAlertItemInput, UpsertMPCAlertInput, UpsertResult, ValidationResult } from "@artu-ai/shared";
+import { ReportType } from "@artu-ai/shared";
+import { type AlertClientItemData, type AlertData, type AlertItemData, type AlertTransactionItemData, MexMPCAlert, MexMPCAlertClientItem, MexMPCAlertItem, MexMPCAlertTransactionItem } from "../../../../models";
+import { AlertItemsResource } from "../../../alert-items";
+import { AVAlertsResource } from "../alerts";
+/**
+ * MPC (Mutuo, Préstamos y Créditos) scoped alerts resource.
+ *
+ * @example
+ * ```typescript
+ * const mpcSdk = new ComplianceSDK({
+ *   apiKey,
+ *   scope: "MX:AV:MPC",
+ * });
+ *
+ * const alert = await mpcSdk.alerts.create({
+ *   mesReportado: "202401",
+ * });
+ *
+ * // Returns MexMPCAlert
+ * console.log(alert.mesReportado);
+ * ```
+ */
+export declare class MPCAlertsResource extends AVAlertsResource {
+    create(data: CreateMPCAlertInput): Promise<MexMPCAlert>;
+    retrieve(id: string, opts?: {
+        crossScope?: boolean;
+    }): Promise<MexMPCAlert>;
+    retrieveByMetadata(key: string, value: string, opts?: {
+        crossScope?: boolean;
+    }): Promise<MexMPCAlert>;
+    retrieveByExternalId(externalId: string, opts?: {
+        crossScope?: boolean;
+    }): Promise<MexMPCAlert>;
+    update(id: string, data: UpdateMPCAlertInput): Promise<MexMPCAlert>;
+    list(options?: ListOptions<MPCAlertFilter, MPCAlertSort> & {
+        crossScope?: boolean;
+    }): Promise<PaginatedResponse<MexMPCAlert>>;
+    iterate(options?: {
+        filter?: MPCAlertFilter;
+        sort?: MPCAlertSort;
+        pageSize?: number;
+        crossScope?: boolean;
+    }): AsyncGenerator<MexMPCAlert, void, undefined>;
+    count(filter?: MPCAlertFilter, options?: {
+        crossScope?: boolean;
+    }): Promise<number>;
+    createMany(alerts: CreateMPCAlertInput[], options?: {
+        atomic?: true;
+    }): Promise<AtomicBatchResult<MexMPCAlert>>;
+    createMany(alerts: CreateMPCAlertInput[], options: {
+        atomic: false;
+    }): Promise<PartialBatchResult<MexMPCAlert>>;
+    updateMany(updates: {
+        id: string;
+        data: UpdateMPCAlertInput;
+    }[], options?: {
+        atomic?: true;
+    }): Promise<AtomicBatchResult<MexMPCAlert>>;
+    updateMany(updates: {
+        id: string;
+        data: UpdateMPCAlertInput;
+    }[], options: {
+        atomic: false;
+    }): Promise<PartialBatchResult<MexMPCAlert>>;
+    upsertByExternalId(data: UpsertMPCAlertInput): Promise<UpsertResult<MexMPCAlert>>;
+    upsertManyByExternalId(alerts: UpsertMPCAlertInput[], options?: {
+        atomic?: true;
+    }): Promise<AtomicBatchResult<UpsertResult<MexMPCAlert>>>;
+    upsertManyByExternalId(alerts: UpsertMPCAlertInput[], options: {
+        atomic: false;
+    }): Promise<PartialBatchResult<UpsertResult<MexMPCAlert>>>;
+    addItem(alertId: string, data: CreateMPCAlertItemInput): Promise<MexMPCAlertItem>;
+    getItem(alertId: string, itemId: string): Promise<MexMPCAlertItem>;
+    updateItem(alertId: string, itemId: string, data: UpdateMPCAlertItemInput): Promise<MexMPCAlertItem>;
+    listItems(alertId: string, options?: ListOptions<MPCAlertItemFilter, AlertItemSort>): Promise<PaginatedResponse<MexMPCAlertItem>>;
+    protected applyScopeToItemFilter(filter?: MPCAlertItemFilter): AlertItemFilter | undefined;
+    addItems(alertId: string, items: CreateMPCAlertItemInput[]): Promise<{
+        added: number;
+        items: MexMPCAlertItem[];
+    }>;
+    protected createItemsResource(): AlertItemsResource<MexMPCAlertItem, {
+        id?: string | {
+            eq?: string | undefined;
+            in?: string[] | undefined;
+            nin?: string[] | undefined;
+        } | undefined;
+        clientId?: string | {
+            eq?: string | undefined;
+            in?: string[] | undefined;
+            nin?: string[] | undefined;
+        } | undefined;
+        createdAt?: string | {
+            eq?: string | undefined;
+            gt?: string | undefined;
+            gte?: string | undefined;
+            lt?: string | undefined;
+            lte?: string | undefined;
+        } | undefined;
+        updatedAt?: string | {
+            eq?: string | undefined;
+            gt?: string | undefined;
+            gte?: string | undefined;
+            lt?: string | undefined;
+            lte?: string | undefined;
+        } | undefined;
+        metadataFilters?: {
+            key: string;
+            value: string;
+        }[] | undefined;
+        alertId?: string | {
+            eq?: string | undefined;
+            in?: string[] | undefined;
+            nin?: string[] | undefined;
+        } | undefined;
+        transactionId?: string | {
+            eq?: string | undefined;
+            in?: string[] | undefined;
+            nin?: string[] | undefined;
+        } | undefined;
+        hasErrors?: boolean | undefined;
+        clientNames?: string | {
+            eq?: string | undefined;
+            contains?: string | undefined;
+            startsWith?: string | undefined;
+            endsWith?: string | undefined;
+            in?: string[] | undefined;
+            nin?: string[] | undefined;
+        } | undefined;
+        transactionAmount?: number | {
+            eq?: number | undefined;
+            gt?: number | undefined;
+            gte?: number | undefined;
+            lt?: number | undefined;
+            lte?: number | undefined;
+            in?: number[] | undefined;
+            nin?: number[] | undefined;
+        } | undefined;
+        transactionCurrency?: string | {
+            eq?: string | undefined;
+            in?: string[] | undefined;
+            nin?: string[] | undefined;
+        } | undefined;
+        transactionDate?: string | {
+            eq?: string | undefined;
+            gt?: string | undefined;
+            gte?: string | undefined;
+            lt?: string | undefined;
+            lte?: string | undefined;
+        } | undefined;
+        actividadVulnerable?: {
+            ARI?: {
+                alertType?: "100" | "3001" | "3002" | "3003" | "3004" | "3005" | "3006" | "3007" | "3008" | "3009" | "3010" | "3011" | "3012" | "3013" | "3014" | "3015" | "3016" | "3017" | "3018" | "3019" | "3020" | "3021" | "3022" | "3023" | "3024" | "9999" | {
+                    eq?: "100" | "3001" | "3002" | "3003" | "3004" | "3005" | "3006" | "3007" | "3008" | "3009" | "3010" | "3011" | "3012" | "3013" | "3014" | "3015" | "3016" | "3017" | "3018" | "3019" | "3020" | "3021" | "3022" | "3023" | "3024" | "9999" | undefined;
+                    in?: ("100" | "3001" | "3002" | "3003" | "3004" | "3005" | "3006" | "3007" | "3008" | "3009" | "3010" | "3011" | "3012" | "3013" | "3014" | "3015" | "3016" | "3017" | "3018" | "3019" | "3020" | "3021" | "3022" | "3023" | "3024" | "9999")[] | undefined;
+                    nin?: ("100" | "3001" | "3002" | "3003" | "3004" | "3005" | "3006" | "3007" | "3008" | "3009" | "3010" | "3011" | "3012" | "3013" | "3014" | "3015" | "3016" | "3017" | "3018" | "3019" | "3020" | "3021" | "3022" | "3023" | "3024" | "9999")[] | undefined;
+                } | undefined;
+            } | undefined;
+            AVI?: {
+                alertType?: "100" | "9999" | "4101" | "4102" | "4103" | "4104" | "4105" | "4106" | "4107" | "4108" | "4109" | "4110" | "4111" | "4112" | "4113" | "4114" | "4115" | "4116" | "4117" | "4118" | "4119" | "4120" | "4121" | "4122" | {
+                    eq?: "100" | "9999" | "4101" | "4102" | "4103" | "4104" | "4105" | "4106" | "4107" | "4108" | "4109" | "4110" | "4111" | "4112" | "4113" | "4114" | "4115" | "4116" | "4117" | "4118" | "4119" | "4120" | "4121" | "4122" | undefined;
+                    in?: ("100" | "9999" | "4101" | "4102" | "4103" | "4104" | "4105" | "4106" | "4107" | "4108" | "4109" | "4110" | "4111" | "4112" | "4113" | "4114" | "4115" | "4116" | "4117" | "4118" | "4119" | "4120" | "4121" | "4122")[] | undefined;
+                    nin?: ("100" | "9999" | "4101" | "4102" | "4103" | "4104" | "4105" | "4106" | "4107" | "4108" | "4109" | "4110" | "4111" | "4112" | "4113" | "4114" | "4115" | "4116" | "4117" | "4118" | "4119" | "4120" | "4121" | "4122")[] | undefined;
+                } | undefined;
+            } | undefined;
+            INM?: {
+                alertType?: "100" | "9999" | "3101" | "3102" | "3103" | "3104" | "3105" | "3106" | "3107" | "3108" | "3109" | "3110" | "3111" | "3112" | "3113" | "3114" | "3115" | "3116" | "3117" | "3118" | "3119" | "3120" | {
+                    eq?: "100" | "9999" | "3101" | "3102" | "3103" | "3104" | "3105" | "3106" | "3107" | "3108" | "3109" | "3110" | "3111" | "3112" | "3113" | "3114" | "3115" | "3116" | "3117" | "3118" | "3119" | "3120" | undefined;
+                    in?: ("100" | "9999" | "3101" | "3102" | "3103" | "3104" | "3105" | "3106" | "3107" | "3108" | "3109" | "3110" | "3111" | "3112" | "3113" | "3114" | "3115" | "3116" | "3117" | "3118" | "3119" | "3120")[] | undefined;
+                    nin?: ("100" | "9999" | "3101" | "3102" | "3103" | "3104" | "3105" | "3106" | "3107" | "3108" | "3109" | "3110" | "3111" | "3112" | "3113" | "3114" | "3115" | "3116" | "3117" | "3118" | "3119" | "3120")[] | undefined;
+                } | undefined;
+            } | undefined;
+            JYS?: {
+                alertType?: "100" | "9999" | "2101" | "2102" | "2103" | "2104" | "2105" | "2106" | "2107" | "2108" | "2109" | "2110" | "2111" | "2112" | "2113" | "2114" | "2115" | "2116" | "2117" | "2118" | "2119" | "2120" | "2121" | "2122" | "2123" | "2124" | "2125" | "2126" | "2127" | {
+                    eq?: "100" | "9999" | "2101" | "2102" | "2103" | "2104" | "2105" | "2106" | "2107" | "2108" | "2109" | "2110" | "2111" | "2112" | "2113" | "2114" | "2115" | "2116" | "2117" | "2118" | "2119" | "2120" | "2121" | "2122" | "2123" | "2124" | "2125" | "2126" | "2127" | undefined;
+                    in?: ("100" | "9999" | "2101" | "2102" | "2103" | "2104" | "2105" | "2106" | "2107" | "2108" | "2109" | "2110" | "2111" | "2112" | "2113" | "2114" | "2115" | "2116" | "2117" | "2118" | "2119" | "2120" | "2121" | "2122" | "2123" | "2124" | "2125" | "2126" | "2127")[] | undefined;
+                    nin?: ("100" | "9999" | "2101" | "2102" | "2103" | "2104" | "2105" | "2106" | "2107" | "2108" | "2109" | "2110" | "2111" | "2112" | "2113" | "2114" | "2115" | "2116" | "2117" | "2118" | "2119" | "2120" | "2121" | "2122" | "2123" | "2124" | "2125" | "2126" | "2127")[] | undefined;
+                } | undefined;
+            } | undefined;
+            MJR?: {
+                alertType?: "100" | "9999" | "2901" | "2902" | "2903" | "2904" | "2905" | "2906" | "2907" | "2908" | "2909" | "2910" | "2911" | "2912" | "2913" | "2914" | "2915" | "2916" | "2917" | "2918" | "2919" | "2920" | "2921" | "2922" | "2923" | "2924" | "2925" | {
+                    eq?: "100" | "9999" | "2901" | "2902" | "2903" | "2904" | "2905" | "2906" | "2907" | "2908" | "2909" | "2910" | "2911" | "2912" | "2913" | "2914" | "2915" | "2916" | "2917" | "2918" | "2919" | "2920" | "2921" | "2922" | "2923" | "2924" | "2925" | undefined;
+                    in?: ("100" | "9999" | "2901" | "2902" | "2903" | "2904" | "2905" | "2906" | "2907" | "2908" | "2909" | "2910" | "2911" | "2912" | "2913" | "2914" | "2915" | "2916" | "2917" | "2918" | "2919" | "2920" | "2921" | "2922" | "2923" | "2924" | "2925")[] | undefined;
+                    nin?: ("100" | "9999" | "2901" | "2902" | "2903" | "2904" | "2905" | "2906" | "2907" | "2908" | "2909" | "2910" | "2911" | "2912" | "2913" | "2914" | "2915" | "2916" | "2917" | "2918" | "2919" | "2920" | "2921" | "2922" | "2923" | "2924" | "2925")[] | undefined;
+                } | undefined;
+            } | undefined;
+            MPC?: {
+                alertType?: "100" | "9999" | "2801" | "2802" | "2803" | "2804" | "2805" | "2806" | "2807" | "2808" | "2809" | "2810" | "2811" | "2812" | "2813" | "2814" | {
+                    eq?: "100" | "9999" | "2801" | "2802" | "2803" | "2804" | "2805" | "2806" | "2807" | "2808" | "2809" | "2810" | "2811" | "2812" | "2813" | "2814" | undefined;
+                    in?: ("100" | "9999" | "2801" | "2802" | "2803" | "2804" | "2805" | "2806" | "2807" | "2808" | "2809" | "2810" | "2811" | "2812" | "2813" | "2814")[] | undefined;
+                    nin?: ("100" | "9999" | "2801" | "2802" | "2803" | "2804" | "2805" | "2806" | "2807" | "2808" | "2809" | "2810" | "2811" | "2812" | "2813" | "2814")[] | undefined;
+                } | undefined;
+            } | undefined;
+            TSC?: {
+                alertType?: "100" | "9999" | "2201" | "2202" | "2203" | "2204" | "2205" | "2206" | "2207" | "2208" | "2209" | "2210" | "2211" | "2212" | "2213" | "2214" | "2215" | "2216" | {
+                    eq?: "100" | "9999" | "2201" | "2202" | "2203" | "2204" | "2205" | "2206" | "2207" | "2208" | "2209" | "2210" | "2211" | "2212" | "2213" | "2214" | "2215" | "2216" | undefined;
+                    in?: ("100" | "9999" | "2201" | "2202" | "2203" | "2204" | "2205" | "2206" | "2207" | "2208" | "2209" | "2210" | "2211" | "2212" | "2213" | "2214" | "2215" | "2216")[] | undefined;
+                    nin?: ("100" | "9999" | "2201" | "2202" | "2203" | "2204" | "2205" | "2206" | "2207" | "2208" | "2209" | "2210" | "2211" | "2212" | "2213" | "2214" | "2215" | "2216")[] | undefined;
+                } | undefined;
+            } | undefined;
+            VEH?: {
+                alertType?: "100" | "9999" | "2501" | "2502" | "2503" | "2504" | "2505" | "2506" | "2507" | "2508" | "2509" | "2510" | "2511" | "2512" | "2513" | "2514" | "2515" | "2516" | "2517" | "2518" | "2519" | "2520" | "2521" | {
+                    eq?: "100" | "9999" | "2501" | "2502" | "2503" | "2504" | "2505" | "2506" | "2507" | "2508" | "2509" | "2510" | "2511" | "2512" | "2513" | "2514" | "2515" | "2516" | "2517" | "2518" | "2519" | "2520" | "2521" | undefined;
+                    in?: ("100" | "9999" | "2501" | "2502" | "2503" | "2504" | "2505" | "2506" | "2507" | "2508" | "2509" | "2510" | "2511" | "2512" | "2513" | "2514" | "2515" | "2516" | "2517" | "2518" | "2519" | "2520" | "2521")[] | undefined;
+                    nin?: ("100" | "9999" | "2501" | "2502" | "2503" | "2504" | "2505" | "2506" | "2507" | "2508" | "2509" | "2510" | "2511" | "2512" | "2513" | "2514" | "2515" | "2516" | "2517" | "2518" | "2519" | "2520" | "2521")[] | undefined;
+                } | undefined;
+            } | undefined;
+            alertDescription?: string | {
+                eq?: string | undefined;
+                contains?: string | undefined;
+                startsWith?: string | undefined;
+                endsWith?: string | undefined;
+                in?: string[] | undefined;
+                nin?: string[] | undefined;
+            } | undefined;
+        } | undefined;
+        cnbv?: {
+            TRANSMISOR?: Record<string, never> | undefined;
+        } | undefined;
+        alertType?: "100" | "9999" | "2801" | "2802" | "2803" | "2804" | "2805" | "2806" | "2807" | "2808" | "2809" | "2810" | "2811" | "2812" | "2813" | "2814" | {
+            eq?: "100" | "9999" | "2801" | "2802" | "2803" | "2804" | "2805" | "2806" | "2807" | "2808" | "2809" | "2810" | "2811" | "2812" | "2813" | "2814" | undefined;
+            in?: ("100" | "9999" | "2801" | "2802" | "2803" | "2804" | "2805" | "2806" | "2807" | "2808" | "2809" | "2810" | "2811" | "2812" | "2813" | "2814")[] | undefined;
+            nin?: ("100" | "9999" | "2801" | "2802" | "2803" | "2804" | "2805" | "2806" | "2807" | "2808" | "2809" | "2810" | "2811" | "2812" | "2813" | "2814")[] | undefined;
+        } | undefined;
+        alertDescription?: string | {
+            eq?: string | undefined;
+            contains?: string | undefined;
+            startsWith?: string | undefined;
+            endsWith?: string | undefined;
+            in?: string[] | undefined;
+            nin?: string[] | undefined;
+        } | undefined;
+    }>;
+    /**
+     * Validates an MPC alert.
+     *
+     * @param alertId - The alert ID to validate
+     * @param defaults - MPC alert defaults including rfc, alertType, etc.
+     */
+    validateReport(alertId: string, defaults?: MpcAlertDefaultsInput): Promise<ValidationResult>;
+    /**
+     * Generates XML for an MPC alert.
+     *
+     * @param alertId - The alert ID to generate XML for
+     * @param defaults - MPC alert defaults including rfc, alertType, etc.
+     */
+    generateReport(alertId: string, defaults?: MpcAlertDefaultsInput): Promise<GenerateResult>;
+    protected transformToNested(data: CreateMPCAlertInput): CreateAlertInput;
+    protected transformUpdateToNested(data: UpdateMPCAlertInput): UpdateAlertInput;
+    protected instantiate(data: AlertData): MexMPCAlert;
+    /** Materializes a raw payload into a {@link MexMPCAlert} (return type narrowed via the `instantiate` override). */
+    materialize(data: AlertData): MexMPCAlert;
+    protected instantiateItem(data: AlertItemData): MexMPCAlertItem;
+    protected instantiateTransactionItem(data: AlertTransactionItemData): MexMPCAlertTransactionItem;
+    protected instantiateClientItem(data: AlertClientItemData): MexMPCAlertClientItem;
+    protected transformItemToNested(data: CreateMPCAlertItemInput): CreateAlertItemInput;
+    protected transformItemUpdateToNested(data: UpdateMPCAlertItemInput): UpdateAlertItemInput;
+    protected applyScopeToSort(sort?: MPCAlertSort): AlertSort | undefined;
+    protected transformMpcDefaultsToNested(alertId: string, defaults?: MpcAlertDefaultsInput): {
+        alertId: string;
+        reportType: ReportType;
+        defaults?: unknown;
+    };
+}