PHP Class SevenShores\Hubspot\Resources\Workflows

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

Public Methods

Method Description
all ( ) : Response Get all workflows.
create ( array $workflow ) : Response Create a new workflow.
delete ( integer $id ) : Response Delete a workflow.
enrollContact ( integer $workflow_id, string $email ) : Response Enroll a contact in a workflow.
enrollmentsForContact ( integer $contact_id ) : Response Get current enrollments for a contact.
getById ( integer $id ) : Response Get a specific workflow.
pastEventsForContact ( integer $workflow_id, integer $contact_id, array $params = [] ) : Response Get past events for contact from a workflow.
unenrollContact ( integer $workflow_id, string $email ) : Response Unenroll a contact from a workflow.
upcomingEventsForContact ( integer $workflow_id, integer $contact_id, array $params = [] ) : Response Get upcoming (scheduled) events for a contact in a workflow.

Method Details

all() public method

Get all workflows.
public all ( ) : Response
return SevenShores\Hubspot\Http\Response

create() public method

Create a new workflow.
public create ( array $workflow ) : Response
$workflow array The workflow properties
return SevenShores\Hubspot\Http\Response

delete() public method

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

enrollContact() public method

Enroll a contact in a workflow.
public enrollContact ( integer $workflow_id, string $email ) : Response
$workflow_id integer
$email string
return SevenShores\Hubspot\Http\Response

enrollmentsForContact() public method

Get current enrollments for a contact.
public enrollmentsForContact ( integer $contact_id ) : Response
$contact_id integer
return SevenShores\Hubspot\Http\Response

getById() public method

Get a specific workflow.
public getById ( integer $id ) : Response
$id integer
return SevenShores\Hubspot\Http\Response

pastEventsForContact() public method

Get past events for contact from a workflow.
public pastEventsForContact ( integer $workflow_id, integer $contact_id, array $params = [] ) : Response
$workflow_id integer
$contact_id integer
$params array Optional parameters.
return SevenShores\Hubspot\Http\Response

unenrollContact() public method

Unenroll a contact from a workflow.
public unenrollContact ( integer $workflow_id, string $email ) : Response
$workflow_id integer
$email string
return SevenShores\Hubspot\Http\Response

upcomingEventsForContact() public method

Get upcoming (scheduled) events for a contact in a workflow.
public upcomingEventsForContact ( integer $workflow_id, integer $contact_id, array $params = [] ) : Response
$workflow_id integer
$contact_id integer
$params array
return SevenShores\Hubspot\Http\Response