Copyright	2019 Sasha Bogicevic
License	BSD 3 clause
Maintainer	Sasha Bogicevic <[email protected]>
Stability	experimental
Portability	portable
Safe Haskell	None
Language	Haskell2010

Data.Plaid

Description

Welcome to Plaid

As you could guess this library aims to provide easy integration with Plaid.com

Synopsis

mkExchangePublicTokenEnv :: PlaidEnv -> PublicToken -> Either PlaidError (PlaidBody PlaidTokenExchange)
mkCreatePublicTokenEnv :: PlaidEnv -> InstitutionId -> [PlaidProduct] -> Maybe PlaidOptions -> Either PlaidError (PlaidBody PublicTokenCreate)
mkGetBalanceEnv :: PlaidEnv -> AccessToken -> Either PlaidError (PlaidBody GetBalance)
mkGetAuthEnv :: PlaidEnv -> AccessToken -> Either PlaidError (PlaidBody AuthGet)
mkCreateTransactionsGetEnv :: PlaidEnv -> AccessToken -> Day -> Day -> Maybe PlaidOptions -> Maybe PlaidPaginationOptions -> Either PlaidError (PlaidBody PlaidTransactionsGet)
mkCreateIdentityGetEnv :: PlaidEnv -> AccessToken -> Either PlaidError (PlaidBody PlaidIdentityGet)
mkCreateIncomeGetEnv :: PlaidEnv -> AccessToken -> Either PlaidError (PlaidBody PlaidIncomeGet)
plaidCreatePublicToken :: (MonadReader PlaidEnv m, MonadThrow m, PlaidHttp m) => PlaidBody PublicTokenCreate -> m PlaidPublicTokenResponse
plaidExchangeToken :: (MonadReader PlaidEnv m, MonadThrow m, PlaidHttp m) => PlaidBody PlaidTokenExchange -> m PlaidAccessTokenResponse
plaidGetAuth :: (MonadReader PlaidEnv m, MonadThrow m, PlaidHttp m) => PlaidBody AuthGet -> m ByteString
plaidGetBalance :: (MonadReader PlaidEnv m, PlaidHttp m) => PlaidBody GetBalance -> m ByteString
plaidGetTransactions :: (MonadReader PlaidEnv m, MonadThrow m, PlaidHttp m) => PlaidBody PlaidTransactionsGet -> m ByteString
plaidGetIdentity :: (MonadReader PlaidEnv m, MonadThrow m, PlaidHttp m) => PlaidBody PlaidIdentityGet -> m ByteString
plaidGetIncome :: (MonadReader PlaidEnv m, MonadThrow m, PlaidHttp m) => PlaidBody PlaidIncomeGet -> m ByteString
data Environment
- = Sandbox
- | Development
- | Production
newtype PlaidError = PlaidError Text
class Monad m => PlaidHttp m where
- executePost :: ToJSON a => Text -> a -> m ByteString
- executeGet :: Text -> m ByteString
data PlaidOptions = PlaidOptions {
- _plaidOptionsWebHook :: Text
- _plaidOptionsOverrideUsername :: Text
- _plaidOptionsOverridePassword :: Text
}
data PlaidIncomeGet
data PlaidIdentityGet
data PlaidTransactionsGet
data PlaidTokenExchange
data PublicTokenCreate
data GetBalance
data AuthGet
type RequestId = Text
type Bic = Text
type Iban = Text
type AccountId = Text
type SortCode = Text
type AccountNumber = Text
type Institution = Text
type PlaidProduct = Text
type AccessKey = Text
type PublicKey = Text
newtype Url a = Url {
- unUrl :: Text
}
newtype InstitutionId = InstitutionId {
- unInstitutionId :: Text
}
newtype Secret = Secret {
- unSecret :: Text
}
newtype ClientId = ClientId {
- unClientId :: Text
}
newtype PublicToken = PublicToken {
- unPublicToken :: Text
}
newtype AccessToken = AccessToken {
- unAccessToken :: Text
}
plaidOptionsOverridePassword :: Lens' PlaidOptions Text
plaidOptionsOverrideUsername :: Lens' PlaidOptions Text
plaidOptionsWebHook :: Lens' PlaidOptions Text
data PlaidPaginationOptions = PlaidPaginationOptions {
- _plaidPaginationOptionsCount :: Int
- _plaidPaginationOptionsOffset :: Int
}
plaidPaginationOptionsCount :: Lens' PlaidPaginationOptions Int
plaidPaginationOptionsOffset :: Lens' PlaidPaginationOptions Int
data PlaidEnv = PlaidEnv {
- _plaidEnvPublicKey :: PublicKey
- _plaidEnvClientId :: ClientId
- _plaidEnvSecret :: Secret
- _plaidEnvEnvironment :: Environment
}
defPaginationOptions :: PlaidPaginationOptions
plaidEnvClientId :: Lens' PlaidEnv ClientId
plaidEnvEnvironment :: Lens' PlaidEnv Environment
plaidEnvPublicKey :: Lens' PlaidEnv PublicKey
plaidEnvSecret :: Lens' PlaidEnv Secret
data PlaidBody a = PlaidBody {
- _plaidBodyEnv :: PlaidEnv
- _plaidBodyPublicToken :: Maybe PublicToken
- _plaidBodyAccessToken :: Maybe AccessToken
- _plaidBodyOptions :: Maybe PlaidOptions
- _plaidBodyPaginationOptions :: Maybe PlaidPaginationOptions
- _plaidBodyInstitutionId :: Maybe InstitutionId
- _plaidBodyInitialProducts :: Maybe [PlaidProduct]
- _plaidBodyStartDate :: Maybe Day
- _plaidBodyEndDate :: Maybe Day
}
data CurrencyCode
- = USD
- | EUR
unPlaidTest :: PlaidTest a -> Identity a
unPlaid :: Plaid a -> ReaderT PlaidEnv IO a
plaidBodyAccessToken :: forall a a. Lens (PlaidBody a) (PlaidBody a) (Maybe AccessToken) (Maybe AccessToken)
plaidBodyEndDate :: forall a a. Lens (PlaidBody a) (PlaidBody a) (Maybe Day) (Maybe Day)
plaidBodyEnv :: forall a a. Lens (PlaidBody a) (PlaidBody a) PlaidEnv PlaidEnv
plaidBodyInitialProducts :: forall a a. Lens (PlaidBody a) (PlaidBody a) (Maybe [PlaidProduct]) (Maybe [PlaidProduct])
plaidBodyInstitutionId :: forall a a. Lens (PlaidBody a) (PlaidBody a) (Maybe InstitutionId) (Maybe InstitutionId)
plaidBodyOptions :: forall a a. Lens (PlaidBody a) (PlaidBody a) (Maybe PlaidOptions) (Maybe PlaidOptions)
plaidBodyPaginationOptions :: forall a a. Lens (PlaidBody a) (PlaidBody a) (Maybe PlaidPaginationOptions) (Maybe PlaidPaginationOptions)
plaidBodyPublicToken :: forall a a. Lens (PlaidBody a) (PlaidBody a) (Maybe PublicToken) (Maybe PublicToken)
plaidBodyStartDate :: forall a a. Lens (PlaidBody a) (PlaidBody a) (Maybe Day) (Maybe Day)
runPlaid :: PlaidEnv -> Plaid a -> IO a
data Balance = Balance {
- balanceAvailable :: Double
- balanceCurrent :: Double
- balanceLimit :: Maybe Double
- balanceIsoCurrencyCode :: CurrencyCode
- balanceUnofficialCurrencyCode :: Maybe CurrencyCode
}
data Account = Account {
- accountAccountId :: Text
- accountBalances :: Balance
- accountMask :: Text
- accountName :: Text
- accountOfficialName :: Text
- accountSubtype :: Text
- accountType :: Text
}
data Ach = Ach {
- achAccount :: AccountNumber
- achAccountId :: AccountId
- achRouting :: Text
- achWireRouting :: Text
}
data Error = Error {
- errorType :: Text
- errorCode :: Text
- errorMessage :: Text
- displayMessage :: Maybe Text
}
data Item = Item {
- itemAvailableProducts :: [Text]
- itemBilledProducts :: [Text]
- itemError :: Maybe Error
- itemInstitutionId :: InstitutionId
- itemItemId :: Text
- itemWebhook :: Maybe Text
}
data Eft = Eft {
- eftAccount :: AccountNumber
- eftAccountId :: AccountId
- eftInstitution :: Institution
- eftBranch :: Text
}
data International = International {
- internationalAccountId :: AccountId
- internationalBic :: Bic
- internationalIban :: Iban
}
data Bacs = Bacs {
- bacsAccount :: AccountNumber
- bacsAccountId :: AccountId
- bacsSortCode :: SortCode
}
data Numbers = Numbers {
- numbersAch :: [Ach]
- numbersEft :: [Eft]
- numbersInternational :: [International]
- numbersBacs :: [Bacs]
}
data TransactionLocation = TransactionLocation {
- transactionLocationAddress :: Maybe Text
- transactionLocationCity :: Maybe Text
- transactionLocationRegion :: Maybe Text
- transactionLocationPostalCode :: Maybe Text
- transactionLocationPostalCountry :: Maybe Text
- transactionLocationPostalLat :: Maybe Double
- transactionLocationPostalLon :: Maybe Double
}
data TransactionType
- = Digital
- | Place
- | Special
- | Unresolved
data PaymentMeta = PaymentMeta {
- paymentMetaReferenceNumber :: Maybe Text
- paymentMetaPpdId :: Maybe Text
- paymentMetaPayee :: Maybe Text
}
data Transaction = Transaction {
- transactionAccountId :: AccountId
- transactionAmount :: Double
- transactionIsoCurrencyCode :: CurrencyCode
- transactionUnofficialCurrencyCode :: Maybe CurrencyCode
- transactionCategory :: Maybe [Text]
- transactionCategoryId :: Maybe Text
- transactionTransactionType :: Maybe TransactionType
- transactionName :: Text
- transactionDate :: Day
- transactionLocation :: TransactionLocation
- transactionPending :: Bool
- transactionPaymentMeta :: PaymentMeta
- transactionPendingTransactionId :: Maybe Text
- transactionAccountOwner :: Maybe Text
}
data PlaidTransactionsGetResponse = PlaidTransactionsGetResponse {
- _plaidTransactionsGetResponseAccounts :: [Account]
- _plaidTransactionsGetResponseTransactions :: [Transaction]
- _plaidTransactionsItem :: Item
- _plaidTransactionsTotalTransactions :: Int
- _plaidTransactionsRequestId :: Text
}
plaidTransactionsGetResponseAccounts :: Lens' PlaidTransactionsGetResponse [Account]
plaidTransactionsGetResponseTransactions :: Lens' PlaidTransactionsGetResponse [Transaction]
plaidTransactionsItem :: Lens' PlaidTransactionsGetResponse Item
plaidTransactionsRequestId :: Lens' PlaidTransactionsGetResponse Text
plaidTransactionsTotalTransactions :: Lens' PlaidTransactionsGetResponse Int
data PlaidAuthGetResponse = PlaidAuthGetResponse {
- _plaidAuthGetResponseAccounts :: [Account]
- _plaidAuthGetResponseNumbers :: Numbers
- _plaidAuthGetResponseItem :: Item
- _plaidAuthGetResponseRequestId :: RequestId
}
plaidAuthGetResponseAccounts :: Lens' PlaidAuthGetResponse [Account]
plaidAuthGetResponseItem :: Lens' PlaidAuthGetResponse Item
plaidAuthGetResponseNumbers :: Lens' PlaidAuthGetResponse Numbers
plaidAuthGetResponseRequestId :: Lens' PlaidAuthGetResponse RequestId
data PlaidPublicTokenResponse = PlaidPublicTokenResponse {
- _plaidPublicTokenResponsePublicToken :: PublicToken
- _plaidPublicTokenResponseRequestId :: Text
}
data PlaidAccessTokenResponse = PlaidAccessTokenResponse {
- _plaidAccessTokenResponseAccessToken :: AccessToken
- _plaidAccessTokenResponseRequestId :: Text
- _plaidAccessTokenResponseItemId :: Text
}
plaidPublicTokenResponsePublicToken :: Lens' PlaidPublicTokenResponse PublicToken
plaidPublicTokenResponseRequestId :: Lens' PlaidPublicTokenResponse Text
data PhoneNumber = PhoneNumber {
- _phoneNumberData :: Text
- _phoneNumberPrimary :: Bool
- _phoneNumberType :: Text
}
plaidAccessTokenResponseAccessToken :: Lens' PlaidAccessTokenResponse AccessToken
plaidAccessTokenResponseItemId :: Lens' PlaidAccessTokenResponse Text
plaidAccessTokenResponseRequestId :: Lens' PlaidAccessTokenResponse Text
phoneNumberData :: Lens' PhoneNumber Text
phoneNumberPrimary :: Lens' PhoneNumber Bool
phoneNumberType :: Lens' PhoneNumber Text
data Email = Email {
- _emailData :: Text
- _emailPrimary :: Bool
- _emailType :: Text
}
emailData :: Lens' Email Text
emailPrimary :: Lens' Email Bool
emailType :: Lens' Email Text
data Address = Address {
- _addressCity :: Text
- _addressRegion :: Text
- _addressStreet :: Text
- _addressPostalCode :: Text
- _addressCountry :: Maybe Text
}
addressCity :: Lens' Address Text
addressCountry :: Lens' Address (Maybe Text)
addressPostalCode :: Lens' Address Text
addressRegion :: Lens' Address Text
addressStreet :: Lens' Address Text
data Addresses = Addresses {
- _addressesData :: Address
- _addressesPrimary :: Bool
}
addressesData :: Lens' Addresses Address
addressesPrimary :: Lens' Addresses Bool
data Owners = Owners {
- _ownersAddresses :: [Addresses]
- _ownersEmails :: [Email]
- _ownersNames :: [Text]
- _ownersPhoneNumbers :: [PhoneNumber]
}
ownersAddresses :: Lens' Owners [Addresses]
ownersEmails :: Lens' Owners [Email]
ownersNames :: Lens' Owners [Text]
ownersPhoneNumbers :: Lens' Owners [PhoneNumber]
data Accounts = Accounts {
- _accountsAccountId :: Text
- _accountsBalances :: Balance
- _accountsMask :: Text
- _accountsName :: Text
- _accountsOfficialName :: Maybe Text
- _accountsOwners :: [Owners]
- _accountsSubtype :: Text
- _accountsType :: Text
}
data PlaidIdentityGetResponse = PlaidIdentityGetResponse {
- _plaidIdentityGetResponseAccounts :: [Accounts]
- _plaidIdentityGetItem :: Item
- _plaidIdentityGetRequestId :: Text
}
plaidIdentityGetItem :: Lens' PlaidIdentityGetResponse Item
plaidIdentityGetRequestId :: Lens' PlaidIdentityGetResponse Text
plaidIdentityGetResponseAccounts :: Lens' PlaidIdentityGetResponse [Accounts]
data IncomeStream = IncomeStream {
- _incomeStreamMonthlyIncome :: Fixed E2
- _incomeStreamConfidence :: Fixed E2
- _incomeStreamDays :: Fixed E2
- _incomeStreamName :: Text
}
incomeStreamConfidence :: Lens' IncomeStream (Fixed E2)
incomeStreamDays :: Lens' IncomeStream (Fixed E2)
incomeStreamMonthlyIncome :: Lens' IncomeStream (Fixed E2)
incomeStreamName :: Lens' IncomeStream Text
data Income = Income {
- _incomeLastYearIncome :: Fixed E2
- _incomeLastYearIncomeBeforeTax :: Fixed E2
- _incomeProjectedYearlyIncome :: Fixed E2
- _incomeProjectedYearlyIncomeBeforeTax :: Fixed E2
- _incomeIncomeStreams :: [IncomeStream]
- _incomeMaxNumberOfOverlappingIncomeStreams :: Fixed E2
- _incomeNumberOfIncomeStreams :: Fixed E2
}
incomeIncomeStreams :: Lens' Income [IncomeStream]
incomeLastYearIncome :: Lens' Income (Fixed E2)
incomeLastYearIncomeBeforeTax :: Lens' Income (Fixed E2)
incomeMaxNumberOfOverlappingIncomeStreams :: Lens' Income (Fixed E2)
incomeNumberOfIncomeStreams :: Lens' Income (Fixed E2)
incomeProjectedYearlyIncome :: Lens' Income (Fixed E2)
incomeProjectedYearlyIncomeBeforeTax :: Lens' Income (Fixed E2)
baseUrl :: Environment -> Url Environment
validInstitutionIds :: [InstitutionId]

