hubspot

Documentation

Index

• Constants
• func Columns() []string
• func ContactsV1ExportWriteFiles(client *http.Client, fileprefix string, opts *ContactsListV1Opts) error
• func ContactsV3ExportWriteFiles(client *http.Client, fileprefix string, opts *ContactsListV3Opts) error
• func MustE164FormatUS(num string) string
• func NewClientAPIKey(apiKey string) *http.Client
• func NewSimpleClientAPIKey(apiKey string) httpsimple.SimpleClient
• func WriteContactsXLSX(filename string, users []scim.User) error
• type ContactsListV1Opts
  • func (opts *ContactsListV1Opts) Query() url.Values
• type ContactsListV3Opts
  • func (opts *ContactsListV3Opts) Query() url.Values
• type Paging
• type PagingNext
• type ResponsePaging

Constants

const (
	ContactsListAPIPathV3        = "/crm/v3/objects/contacts"
	ContactsListAPIPathV1        = "/contacts/v1/lists/all/contacts/all"
	ParamV3Limit                 = "limit"
	ParamV3After                 = "after"
	ParamV3Archived              = "archived"
	ParamV3Properties            = "properties"
	ParamV3PropertiesWithHistory = "propertiesWithHistory"
	ParamV3Associations          = "associations"
	ParamV1Count                 = "count"
	ParamV1VIDOffset             = "vidOffset"
	LimitMax                     = 100
)

const (
	APIKeyQueryParameter = "hapikey"
)

const ColumnsString = `First Name,Last Name,Email Address,Phone Number,Street Address,City,State,Postal Code`

Functions

func Columns

func Columns() []string

func ContactsV1ExportWriteFiles

func ContactsV1ExportWriteFiles(client *http.Client, fileprefix string, opts *ContactsListV1Opts) error

func ContactsV3ExportWriteFiles

func ContactsV3ExportWriteFiles(client *http.Client, fileprefix string, opts *ContactsListV3Opts) error

func MustE164FormatUS

func MustE164FormatUS(num string) string

func NewClientAPIKey

func NewClientAPIKey(apiKey string) *http.Client

func NewSimpleClientAPIKey

func NewSimpleClientAPIKey(apiKey string) httpsimple.SimpleClient

func WriteContactsXLSX

func WriteContactsXLSX(filename string, users []scim.User) error

Types

type ContactsListV1Opts

type ContactsListV1Opts struct {
	Count     int `url:"count"`
	VIDOffset int `url:"vidOffset"`
}

func (*ContactsListV1Opts) Query

func (opts *ContactsListV1Opts) Query() url.Values

Query generates query string values for the Contacts V3 API.

type ContactsListV3Opts

type ContactsListV3Opts struct {
	Limit                 int      `url:"limit"`
	After                 string   `url:"after"`
	Properties            []string `url:"properties"`
	PropertiesWithHistory []string `url:"propertiesWithHistory"`
	Associations          []string `url:"associations"`
	Archived              bool     `url:"archived"`
}

func (*ContactsListV3Opts) Query

func (opts *ContactsListV3Opts) Query() url.Values

Query generates query string values for the Contacts V3 API.

type Paging

type Paging struct {
	Next PagingNext `json:"next,omitempty"`
}

type PagingNext

type PagingNext struct {
	After string `json:"after,omitempty"`
	Link  string `json:"link,omitempty"`
}

type ResponsePaging

type ResponsePaging struct {
	Paging    Paging `json:"paging,omitempty"`     // V3 List Contacts API
	VIDOffset int    `json:"vid-offset,omitempty"` // V1 List Contacts API
}