customerapp

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, apiKey string, ...) Option
• type ResponseError
  • func (r ResponseError) CombineErr(base error) error

Constants

const ApiVersion = "v1"

const DefaultPageSize = 50

DefaultPageSize is number of elements per page.

Variables

var ObjectNameToWritePath = datautils.NewDefaultMap(map[string]string{
	objectNameCustomerExports:   "exports/customers",
	objectNameDeliveriesExports: "exports/deliveries",
},
	func(objectName string) (jsonPath string) {
		return objectName
	},
)

ObjectNameToWritePath maps ObjectName to URL path used for Write operation.

var ObjectNameToWriteResponseField = datautils.NewDefaultMap(map[string]string{
	objectNameCollections:       "collection",
	objectNameImports:           "import",
	objectNameReportingWebhooks: "",
	objectNameSegments:          "segment",
	objectNameSnippets:          "snippet",
	objectNameCustomerExports:   "export",
	objectNameDeliveriesExports: "export",
},
	func(objectName string) string {

		return naming.NewSingularString(objectName).String()
	},
)

ObjectNameToWriteResponseField maps ObjectName to the write response field names that hold the object.

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 {
	Detail string `json:"detail"`
	Status string `json:"status"`
}

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

type ResponseError

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

func (ResponseError) CombineErr

func (r ResponseError) CombineErr(base error) error