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


-- | Salesforce API Client
--   
--   This package provides bindings to Salesforce API
--   <a>https://github.com/githubuser/hsforce#readme</a>
@package hsforce
@version 0.1.0.0

module HSForce.Util
defaultJsonLabelFilter :: String -> String -> String
tagText :: Content a -> String -> String
replace :: String -> String -> String -> String

module HSForce.Types
data QueryResponse a
QueryResponse :: [a] -> Int -> Bool -> QueryResponse a
[qrRecords] :: QueryResponse a -> [a]
[qrTotalSize] :: QueryResponse a -> Int
[qrDone] :: QueryResponse a -> Bool
class SObject a
typeName :: SObject a => a -> String
getSfid :: SObject a => a -> String
data DescribeResponse a
DescribeResponse :: ObjectDescribe -> [a] -> DescribeResponse a
[drObjectDescribe] :: DescribeResponse a -> ObjectDescribe
[drRecentItems] :: DescribeResponse a -> [a]
data ObjectDescribe
ObjectDescribe :: Bool -> Bool -> Bool -> Bool -> Bool -> Bool -> Bool -> Bool -> Bool -> Maybe String -> String -> String -> Bool -> Bool -> Bool -> String -> Bool -> Bool -> Bool -> Bool -> Bool -> Bool -> Bool -> Object -> ObjectDescribe
[odActivateable] :: ObjectDescribe -> Bool
[odCreateable] :: ObjectDescribe -> Bool
[odCustom] :: ObjectDescribe -> Bool
[odCustomSetting] :: ObjectDescribe -> Bool
[odDeletable] :: ObjectDescribe -> Bool
[odDeprecatedAndHidden] :: ObjectDescribe -> Bool
[odFeedEnabled] :: ObjectDescribe -> Bool
[odHasSubtypes] :: ObjectDescribe -> Bool
[odIsSubtype] :: ObjectDescribe -> Bool
[odKeyPrefix] :: ObjectDescribe -> Maybe String
[odLabel] :: ObjectDescribe -> String
[odLabelPlural] :: ObjectDescribe -> String
[odLayoutable] :: ObjectDescribe -> Bool
[odMergeable] :: ObjectDescribe -> Bool
[odMruEnabled] :: ObjectDescribe -> Bool
[odName] :: ObjectDescribe -> String
[odQueryable] :: ObjectDescribe -> Bool
[odReplicateable] :: ObjectDescribe -> Bool
[odRetrieveable] :: ObjectDescribe -> Bool
[odSearchable] :: ObjectDescribe -> Bool
[odTriggerable] :: ObjectDescribe -> Bool
[odUndeletable] :: ObjectDescribe -> Bool
[odUpdateable] :: ObjectDescribe -> Bool
[odUrls] :: ObjectDescribe -> Object
data GlobalDescribeResponse
GlobalDescribeResponse :: String -> Int -> [ObjectDescribe] -> GlobalDescribeResponse
[gdEncoding] :: GlobalDescribeResponse -> String
[gdMaxBatchSize] :: GlobalDescribeResponse -> Int
[gdSobjects] :: GlobalDescribeResponse -> [ObjectDescribe]
data DescribeDetail
DescribeDetail :: Maybe [ActionOverride] -> Maybe Bool -> Maybe [ChildRelationship] -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe [Field] -> Maybe Bool -> Maybe Bool -> Maybe String -> Maybe String -> Maybe String -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe String -> Maybe [String] -> Maybe String -> Maybe Bool -> Maybe [RecordTypeInfo] -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe [Scope] -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Object -> DescribeDetail
[ddActionOverrides] :: DescribeDetail -> Maybe [ActionOverride]
[ddActivateable] :: DescribeDetail -> Maybe Bool
[ddChildRelationships] :: DescribeDetail -> Maybe [ChildRelationship]
[ddCompactLayoutable] :: DescribeDetail -> Maybe Bool
[ddCreateable] :: DescribeDetail -> Maybe Bool
[ddCustom] :: DescribeDetail -> Maybe Bool
[ddCustomSetting] :: DescribeDetail -> Maybe Bool
[ddDeletable] :: DescribeDetail -> Maybe Bool
[ddDeprecatedAndHidden] :: DescribeDetail -> Maybe Bool
[ddFeedEnabled] :: DescribeDetail -> Maybe Bool
[ddFields] :: DescribeDetail -> Maybe [Field]
[ddHasSubtypes] :: DescribeDetail -> Maybe Bool
[ddIsSubtype] :: DescribeDetail -> Maybe Bool
[ddKeyPrefix] :: DescribeDetail -> Maybe String
[ddLabel] :: DescribeDetail -> Maybe String
[ddLabelPlural] :: DescribeDetail -> Maybe String
[ddLayoutable] :: DescribeDetail -> Maybe Bool
[ddListviewable] :: DescribeDetail -> Maybe Bool
[ddLookupLayoutable] :: DescribeDetail -> Maybe Bool
[ddMergeable] :: DescribeDetail -> Maybe Bool
[ddMruEnabled] :: DescribeDetail -> Maybe Bool
[ddName] :: DescribeDetail -> Maybe String
[ddNamedLayoutInfos] :: DescribeDetail -> Maybe [String]
[ddNetworkScopeFieldName] :: DescribeDetail -> Maybe String
[ddQueryable] :: DescribeDetail -> Maybe Bool
[ddRecordTypeInfos] :: DescribeDetail -> Maybe [RecordTypeInfo]
[ddReplicateable] :: DescribeDetail -> Maybe Bool
[ddRetrieveable] :: DescribeDetail -> Maybe Bool
[ddSearchLayoutable] :: DescribeDetail -> Maybe Bool
[ddSearchable] :: DescribeDetail -> Maybe Bool
[ddSupportedScopes] :: DescribeDetail -> Maybe [Scope]
[ddTriggerable] :: DescribeDetail -> Maybe Bool
[ddUndeletable] :: DescribeDetail -> Maybe Bool
[ddUpdateable] :: DescribeDetail -> Maybe Bool
[ddUrls] :: DescribeDetail -> Maybe Object
data ActionOverride
ActionOverride :: Maybe String -> Maybe Bool -> Maybe String -> Maybe String -> Maybe String -> ActionOverride
[aoFormFactor] :: ActionOverride -> Maybe String
[aoIsAvailableInTouch] :: ActionOverride -> Maybe Bool
[aoName] :: ActionOverride -> Maybe String
[aoPageId] :: ActionOverride -> Maybe String
[aoUrl] :: ActionOverride -> Maybe String
data ChildRelationship
ChildRelationship :: Maybe Bool -> Maybe String -> Maybe Bool -> Maybe String -> Maybe [String] -> Maybe [String] -> Maybe String -> Maybe Bool -> ChildRelationship
[crCascadeDelete] :: ChildRelationship -> Maybe Bool
[crChildSObject] :: ChildRelationship -> Maybe String
[crDeprecatedAndHidden] :: ChildRelationship -> Maybe Bool
[crField] :: ChildRelationship -> Maybe String
[crJunctionIdListNames] :: ChildRelationship -> Maybe [String]
[crJunctionReferenceTo] :: ChildRelationship -> Maybe [String]
[crRelationshipName] :: ChildRelationship -> Maybe String
[crRestrictedDelte] :: ChildRelationship -> Maybe Bool
data Field
Field :: Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Int -> Maybe Bool -> Maybe String -> Maybe Bool -> Maybe Bool -> Maybe String -> Maybe String -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe String -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Int -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe String -> Maybe Bool -> Maybe String -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe String -> Maybe String -> Maybe Int -> Maybe String -> Maybe String -> Maybe String -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe [PicklistEntry] -> Maybe Bool -> Maybe Int -> Maybe Bool -> Maybe String -> Maybe [String] -> Maybe String -> Maybe Int -> Maybe Bool -> Maybe Bool -> Maybe Int -> Maybe Bool -> Maybe String -> Maybe Bool -> Maybe String -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Field
[fAggregatable] :: Field -> Maybe Bool
[fAiPredictionField] :: Field -> Maybe Bool
[fAutoNumber] :: Field -> Maybe Bool
[fByteLength] :: Field -> Maybe Int
[fCalculated] :: Field -> Maybe Bool
[fCalculatedFormula] :: Field -> Maybe String
[fCascadeDelete] :: Field -> Maybe Bool
[fCaseSensitive] :: Field -> Maybe Bool
[fCompoundFieldName] :: Field -> Maybe String
[fControllerName] :: Field -> Maybe String
[fCreateable] :: Field -> Maybe Bool
[fCustom] :: Field -> Maybe Bool
[fDefaultValue] :: Field -> Maybe Bool
[fDefaultValueFormula] :: Field -> Maybe String
[fDefaultedOnCreate] :: Field -> Maybe Bool
[fDependentPicklist] :: Field -> Maybe Bool
[fDeprecatedAndHidden] :: Field -> Maybe Bool
[fDigits] :: Field -> Maybe Int
[fDisplayLocationInDecimal] :: Field -> Maybe Bool
[fEncrypted] :: Field -> Maybe Bool
[fExternalId] :: Field -> Maybe Bool
[fExtraTypeInfo] :: Field -> Maybe String
[fFilterable] :: Field -> Maybe Bool
[fFilteredLookupInfo] :: Field -> Maybe String
[fFormulaTreatNullNumberAsZero] :: Field -> Maybe Bool
[fGroupable] :: Field -> Maybe Bool
[fHighScaleNumber] :: Field -> Maybe Bool
[fHtmlFormatted] :: Field -> Maybe Bool
[fIdLookup] :: Field -> Maybe Bool
[fInlineHelpText] :: Field -> Maybe String
[fLabel] :: Field -> Maybe String
[fLength] :: Field -> Maybe Int
[fMask] :: Field -> Maybe String
[fMaskType] :: Field -> Maybe String
[fName] :: Field -> Maybe String
[fNameField] :: Field -> Maybe Bool
[fNamePointing] :: Field -> Maybe Bool
[fNillable] :: Field -> Maybe Bool
[fPermissionable] :: Field -> Maybe Bool
[fPicklistValues] :: Field -> Maybe [PicklistEntry]
[fPolymorphicForeignKey] :: Field -> Maybe Bool
[fPrecision] :: Field -> Maybe Int
[fQueryByDistance] :: Field -> Maybe Bool
[fReferenceTargetField] :: Field -> Maybe String
[fReferenceTo] :: Field -> Maybe [String]
[fRelationshipName] :: Field -> Maybe String
[fRelationshipOrder] :: Field -> Maybe Int
[fRestrictedDelete] :: Field -> Maybe Bool
[fRestrictedPicklist] :: Field -> Maybe Bool
[fScale] :: Field -> Maybe Int
[fSearchPrefilterable] :: Field -> Maybe Bool
[fSoapType] :: Field -> Maybe String
[fSortable] :: Field -> Maybe Bool
[fType] :: Field -> Maybe String
[fUnique] :: Field -> Maybe Bool
[fUpdateable] :: Field -> Maybe Bool
[fWriteRequiresMasterRead] :: Field -> Maybe Bool
data PicklistEntry
PicklistEntry :: Maybe String -> Maybe Bool -> Maybe Bool -> Maybe String -> Maybe String -> PicklistEntry
[peValidFor] :: PicklistEntry -> Maybe String
[peActive] :: PicklistEntry -> Maybe Bool
[peDefaultValue] :: PicklistEntry -> Maybe Bool
[peLabel] :: PicklistEntry -> Maybe String
[peValue] :: PicklistEntry -> Maybe String
data RecordTypeInfo
RecordTypeInfo :: Maybe Bool -> Maybe Bool -> Maybe String -> Maybe Bool -> Maybe String -> Maybe String -> RecordTypeInfo
[rtAvailable] :: RecordTypeInfo -> Maybe Bool
[rtDefaultRecordTypeMapping] :: RecordTypeInfo -> Maybe Bool
[rtDeveloperName] :: RecordTypeInfo -> Maybe String
[rtMaster] :: RecordTypeInfo -> Maybe Bool
[rtName] :: RecordTypeInfo -> Maybe String
[rtRecordTypeId] :: RecordTypeInfo -> Maybe String
data Scope
Scope :: Maybe String -> Maybe String -> Scope
[scopeName] :: Scope -> Maybe String
[scopeValue] :: Scope -> Maybe String
data RecordCount
RecordCount :: [SObjectCount] -> RecordCount
[rcsObjects] :: RecordCount -> [SObjectCount]
data SObjectCount
SObjectCount :: Int -> String -> SObjectCount
[scCount] :: SObjectCount -> Int
[scName] :: SObjectCount -> String
data Version
Version :: String -> String -> String -> Version
[vVersion] :: Version -> String
[vLabel] :: Version -> String
[vUrl] :: Version -> String
data BatchRequest a
BatchRequest :: String -> String -> a -> String -> String -> BatchRequest a
[brBinaryPartName] :: BatchRequest a -> String
[brMethod] :: BatchRequest a -> String
[brRichInput] :: BatchRequest a -> a
[brUrl] :: BatchRequest a -> String
[brBinaryPartNameAlias] :: BatchRequest a -> String
data Explain
Explain :: [Plan] -> [String] -> Bool -> Explain
[ePlans] :: Explain -> [Plan]
[actionOverrides] :: Explain -> [String]
[activateable] :: Explain -> Bool
data Plan
Plan :: Int -> [String] -> [Note] -> Float -> Int -> String -> Plan
[pCardinality] :: Plan -> Int
[pFields] :: Plan -> [String]
[pNotes] :: Plan -> [Note]
[pRelativeCost] :: Plan -> Float
[pSobjectCardinality] :: Plan -> Int
[pSobjectType] :: Plan -> String
data Note
Note :: String -> [String] -> String -> Note
[nDescription] :: Note -> String
[nFields] :: Note -> [String]
[nTableEnumOrId] :: Note -> String
instance Data.Aeson.Types.ToJSON.ToJSON HSForce.Types.ActionOverride
instance Data.Aeson.Types.FromJSON.FromJSON HSForce.Types.ActionOverride
instance Data.Aeson.Types.ToJSON.ToJSON HSForce.Types.Scope
instance Data.Aeson.Types.FromJSON.FromJSON HSForce.Types.Scope
instance Data.Aeson.Types.ToJSON.ToJSON HSForce.Types.RecordTypeInfo
instance Data.Aeson.Types.FromJSON.FromJSON HSForce.Types.RecordTypeInfo
instance Data.Aeson.Types.ToJSON.ToJSON HSForce.Types.ChildRelationship
instance Data.Aeson.Types.FromJSON.FromJSON HSForce.Types.ChildRelationship
instance Data.Aeson.Types.ToJSON.ToJSON HSForce.Types.PicklistEntry
instance Data.Aeson.Types.FromJSON.FromJSON HSForce.Types.PicklistEntry
instance Data.Aeson.Types.ToJSON.ToJSON HSForce.Types.Field
instance Data.Aeson.Types.FromJSON.FromJSON HSForce.Types.Field
instance Data.Aeson.Types.ToJSON.ToJSON HSForce.Types.Note
instance Data.Aeson.Types.FromJSON.FromJSON HSForce.Types.Note
instance Data.Aeson.Types.ToJSON.ToJSON HSForce.Types.Plan
instance Data.Aeson.Types.FromJSON.FromJSON HSForce.Types.Plan
instance Data.Aeson.Types.ToJSON.ToJSON HSForce.Types.Explain
instance Data.Aeson.Types.FromJSON.FromJSON HSForce.Types.Explain
instance Data.Aeson.Types.ToJSON.ToJSON a => Data.Aeson.Types.ToJSON.ToJSON (HSForce.Types.BatchRequest a)
instance Data.Aeson.Types.FromJSON.FromJSON a => Data.Aeson.Types.FromJSON.FromJSON (HSForce.Types.BatchRequest a)
instance Data.Aeson.Types.ToJSON.ToJSON HSForce.Types.Version
instance Data.Aeson.Types.FromJSON.FromJSON HSForce.Types.Version
instance Data.Aeson.Types.ToJSON.ToJSON HSForce.Types.SObjectCount
instance Data.Aeson.Types.FromJSON.FromJSON HSForce.Types.SObjectCount
instance Data.Aeson.Types.ToJSON.ToJSON HSForce.Types.RecordCount
instance Data.Aeson.Types.FromJSON.FromJSON HSForce.Types.RecordCount
instance Data.Aeson.Types.ToJSON.ToJSON HSForce.Types.GlobalDescribeResponse
instance Data.Aeson.Types.FromJSON.FromJSON HSForce.Types.GlobalDescribeResponse
instance Data.Aeson.Types.ToJSON.ToJSON HSForce.Types.DescribeDetail
instance Data.Aeson.Types.FromJSON.FromJSON HSForce.Types.DescribeDetail
instance Data.Aeson.Types.ToJSON.ToJSON HSForce.Types.ObjectDescribe
instance Data.Aeson.Types.FromJSON.FromJSON HSForce.Types.ObjectDescribe
instance Data.Aeson.Types.ToJSON.ToJSON a => Data.Aeson.Types.ToJSON.ToJSON (HSForce.Types.DescribeResponse a)
instance Data.Aeson.Types.FromJSON.FromJSON a => Data.Aeson.Types.FromJSON.FromJSON (HSForce.Types.DescribeResponse a)
instance Data.Aeson.Types.ToJSON.ToJSON a => Data.Aeson.Types.ToJSON.ToJSON (HSForce.Types.QueryResponse a)
instance Data.Aeson.Types.FromJSON.FromJSON a => Data.Aeson.Types.FromJSON.FromJSON (HSForce.Types.QueryResponse a)
instance GHC.Show.Show HSForce.Types.Explain
instance GHC.Show.Show HSForce.Types.Plan
instance GHC.Show.Show HSForce.Types.Note
instance GHC.Show.Show a => GHC.Show.Show (HSForce.Types.BatchRequest a)
instance GHC.Show.Show HSForce.Types.Version
instance GHC.Show.Show HSForce.Types.RecordCount
instance GHC.Show.Show HSForce.Types.SObjectCount
instance GHC.Show.Show HSForce.Types.DescribeDetail
instance GHC.Show.Show HSForce.Types.Scope
instance GHC.Show.Show HSForce.Types.RecordTypeInfo
instance GHC.Show.Show HSForce.Types.Field
instance GHC.Show.Show HSForce.Types.PicklistEntry
instance GHC.Show.Show HSForce.Types.ChildRelationship
instance GHC.Show.Show HSForce.Types.ActionOverride
instance GHC.Show.Show HSForce.Types.GlobalDescribeResponse
instance GHC.Show.Show a => GHC.Show.Show (HSForce.Types.DescribeResponse a)
instance GHC.Show.Show HSForce.Types.ObjectDescribe
instance GHC.Show.Show a => GHC.Show.Show (HSForce.Types.QueryResponse a)