Documentation

mkExchangePublicTokenEnv :: PlaidEnv -> PublicToken -> Either PlaidError (PlaidBody PlaidTokenExchange) Source #

mkCreatePublicTokenEnv :: PlaidEnv -> InstitutionId -> [PlaidProduct] -> Maybe PlaidOptions -> Either PlaidError (PlaidBody PublicTokenCreate) Source #

Creates a Public Token https://plaid.com/docs/#exchange-token-flow

mkGetBalanceEnv :: PlaidEnv -> AccessToken -> Either PlaidError (PlaidBody GetBalance) Source #

mkGetAuthEnv :: PlaidEnv -> AccessToken -> Either PlaidError (PlaidBody AuthGet) Source #

mkCreateTransactionsGetEnv :: PlaidEnv -> AccessToken -> Day -> Day -> Maybe PlaidOptions -> Maybe PlaidPaginationOptions -> Either PlaidError (PlaidBody PlaidTransactionsGet) Source #

Creates request body for transactionsget call https://plaid.com/docs/#retrieve-transactions-request

mkCreateIdentityGetEnv :: PlaidEnv -> AccessToken -> Either PlaidError (PlaidBody PlaidIdentityGet) Source #

Creates request body for identityget call https://plaid.com/docs/#identity

mkCreateIncomeGetEnv :: PlaidEnv -> AccessToken -> Either PlaidError (PlaidBody PlaidIncomeGet) Source #

Creates request body for incomeget call https://plaid.com/docs/#income

plaidCreatePublicToken :: (MonadReader PlaidEnv m, MonadThrow m, PlaidHttp m) => PlaidBody PublicTokenCreate -> m PlaidPublicTokenResponse Source #

Creates a public token that can be used in further interaction with plaid.com https://plaid.com/docs/#creating-public-tokens returns PlaidPublicTokenResponse or fails with PlaidError

plaidExchangeToken :: (MonadReader PlaidEnv m, MonadThrow m, PlaidHttp m) => PlaidBody PlaidTokenExchange -> m PlaidAccessTokenResponse Source #

