clearbit_proposal.go

package clearbit

type Client struct{}

func NewClient(apiKey string) (*Client, error)

type PersonQuery struct {
	// Email address to look up (required).
	Email string

	// Setting a webhook_id allows you to get a callback
	// when a person's information is not immediately available.
	// You can also subscribe to changes.
	//
	// If no WebhookID is provided, the client will use Clearbit's
	// streaming API.
	WebhookID string

	// Set to true to subscribe to changes.
	Subscribe bool
}

// EnrichPerson finds a person by their email address
// and returns detailed information about them.
func (*Client) EnrichPerson(PersonQuery) (*Person, error)

// EnrichPersonCombined finds a person by their email address
// and returns detailed information about them and their company.
func (*Client) EnrichPersonCombined(PersonQuery) (*Person, *Company, error)

type CompanyQuery struct {
	// Company's domain name to look up (required).
	Domain string

	// Setting a webhook_id allows you to get a callback
	// when a company's information is not immediately available.
	// You can also subscribe to changes.
	//
	// If no WebhookID is provided, the client will use Clearbit's
	// streaming API.
	WebhookID string
}

// EnrichCompany finds a company by its domain name
// and returns detailed information about it.
func (*Client) EnrichCompany(CompanyQuery) (*Company, error)

type ProspectQuery struct {
	// Company's domain name to look up (required).
	Domain string

	// Filters results by first or last name (case-insensitive).
	Name string

	// Filters results by one or more titles.
	Titles []string

	// Set to true to exclude email addresses from the results.
	ExcludeEmails bool
}

// Prospect finds a company by its domain name
// and returns basic information about the people working there.
func (*Client) Prospect(ProspectQuery) ([]Person, error)