web

Documentation

Overview

Package web provides commons for interacting with 3rd party web services such as those in the broker package.

Index

• type ListOpts
• type Page
• type Rate
• type Response
• type ResponseMetadata

Types

type ListOpts

type ListOpts struct {
	PageSize int
	PageNum  int
}

ListOpts is used to specify pagination options in a web call.

type Page

type Page struct {
	PageSize   int
	PageNum    int
	PagesTotal int
}

Page contains pagination information about the response.

type Rate

type Rate struct {
	Limit     int
	Remaining int
	ResetAt   time.Time
}

Rate contains information about the current rate limit status.

type Response

type Response struct {
	Resp *http.Response
	Meta ResponseMetadata
}

Response wraps a http response returned by a 3rd party service.

type ResponseMetadata

type ResponseMetadata struct {
	Page Page
	Rate Rate
}

ResponseMetadata contains metadata about the response.