README

Build Status

smartystreets-go-sdk

The official client libraries for accessing SmartyStreets APIs from Go.

GoDoc

You may have noticed this page is curiously sparse. Don't panic, there are examples and documentation.


asciicast


Apache 2.0 License

Expand ▾ Collapse ▴

Documentation

Overview

    sdk is a top-level package containing elements common to all SmartyStreets APIs.

    Index

    Constants

    View Source
    const VERSION = "v1.9.1"

    Variables

    This section is empty.

    Functions

    func NewSecretKeyCredential

    func NewSecretKeyCredential(authID, authToken string) *secretKeyCredential

    func NewWebsiteKeyCredential

    func NewWebsiteKeyCredential(key, hostNameOrIP string) *websiteKeyCredential

    Types

    type CoordinateLicense

    type CoordinateLicense uint16
    const (
    	CoordinateLicenseSmartyStreets            CoordinateLicense = 0
    	CoordinateLicenseSmartyStreetsProprietary CoordinateLicense = 1
    )

      CoordinateLicense values and associated details defined here: https://smartystreets.com/docs/cloud/us-reverse-geo-api#licenses

      func (CoordinateLicense) String

      func (this CoordinateLicense) String() string

      type Credential

      type Credential interface {
      	Sign(*http.Request) error
      }

      type HTTPStatusError

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

        HTTPStatusError stands in for the error type but also provides convenience methods for accessing the status code and content of the request that caused the error. Instances of this type are returned by sdk.HTTPSender.Send(). When nil, the methods of this type behave as if called on a non-nil instance instantiated with http.StatusOK (200).

        func NewHTTPStatusError

        func NewHTTPStatusError(statusCode int, content []byte) *HTTPStatusError

        func (*HTTPStatusError) Content

        func (e *HTTPStatusError) Content() string

        func (*HTTPStatusError) Error

        func (e *HTTPStatusError) Error() string

        func (*HTTPStatusError) StatusCode

        func (e *HTTPStatusError) StatusCode() int

        type RequestSender

        type RequestSender interface {
        	Send(*http.Request) ([]byte, error)
        }