Documentation
¶
Index ¶
- Constants
- type Autocomplete
- type AutocompleteFunc
- type Client
- type ClientOptions
- type Company
- func (c Company) BulkEnrich(ctx context.Context, params model.BulkEnrichCompanyParams) ([]model.EnrichCompanyResponse, error)
- func (c Company) Clean(ctx context.Context, params model.CleanCompanyParams) (model.CleanCompanyResponse, error)
- func (c Company) Enrich(ctx context.Context, params model.EnrichCompanyParams) (model.EnrichCompanyResponse, error)
- func (c Company) Search(ctx context.Context, params model.SearchParams) (model.SearchCompanyResponse, error)
- type IP
- type IPFunc
- type JobTitle
- type JobTitleFunc
- type Location
- type Person
- func (p Person) BulkEnrich(ctx context.Context, params model.BulkEnrichPersonParams) ([]model.BulkEnrichPersonResponse, error)
- func (p Person) BulkRetrieve(ctx context.Context, params model.BulkRetrievePersonParams) ([]model.BulkRetrievePersonResponse, error)
- func (p Person) Enrich(ctx context.Context, params model.EnrichPersonParams) (model.EnrichPersonResponse, error)
- func (p Person) Identify(ctx context.Context, params model.IdentifyPersonParams) (model.IdentifyPersonResponse, error)
- func (p Person) Retrieve(ctx context.Context, params model.RetrievePersonParams) (model.RetrievePersonResponse, error)
- func (p Person) Search(ctx context.Context, params model.SearchParams) (model.SearchPersonResponse, error)
- type School
- type Skill
- type SkillFunc
Constants ¶
const (
DefaultTimeout = 10 * time.Second
)
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Autocomplete ¶
type Autocomplete struct {
Client
}
func (Autocomplete) Autocomplete ¶
func (a Autocomplete) Autocomplete(ctx context.Context, params model.AutocompleteParams) (model.AutocompleteResponse, error)
Autocomplete allows your users to get suggestions for Search API query values along with the number of available records for each suggestion. For example, schools starting with "stanf".
type AutocompleteFunc ¶
type AutocompleteFunc func(ctx context.Context, params model.AutocompleteParams) (model.AutocompleteResponse, error)
type Client ¶
type Client struct {
ApiKey string
BaseURL string
ApiVersion string
HttpClient *http.Client
Logger logger.Logger
LibVersion string
Sandbox bool
SandboxBaseURL string
}
func NewClient ¶
func NewClient(apiKey, libVersion string, opts ...ClientOptions) Client
type ClientOptions ¶
type ClientOptions func(*Client)
type Company ¶
type Company struct {
Client
}
func (Company) BulkEnrich ¶
func (c Company) BulkEnrich(ctx context.Context, params model.BulkEnrichCompanyParams) ([]model.EnrichCompanyResponse, error)
BulkEnrich allows to enrich up to 100 companies in a single HTTP request docs: https://docs.peopledatalabs.com/docs/bulk-company-enrichment-api
func (Company) Clean ¶
func (c Company) Clean(ctx context.Context, params model.CleanCompanyParams) (model.CleanCompanyResponse, error)
Clean your company data, so you can better query our person data docs: https://docs.peopledatalabs.com/docs/cleaner-apis-reference#company-cleaner-api-companyclean-1
func (Company) Enrich ¶
func (c Company) Enrich(ctx context.Context, params model.EnrichCompanyParams) (model.EnrichCompanyResponse, error)
Enrich a company docs: https://docs.peopledatalabs.com/docs/company-enrichment-api
func (Company) Search ¶
func (c Company) Search(ctx context.Context, params model.SearchParams) (model.SearchCompanyResponse, error)
Search gives you access to every record in our full Company dataset, which you can filter and segment using a search query. docs: https://docs.peopledatalabs.com/docs/company-search-api
type JobTitle ¶
type JobTitle struct {
Client
}
func (JobTitle) JobTitle ¶
func (a JobTitle) JobTitle(ctx context.Context, params model.JobTitleParams) (model.JobTitleResponse, error)
JobTitle allows your users to get information for JobTitle values
type JobTitleFunc ¶
type JobTitleFunc func(ctx context.Context, params model.JobTitleParams) (model.JobTitleResponse, error)
type Location ¶
type Location struct {
Client
}
func (Location) Clean ¶
func (l Location) Clean(ctx context.Context, params model.CleanLocationParams) (model.CleanLocationResponse, error)
Clean your location data, so you can better query our person data docs: https://docs.peopledatalabs.com/docs/cleaner-apis-reference#location-cleaner-api-locationclean
type Person ¶
type Person struct {
Client
}
func (Person) BulkEnrich ¶
func (p Person) BulkEnrich(ctx context.Context, params model.BulkEnrichPersonParams) ([]model.BulkEnrichPersonResponse, error)
BulkEnrich allows to enrich up to 100 persons in a single HTTP request docs: https://docs.peopledatalabs.com/docs/bulk-enrichment-api
func (Person) BulkRetrieve ¶
func (p Person) BulkRetrieve(ctx context.Context, params model.BulkRetrievePersonParams) ([]model.BulkRetrievePersonResponse, error)
BulkRetrieve allows to retrieve up to 100 persons in a single HTTP request docs: https://docs.peopledatalabs.com/docs/bulk-person-retrieve
func (Person) Enrich ¶
func (p Person) Enrich(ctx context.Context, params model.EnrichPersonParams) (model.EnrichPersonResponse, error)
Enrich a person record on a variety of fields docs: https://docs.peopledatalabs.com/docs/reference-person-enrichment-api
func (Person) Identify ¶
func (p Person) Identify(ctx context.Context, params model.IdentifyPersonParams) (model.IdentifyPersonResponse, error)
Identify recovers all related profiles for an identity docs: https://docs.peopledatalabs.com/docs/identify-api
func (Person) Retrieve ¶
func (p Person) Retrieve(ctx context.Context, params model.RetrievePersonParams) (model.RetrievePersonResponse, error)
Retrieve allows you to use a PDL Person ID to return data associated with that ID docs: https://docs.peopledatalabs.com/docs/person-retrieve-api
func (Person) Search ¶
func (p Person) Search(ctx context.Context, params model.SearchParams) (model.SearchPersonResponse, error)
Search is perfect for finding specific segments of people that you need to power your projects and products. It gives you direct access to our full API dataset. docs: https://docs.peopledatalabs.com/docs/person-search-api
type School ¶
type School struct {
Client
}
func (School) Clean ¶
func (s School) Clean(ctx context.Context, params model.CleanSchoolParams) (model.CleanSchoolResponse, error)
Clean your school data, so you can better query our person data docs: https://docs.peopledatalabs.com/docs/cleaner-apis-reference#school-cleaner-api-schoolclean
type Skill ¶
type Skill struct {
Client
}
func (Skill) Skill ¶
func (a Skill) Skill(ctx context.Context, params model.SkillParams) (model.SkillResponse, error)
Skill allows your users to get information for Skill values
type SkillFunc ¶
type SkillFunc func(ctx context.Context, params model.SkillParams) (model.SkillResponse, error)
Source Files