Exchange a public token to access token. Public token is invalidated after the exchange. https://plaid.com/docs/#exchange-token-flow returns PlaidAccessTokenResponse or fails with PlaidError

plaidGetAuth :: (MonadReader PlaidEnv m, MonadThrow m, PlaidHttp m) => PlaidBody AuthGet -> m ByteString Source #

plaidGetBalance :: (MonadReader PlaidEnv m, PlaidHttp m) => PlaidBody GetBalance -> m ByteString Source #

Get the account balance http://plaid.com/docs/#retrieve-balance-request

plaidGetTransactions :: (MonadReader PlaidEnv m, MonadThrow m, PlaidHttp m) => PlaidBody PlaidTransactionsGet -> m ByteString Source #

plaidGetIdentity :: (MonadReader PlaidEnv m, MonadThrow m, PlaidHttp m) => PlaidBody PlaidIdentityGet -> m ByteString Source #

plaidGetIncome :: (MonadReader PlaidEnv m, MonadThrow m, PlaidHttp m) => PlaidBody PlaidIncomeGet -> m ByteString Source #

data Environment Source #

Constructors

Sandbox
Development
Production

Instances

Eq Environment Source #
Instance details Defined in Data.Api.Types Methods (==) :: Environment -> Environment -> Bool # (/=) :: Environment -> Environment -> Bool #
Ord Environment Source #
Instance details Defined in Data.Api.Types Methods compare :: Environment -> Environment -> Ordering # (<) :: Environment -> Environment -> Bool # (<=) :: Environment -> Environment -> Bool # (>) :: Environment -> Environment -> Bool # (>=) :: Environment -> Environment -> Bool # max :: Environment -> Environment -> Environment # min :: Environment -> Environment -> Environment #
Show Environment Source #
Instance details Defined in Data.Api.Types Methods showsPrec :: Int -> Environment -> ShowS # show :: Environment -> String # showList :: [Environment] -> ShowS #
FromJSON Environment Source #
Instance details Defined in Data.Api.Types Methods parseJSON :: Value -> Parser Environment # parseJSONList :: Value -> Parser [Environment] #

newtype PlaidError Source #

Constructors

PlaidError Text

Instances

Show PlaidError Source #
Instance details Defined in Data.Api.Types Methods showsPrec :: Int -> PlaidError -> ShowS # show :: PlaidError -> String # showList :: [PlaidError] -> ShowS #
ToJSON PlaidError Source #
Instance details Defined in Data.Api.Types Methods toJSON :: PlaidError -> Value # toEncoding :: PlaidError -> Encoding # toJSONList :: [PlaidError] -> Value # toEncodingList :: [PlaidError] -> Encoding #
FromJSON PlaidError Source #
Instance details Defined in Data.Api.Types Methods parseJSON :: Value -> Parser PlaidError # parseJSONList :: Value -> Parser [PlaidError] #
Exception PlaidError Source #
Instance details Defined in Data.Api.Types Methods toException :: PlaidError -> SomeException # fromException :: SomeException -> Maybe PlaidError # displayException :: PlaidError -> String #

class Monad m => PlaidHttp m where Source #

Methods

executePost :: ToJSON a => Text -> a -> m ByteString Source #

executeGet :: Text -> m ByteString Source #

data PlaidOptions Source #

Constructors

PlaidOptions
Fields _plaidOptionsWebHook :: Text _plaidOptionsOverrideUsername :: Text _plaidOptionsOverridePassword :: Text

Instances

Eq PlaidOptions Source #
Instance details Defined in Data.Api.Types Methods (==) :: PlaidOptions -> PlaidOptions -> Bool # (/=) :: PlaidOptions -> PlaidOptions -> Bool #
Show PlaidOptions Source #
Instance details Defined in Data.Api.Types Methods showsPrec :: Int -> PlaidOptions -> ShowS # show :: PlaidOptions -> String # showList :: [PlaidOptions] -> ShowS #
Semigroup PlaidOptions Source #
Instance details Defined in Data.Api.Types Methods (<>) :: PlaidOptions -> PlaidOptions -> PlaidOptions # sconcat :: NonEmpty PlaidOptions -> PlaidOptions # stimes :: Integral b => b -> PlaidOptions -> PlaidOptions #
Monoid PlaidOptions Source #
Instance details Defined in Data.Api.Types Methods mempty :: PlaidOptions # mappend :: PlaidOptions -> PlaidOptions -> PlaidOptions # mconcat :: [PlaidOptions] -> PlaidOptions #
ToJSON PlaidOptions Source #
Instance details Defined in Data.Api.Types Methods toJSON :: PlaidOptions -> Value # toEncoding :: PlaidOptions -> Encoding # toJSONList :: [PlaidOptions] -> Value # toEncodingList :: [PlaidOptions] -> Encoding #
FromJSON PlaidOptions Source #
Instance details Defined in Data.Api.Types Methods parseJSON :: Value -> Parser PlaidOptions # parseJSONList :: Value -> Parser [PlaidOptions] #

data PlaidIncomeGet Source #

Instances

ToJSON (PlaidBody PlaidIncomeGet) Source #
Instance details Defined in Data.Api.Types Methods toJSON :: PlaidBody PlaidIncomeGet -> Value # toEncoding :: PlaidBody PlaidIncomeGet -> Encoding # toJSONList :: [PlaidBody PlaidIncomeGet] -> Value # toEncodingList :: [PlaidBody PlaidIncomeGet] -> Encoding #

data PlaidIdentityGet Source #

Instances

ToJSON (PlaidBody PlaidIdentityGet) Source #
Instance details Defined in Data.Api.Types Methods toJSON :: PlaidBody PlaidIdentityGet -> Value # toEncoding :: PlaidBody PlaidIdentityGet -> Encoding # toJSONList :: [PlaidBody PlaidIdentityGet] -> Value # toEncodingList :: [PlaidBody PlaidIdentityGet] -> Encoding #

data PlaidTransactionsGet Source #

Instances

ToJSON (PlaidBody PlaidTransactionsGet) Source #
Instance details Defined in Data.Api.Types Methods toJSON :: PlaidBody PlaidTransactionsGet -> Value # toEncoding :: PlaidBody PlaidTransactionsGet -> Encoding # toJSONList :: [PlaidBody PlaidTransactionsGet] -> Value # toEncodingList :: [PlaidBody PlaidTransactionsGet] -> Encoding #

data PlaidTokenExchange Source #

Instances

ToJSON (PlaidBody PlaidTokenExchange) Source #
Instance details Defined in Data.Api.Types Methods toJSON :: PlaidBody PlaidTokenExchange -> Value # toEncoding :: PlaidBody PlaidTokenExchange -> Encoding # toJSONList :: [PlaidBody PlaidTokenExchange] -> Value # toEncodingList :: [PlaidBody PlaidTokenExchange] -> Encoding #

data PublicTokenCreate Source #

Instances

ToJSON (PlaidBody PublicTokenCreate) Source #
Instance details Defined in Data.Api.Types Methods toJSON :: PlaidBody PublicTokenCreate -> Value # toEncoding :: PlaidBody PublicTokenCreate -> Encoding # toJSONList :: [PlaidBody PublicTokenCreate] -> Value # toEncodingList :: [PlaidBody PublicTokenCreate] -> Encoding #

data GetBalance Source #

Instances

ToJSON (PlaidBody GetBalance) Source #
Instance details Defined in Data.Api.Types Methods toJSON :: PlaidBody GetBalance -> Value # toEncoding :: PlaidBody GetBalance -> Encoding # toJSONList :: [PlaidBody GetBalance] -> Value # toEncodingList :: [PlaidBody GetBalance] -> Encoding #

data AuthGet Source #

Instances

ToJSON (PlaidBody AuthGet) Source #
Instance details Defined in Data.Api.Types Methods toJSON :: PlaidBody AuthGet -> Value # toEncoding :: PlaidBody AuthGet -> Encoding # toJSONList :: [PlaidBody AuthGet] -> Value # toEncodingList :: [PlaidBody AuthGet] -> Encoding #

type RequestId = Text Source #

type Bic = Text Source #

type Iban = Text Source #

type AccountId = Text Source #

type SortCode = Text Source #

type AccountNumber = Text Source #

type Institution = Text Source #

type PlaidProduct = Text Source #

type AccessKey = Text Source #

type PublicKey = Text Source #

newtype Url a Source #

Constructors

Url
Fields unUrl :: Text

Instances

ToJSON (Url a) Source #
Instance details Defined in Data.Api.Types Methods toJSON :: Url a -> Value # toEncoding :: Url a -> Encoding # toJSONList :: [Url a] -> Value # toEncodingList :: [Url a] -> Encoding #
FromJSON (Url a) Source #
Instance details Defined in Data.Api.Types Methods parseJSON :: Value -> Parser (Url a) # parseJSONList :: Value -> Parser [Url a] #

newtype InstitutionId Source #

Constructors

InstitutionId
Fields unInstitutionId :: Text

Instances

