glo

README

go-glo

Golang library for access to Glo Api

Documentation

Index

• type Attachment
• type Board
• type BoardCard
• type BoardCardParams
• type BoardColumn
• type CardDescription
• type CardDescriptionParam
• type Comment
• type CreateBoardColumnParams
• type Glo
  • func NewGloClient(token string) Glo
  • func (g Glo) CreateBoardCard(boardID string, data BoardCardParams) (card BoardCard)
  • func (g Glo) CreateBoardCardComment(boardID string, cardID string, data ParamComment) (comment Comment)
  • func (g Glo) CreateBoardColumn(boardID string, data CreateBoardColumnParams) (column BoardColumn)
  • func (g Glo) DeleteBoardCard(boardID string, cardID string)
  • func (g Glo) DeleteBoardCardComment(boardID string, cardID string, commentID string)
  • func (g Glo) DeleteBoardColumn(boardID string, columnID string)
  • func (g Glo) EditBoardCard(boardID string, cardID string, data BoardCardParams) (card BoardCard)
  • func (g Glo) EditBoardCardComment(boardID string, cardID string, commentID string, data ParamComment) (comment Comment)
  • func (g Glo) EditBoardColumn(boardID string, columnID string, data CreateBoardColumnParams) (column BoardColumn)
  • func (g Glo) GetBoard(id string, fields []string) (board Board)
  • func (g Glo) GetBoardCard(boardID string, cardID string, fields []string) (card BoardCard)
  • func (g Glo) GetBoardCardAttachments(boardID string, cardID string, fields []string) (attachments []Attachment)
  • func (g Glo) GetBoardCardComments(boardID string, cardID string, fields []string) (comments []Comment)
  • func (g Glo) GetBoardCards(boardID string, fields []string) (cards []BoardCard)
  • func (g Glo) GetBoardColumnCards(boardID string, columnID string, fields []string) (cards []BoardCard)
  • func (g Glo) GetBoards(fields []string) (boards []Board)
  • func (g Glo) GetUser(fields []string) (user User)
• type Label
• type Member
• type ParamComment
• type PartialLabel
• type PartialUser
• type User

Types

type Attachment

type Attachment struct {
	ID          string    `json:"id"`
	Filename    string    `json:"filename"`
	MimeType    string    `json:"mimetype"`
	CreatedDate time.Time `json:"created_date"`
	CreatedBy   Member    `json:"created_by"`
}

Attachment struct for response unmarshall

type Board

type Board struct {
	ID              string        `json:"id"`
	Name            string        `json:"name"`
	Columns         []BoardColumn `json:"columns"`
	ArchivedColumns []BoardColumn `json:"archived_columns"`
	InvitedMembers  []Member      `json:"invited_members"`
	Members         []Member      `json:"members"`
	ArchivedDate    time.Time     `json:"archived_date"`
	Labels          []Label       `json:"labels"`
	CreatedDate     time.Time     `json:"created_date"`
	CreatedBy       PartialUser   `json:"created_by"`
}

Board struct for response unmarshall

type BoardCard

type BoardCard struct {
	ID                 string          `json:"id"`
	Name               string          `json:"name"`
	Description        CardDescription `json:"description"`
	BoardID            string          `json:"board_id"`
	ColumnID           string          `json:"column_id"`
	CreatedDate        time.Time       `json:"created_date"`
	UpdatedDate        time.Time       `json:"updated_date"`
	ArchivedDate       time.Time       `json:"archived_date"`
	Assignees          []PartialUser   `json:"assignees"`
	Labels             []PartialLabel  `json:"labels"`
	DueDate            time.Time       `json:"due_date"`
	CommentCount       int             `json:"comment_count"`
	AttachmentCount    int             `json:"attachment_count"`
	CompletedTaskCount int             `json:"completed_task_count"`
	TotalTaskCount     int             `json:"total_task_count"`
	CreatedBy          PartialUser     `json:"created_by"`
}

BoardCard struct for response unmarshall

type BoardCardParams

type BoardCardParams struct {
	Name        string               `json:"name"`
	Position    int                  `json:"position"`
	Description CardDescriptionParam `json:"description"`
	ColumnID    string               `json:"column_id"`
	Assignees   []PartialUser        `json:"assignees"`
	Labels      []PartialLabel       `json:"labels"`
	DueDate     time.Time            `json:"due_date"`
}

BoardCardParams struct for request

type BoardColumn

type BoardColumn struct {
	ID           string    `json:"id"`
	Name         string    `json:"name"`
	ArchivedDate time.Time `json:"archived_date"`
	CreatedDate  time.Time `json:"created_date"`
}

BoardColumn struct for response unmarshall

type CardDescription

type CardDescription struct {
	Text        string      `json:"text"`
	CreatedDate time.Time   `json:"created_date"`
	UpdatedDate time.Time   `json:"updated_date"`
	CreatedBy   PartialUser `json:"created_by"`
	UpdatedBy   PartialUser `json:"updated_by"`
}