module HSForce.Client
data SFClient
SFClient :: String -> String -> String -> Bool -> SFClient
[clientAccessToken] :: SFClient -> String
[clientInstanceUrl] :: SFClient -> String
[clientApiVersion] :: SFClient -> String
[clientDebug] :: SFClient -> Bool
data LoginRequest
LoginRequest :: Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> LoginRequest
[sfUsername] :: LoginRequest -> Maybe String
[sfPassword] :: LoginRequest -> Maybe String
[sfEndpoint] :: LoginRequest -> Maybe String
[sfVersion] :: LoginRequest -> Maybe String
[sfClientID] :: LoginRequest -> Maybe String
[sfClientSecret] :: LoginRequest -> Maybe String
defaultLoginRequest :: IO LoginRequest
login :: LoginRequest -> IO SFClient
soapLogin :: LoginRequest -> IO SFClient
restLogin :: LoginRequest -> IO SFClient
isOAuth :: LoginRequest -> Bool
requestGet :: SFClient -> String -> IO (Response ByteString)
requestDelete :: SFClient -> String -> IO (Response ByteString)
requestWithoutBody :: ByteString -> SFClient -> String -> IO (Response ByteString)
requestWithBody :: ByteString -> SFClient -> String -> String -> IO (Response ByteString)
requestPost :: SFClient -> String -> String -> IO (Response ByteString)
requestPatch :: SFClient -> String -> String -> IO (Response ByteString)
printDebug :: Show a => SFClient -> a -> IO ()
dataPath :: SFClient -> String
getText :: Value -> Text
instance Data.Aeson.Types.ToJSON.ToJSON HSForce.Client.SFClient
instance Data.Aeson.Types.FromJSON.FromJSON HSForce.Client.SFClient
instance GHC.Show.Show HSForce.Client.LoginRequest
instance GHC.Show.Show HSForce.Client.SFClient

