ci-validation
Version:
🇺🇾 Complete TypeScript/JavaScript library for validating Uruguayan CI (Cédula de Identidad) with official algorithm and government service integration
57 lines • 1.8 kB
TypeScript
export interface ForumRequest {
ci: string;
}
export interface ForumMember {
ci: string;
idCliente: string;
status: "active" | "no_points" | "not_registered";
executionTime: number;
}
export interface ForumPoints {
available: number;
minimumExchange: number;
}
export interface ForumResponse {
success: boolean;
hasUser: boolean;
member?: ForumMember;
points?: ForumPoints;
error?: string;
}
export declare class ForumService {
private readonly baseUrl;
private readonly headers;
/**
* Check member status and points in Forum loyalty program
* @param request - Object containing the CI
* @returns Promise with Forum response data
*/
checkMember(request: ForumRequest): Promise<ForumResponse>;
/**
* Parse the raw API response into our standardized format
* @param apiResponse - Raw response from Forum API
* @param ci - The CI number that was queried
* @param executionTime - Time taken for the request
* @returns Parsed ForumResponse
*/
private parseResponse;
/**
* Check if user exists in the Forum system
* @param request - Object containing the CI
* @returns Promise with boolean indicating if user exists
*/
hasUser(request: ForumRequest): Promise<boolean>;
/**
* Get user points if available
* @param request - Object containing the CI
* @returns Promise with points or null if not available
*/
getPoints(request: ForumRequest): Promise<number | null>;
/**
* Get member information
* @param request - Object containing the CI
* @returns Promise with member data or null if not found
*/
getMember(request: ForumRequest): Promise<ForumMember | null>;
}
//# sourceMappingURL=Forum.d.ts.map