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


-- | Haskell package for easy integration with the 2captcha API.
--   
--   Haskell package for easy integration with the 2captcha API.
--   
--   Feature list:
--   
--   <ul>
--   <li>Lens-based API</li>
--   <li>Uses Wreq for http calls</li>
--   </ul>
@package 2captcha
@version 0.1.0.0

module TwoCaptcha.Internal.Types.Captcha

-- | The id of a captcha being solved.
type CaptchaId = Text

-- | Time in milliseconds in how often to request the answer.
type PollingInterval = Int

-- | Time in milliseconds on when to timeout if the request takes too long.
type TimeoutDuration = Integer

-- | Default captcha timeout duration (120 seconds).
captchaTimeout :: TimeoutDuration

-- | Default polling interval (10 seconds).
pollingInterval :: PollingInterval

-- | Represents the request information required to solve a captcha.
data Captcha
MkCaptcha :: Options -> [(Text, Text)] -> [(Text, FilePath)] -> Captcha
[_options] :: Captcha -> Options
[_partTexts] :: Captcha -> [(Text, Text)]
[_partFiles] :: Captcha -> [(Text, FilePath)]
partTexts :: Lens' Captcha [(Text, Text)]
partFiles :: Lens' Captcha [(Text, FilePath)]
options :: Lens' Captcha Options

-- | Convert the captcha's multipart form parameters into a [<a>Part</a>].
parts :: Getter Captcha [Part]

-- | Default parameters for solving a captcha. Internal use only.
defaultCaptcha :: Captcha

-- | Create a lens using the given field name for multipart forms.
mkPartLens :: (Coercible Captcha a, IsString s) => Lens' Captcha [(Text, s)] -> Text -> Lens' a (Maybe s)

-- | Create a lens using the given field name for multipart form texts.
mkPartTextLens :: Coercible Captcha a => Text -> Lens' a (Maybe Text)

-- | Create a lens using the given field name for multipart form files.
mkPartFileLens :: Coercible Captcha a => Text -> Lens' a (Maybe FilePath)

-- | Creates a lens using the given field name for query parameters.
mkParamLens :: Coercible Captcha a => Text -> Lens' a (Maybe Text)

-- | Create a lens using the given field name for type <b>b</b> with a
--   <a>Show</a> and <a>Read</a> instance.
--   
--   GOTCHA: Bool values translate to <a>True</a> or <a>False</a>. Use
--   <tt>mkLensBool</tt> instead for bool lenses.
mkParamLens' :: (Coercible Captcha a, Show b, Read b) => Text -> Lens' a (Maybe b)

-- | Create a lens using the given field name for bools.
--   
--   The boolean values become:
--   
--   <ul>
--   <li><a>True</a> - 1</li>
--   <li><a>False</a> - 0</li>
--   </ul>
mkParamLensBool :: Coercible Captcha a => Text -> Lens' a (Maybe Bool)

-- | Lenses for constructing options for <a>submit</a>.
class Coercible Captcha a => HasCaptchaLenses a

-- | Software developer id. Developers who integrate their software with
--   2captcha earn 10% of the user's spendings.
softId :: HasCaptchaLenses a => Lens' a (Maybe Int)

-- | URL for <a>pingback</a> (callback) response that will be sent the
--   answer to when the captcha is solved.
pingback :: HasCaptchaLenses a => Lens' a (Maybe Text)

-- | Type of captcha to solve.
method :: HasCaptchaLenses a => Lens' a (Maybe Text)

-- | Lenses for constructing options for <a>submit</a> and <a>answer</a>.
class Coercible Captcha a => HasCommonCaptchaLenses a

-- | Your 2captcha API <a>key</a>.
apiKey :: HasCommonCaptchaLenses a => Lens' a (Maybe Text)

-- | If True, <a>submit</a> will include the
--   <b>Access-Control-Allow-Origin:*</b> header in the response. Used for
--   cross-domain AJAX requests in web applications.
headerACAO :: HasCommonCaptchaLenses a => Lens' a (Maybe Bool)

-- | Parameters used to retrieve the <a>answer</a> of a solved captcha.
newtype CaptchaRes
CaptchaRes :: Captcha -> CaptchaRes

-- | Parameters for retrieving a captcha's answer.
--   
--   Required parameters:
--   
--   <ul>
--   <li><a>apiKey</a></li>
--   <li><a>captchaId</a></li>
--   </ul>
--   
--   Optional parameters:
--   
--   <ul>
--   <li><a>headerACAO</a></li>
--   </ul>
captchaRes :: CaptchaRes

-- | The captcha id returned from <a>submit</a>.
captchaId :: Lens' CaptchaRes (Maybe Text)
class Coercible Captcha a => HasPageURL a

-- | Full URL of the page where the captcha is found.
pageUrl :: HasPageURL a => Lens' a (Maybe Text)
class Coercible Captcha a => HasProxy a

-- | Proxy to be sent to the worker who solves the captcha. You can read
--   more about proxies <a>here</a>.
--   
--   Format must be in <b>login:password@123.123.123.123:3128</b> .
proxy :: HasProxy a => Lens' a (Maybe Text)

-- | Type of your proxy: <b>HTTP</b>, <b>HTTPS</b>, <b>SOCKS4</b>,
--   <b>SOCKS5</b>.
proxyType :: HasProxy a => Lens' a (Maybe Text)
class Coercible Captcha a => HasLocalImage a

-- | File path of a captcha image.
file :: HasLocalImage a => Lens' a (Maybe FilePath)

-- | Base-64 encoded image.
body :: HasLocalImage a => Lens' a (Maybe Text)

-- | Text which is shown to the worker to help solve a captcha.
textInstructions :: HasLocalImage a => Lens' a (Maybe Text)

-- | Image file path with instructions on solving a captcha.
imgInstructions :: HasLocalImage a => Lens' a (Maybe FilePath)
class Coercible Captcha a => HasLanguage a

-- | The captcha's language:
--   
--   <ol>
--   <li>Not specified.</li>
--   <li>Cyrillic captcha.</li>
--   <li>Latin captcha.</li>
--   </ol>
language :: HasLanguage a => Lens' a (Maybe Int)

-- | The captcha's language code. Click <a>here</a> for a list of supported
--   languages.
languageCode :: HasLanguage a => Lens' a (Maybe Text)
class Coercible Captcha a => HasUserAgent a

-- | User agent that will be used by the worker when solving the captcha.
userAgent :: HasUserAgent a => Lens' a (Maybe Text)
class Coercible Captcha a => HasCookies a

