klaviyo

Documentation

Index

• Constants
• Variables
• type Connector
  • func NewConnector(opts ...Option) (conn *Connector, outErr error)
  • func (c *Connector) Delete(ctx context.Context, config common.DeleteParams) (*common.DeleteResult, 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 ErrorDetails
• type Option
  • func WithAuthenticatedClient(client common.AuthenticatedHTTPClient) Option
  • func WithClient(ctx context.Context, client *http.Client, config *oauth2.Config, ...) Option
  • func WithModule(module common.ModuleID) Option
• type ResponseError
  • func (r ResponseError) CombineErr(base error) error

Constants

const (
	// Module2024Oct15 is the latest stable version of API as of the date of writing.
	// https://developers.klaviyo.com/en/reference/api_overview
	Module2024Oct15 common.ModuleID = "2024-10-15"
)

Variables

var SupportedModules = metadata.Schemas.ModuleRegistry() // nolint: gochecknoglobals

SupportedModules represents currently working and supported modules within the Klaviyo connector. Modules are added to schema.json file using OpenAPI script.

Types

type Connector

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

func NewConnector

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

func (*Connector) Delete

func (c *Connector) Delete(ctx context.Context, config common.DeleteParams) (*common.DeleteResult, 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)

func (*Connector) Provider

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

func (*Connector) Read

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

func (*Connector) String

func (c *Connector) String() string

func (*Connector) Write

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

type ErrorDetails

type ErrorDetails struct {
	Id     string `json:"id"`
	Status int    `json:"status"`
	Code   string `json:"code"`
	Title  string `json:"title"`
	Detail string `json:"detail"`
	Source any    `json:"source"`
	Meta   any    `json:"meta"`
}

type Option

type Option = func(params *parameters)

Option is a function which mutates the connector configuration.

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

func WithModule

func WithModule(module common.ModuleID) Option

WithModule sets the Atlassian API module to use for the connector. It's required.

type ResponseError

type ResponseError struct {
	Errors []ErrorDetails `json:"errors"`
}

func (ResponseError) CombineErr

func (r ResponseError) CombineErr(base error) error