Eq InstitutionId Source #
Instance details Defined in Data.Api.Types Methods (==) :: InstitutionId -> InstitutionId -> Bool # (/=) :: InstitutionId -> InstitutionId -> Bool #
Show InstitutionId Source #
Instance details Defined in Data.Api.Types Methods showsPrec :: Int -> InstitutionId -> ShowS # show :: InstitutionId -> String # showList :: [InstitutionId] -> ShowS #
ToJSON InstitutionId Source #
Instance details Defined in Data.Api.Types Methods toJSON :: InstitutionId -> Value # toEncoding :: InstitutionId -> Encoding # toJSONList :: [InstitutionId] -> Value # toEncodingList :: [InstitutionId] -> Encoding #
FromJSON InstitutionId Source #
Instance details Defined in Data.Api.Types Methods parseJSON :: Value -> Parser InstitutionId # parseJSONList :: Value -> Parser [InstitutionId] #

newtype Secret Source #

Constructors

Secret
Fields unSecret :: Text

Instances

Eq Secret Source #
Instance details Defined in Data.Api.Types Methods (==) :: Secret -> Secret -> Bool # (/=) :: Secret -> Secret -> Bool #
Show Secret Source #
Instance details Defined in Data.Api.Types Methods showsPrec :: Int -> Secret -> ShowS # show :: Secret -> String # showList :: [Secret] -> ShowS #
ToJSON Secret Source #
Instance details Defined in Data.Api.Types Methods toJSON :: Secret -> Value # toEncoding :: Secret -> Encoding # toJSONList :: [Secret] -> Value # toEncodingList :: [Secret] -> Encoding #
FromJSON Secret Source #
Instance details Defined in Data.Api.Types Methods parseJSON :: Value -> Parser Secret # parseJSONList :: Value -> Parser [Secret] #

newtype ClientId Source #

Constructors

ClientId
Fields unClientId :: Text

Instances

Eq ClientId Source #
Instance details Defined in Data.Api.Types Methods (==) :: ClientId -> ClientId -> Bool # (/=) :: ClientId -> ClientId -> Bool #
Show ClientId Source #
Instance details Defined in Data.Api.Types Methods showsPrec :: Int -> ClientId -> ShowS # show :: ClientId -> String # showList :: [ClientId] -> ShowS #
ToJSON ClientId Source #
Instance details Defined in Data.Api.Types Methods toJSON :: ClientId -> Value # toEncoding :: ClientId -> Encoding # toJSONList :: [ClientId] -> Value # toEncodingList :: [ClientId] -> Encoding #
FromJSON ClientId Source #
Instance details Defined in Data.Api.Types Methods parseJSON :: Value -> Parser ClientId # parseJSONList :: Value -> Parser [ClientId] #

newtype PublicToken Source #

Constructors

PublicToken
Fields unPublicToken :: Text

Instances

Eq PublicToken Source #
Instance details Defined in Data.Api.Types Methods (==) :: PublicToken -> PublicToken -> Bool # (/=) :: PublicToken -> PublicToken -> Bool #
Show PublicToken Source #
Instance details Defined in Data.Api.Types Methods showsPrec :: Int -> PublicToken -> ShowS # show :: PublicToken -> String # showList :: [PublicToken] -> ShowS #
ToJSON PublicToken Source #
Instance details Defined in Data.Api.Types Methods toJSON :: PublicToken -> Value # toEncoding :: PublicToken -> Encoding # toJSONList :: [PublicToken] -> Value # toEncodingList :: [PublicToken] -> Encoding #
FromJSON PublicToken Source #
Instance details Defined in Data.Api.Types Methods parseJSON :: Value -> Parser PublicToken # parseJSONList :: Value -> Parser [PublicToken] #

newtype AccessToken Source #

Constructors

AccessToken
Fields unAccessToken :: Text

Instances

Eq AccessToken Source #
Instance details Defined in Data.Api.Types Methods (==) :: AccessToken -> AccessToken -> Bool # (/=) :: AccessToken -> AccessToken -> Bool #
Show AccessToken Source #
Instance details Defined in Data.Api.Types Methods showsPrec :: Int -> AccessToken -> ShowS # show :: AccessToken -> String # showList :: [AccessToken] -> ShowS #
ToJSON AccessToken Source #
Instance details Defined in Data.Api.Types Methods toJSON :: AccessToken -> Value # toEncoding :: AccessToken -> Encoding # toJSONList :: [AccessToken] -> Value # toEncodingList :: [AccessToken] -> Encoding #
FromJSON AccessToken Source #
Instance details Defined in Data.Api.Types Methods parseJSON :: Value -> Parser AccessToken # parseJSONList :: Value -> Parser [AccessToken] #

plaidOptionsOverridePassword :: Lens' PlaidOptions Text Source #

plaidOptionsOverrideUsername :: Lens' PlaidOptions Text Source #

plaidOptionsWebHook :: Lens' PlaidOptions Text Source #

data PlaidPaginationOptions Source #

Constructors

PlaidPaginationOptions
Fields _plaidPaginationOptionsCount :: Int _plaidPaginationOptionsOffset :: Int

Instances

Eq PlaidPaginationOptions Source #
Instance details Defined in Data.Api.Types Methods (==) :: PlaidPaginationOptions -> PlaidPaginationOptions -> Bool # (/=) :: PlaidPaginationOptions -> PlaidPaginationOptions -> Bool #
Show PlaidPaginationOptions Source #
Instance details Defined in Data.Api.Types Methods showsPrec :: Int -> PlaidPaginationOptions -> ShowS # show :: PlaidPaginationOptions -> String # showList :: [PlaidPaginationOptions] -> ShowS #
ToJSON PlaidPaginationOptions Source #
Instance details Defined in Data.Api.Types Methods toJSON :: PlaidPaginationOptions -> Value # toEncoding :: PlaidPaginationOptions -> Encoding # toJSONList :: [PlaidPaginationOptions] -> Value # toEncodingList :: [PlaidPaginationOptions] -> Encoding #
FromJSON PlaidPaginationOptions Source #
Instance details Defined in Data.Api.Types Methods parseJSON :: Value -> Parser PlaidPaginationOptions # parseJSONList :: Value -> Parser [PlaidPaginationOptions] #

plaidPaginationOptionsCount :: Lens' PlaidPaginationOptions Int Source #

plaidPaginationOptionsOffset :: Lens' PlaidPaginationOptions Int Source #

data PlaidEnv Source #

Constructors

PlaidEnv
Fields _plaidEnvPublicKey :: PublicKey _plaidEnvClientId :: ClientId _plaidEnvSecret :: Secret _plaidEnvEnvironment :: Environment

Instances

Eq PlaidEnv Source #
Instance details Defined in Data.Api.Types Methods (==) :: PlaidEnv -> PlaidEnv -> Bool # (/=) :: PlaidEnv -> PlaidEnv -> Bool #
Show PlaidEnv Source #
Instance details Defined in Data.Api.Types Methods showsPrec :: Int -> PlaidEnv -> ShowS # show :: PlaidEnv -> String # showList :: [PlaidEnv] -> ShowS #
FromJSON PlaidEnv Source #
Instance details Defined in Data.Api.Types Methods parseJSON :: Value -> Parser PlaidEnv # parseJSONList :: Value -> Parser [PlaidEnv] #

defPaginationOptions :: PlaidPaginationOptions Source #

plaidEnvClientId :: Lens' PlaidEnv ClientId Source #

plaidEnvEnvironment :: Lens' PlaidEnv Environment Source #

plaidEnvPublicKey :: Lens' PlaidEnv PublicKey Source #

plaidEnvSecret :: Lens' PlaidEnv Secret Source #

data PlaidBody a Source #

Constructors

PlaidBody
Fields _plaidBodyEnv :: PlaidEnv _plaidBodyPublicToken :: Maybe PublicToken _plaidBodyAccessToken :: Maybe AccessToken _plaidBodyOptions :: Maybe PlaidOptions _plaidBodyPaginationOptions :: Maybe PlaidPaginationOptions _plaidBodyInstitutionId :: Maybe InstitutionId _plaidBodyInitialProducts :: Maybe [PlaidProduct] _plaidBodyStartDate :: Maybe Day _plaidBodyEndDate :: Maybe Day

Instances