-- | Cookies that will be used by the worker solving the captcha. The used
--   cookies will also be included in the response.
--   
--   Format: <b>KEY1:Value1;KEY2:Value2;</b>
cookies :: HasCookies a => Lens' a (Maybe Text)
instance GHC.Show.Show TwoCaptcha.Internal.Types.Captcha.CaptchaRes
instance TwoCaptcha.Internal.Types.Captcha.HasCommonCaptchaLenses TwoCaptcha.Internal.Types.Captcha.CaptchaRes
instance TwoCaptcha.Internal.Types.Captcha.HasCommonCaptchaLenses TwoCaptcha.Internal.Types.Captcha.Captcha
instance TwoCaptcha.Internal.Types.Captcha.HasCaptchaLenses TwoCaptcha.Internal.Types.Captcha.Captcha
instance GHC.Show.Show TwoCaptcha.Internal.Types.Captcha.Captcha

module TwoCaptcha.Internal.Types.CapyCaptcha

-- | Parameters used to solve a capy puzzle captcha.
newtype CapyCaptcha
MkCapyCaptcha :: Captcha -> CapyCaptcha

-- | Parameters used to solve a capy puzzle captcha.
--   
--   Required parameters:
--   
--   <ul>
--   <li><a>apiKey</a></li>
--   <li><a>captchaKey</a></li>
--   <li><a>scriptDomain</a></li>
--   <li><a>pageUrl</a></li>
--   </ul>
--   
--   Optional parameters:
--   
--   <ul>
--   <li><a>scriptDomain</a></li>
--   <li><a>headerACAO</a></li>
--   <li><a>pingback</a></li>
--   <li><a>softId</a></li>
--   <li><a>proxy</a></li>
--   <li><a>proxyType</a></li>
--   </ul>
capyCaptcha :: CapyCaptcha

-- | Value of <b>captchakey</b> parameter you found on page.
captchaKey :: Lens' CapyCaptcha (Maybe Text)

-- | The domain part of the script URL found on page.
--   
--   If not specified, defaults to: <a>https://jp.api.capy.me/</a>
scriptDomain :: Lens' CapyCaptcha (Maybe Text)
instance GHC.Show.Show TwoCaptcha.Internal.Types.CapyCaptcha.CapyCaptcha
instance TwoCaptcha.Internal.Types.Captcha.HasCommonCaptchaLenses TwoCaptcha.Internal.Types.CapyCaptcha.CapyCaptcha
instance TwoCaptcha.Internal.Types.Captcha.HasCaptchaLenses TwoCaptcha.Internal.Types.CapyCaptcha.CapyCaptcha
instance TwoCaptcha.Internal.Types.Captcha.HasPageURL TwoCaptcha.Internal.Types.CapyCaptcha.CapyCaptcha
instance TwoCaptcha.Internal.Types.Captcha.HasProxy TwoCaptcha.Internal.Types.CapyCaptcha.CapyCaptcha

module TwoCaptcha.Internal.Types.CoordinateCaptcha

-- | Parameters used to solve a coordinate captcha.
newtype CoordinateCaptcha
MkCoordinateCaptcha :: Captcha -> CoordinateCaptcha

-- | Parameters used to solve a coordinate captcha.
--   
--   Required parameters:
--   
--   <ul>
--   <li><a>apiKey</a></li>
--   <li><a>method</a></li>
--   <li><a>coordinateReCAPTCHAImage</a></li>
--   <li><a>file</a>*</li>
--   <li><a>body</a>*</li>
--   </ul>
--   
--   Optional parameters:
--   
--   <ul>
--   <li><a>textInstructions</a></li>
--   <li><a>imgInstructions</a></li>
--   <li><a>language</a></li>
--   <li><a>languageCode</a></li>
--   <li><a>headerACAO</a></li>
--   <li><a>pingback</a></li>
--   <li><a>softId</a></li>
--   </ul>
--   
--   Possible <a>method</a> values:
--   
--   <ul>
--   <li><b>post</b> - defines that you're sending an image with multipart
--   form</li>
--   <li><b>base64</b> - defines that you're sending a base64 encoded
--   image</li>
--   </ul>
--   
--   Starred required parameter rules:
--   
--   <ul>
--   <li><b>file</b> is only required if <b>captcha = "post"</b></li>
--   <li><b>body</b> is only required if <b>captcha = "base64"</b></li>
--   </ul>
coordinateCaptcha :: CoordinateCaptcha

-- | Defines that you're sending a reCAPTCHA as an image.
coordinateReCAPTCHAImage :: Lens' CoordinateCaptcha (Maybe Bool)
instance GHC.Show.Show TwoCaptcha.Internal.Types.CoordinateCaptcha.CoordinateCaptcha
instance TwoCaptcha.Internal.Types.Captcha.HasCommonCaptchaLenses TwoCaptcha.Internal.Types.CoordinateCaptcha.CoordinateCaptcha
instance TwoCaptcha.Internal.Types.Captcha.HasCaptchaLenses TwoCaptcha.Internal.Types.CoordinateCaptcha.CoordinateCaptcha
instance TwoCaptcha.Internal.Types.Captcha.HasLocalImage TwoCaptcha.Internal.Types.CoordinateCaptcha.CoordinateCaptcha
instance TwoCaptcha.Internal.Types.Captcha.HasLanguage TwoCaptcha.Internal.Types.CoordinateCaptcha.CoordinateCaptcha

module TwoCaptcha.Internal.Types.Exception

-- | Represents a possible exception when interacting with the 2captcha
--   API.
data TwoCaptchaException

-- | An error documented on 2captcha's website.
TwoCaptchaResponseException :: TwoCaptchaErrorCode -> TwoCaptchaException

-- | A non-200 status code was thrown. This should only appear in rare
--   cases.
NetworkException :: HttpException -> TwoCaptchaException

-- | An unknown error occured, likely due to a change in the 2captcha API.
UnknownError :: Text -> TwoCaptchaException

-- | Solving the captcha took too long. Try setting a higher timeout
--   duration?
SolvingTimeout :: TwoCaptchaException

-- | Possible errors when using the 2captcha API.
data TwoCaptchaErrorCode

-- | The api key you provided is invalid. Please ensure it is 32 characters
--   long.
WrongUserKey :: TwoCaptchaErrorCode

-- | The key you've provided does not exist.
KeyDoesNotExist :: TwoCaptchaErrorCode

-- | You don't have funds in your account.
ZeroBalance :: TwoCaptchaErrorCode

-- | The <b>pageurl</b> parameter is missing in your request.
PageUrlMissing :: TwoCaptchaErrorCode

-- | You can receive this error in two cases:
--   
--   <ol>
--   <li><b>If you solve token-based captchas (reCAPTCHA, hCaptcha,
--   ArkoseLabs FunCaptcha, GeeTest, etc):</b> the queue of your captchas
--   that are not distributed to workers is too long. Queue limit changes
--   dynamically and depends on total amount of captchas awaiting solution
--   and usually it’s between 50 and 100 captchas.</li>
--   <li><b>If you solve Normal Captcha:</b> your maximum rate for normal
--   captchas is lower than current rate on the server. You can change your
--   maximum rate in <a>your account's settings.</a></li>
--   </ol>
NoSlotAvailable :: TwoCaptchaErrorCode

