api

Documentation

Index

• Constants
• Variables
• type Auth
  • func (a *Auth) IDToken() (string, error)
• type Client
  • func NewClient(client *http.Client, baseURL string, auth *Auth) *Client
  • func (c *Client) GetTeamCurrent(team string) (*TeamPairing, error)
  • func (c *Client) GetTeamHistorical(team string) (*TeamPairingHistory, error)
  • func (c *Client) GetTeamLists(team string) (*TeamLists, error)
• type TeamList
• type TeamListItem
• type TeamListItems
• type TeamLists
• type TeamPairing
• type TeamPairingEntity
• type TeamPairingHistory
• type TeamPairingLane

Constants

const DefaultFirebaseAPIKey = "AIzaSyCJwO1t81W7vhpDOL9rey23Q90VjruNkD4"

const DefaultFirebaseURL = "https://pairist-9de4d.firebaseio.com"

https://github.com/pivotal-cf/pairist/blob/d5a40ad99a5985bec61a524e4c175a730ad9e788/.env.production

Variables

var DefaultClient = NewClient(http.DefaultClient, DefaultFirebaseURL, nil)

Types

type Auth

type Auth struct {
	APIKey   string
	Team     string
	Password string
	// contains filtered or unexported fields
}

func (*Auth) IDToken

func (a *Auth) IDToken() (string, error)

type Client

type Client struct {
	// contains filtered or unexported fields
}

func NewClient

func NewClient(client *http.Client, baseURL string, auth *Auth) *Client

func (*Client) GetTeamCurrent

func (c *Client) GetTeamCurrent(team string) (*TeamPairing, error)

func (*Client) GetTeamHistorical

func (c *Client) GetTeamHistorical(team string) (*TeamPairingHistory, error)

func (*Client) GetTeamLists

func (c *Client) GetTeamLists(team string) (*TeamLists, error)

type TeamList

type TeamList struct {
	Items TeamListItems `json:"items,omitempty"`
	Title string        `json:"title,omitempty"`
}

type TeamListItem

type TeamListItem struct {
	Checked bool   `json:"checked,omitempty"`
	Title   string `json:"title,omitempty"`
}

type TeamListItems

type TeamListItems map[string]TeamListItem

type TeamLists

type TeamLists map[string]TeamList

type TeamPairing

type TeamPairing struct {
	Entities map[string]TeamPairingEntity `json:"entities,omitempty"`
	Lanes    map[string]TeamPairingLane   `json:"lanes,omitempty"`
}

type TeamPairingEntity

type TeamPairingEntity struct {
	Color     string   `json:"color,omitempty"`
	Icon      string   `json:"icon,omitempty"`
	Location  string   `json:"location,omitempty"`
	Name      string   `json:"name,omitempty"`
	Picture   string   `json:"picture,omitempty"`
	Tags      []string `json:"tags,omitempty"`
	Type      string   `json:"type,omitempty"`
	UpdatedAt uint     `json:"updatedAt,omitempty"`
}

type TeamPairingHistory

type TeamPairingHistory map[int]TeamPairing

type TeamPairingLane

type TeamPairingLane struct {
	Locked    bool `json:"locked,omitempty"`
	SortOrder uint `json:"sortOrder,omitempty"`
}