module HSForce
login :: LoginRequest -> IO SFClient
soapLogin :: LoginRequest -> IO SFClient
restLogin :: LoginRequest -> IO SFClient
defaultLoginRequest :: IO LoginRequest
versions :: SFClient -> IO [Version]
query :: FromJSON a => SFClient -> String -> Proxy a -> IO (QueryResponse a)
queryAll :: FromJSON a => SFClient -> String -> Proxy a -> IO (QueryResponse a)
queryMore :: FromJSON a => SFClient -> String -> Proxy a -> IO (QueryResponse a)
queryAllMore :: FromJSON a => SFClient -> String -> Proxy a -> IO (QueryResponse a)
recordCount :: SFClient -> [String] -> IO RecordCount
insert :: (SObject a, ToJSON a) => SFClient -> a -> IO ()
update :: (SObject a, ToJSON a) => SFClient -> a -> IO ()
upsert :: (SObject a, ToJSON a) => SFClient -> a -> String -> String -> IO ()
delete :: (SObject a, ToJSON a) => SFClient -> a -> IO ()
describe :: FromJSON a => SFClient -> String -> Proxy a -> IO (DescribeResponse a)
describeDetail :: SFClient -> String -> IO DescribeDetail
describeGlobal :: SFClient -> IO GlobalDescribeResponse
explain :: SFClient -> String -> IO Explain
class SObject a
typeName :: SObject a => a -> String
getSfid :: SObject a => a -> String
data SFClient
SFClient :: String -> String -> String -> Bool -> SFClient
[clientAccessToken] :: SFClient -> String
[clientInstanceUrl] :: SFClient -> String
[clientApiVersion] :: SFClient -> String
[clientDebug] :: SFClient -> Bool