-- | Image size is less than 100 bytes.
ZeroCaptchaFileSize :: TwoCaptchaErrorCode

-- | Image size is more than 100 kB.
TooBigCaptchaFileSize :: TwoCaptchaErrorCode

-- | Image file has unsupported extension. Accepted extensions: jpg, jpeg,
--   gif, png.
WrongFileExtension :: TwoCaptchaErrorCode

-- | Server can't recognize image file type.
ImageTypeNotSupported :: TwoCaptchaErrorCode

-- | Server can't get file data from your POST-request. That happens if
--   your POST-request is malformed or base64 data is not a valid base64
--   image.
UploadFailure :: TwoCaptchaErrorCode

-- | The request is sent from the IP that is not on the list of your
--   allowed IPs.
IpNotAllowed :: TwoCaptchaErrorCode

-- | Your IP address is banned due to many frequent attempts to access the
--   server using wrong authorization keys.
IpBanned :: TwoCaptchaErrorCode

-- | You can get this error code when sending reCAPTCHA V2. This happens if
--   your request contains invalid pair of googlekey and pageurl. The
--   common reason for that is that reCAPTCHA is loaded inside an iframe
--   hosted on another domain/subdomain.
BadTokenOrPageUrl :: TwoCaptchaErrorCode

-- | You can get this error code when sending reCAPTCHA V2. That means that
--   sitekey value provided in your request is incorrect: it's blank or
--   malformed.
GoogleKeyInvalid :: TwoCaptchaErrorCode

-- | The <b>googlekey</b> parameter is missing in your request.
GoogleKeyMissing :: TwoCaptchaErrorCode

-- | You've sent an image that is marked in 2captcha's database as
--   unrecognizable. Usually that happens if the website where you found
--   the captcha stopped sending you captchas and started to send a "deny
--   access" image.
CaptchaImageBlocked :: TwoCaptchaErrorCode

-- | You are sending too many unrecognizable images.
TooManyBadImages :: TwoCaptchaErrorCode

-- | You made more than 60 requests to in.php within 3 seconds. Your
--   account is banned for 10 seconds. Ban will be lifted automatically.
RateLimited :: TwoCaptchaErrorCode

-- | You received the error <a>NoSlotAvailable</a> 120 times in one minute
--   because your current bid is lower than current bid on the server.
--   
--   Blocking time: 10 minutes.
Error1001 :: TwoCaptchaErrorCode

-- | You received the error <a>ZeroBalance</a> 120 times in one minute
--   because your balance is zero.
--   
--   Blocking time: 5 minutes.
Error1002 :: TwoCaptchaErrorCode

-- | You received the error <a>NoSlotAvailable</a> because you are
--   uploading many captchas and server has a long queue of your captchas
--   that are not distributed to workers. You received three times more
--   errors than amount of captchas you sent (but not less than 120
--   errors). Increase the timeout if you see this error.
--   
--   Blocking time: 30 seconds.
Error1003 :: TwoCaptchaErrorCode

-- | Your IP address is blocked because there were 5 requests with
--   incorrect API key from your IP.
Error1004 :: TwoCaptchaErrorCode

-- | You are making too many requests to res.php to get answers.
--   
--   2captcha uses the following rule to block your account: R &gt; C * 20
--   + 1200
--   
--   Where:
--   
--   <ul>
--   <li>R - the amount of your requests</li>
--   <li>C - the amount of captchas you've uploaded</li>
--   </ul>
--   
--   That means that you don't have to make more than 20 requests to
--   res.php per each captcha. Please remember that balance request sent to
--   res.php also counts!
--   
--   To get your answer faster without a risk to be blocked you can use
--   <a>pingback</a> feature and 2captcha will send you the answer when
--   your captcha is solved.
--   
--   Blocking time: 10 minutes.
Error1005 :: TwoCaptchaErrorCode

-- | The error code is returned if some required parameters are missing in
--   your request or the values have incorrect format. For example if you
--   submit <a>Grid images</a> but your request is missing an instruction
--   for workers.
--   
--   Blocking time: 5 minutes.
BadParameters :: TwoCaptchaErrorCode

-- | You can get this error code when sending a captcha via proxy server
--   which is marked as BAD by the 2captcha API.
BadProxy :: TwoCaptchaErrorCode

-- | Your captcha is not solved yet.
CaptchaNotReady :: TwoCaptchaErrorCode

-- | 2captcha was unable to solve your captcha - three of their workers
--   were unable solve it or they didn't get an answer within 90 seconds
--   (300 seconds for reCAPTCHA V2).
--   
--   You will not be charged for that request.
CaptchaUnsolvable :: TwoCaptchaErrorCode

-- | You've provided captcha ID in wrong format. The ID can contain numbers
--   only.
WrongIdFormat :: TwoCaptchaErrorCode

-- | You provided an invalid captcha id.
WrongCaptchaId :: TwoCaptchaErrorCode

-- | Error is returned when 100% accuracy feature is enabled. The error
--   means that max numbers of tries is reached but min number of matches
--   not found.
BadDuplicates :: TwoCaptchaErrorCode

-- | Error is returned to your <a>report</a> request if you already
--   complained lots of correctly solved captchas (more than 40%). Or if
--   more than 15 minutes passed after you submitted the captcha.
ReportNotRecorded :: TwoCaptchaErrorCode

-- | Error is returned to your <a>report request</a> if you are trying to
--   report the same captcha more than once.
DuplicateReport :: TwoCaptchaErrorCode

-- | You can receive this error code when registering a <a>pingback
--   (callback)</a> IP or domain.
--   
--   This happens if your request is coming from an IP address that doesn't
--   match the IP address of your pingback IP or domain.
InvalidPingbackIp :: TwoCaptchaErrorCode

-- | You can receive this error code when sending <a>GeeTest</a>. This
--   error means the <b>challenge</b> value you provided is expired.
TokenExpired :: TwoCaptchaErrorCode

-- | Action parameter is missing or no value is provided for <b>action</b>
--   parameter.
EmptyAction :: TwoCaptchaErrorCode

-- | You can get this error code if we were unable to load a captcha
--   through your proxy server. The proxy will be marked as BAD by our API
--   and we will not accept requests with the proxy during 10 minutes. You
--   will recieve ERROR_BAD_PROXY code from in.php API endpoint in such
--   case.
ProxyConnectionFailed :: TwoCaptchaErrorCode

-- | The raw error code provided by 2captcha.
errorCode :: TwoCaptchaErrorCode -> String

