person

Documentation

Index

• type BulkEnrichParams
• type BulkRetrieveParams
• type Certificate
• type Education
• type EmailAddress
• type EnrichParams
  • func (e EnrichParams) Invalid() bool
  • func (e EnrichParams) URL() string
• type Experience
• type IdentifyParams
  • func (i IdentifyParams) Invalid() bool
  • func (i IdentifyParams) URL() string
• type Language
• type Person
  • func BulkEnrich(params ...BulkEnrichParams) ([]Person, error)
  • func BulkRetrieve(params ...BulkRetrieveParams) ([]Person, error)
  • func Enrich(params EnrichParams) (*Person, error)
  • func Identify(params IdentifyParams) ([]Person, error)
  • func Retrieve(id string) (*Person, error)
  • func Search(params SearchParams) ([]Person, error)
• type PersonPreview
  • func Preview(params PreviewParams) (*PersonPreview, error)
• type PreviewParams
  • func (e PreviewParams) Invalid() bool
  • func (e PreviewParams) URL() string
• type SearchParams
  • func (s SearchParams) Invalid() bool
  • func (s SearchParams) URL() string
• type SocialLink

Types

type BulkEnrichParams

type BulkEnrichParams struct {
	Params   EnrichParams `json:"params"`
	MetaData interface{}  `json:"metadata"`
}

type BulkRetrieveParams

type BulkRetrieveParams struct {
	ID       string                 `json:"id"`
	MetaData map[string]interface{} `json:"metadata"`
}

type Certificate

type Certificate struct {
	Name         *string `json:"name"`
	Organization *string `json:"organization"`
	EndDate      *string `json:"end_date"`
	StartDate    *string `json:"start_date"`
}

type Education

type Education struct {
	Majors    []string `json:"majors"`
	EndDate   *string  `json:"end_date"`
	StartDate *string  `json:"start_date"`
	School    *struct {
		ID          *string `json:"id"`
		Name        *string `json:"name"`
		Type        *string `json:"type"`
		Domain      *string `json:"domain"`
		Website     *string `json:"website"`
		LinkedinID  *string `json:"linkedin_id"`
		LinkedinURL *string `json:"linkedin_url"`
	} `json:"school,omitempty"`
}

type EmailAddress

type EmailAddress struct {
	Type   string `json:"type"` /* personal, professional, educational, disposable */
	Name   string `json:"name"`
	Domain string `json:"domain"`
	Full   string `json:"address"`
}

type EnrichParams

type EnrichParams struct {
	Profile string
	Email   string
	LID     string
	Filter  string
	Require string
}

func (EnrichParams) Invalid

func (e EnrichParams) Invalid() bool

func (EnrichParams) URL

func (e EnrichParams) URL() string

type Experience

type Experience struct {
	Title *struct {
		Name    *string  `json:"name"`
		Role    *string  `json:"role"`
		SubRole *string  `json:"sub_role"`
		Levels  []string `json:"levels"`
	} `json:"title,omitempty"`

	EndDate   *string `json:"end_date"`
	StartDate *string `json:"start_date"`
}

type IdentifyParams

type IdentifyParams struct {
	FirstName string
	LastName  string
	Name      string
	Location  string
	Country   string
	Filter    string
	Require   string
}

func (IdentifyParams) Invalid

func (i IdentifyParams) Invalid() bool

func (IdentifyParams) URL

func (i IdentifyParams) URL() string

type Language

type Language struct {
	Name        string `json:"name"`
	Proficiency int    `json:"proficiency"`
}

type Person

type Person struct {
	ID                    string         `json:"id"`
	FirstName             *string        `json:"first_name"`
	LastName              *string        `json:"last_name"`
	FullName              *string        `json:"full_name"`
	Gender                *string        `json:"gender"`
	Age                   *int           `json:"age"`
	BirthYear             *string        `json:"birth_year"`
	BirthDate             *string        `json:"birth_date"`
	WorkEmail             *string        `json:"work_email"`
	PersonalEmails        []string       `json:"personal_emails"`
	Emails                []EmailAddress `json:"emails"`
	MobilePhone           *string        `json:"mobile_phone"`
	PhoneNumbers          []string       `json:"phone_numbers"`
	Industry              *string        `json:"industry"`
	LocationName          *string        `json:"location_name"`
	LocationLastUpdated   *string        `json:"location_last_updated"`
	LocationCountry       *string        `json:"location_country"`
	InferredExperience    *int           `json:"inferred_years_of_experience"`
	InferredSalary        *string        `json:"inferred_salary"`
	JobTitle              *string        `json:"job_title"`
	JobTitleRole          *string        `json:"job_title_role"`
	JobTitleLevels        []string       `json:"job_title_levels"`
	JobStartDate          *string        `json:"job_start_date"`
	JobCompanyName        *string        `json:"job_company_name"`
	JobCompanyURL         *string        `json:"job_company_website"`
	JobCompanyFounded     *string        `json:"job_company_founded"`
	JobCompanySize        *string        `json:"job_company_size"`
	JobCompanyLinkedinURL *string        `json:"job_company_linkedin_url"`
	JobLastUpdated        *string        `json:"job_last_updated"`
	JobSummary            *string        `json:"job_summary"`
	Skills                []string       `json:"skills"`
	Interests             []string       `json:"interests"`
	LinkedinUsername      *string        `json:"linkedin_username"`
	LinkedinURL           *string        `json:"linkedin_url"`
	LinkedinID            *string        `json:"linkedin_id"`
	LinkedinConnections   *int           `json:"linkedin_connections"`
	FacebookUsername      *string        `json:"facebook_username"`
	FacebookURL           *string        `json:"facebook_url"`
	FacebookID            *string        `json:"facebook_id"`
	TwitterUsername       *string        `json:"twitter_username"`
	TwitterURL            *string        `json:"twitter_url"`
	GithubUsername        *string        `json:"github_username"`
	GithubURL             *string        `json:"github_url"`
	Profiles              []SocialLink   `json:"profiles"`
	LinkedinSummary       *string        `json:"linkedin_summary"`
	Education             []Education    `json:"education"`
	Experience            []Experience   `json:"experience"`
	Certificates          []Certificate  `json:"certificates"`
	Languages             []Language     `json:"languages"`
}

