freshdesk

Documentation

Index

• func ParseNexPageLinkHeader(linkHeader string) string
• type Connector
  • func NewConnector(opts ...Option) (*Connector, error)
  • func (conn *Connector) HTTPClient() *common.HTTPClient
  • func (conn *Connector) JSONHTTPClient() *common.JSONHTTPClient
  • func (conn *Connector) ListObjectMetadata(ctx context.Context, objectNames []string) (*common.ListObjectMetadataResult, error)
  • func (conn *Connector) Provider() providers.Provider
  • func (conn *Connector) Read(ctx context.Context, config common.ReadParams) (*common.ReadResult, error)
  • func (conn *Connector) String() string
  • func (conn *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, username string, password string, ...) Option
  • func WithWorkspace(workspace string) Option

Functions

func ParseNexPageLinkHeader

func ParseNexPageLinkHeader(linkHeader string) string

ParseLinkHeader extracts the next page URL from the Link Header response.

Types

type Connector

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

func NewConnector

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

func (*Connector) HTTPClient

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

func (*Connector) JSONHTTPClient

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

JSONHTTPClient returns the underlying JSON HTTP client.

func (*Connector) ListObjectMetadata

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

func (*Connector) Provider

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

func (*Connector) Read

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

func (*Connector) String

func (conn *Connector) String() string

func (*Connector) Write

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

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,
	username string, password string,
	opts ...common.HeaderAuthClientOption,
) Option

func WithWorkspace

func WithWorkspace(workspace string) Option

WithWorkspace sets the freshdesk API instance to use for the connector. It's required.