-- | Parser instance for parsing an error code to a
--   <a>TwoCaptchaErrorCode</a>.
errorParser :: Parser TwoCaptchaErrorCode

-- | Read an error code as its corresponding <a>TwoCaptchaErrorCode</a>.
readErrorCode :: String -> Either ParseError TwoCaptchaErrorCode
instance GHC.Classes.Eq TwoCaptcha.Internal.Types.Exception.TwoCaptchaErrorCode
instance GHC.Show.Show TwoCaptcha.Internal.Types.Exception.TwoCaptchaErrorCode
instance GHC.Show.Show TwoCaptcha.Internal.Types.Exception.TwoCaptchaException
instance GHC.Exception.Type.Exception TwoCaptcha.Internal.Types.Exception.TwoCaptchaException

module TwoCaptcha.Internal.Client

-- | Runs the given http method and adapts errors to
--   <a>TwoCaptchaException</a>.
handle :: (MonadIO m, MonadCatch m) => IO (Response ByteString) -> m Text

-- | Encapsulates the <b>in.php</b> and <b>res.php</b> endpoints for the
--   2captcha API.
class TwoCaptchaClient m

-- | Submit a captcha to be solved by the 2captcha API. Returns a captcha
--   id used for <a>answer</a>.
submit :: (TwoCaptchaClient m, Coercible Captcha a, HasCaptchaLenses a, HasCommonCaptchaLenses a) => Session -> a -> m CaptchaId

-- | Attempt to retrieve the answer of a captcha previously submitted.
answer :: TwoCaptchaClient m => Session -> CaptchaRes -> m Text

-- | Submits a captcha and polls for the answer.
solve :: (TwoCaptchaClient m, Coercible Captcha a, HasCaptchaLenses a, HasCommonCaptchaLenses a) => PollingInterval -> TimeoutDuration -> Session -> a -> m Text
instance (Control.Monad.IO.Class.MonadIO m, Control.Monad.Catch.MonadCatch m) => TwoCaptcha.Internal.Client.TwoCaptchaClient m

module TwoCaptcha.Internal.Types.FunCaptcha

-- | Parameters used to solve FunCaptcha.
newtype FunCaptcha
MkFunCaptcha :: Captcha -> FunCaptcha

-- | Parameters used to solve FunCaptcha.
--   
--   Required parameters:
--   
--   <ul>
--   <li><a>apiKey</a></li>
--   <li><a>publicKey</a></li>
--   <li><a>pageUrl</a></li>
--   </ul>
--   
--   Optional parameters:
--   
--   <ul>
--   <li><a>surl</a></li>
--   <li><a>customDataField</a></li>
--   <li><a>userAgent</a></li>
--   <li><a>headerACAO</a></li>
--   <li><a>pingback</a></li>
--   <li><a>softId</a></li>
--   <li><a>proxy</a></li>
--   <li><a>proxyType</a></li>
--   </ul>
funCaptcha :: FunCaptcha

-- | Value of <b>pk</b> or <b>data-pkey</b> found on the FunCaptcha page.
publicKey :: Lens' FunCaptcha (Maybe Text)

-- | Value of <b>surl</b> found on the FunCaptcha page.
surl :: Lens' FunCaptcha (Maybe Text)

-- | Custom data to pass to FunCaptcha.
customDataField :: Text -> Lens' FunCaptcha (Maybe Text)
instance GHC.Show.Show TwoCaptcha.Internal.Types.FunCaptcha.FunCaptcha
instance TwoCaptcha.Internal.Types.Captcha.HasCommonCaptchaLenses TwoCaptcha.Internal.Types.FunCaptcha.FunCaptcha
instance TwoCaptcha.Internal.Types.Captcha.HasCaptchaLenses TwoCaptcha.Internal.Types.FunCaptcha.FunCaptcha
instance TwoCaptcha.Internal.Types.Captcha.HasPageURL TwoCaptcha.Internal.Types.FunCaptcha.FunCaptcha
instance TwoCaptcha.Internal.Types.Captcha.HasProxy TwoCaptcha.Internal.Types.FunCaptcha.FunCaptcha

module TwoCaptcha.Internal.Types.GeeTestCaptcha

-- | Parameters used to solve a GeeTest captcha.
newtype GeeTestCaptcha
MkGeeTestCaptcha :: Captcha -> GeeTestCaptcha

-- | Parameters used to solve a GeeTest captcha.
--   
--   Required parameters:
--   
--   <ul>
--   <li><a>apiKey</a></li>
--   <li><a>gt</a></li>
--   <li><a>challenge</a></li>
--   <li><a>pageUrl</a></li>
--   </ul>
--   
--   Optional parameters:
--   
--   <ul>
--   <li><a>apiServer</a></li>
--   <li><a>userAgent</a></li>
--   <li><a>headerACAO</a></li>
--   <li><a>pingback</a></li>
--   <li><a>softId</a></li>
--   <li><a>proxy</a></li>
--   <li><a>proxyType</a></li>
--   </ul>
geeTestCaptcha :: GeeTestCaptcha

-- | Value of <b>gt</b> parameter you found on target website.
gt :: Lens' GeeTestCaptcha (Maybe Text)

-- | Value of <b>challenge</b> parameter you found on target website.
challenge :: Lens' GeeTestCaptcha (Maybe Text)

-- | Value of <b>api_server</b> parameter you found on target website.
apiServer :: Lens' GeeTestCaptcha (Maybe Text)
instance GHC.Show.Show TwoCaptcha.Internal.Types.GeeTestCaptcha.GeeTestCaptcha
instance TwoCaptcha.Internal.Types.Captcha.HasCommonCaptchaLenses TwoCaptcha.Internal.Types.GeeTestCaptcha.GeeTestCaptcha
instance TwoCaptcha.Internal.Types.Captcha.HasCaptchaLenses TwoCaptcha.Internal.Types.GeeTestCaptcha.GeeTestCaptcha
instance TwoCaptcha.Internal.Types.Captcha.HasPageURL TwoCaptcha.Internal.Types.GeeTestCaptcha.GeeTestCaptcha
instance TwoCaptcha.Internal.Types.Captcha.HasProxy TwoCaptcha.Internal.Types.GeeTestCaptcha.GeeTestCaptcha

module TwoCaptcha.Internal.Types.GridCaptcha

-- | Parameters used to solve a grid captcha.
newtype GridCaptcha
MkGridCaptcha :: Captcha -> GridCaptcha

