Network.DigitalOcean.Types

Documentation

type QueryParams = [(String, String)]

data RequestMethod

Constructors

Get

Post

Put

Delete

Instances

Show RequestMethod

Methods

showsPrec :: Int -> RequestMethod -> ShowS

show :: RequestMethod -> String

showList :: [RequestMethod] -> ShowS

showQueryParams :: QueryParams -> String

class (FromJSON a, Show a, FromJSON (PaginationState a)) => Paginatable a

Instances

Paginatable LoadBalancer

Paginatable Image

Paginatable Firewall

Paginatable Droplet

Paginatable FloatingIp

Paginatable Action

Paginatable DomainRecord

Paginatable Domain

Paginatable Certificate

data PaginationState a

Constructors

PaginationState

Fields

• curr :: [a]
• page :: Int
• nextUrl :: Maybe String
• total :: Maybe Int
• isLast :: Bool

Instances

Show a => Show (PaginationState a)

Methods

showsPrec :: Int -> PaginationState a -> ShowS

show :: PaginationState a -> String

showList :: [PaginationState a] -> ShowS

FromJSON (PaginationState LoadBalancer)

Methods

parseJSON :: Value -> Parser (PaginationState LoadBalancer)

parseJSONList :: Value -> Parser [PaginationState LoadBalancer]

FromJSON (PaginationState Image)

Methods

parseJSON :: Value -> Parser (PaginationState Image)

parseJSONList :: Value -> Parser [PaginationState Image]

FromJSON (PaginationState Firewall)

Methods

parseJSON :: Value -> Parser (PaginationState Firewall)

parseJSONList :: Value -> Parser [PaginationState Firewall]

FromJSON (PaginationState Droplet)

Methods

parseJSON :: Value -> Parser (PaginationState Droplet)

parseJSONList :: Value -> Parser [PaginationState Droplet]

FromJSON (PaginationState FloatingIp)

Methods

parseJSON :: Value -> Parser (PaginationState FloatingIp)

parseJSONList :: Value -> Parser [PaginationState FloatingIp]

FromJSON (PaginationState Action)

Methods

parseJSON :: Value -> Parser (PaginationState Action)

parseJSONList :: Value -> Parser [PaginationState Action]

FromJSON (PaginationState DomainRecord)

Methods

parseJSON :: Value -> Parser (PaginationState DomainRecord)

parseJSONList :: Value -> Parser [PaginationState DomainRecord]

FromJSON (PaginationState Domain)

Methods

parseJSON :: Value -> Parser (PaginationState Domain)

parseJSONList :: Value -> Parser [PaginationState Domain]

FromJSON (PaginationState Certificate)

Methods

parseJSON :: Value -> Parser (PaginationState Certificate)

parseJSONList :: Value -> Parser [PaginationState Certificate]

data PaginationConfig

Constructors

PaginationConfig

Fields

• pageSize :: Int
• resultLimit :: Int

defaultPaginationConfig :: PaginationConfig

newtype DO a

Constructors

DO

Fields

• runDO :: ReaderT Client (ExceptT DoErr IO) a

Instances

Monad DO

Methods

(>>=) :: DO a -> (a -> DO b) -> DO b

(>>) :: DO a -> DO b -> DO b

return :: a -> DO a

fail :: String -> DO a

Functor DO

Methods

fmap :: (a -> b) -> DO a -> DO b

(<$) :: a -> DO b -> DO a

Applicative DO

Methods

pure :: a -> DO a

(<*>) :: DO (a -> b) -> DO a -> DO b

liftA2 :: (a -> b -> c) -> DO a -> DO b -> DO c

(*>) :: DO a -> DO b -> DO b

(<*) :: DO a -> DO b -> DO a

MonadIO DO

Methods

liftIO :: IO a -> DO a

MonadReader Client DO

Methods

ask :: DO Client

local :: (Client -> Client) -> DO a -> DO a

reader :: (Client -> a) -> DO a

MonadError DoErr DO

Methods

throwError :: DoErr -> DO a

catchError :: DO a -> (DoErr -> DO a) -> DO a

newtype Client

Constructors

Client

Fields

• apiKey :: ByteString

Instances

MonadReader Client DO

Methods

ask :: DO Client

local :: (Client -> Client) -> DO a -> DO a

reader :: (Client -> a) -> DO a

data DoErrType

Constructors

HttpError

JSONConversionError

InternalError

ActionNotAllowed

AuthenticationError

UnknownError

Instances

Show DoErrType

Methods

showsPrec :: Int -> DoErrType -> ShowS

show :: DoErrType -> String

showList :: [DoErrType] -> ShowS

data DoErr

Constructors

DoErr

Fields

• errType :: DoErrType
• errTitle :: Text
• errBody :: Text

Instances

Show DoErr

Methods

showsPrec :: Int -> DoErr -> ShowS

show :: DoErr -> String

showList :: [DoErr] -> ShowS