Eq (PlaidBody a) Source #
Instance details Defined in Data.Api.Types Methods (==) :: PlaidBody a -> PlaidBody a -> Bool # (/=) :: PlaidBody a -> PlaidBody a -> Bool #
Show (PlaidBody a) Source #
Instance details Defined in Data.Api.Types Methods showsPrec :: Int -> PlaidBody a -> ShowS # show :: PlaidBody a -> String # showList :: [PlaidBody a] -> ShowS #
Semigroup (PlaidBody a) Source #
Instance details Defined in Data.Api.Types Methods (<>) :: PlaidBody a -> PlaidBody a -> PlaidBody a # sconcat :: NonEmpty (PlaidBody a) -> PlaidBody a # stimes :: Integral b => b -> PlaidBody a -> PlaidBody a #
Monoid (PlaidBody a) Source #
Instance details Defined in Data.Api.Types Methods mempty :: PlaidBody a # mappend :: PlaidBody a -> PlaidBody a -> PlaidBody a # mconcat :: [PlaidBody a] -> PlaidBody a #
ToJSON (PlaidBody PlaidIncomeGet) Source #
Instance details Defined in Data.Api.Types Methods toJSON :: PlaidBody PlaidIncomeGet -> Value # toEncoding :: PlaidBody PlaidIncomeGet -> Encoding # toJSONList :: [PlaidBody PlaidIncomeGet] -> Value # toEncodingList :: [PlaidBody PlaidIncomeGet] -> Encoding #
ToJSON (PlaidBody PlaidIdentityGet) Source #
Instance details Defined in Data.Api.Types Methods toJSON :: PlaidBody PlaidIdentityGet -> Value # toEncoding :: PlaidBody PlaidIdentityGet -> Encoding # toJSONList :: [PlaidBody PlaidIdentityGet] -> Value # toEncodingList :: [PlaidBody PlaidIdentityGet] -> Encoding #
ToJSON (PlaidBody PlaidTransactionsGet) Source #
Instance details Defined in Data.Api.Types Methods toJSON :: PlaidBody PlaidTransactionsGet -> Value # toEncoding :: PlaidBody PlaidTransactionsGet -> Encoding # toJSONList :: [PlaidBody PlaidTransactionsGet] -> Value # toEncodingList :: [PlaidBody PlaidTransactionsGet] -> Encoding #
ToJSON (PlaidBody PlaidTokenExchange) Source #
Instance details Defined in Data.Api.Types Methods toJSON :: PlaidBody PlaidTokenExchange -> Value # toEncoding :: PlaidBody PlaidTokenExchange -> Encoding # toJSONList :: [PlaidBody PlaidTokenExchange] -> Value # toEncodingList :: [PlaidBody PlaidTokenExchange] -> Encoding #
ToJSON (PlaidBody PublicTokenCreate) Source #
Instance details Defined in Data.Api.Types Methods toJSON :: PlaidBody PublicTokenCreate -> Value # toEncoding :: PlaidBody PublicTokenCreate -> Encoding # toJSONList :: [PlaidBody PublicTokenCreate] -> Value # toEncodingList :: [PlaidBody PublicTokenCreate] -> Encoding #
ToJSON (PlaidBody GetBalance) Source #
Instance details Defined in Data.Api.Types Methods toJSON :: PlaidBody GetBalance -> Value # toEncoding :: PlaidBody GetBalance -> Encoding # toJSONList :: [PlaidBody GetBalance] -> Value # toEncodingList :: [PlaidBody GetBalance] -> Encoding #
ToJSON (PlaidBody AuthGet) Source #
Instance details Defined in Data.Api.Types Methods toJSON :: PlaidBody AuthGet -> Value # toEncoding :: PlaidBody AuthGet -> Encoding # toJSONList :: [PlaidBody AuthGet] -> Value # toEncodingList :: [PlaidBody AuthGet] -> Encoding #

data CurrencyCode Source #

Constructors

USD
EUR

Instances

Eq CurrencyCode Source #
Instance details Defined in Data.Api.Types Methods (==) :: CurrencyCode -> CurrencyCode -> Bool # (/=) :: CurrencyCode -> CurrencyCode -> Bool #
Show CurrencyCode Source #
Instance details Defined in Data.Api.Types Methods showsPrec :: Int -> CurrencyCode -> ShowS # show :: CurrencyCode -> String # showList :: [CurrencyCode] -> ShowS #
ToJSON CurrencyCode Source #
Instance details Defined in Data.Api.Types Methods toJSON :: CurrencyCode -> Value # toEncoding :: CurrencyCode -> Encoding # toJSONList :: [CurrencyCode] -> Value # toEncodingList :: [CurrencyCode] -> Encoding #
FromJSON CurrencyCode Source #
Instance details Defined in Data.Api.Types Methods parseJSON :: Value -> Parser CurrencyCode # parseJSONList :: Value -> Parser [CurrencyCode] #

unPlaidTest :: PlaidTest a -> Identity a Source #

unPlaid :: Plaid a -> ReaderT PlaidEnv IO a Source #

plaidBodyAccessToken :: forall a a. Lens (PlaidBody a) (PlaidBody a) (Maybe AccessToken) (Maybe AccessToken) Source #

plaidBodyEndDate :: forall a a. Lens (PlaidBody a) (PlaidBody a) (Maybe Day) (Maybe Day) Source #

plaidBodyEnv :: forall a a. Lens (PlaidBody a) (PlaidBody a) PlaidEnv PlaidEnv Source #

plaidBodyInitialProducts :: forall a a. Lens (PlaidBody a) (PlaidBody a) (Maybe [PlaidProduct]) (Maybe [PlaidProduct]) Source #

plaidBodyInstitutionId :: forall a a. Lens (PlaidBody a) (PlaidBody a) (Maybe InstitutionId) (Maybe InstitutionId) Source #

plaidBodyOptions :: forall a a. Lens (PlaidBody a) (PlaidBody a) (Maybe PlaidOptions) (Maybe PlaidOptions) Source #

plaidBodyPaginationOptions :: forall a a. Lens (PlaidBody a) (PlaidBody a) (Maybe PlaidPaginationOptions) (Maybe PlaidPaginationOptions) Source #

plaidBodyPublicToken :: forall a a. Lens (PlaidBody a) (PlaidBody a) (Maybe PublicToken) (Maybe PublicToken) Source #

plaidBodyStartDate :: forall a a. Lens (PlaidBody a) (PlaidBody a) (Maybe Day) (Maybe Day) Source #

runPlaid :: PlaidEnv -> Plaid a -> IO a Source #

data Balance Source #

Constructors

Balance
Fields balanceAvailable :: Double balanceCurrent :: Double balanceLimit :: Maybe Double balanceIsoCurrencyCode :: CurrencyCode balanceUnofficialCurrencyCode :: Maybe CurrencyCode

Instances

Eq Balance Source #
Instance details Defined in Data.Api.Types Methods (==) :: Balance -> Balance -> Bool # (/=) :: Balance -> Balance -> Bool #
Show Balance Source #
Instance details Defined in Data.Api.Types Methods showsPrec :: Int -> Balance -> ShowS # show :: Balance -> String # showList :: [Balance] -> ShowS #
ToJSON Balance Source #
Instance details Defined in Data.Api.Types Methods toJSON :: Balance -> Value # toEncoding :: Balance -> Encoding # toJSONList :: [Balance] -> Value # toEncodingList :: [Balance] -> Encoding #
FromJSON Balance Source #
Instance details Defined in Data.Api.Types Methods parseJSON :: Value -> Parser Balance # parseJSONList :: Value -> Parser [Balance] #

data Account Source #

Constructors

Account
Fields accountAccountId :: Text accountBalances :: Balance accountMask :: Text accountName :: Text accountOfficialName :: Text accountSubtype :: Text accountType :: Text

Instances

Eq Account Source #
Instance details Defined in Data.Api.Types Methods (==) :: Account -> Account -> Bool # (/=) :: Account -> Account -> Bool #
Show Account Source #
Instance details Defined in Data.Api.Types Methods showsPrec :: Int -> Account -> ShowS # show :: Account -> String # showList :: [Account] -> ShowS #
ToJSON Account Source #
Instance details Defined in Data.Api.Types Methods toJSON :: Account -> Value # toEncoding :: Account -> Encoding # toJSONList :: [Account] -> Value # toEncodingList :: [Account] -> Encoding #
FromJSON Account Source #
Instance details Defined in Data.Api.Types Methods parseJSON :: Value -> Parser Account # parseJSONList :: Value -> Parser [Account] #

data Ach Source #

Constructors

Ach
Fields achAccount :: AccountNumber achAccountId :: AccountId achRouting :: Text achWireRouting :: Text

Instances

Eq Ach Source #
Instance details Defined in Data.Api.Types Methods (==) :: Ach -> Ach -> Bool # (/=) :: Ach -> Ach -> Bool #
Show Ach Source #
Instance details Defined in Data.Api.Types Methods showsPrec :: Int -> Ach -> ShowS # show :: Ach -> String # showList :: [Ach] -> ShowS #
ToJSON Ach Source #
Instance details Defined in Data.Api.Types Methods toJSON :: Ach -> Value # toEncoding :: Ach -> Encoding # toJSONList :: [Ach] -> Value # toEncodingList :: [Ach] -> Encoding #
FromJSON Ach Source #
Instance details Defined in Data.Api.Types Methods parseJSON :: Value -> Parser Ach # parseJSONList :: Value -> Parser [Ach] #

data Error Source #

Constructors

Error
Fields errorType :: Text errorCode :: Text errorMessage :: Text displayMessage :: Maybe Text

Instances

Eq Error Source #
Instance details Defined in Data.Api.Types Methods (==) :: Error -> Error -> Bool # (/=) :: Error -> Error -> Bool #
Show Error Source #
Instance details Defined in Data.Api.Types Methods showsPrec :: Int -> Error -> ShowS # show :: Error -> String # showList :: [Error] -> ShowS #
ToJSON Error Source #
Instance details Defined in Data.Api.Types Methods toJSON :: Error -> Value # toEncoding :: Error -> Encoding # toJSONList :: [Error] -> Value # toEncodingList :: [Error] -> Encoding #
FromJSON Error Source #
Instance details Defined in Data.Api.Types Methods parseJSON :: Value -> Parser Error # parseJSONList :: Value -> Parser [Error] #

data Item Source #

Constructors

Item
Fields itemAvailableProducts :: [Text] itemBilledProducts :: [Text] itemError :: Maybe Error itemInstitutionId :: InstitutionId itemItemId :: Text itemWebhook :: Maybe Text

Instances

