extract

Documentation

Index

• type Client
  • func NewClient(sender sdk.RequestSender) *Client
  • func (c *Client) SendLookup(lookup *Lookup) error
  • func (c *Client) SendLookupWithContext(ctx context.Context, lookup *Lookup) error
• type ExtractedAddress
• type HTMLPayload
• type Lookup
• type Metadata
• type Result

Types

type Client

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

Client is responsible for sending requests to the us-extract-api.

func NewClient

func NewClient(sender sdk.RequestSender) *Client

NewClient creates a client with the provided sender.

func (*Client) SendLookup

func (c *Client) SendLookup(lookup *Lookup) error

SendBatch sends the batch of inputs, populating the output for each input if the batch was successful.

func (*Client) SendLookupWithContext

func (c *Client) SendLookupWithContext(ctx context.Context, lookup *Lookup) error

type ExtractedAddress

type ExtractedAddress struct {
	Text      string             `json:"text"`
	Verified  bool               `json:"verified"`
	Line      int                `json:"line"`
	Start     int                `json:"start"`
	End       int                `json:"end"`
	APIOutput []street.Candidate `json:"api_output"`
}

type HTMLPayload

type HTMLPayload string

const (
	HTMLUnspecified HTMLPayload = ""      // Indicates that the server may decide if Lookup.Text is HTML or not.
	HTMLYes         HTMLPayload = "true"  // Indicates that the Lookup.Text is known to be HTML.
	HTMLNo          HTMLPayload = "false" // Indicates that the Lookup.Text is known to NOT be HTML.
)

type Lookup

type Lookup struct {
	Text                    string               `json:"text,omitempty"`
	HTML                    HTMLPayload          `json:"html,omitempty"`
	Aggressive              bool                 `json:"aggressive,omitempty"`
	AddressesWithLineBreaks bool                 `json:"addr_line_breaks,omitempty"`
	AddressesPerLine        int                  `json:"addr_per_line,omitempty"`
	MatchStrategy           street.MatchStrategy `json:"match,omitempty"`
	Result                  *Result              `json:"result,omitempty"`
}

Lookup represents all input fields documented here: https://smartystreets.com/docs/cloud/us-extract-api#http-request-input-fields

type Metadata

type Metadata struct {
	Lines                   int  `json:"lines"`
	Characters              int  `json:"character_count"`
	Bytes                   int  `json:"bytes"`
	Addresses               int  `json:"address_count"`
	VerifiedAddresses       int  `json:"verified_count"`
	ContainsNonASCIIUnicode bool `json:"unicode"`
}

type Result

type Result struct {
	Metadata  Metadata           `json:"meta"`
	Addresses []ExtractedAddress `json:"addresses"`
}

Result, Metadata, and ExtractedAddress represent all output fields documented here: https://smartystreets.com/docs/cloud/us-extract-api#http-response