PHP Class SevenShores\Hubspot\Resources\ContactProperties

Inheritance: extends Resource
Datei anzeigen Open project: fungku/hubspot-php

Public Methods

Method Description
all ( ) : Response Get all Contact properties.
create ( array $property ) : Response Create a contact property.
createGroup ( array $group ) : Response Create a contact property group.
delete ( string $name ) : Response Delete a contact property.
deleteGroup ( string $name ) : Response Delete a property group.
get ( string $name ) : Response Get a Contact Property.
getGroups ( boolean $includeProperties = false ) : Response Get contact property groups.
update ( string $name, array $property ) : Response Update a contact property.
updateGroup ( string $name, array $group ) : Response Update a property group.

Method Details

all() public method

Properties in HubSpot are fields that have been created, in this case for deals in a given portal. This endpoint will return all of the contacts properties, including their definition, for a given portal.
See also: http://developers.hubspot.com/docs/methods/contacts/v2/get_contacts_properties
public all ( ) : Response
return SevenShores\Hubspot\Http\Response

create() public method

Create a property on every contact object to store a specific piece of data. In the example below, we want to store an invoice number on a separate field on deals.
See also: http://developers.hubspot.com/docs/methods/contacts/v2/create_contacts_property
public create ( array $property ) : Response
$property array
return SevenShores\Hubspot\Http\Response

createGroup() public method

Create a new contact property group to gather like contact-level data. Property groups allow you to more easily manage properties in a given portal and make contact records easier to parse for the user.
See also: http://developers.hubspot.com/docs/methods/contacts/v2/create_contacts_property_group
public createGroup ( array $group ) : Response
$group array Group properties
return SevenShores\Hubspot\Http\Response

delete() public method

For a portal, delete an existing contact property.
See also: http://developers.hubspot.com/docs/methods/contacts/v2/delete_contact_property
public delete ( string $name ) : Response
$name string
return SevenShores\Hubspot\Http\Response

deleteGroup() public method

Delete an existing contact property group.
See also: http://developers.hubspot.com/docs/methods/contacts/v2/delete_contact_property_group
public deleteGroup ( string $name ) : Response
$name string
return SevenShores\Hubspot\Http\Response

get() public method

Returns a JSON object representing the definition for a given contact property.
See also: http://developers.hubspot.com/docs/methods/companies/get_contact_property
public get ( string $name ) : Response
$name string The name of the property.
return SevenShores\Hubspot\Http\Response

getGroups() public method

Returns all of the contact property groups for a given portal.
See also: http://developers.hubspot.com/docs/methods/contacts/v2/get_contact_property_groups
public getGroups ( boolean $includeProperties = false ) : Response
$includeProperties boolean
return SevenShores\Hubspot\Http\Response

update() public method

Update a specified contact property.
See also: http://developers.hubspot.com/docs/methods/contacts/v2/update_contact_property
public update ( string $name, array $property ) : Response
$name string
$property array
return SevenShores\Hubspot\Http\Response

updateGroup() public method

Update a previously created contact property group.
See also: http://developers.hubspot.com/docs/methods/contacts/v2/update_contact_property_group
public updateGroup ( string $name, array $group ) : Response
$name string
$group array
return SevenShores\Hubspot\Http\Response