Eq Item Source #
Instance details Defined in Data.Api.Types Methods (==) :: Item -> Item -> Bool # (/=) :: Item -> Item -> Bool #
Show Item Source #
Instance details Defined in Data.Api.Types Methods showsPrec :: Int -> Item -> ShowS # show :: Item -> String # showList :: [Item] -> ShowS #
ToJSON Item Source #
Instance details Defined in Data.Api.Types Methods toJSON :: Item -> Value # toEncoding :: Item -> Encoding # toJSONList :: [Item] -> Value # toEncodingList :: [Item] -> Encoding #
FromJSON Item Source #
Instance details Defined in Data.Api.Types Methods parseJSON :: Value -> Parser Item # parseJSONList :: Value -> Parser [Item] #

data Eft Source #

Constructors

Eft
Fields eftAccount :: AccountNumber eftAccountId :: AccountId eftInstitution :: Institution eftBranch :: Text

Instances

Eq Eft Source #
Instance details Defined in Data.Api.Types Methods (==) :: Eft -> Eft -> Bool # (/=) :: Eft -> Eft -> Bool #
Show Eft Source #
Instance details Defined in Data.Api.Types Methods showsPrec :: Int -> Eft -> ShowS # show :: Eft -> String # showList :: [Eft] -> ShowS #
ToJSON Eft Source #
Instance details Defined in Data.Api.Types Methods toJSON :: Eft -> Value # toEncoding :: Eft -> Encoding # toJSONList :: [Eft] -> Value # toEncodingList :: [Eft] -> Encoding #
FromJSON Eft Source #
Instance details Defined in Data.Api.Types Methods parseJSON :: Value -> Parser Eft # parseJSONList :: Value -> Parser [Eft] #

data International Source #

Constructors

International
Fields internationalAccountId :: AccountId internationalBic :: Bic internationalIban :: Iban

Instances

Eq International Source #
Instance details Defined in Data.Api.Types Methods (==) :: International -> International -> Bool # (/=) :: International -> International -> Bool #
Show International Source #
Instance details Defined in Data.Api.Types Methods showsPrec :: Int -> International -> ShowS # show :: International -> String # showList :: [International] -> ShowS #
ToJSON International Source #
Instance details Defined in Data.Api.Types Methods toJSON :: International -> Value # toEncoding :: International -> Encoding # toJSONList :: [International] -> Value # toEncodingList :: [International] -> Encoding #
FromJSON International Source #
Instance details Defined in Data.Api.Types Methods parseJSON :: Value -> Parser International # parseJSONList :: Value -> Parser [International] #

data Bacs Source #

Constructors

Bacs
Fields bacsAccount :: AccountNumber bacsAccountId :: AccountId bacsSortCode :: SortCode

Instances

Eq Bacs Source #
Instance details Defined in Data.Api.Types Methods (==) :: Bacs -> Bacs -> Bool # (/=) :: Bacs -> Bacs -> Bool #
Show Bacs Source #
Instance details Defined in Data.Api.Types Methods showsPrec :: Int -> Bacs -> ShowS # show :: Bacs -> String # showList :: [Bacs] -> ShowS #
ToJSON Bacs Source #
Instance details Defined in Data.Api.Types Methods toJSON :: Bacs -> Value # toEncoding :: Bacs -> Encoding # toJSONList :: [Bacs] -> Value # toEncodingList :: [Bacs] -> Encoding #
FromJSON Bacs Source #
Instance details Defined in Data.Api.Types Methods parseJSON :: Value -> Parser Bacs # parseJSONList :: Value -> Parser [Bacs] #

data Numbers Source #

Constructors

Numbers
Fields numbersAch :: [Ach] numbersEft :: [Eft] numbersInternational :: [International] numbersBacs :: [Bacs]

Instances

Eq Numbers Source #
Instance details Defined in Data.Api.Types Methods (==) :: Numbers -> Numbers -> Bool # (/=) :: Numbers -> Numbers -> Bool #
Show Numbers Source #
Instance details Defined in Data.Api.Types Methods showsPrec :: Int -> Numbers -> ShowS # show :: Numbers -> String # showList :: [Numbers] -> ShowS #
ToJSON Numbers Source #
Instance details Defined in Data.Api.Types Methods toJSON :: Numbers -> Value # toEncoding :: Numbers -> Encoding # toJSONList :: [Numbers] -> Value # toEncodingList :: [Numbers] -> Encoding #
FromJSON Numbers Source #
Instance details Defined in Data.Api.Types Methods parseJSON :: Value -> Parser Numbers # parseJSONList :: Value -> Parser [Numbers] #

data TransactionLocation Source #

Instances

Eq TransactionLocation Source #
Instance details Defined in Data.Api.Types Methods (==) :: TransactionLocation -> TransactionLocation -> Bool # (/=) :: TransactionLocation -> TransactionLocation -> Bool #
Show TransactionLocation Source #
Instance details Defined in Data.Api.Types Methods showsPrec :: Int -> TransactionLocation -> ShowS # show :: TransactionLocation -> String # showList :: [TransactionLocation] -> ShowS #
ToJSON TransactionLocation Source #
Instance details Defined in Data.Api.Types Methods toJSON :: TransactionLocation -> Value # toEncoding :: TransactionLocation -> Encoding # toJSONList :: [TransactionLocation] -> Value # toEncodingList :: [TransactionLocation] -> Encoding #
FromJSON TransactionLocation Source #
Instance details Defined in Data.Api.Types Methods parseJSON :: Value -> Parser TransactionLocation # parseJSONList :: Value -> Parser [TransactionLocation] #

data TransactionType Source #

Constructors

Digital
Place
Special
Unresolved

Instances

Eq TransactionType Source #
Instance details Defined in Data.Api.Types Methods (==) :: TransactionType -> TransactionType -> Bool # (/=) :: TransactionType -> TransactionType -> Bool #
Show TransactionType Source #
Instance details Defined in Data.Api.Types Methods showsPrec :: Int -> TransactionType -> ShowS # show :: TransactionType -> String # showList :: [TransactionType] -> ShowS #
ToJSON TransactionType Source #
Instance details Defined in Data.Api.Types Methods toJSON :: TransactionType -> Value # toEncoding :: TransactionType -> Encoding # toJSONList :: [TransactionType] -> Value # toEncodingList :: [TransactionType] -> Encoding #
FromJSON TransactionType Source #
Instance details Defined in Data.Api.Types Methods parseJSON :: Value -> Parser TransactionType # parseJSONList :: Value -> Parser [TransactionType] #

data PaymentMeta Source #

Constructors

PaymentMeta
Fields paymentMetaReferenceNumber :: Maybe Text paymentMetaPpdId :: Maybe Text paymentMetaPayee :: Maybe Text

Instances

Eq PaymentMeta Source #
Instance details Defined in Data.Api.Types Methods (==) :: PaymentMeta -> PaymentMeta -> Bool # (/=) :: PaymentMeta -> PaymentMeta -> Bool #
Show PaymentMeta Source #
Instance details Defined in Data.Api.Types Methods showsPrec :: Int -> PaymentMeta -> ShowS # show :: PaymentMeta -> String # showList :: [PaymentMeta] -> ShowS #
ToJSON PaymentMeta Source #
Instance details Defined in Data.Api.Types Methods toJSON :: PaymentMeta -> Value # toEncoding :: PaymentMeta -> Encoding # toJSONList :: [PaymentMeta] -> Value # toEncodingList :: [PaymentMeta] -> Encoding #
FromJSON PaymentMeta Source #
Instance details Defined in Data.Api.Types Methods parseJSON :: Value -> Parser PaymentMeta # parseJSONList :: Value -> Parser [PaymentMeta] #

data Transaction Source #

Instances

Eq Transaction Source #
Instance details Defined in Data.Api.Types Methods (==) :: Transaction -> Transaction -> Bool # (/=) :: Transaction -> Transaction -> Bool #
Show Transaction Source #
Instance details Defined in Data.Api.Types Methods showsPrec :: Int -> Transaction -> ShowS # show :: Transaction -> String # showList :: [Transaction] -> ShowS #
ToJSON Transaction Source #
Instance details Defined in Data.Api.Types Methods toJSON :: Transaction -> Value # toEncoding :: Transaction -> Encoding # toJSONList :: [Transaction] -> Value # toEncodingList :: [Transaction] -> Encoding #
FromJSON Transaction Source #
Instance details Defined in Data.Api.Types Methods parseJSON :: Value -> Parser Transaction # parseJSONList :: Value -> Parser [Transaction] #

data PlaidTransactionsGetResponse Source #

Constructors

PlaidTransactionsGetResponse
Fields _plaidTransactionsGetResponseAccounts :: [Account] _plaidTransactionsGetResponseTransactions :: [Transaction] _plaidTransactionsItem :: Item _plaidTransactionsTotalTransactions :: Int _plaidTransactionsRequestId :: Text

Instances

Eq PlaidTransactionsGetResponse Source #
Instance details Defined in Data.Api.Types Methods (==) :: PlaidTransactionsGetResponse -> PlaidTransactionsGetResponse -> Bool # (/=) :: PlaidTransactionsGetResponse -> PlaidTransactionsGetResponse -> Bool #
Show PlaidTransactionsGetResponse Source #
Instance details Defined in Data.Api.Types Methods showsPrec :: Int -> PlaidTransactionsGetResponse -> ShowS # show :: PlaidTransactionsGetResponse -> String # showList :: [PlaidTransactionsGetResponse] -> ShowS #
ToJSON PlaidTransactionsGetResponse Source #
Instance details Defined in Data.Api.Types Methods toJSON :: PlaidTransactionsGetResponse -> Value # toEncoding :: PlaidTransactionsGetResponse -> Encoding # toJSONList :: [PlaidTransactionsGetResponse] -> Value # toEncodingList :: [PlaidTransactionsGetResponse] -> Encoding #
FromJSON PlaidTransactionsGetResponse Source #
Instance details Defined in Data.Api.Types Methods parseJSON :: Value -> Parser PlaidTransactionsGetResponse # parseJSONList :: Value -> Parser [PlaidTransactionsGetResponse] #

