types

Documentation

Index

• type AvailabilityBlock
• type Coordinates
• type DayAvailability
• type ErrorResponse
• type Event
• type Location
• type LocationResponse
• type TimePair
• type User
• type UserAvailability
• type UserLocation
• type UserVotes
• type VoteOption

Types

type AvailabilityBlock

type AvailabilityBlock struct {
	StartHour   int `json:"start_hour" bson:"start_hour"`
	StartMinute int `json:"start_minute" bson:"start_minute"`
	EndHour     int `json:"end_hour" bson:"end_hour"`
	EndMinute   int `json:"end_minute" bson:"end_minute"`
}

type Coordinates

type Coordinates struct {
	Latitude  float64 `json:"latitude"`
	Longitude float64 `json:"longitude"`
}

type DayAvailability

type DayAvailability struct {
	Date            time.Time           `json:"date" bson:"date"` // ISO 8601 string
	AvailableBlocks []AvailabilityBlock `json:"available_blocks" bson:"available_blocks"`
}

type ErrorResponse

type ErrorResponse struct {
	Message string `json:"message"`
}

ErrorResponse is the generic error JSON shape returned by the API

type Event

type Event struct {
	CreatorID string `json:"creator_id" bson:"creator_id"`
	GuildID   string `json:"guild_id" bson:"guild_id"`
	EventID   string `json:"id" bson:"id"`
	ChannelID string `json:"channel_id" bson:"channel_id"`

	Title              string    `json:"title" bson:"title"`
	Description        string    `json:"description" bson:"description"`
	EarliestDate       time.Time `json:"earliest_date" bson:"earliest_date"` // ISO 8601 string
	LatestDate         time.Time `json:"latest_date" bson:"latest_date"`     // ISO 8601 string
	StartTimeHour      int       `json:"start_time_hour" bson:"start_time_hour"`
	StartTimeMinute    int       `json:"start_time_minute" bson:"start_time_minute"`
	EndTimeHour        int       `json:"end_time_hour" bson:"end_time_hour"`
	EndTimeMinute      int       `json:"end_time_minute" bson:"end_time_minute"`
	SwitchToVotingTime time.Time `json:"switch_to_voting" bson:"switch_to_voting"` // ISO 8601 string

	Populated   bool       `json:"populated" bson:"populated"`       // field is set once creator goes on web and populates
	VoteOptions VoteOption `json:"vote_options" bson:"vote_options"` // ^ not done until this is done
	// Maps Discord User ID => availability
	UserAvailability map[string]UserAvailability `json:"user_availability" bson:"user_availability"` // ^ not done until this is done
	// Maps Discord User ID => location
	UserLocations map[string]UserLocation `json:"user_locations" bson:"user_locations"` // userID:userLocation
	UserVotes     map[string]UserVotes    `json:"user_votes" bson:"user_votes"`         // ^ not done until this is done
}

we need the user who is creating the event we need to generate an event ID we need to use this event ID for the link we need to store the GuildID (only members in the server can access)

type Location

type Location struct {
	Name      string  `json:"name" bson:"name"`
	Address   string  `json:"address" bson:"address"`
	Rating    float64 `json:"rating" bson:"rating"`
	Image     string  `json:"image" bson:"image"`
	Latitude  float64 `json:"latitude" bson:"latitude"`
	Longitude float64 `json:"longitude" bson:"longitude"`
}

type LocationResponse

type LocationResponse struct {
	EventID   int     `json:"eventID"`
	UserID    int     `json:"userID"`
	Latitude  float64 `json:"latitude"`
	Longitude float64 `json:"longitude"`
	Address   string  `json:"address"`
}

type TimePair

type TimePair struct {
	Start time.Time `json:"start" bson:"start"`
	End   time.Time `json:"end" bson:"end"`
	Users []User    `json:"users" bson:"users"`
}

type User

type User struct {
	ID    string `json:"id" bson:"id"`
	Color string `json:"color" bson:"color"`
	Name  string `json:"name" bson:"name"`
}

type UserAvailability

type UserAvailability struct {
	DayAvailability []DayAvailability `json:"day_availability" bson:"day_availability"`
}

type UserLocation

type UserLocation struct {
	Latitude  float64 `json:"latitude" bson:"latitude"`
	Longitude float64 `json:"longitude" bson:"longitude"`
}

type UserVotes

type UserVotes struct {
	LocationVotes []int `json:"location_votes" bson:"location_votes"`
	TimeVotes     []int `json:"time_votes" bson:"time_votes"`
}

type VoteOption

type VoteOption struct {
	Location      []Location `json:"address" bson:"address"`
	StartEndPairs []TimePair `json:"start_end_pairs" bson:"start_end_pairs"`
}