catchdigital/salesforce_rest

There is no license information available for the latest version (0.5.4) of this package.

A Drupal module that provides RESTFUL querying capabilities to Salesforce.

0.5.4 2019-03-23 14:39 UTC

Requires

• symfony/property-access: ^4.2

Requires (Dev)

• drupal/core: ^8.0

Unknown License

• Ken Mortimer

README

Description

A Drupal module that provides RESTFUL querying capabilities to Salesforce.

Configuration

This module uses Drupal's configuration override system, the configuration is not exported and instead set at runtime. The configuration schema that is provided with this module is only intended as documentation.

The configuration must be included within the settings.php and declared as any other configuration override:

$config['rest_client']['oauth_base_uri'] = 'http://test.salesforce.com'
$config['rest_client']['oauth_username'] = ''
$config['rest_client']['oauth_password'] = ''
$config['rest_client']['oauth_client_id'] = ''
$config['rest_client']['oauth_client_secret'] = ''
$config['rest_client']['oauth_token'] = ''
$config['rest_client']['api_version'] = ''

Note: The example illustrates the complete list of configuration.

Usage

// A SELECT request query with conditionals.
$requestFactory = \Drupal::service('salesforce_rest.services.request.request_factory');
$fuzzyRequest = $requestFactory->createFuzzyRequest();

$fuzzyRequest->setType('User');
$fuzzyRequest->setFields(['Id']);
$fuzzyRequest->setConditions([
    'AND' => [
        ['field', 'operator', 'value'],
    ],
]);

$requestResponse = $fuzzyRequest->execute();

// A SELECT request query using an Id.
$requestFactory = \Drupal::service('salesforce_rest.services.request.request_factory');
$selectRequest = $requestFactory->createSelectRequest();

$selectRequest->setType('User');
$selectRequest->setId(1);
$selectRequest->setFields(['Id']);

$requestResponse = $selectRequest->execute();

// An UPDATE request query using an Id.
$requestFactory = \Drupal::service('salesforce_rest.services.request.request_factory');
$updateRequest = $requestFactory->createUpdateRequest();

$updateRequest->setType('User');
$updateRequest->setId(1);
$updateRequest->setFieldValues([
    'field' => 'value',
]);

$requestResponse = $updateRequest->execute();