PHP Class SevenShores\Hubspot\Resources\Timeline

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

Public Methods

Method Description
createEventType ( integer $appId, string $name, string | null $headerTemplate = null, string | null $detailTemplate = null, string | null $objectType = null ) : mixed Create Timeline Event Type
createEventTypeProperty ( integer $appId, integer $eventTypeId, string $name, string $label, string $propertyType, string | null $objectProperty = null, array $options = [] ) : mixed Create Property for Timeline Event Type
createOrUpdate ( integer $appId, integer $eventTypeId, string $id, integer | null $objectId = null, string | null $email = null, string | null $utk = null, array $extraData = [], mixed $timestamp = null, array $eventTypeData = [] ) : mixed Create or Update Timeline Event
deleteEventType ( integer $appId, integer $eventTypeId ) : mixed Delete Timeline Event Type
deleteEventTypeProperty ( integer $appId, integer $eventTypeId, integer $eventTypePropertyId ) : mixed Delete Property for Timeline Event Type
getEventTypeProperties ( integer $appId, integer $eventTypeId ) : mixed Get Properties for Timeline Event Type
getEventTypes ( integer $appId ) : mixed Get Timeline Event Types
updateEventType ( integer $appId, integer $eventTypeId, string | null $name = null, string | null $headerTemplate = null, string | null $detailTemplate = null, string | null $objectType = null ) : mixed Update Timeline Event Type
updateEventTypeProperty ( integer $appId, integer $eventTypeId, integer $eventTypePropertyId, string $name, string $label, string $propertyType, array | null $options = null ) : mixed Update Property for Timeline Event Type

Method Details

createEventType() public method

Create Timeline Event Type
See also: http://developers.hubspot.com/docs/methods/timeline/create-event-type
public createEventType ( integer $appId, string $name, string | null $headerTemplate = null, string | null $detailTemplate = null, string | null $objectType = null ) : mixed
$appId integer
$name string
$headerTemplate string | null
$detailTemplate string | null
$objectType string | null
return mixed

createEventTypeProperty() public method

Create Property for Timeline Event Type
See also: http://developers.hubspot.com/docs/methods/timeline/create-timeline-event-type-property
public createEventTypeProperty ( integer $appId, integer $eventTypeId, string $name, string $label, string $propertyType, string | null $objectProperty = null, array $options = [] ) : mixed
$appId integer
$eventTypeId integer
$name string
$label string
$propertyType string
$objectProperty string | null
$options array
return mixed

createOrUpdate() public method

Create or Update Timeline Event
See also: http://developers.hubspot.com/docs/methods/timeline/create-or-update-event
public createOrUpdate ( integer $appId, integer $eventTypeId, string $id, integer | null $objectId = null, string | null $email = null, string | null $utk = null, array $extraData = [], mixed $timestamp = null, array $eventTypeData = [] ) : mixed
$appId integer
$eventTypeId integer
$id string
$objectId integer | null
$email string | null
$utk string | null
$extraData array
$timestamp mixed
$eventTypeData array
return mixed

deleteEventType() public method

Delete Timeline Event Type
See also: http://developers.hubspot.com/docs/methods/timeline/delete-event-type
public deleteEventType ( integer $appId, integer $eventTypeId ) : mixed
$appId integer
$eventTypeId integer
return mixed

deleteEventTypeProperty() public method

Delete Property for Timeline Event Type
See also: http://developers.hubspot.com/docs/methods/timeline/delete-timeline-event-type-property
public deleteEventTypeProperty ( integer $appId, integer $eventTypeId, integer $eventTypePropertyId ) : mixed
$appId integer
$eventTypeId integer
$eventTypePropertyId integer
return mixed

getEventTypeProperties() public method

Get Properties for Timeline Event Type
See also: http://developers.hubspot.com/docs/methods/timeline/get-timeline-event-type-properties
public getEventTypeProperties ( integer $appId, integer $eventTypeId ) : mixed
$appId integer
$eventTypeId integer
return mixed

getEventTypes() public method

Get Timeline Event Types
See also: http://developers.hubspot.com/docs/methods/timeline/get-event-types
public getEventTypes ( integer $appId ) : mixed
$appId integer
return mixed

updateEventType() public method

Update Timeline Event Type
See also: http://developers.hubspot.com/docs/methods/timeline/update-event-type
public updateEventType ( integer $appId, integer $eventTypeId, string | null $name = null, string | null $headerTemplate = null, string | null $detailTemplate = null, string | null $objectType = null ) : mixed
$appId integer
$eventTypeId integer
$name string | null
$headerTemplate string | null
$detailTemplate string | null
$objectType string | null
return mixed

updateEventTypeProperty() public method

Update Property for Timeline Event Type
See also: http://developers.hubspot.com/docs/methods/timeline/udpate-timeline-event-type-property
public updateEventTypeProperty ( integer $appId, integer $eventTypeId, integer $eventTypePropertyId, string $name, string $label, string $propertyType, array | null $options = null ) : mixed
$appId integer
$eventTypeId integer
$eventTypePropertyId integer
$name string
$label string
$propertyType string
$options array | null
return mixed