CardDescription struct for response unmarshall

type CardDescriptionParam

type CardDescriptionParam struct {
	Text string `json:"text"`
}

CardDescriptionParam struct for request

type Comment

type Comment struct {
	ID          string      `json:"id"`
	CardID      string      `json:"card_id"`
	BoardID     string      `json:"board_id"`
	CreatedDate time.Time   `json:"created_date"`
	UpdatedDate time.Time   `json:"updated_date"`
	CreatedBy   PartialUser `json:"created_by"`
	UpdatedBy   PartialUser `json:"updated_by"`
	Text        string      `json:"text"`
}

Comment struct for response unmarshall

type CreateBoardColumnParams

type CreateBoardColumnParams struct {
	Name     string `json:"name"`
	Position int    `json:"position"`
}

CreateBoardColumnParams struct for request

type Glo

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

Glo Base Struct for the library and get the paths and the token for access to the API

func NewGloClient

func NewGloClient(token string) Glo

NewGloClient returns a new Glo Api Client

func (Glo) CreateBoardCard

func (g Glo) CreateBoardCard(boardID string, data BoardCardParams) (card BoardCard)

CreateBoardCard Create a card inside board

func (Glo) CreateBoardCardComment

func (g Glo) CreateBoardCardComment(boardID string, cardID string, data ParamComment) (comment Comment)

CreateBoardCardComment Add a comment to a card

func (Glo) CreateBoardColumn

func (g Glo) CreateBoardColumn(boardID string, data CreateBoardColumnParams) (column BoardColumn)

CreateBoardColumn Create a column in the board that pass with the id

func (Glo) DeleteBoardCard

func (g Glo) DeleteBoardCard(boardID string, cardID string)

DeleteBoardCard Delete a card of board

func (Glo) DeleteBoardCardComment

func (g Glo) DeleteBoardCardComment(boardID string, cardID string, commentID string)

DeleteBoardCardComment Delete a comment of card

func (Glo) DeleteBoardColumn

func (g Glo) DeleteBoardColumn(boardID string, columnID string)

DeleteBoardColumn Delete a column in a single board

func (Glo) EditBoardCard

func (g Glo) EditBoardCard(boardID string, cardID string, data BoardCardParams) (card BoardCard)

EditBoardCard Edit a card of board

func (Glo) EditBoardCardComment

func (g Glo) EditBoardCardComment(boardID string, cardID string, commentID string, data ParamComment) (comment Comment)

EditBoardCardComment Edit a comment of card

func (Glo) EditBoardColumn

func (g Glo) EditBoardColumn(boardID string, columnID string, data CreateBoardColumnParams) (column BoardColumn)

EditBoardColumn Edit a column in a single board

func (Glo) GetBoard

func (g Glo) GetBoard(id string, fields []string) (board Board)

GetBoard Get a single board

func (Glo) GetBoardCard

func (g Glo) GetBoardCard(boardID string, cardID string, fields []string) (card BoardCard)

GetBoardCard Get a single card of a board

func (Glo) GetBoardCardAttachments

func (g Glo) GetBoardCardAttachments(boardID string, cardID string, fields []string) (attachments []Attachment)

GetBoardCardAttachments Get all the attachments of a single card of board

func (Glo) GetBoardCardComments

func (g Glo) GetBoardCardComments(boardID string, cardID string, fields []string) (comments []Comment)

GetBoardCardComments Get all the comments of a card

func (Glo) GetBoardCards

func (g Glo) GetBoardCards(boardID string, fields []string) (cards []BoardCard)

GetBoardCards Get all the cards inside board

func (Glo) GetBoardColumnCards

func (g Glo) GetBoardColumnCards(boardID string, columnID string, fields []string) (cards []BoardCard)

GetBoardColumnCards Get all the cards of a single column of board

func (Glo) GetBoards

func (g Glo) GetBoards(fields []string) (boards []Board)

GetBoards Get all the boards that read the token

func (Glo) GetUser

func (g Glo) GetUser(fields []string) (user User)

GetUser Get information of the connect user

type Label

type Label struct {
	ID          string      `json:"id"`
	Name        string      `json:"name"`
	Color       color.RGBA  `json:"color"`
	CreatedDate time.Time   `json:"created_date"`
	CreatedBy   PartialUser `json:"created_by"`
}

Label struct for response unmarshall

type Member

type Member struct {
	ID       string `json:"id"`
	Role     string `json:"role"`
	Username string `json:"username"`
}

Member struct for response unmarshall

type ParamComment

type ParamComment struct {
	Text string `json:"text"`
}

ParamComment struct for request

type PartialLabel

type PartialLabel struct {
	ID string `json:"id"`
}

PartialLabel struct for response unmarshall

type PartialUser

type PartialUser struct {
	ID string `json:"id"`
}

PartialUser struct for response unmarshall

type User

type User struct {
	ID       string `json:"id"`
	Name     string `json:"name"`
	Username string `json:"username"`
	Email    string `json:"email"`
}

User struct for response unmarshall