Documentation ¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ReonomySource ¶
type ReonomySource struct { AccessKey string SecretKey string BaseURL string // summary queries to filter properties SummaryQueries []map[string]interface{} // limit of how many properties to retrieve per API call SummaryLimit int // property detail types. Valid types are basic, mortgages, ownership, // reported_owner, sales, taxes, and tenants. PropertyDetailTypes []string // whether to supply the filter_pii to the property bulk API endpoint FilterPII bool // the number of times to retry a request if it fails RetryCount int // contains filtered or unexported fields }
ReonomySource struct for use by the data-mover-core
func NewReonomySource ¶
func NewReonomySource(accessKey string, secretKey string, queries []map[string]interface{}, propertyDetailTypes []string, filterPII bool, summaryLimit int, retryCount int) *ReonomySource
NewReonomySource initializes a ReonomySource struct for use by the data-mover-core. The accessKey and secretKey are used for basic authentication to the API.
The query parameter is used to filter which properties to return. The query is passed into the "settings" field in the body of a summaries search. Ref: https://api.reonomy.com/v2/docs/guides/search/#filtered-search.
The detailTypes parameter must be one of: basic, mortgages, ownership, reported_owner, sales, taxes, and tenants. Ref: https://api.reonomy.com/v2/docs/api/data-dictionary/
func (*ReonomySource) GetData ¶
func (s *ReonomySource) GetData() (data []map[string]interface{}, err error)
GetData is the implementation of the GetData interface for the data-mover-core
func (*ReonomySource) Initialize ¶
func (s *ReonomySource) Initialize() error
Initialize is the implementation of the Initialize interface for the data-mover-core