PHP Class SevenShores\Hubspot\Resources\CompanyProperties

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

Public Methods

Method Description
all ( ) : Response Returns all of the company properties, including their definition.
create ( array $property ) : Response Creates a property on every company object to store a specific piece of data.
createGroup ( array $group ) : Response Create a new company property group to gather like company-level data.
delete ( string $propertyName ) : Response For a portal, delete an existing company property.
deleteGroup ( string $groupName ) : Response Delete an existing company property group.
get ( string $propertyName ) : Response Returns a JSON object representing the definition for a given company property.
getAllGroups ( boolean $includeProperties = false ) : Response Returns all of the company property groups for a given portal.
update ( string $propertyName, array $property ) : Response Update the specified company-level property. This does not update the value on a specified company, but instead changes the definition of the company property.
updateGroup ( string $groupName, array $group ) : Response Update a previously created company property group.

Method Details

all() public method

Returns all of the company properties, including their definition.
See also: http://developers.hubspot.com/docs/methods/companies/get_company_properties
public all ( ) : Response
return SevenShores\Hubspot\Http\Response

create() public method

Creates a property on every company object to store a specific piece of data.
See also: http://developers.hubspot.com/docs/methods/companies/create_company_property
public create ( array $property ) : Response
$property array
return SevenShores\Hubspot\Http\Response

createGroup() public method

Create a new company property group to gather like company-level data.
See also: http://developers.hubspot.com/docs/methods/companies/create_company_property_group
public createGroup ( array $group ) : Response
$group array Defines the group and any properties within it.
return SevenShores\Hubspot\Http\Response

delete() public method

For a portal, delete an existing company property.
See also: http://developers.hubspot.com/docs/methods/companies/delete_company_property
public delete ( string $propertyName ) : Response
$propertyName string The API name of the property that you will be deleting.
return SevenShores\Hubspot\Http\Response

deleteGroup() public method

Delete an existing company property group.
See also: http://developers.hubspot.com/docs/methods/companies/delete_company_property_group
public deleteGroup ( string $groupName ) : Response
$groupName string The API name of the property group that you will be deleting.
return SevenShores\Hubspot\Http\Response

get() public method

Returns a JSON object representing the definition for a given company property.
See also: http://developers.hubspot.com/docs/methods/companies/get_company_property
public get ( string $propertyName ) : Response
$propertyName string The API name of the property that you wish to see metadata for.
return SevenShores\Hubspot\Http\Response

getAllGroups() public method

Returns all of the company property groups for a given portal.
See also: http://developers.hubspot.com/docs/methods/companies/get_company_property_groups
public getAllGroups ( boolean $includeProperties = false ) : Response
$includeProperties boolean If true returns all of the properties for each company property group.
return SevenShores\Hubspot\Http\Response

update() public method

Update the specified company-level property. This does not update the value on a specified company, but instead changes the definition of the company property.
See also: http://developers.hubspot.com/docs/methods/companies/update_company_property
public update ( string $propertyName, array $property ) : Response
$propertyName string
$property array
return SevenShores\Hubspot\Http\Response

updateGroup() public method

Update a previously created company property group.
See also: http://developers.hubspot.com/docs/methods/companies/update_company_property_group
public updateGroup ( string $groupName, array $group ) : Response
$groupName string The API name of the property group that you will be updating.
$group array Defines the property group and any properties within it.
return SevenShores\Hubspot\Http\Response