Liking cljdoc? Tell your friends :D

salesforce.core


+token+clj

source

+version+clj

source

all-versionsclj

(all-versions)

Lists all available versions of the Salesforce REST API

Lists all available versions of the Salesforce REST API
sourceraw docstring

auth!clj

(auth! {:keys [client-id client-secret username password security-token
               login-host]})

Get security token and auth info from Salesforce config is a map in the form

  • client-id ID
  • client-secret SECRET
  • username USERNAME
  • password PASSWORD
  • security-token TOKEN
  • login-host HOSTNAME (default login.salesforce.com
Get security token and auth info from Salesforce
config is a map in the form
- client-id ID
- client-secret SECRET
- username USERNAME
- password PASSWORD
- security-token TOKEN
- login-host HOSTNAME (default login.salesforce.com
sourceraw docstring

confclj

(conf f)
source

gen-query-urlclj

(gen-query-url version query)

Given an SOQL string, i.e "SELECT name from Account" generate a Salesforce SOQL query url in the form: /services/data/v20.0/query/?q=SELECT+name+from+Account

Given an SOQL string, i.e "SELECT name from Account"
generate a Salesforce SOQL query url in the form:
/services/data/v20.0/query/?q=SELECT+name+from+Account
sourceraw docstring

latest-versionclj

(latest-version)

What is the latest API version?

What is the latest API version?
sourceraw docstring

latest-version*clj

Memoized latest-version, used by (with-latest-version) macro

Memoized latest-version, used by (with-latest-version) macro
sourceraw docstring

read-limit-infoclj

(read-limit-info)

Deref the value of the limit-info atom which is updated with each call to the API. Returns a map, containing the used and available API call counts: {:used 11 :available 15000}

Deref the value of the `limit-info` atom which is
updated with each call to the API. Returns a map,
containing the used and available API call counts:
{:used 11 :available 15000}
sourceraw docstring

requestclj

(request method url token & [params])

Make a HTTP request to the Salesforce.com REST API Token is the full map returned from (auth! @conf)

Make a HTTP request to the Salesforce.com REST API
Token is the full map returned from (auth! @conf)
sourceraw docstring

resourcesclj

(resources token)
source

set-version!clj

(set-version! v)
source

so->allclj

(so->all sobject token)

All sobjects i.e (so->all "Account" auth-info)

All sobjects i.e (so->all "Account" auth-info)
sourceraw docstring

so->createclj

(so->create sobject record token)

Create a new record

Create a new record
sourceraw docstring

so->deleteclj

(so->delete sobject identifier token)

Delete a record

  • sojbect the name of the object i.e Account
  • identifier the object id
  • token your api auth info
Delete a record
- sojbect the name of the object i.e Account
- identifier the object id
- token your api auth info
sourceraw docstring

so->describeclj

(so->describe sobject token)

Describe an SObject

Describe an SObject
sourceraw docstring

so->flowclj

(so->flow identifier token & [data])

Invoke a flow (see: https://developer.salesforce.com/docs/atlas.en-us.salesforce_vpm_guide.meta/salesforce_vpm_guide/vpm_distribute_system_rest.htm)

  • indentifier of flow (e.g. "Escalate_to_Case")
  • inputs map (e.g. {:inputs [{"CommentCount" 6 "FeedItemId" "0D5D0000000cfMY"}]})
  • token to your api auth info
Invoke a flow (see: https://developer.salesforce.com/docs/atlas.en-us.salesforce_vpm_guide.meta/salesforce_vpm_guide/vpm_distribute_system_rest.htm)
- indentifier of flow (e.g. "Escalate_to_Case")
- inputs map (e.g. {:inputs [{"CommentCount" 6
                              "FeedItemId" "0D5D0000000cfMY"}]})
- token to your api auth info
sourceraw docstring

so->getclj

(so->get sobject identifier token)
(so->get sobject identifier fields token)

Fetch a single SObject or passing in a vector of attributes return a subset of the data

Fetch a single SObject or passing in a vector of attributes
return a subset of the data
sourceraw docstring

so->objectsclj

(so->objects token)

Lists all of the available sobjects

Lists all of the available sobjects
sourceraw docstring

so->recentclj

(so->recent sobject token)

The recently created items under an sobject identifier e.g (so->recent "Account" auth-info)

The recently created items under an sobject identifier
e.g (so->recent "Account" auth-info)
sourceraw docstring

so->updateclj

(so->update sobject identifier record token)

Update a record

  • sojbect the name of the object i.e Account
  • identifier the object id
  • record map of data to update object with
  • token your api auth info
Update a record
- sojbect the name of the object i.e Account
- identifier the object id
- record map of data to update object with
- token your api auth info
sourceraw docstring

Soqlcljprotocol

soqlclj

(soql query token)

Executes an arbitrary SOQL query

Executes an arbitrary SOQL query
source

SOQLablecljprotocol

->soqlclj

(->soql value)

Serialize the value to a format that Salesforce expect

Serialize the value to a format that Salesforce expect
source

sqlvec->queryclj

(sqlvec->query [query & args])

Receives a Sql vector in the clojure java.jdbc format, for example: ["select * from fruit where appearance = ?" "rosy"]. Return a String with all the '?' set and serialized to the expected format from Salesforce using the SOQLable protocol.

Suitable to use with HugSQL sqlvec functions from hugsql.core/def-sqlvec-fns

Receives a Sql vector in the clojure java.jdbc format, for example: ["select * from fruit where appearance = ?" "rosy"].
 Return a String with all the '?' set and serialized to the expected format from Salesforce using the SOQLable protocol.

Suitable to use with HugSQL sqlvec functions from hugsql.core/def-sqlvec-fns
sourceraw docstring

with-latest-versioncljmacro

(with-latest-version & forms)
source

with-tokencljmacro

(with-token token & forms)
source

with-versioncljmacro

(with-version v & forms)
source

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close