Documentation ¶
Index ¶
- func CheckResponse(r *http.Response) error
- func DoRequestWithClient(ctx context.Context, client *http.Client, req *http.Request) (*http.Response, error)
- func FromEnv(c *Client) error
- func StreamDiscardInitial(c *streamConfig)
- type Agent
- type Client
- type Credentials
- type FloorArea
- type Listing
- type ListingDetails
- type ListingOptions
- type ListingResponse
- type ListingService
- type Opt
- type RentalPrices
- type RoomDetails
- type SearchBoundingBox
- type SearchSettings
- type StreamOpt
- type StreamService
- type XMLDate
- type XMLTime
- type XMLURL
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CheckResponse ¶
func DoRequestWithClient ¶
func StreamDiscardInitial ¶
func StreamDiscardInitial(c *streamConfig)
Types ¶
type Client ¶
type Client struct { BaseURL *url.URL Credentials Credentials Listing *ListingService Stream *StreamService // contains filtered or unexported fields }
type Credentials ¶
type Credentials struct {
ApiKey string
}
type Listing ¶
type Listing struct { Agent ListingDetails RoomDetails RentalPrices }
type ListingDetails ¶
type ListingDetails struct { ListingID string `xml:"listing_id"` ListingURL XMLURL `xml:"details_url"` ImageURL XMLURL `xml:"image_url"` Address string `xml:"displayable_address"` Town string `xml:"post_town"` PostCode string `xml:"outcode"` AvailabilityDate XMLDate `xml:"available_from_display"` FirstPublished XMLTime `xml:"first_published_date"` LastPublished XMLTime `xml:"last_published_date"` Status string `xml:"status"` Description string `xml:"description"` ShortDescription string `xml:"short_description"` PropertyType string `xml:"property_type"` FloorPlan XMLURL `xml:"floor_plan"` FurnishedState string `xml:"furnished_state"` LettingFees string `xml:"letting_fees"` }
type ListingOptions ¶
type ListingOptions struct { Area string Order_by string Ordering string Listing_status string Include_sold string Include_rented string Minimum_price string Maximum_price string Minimum_beds int Maximum_beds int Furnished string Property_type string New_homes bool Chain_free bool Keywords []string Listing_id string Branch_id string Page_number int Page_size int Summarized string // contains filtered or unexported fields }
type ListingResponse ¶
type ListingResponse struct { SearchSettings Listings []Listing `xml:"listing"` }
type ListingService ¶
type ListingService struct {
// contains filtered or unexported fields
}
func (*ListingService) Get ¶
func (l *ListingService) Get(ctx context.Context, opts *ListingOptions) (*ListingResponse, *http.Response, error)
type RentalPrices ¶
type RoomDetails ¶
type SearchBoundingBox ¶
type SearchSettings ¶
type SearchSettings struct { Area string `xml:"area_name"` Street string `xml:"street"` Town string `xml:"town"` County string `xml:"county"` Country string `xml:"country"` PostCode string `xml:"postcode"` Latitude string `xml:"latitude"` Longitude string `xml:"longitude"` SearchBoundingBox ListingAmount int `xml:"result_count"` }
type StreamService ¶
type StreamService struct {
// contains filtered or unexported fields
}
func (*StreamService) Listings ¶
func (s *StreamService) Listings(listingOpts *ListingOptions, streamOpts ...StreamOpt) (<-chan Listing, <-chan error, func())
type XMLDate ¶
func (*XMLDate) UnmarshalXML ¶
type XMLTime ¶
func (*XMLTime) UnmarshalXML ¶
Click to show internal directories.
Click to hide internal directories.