-- | Parameters for solving a grid captcha.
--   
--   Required parameters:
--   
--   <ul>
--   <li><a>apiKey</a></li>
--   <li><a>method</a></li>
--   <li><a>reCAPTCHAImage</a></li>
--   <li><a>file</a>*</li>
--   <li><a>body</a>*</li>
--   </ul>
--   
--   Optional parameters:
--   
--   <ul>
--   <li><a>canvas</a></li>
--   <li><a>textInstructions</a></li>
--   <li><a>imgInstructions</a></li>
--   <li><a>reCAPTCHAImage</a></li>
--   <li><a>rows</a></li>
--   <li><a>columns</a></li>
--   <li><a>previousId</a></li>
--   <li><a>cannotAnswer</a></li>
--   <li><a>language</a></li>
--   <li><a>languageCode</a></li>
--   <li><a>headerACAO</a></li>
--   <li><a>pingback</a></li>
--   <li><a>softId</a></li>
--   </ul>
--   
--   Possible <a>method</a> values:
--   
--   <ul>
--   <li><b>post</b> - defines that you're sending an image with multipart
--   form</li>
--   <li><b>base64</b> - defines that you're sending a base64 encoded
--   image</li>
--   </ul>
--   
--   Starred required parameter rules:
--   
--   <ul>
--   <li><b>file</b> is only required if <b>captcha = "post"</b></li>
--   <li><b>body</b> is only required if <b>captcha = "base64"</b></li>
--   </ul>
gridCaptcha :: GridCaptcha

-- | Defines that you're sending a reCAPTCHA as an image.
reCAPTCHAImage :: Lens' GridCaptcha (Maybe Bool)

-- | Defines that you want to use a <a>canvas</a> method.
canvas :: Lens' GridCaptcha (Maybe Bool)

-- | Number of rows in reCAPTCHA grid.
rows :: Lens' GridCaptcha (Maybe Int)

-- | Number of columns in reCAPTCHA grid.
columns :: Lens' GridCaptcha (Maybe Int)

-- | Id of your previous request with the same captcha challenge.
previousId :: Lens' GridCaptcha (Maybe Text)

-- | Defines if the captcha can potentially have no images, or possibly
--   cannot be answered.
cannotAnswer :: Lens' GridCaptcha (Maybe Bool)
instance GHC.Show.Show TwoCaptcha.Internal.Types.GridCaptcha.GridCaptcha
instance TwoCaptcha.Internal.Types.Captcha.HasCommonCaptchaLenses TwoCaptcha.Internal.Types.GridCaptcha.GridCaptcha
instance TwoCaptcha.Internal.Types.Captcha.HasCaptchaLenses TwoCaptcha.Internal.Types.GridCaptcha.GridCaptcha
instance TwoCaptcha.Internal.Types.Captcha.HasLocalImage TwoCaptcha.Internal.Types.GridCaptcha.GridCaptcha
instance TwoCaptcha.Internal.Types.Captcha.HasLanguage TwoCaptcha.Internal.Types.GridCaptcha.GridCaptcha

module TwoCaptcha.Internal.Types.HCaptcha

-- | Parameters used to solve hCaptcha.
newtype HCaptcha
MkHCaptcha :: Captcha -> HCaptcha

-- | Parameters used to solve hCaptcha.
--   
--   Required parameters:
--   
--   <ul>
--   <li><a>apiKey</a></li>
--   <li><tt>sitekey</tt></li>
--   <li><a>pageUrl</a></li>
--   </ul>
--   
--   Optional parameters:
--   
--   <ul>
--   <li><a>hInvisible</a></li>
--   <li><a>customData</a></li>
--   <li><a>userAgent</a></li>
--   <li><a>headerACAO</a></li>
--   <li><a>pingback</a></li>
--   <li><a>softId</a></li>
--   <li><a>proxy</a></li>
--   <li><a>proxyType</a></li>
--   </ul>
hCaptcha :: HCaptcha

-- | Value of <b>data-sitekey</b> parameter on target website.
siteKey :: Lens' HCaptcha (Maybe Text)

-- | Defines if the captcha is invisible. Invisible hCaptchas are currently
--   a rare case.
hInvisible :: Lens' HCaptcha (Maybe Bool)

-- | Custom data that is used in some implementations of hCaptcha, mostly
--   with invisible captchas. In most cases, you see it as <b>rqdata</b>
--   inside network requests.
--   
--   <b>IMPORTANT</b>: you MUST provide <tt>userAgent</tt> if you submit
--   with <a>customData</a>. The value should match the User-Agent you use
--   when interacting with target website.
customData :: Lens' HCaptcha (Maybe Text)
instance GHC.Show.Show TwoCaptcha.Internal.Types.HCaptcha.HCaptcha
instance TwoCaptcha.Internal.Types.Captcha.HasCommonCaptchaLenses TwoCaptcha.Internal.Types.HCaptcha.HCaptcha
instance TwoCaptcha.Internal.Types.Captcha.HasCaptchaLenses TwoCaptcha.Internal.Types.HCaptcha.HCaptcha
instance TwoCaptcha.Internal.Types.Captcha.HasPageURL TwoCaptcha.Internal.Types.HCaptcha.HCaptcha
instance TwoCaptcha.Internal.Types.Captcha.HasProxy TwoCaptcha.Internal.Types.HCaptcha.HCaptcha

module TwoCaptcha.Internal.Types.KeyCaptcha

-- | Parameters used to solve KeyCaptcha.
newtype KeyCaptcha
MkKeyCaptcha :: Captcha -> KeyCaptcha

-- | Parameters used to solve a KeyCaptcha.
--   
--   Required parameters:
--   
--   <ul>
--   <li><a>apiKey</a></li>
--   <li><a>userId</a></li>
--   <li><a>sessionId</a></li>
--   <li><a>webServerSign</a></li>
--   <li><a>webServerSign2</a></li>
--   <li><a>pageUrl</a></li>
--   </ul>
--   
--   Optional parameters:
--   
--   <ul>
--   <li><a>headerACAO</a></li>
--   <li><a>pingback</a></li>
--   <li><a>softId</a></li>
--   </ul>
keyCaptcha :: KeyCaptcha

-- | Value of <b>s_s_c_user_id</b> parameter you found on page.
userId :: Lens' KeyCaptcha (Maybe Text)

-- | Value of <b>s_s_c_session_id</b> parameter you found on page.
sessionId :: Lens' KeyCaptcha (Maybe Text)

-- | Value of <b>s_s_c_web_server_sign</b> parameter you found on page.
webServerSign :: Lens' KeyCaptcha (Maybe Text)

-- | Value of <b>s_s_c_web_server_sign2</b> parameter you found on page.
webServerSign2 :: Lens' KeyCaptcha (Maybe Text)
instance GHC.Show.Show TwoCaptcha.Internal.Types.KeyCaptcha.KeyCaptcha
instance TwoCaptcha.Internal.Types.Captcha.HasCommonCaptchaLenses TwoCaptcha.Internal.Types.KeyCaptcha.KeyCaptcha
instance TwoCaptcha.Internal.Types.Captcha.HasCaptchaLenses TwoCaptcha.Internal.Types.KeyCaptcha.KeyCaptcha
instance TwoCaptcha.Internal.Types.Captcha.HasPageURL TwoCaptcha.Internal.Types.KeyCaptcha.KeyCaptcha

