suitecrm-mcp-server
Version:
Model Context Protocol server for SuiteCRM integration with natural language SQL reporting
51 lines • 1.53 kB
TypeScript
/**
* Module management service for SuiteCRM
*/
import { ModuleInfo, ModuleSchema } from '../types';
export declare class ModuleService {
private httpClient;
private schemaCache;
private readonly cacheTtl;
constructor(baseUrl: string, timeout?: number);
/**
* Get available modules from SuiteCRM
*/
getModules(accessToken: string): Promise<ModuleInfo[]>;
/**
* Get detailed schema for a specific module
*/
getModuleSchema(accessToken: string, moduleName: string): Promise<ModuleSchema>;
/**
* Get multiple module schemas at once
*/
getModuleSchemas(accessToken: string, moduleNames: string[]): Promise<Record<string, ModuleSchema>>;
/**
* Get field information for a specific module
*/
getModuleFields(accessToken: string, moduleName: string): Promise<ModuleSchema['fields']>;
/**
* Get relationship information for a specific module
*/
getModuleRelationships(accessToken: string, moduleName: string): Promise<ModuleSchema['relationships']>;
/**
* Check if a module exists
*/
moduleExists(accessToken: string, moduleName: string): Promise<boolean>;
/**
* Get cache statistics
*/
getCacheStats(): {
total: number;
expired: number;
valid: number;
};
/**
* Clear schema cache
*/
clearCache(): void;
/**
* Clear cache for specific module
*/
clearModuleCache(moduleName: string): void;
}
//# sourceMappingURL=modules.d.ts.map