MonadError DoErr DO

Methods

throwError :: DoErr -> DO a

catchError :: DO a -> (DoErr -> DO a) -> DO a

newtype Response a

Constructors

Response

Fields

• unResponse :: a

Instances

Show a => Show (Response a)

Methods

showsPrec :: Int -> Response a -> ShowS

show :: Response a -> String

showList :: [Response a] -> ShowS

Generic (Response a)

Associated Types

type Rep (Response a) :: * -> *

Methods

from :: Response a -> Rep (Response a) x

to :: Rep (Response a) x -> Response a

FromJSON (Response [Snapshot])

Methods

parseJSON :: Value -> Parser (Response [Snapshot])

parseJSONList :: Value -> Parser [Response [Snapshot]]

FromJSON (Response [Size])

Methods

parseJSON :: Value -> Parser (Response [Size])

parseJSONList :: Value -> Parser [Response [Size]]

FromJSON (Response [SSHKey])

Methods

parseJSON :: Value -> Parser (Response [SSHKey])

parseJSONList :: Value -> Parser [Response [SSHKey]]

FromJSON (Response [Region])

Methods

parseJSON :: Value -> Parser (Response [Region])

parseJSONList :: Value -> Parser [Response [Region]]

FromJSON (Response [Volume])

Methods

parseJSON :: Value -> Parser (Response [Volume])

parseJSONList :: Value -> Parser [Response [Volume]]

FromJSON (Response [LoadBalancer])

Methods

parseJSON :: Value -> Parser (Response [LoadBalancer])

parseJSONList :: Value -> Parser [Response [LoadBalancer]]

FromJSON (Response [Image])

Methods

parseJSON :: Value -> Parser (Response [Image])

parseJSONList :: Value -> Parser [Response [Image]]

FromJSON (Response [Firewall])

Methods

parseJSON :: Value -> Parser (Response [Firewall])

parseJSONList :: Value -> Parser [Response [Firewall]]

FromJSON (Response [Droplet])

Methods

parseJSON :: Value -> Parser (Response [Droplet])

parseJSONList :: Value -> Parser [Response [Droplet]]

FromJSON (Response [Backup])

Methods

parseJSON :: Value -> Parser (Response [Backup])

parseJSONList :: Value -> Parser [Response [Backup]]

FromJSON (Response [Kernel])

Methods

parseJSON :: Value -> Parser (Response [Kernel])

parseJSONList :: Value -> Parser [Response [Kernel]]

FromJSON (Response [FloatingIp])

Methods

parseJSON :: Value -> Parser (Response [FloatingIp])

parseJSONList :: Value -> Parser [Response [FloatingIp]]

FromJSON (Response [Action])

Methods

parseJSON :: Value -> Parser (Response [Action])

parseJSONList :: Value -> Parser [Response [Action]]

FromJSON (Response [DomainRecord])

Methods

parseJSON :: Value -> Parser (Response [DomainRecord])

parseJSONList :: Value -> Parser [Response [DomainRecord]]

FromJSON (Response [Domain])

Methods

parseJSON :: Value -> Parser (Response [Domain])

parseJSONList :: Value -> Parser [Response [Domain]]

FromJSON (Response [Certificate])

Methods

parseJSON :: Value -> Parser (Response [Certificate])

parseJSONList :: Value -> Parser [Response [Certificate]]

FromJSON (Response ())

Methods

parseJSON :: Value -> Parser (Response ())

parseJSONList :: Value -> Parser [Response ()]

FromJSON (Response Snapshot)

Methods

parseJSON :: Value -> Parser (Response Snapshot)

parseJSONList :: Value -> Parser [Response Snapshot]

FromJSON (Response SSHKey)

Methods

parseJSON :: Value -> Parser (Response SSHKey)

parseJSONList :: Value -> Parser [Response SSHKey]

FromJSON (Response Volume)

Methods

parseJSON :: Value -> Parser (Response Volume)

parseJSONList :: Value -> Parser [Response Volume]

FromJSON (Response Account)

Methods

parseJSON :: Value -> Parser (Response Account)

parseJSONList :: Value -> Parser [Response Account]

FromJSON (Response LoadBalancer)

Methods

parseJSON :: Value -> Parser (Response LoadBalancer)

parseJSONList :: Value -> Parser [Response LoadBalancer]

FromJSON (Response Image)

Methods

parseJSON :: Value -> Parser (Response Image)

parseJSONList :: Value -> Parser [Response Image]

FromJSON (Response Firewall)

Methods

parseJSON :: Value -> Parser (Response Firewall)

parseJSONList :: Value -> Parser [Response Firewall]

FromJSON (Response Droplet)

Methods

parseJSON :: Value -> Parser (Response Droplet)

parseJSONList :: Value -> Parser [Response Droplet]

FromJSON (Response Neighbors)

Methods

parseJSON :: Value -> Parser (Response Neighbors)

parseJSONList :: Value -> Parser [Response Neighbors]

