pipedrive

README

Pipedrive connector

Read

Read is used to list all records of a given type. For example, if you want to list all user activities, you would use the Read method with the activities object.

Supported Objects

Below is an exhaustive list of the supported Objects in the Pipedrive deep connector with their endpoint resources(ObjectName).

Pipedrive API version : v1

Object	Resource	Method
Activities	activities	Read, Write
Activity Fields	activityFields	Read
Activity Types	activityTypes	Read, Write
Call Logs	callLogs	Read, Write
Channels	channel	Write
Currencies	currencies	Read
Deals	deals	Read, Write
Deal Fields	dealFields	Read,Write
Files	files	Read,Write
Filters	filters	Read,Write
Goals	goals	Write
Leads	leads	Read,Write
Lead Labels	leadLabels	Read,Write
Lead Sources	leadSources	Read
Legacy Teams	legacyTeams	Read,Write
Notes	notes	Read,Write
Note Fields	noteFields	Read
Organizations	organizations	Read,Write
Organization Fields	organizationFields	Read, Write
Organization Relationships	organizationRelationships	Read,Write
Permission Sets	permissionSets	Read
Persons	persons	Read,Write
Person Fields	personFields	Read,Write
Pipelines	pipelines	Read,Write
Products	products	Read,Write
Projects	projects	Write
Product Fields	productFields	Read,Write
Roles	roles	Read,Write
Stages	stages	Read,Write
Tasks	tasks	Write
Users	users	Read,Write
User Connections	userConnections	Read
User Settings	userSettings	Read
Webhooks	webhooks	Read,Write

Documentation

Index

• Variables
• 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) 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, config *oauth2.Config, ...) Option

Variables

var ObjectNameToResponseField = datautils.NewDefaultMap(map[string]string{},
	func(key string) string {
		return key
	},
)

ObjectNameToResponseField maps ObjectName to the response field name which contains that object.

Types

type Connector

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

Connector represents the Pipedrive Connector.

func NewConnector

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

NewConnector constructs the Pipedrive Connector and returns it, Fails if any of the required fields are not instantiated.

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 returns metadata for an object by sampling an object from Pipedrive's API. If that fails, it generates object metadata by parsing Pipedrive's OpenAPI files.

func (*Connector) Provider

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

Provider returns the pipedrive provider instance.

func (*Connector) Read

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

Read retrieves data based on the provided read parameters. https://developers.pipedrive.com/docs/api/v1

func (*Connector) String

func (c *Connector) String() string

String implements the fmt.Stringer interface.

func (*Connector) Write

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

Write creates or updates records in a pipedriver account. https://developers.pipedrive.com/docs/api/v1

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,
	config *oauth2.Config, token *oauth2.Token, opts ...common.OAuthOption,
) Option