PHP Class Intercom\IntercomLeads

Show file Open project: intercom/intercom-php Class Usage Examples

Public Methods

Method Description
__construct ( IntercomClient $client ) IntercomLeads constructor.
convertLead ( $options ) : mixed Converts Lead.
create ( array $options ) : mixed Creates Lead.
deleteLead ( string $id, array $options = [] ) : mixed Deletes Lead.
getLead ( string $id, array $options = [] ) : mixed Returns single Lead.
getLeads ( array $options ) : mixed Lists Leads.
leadPath ( string $id ) : string Returns endpoint path to Lead with given ID.

Method Details

__construct() public method

IntercomLeads constructor.
public __construct ( IntercomClient $client )
$client IntercomClient

convertLead() public method

Converts Lead.
See also: https://developers.intercom.io/reference#convert-a-lead
public convertLead ( $options ) : mixed
$options
return mixed

create() public method

Creates Lead.
See also: https://developers.intercom.io/reference#create-lead
public create ( array $options ) : mixed
$options array
return mixed

deleteLead() public method

Deletes Lead.
See also: https://developers.intercom.io/reference#delete-a-lead
public deleteLead ( string $id, array $options = [] ) : mixed
$id string
$options array
return mixed

getLead() public method

Returns single Lead.
See also: https://developers.intercom.io/reference#view-a-lead
public getLead ( string $id, array $options = [] ) : mixed
$id string
$options array
return mixed

getLeads() public method

Lists Leads.
See also: https://developers.intercom.io/reference#list-leads
public getLeads ( array $options ) : mixed
$options array
return mixed

leadPath() public method

Returns endpoint path to Lead with given ID.
public leadPath ( string $id ) : string
$id string
return string