FromJSON (Response FloatingIp)

Methods

parseJSON :: Value -> Parser (Response FloatingIp)

parseJSONList :: Value -> Parser [Response FloatingIp]

FromJSON (Response Action)

Methods

parseJSON :: Value -> Parser (Response Action)

parseJSONList :: Value -> Parser [Response Action]

FromJSON (Response DomainRecord)

Methods

parseJSON :: Value -> Parser (Response DomainRecord)

parseJSONList :: Value -> Parser [Response DomainRecord]

FromJSON (Response Domain)

Methods

parseJSON :: Value -> Parser (Response Domain)

parseJSONList :: Value -> Parser [Response Domain]

FromJSON (Response Certificate)

Methods

parseJSON :: Value -> Parser (Response Certificate)

parseJSONList :: Value -> Parser [Response Certificate]

type Rep (Response a)

type Rep (Response a) = D1 * (MetaData "Response" "Network.DigitalOcean.Types" "DOH-0.1.4.0-1E19JRUoTXIFgbVw80VcOk" True) (C1 * (MetaCons "Response" PrefixI True) (S1 * (MetaSel (Just Symbol "unResponse") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * a)))

class ToJSON a => Payload a

Instances

Payload EmptyPayload

Payload SnapshotPayload

Payload SSHKeyNamePayload

Payload SSHKeyPayload

Payload VolumeAction

Payload VolumePayload

Payload LoadBalancerPayload

Payload ImageAction

Payload ImagePayload

Payload FirewallRulesPayload

Payload TagsPayload

Payload DropletsPayload

Payload FirewallPayload

Payload DropletAction

Payload DropletPayload

Payload FloatingIpAction

Payload FloatingIpPayload

Payload DomainRecordPayload

Payload DomainPayload

Payload Certificatepayload

Payload [ForwardingRule]

data EmptyPayload

Constructors

EmptyPayload

Instances

ToJSON EmptyPayload

Methods

toJSON :: EmptyPayload -> Value

toEncoding :: EmptyPayload -> Encoding

toJSONList :: [EmptyPayload] -> Value

toEncodingList :: [EmptyPayload] -> Encoding

Payload EmptyPayload

data Endpoint

Constructors

AccountEndpoint

ActionsEndpoint

ActionEndpoint ActionId

RegionsEndpoint

VolumesEndpoint

SnapshotsEndpoint

DomainsEndpoint

ImagesEndpoint

SizesEndpoint

DropletsEndpoint

RecordsEndpoint

KernelsEndpoint

BackupsEndpoint

NeighborsEndpoint

FloatingIpsEndpoint

DropletsNeighborsEndpoint

TagsEndpoint

RulesEndpoint

FirewallsEndpoint

LoadBalancersEndpoint

ForwardingRulesEndpoint

KeysEndpoint

SSHKeysEndpoint

VolumeEndpoint VolumeId

SnapshotEndpoint SnapshotId

VolumeSnapshotsEndpoint VolumeId

VolumesActionsEndpoint

VolumeActionEndpoint VolumeId ActionId

VolumeActionsEndpoint VolumeId

CertificateEndpoint CertificateId

CertificatesEndpoint

DomainEndpoint DomainName

DomainRecordsEndpoint DomainName

DomainRecordEndpoint DomainName DomainRecordId

ImageActionsEndpoint ImageId

ImageActionEndpoint ImageId ActionId

ImageEndpoint ImageId

ImageBySlugEndpoint String

DropletEndpoint DropletId

DropletKernelsEndpoint DropletId

DropletSnapshotsEndpoint DropletId

DropletBackupsEndpoint DropletId

DropletActionsEndpoint DropletId

DropletNeighborsEndpoint DropletId

DropletsActionsEndpoint

DropletActionEndpoint DropletId ActionId

FloatingIpEndpoint IpAddress

FloatingIpActionsEndpoint IpAddress

FloatingIpActionEndpoint IpAddress ActionId

FirewallEndpoint FirewallId

FirewallDropletsEndpoint FirewallId

FirewallTagsEndpoint FirewallId

FirewallRulesEndpoint FirewallId

LoadBalancerEndpoint LoadBalancerId

LoadBalancerDropletsEndpoint LoadBalancerId

LoadBalancerForwardingRulesEndpoint LoadBalancerId

SSHKeyEndpoint SSHKeyId

SSHKeyWithFingerprintEndpoint String

Instances

Show Endpoint

Methods

showsPrec :: Int -> Endpoint -> ShowS

show :: Endpoint -> String

showList :: [Endpoint] -> ShowS

type VolumeId = String

type ActionId = Int

type CertificateId = String

type SnapshotId = String

type DomainName = String

type DomainRecordId = Int

type DropletId = Int

type RegionSlug = String

type ImageId = Int

type DropletName = String

type IpAddress = String

type FirewallId = String

type LoadBalancerId = String

type SSHKeyId = Int