vesant-sdk 1.0.4

package/dist/risk-profile/index.d.ts

@@ -0,0 +1,228 @@
+import { B as BaseClient, a as BaseClientConfig } from '../types-Bnsnejor.js';
+export { g as EntityType } from '../types-Bnsnejor.js';
+import { d as CreateProfileRequest, C as CustomerProfile, P as ProfileDetailsResponse, U as UpdateProfileRequest, e as ProfileFilters, f as ProfileListResponse, g as RiskDashboardMetrics, h as RiskConfiguration } from '../types-CFupjwi8.js';
+export { E as EmploymentType, L as LegalForm, R as RiskCategory, a as RiskFactor, b as RiskFactorType, c as RiskHistory, S as ScreeningStatus } from '../types-CFupjwi8.js';
+
+/**
+ * RiskProfileClient - Customer Risk Profile Management
+ *
+ * Provides methods to create, retrieve, and manage customer risk profiles
+ * in the Vesant Compliance Platform.
+ */
+
+declare class RiskProfileClient extends BaseClient {
+    constructor(config: BaseClientConfig);
+    /**
+     * Create a new customer risk profile
+     *
+     * @param request - Profile creation data
+     * @returns Created customer profile
+     *
+     * @example
+     * ```typescript
+     * const profile = await client.createProfile({
+     *   customer_id: 'CUST-12345',
+     *   entity_type: 'individual',
+     *   customer_status: 'active',
+     *   full_name: 'John Doe',
+     *   email_address: 'john@example.com',
+     *   date_of_birth: '1990-01-15',
+     *   country_of_residence: 'US'
+     * });
+     * ```
+     */
+    createProfile(request: CreateProfileRequest): Promise<CustomerProfile>;
+    /**
+     * Get customer profile by customer ID
+     *
+     * Note: This searches for the profile using the customer_id field.
+     * Returns the first matching profile for the tenant.
+     *
+     * @param customerId - Customer ID to search for
+     * @returns Customer profile
+     *
+     * @example
+     * ```typescript
+     * const profile = await client.getProfile('CUST-12345');
+     * console.log('Risk score:', profile.risk_score);
+     * ```
+     */
+    getProfile(customerId: string): Promise<CustomerProfile>;
+    /**
+     * Get profile by UUID
+     *
+     * @param profileId - Profile UUID
+     * @returns Customer profile
+     */
+    getProfileById(profileId: string): Promise<CustomerProfile>;
+    /**
+     * Get detailed profile information including risk factors and history
+     *
+     * @param profileId - Profile UUID
+     * @returns Detailed profile response with risk factors and history
+     *
+     * @example
+     * ```typescript
+     * const details = await client.getProfileDetails(profileId);
+     * console.log('Risk factors:', details.risk_factors);
+     * console.log('Risk history:', details.risk_history);
+     * console.log('Alert counts:', {
+     *   watchlist: details.watchlist_alert_count,
+     *   fraud: details.fraud_alert_count,
+     *   geo: details.geolocation_alert_count
+     * });
+     * ```
+     */
+    getProfileDetails(profileId: string): Promise<ProfileDetailsResponse>;
+    /**
+     * Update customer profile
+     *
+     * @param profileId - Profile UUID
+     * @param updates - Fields to update
+     * @returns Updated customer profile
+     *
+     * @example
+     * ```typescript
+     * const updated = await client.updateProfile(profileId, {
+     *   location: 'New York, USA',
+     *   location_compliance: 'compliant',
+     *   last_recorded_activity: new Date().toISOString()
+     * });
+     * ```
+     */
+    updateProfile(profileId: string, updates: UpdateProfileRequest): Promise<CustomerProfile>;
+    /**
+     * Manually recalculate risk score for a profile
+     *
+     * Triggers immediate risk score recalculation based on current risk factors.
+     *
+     * @param profileId - Profile UUID
+     * @param reason - Optional reason for recalculation
+     *
+     * @example
+     * ```typescript
+     * await client.recalculateRiskScore(profileId, 'Manual review completed');
+     * ```
+     */
+    recalculateRiskScore(profileId: string, reason?: string): Promise<void>;
+    /**
+     * Query profiles with advanced filters
+     *
+     * @param filters - Filter criteria and pagination
+     * @returns Paginated list of profiles
+     *
+     * @example
+     * ```typescript
+     * const results = await client.queryProfiles({
+     *   risk_category: ['high', 'critical'],
+     *   kyc_status: ['pending'],
+     *   is_pep: true,
+     *   page: 1,
+     *   page_size: 20,
+     *   sort_by: 'risk_score',
+     *   sort_order: 'desc'
+     * });
+     *
+     * console.log(`Found ${results.total} high-risk profiles`);
+     * results.data.forEach(profile => {
+     *   console.log(`${profile.full_name}: ${profile.risk_score}`);
+     * });
+     * ```
+     */
+    queryProfiles(filters?: ProfileFilters): Promise<ProfileListResponse>;
+    /**
+     * Search profiles by text (searches name, email, customer_id, account_number)
+     *
+     * @param searchText - Text to search for
+     * @param limit - Maximum results to return (default: 10)
+     * @returns Array of matching profiles
+     */
+    searchProfiles(searchText: string, limit?: number): Promise<CustomerProfile[]>;
+    /**
+     * Get all high-risk profiles (high + critical)
+     *
+     * @param limit - Maximum results to return (default: 50)
+     * @returns Array of high-risk profiles
+     */
+    getHighRiskProfiles(limit?: number): Promise<CustomerProfile[]>;
+    /**
+     * Get profiles requiring PEP review
+     *
+     * @param limit - Maximum results to return (default: 50)
+     * @returns Array of PEP profiles
+     */
+    getPEPProfiles(limit?: number): Promise<CustomerProfile[]>;
+    /**
+     * Get profiles with sanctions matches
+     *
+     * @param limit - Maximum results to return (default: 50)
+     * @returns Array of sanctioned profiles
+     */
+    getSanctionedProfiles(limit?: number): Promise<CustomerProfile[]>;
+    /**
+     * Get risk dashboard metrics and statistics
+     *
+     * @param startDate - Optional start date for metrics (ISO format)
+     * @param endDate - Optional end date for metrics (ISO format)
+     * @returns Dashboard metrics
+     *
+     * @example
+     * ```typescript
+     * const metrics = await client.getDashboardMetrics();
+     * console.log('Total risky profiles:', metrics.total_risky_profiles);
+     * console.log('Critical profiles:', metrics.total_critical_profiles);
+     * console.log('Average risk score:', metrics.average_risk_score);
+     *
+     * metrics.risk_distribution.forEach(item => {
+     *   console.log(`${item.category}: ${item.count} (${item.percentage}%)`);
+     * });
+     * ```
+     */
+    getDashboardMetrics(startDate?: string, endDate?: string): Promise<RiskDashboardMetrics>;
+    /**
+     * Get or create profile (idempotent operation)
+     *
+     * Attempts to get existing profile by customer_id, creates if not found.
+     *
+     * @param customerId - Customer ID
+     * @param createRequest - Profile data to use if creating new profile
+     * @returns Existing or newly created profile
+     *
+     * @example
+     * ```typescript
+     * const profile = await client.getOrCreateProfile('CUST-123', {
+     *   customer_id: 'CUST-123',
+     *   entity_type: 'individual',
+     *   full_name: 'John Doe',
+     *   email_address: 'john@example.com'
+     * });
+     * ```
+     */
+    getOrCreateProfile(customerId: string, createRequest: CreateProfileRequest): Promise<CustomerProfile>;
+    /**
+     * Batch get profiles by customer IDs
+     *
+     * @param customerIds - Array of customer IDs
+     * @returns Array of profiles (may be less than input if some not found)
+     */
+    batchGetProfiles(customerIds: string[]): Promise<CustomerProfile[]>;
+    /**
+     * Get risk configuration for tenant
+     *
+     * Returns the risk scoring weights and thresholds configured for the tenant.
+     *
+     * @returns Risk configuration
+     */
+    getRiskConfiguration(): Promise<RiskConfiguration>;
+    /**
+     * Update risk configuration for tenant
+     *
+     * Updates risk scoring weights and/or thresholds.
+     *
+     * @param config - Configuration updates
+     * @returns Updated risk configuration
+     */
+    updateRiskConfiguration(config: Partial<RiskConfiguration>): Promise<RiskConfiguration>;
+}
+
+export { CreateProfileRequest, CustomerProfile, ProfileDetailsResponse, ProfileFilters, ProfileListResponse, RiskConfiguration, RiskDashboardMetrics, RiskProfileClient, UpdateProfileRequest };