/forcex

Elixir library for the Force.com / Salesforce / SFDC REST API

Primary LanguageElixirMIT LicenseMIT

Forcex

Elixir library for interacting with the Force.com REST API.

Usage

Add Forcex to you dependency list

  defp deps do
    [ {:forcex, "~> 0.0.8"}
    ]
  end

Currently, Forcex only allows for Username/Password/Client Key/Client Secret logins. This returns a bearer token, which is also stored in the state of the Forcex process. In addition, after login, Forcex will interrogate the Force.com API to determine which instance we should use and what the base endpoint URIs are for various capabilities and versions.

{:ok, pid} = Forcex.start
Forcex.login(pid, "user@example.com", "passwordTOKEN", "ClientKey", "ClientSecret")
Forcex.query(pid, "select Id, Email from Lead where Name = 'Joe Schmoe'")

Current State

See https://www.salesforce.com/us/developer/docs/api_rest/

  • List API versions available
  • Login (Username/Password/Client Key/Client Secret)
  • Login (Web Server OAuth)
  • Login (User-Agent OAuth)
  • OAuth Refresh Token
  • Resources by Version
  • Limits
  • Describe Global
  • SObject Basic Information
  • SObject Describe
  • SObject Get Deleted
  • SObject Get Updated
  • SObject Named Layouts
  • SObject Rows
  • SObject Rows by External ID
  • SObject ApprovalLayouts
  • SObject CompactLayouts
  • SObject Layouts
  • SObject Blob Retrieve
  • SObject Quick Actions
  • SObject Suggested Articles for Case
  • SObject User Password
  • AppMenu
  • Compact Layouts
  • FlexiPage
  • Process Approvals
  • Process Rules
  • Query
  • QueryAll
  • Quick Actions
  • Search
  • Search Scope and Order
  • Search Result Layouts
  • Recently Viewed Items
  • Search Suggested Article Title Matches
  • Tabs
  • Themes

License

MIT License, see LICENSE