PHP Class SevenShores\Hubspot\Resources\ContactLists

Inheritance: extends Resource
Mostra file Open project: fungku/hubspot-php

Public Methods

Method Description
addContact ( integer $list_id, array $contact_ids ) : Response Add a contact to a list.
all ( array $params = [] ) : Response Get a set of contact lists.
contacts ( integer $id, array $params = [] ) : Response Get contacts in a list.
create ( array $list ) : Response Create a new contact list.
delete ( integer $id ) : Response Delete a contact list.
getAllDynamic ( array $params = [] ) : Response
getAllStatic ( array $params = [] ) : Response
getBatchByIds ( array $ids ) : Response
getById ( integer $id ) : Response
recentContacts ( integer $id, array $params = [] ) : Response Get recently added contact from a list.
refresh ( integer $id ) : Response Refresh a list.
removeContact ( integer $list_id, array $contact_ids ) : Response Remove a contact from a list.
update ( integer $id, array $list ) : Response Update a contact list.

Method Details

addContact() public method

Add a contact to a list.
public addContact ( integer $list_id, array $contact_ids ) : Response
$list_id integer
$contact_ids array
return SevenShores\Hubspot\Http\Response

all() public method

Get a set of contact lists.
public all ( array $params = [] ) : Response
$params array ['count', 'offset']
return SevenShores\Hubspot\Http\Response

contacts() public method

Get contacts in a list.
public contacts ( integer $id, array $params = [] ) : Response
$id integer List id
$params array Optional parameters { count, vidOffset, property, propertyMode, formSubmissionMode, showListMemberships }
return SevenShores\Hubspot\Http\Response

create() public method

Create a new contact list.
public create ( array $list ) : Response
$list array Contact list properties.
return SevenShores\Hubspot\Http\Response

delete() public method

Delete a contact list.
public delete ( integer $id ) : Response
$id integer
return SevenShores\Hubspot\Http\Response

getAllDynamic() public method

public getAllDynamic ( array $params = [] ) : Response
$params array Optional parameters ['count', 'offset']
return SevenShores\Hubspot\Http\Response

getAllStatic() public method

public getAllStatic ( array $params = [] ) : Response
$params array Optional parameters ['count', 'offset']
return SevenShores\Hubspot\Http\Response

getBatchByIds() public method

public getBatchByIds ( array $ids ) : Response
$ids array
return SevenShores\Hubspot\Http\Response

getById() public method

public getById ( integer $id ) : Response
$id integer
return SevenShores\Hubspot\Http\Response

recentContacts() public method

Get recently added contact from a list.
public recentContacts ( integer $id, array $params = [] ) : Response
$id integer List id
$params array
return SevenShores\Hubspot\Http\Response

refresh() public method

Refresh a list.
public refresh ( integer $id ) : Response
$id integer List id
return SevenShores\Hubspot\Http\Response

removeContact() public method

Remove a contact from a list.
public removeContact ( integer $list_id, array $contact_ids ) : Response
$list_id integer
$contact_ids array
return SevenShores\Hubspot\Http\Response

update() public method

Update a contact list.
public update ( integer $id, array $list ) : Response
$id integer The contact list id.
$list array The contact list properties to update.
return SevenShores\Hubspot\Http\Response