hubspotex v0.0.6 Hubspot.ContactProperties

Summary

Functions

Get all Contact properties

Create a contact property

Create a contact property group

Delete a contact property

Delete a property group

Get a Contact Property

Update a contact property

Update a property group

Functions

all()

Specs

all :: %Hubspot.HTTP.Request{body: term, endpoint: term, method: term, query: term}

Get all Contact properties.

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: http://developers.hubspot.com/docs/methods/contacts/v2/get_contacts_properties

Example

iex> Hubspot.ContactProperties.all
%Hubspot.HTTP.Request{endpoint: "/contacts/v2/properties",
  method: :get, query: [], body: ""}
create(property)

Specs

create(list) :: %Hubspot.HTTP.Request{body: term, endpoint: term, method: term, query: term}

Create a contact property.

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: http://developers.hubspot.com/docs/methods/contacts/v2/create_contacts_property

Example

iex> Hubspot.ContactProperties.create([name: "test", label: "New test", type: "string"])
%Hubspot.HTTP.Request{endpoint: "/contacts/v2/properties",
  method: :post, query: [], body: [name: "test", label: "New test", type: "string"]}
create_group(group)

Specs

create_group(list) :: %Hubspot.HTTP.Request{body: term, endpoint: term, method: term, query: term}

Create a contact property group.

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: http://developers.hubspot.com/docs/methods/contacts/v2/create_contacts_property_group

Example

iex> Hubspot.ContactProperties.create_group([name: "some_group"])
%Hubspot.HTTP.Request{endpoint: "/contacts/v2/groups",
  method: :post, query: [], body: [name: "some_group"]}
delete(name)

Specs

delete(String.t) :: %Hubspot.HTTP.Request{body: term, endpoint: term, method: term, query: term}

Delete a contact property.

For a portal, delete an existing contact property.

see: http://developers.hubspot.com/docs/methods/contacts/v2/delete_contact_property

Example

iex> Hubspot.ContactProperties.delete("some_property")
%Hubspot.HTTP.Request{endpoint: "/contacts/v2/properties/named/some_property",
  method: :delete, query: [], body: ""}
delete_group(name)

Specs

delete_group(String.t) :: %Hubspot.HTTP.Request{body: term, endpoint: term, method: term, query: term}

Delete a property group.

Delete an existing contact property group.

see: http://developers.hubspot.com/docs/methods/contacts/v2/delete_contact_property_group

Example

iex> Hubspot.ContactProperties.delete_group("test_group")
%Hubspot.HTTP.Request{endpoint: "/contacts/v2/groups/named/test_group",
  method: :delete, query: [], body: ""}
get(name)

Specs

get(String.t) :: %Hubspot.HTTP.Request{body: term, endpoint: term, method: term, query: term}

Get a Contact Property.

Returns a JSON object representing the definition for a given contact property.

see: http://developers.hubspot.com/docs/methods/companies/get_contact_property

Example

iex> Hubspot.ContactProperties.get("test")
%Hubspot.HTTP.Request{endpoint: "/contacts/v2/properties/named/test",
  method: :get, query: [], body: ""}
get_groups(include_properties \\ [includeProperties: false])

Specs

get_groups(list) :: %Hubspot.HTTP.Request{body: term, endpoint: term, method: term, query: term}

Get contact property groups.

Returns all of the contact property groups for a given portal.

see: http://developers.hubspot.com/docs/methods/contacts/v2/get_contact_property_groups

Example

iex> Hubspot.ContactProperties.get_groups
%Hubspot.HTTP.Request{endpoint: "/contacts/v2/groups",
  method: :get, query: ["includeProperties": false], body: ""}

iex> Hubspot.ContactProperties.get_groups([includeProperties: true])
%Hubspot.HTTP.Request{endpoint: "/contacts/v2/groups",
  method: :get, query: [includeProperties: true], body: ""}
update(property)

Specs

update(list) :: %Hubspot.HTTP.Request{body: term, endpoint: term, method: term, query: term}

Update a contact property.

Update a specified contact property.

see: http://developers.hubspot.com/docs/methods/contacts/v2/update_contact_property

Example

iex> Hubspot.ContactProperties.update([name: "test", description: "Cool"])
%Hubspot.HTTP.Request{endpoint: "/contacts/v2/properties/named/test",
  method: :put, query: [], body: [name: "test", description: "Cool"]}
update_group(group)

Specs

update_group(list) :: %Hubspot.HTTP.Request{body: term, endpoint: term, method: term, query: term}

Update a property group.

Update a previously created contact property group.

see: http://developers.hubspot.com/docs/methods/contacts/v2/update_contact_property_group

Example

iex> Hubspot.ContactProperties.update_group([name: "some_group", properties: [type: "string"]])
%Hubspot.HTTP.Request{endpoint: "/contacts/v2/groups/named/some_group",
  method: :put, query: [], body: [name: "some_group", properties: [type: "string"]]}