plaidTransactionsGetResponseAccounts :: Lens' PlaidTransactionsGetResponse [Account] Source #

plaidTransactionsGetResponseTransactions :: Lens' PlaidTransactionsGetResponse [Transaction] Source #

plaidTransactionsItem :: Lens' PlaidTransactionsGetResponse Item Source #

plaidTransactionsRequestId :: Lens' PlaidTransactionsGetResponse Text Source #

plaidTransactionsTotalTransactions :: Lens' PlaidTransactionsGetResponse Int Source #

data PlaidAuthGetResponse Source #

Constructors

PlaidAuthGetResponse
Fields _plaidAuthGetResponseAccounts :: [Account] _plaidAuthGetResponseNumbers :: Numbers _plaidAuthGetResponseItem :: Item _plaidAuthGetResponseRequestId :: RequestId

Instances

Eq PlaidAuthGetResponse Source #
Instance details Defined in Data.Api.Types Methods (==) :: PlaidAuthGetResponse -> PlaidAuthGetResponse -> Bool # (/=) :: PlaidAuthGetResponse -> PlaidAuthGetResponse -> Bool #
Show PlaidAuthGetResponse Source #
Instance details Defined in Data.Api.Types Methods showsPrec :: Int -> PlaidAuthGetResponse -> ShowS # show :: PlaidAuthGetResponse -> String # showList :: [PlaidAuthGetResponse] -> ShowS #
ToJSON PlaidAuthGetResponse Source #
Instance details Defined in Data.Api.Types Methods toJSON :: PlaidAuthGetResponse -> Value # toEncoding :: PlaidAuthGetResponse -> Encoding # toJSONList :: [PlaidAuthGetResponse] -> Value # toEncodingList :: [PlaidAuthGetResponse] -> Encoding #
FromJSON PlaidAuthGetResponse Source #
Instance details Defined in Data.Api.Types Methods parseJSON :: Value -> Parser PlaidAuthGetResponse # parseJSONList :: Value -> Parser [PlaidAuthGetResponse] #

plaidAuthGetResponseAccounts :: Lens' PlaidAuthGetResponse [Account] Source #

plaidAuthGetResponseItem :: Lens' PlaidAuthGetResponse Item Source #

plaidAuthGetResponseNumbers :: Lens' PlaidAuthGetResponse Numbers Source #

plaidAuthGetResponseRequestId :: Lens' PlaidAuthGetResponse RequestId Source #

data PlaidPublicTokenResponse Source #

Constructors

PlaidPublicTokenResponse
Fields _plaidPublicTokenResponsePublicToken :: PublicToken _plaidPublicTokenResponseRequestId :: Text

Instances

Eq PlaidPublicTokenResponse Source #
Instance details Defined in Data.Api.Types Methods (==) :: PlaidPublicTokenResponse -> PlaidPublicTokenResponse -> Bool # (/=) :: PlaidPublicTokenResponse -> PlaidPublicTokenResponse -> Bool #
Show PlaidPublicTokenResponse Source #
Instance details Defined in Data.Api.Types Methods showsPrec :: Int -> PlaidPublicTokenResponse -> ShowS # show :: PlaidPublicTokenResponse -> String # showList :: [PlaidPublicTokenResponse] -> ShowS #
ToJSON PlaidPublicTokenResponse Source #
Instance details Defined in Data.Api.Types Methods toJSON :: PlaidPublicTokenResponse -> Value # toEncoding :: PlaidPublicTokenResponse -> Encoding # toJSONList :: [PlaidPublicTokenResponse] -> Value # toEncodingList :: [PlaidPublicTokenResponse] -> Encoding #
FromJSON PlaidPublicTokenResponse Source #
Instance details Defined in Data.Api.Types Methods parseJSON :: Value -> Parser PlaidPublicTokenResponse # parseJSONList :: Value -> Parser [PlaidPublicTokenResponse] #

data PlaidAccessTokenResponse Source #

Constructors

PlaidAccessTokenResponse
Fields _plaidAccessTokenResponseAccessToken :: AccessToken _plaidAccessTokenResponseRequestId :: Text _plaidAccessTokenResponseItemId :: Text

Instances

Eq PlaidAccessTokenResponse Source #
Instance details Defined in Data.Api.Types Methods (==) :: PlaidAccessTokenResponse -> PlaidAccessTokenResponse -> Bool # (/=) :: PlaidAccessTokenResponse -> PlaidAccessTokenResponse -> Bool #
Show PlaidAccessTokenResponse Source #
Instance details Defined in Data.Api.Types Methods showsPrec :: Int -> PlaidAccessTokenResponse -> ShowS # show :: PlaidAccessTokenResponse -> String # showList :: [PlaidAccessTokenResponse] -> ShowS #
ToJSON PlaidAccessTokenResponse Source #
Instance details Defined in Data.Api.Types Methods toJSON :: PlaidAccessTokenResponse -> Value # toEncoding :: PlaidAccessTokenResponse -> Encoding # toJSONList :: [PlaidAccessTokenResponse] -> Value # toEncodingList :: [PlaidAccessTokenResponse] -> Encoding #
FromJSON PlaidAccessTokenResponse Source #
Instance details Defined in Data.Api.Types Methods parseJSON :: Value -> Parser PlaidAccessTokenResponse # parseJSONList :: Value -> Parser [PlaidAccessTokenResponse] #

plaidPublicTokenResponsePublicToken :: Lens' PlaidPublicTokenResponse PublicToken Source #

plaidPublicTokenResponseRequestId :: Lens' PlaidPublicTokenResponse Text Source #

data PhoneNumber Source #

Constructors

PhoneNumber
Fields _phoneNumberData :: Text _phoneNumberPrimary :: Bool _phoneNumberType :: Text

Instances

Eq PhoneNumber Source #
Instance details Defined in Data.Api.Types Methods (==) :: PhoneNumber -> PhoneNumber -> Bool # (/=) :: PhoneNumber -> PhoneNumber -> Bool #
Show PhoneNumber Source #
Instance details Defined in Data.Api.Types Methods showsPrec :: Int -> PhoneNumber -> ShowS # show :: PhoneNumber -> String # showList :: [PhoneNumber] -> ShowS #
ToJSON PhoneNumber Source #
Instance details Defined in Data.Api.Types Methods toJSON :: PhoneNumber -> Value # toEncoding :: PhoneNumber -> Encoding # toJSONList :: [PhoneNumber] -> Value # toEncodingList :: [PhoneNumber] -> Encoding #
FromJSON PhoneNumber Source #
Instance details Defined in Data.Api.Types Methods parseJSON :: Value -> Parser PhoneNumber # parseJSONList :: Value -> Parser [PhoneNumber] #

plaidAccessTokenResponseAccessToken :: Lens' PlaidAccessTokenResponse AccessToken Source #

plaidAccessTokenResponseItemId :: Lens' PlaidAccessTokenResponse Text Source #

plaidAccessTokenResponseRequestId :: Lens' PlaidAccessTokenResponse Text Source #

phoneNumberData :: Lens' PhoneNumber Text Source #

phoneNumberPrimary :: Lens' PhoneNumber Bool Source #

phoneNumberType :: Lens' PhoneNumber Text Source #

data Email Source #

Constructors

Email
Fields _emailData :: Text _emailPrimary :: Bool _emailType :: Text

Instances

Eq Email Source #
Instance details Defined in Data.Api.Types Methods (==) :: Email -> Email -> Bool # (/=) :: Email -> Email -> Bool #
Show Email Source #
Instance details Defined in Data.Api.Types Methods showsPrec :: Int -> Email -> ShowS # show :: Email -> String # showList :: [Email] -> ShowS #
ToJSON Email Source #
Instance details Defined in Data.Api.Types Methods toJSON :: Email -> Value # toEncoding :: Email -> Encoding # toJSONList :: [Email] -> Value # toEncodingList :: [Email] -> Encoding #
FromJSON Email Source #
Instance details Defined in Data.Api.Types Methods parseJSON :: Value -> Parser Email # parseJSONList :: Value -> Parser [Email] #

emailData :: Lens' Email Text Source #

emailPrimary :: Lens' Email Bool Source #

emailType :: Lens' Email Text Source #

data Address Source #

Constructors

Address
Fields _addressCity :: Text _addressRegion :: Text _addressStreet :: Text _addressPostalCode :: Text _addressCountry :: Maybe Text

Instances

Eq Address Source #
Instance details Defined in Data.Api.Types Methods (==) :: Address -> Address -> Bool # (/=) :: Address -> Address -> Bool #
Show Address Source #
Instance details Defined in Data.Api.Types Methods showsPrec :: Int -> Address -> ShowS # show :: Address -> String # showList :: [Address] -> ShowS #
ToJSON Address Source #
Instance details Defined in Data.Api.Types Methods toJSON :: Address -> Value # toEncoding :: Address -> Encoding # toJSONList :: [Address] -> Value # toEncodingList :: [Address] -> Encoding #
FromJSON Address Source #
Instance details Defined in Data.Api.Types Methods parseJSON :: Value -> Parser Address # parseJSONList :: Value -> Parser [Address] #

