password

  my $sforce = WWW::Salesforce->new(password => 'foobar1232131');

The password is a combination of your Salesforce password and your user's Security Token <https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_concepts_security.htm>.

serverurl

  my $sforce = WWW::Salesforce->new(serverurl => 'https://login.salesforce.com');
  # or maybe one of your developer instances
  $sforce = WWW::Salesforce->new(serverurl => 'https://test.salesforce.com');

When you login to Salesforce, it's sometimes useful to login to one of your sandbox or other instances. All you need is the base URL here.

username

  my $sforce = WWW::Salesforce->new(username => 'foo@bar.com');

When you login to Salesforce, your username is necessary.

version

  my $sforce = WWW::Salesforce->new(version => '52.0');

Salesforce makes changes to their API and luckily for us, they version those changes. You can choose which API version you want to use by passing this argument. However, it must be a string.

new

  my $sforce = WWW::Salesforce->new(
    username => 'foo@bar.com',
    password => 'password' . 'security_token',
    serverurl => 'https://login.salesforce.com',
    version => '52.0'
  );

When you create a new instance, the "username" in WWW::Salesforce and "password" in WWW::Salesforce arguments are required. The others are not required. After construction, these items are not mutable.

login

  my $sforce = WWW::Salesforce->login(
    username => 'foo@bar.com',
    password => 'password' . 'security_token',
    serverurl => 'https://login.salesforce.com',
    version => '52.0'
  );

When you create a new instance, the "username" in WWW::Salesforce and "password" in WWW::Salesforce arguments are required. The others are not required. After construction, these items are not mutable.

convertLead( HASH )

Converts a Lead into an Account, Contact, or (optionally) an Opportunity

The following are the accepted input parameters:

%hash_of_array_references

    leadId => [ 2345, 5678, ],
    contactId => [ 9876, ],
    

create( HASH )

Returns a SOAP::Lite object. Success of this operation can be gleaned from the envelope result.

    $r->envelope->{Body}->{createResponse}->{result}->{success};

delete( ARRAY )

describeGlobal()

describeLayout( HASH )

type

The type of the object you wish to have described.

describeSObject( HASH )

type

The type of the object you wish to have described.

describeSObjects( type => ['Account','Contact','CustomObject__c'] )

describeTabs()

get_session_id()

get_user_id()

get_username()

getDeleted( HASH )

type

Identifies the type of the object you wish to find deletions for.

start

A string identifying the start date/time for the query

end

A string identifying the end date/time for the query

getServerTimestamp()

getUpdated( HASH )

type

Identifies the type of the object you wish to find updates for.

start

A string identifying the start date/time for the query

end

A string identifying the end date/time for the query

getUserInfo( HASH )

user

A user ID

logout()

query

  my $res = $sf->query(query => 'SELECT Id, Name FROM Account');
  $res = $sf->query(query => 'SELECT Id, Name FROM Account', limit => 20);
  # records as an array
  my @records = $res->valueof('//QueryResult/result/records');
  # number of records returned (int)
  my $number = $res->valueof('//QueryResult/result/size');
  # When our query has more results than our limit, we get paged results
  my $done = $res->valueof('//queryResponse/result/done');
  while (!$done) {
    my $locator = $res->valueof('//queryResponse/result/queryLocator');
    # use that locator for the queryMore method
  }

Executes a query <https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_calls_query.htm> against the specified object and returns data that matches the specified criteria.

The method takes in a hash with two potential keys, "query" and "limit".

The "query" key is required and should contain an SOQL <https://developer.salesforce.com/docs/atlas.en-us.soql_sosl.meta/soql_sosl/sforce_api_calls_soql.htm> query string.

The "limit" key sets the batch size, or size of the result returned. This is helpful in producing paginated results, or fetching small sets of data at a time.

queryAll( HASH )

query

The query string to use for the query. The query string takes the form of a basic SQL statement. For example, "SELECT Id,Name FROM Account".

limit

This sets the batch size, or size of the result returned. This is helpful in producing paginated results, or fetch small sets of data at a time.

queryMore( HASH )

queryLocator

The handle or string returned by "query". This identifies the result set and cursor for fetching the next set of rows from a result set.

limit

This sets the batch size, or size of the result returned. This is helpful in producing paginated results, or fetch small sets of data at a time.

resetPassword( HASH )

userId

A user Id.

retrieve( HASH )

fields

A comma delimited list of field name you want retrieved.

type

The type of the object being queried.

ids

The ids (LIST) of the object you want returned.

search( HASH )

searchString

The search string to be used in the query. For example, "find {4159017000} in phone fields returning contact(id, phone, firstname, lastname), lead(id, phone, firstname, lastname), account(id, phone, name)"

setPassword( HASH )

userId

A user Id.

password

The new password to assign to the user identified by "userId".

sf_date

update(type => $type, HASHREF [, HASHREF ...])

The hash must contain the 'Id' key in order to identify the record to update.

upsert(type => $type, key => $key, HASHREF [, HASHREF ...])

This subroutine takes as input a type value which names the type of object to update (e.g. Account, User). It also takes a key value which specifies the unique key Salesforce should use to determine if it needs to update or insert. If key is not given it will default to 'Id' which is Salesforce's own internal unique ID. This key can be any of Salesforce's default fields or an custom field marked as an external key.

Finally, this method takes one or more perl HASH references containing the fields (the keys of the hash) and the values of the record that will be updated.

describeMetadata()

retrieveMetadata

checkAsyncStatus( $pid )

checkRetrieveStatus( $pid )

getErrorDetails( RESULT )

  {
      'statusCode' => 'INVALID_FIELD_FOR_INSERT_UPDATE',
      'message' => 'Account: bad field names on insert/update call: type'
      ...
  }

bye()

Ends the session for the logged-in user issuing the call. No arguments are needed. Returns a reference to an array of hash refs

do_query( $query, [$limit] )

do_queryAll( $query, [$limit] )

get_field_list( $table_name )

get_tables()

login()

    use WWW::Salesforce;
    my $sf = WWW::Salesforce->login( 'username' => $user,'password' => $pass )
        or die $@;

search()

    my $query = 'find {4159017000} in phone fields returning contact(id, phone, ';
    $query .= 'firstname, lastname), lead(id, phone, firstname, lastname), ';
    $query .= 'account(id, phone, name)';
    my $result = $sforce->search( 'searchString' => $query );