dimension

Documentation

Overview

Package dimension provides an HTTP client for the Cantabular Dimension API

Index

• type Area
• type Client
  • func NewClient(dimensionsAPIURL string) (*Client, error)
  • func NewWithHealthClient(hcCli *health.Client) (*Client, error)
  • func (c *Client) Checker(ctx context.Context, check *healthcheck.CheckState) error
• type ErrorResp
  • func (e ErrorResp) Error() string
• type GetAreasInput
• type GetAreasResponse

Types

type Area

type Area struct {
	ID       string `json:"id"`
	Label    string `json:"label"`
	AreaType string `json:"area_type"`
}

Area is an area model with ID and Label

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client is a Cantabular Dimension API client

func NewClient

func NewClient(dimensionsAPIURL string) (*Client, error)

NewClient creates a new instance of Client with a given Dimensions API URL

func NewWithHealthClient

func NewWithHealthClient(hcCli *health.Client) (*Client, error)

NewWithHealthClient creates a new instance of Client, reusing the URL and Clienter from the provided health check client

func (*Client) Checker

func (c *Client) Checker(ctx context.Context, check *healthcheck.CheckState) error

Checker calls recipe api health endpoint and returns a check object to the caller

type ErrorResp

type ErrorResp struct {
	Errors []string `json:"errors"`
}

ErrorResp represents an error response containing a list of errors

func (ErrorResp) Error

func (e ErrorResp) Error() string

type GetAreasInput

type GetAreasInput struct {
	UserAuthToken    string
	ServiceAuthToken string
	DatasetID        string
	AreaTypeID       string
	Text             string
}

type GetAreasResponse

type GetAreasResponse struct {
	Areas []Area `json:"areas"`
}

GetAreasResponse is the response object for GET /areas