module TwoCaptcha.Internal.Types.NormalCaptcha

-- | Parameters used to solve a normal captcha.
newtype NormalCaptcha
MkNormalCaptcha :: Captcha -> NormalCaptcha

-- | Parameters for solving a normal captcha.
--   
--   Required parameters:
--   
--   <ul>
--   <li><a>apiKey</a></li>
--   <li><a>method</a></li>
--   <li><a>file</a>*</li>
--   <li><a>body</a>*</li>
--   </ul>
--   
--   Optional parameters:
--   
--   <ul>
--   <li><a>phrase</a></li>
--   <li><a>caseSensitive</a></li>
--   <li><a>format</a></li>
--   <li><a>calc</a></li>
--   <li><a>minLength</a></li>
--   <li><a>maxLength</a></li>
--   <li><a>language</a></li>
--   <li><a>languageCode</a></li>
--   <li><a>textInstructions</a></li>
--   <li><a>imgInstructions</a></li>
--   <li><a>headerACAO</a></li>
--   <li><a>pingback</a></li>
--   <li><a>softId</a></li>
--   </ul>
--   
--   Possible <a>method</a> values:
--   
--   <ul>
--   <li><b>post</b> - defines that you're sending an image with multipart
--   form</li>
--   <li><b>base64</b> - defines that you're sending a base64 encoded
--   image</li>
--   </ul>
--   
--   Starred required parameter rules:
--   
--   <ul>
--   <li><b>file</b> is only required if <b>captcha = "post"</b></li>
--   <li><b>body</b> is only required if <b>captcha = "base64"</b></li>
--   </ul>
normalCaptcha :: NormalCaptcha

-- | Defines if the captcha is a phrase.
--   
--   <ul>
--   <li>True - Captcha contains two or more words.</li>
--   <li>False - Captcha contains one word.</li>
--   </ul>
phrase :: Lens' NormalCaptcha (Maybe Bool)

-- | Defines if the captcha is case sensitive.
caseSensitive :: Lens' NormalCaptcha (Maybe Bool)

-- | The captcha's format:
--   
--   <ol>
--   <li>Not specified.</li>
--   <li>Captcha contains only numbers.</li>
--   <li>Captcha contains only letters.</li>
--   <li>Captcha contains only numbers OR only letters.</li>
--   <li>Captcha contains both numbers AND letters.</li>
--   </ol>
format :: Lens' NormalCaptcha (Maybe Int)

-- | Define if the captcha requires calculation (e.g. 1 + 1 = ?).
calc :: Lens' NormalCaptcha (Maybe Bool)

-- | The minimum number of symbols in the captcha (up to 20).
minLength :: Lens' NormalCaptcha (Maybe Int)

-- | The maximum numbers of symbols in the captcha (up to 20).
maxLength :: Lens' NormalCaptcha (Maybe Int)
instance GHC.Show.Show TwoCaptcha.Internal.Types.NormalCaptcha.NormalCaptcha
instance TwoCaptcha.Internal.Types.Captcha.HasCommonCaptchaLenses TwoCaptcha.Internal.Types.NormalCaptcha.NormalCaptcha
instance TwoCaptcha.Internal.Types.Captcha.HasCaptchaLenses TwoCaptcha.Internal.Types.NormalCaptcha.NormalCaptcha
instance TwoCaptcha.Internal.Types.Captcha.HasLocalImage TwoCaptcha.Internal.Types.NormalCaptcha.NormalCaptcha
instance TwoCaptcha.Internal.Types.Captcha.HasLanguage TwoCaptcha.Internal.Types.NormalCaptcha.NormalCaptcha

module TwoCaptcha.Internal.Types.ReCaptcha

-- | Default parameters for solving a recaptcha. Internal use only.
defaultReCAPTCHA :: Captcha

-- | Lenses for constructing ReCaptcha options.
class Coercible Captcha a => HasReCaptchaLenses a

-- | Defines if your ReCaptcha is enterprise.
enterprise :: HasReCaptchaLenses a => Lens' a (Maybe Bool)

-- | If using <a>ReCaptchaV2</a>, this is the value of <b>k</b> or
--   <b>data-sitekey</b> found on the captcha page.
--   
--   If using <a>ReCaptchaV3</a>, this is the value of <b>sitekey</b> found
--   on the captcha page.
googleKey :: HasReCaptchaLenses a => Lens' a (Maybe Text)

-- | Domain used to load the captcha: <b>google.com</b> or
--   <b>recaptcha.net</b>.
domain :: HasReCaptchaLenses a => Lens' a (Maybe Text)

-- | Parameters used to solve reCAPTCHA V2.
newtype ReCaptchaV2
MkReCaptchaV2 :: Captcha -> ReCaptchaV2

-- | Parameters used to solve reCAPTCHA V2.
--   
--   Required parameters:
--   
--   <ul>
--   <li><a>apiKey</a></li>
--   <li><a>googleKey</a></li>
--   <li><a>pageUrl</a></li>
--   </ul>
--   
--   Optional parameters:
--   
--   <ul>
--   <li><a>enterprise</a></li>
--   <li><a>domain</a></li>
--   <li><a>invisible</a></li>
--   <li><a>dataS</a></li>
--   <li><a>cookies</a></li>
--   <li><a>userAgent</a></li>
--   <li><a>headerACAO</a></li>
--   <li><a>pingback</a></li>
--   <li><a>softId</a></li>
--   <li><a>proxy</a></li>
--   <li><a>proxyType</a></li>
--   </ul>
reCAPTCHAV2 :: ReCaptchaV2

-- | Defines if the reCAPTCHA v2 is invisible.
invisible :: Lens' ReCaptchaV2 (Maybe Bool)

-- | Value of the <b>data-s</b> parameter found on the reCAPTCHA page.
--   Currently applicable for google services.
dataS :: Lens' ReCaptchaV2 (Maybe Text)

-- | Parameters used to solve reCAPTCHA V3.
newtype ReCaptchaV3
MkReCaptchaV3 :: Captcha -> ReCaptchaV3

-- | Parameters used to solve reCAPTCHA V3.
--   
--   Required parameters:
--   
--   <ul>
--   <li><a>apiKey</a></li>
--   <li><a>googleKey</a></li>
--   <li><a>pageUrl</a></li>
--   </ul>
--   
--   Optional parameters:
--   
--   <ul>
--   <li><a>enterprise</a></li>
--   <li><a>domain</a></li>
--   <li><a>minScore</a></li>
--   <li><a>headerACAO</a></li>
--   <li><a>pingback</a></li>
--   <li><a>softId</a></li>
--   <li><a>proxy</a></li>
--   <li><a>proxyType</a></li>
--   </ul>
reCAPTCHAV3 :: ReCaptchaV3

