NAME

WebService::Salesforce::REST

DESCRIPTION

Interaction with Salesforce REST API

This module uses MooseX::Log::Log4perl for logging - be sure to initialize!

ATTRIBUTES

cache

Optional.

Provided by MooseX::WithX - optionally pass a Cache::FileCache object to cache and avoid unnecessary requests

username

password

security_token

client_id

client_secret

access_token

is_sandbox

instance_url

api_version

credentials_file

timeout

Timeout in seconds. Optional. Default: 10 Will only be in effect if you allow the useragent to be built in this module.

default_backoff

Optional. Default: 10 Time in seconds to back off before retrying request. If a 429 response is given and the Retry-Time header is provided by the api this will be overridden.

default_page_size

Optional. Default: 100

retry_on_status

Optional. Default: [ 429, 500, 502, 503, 504 ] Which http response codes should we retry on?

max_tries

Optional. Default: undef

Limit maximum number of times a query should be attempted before failing. If undefined then unlimited retries

user_agent

Optional. A new LWP::UserAgent will be created for you if you don't already have one you'd like to reuse.

loglevel

Optionally override the global loglevel for this module

METHODS

refresh_access_token

Will return a valid access token.

headers

Returns a HTTP::Headers object with the Authorization header set with a valid access token

API METHODS

This is a module in development - only a subset of all of the API endpoints have been implemented yet.

version

Get versions info

https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_versions.htm

sobjects

Lists the available objects and their metadata for your organization’s data.

https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_describeGlobal.htm

sobject_describe

Completely describes the individual metadata at all levels for the specified object

https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_sobject_describe.htm

query

execute a query

COPYRIGHT

Copyright 2015, Robin Clarke

AUTHOR

Robin Clarke <robin@robinclarke.net>

Jeremy Falling <projects@falling.se>