-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Interface for antigate.com captcha recognition service.
--   
--   Interface for antigate.com captcha recognition service.
@package antigate
@version 0.0.1

module Text.Recognition.Antigate
type AntigateKey = String
type CaptchaID = Int

-- | See <a>http://antigate.com/panel.php?action=api</a>
data CaptchaConf
CaptchaConf :: Bool -> Bool -> Maybe Bool -> Bool -> Word -> Word -> Bool -> Maybe Double -> CaptchaConf

-- | <ul>
--   <li><a>False</a> = default value (one word)</li>
--   <li><a>True</a> = captcha has 2-4 words</li>
--   </ul>
phrase :: CaptchaConf -> Bool

-- | <ul>
--   <li><a>False</a> = default value (case is not important)</li>
--   <li><a>True</a> = captcha is case sensitive</li>
--   </ul>
regsense :: CaptchaConf -> Bool

-- | <ul>
--   <li><a>Nothing</a> = default value</li>
--   <li><a>Just</a> <a>True</a> = captcha consists from numbers only</li>
--   <li><a>Just</a> <a>False</a> = captcha does not have numbers on
--   it</li>
--   </ul>
numeric :: CaptchaConf -> Maybe Bool

-- | <ul>
--   <li><a>False</a> = default value</li>
--   <li><a>True</a> = numbers on captcha must be summed</li>
--   </ul>
calc :: CaptchaConf -> Bool

-- | <ul>
--   <li>0 = default value</li>
--   <li>&gt;0 = minimum length of captcha text workers required to
--   input</li>
--   </ul>
min_len :: CaptchaConf -> Word

-- | <ul>
--   <li>0 = default value (unlimited)</li>
--   <li>&gt;0 = maximum length of captcha text workers required to
--   input</li>
--   </ul>
max_len :: CaptchaConf -> Word

-- | <ul>
--   <li><a>False</a> = default value</li>
--   <li><a>True</a> = captcha goes to Russian-speaking worker</li>
--   </ul>
is_russian :: CaptchaConf -> Bool

-- | <a>Default</a> value is set on bids page. This parameter allows to
--   control maximum bid without setting it on the bids page.
max_bid :: CaptchaConf -> Maybe Double
data UploadResult

-- | result is positive, your captcha is accepted for recognition and its
--   ID follows. You may now attempt to retrieve captcha status with this
--   ID.
UPLOAD_OK :: CaptchaID -> UploadResult

-- | user authorization key is invalid (its length is not 32 bytes as it
--   should be)
ERROR_WRONG_USER_KEY :: UploadResult

-- | you have set wrong user authorization key in request
UPLOAD_ERROR_KEY_DOES_NOT_EXIST :: UploadResult

-- | account has zero or negative balance
ERROR_ZERO_BALANCE :: UploadResult

-- | no idle captcha workers are available at the moment, please try a bit
--   later or try increasing your bid
ERROR_NO_SLOT_AVAILABLE :: UploadResult

-- | the size of the captcha you are uploading or pointing to is zero
ERROR_ZERO_CAPTCHA_FILESIZE :: UploadResult

-- | your captcha size is exceeding 100kb limit
ERROR_TOO_BIG_CAPTCHA_FILESIZE :: UploadResult

-- | your captcha file has wrong extension, the only allowed extensions are
--   gif,jpg,jpeg,png
ERROR_WRONG_FILE_EXTENSION :: UploadResult

-- | Could not determine captcha file type, only allowed formats are JPG,
--   GIF, PNG
ERROR_IMAGE_TYPE_NOT_SUPPORTED :: UploadResult

-- | Request with current account key is not allowed from your IP. Please
--   refer to IP list section
ERROR_IP_NOT_ALLOWED :: UploadResult
UPLOAD_ERROR_UNKNOWN :: String -> UploadResult
data CheckResult

-- | the captcha is recognized, the guessed text follows
CHECK_OK :: String -> CheckResult

-- | captcha is not recognized yet, repeat request withing 1-5 seconds
CAPCHA_NOT_READY :: CheckResult

-- | you have set wrong user authorization key in request
CHECK_ERROR_KEY_DOES_NOT_EXIST :: CheckResult

-- | the captcha ID you are sending is non-numeric
ERROR_WRONG_ID_FORMAT :: CheckResult
CHECK_ERROR_UNKNOWN :: String -> CheckResult
data SolveException
SolveExceptionUpload :: UploadResult -> SolveException
SolveExceptionCheck :: CaptchaID -> CheckResult -> SolveException

-- | High level function to solve captcha, blocks until answer is provided
--   (about 2-10 seconds).
--   
--   throws <a>SolveException</a> or <a>HttpException</a> when something
--   goes wrong.
solveCaptcha :: Int -> Int -> AntigateKey -> CaptchaConf -> FilePath -> ByteString -> IO (CaptchaID, String)

-- | Same as <a>solveCaptcha</a>, but read contents from a file.
solveCaptchaFromFile :: Int -> Int -> AntigateKey -> CaptchaConf -> FilePath -> IO (CaptchaID, String)

-- | upload captcha for recognition
--   
--   throws <a>HttpException</a> on network errors.
uploadCaptcha :: AntigateKey -> CaptchaConf -> FilePath -> ByteString -> IO UploadResult

-- | retrieve captcha status
--   
--   throws <a>HttpException</a> on network errors.
checkCaptcha :: AntigateKey -> CaptchaID -> IO CheckResult

-- | retrieve multiple captcha status
--   
--   throws <a>HttpException</a> on network errors.
checkCaptchas :: AntigateKey -> [CaptchaID] -> IO [CheckResult]

-- | report bad captcha result
--   
--   throws <a>HttpException</a> on network errors.
reportBad :: AntigateKey -> CaptchaID -> IO ()

-- | retrieve your current account balance
--   
--   throws <a>HttpException</a> on network errors.
getBalance :: AntigateKey -> IO Double

-- | Parse antigate's upload response
parseUploadResult :: String -> UploadResult

-- | Parse antigate's check response
parseCheckResult :: String -> CheckResult

-- | Parse antigate's multi-check response
parseCheckResults :: String -> [CheckResult]

-- | Parse antigate's multi-check response
parseCheckResultNoOK :: String -> CheckResult

-- | Marshal <a>UploadResult</a> back to its text form
renderUploadResult :: UploadResult -> String

-- | Marshal <a>CheckResult</a> back to its text form
renderCheckResult :: CheckResult -> String
instance Typeable SolveException
instance Show CaptchaConf
instance Read CaptchaConf
instance Show UploadResult
instance Read UploadResult
instance Eq UploadResult
instance Ord UploadResult
instance Show CheckResult
instance Read CheckResult
instance Eq CheckResult
instance Ord CheckResult
instance Show Field
instance Show SolveException
instance Exception SolveException
instance Default CaptchaConf