-- | The score needed for resolution. Currently it's almost impossible to
--   get a token with a score higher than 0.3
minScore :: Lens' ReCaptchaV3 (Maybe Double)

-- | Default reCAPTCHA timeout duration (600 seconds).
reCAPTCHATimeout :: TimeoutDuration
instance GHC.Show.Show TwoCaptcha.Internal.Types.ReCaptcha.ReCaptchaV2
instance GHC.Show.Show TwoCaptcha.Internal.Types.ReCaptcha.ReCaptchaV3
instance TwoCaptcha.Internal.Types.Captcha.HasCommonCaptchaLenses TwoCaptcha.Internal.Types.ReCaptcha.ReCaptchaV3
instance TwoCaptcha.Internal.Types.Captcha.HasCaptchaLenses TwoCaptcha.Internal.Types.ReCaptcha.ReCaptchaV3
instance TwoCaptcha.Internal.Types.ReCaptcha.HasReCaptchaLenses TwoCaptcha.Internal.Types.ReCaptcha.ReCaptchaV3
instance TwoCaptcha.Internal.Types.Captcha.HasPageURL TwoCaptcha.Internal.Types.ReCaptcha.ReCaptchaV3
instance TwoCaptcha.Internal.Types.Captcha.HasCommonCaptchaLenses TwoCaptcha.Internal.Types.ReCaptcha.ReCaptchaV2
instance TwoCaptcha.Internal.Types.Captcha.HasCaptchaLenses TwoCaptcha.Internal.Types.ReCaptcha.ReCaptchaV2
instance TwoCaptcha.Internal.Types.ReCaptcha.HasReCaptchaLenses TwoCaptcha.Internal.Types.ReCaptcha.ReCaptchaV2
instance TwoCaptcha.Internal.Types.Captcha.HasPageURL TwoCaptcha.Internal.Types.ReCaptcha.ReCaptchaV2
instance TwoCaptcha.Internal.Types.Captcha.HasProxy TwoCaptcha.Internal.Types.ReCaptcha.ReCaptchaV2
instance TwoCaptcha.Internal.Types.Captcha.HasUserAgent TwoCaptcha.Internal.Types.ReCaptcha.ReCaptchaV2
instance TwoCaptcha.Internal.Types.Captcha.HasCookies TwoCaptcha.Internal.Types.ReCaptcha.ReCaptchaV2

module TwoCaptcha.Internal.Types.RotateCaptcha

-- | Parameters used to solve a rotate captcha.
newtype RotateCaptcha
MkRotateCaptcha :: Captcha -> RotateCaptcha

-- | Parameters used to solve a rotate captcha.
--   
--   Required parameters:
--   
--   <ul>
--   <li><a>apiKey</a></li>
--   <li><a>file</a>*</li>
--   <li><a>body</a>*</li>
--   </ul>
--   
--   Optional parameters:
--   
--   <ul>
--   <li><a>angle</a></li>
--   <li><a>headerACAO</a></li>
--   <li><a>pingback</a></li>
--   <li><a>softId</a></li>
--   </ul>
--   
--   Starred required parameter rules:
--   
--   <ul>
--   <li><b>file</b> is only required if your captcha is sent as a
--   file.</li>
--   <li><b>body</b> is only required if your captcha is sent in base64
--   format.</li>
--   </ul>
rotateCaptcha :: RotateCaptcha

-- | Angle for one rotation step in degrees. Defaults to 40 degrees if not
--   specified.
angle :: Lens' RotateCaptcha (Maybe Int)
instance GHC.Show.Show TwoCaptcha.Internal.Types.RotateCaptcha.RotateCaptcha
instance TwoCaptcha.Internal.Types.Captcha.HasCommonCaptchaLenses TwoCaptcha.Internal.Types.RotateCaptcha.RotateCaptcha
instance TwoCaptcha.Internal.Types.Captcha.HasCaptchaLenses TwoCaptcha.Internal.Types.RotateCaptcha.RotateCaptcha
instance TwoCaptcha.Internal.Types.Captcha.HasLocalImage TwoCaptcha.Internal.Types.RotateCaptcha.RotateCaptcha

module TwoCaptcha.Internal.Types.TextCaptcha

-- | Parameters used to solve a text captcha.
newtype TextCaptcha
MkTextCaptcha :: Captcha -> TextCaptcha

-- | Parameters for solving a text captcha.
--   
--   Required parameters:
--   
--   <ul>
--   <li><a>apiKey</a></li>
--   <li><a>textContent</a></li>
--   </ul>
--   
--   Optional parameters:
--   
--   <ul>
--   <li><a>language</a></li>
--   <li><a>languageCode</a></li>
--   <li><a>headerACAO</a></li>
--   <li><a>pingback</a></li>
--   <li><a>softId</a></li>
--   </ul>
textCaptcha :: TextCaptcha

-- | The text captcha's content.
textContent :: Lens' TextCaptcha (Maybe Text)
instance GHC.Show.Show TwoCaptcha.Internal.Types.TextCaptcha.TextCaptcha
instance TwoCaptcha.Internal.Types.Captcha.HasCommonCaptchaLenses TwoCaptcha.Internal.Types.TextCaptcha.TextCaptcha
instance TwoCaptcha.Internal.Types.Captcha.HasCaptchaLenses TwoCaptcha.Internal.Types.TextCaptcha.TextCaptcha
instance TwoCaptcha.Internal.Types.Captcha.HasLanguage TwoCaptcha.Internal.Types.TextCaptcha.TextCaptcha

module TwoCaptcha.Internal.Types.TikTokCaptcha

-- | Parameters used to solve a TikTok captcha.
newtype TikTokCaptcha
MkTikTokCaptcha :: Captcha -> TikTokCaptcha

-- | Parameters used to solve a TikTok captcha.
--   
--   Required parameters:
--   
--   <ul>
--   <li><a>apiKey</a></li>
--   <li><a>cookies</a></li>
--   <li><a>aid</a></li>
--   <li><a>host</a></li>
--   <li><a>pageUrl</a></li>
--   </ul>
--   
--   Optional parameters:
--   
--   <ul>
--   <li><a>softId</a></li>
--   <li><a>proxy</a></li>
--   <li><a>proxyType</a></li>
--   </ul>
tikTokCaptcha :: TikTokCaptcha

-- | The <b>aid</b> parameter value found on the page.
aid :: Lens' TikTokCaptcha (Maybe Int)