func BulkEnrich

func BulkEnrich(params ...BulkEnrichParams) ([]Person, error)

func BulkRetrieve

func BulkRetrieve(params ...BulkRetrieveParams) ([]Person, error)

func Enrich

func Enrich(params EnrichParams) (*Person, error)

func Identify

func Identify(params IdentifyParams) ([]Person, error)

func Retrieve

func Retrieve(id string) (*Person, error)

func Search

func Search(params SearchParams) ([]Person, error)

type PersonPreview

type PersonPreview struct {
	ID             string `json:"id"`
	FirstName      string `json:"first_name"`
	LastName       string `json:"last_name"`
	FullName       string `json:"full_name"`
	JobTitle       string `json:"job_title"`
	LocationName   string `json:"location_name"`
	JobCompanyName string `json:"job_company_name"`

	Gender                bool `json:"gender"`
	Age                   bool `json:"age"`
	BirthYear             bool `json:"birth_year"`
	BirthDate             bool `json:"birth_date"`
	WorkEmail             bool `json:"work_email"`
	PersonalEmails        bool `json:"personal_emails"`
	Emails                bool `json:"emails"`
	MobilePhone           bool `json:"mobile_phone"`
	PhoneNumbers          bool `json:"phone_numbers"`
	Industry              bool `json:"industry"`
	LocationLastUpdated   bool `json:"location_last_updated"`
	LocationCountry       bool `json:"location_country"`
	InferredExperience    bool `json:"inferred_years_of_experience"`
	InferredSalary        bool `json:"inferred_salary"`
	JobTitleRole          bool `json:"job_title_role"`
	JobTitleLevels        bool `json:"job_title_levels"`
	JobStartDate          bool `json:"job_start_date"`
	JobCompanyURL         bool `json:"job_company_website"`
	JobCompanyFounded     bool `json:"job_company_founded"`
	JobCompanySize        bool `json:"job_company_size"`
	JobCompanyLinkedinURL bool `json:"job_company_linkedin_url"`
	JobLastUpdated        bool `json:"job_last_updated"`
	JobSummary            bool `json:"job_summary"`
	Skills                bool `json:"skills"`
	Interests             bool `json:"interests"`
	LinkedinUsername      bool `json:"linkedin_username"`
	LinkedinURL           bool `json:"linkedin_url"`
	LinkedinID            bool `json:"linkedin_id"`
	LinkedinConnections   bool `json:"linkedin_connections"`
	FacebookUsername      bool `json:"facebook_username"`
	FacebookURL           bool `json:"facebook_url"`
	FacebookID            bool `json:"facebook_id"`
	TwitterUsername       bool `json:"twitter_username"`
	TwitterURL            bool `json:"twitter_url"`
	GithubUsername        bool `json:"github_username"`
	GithubURL             bool `json:"github_url"`
	Profiles              bool `json:"profiles"`
	LinkedinSummary       bool `json:"linkedin_summary"`
	Education             bool `json:"education"`
	Experience            bool `json:"experience"`
	Certificates          bool `json:"certificates"`
	Languages             bool `json:"languages"`
}

func Preview

func Preview(params PreviewParams) (*PersonPreview, error)

type PreviewParams

type PreviewParams struct {
	Profile string
	Email   string
	LID     string
	Filter  string
	Require string
}

func (PreviewParams) Invalid

func (e PreviewParams) Invalid() bool

func (PreviewParams) URL

func (e PreviewParams) URL() string

type SearchParams

type SearchParams struct {
	Query string
	Size  int /* how many records to retrieve starting at From (default: 0) */
	From  int /* from which record to start */
}

func (SearchParams) Invalid

func (s SearchParams) Invalid() bool

func (SearchParams) URL

func (s SearchParams) URL() string

type SocialLink

type SocialLink struct {
	Network  string `json:"network"`
	URL      string `json:"url"`
	Username string `json:"username"`
}