addressCity :: Lens' Address Text Source #

addressCountry :: Lens' Address (Maybe Text) Source #

addressPostalCode :: Lens' Address Text Source #

addressRegion :: Lens' Address Text Source #

addressStreet :: Lens' Address Text Source #

data Addresses Source #

Constructors

Addresses
Fields _addressesData :: Address _addressesPrimary :: Bool

Instances

Eq Addresses Source #
Instance details Defined in Data.Api.Types Methods (==) :: Addresses -> Addresses -> Bool # (/=) :: Addresses -> Addresses -> Bool #
Show Addresses Source #
Instance details Defined in Data.Api.Types Methods showsPrec :: Int -> Addresses -> ShowS # show :: Addresses -> String # showList :: [Addresses] -> ShowS #
ToJSON Addresses Source #
Instance details Defined in Data.Api.Types Methods toJSON :: Addresses -> Value # toEncoding :: Addresses -> Encoding # toJSONList :: [Addresses] -> Value # toEncodingList :: [Addresses] -> Encoding #
FromJSON Addresses Source #
Instance details Defined in Data.Api.Types Methods parseJSON :: Value -> Parser Addresses # parseJSONList :: Value -> Parser [Addresses] #

addressesData :: Lens' Addresses Address Source #

addressesPrimary :: Lens' Addresses Bool Source #

data Owners Source #

Constructors

Owners
Fields _ownersAddresses :: [Addresses] _ownersEmails :: [Email] _ownersNames :: [Text] _ownersPhoneNumbers :: [PhoneNumber]

Instances

Eq Owners Source #
Instance details Defined in Data.Api.Types Methods (==) :: Owners -> Owners -> Bool # (/=) :: Owners -> Owners -> Bool #
Show Owners Source #
Instance details Defined in Data.Api.Types Methods showsPrec :: Int -> Owners -> ShowS # show :: Owners -> String # showList :: [Owners] -> ShowS #
ToJSON Owners Source #
Instance details Defined in Data.Api.Types Methods toJSON :: Owners -> Value # toEncoding :: Owners -> Encoding # toJSONList :: [Owners] -> Value # toEncodingList :: [Owners] -> Encoding #
FromJSON Owners Source #
Instance details Defined in Data.Api.Types Methods parseJSON :: Value -> Parser Owners # parseJSONList :: Value -> Parser [Owners] #

ownersAddresses :: Lens' Owners [Addresses] Source #

ownersEmails :: Lens' Owners [Email] Source #

ownersNames :: Lens' Owners [Text] Source #

ownersPhoneNumbers :: Lens' Owners [PhoneNumber] Source #

data Accounts Source #

Constructors

Accounts
Fields _accountsAccountId :: Text _accountsBalances :: Balance _accountsMask :: Text _accountsName :: Text _accountsOfficialName :: Maybe Text _accountsOwners :: [Owners] _accountsSubtype :: Text _accountsType :: Text

Instances

Eq Accounts Source #
Instance details Defined in Data.Api.Types Methods (==) :: Accounts -> Accounts -> Bool # (/=) :: Accounts -> Accounts -> Bool #
Show Accounts Source #
Instance details Defined in Data.Api.Types Methods showsPrec :: Int -> Accounts -> ShowS # show :: Accounts -> String # showList :: [Accounts] -> ShowS #
ToJSON Accounts Source #
Instance details Defined in Data.Api.Types Methods toJSON :: Accounts -> Value # toEncoding :: Accounts -> Encoding # toJSONList :: [Accounts] -> Value # toEncodingList :: [Accounts] -> Encoding #
FromJSON Accounts Source #
Instance details Defined in Data.Api.Types Methods parseJSON :: Value -> Parser Accounts # parseJSONList :: Value -> Parser [Accounts] #

data PlaidIdentityGetResponse Source #

Constructors

PlaidIdentityGetResponse
Fields _plaidIdentityGetResponseAccounts :: [Accounts] _plaidIdentityGetItem :: Item _plaidIdentityGetRequestId :: Text

Instances

Eq PlaidIdentityGetResponse Source #
Instance details Defined in Data.Api.Types Methods (==) :: PlaidIdentityGetResponse -> PlaidIdentityGetResponse -> Bool # (/=) :: PlaidIdentityGetResponse -> PlaidIdentityGetResponse -> Bool #
Show PlaidIdentityGetResponse Source #
Instance details Defined in Data.Api.Types Methods showsPrec :: Int -> PlaidIdentityGetResponse -> ShowS # show :: PlaidIdentityGetResponse -> String # showList :: [PlaidIdentityGetResponse] -> ShowS #
ToJSON PlaidIdentityGetResponse Source #
Instance details Defined in Data.Api.Types Methods toJSON :: PlaidIdentityGetResponse -> Value # toEncoding :: PlaidIdentityGetResponse -> Encoding # toJSONList :: [PlaidIdentityGetResponse] -> Value # toEncodingList :: [PlaidIdentityGetResponse] -> Encoding #
FromJSON PlaidIdentityGetResponse Source #
Instance details Defined in Data.Api.Types Methods parseJSON :: Value -> Parser PlaidIdentityGetResponse # parseJSONList :: Value -> Parser [PlaidIdentityGetResponse] #

plaidIdentityGetItem :: Lens' PlaidIdentityGetResponse Item Source #

plaidIdentityGetRequestId :: Lens' PlaidIdentityGetResponse Text Source #

plaidIdentityGetResponseAccounts :: Lens' PlaidIdentityGetResponse [Accounts] Source #

data IncomeStream Source #

Constructors

IncomeStream
Fields _incomeStreamMonthlyIncome :: Fixed E2 _incomeStreamConfidence :: Fixed E2 _incomeStreamDays :: Fixed E2 _incomeStreamName :: Text

Instances

Eq IncomeStream Source #
Instance details Defined in Data.Api.Types Methods (==) :: IncomeStream -> IncomeStream -> Bool # (/=) :: IncomeStream -> IncomeStream -> Bool #
Show IncomeStream Source #
Instance details Defined in Data.Api.Types Methods showsPrec :: Int -> IncomeStream -> ShowS # show :: IncomeStream -> String # showList :: [IncomeStream] -> ShowS #
ToJSON IncomeStream Source #
Instance details Defined in Data.Api.Types Methods toJSON :: IncomeStream -> Value # toEncoding :: IncomeStream -> Encoding # toJSONList :: [IncomeStream] -> Value # toEncodingList :: [IncomeStream] -> Encoding #
FromJSON IncomeStream Source #
Instance details Defined in Data.Api.Types Methods parseJSON :: Value -> Parser IncomeStream # parseJSONList :: Value -> Parser [IncomeStream] #

incomeStreamConfidence :: Lens' IncomeStream (Fixed E2) Source #

incomeStreamDays :: Lens' IncomeStream (Fixed E2) Source #

incomeStreamMonthlyIncome :: Lens' IncomeStream (Fixed E2) Source #

incomeStreamName :: Lens' IncomeStream Text Source #

data Income Source #

Constructors

Income
Fields _incomeLastYearIncome :: Fixed E2 _incomeLastYearIncomeBeforeTax :: Fixed E2 _incomeProjectedYearlyIncome :: Fixed E2 _incomeProjectedYearlyIncomeBeforeTax :: Fixed E2 _incomeIncomeStreams :: [IncomeStream] _incomeMaxNumberOfOverlappingIncomeStreams :: Fixed E2 _incomeNumberOfIncomeStreams :: Fixed E2

Instances

Eq Income Source #
Instance details Defined in Data.Api.Types Methods (==) :: Income -> Income -> Bool # (/=) :: Income -> Income -> Bool #
Show Income Source #
Instance details Defined in Data.Api.Types Methods showsPrec :: Int -> Income -> ShowS # show :: Income -> String # showList :: [Income] -> ShowS #
ToJSON Income Source #
Instance details Defined in Data.Api.Types Methods toJSON :: Income -> Value # toEncoding :: Income -> Encoding # toJSONList :: [Income] -> Value # toEncodingList :: [Income] -> Encoding #
FromJSON Income Source #
Instance details Defined in Data.Api.Types Methods parseJSON :: Value -> Parser Income # parseJSONList :: Value -> Parser [Income] #

incomeIncomeStreams :: Lens' Income [IncomeStream] Source #

incomeLastYearIncome :: Lens' Income (Fixed E2) Source #

incomeLastYearIncomeBeforeTax :: Lens' Income (Fixed E2) Source #

incomeMaxNumberOfOverlappingIncomeStreams :: Lens' Income (Fixed E2) Source #

incomeNumberOfIncomeStreams :: Lens' Income (Fixed E2) Source #

incomeProjectedYearlyIncome :: Lens' Income (Fixed E2) Source #

incomeProjectedYearlyIncomeBeforeTax :: Lens' Income (Fixed E2) Source #

baseUrl :: Environment -> Url Environment Source #

validInstitutionIds :: [InstitutionId] Source #

TransactionLocation
Fields transactionLocationAddress :: Maybe Text transactionLocationCity :: Maybe Text transactionLocationRegion :: Maybe Text transactionLocationPostalCode :: Maybe Text transactionLocationPostalCountry :: Maybe Text transactionLocationPostalLat :: Maybe Double transactionLocationPostalLon :: Maybe Double