waschick/salesforceiq

SalesforceIQ (RelateIQ) API v2 client for Laravel & standalone projects. Forked from torann/relateiq.

This package's canonical repository appears to be gone and the package has been frozen as a result.

0.2.5 2017-03-15 23:02 UTC

Requires

• php: >=5.4.0

BSD 2-Clause

• Andy Waschick

• api
• salesforce
• wrapper
• standalone
• laravel
• laravel4
• relateiq
• salesforceiq

README

About

This will help you access the SalesforceIQ REST API using PHP. The API is simple enough that you can almost do what you want with basic Curl calls... almost. But, a little sdk help sometimes makes things more pleasant. Documentation can be found here.

Installation

• SalesforceIQ Client on Packagist
• SalesforceIQ Client on GitHub
• Forked from Torann/RelateIQ

"waschick/salesforceiq": "dev-master"

You'll then need to run composer install to download it and have the autoloader updated.

Laravel Setup

Once SalesforceIQ Client is installed you need to register the service provider with the application. Open up app/config/app.php and find the providers key.

'SalesforceIQ\ServiceProvider'

There is no need to add the Facade, the package will add it for you.

Add SalesforceIQ to the Services Config

Open up app/config/services.php and add salesforceiq.

'salesforceiq' => array(
	'key'    => '66cfba7f741d645a488c0b21ebFAKE',
	'secret' => 'effd5216acac6314219ALSOFAKE',
),

SalesforceIQ Client Instance

$riq = new SalesforceIQ('66cfba7f741d645a488c0b21ebFAKE', 'effd5216acac6314219ALSOFAKE');
$contact = $riq->getContact('741d645a488c0b21eb');

For Laravel simple use the facade SalesforceIQ.

$contact = new SalesforceIQ::getContact('741d645a488c0b21eb');

Methods

Create a Contact newContact(:properties)

A POST request which creates a new Contact object and returns the created Contact with its new unique ID.

Parameters:

• :properties Attributes that are comprised of a contact object in SalesforceIQ. The following attributes are supported through the API:
  • name
  • email (Required)
  • phone
  • address
  • company
  • title
  • twitter

Example

$contact = SalesforceIQ::newContact(array(
    'name'    => 'John Doe',
    'email'   => '[e-mail]',
    'phone'   => '555-4454',
    'address' => '22 Hill Ave',
    'company' => 'Box Maker, Inc.',
    'title'   => 'Lead Taper',
    'twitter' => '@John4Boxes'
));

Get a Single Contact getContact(:id)

A GET request which pulls a specific Contact by ID, Email or Phone Number

Parameters:

• :id The identifier for the Contact to be fetched.

Example

$contact = new SalesforceIQ::getContact('741d645a488c0b21eb');

Get All Contacts getContacts()

A GET request which fetches a paginated collection of all Contacts in your Organization.

Example

$contacts = new SalesforceIQ::getContacts();

Update a Contact

A PUT request which updates the details of a specific Contact.

Example

$contact = new SalesforceIQ::getContact('741d645a488c0b21eb');
$contact->name = 'Sally Doe';
$contact->save();

Change Log

v0.1.0

• First release

v.0.2.0

• Forked from Torann/RelateIQ
• Updated Copyright
• Updated Namespaces
• Changed endpoint URL to Salesforce domain

v.0.2.1

• Removed extra namespace layer from class files

v.0.2.2

• Removed "Riq" prefix from file names and class names
• Had to change "List" to "Collection" to avoid using PHP reserved word

v.0.2.3

• Enhanced list item response parsing to generate a more friendly associative array of results by combining the raw data with the field definitions
• Added GetAllListItems($listId) function to the Client to retrieve the full contents of a specific list

v.0.2.4

• Fixed problem with retrieving proper value of list items; Salesforce IQ supplies list item definitions with an ID and display value, and then refers to the ID value, but we were incorrectly using the array index to translate. Constructed a reference array with the right values.

v.0.2.5

• Added "User" as a resource type, with the ability to retrieve the name and email of a user ID as an array.