kit

README

Kit connector

Supported Objects

Below is an exhaustive list of objects & methods supported on the objects

Kit API version : v4

| Object | Resource | Method | :-------- | :------- | | Broadcasts | broadcasts | read and write | Custom fields | custom_fields | read and write | Email templates | email_templates | read | Forms | forms | read | Purchases | purchases | read and write | Sequences | sequences | read | Subscribers | subscribers | read and write | Segments | segments | read | Tags | tags | read and write | Webhooks | webhook | read and write

Documentation

Overview

nolint

Index

• Constants
• type Connector
  • func NewConnector(opts ...Option) (conn *Connector, outErr error)
  • func (c *Connector) Close() 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
• type ResponseError
  • func (r ResponseError) CombineErr(base error) error

Constants

const (
	// DefaultPageSize is number of elements per page.
	DefaultPageSize = 500
)

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) Close

func (c *Connector) Close() 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 Kit 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)

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 kit.

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

type ResponseError

type ResponseError struct {
	Errors interface{} `json:"errors"`
}

func (ResponseError) CombineErr

func (r ResponseError) CombineErr(base error) error