Hercules.CLI.Client

Setup

determineDefaultApiBaseUrl :: IO Text

init :: IO HerculesClientEnv

Using the client

newtype HerculesClientToken

Constructors

HerculesClientToken Token

data HerculesClientEnv

retryOnFail :: (NFData b, Has HerculesClientToken r, Has HerculesClientEnv r) => Text -> (Token -> ClientM b) -> RIO r b

retryOnFailAnon :: (NFData b, Has HerculesClientEnv r) => Text -> ClientM b -> RIO r b

retryStreamOnFail :: (Has HerculesClientToken r, Has HerculesClientEnv r) => Text -> (Token -> ClientM b) -> (Either ClientError b -> IO c) -> RIO r c

Error handling

shouldRetryClientError :: ClientError -> Bool

clientErrorSummary :: ClientError -> Text

ClientError printer that won't leak sensitive info.

shouldRetryResponse :: Either ClientError r -> Bool

waitRetryPolicy :: MonadIO m => RetryPolicyM m

dieWithHttpError :: ClientError -> IO a

prettyPrintHttpErrors :: IO a -> IO a

Client function groups

accountsClient :: AccountsAPI ClientAuth (AsClientT ClientM)

projectsClient :: ProjectsAPI ClientAuth (AsClientT ClientM)

reposClient :: ReposAPI ClientAuth (AsClientT ClientM)

stateClient :: StateAPI ClientAuth (AsClientT ClientM)