apollo

README

Apollo conector

This connector has two ways of reading data: 1.Read 2.Search

Reading Supported Objects

- contact_stages
- account_stages
- email_accounts
- labels
- typed_custom_fields
- opportunity_stages

Searching Supported Objects:

- opportunities
- users

The following Objects works with the Search Method:

- mixed_people
- mixed_companies
- contacts
- accounts
- emailer_campaigns

The Search Endpoint has a display limit of 50,000 records. With the maximum page_size of 100 records, we can go up to 500 calls.

No object supports filterinng and retrieving data from certain points in time.

Apollo Write connector

Write Supported Objects

- accounts
- contacts
- opportunities
- 

Documentation

Index

• type Connector
  • func NewConnector(opts ...Option) (conn *Connector, outErr error)
  • func (c *Connector) HTTPClient() *common.HTTPClient
  • func (c *Connector) JSONHTTPClient() *common.JSONHTTPClient
  • func (c *Connector) ListObjectMetadata(ctx context.Context, objectNames []string) (*common.ListObjectMetadataResult, error)
  • func (c *Connector) Provider() providers.Provider
  • func (c *Connector) Read(ctx context.Context, config common.ReadParams) (*common.ReadResult, error)
  • func (c *Connector) Search(ctx context.Context, config common.ReadParams, url *urlbuilder.URL) (*common.ReadResult, error)
  • func (c *Connector) String() string
  • func (c *Connector) Write(ctx context.Context, config common.WriteParams) (*common.WriteResult, error)
• type Option
  • func WithAuthenticatedClient(client common.AuthenticatedHTTPClient) Option
  • func WithClient(ctx context.Context, client *http.Client, apiKey string, ...) Option

Types

type Connector

type Connector struct {
	BaseURL string
	Client  *common.JSONHTTPClient
}

func NewConnector

func NewConnector(opts ...Option) (conn *Connector, outErr error)

func (*Connector) HTTPClient

func (c *Connector) HTTPClient() *common.HTTPClient

func (*Connector) JSONHTTPClient

func (c *Connector) JSONHTTPClient() *common.JSONHTTPClient

JSONHTTPClient returns the underlying JSON HTTP client.

func (*Connector) ListObjectMetadata

func (c *Connector) ListObjectMetadata(ctx context.Context,
	objectNames []string,
) (*common.ListObjectMetadataResult, error)

ListObjectMetadata creates metadata of object via reading objects using Apollo API.

func (*Connector) Provider

func (c *Connector) Provider() providers.Provider

Provider returns the connector provider.

func (*Connector) Read

func (c *Connector) Read(ctx context.Context, config common.ReadParams) (*common.ReadResult, error)

Read retrieves data based on the provided configuration parameters.

This function executes a read operation using the given context and provided read parameters.

func (*Connector) Search

func (c *Connector) Search(ctx context.Context, config common.ReadParams, url *urlbuilder.URL,
) (*common.ReadResult, error)

search uses POST method to read data.It has a display limit of 50,000 records. It's recommended to filter the results so as to narrow down the results as much as possible. Most of the Filtering would need client's input so we don't exhaust calls by paging through all 50k records. Using this as is may lead to that issue.

func (*Connector) String

func (c *Connector) String() string

func (*Connector) Write

func (c *Connector) Write(ctx context.Context, config common.WriteParams) (*common.WriteResult, error)

Write creates/updates records in apolllo.

type Option

type Option = func(params *parameters)

func WithAuthenticatedClient

func WithAuthenticatedClient(client common.AuthenticatedHTTPClient) Option

func WithClient

func WithClient(
	ctx context.Context, client *http.Client,
	apiKey string,
	opts ...common.HeaderAuthClientOption,
) Option