-- | The <b>host</b> parameter value found on the page.
host :: Lens' TikTokCaptcha (Maybe Text)
instance GHC.Show.Show TwoCaptcha.Internal.Types.TikTokCaptcha.TikTokCaptcha
instance TwoCaptcha.Internal.Types.Captcha.HasCommonCaptchaLenses TwoCaptcha.Internal.Types.TikTokCaptcha.TikTokCaptcha
instance TwoCaptcha.Internal.Types.Captcha.HasCaptchaLenses TwoCaptcha.Internal.Types.TikTokCaptcha.TikTokCaptcha
instance TwoCaptcha.Internal.Types.Captcha.HasPageURL TwoCaptcha.Internal.Types.TikTokCaptcha.TikTokCaptcha
instance TwoCaptcha.Internal.Types.Captcha.HasProxy TwoCaptcha.Internal.Types.TikTokCaptcha.TikTokCaptcha
instance TwoCaptcha.Internal.Types.Captcha.HasCookies TwoCaptcha.Internal.Types.TikTokCaptcha.TikTokCaptcha

module TwoCaptcha.Captcha

-- | Represents the request information required to solve a captcha.
data Captcha
MkCaptcha :: Options -> [(Text, Text)] -> [(Text, FilePath)] -> Captcha
[_options] :: Captcha -> Options
[_partTexts] :: Captcha -> [(Text, Text)]
[_partFiles] :: Captcha -> [(Text, FilePath)]

-- | Time in milliseconds on when to timeout if the request takes too long.
type TimeoutDuration = Integer

-- | Time in milliseconds in how often to request the answer.
type PollingInterval = Int

-- | The id of a captcha being solved.
type CaptchaId = Text

-- | Default captcha timeout duration (120 seconds).
captchaTimeout :: TimeoutDuration

-- | Default polling interval (10 seconds).
pollingInterval :: PollingInterval
class Coercible Captcha a => HasCookies a

-- | Cookies that will be used by the worker solving the captcha. The used
--   cookies will also be included in the response.
--   
--   Format: <b>KEY1:Value1;KEY2:Value2;</b>
cookies :: HasCookies a => Lens' a (Maybe Text)
class Coercible Captcha a => HasUserAgent a

-- | User agent that will be used by the worker when solving the captcha.
userAgent :: HasUserAgent a => Lens' a (Maybe Text)
class Coercible Captcha a => HasLanguage a

-- | The captcha's language:
--   
--   <ol>
--   <li>Not specified.</li>
--   <li>Cyrillic captcha.</li>
--   <li>Latin captcha.</li>
--   </ol>
language :: HasLanguage a => Lens' a (Maybe Int)

-- | The captcha's language code. Click <a>here</a> for a list of supported
--   languages.
languageCode :: HasLanguage a => Lens' a (Maybe Text)
class Coercible Captcha a => HasLocalImage a

-- | File path of a captcha image.
file :: HasLocalImage a => Lens' a (Maybe FilePath)

-- | Base-64 encoded image.
body :: HasLocalImage a => Lens' a (Maybe Text)

-- | Text which is shown to the worker to help solve a captcha.
textInstructions :: HasLocalImage a => Lens' a (Maybe Text)

-- | Image file path with instructions on solving a captcha.
imgInstructions :: HasLocalImage a => Lens' a (Maybe FilePath)
class Coercible Captcha a => HasProxy a

-- | Proxy to be sent to the worker who solves the captcha. You can read
--   more about proxies <a>here</a>.
--   
--   Format must be in <b>login:password@123.123.123.123:3128</b> .
proxy :: HasProxy a => Lens' a (Maybe Text)

-- | Type of your proxy: <b>HTTP</b>, <b>HTTPS</b>, <b>SOCKS4</b>,
--   <b>SOCKS5</b>.
proxyType :: HasProxy a => Lens' a (Maybe Text)
class Coercible Captcha a => HasPageURL a

-- | Full URL of the page where the captcha is found.
pageUrl :: HasPageURL a => Lens' a (Maybe Text)

-- | Parameters used to retrieve the <a>answer</a> of a solved captcha.
newtype CaptchaRes
CaptchaRes :: Captcha -> CaptchaRes

-- | Lenses for constructing options for <a>submit</a> and <a>answer</a>.
class Coercible Captcha a => HasCommonCaptchaLenses a

-- | Your 2captcha API <a>key</a>.
apiKey :: HasCommonCaptchaLenses a => Lens' a (Maybe Text)

-- | If True, <a>submit</a> will include the
--   <b>Access-Control-Allow-Origin:*</b> header in the response. Used for
--   cross-domain AJAX requests in web applications.
headerACAO :: HasCommonCaptchaLenses a => Lens' a (Maybe Bool)

-- | Lenses for constructing options for <a>submit</a>.
class Coercible Captcha a => HasCaptchaLenses a

-- | Software developer id. Developers who integrate their software with
--   2captcha earn 10% of the user's spendings.
softId :: HasCaptchaLenses a => Lens' a (Maybe Int)

-- | URL for <a>pingback</a> (callback) response that will be sent the
--   answer to when the captcha is solved.
pingback :: HasCaptchaLenses a => Lens' a (Maybe Text)

-- | Type of captcha to solve.
method :: HasCaptchaLenses a => Lens' a (Maybe Text)
options :: Lens' Captcha Options
partFiles :: Lens' Captcha [(Text, FilePath)]
partTexts :: Lens' Captcha [(Text, Text)]

-- | Convert the captcha's multipart form parameters into a [<a>Part</a>].
parts :: Getter Captcha [Part]

-- | Create a lens using the given field name for multipart form files.
mkPartFileLens :: Coercible Captcha a => Text -> Lens' a (Maybe FilePath)

-- | Parameters for retrieving a captcha's answer.
--   
--   Required parameters:
--   
--   <ul>
--   <li><a>apiKey</a></li>
--   <li><a>captchaId</a></li>
--   </ul>
--   
--   Optional parameters:
--   
--   <ul>
--   <li><a>headerACAO</a></li>
--   </ul>
captchaRes :: CaptchaRes

-- | The captcha id returned from <a>submit</a>.
captchaId :: Lens' CaptchaRes (Maybe Text)

-- | Encapsulates the <b>in.php</b> and <b>res.php</b> endpoints for the
--   2captcha API.
class TwoCaptchaClient m

-- | Submit a captcha to be solved by the 2captcha API. Returns a captcha
--   id used for <a>answer</a>.
submit :: (TwoCaptchaClient m, Coercible Captcha a, HasCaptchaLenses a, HasCommonCaptchaLenses a) => Session -> a -> m CaptchaId

-- | Attempt to retrieve the answer of a captcha previously submitted.
answer :: TwoCaptchaClient m => Session -> CaptchaRes -> m Text

-- | Submits a captcha and polls for the answer.
solve :: (TwoCaptchaClient m, Coercible Captcha a, HasCaptchaLenses a, HasCommonCaptchaLenses a) => PollingInterval -> TimeoutDuration -> Session -> a -> m Text