declare enum Entity { USER_NAME = "USER_NAME", USER_PASSWORD = "USER_PASSWORD", OAUTH_SECRET_NAME = "OAUTH_SECRET_NAME", ORGANIZATION_NAME = "ORGANIZATION_NAME", USER_ORGANIZATION_NAME = "USER_ORGANIZATION_NAME", TEAM_NAME = "TEAM_NAME", COMPANY_NAME = "COMPANY_NAME", PAT_NAME = "PAT_NAME", JOIN_TOKEN_NAME = "JOIN_TOKEN_NAME", SPACE_NAME = "SPACE_NAME", EVENT_NAME = "EVENT_NAME", STREAM_NAME = "STREAM_NAME", DESIGN_NAME = "DESIGN_NAME", SNAPSHOT_NAME = "SNAPSHOT_NAME", WEBHOOK_NAME = "WEBHOOK_NAME", SECRET_KEY = "SECRET_KEY", SECRET_VALUE = "SECRET_VALUE", POOL_NAME = "POOL_NAME", WAVE_ENGINE_RELEASE = "WAVE_ENGINE_RELEASE", CHALLENGE_STRING = "CHALLENGE_STRING", DATABASE_NAME = "DATABASE_NAME", DATABASE_API_KEY = "DATABASE_API_KEY", DOCUMENT_KEY = "DOCUMENT_KEY", DOMAIN_NAME = "DOMAIN_NAME", USER_ID = "USER_ID", INVITATION_ID = "INVITATION_ID", OAUTH_APP_ID = "OAUTH_APP_ID", PAT_ID = "PAT_ID", STREAM_ID = "STREAM_ID", EXECUTION_SECRET = "EXECUTION_SECRET", HIGH5_EXECUTION_ID = "HIGH5_EXECUTION_ID", STREAM_LOG_ID = "STREAM_LOG_ID", STREAM_STATUS_ID = "STREAM_STATUS_ID", JOIN_TOKEN_ID = "JOIN_TOKEN_ID", NODE_ID = "NODE_ID", SNAPSHOT_ID = "SNAPSHOT_ID", CATALOG_ID = "CATALOG_ID", WEBHOOK_ID = "WEBHOOK_ID", WEBHOOK_TOKEN = "WEBHOOK_TOKEN", JOB = "JOB", JOB_ID = "JOB_ID", JOB_LOG_ID = "JOB_LOG_ID", NAMESPACE_NAME = "NAMESPACE_NAME", MESSAGE_ID = "MESSAGE_ID", ARRAY_INDEX = "ARRAY_INDEX", URL_SLUG = "URL_SLUG", LONG_URL_SLUG = "LONG_URL_SLUG", TAG_NAME = "TAG_NAME", TAG_COLOR = "TAG_COLOR", MODULE_NAME = "MODULE_NAME", LOG_COLLECTOR_NAME = "LOG_COLLECTOR_NAME" } declare class EntityDetails { private entity; constructor(name: Entity); get pattern(): RegExp; get minLength(): number; get maxLength(): number; /** * Checks whether the specified value can be used as name of the Current Entity, * the length of the string is additionally checking because these details may not be specified in the regular expression. * @param value - Some string to validate * @returns Validation result */ validate(value: string): boolean; /** * This function cleans the given string from disallowed characters, removes extra dashes, dots, and spaces at the beginning and end of the string. * The list of allowed characters is determined automatically based on the given regular expression for name validation (property "pattern"), * but for special cases, it can be set manually in the property "symbols" in the entity name definition. * @param value - Incoming string to sanitize * @returns Sanitized string */ sanitize(value: string, delimiter?: string): string; } declare function ValidationHelper(name: Entity): EntityDetails; export { Entity, EntityDetails, ValidationHelper };