eventful

README

eventful

Go package for using the Eventful API

Installation

Simply run

go get github.com/iand/eventful

Documentation is at http://godoc.org/github.com/iand/eventful

Authors

• Ian Davis - http://iandavis.com/

Contributors

Contributing

• Do submit your changes as a pull request
• Do your best to adhere to the existing coding conventions and idioms.
• Do run go fmt on the code before committing
• Do feel free to add yourself to the CREDITS file and the corresponding Contributors list in the README.md. Alphabetical order applies.
• Don't touch the AUTHORS file. An existing author will add you if your contributions are significant enough.
• Do note that in order for any non-trivial changes to be merged (as a rule of thumb, additions larger than about 15 lines of code), an explicit Public Domain Dedication needs to be on record from you. Please include a copy of the statement found in the WAIVER file with your pull request

License

This is free and unencumbered software released into the public domain. For more information, see http://unlicense.org/ or the accompanying UNLICENSE file.

Documentation

Overview

Package eventful provides a client for the Eventful API

Index

• type Client
  • func New(apikey string) *Client
  • func (client *Client) SearchEvents(srch string, date string) (*SearchEventsResponse, error)
• type Event
• type EventContainer
• type Image
• type ImageInfo
• type RawSearchEventsResponse
• type SearchEventsResponse

Types

type Client

type Client struct {
	APIKey string
}

func New

func New(apikey string) *Client

func (*Client) SearchEvents

func (client *Client) SearchEvents(srch string, date string) (*SearchEventsResponse, error)

type Event

type Event struct {
	Title       string     `json:"title"`
	URL         string     `json:"url"`
	ID          string     `json:"id"`
	VenueID     string     `json:"venue_id"`
	VenueName   string     `json:"venue_name"`
	VenueURL    string     `json:"venue_url"`
	StartTime   string     `json:"start_time"`
	StopTime    string     `json:"stop_time"`
	AllDay      string     `json:"all_day"`
	Latitude    string     `json:"latitude"`
	Longitude   string     `json:"longitude"`
	CityName    string     `json:"city_name"`
	Description string     `json:"description"`
	Image       *ImageInfo `json:"image"`
}

type EventContainer

type EventContainer struct {
	Events []Event `json:"event"`
}

type Image

type Image struct {
	URL    string `json:"url"`
	Width  int    `json:"width,string"`
	Height int    `json:"height,string"`
}

type ImageInfo

type ImageInfo struct {
	Image
	Small  *Image `json:"small"`
	Medium *Image `json:"medium"`
	Thumb  *Image `json:"thumb"`
}

type RawSearchEventsResponse

type RawSearchEventsResponse struct {
	TotalItems int            `json:"total_items,string"`
	PageNumber int            `json:"page_number,string"`
	PageSize   int            `json:"page_size,string"`
	PageCount  int            `json:"page_count,string"`
	Events     EventContainer `json:"events"`
}

type SearchEventsResponse

type SearchEventsResponse struct {
	TotalItems int     `json:"total_items,string"`
	PageNumber int     `json:"page_number,string"`
	PageSize   int     `json:"page_size,string"`
	PageCount  int     `json:"page_count,string"`
	Events     []Event `json:"events"`
}