backlog

package module
v0.0.0-...-61eb940 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 26, 2024 License: MIT Imports: 17 Imported by: 18

README

Backlog API in Go GoDoc test lint codecov

This library supports most if not all of the backlog REST calls.

Installing

go get
$ go get -u github.com/kenzo0107/backlog

Example

Get my user information
package main

import (
	"fmt"
	"os"

	"github.com/kenzo0107/backlog"
)

func main() {
	c := backlog.New("YOUR API KEY", "YOUR BASE URL")

	user, err := c.GetUserMySelf()
	if err != nil {
		fmt.Printf("%s\n", err)
		return
	}
	fmt.Printf("user ID: %d, Name %s\n", user.ID, user.Name)
}
Download space icon
func main() {
	file, err := os.Create("icon.png")
	if err != nil {
		fmt.Println(err)
		return
	}
	defer file.Close()

	c := backlog.New("YOUR API KEY", "YOUR BASE URL")

	if err := c.GetSpaceIcon(file); err != nil {
		fmt.Println(err)
		return
	}
}

Contributing

You are more than welcome to contribute to this project. Fork and make a Pull Request, or create an Issue if you see any problem.

Before making any Pull Request please run the following:

make pr-prep

This will check/update code formatting, linting and then run all tests

License

MIT License

Documentation

Index

Constants

View Source 
const (
	SortIssueType = Sort(rune(iota))
	SortCategory
	SortVersion
	SortMilestone
	SortSummary
	SortStatus
	SortPriority
	SortAttachment
	SortSharedFile
	SortCreated
	SortCreatedUser
	SortUpdated
	SortUpdatedUser
	SortAssignee
	SortStartDate
	SortDueDate
	SortEstimatedHours
	SortActualHours
	SortChildIssue
)

IssueType is used in sort type

View Source 
const (
	RoleTypeAdministrator = RoleType(iota)
	RoleTypeGeneralUser
	RoleTypeReporter
	RoleTypeViewer
	RoleTypeGuestReporter
	RoleTypeGuestViewer
)

RoleType

View Source 
const (
	OrderAsc = Order(rune(iota))
	OrderDesc
)

Order by asc, desc

Variables

This section is empty.

Functions

func Bool 

func Bool(v bool) *bool

Bool is a helper routine that allocates a new bool value to store v and returns a pointer to it.

func Int 

func Int(v int) *int

Int is a helper routine that allocates a new int value to store v and returns a pointer to it.

func Int64 

func Int64(v int64) *int64

Int64 is a helper routine that allocates a new int64 value to store v and returns a pointer to it.

func OptionDebug 

func OptionDebug(b bool) func(*Client)

OptionDebug enable debugging for the client

func OptionHTTPClient 

func OptionHTTPClient(client httpClient) func(*Client)

OptionHTTPClient - provide a custom http client to the backlog client.

func OptionLog 

func OptionLog(l logger) func(*Client)

OptionLog set logging for client.

func String 

func String(v string) *string

String is a helper routine that allocates a new string value to store v and returns a pointer to it.

Types

type Activity 

type Activity struct {
	ID            *int            `json:"id,omitempty"` // User.ID
	Project       *Project        `json:"project,omitempty"`
	Type          *int            `json:"type,omitempty"`
	Content       *Content        `json:"content,omitempty"`
	Notifications []*Notification `json:"notifications,omitempty"`
	CreatedUser   *User           `json:"createdUser,omitempty"`
	Created       *Timestamp      `json:"created,omitempty"`
}

Activity : activity

type AddAttachmentToWikiInput 

type AddAttachmentToWikiInput struct {
	AttachmentIDs []int `json:"attachmentId"`
}

AddAttachmentToWikiInput contains all the parameters necessary (including the optional ones) for a AddAttachmentToWiki() request.

type AddProjectAdministratorInput 

type AddProjectAdministratorInput struct {
	UserID *int `json:"userId"`
}

AddProjectAdministratorInput specifies parameters to the AddProjectAdministrator method.

type AddProjectTeamInput 

type AddProjectTeamInput struct {
	TeamID *int `json:"teamId"`
}

AddProjectTeamInput specifies parameters to the AddProjectTeam method.

type AddProjectUserInput 

type AddProjectUserInput struct {
	UserID *int `json:"userId"`
}

AddProjectUserInput specifies parameters to the AddProjectUser method.

type Attachment 

type Attachment struct {
	ID          *int       `json:"id,omitempty"`
	Name        *string    `json:"name,omitempty"`
	Size        *int       `json:"size,omitempty"`
	CreatedUser *User      `json:"createdUser,omitempty"`
	Created     *Timestamp `json:"created,omitempty"`
}

Attachment : attachment of wiki

type AttachmentInfo 

type AttachmentInfo struct {
	ID   *int    `json:"id,omitempty"`
	Name *string `json:"name,omitempty"`
}

AttachmentInfo : attachment information

type AttributeInfo 

type AttributeInfo struct {
	ID     *int `json:"id,omitempty"`
	TypeID *int `json:"typeId,omitempty"`
}

AttributeInfo : attribute information

type Category 

type Category struct {
	ID           *int    `json:"id,omitempty"`
	Name         *string `json:"name,omitempty"`
	DisplayOrder *int    `json:"displayOrder,omitempty"`
}

Category : category

type Change 

type Change struct {
	Field    *string `json:"field,omitempty"`
	NewValue *string `json:"new_value,omitempty"`
	OldValue *string `json:"old_value,omitempty"`
	Type     *string `json:"type,omitempty"`
}

Change : -

type ChangeLog 

type ChangeLog struct {
	AttachmentInfo   *AttachmentInfo   `json:"attachmentInfo,omitempty"`
	AttributeInfo    *AttributeInfo    `json:"attributeInfo,omitempty"`
	Field            *string           `json:"field,omitempty"`
	NewValue         *string           `json:"newValue,omitempty"`
	NotificationInfo *NotificationInfo `json:"notificationInfo,omitempty"`
	OriginalValue    *string           `json:"originalValue,omitempty"`
}

ChangeLog : change log

type Client 

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

Client : backlog client

func New 

func New(apiKey, endpoint string, options ...Option) *Client

New builds a backlog client from the provided token, baseURL and options

func (*Client) AddAttachmentToWiki 

func (c *Client) AddAttachmentToWiki(wikiID int, input *AddAttachmentToWikiInput) ([]*Attachment, error)

AddAttachmentToWiki adds attachments to a wiki

func (*Client) AddAttachmentToWikiContext 

func (c *Client) AddAttachmentToWikiContext(ctx context.Context, wikiID int, input *AddAttachmentToWikiInput) ([]*Attachment, error)

AddAttachmentToWikiContext adds attachments to a wiki with context

func (*Client) AddOptions 

func (c *Client) AddOptions(s string, opts interface{}) (string, error)

AddOptions adds the parameters in opt as URL query parameters to s. opt must be a struct whose fields may contain "url" tags.

func (*Client) AddProjectAdministrator 

func (c *Client) AddProjectAdministrator(projectIDOrKey interface{}, input *AddProjectAdministratorInput) (*User, error)

AddProjectAdministrator adds an administrator in a project

func (*Client) AddProjectAdministratorContext 

func (c *Client) AddProjectAdministratorContext(ctx context.Context, projectIDOrKey interface{}, input *AddProjectAdministratorInput) (*User, error)

AddProjectAdministratorContext adds an administrator in a project with context

func (*Client) AddProjectTeam 

func (c *Client) AddProjectTeam(projectIDOrKey interface{}, input *AddProjectTeamInput) (*Team, error)

AddProjectTeam adds a team to a project

func (*Client) AddProjectTeamContext 

func (c *Client) AddProjectTeamContext(ctx context.Context, projectIDOrKey interface{}, input *AddProjectTeamInput) (*Team, error)

AddProjectTeamContext adds a team to a project with context

func (*Client) AddProjectUser 

func (c *Client) AddProjectUser(projectIDOrKey interface{}, input *AddProjectUserInput) (*User, error)

AddProjectUser adds a user to a project

func (*Client) AddProjectUserContext 

func (c *Client) AddProjectUserContext(ctx context.Context, projectIDOrKey interface{}, input *AddProjectUserInput) (*User, error)

AddProjectUserContext adds a user to a project with context

func (*Client) CreateCategory 

func (c *Client) CreateCategory(projectIDOrKey interface{}, input *CreateCategoryInput) (*Category, error)

CreateCategory creates a category

func (*Client) CreateCategoryContext 

func (c *Client) CreateCategoryContext(ctx context.Context, projectIDOrKey interface{}, input *CreateCategoryInput) (*Category, error)

CreateCategoryContext creates a category with Context

func (*Client) CreateIssue 

func (c *Client) CreateIssue(input *CreateIssueInput) (*Issue, error)

CreateIssue creates a issue

func (*Client) CreateIssueComment 

func (c *Client) CreateIssueComment(issueIDOrKey string, input *CreateIssueCommentInput) (*IssueComment, error)

CreateIssueComment creates a issue comments

func (*Client) CreateIssueCommentContext 

func (c *Client) CreateIssueCommentContext(ctx context.Context, issueIDOrKey string, input *CreateIssueCommentInput) (*IssueComment, error)

CreateIssueCommentContext creates a issue comments with context

func (*Client) CreateIssueCommentsNotification 

func (c *Client) CreateIssueCommentsNotification(issueIDOrKey string, commentID int, input *CreateIssueCommentsNotificationInput) (*IssueComment, error)

CreateIssueCommentsNotification creates a notification

func (*Client) CreateIssueCommentsNotificationContext 

func (c *Client) CreateIssueCommentsNotificationContext(ctx context.Context, issueIDOrKey string, commentID int, input *CreateIssueCommentsNotificationInput) (*IssueComment, error)

CreateIssueCommentsNotificationContext creates a notification with context

func (*Client) CreateIssueContext 

func (c *Client) CreateIssueContext(ctx context.Context, input *CreateIssueInput) (*Issue, error)

CreateIssueContext creates a issue with context

func (*Client) CreateIssueSharedFiles 

func (c *Client) CreateIssueSharedFiles(issueIDOrKey string, input *CreateIssueSharedFilesInput) ([]*SharedFile, error)

CreateIssueSharedFiles link a shared files to a issue

func (*Client) CreateIssueSharedFilesContext 

func (c *Client) CreateIssueSharedFilesContext(ctx context.Context, issueIDOrKey string, input *CreateIssueSharedFilesInput) ([]*SharedFile, error)

CreateIssueSharedFilesContext link a shared files to a issue with context

func (*Client) CreateIssueType 

func (c *Client) CreateIssueType(projectIDOrKey interface{}, input *CreateIssueTypeInput) (*IssueType, error)

CreateIssueType creates an issue type

func (*Client) CreateIssueTypeContext 

func (c *Client) CreateIssueTypeContext(ctx context.Context, projectIDOrKey interface{}, input *CreateIssueTypeInput) (*IssueType, error)

CreateIssueTypeContext creates an issue type with Context

func (*Client) CreateProject 

func (c *Client) CreateProject(input *CreateProjectInput) (*Project, error)

CreateProject creates a project

func (*Client) CreateProjectContext 

func (c *Client) CreateProjectContext(ctx context.Context, input *CreateProjectInput) (*Project, error)

CreateProjectContext creates a project with Context

func (*Client) CreateStatus 

func (c *Client) CreateStatus(projectIDOrKey interface{}, input *CreateStatusInput) (*Status, error)

CreateStatus creates a status

func (*Client) CreateStatusContext 

func (c *Client) CreateStatusContext(ctx context.Context, projectIDOrKey interface{}, input *CreateStatusInput) (*Status, error)

CreateStatusContext creates a status

func (*Client) CreateTeam 

func (c *Client) CreateTeam(input *CreateTeamInput) (*Team, error)

CreateTeam creates a team a space backlog.com cannot use this API

func (*Client) CreateTeamContext 

func (c *Client) CreateTeamContext(ctx context.Context, input *CreateTeamInput) (*Team, error)

CreateTeamContext creates a team with Context a space backlog.com cannot use this API

func (*Client) CreateUser 

func (c *Client) CreateUser(input *CreateUserInput) (*User, error)

CreateUser creates a user

func (*Client) CreateUserContext 

func (c *Client) CreateUserContext(ctx context.Context, input *CreateUserInput) (*User, error)

CreateUserContext creates a user with Context

func (*Client) CreateVersion 

func (c *Client) CreateVersion(projectIDOrKey interface{}, input *CreateVersionInput) (*Version, error)

CreateVersion creates a versions (milestone) of a project

func (*Client) CreateVersionContext 

func (c *Client) CreateVersionContext(ctx context.Context, projectIDOrKey interface{}, input *CreateVersionInput) (*Version, error)

CreateVersionContext creates a versions (milestone) of a project with Context

func (*Client) CreateWatching 

func (c *Client) CreateWatching(input *CreateWatchingInput) (*Watching, error)

CreateWatching creates a watching

func (*Client) CreateWatchingContext 

func (c *Client) CreateWatchingContext(ctx context.Context, input *CreateWatchingInput) (*Watching, error)

CreateWatchingContext creates a watching with Context

func (*Client) CreateWebhook 

func (c *Client) CreateWebhook(projectIDOrKey interface{}, webhook *CreateWebhookInput) (*Webhook, error)

CreateWebhook adds a webhook

func (*Client) CreateWebhookContext 

func (c *Client) CreateWebhookContext(ctx context.Context, projectIDOrKey interface{}, input *CreateWebhookInput) (*Webhook, error)

CreateWebhookContext adds a webhook with context

func (*Client) CreateWiki 

func (c *Client) CreateWiki(input *CreateWikiInput) (*Wiki, error)

CreateWiki creates a wiki

func (*Client) CreateWikiContext 

func (c *Client) CreateWikiContext(ctx context.Context, input *CreateWikiInput) (*Wiki, error)

CreateWikiContext creates a wiki with Context

func (*Client) Debug 

func (c *Client) Debug() bool

Debug returns if debug is enabled.

func (*Client) Debugf 

func (c *Client) Debugf(format string, v ...interface{})

Debugf print a formatted debug line.

func (*Client) Debugln 

func (c *Client) Debugln(v ...interface{})

Debugln print a debug line.

func (*Client) DeleteAttachmentInWiki 

func (c *Client) DeleteAttachmentInWiki(wikiID, attachmentID int) (*Attachment, error)

DeleteAttachmentInWiki deletes a attachment in a wiki

func (*Client) DeleteAttachmentInWikiContext 

func (c *Client) DeleteAttachmentInWikiContext(ctx context.Context, wikiID, attachmentID int) (*Attachment, error)

DeleteAttachmentInWikiContext deletes a attachment in a wiki with context

func (*Client) DeleteCategory 

func (c *Client) DeleteCategory(projectIDOrKey interface{}, categoryID int) (*Category, error)

DeleteCategory deletes a category

func (*Client) DeleteCategoryContext 

func (c *Client) DeleteCategoryContext(ctx context.Context, projectIDOrKey interface{}, categoryID int) (*Category, error)

DeleteCategoryContext deletes a category with Context

func (*Client) DeleteIssue 

func (c *Client) DeleteIssue(issueIDOrKey string) (*Issue, error)

DeleteIssue deletes an issue

func (*Client) DeleteIssueAttachment 

func (c *Client) DeleteIssueAttachment(issueIDOrKey string, attachmentID int) (*Attachment, error)

DeleteIssueAttachment deletes an issue attachment

func (*Client) DeleteIssueAttachmentContext 

func (c *Client) DeleteIssueAttachmentContext(ctx context.Context, issueIDOrKey string, attachmentID int) (*Attachment, error)

DeleteIssueAttachmentContext deletes an issue attachments with context

func (*Client) DeleteIssueComment 

func (c *Client) DeleteIssueComment(issueIDOrKey string, commentID int) (*IssueComment, error)

DeleteIssueComment deletes a issue comment

func (*Client) DeleteIssueCommentContext 

func (c *Client) DeleteIssueCommentContext(ctx context.Context, issueIDOrKey string, commentID int) (*IssueComment, error)

DeleteIssueCommentContext deletes a issue comment with context

func (*Client) DeleteIssueContext 

func (c *Client) DeleteIssueContext(ctx context.Context, issueIDOrKey string) (*Issue, error)

DeleteIssueContext deletes an issue with context

func (*Client) DeleteIssueSharedFile 

func (c *Client) DeleteIssueSharedFile(issueIDOrKey string, sharedFileID int) (*SharedFile, error)

DeleteIssueSharedFile link a shared files to a issue

func (*Client) DeleteIssueSharedFileContext 

func (c *Client) DeleteIssueSharedFileContext(ctx context.Context, issueIDOrKey string, sharedFileID int) (*SharedFile, error)

DeleteIssueSharedFileContext link a shared files to a issue with context

func (*Client) DeleteIssueType 

func (c *Client) DeleteIssueType(projectIDOrKey interface{}, issueTypeID int, input *DeleteIssueTypeInput) (*IssueType, error)

DeleteIssueType deletes an issue type

func (*Client) DeleteIssueTypeContext 

func (c *Client) DeleteIssueTypeContext(ctx context.Context, projectIDOrKey interface{}, issueTypeID int, input *DeleteIssueTypeInput) (*IssueType, error)

DeleteIssueTypeContext deletes an issue type with Context

func (*Client) DeleteProject 

func (c *Client) DeleteProject(projectIDOrKey interface{}) (*Project, error)

DeleteProject deletes a project

func (*Client) DeleteProjectAdministrator 

func (c *Client) DeleteProjectAdministrator(projectIDOrKey interface{}, input *DeleteProjectAdministratorInput) (*User, error)

DeleteProjectAdministrator deletes a administrator in a project

func (*Client) DeleteProjectAdministratorContext 

func (c *Client) DeleteProjectAdministratorContext(ctx context.Context, projectIDOrKey interface{}, input *DeleteProjectAdministratorInput) (*User, error)

DeleteProjectAdministratorContext deletes a administrator in a project with Context

func (*Client) DeleteProjectContext 

func (c *Client) DeleteProjectContext(ctx context.Context, projectIDOrKey interface{}) (*Project, error)

DeleteProjectContext deletes a project with Context

func (*Client) DeleteProjectTeam 

func (c *Client) DeleteProjectTeam(projectIDOrKey interface{}, input *DeleteProjectTeamInput) (*Team, error)

DeleteProjectTeam deletes a team to a project

func (*Client) DeleteProjectTeamContext 

func (c *Client) DeleteProjectTeamContext(ctx context.Context, projectIDOrKey interface{}, input *DeleteProjectTeamInput) (*Team, error)

DeleteProjectTeamContext deletes a team to a project with context

func (*Client) DeleteProjectUser 

func (c *Client) DeleteProjectUser(projectIDOrKey interface{}, input *DeleteProjectUserInput) (*User, error)

DeleteProjectUser deletes a user in a project

func (*Client) DeleteProjectUserContext 

func (c *Client) DeleteProjectUserContext(ctx context.Context, projectIDOrKey interface{}, input *DeleteProjectUserInput) (*User, error)

DeleteProjectUserContext deletes a user in a project with Context

func (*Client) DeleteStatus 

func (c *Client) DeleteStatus(projectIDOrKey interface{}, statusID int, input *DeleteStatusInput) (*Status, error)

DeleteStatus deletes a status

func (*Client) DeleteStatusContext 

func (c *Client) DeleteStatusContext(ctx context.Context, projectIDOrKey interface{}, statusID int, input *DeleteStatusInput) (*Status, error)

DeleteStatusContext deletes a status

func (*Client) DeleteTeam 

func (c *Client) DeleteTeam(teamID int) (*Team, error)

DeleteTeam deletes a team

func (*Client) DeleteTeamContext 

func (c *Client) DeleteTeamContext(ctx context.Context, teamID int) (*Team, error)

DeleteTeamContext deletes a team with Context

func (*Client) DeleteUser 

func (c *Client) DeleteUser(id int) (*User, error)

DeleteUser deletes a user

func (*Client) DeleteUserContext 

func (c *Client) DeleteUserContext(ctx context.Context, id int) (*User, error)

DeleteUserContext deletes a user with Context

func (*Client) DeleteVersion 

func (c *Client) DeleteVersion(projectIDOrKey interface{}, versionID int) (*Version, error)

DeleteVersion deletes a versions (milestone) of a project

func (*Client) DeleteVersionContext 

func (c *Client) DeleteVersionContext(ctx context.Context, projectIDOrKey interface{}, versionID int) (*Version, error)

DeleteVersionContext deletes a versions (milestone) of a project with Context

func (*Client) DeleteWatching 

func (c *Client) DeleteWatching(watchingID int) (*Watching, error)

DeleteWatching deletes a watching

func (*Client) DeleteWatchingContext 

func (c *Client) DeleteWatchingContext(ctx context.Context, watchingID int) (*Watching, error)

DeleteWatchingContext deletes a watching with Context

func (*Client) DeleteWebhook 

func (c *Client) DeleteWebhook(projectIDOrKey interface{}, webhookID int) (*Webhook, error)

DeleteWebhook deletes a webhook

func (*Client) DeleteWebhookContext 

func (c *Client) DeleteWebhookContext(ctx context.Context, projectIDOrKey interface{}, webhookID int) (*Webhook, error)

DeleteWebhookContext updates a webhook with context

func (*Client) DeleteWiki 

func (c *Client) DeleteWiki(wikiID int) (*Wiki, error)

DeleteWiki deletes a wiki

func (*Client) DeleteWikiContext 

func (c *Client) DeleteWikiContext(ctx context.Context, wikiID int) (*Wiki, error)

DeleteWikiContext deletes a wiki with Context

func (*Client) Do 

func (c *Client) Do(ctx context.Context, req *http.Request, v interface{}) error

Do sends an API request and returns the API response. The API response is JSON decoded and stored in the value pointed to by v, or returned as an error if an API error has occurred. If v implements the io.Writer interface, the raw response body will be written to v, without attempting to first decode it. If rate limit is exceeded and reset time is in the future, Do returns *RateLimitError immediately without making a network API call.

The provided ctx must be non-nil, if it is nil an error is returned. If it is canceled or times out, ctx.Err() will be returned.

func (*Client) GetCategories 

func (c *Client) GetCategories(projectIDOrKey interface{}) ([]*Category, error)

GetCategories returns the list of categories

func (*Client) GetCategoriesContext 

func (c *Client) GetCategoriesContext(ctx context.Context, projectIDOrKey interface{}) ([]*Category, error)

GetCategoriesContext returns the list of categories with context

func (*Client) GetCustomFields 

func (c *Client) GetCustomFields(projectIDOrKey interface{}) ([]*CustomField, error)

GetCustomFields returns the list of custom fields

func (*Client) GetCustomFieldsContext 

func (c *Client) GetCustomFieldsContext(ctx context.Context, projectIDOrKey interface{}) ([]*CustomField, error)

GetCustomFieldsContext returns the list of custom fields with context

func (*Client) GetIssue 

func (c *Client) GetIssue(issueIDOrKey string) (*Issue, error)

GetIssue gets a issue

func (*Client) GetIssueAttachment 

func (c *Client) GetIssueAttachment(issueIDOrKey string, attachmentID int, writer io.Writer) error

GetIssueAttachment downloads an issue attachment

func (*Client) GetIssueAttachmentContext 

func (c *Client) GetIssueAttachmentContext(ctx context.Context, issueIDOrKey string, attachmentID int, writer io.Writer) error

GetIssueAttachmentContext downloads an issue attachment with context

func (*Client) GetIssueAttachments 

func (c *Client) GetIssueAttachments(issueIDOrKey string) ([]*Attachment, error)

GetIssueAttachments gets issue attachments

func (*Client) GetIssueAttachmentsContext 

func (c *Client) GetIssueAttachmentsContext(ctx context.Context, issueIDOrKey string) ([]*Attachment, error)

GetIssueAttachmentsContext gets issue attachments with context

func (*Client) GetIssueComment 

func (c *Client) GetIssueComment(issueIDOrKey string, commentID int) (*IssueComment, error)

GetIssueComment gets a issue comment

func (*Client) GetIssueCommentContext 

func (c *Client) GetIssueCommentContext(ctx context.Context, issueIDOrKey string, commentID int) (*IssueComment, error)

GetIssueCommentContext gets a issue comment with context

func (*Client) GetIssueComments 

func (c *Client) GetIssueComments(issueIDOrKey string, opts *GetIssueCommentsOptions) ([]*IssueComment, error)

GetIssueComments get list of the issue comments

func (*Client) GetIssueCommentsContext 

func (c *Client) GetIssueCommentsContext(ctx context.Context, issueIDOrKey string, opts *GetIssueCommentsOptions) ([]*IssueComment, error)

GetIssueCommentsContext gets list of the issue comments with context

func (*Client) GetIssueCommentsCount 

func (c *Client) GetIssueCommentsCount(issueIDOrKey string) (int, error)

GetIssueCommentsCount gets count of issue comments

func (*Client) GetIssueCommentsCountContext 

func (c *Client) GetIssueCommentsCountContext(ctx context.Context, issueIDOrKey string) (int, error)

GetIssueCommentsCountContext gets count of issue comments with context

func (*Client) GetIssueCommentsNotifications 

func (c *Client) GetIssueCommentsNotifications(issueIDOrKey string, commentID int) ([]*Notification, error)

GetIssueCommentsNotifications gets notifications in issue comments

func (*Client) GetIssueCommentsNotificationsContext 

func (c *Client) GetIssueCommentsNotificationsContext(ctx context.Context, issueIDOrKey string, commentID int) ([]*Notification, error)

GetIssueCommentsNotificationsContext gets a issue comment with context

func (*Client) GetIssueContext 

func (c *Client) GetIssueContext(ctx context.Context, issueIDOrKey string) (*Issue, error)

GetIssueContext gets a issue with context

func (*Client) GetIssueCount 

func (c *Client) GetIssueCount(opts *GetIssuesCountOptions) (int, error)

GetIssueCount returns the count of issues

func (*Client) GetIssueCountContext 

func (c *Client) GetIssueCountContext(ctx context.Context, opts *GetIssuesCountOptions) (int, error)

GetIssueCountContext returns the count of issues with context

func (*Client) GetIssueParticipants 

func (c *Client) GetIssueParticipants(issueIDOrKey string) ([]*User, error)

GetIssueParticipants gets participants of a issue

func (*Client) GetIssueParticipantsContext 

func (c *Client) GetIssueParticipantsContext(ctx context.Context, issueIDOrKey string) ([]*User, error)

GetIssueParticipantsContext gets participants of a issue with context

func (*Client) GetIssueSharedFiles 

func (c *Client) GetIssueSharedFiles(issueIDOrKey string) ([]*SharedFile, error)

GetIssueSharedFiles gets shared files of a issue

func (*Client) GetIssueSharedFilesContext 

func (c *Client) GetIssueSharedFilesContext(ctx context.Context, issueIDOrKey string) ([]*SharedFile, error)

GetIssueSharedFilesContext gets shared files of a issue with context

func (*Client) GetIssueTypes 

func (c *Client) GetIssueTypes(projectIDOrKey interface{}) ([]*IssueType, error)

GetIssueTypes returns the list of categories

func (*Client) GetIssueTypesContext 

func (c *Client) GetIssueTypesContext(ctx context.Context, projectIDOrKey interface{}) ([]*IssueType, error)

GetIssueTypesContext returns the list of categories with context

func (*Client) GetIssues 

func (c *Client) GetIssues(opts *GetIssuesOptions) ([]*Issue, error)

GetIssues returns the list of issues

func (*Client) GetIssuesContext 

func (c *Client) GetIssuesContext(ctx context.Context, opts *GetIssuesOptions) ([]*Issue, error)

GetIssuesContext returns the list of issues with context

func (*Client) GetLicence 

func (c *Client) GetLicence() (*License, error)

GetLicence returns the license information

func (*Client) GetLicenceContext 

func (c *Client) GetLicenceContext(ctx context.Context) (*License, error)

GetLicenceContext returns the license information with context

func (*Client) GetMyRecentlyViewedProjects 

func (c *Client) GetMyRecentlyViewedProjects(opts *GetMyRecentlyViewedProjectsOptions) ([]*RecentlyViewedProject, error)

GetMyRecentlyViewedProjects returns the list of projects I recently viewed

func (*Client) GetMyRecentlyViewedProjectsContext 

func (c *Client) GetMyRecentlyViewedProjectsContext(ctx context.Context, opts *GetMyRecentlyViewedProjectsOptions) ([]*RecentlyViewedProject, error)

GetMyRecentlyViewedProjectsContext returns the list of projects I recently viewed with context

func (*Client) GetMyRecentlyViewedWikis 

func (c *Client) GetMyRecentlyViewedWikis(opts *GetMyRecentlyViewedWikisOptions) ([]*RecentlyViewedWiki, error)

GetMyRecentlyViewedWikis returns the list of wikis I recently viewed

func (*Client) GetMyRecentlyViewedWikisContext 

func (c *Client) GetMyRecentlyViewedWikisContext(ctx context.Context, opts *GetMyRecentlyViewedWikisOptions) ([]*RecentlyViewedWiki, error)

GetMyRecentlyViewedWikisContext returns the list of wikis I recently viewed with context

func (*Client) GetPriorities 

func (c *Client) GetPriorities() ([]*Priority, error)

GetPriorities returns the list of priorities

func (*Client) GetPrioritiesContext 

func (c *Client) GetPrioritiesContext(ctx context.Context) ([]*Priority, error)

GetPrioritiesContext returns the list of priorities with context

func (*Client) GetProject 

func (c *Client) GetProject(projectIDOrKey interface{}) (*Project, error)

GetProject returns a project

func (*Client) GetProjectActivities 

func (c *Client) GetProjectActivities(projectIDOrKey interface{}, opts *GetProjectActivitiesOptions) ([]*Activity, error)

GetProjectActivities returns the list of a project's activities

func (*Client) GetProjectActivitiesContext 

func (c *Client) GetProjectActivitiesContext(ctx context.Context, projectIDOrKey interface{}, opts *GetProjectActivitiesOptions) ([]*Activity, error)

GetProjectActivitiesContext returns the list of a project's activities with context

func (*Client) GetProjectAdministrators 

func (c *Client) GetProjectAdministrators(projectIDOrKey interface{}) ([]*User, error)

GetProjectAdministrators returns the list of administrators in a project

func (*Client) GetProjectAdministratorsContext 

func (c *Client) GetProjectAdministratorsContext(ctx context.Context, projectIDOrKey interface{}) ([]*User, error)

GetProjectAdministratorsContext returns the list of administrators in a project with context

func (*Client) GetProjectContext 

func (c *Client) GetProjectContext(ctx context.Context, projectIDOrKey interface{}) (*Project, error)

GetProjectContext returns a project with context

func (*Client) GetProjectDiskUsage 

func (c *Client) GetProjectDiskUsage(projectIDOrKey interface{}) (*ProjectDiskUsage, error)

GetProjectDiskUsage returns disk usage of a project

func (*Client) GetProjectDiskUsageContext 

func (c *Client) GetProjectDiskUsageContext(ctx context.Context, projectIDOrKey interface{}) (*ProjectDiskUsage, error)

GetProjectDiskUsageContext returns the list of administrators in a project with context

func (*Client) GetProjectIcon 

func (c *Client) GetProjectIcon(projectIDOrKey interface{}, writer io.Writer) error

GetProjectIcon downloads project icon

func (*Client) GetProjectIconContext 

func (c *Client) GetProjectIconContext(ctx context.Context, projectIDOrKey interface{}, writer io.Writer) error

GetProjectIconContext downloads project icon with context

func (*Client) GetProjectTeams 

func (c *Client) GetProjectTeams(projectIDOrKey interface{}) ([]*Team, error)

GetProjectTeams returns the list of teams in a project

func (*Client) GetProjectTeamsContext 

func (c *Client) GetProjectTeamsContext(ctx context.Context, projectIDOrKey interface{}) ([]*Team, error)

GetProjectTeamsContext returns the list of teams in a project with context

func (*Client) GetProjectUsers 

func (c *Client) GetProjectUsers(projectIDOrKey interface{}, opts *GetProjectUsersOptions) ([]*User, error)

GetProjectUsers returns the list of users in a project

func (*Client) GetProjectUsersContext 

func (c *Client) GetProjectUsersContext(ctx context.Context, projectIDOrKey interface{}, opts *GetProjectUsersOptions) ([]*User, error)

GetProjectUsersContext returns the list of users in a project with context

func (*Client) GetProjects 

func (c *Client) GetProjects(opts *GetProjectsOptions) ([]*Project, error)

GetProjects returns the list of projects

func (*Client) GetProjectsContext 

func (c *Client) GetProjectsContext(ctx context.Context, opts *GetProjectsOptions) ([]*Project, error)

GetProjectsContext returns the list of projects

func (*Client) GetRateLimit 

func (c *Client) GetRateLimit() (*RateLimit, error)

GetRateLimit returns the rate limit

func (*Client) GetRateLimitContext 

func (c *Client) GetRateLimitContext(ctx context.Context) (*RateLimit, error)

GetRateLimitContext returns the rate limit

func (*Client) GetResolutions 

func (c *Client) GetResolutions() ([]*Resolution, error)

GetResolutions returns the list of resolutions

func (*Client) GetResolutionsContext 

func (c *Client) GetResolutionsContext(ctx context.Context) ([]*Resolution, error)

GetResolutionsContext returns the list of resolutions with context

func (*Client) GetSpace 

func (c *Client) GetSpace() (*Space, error)

GetSpace returns backlog space

func (*Client) GetSpaceContext 

func (c *Client) GetSpaceContext(ctx context.Context) (*Space, error)

GetSpaceContext returns backlog space with context

func (*Client) GetSpaceDiskUsage 

func (c *Client) GetSpaceDiskUsage() (*SpaceDiskUsage, error)

GetSpaceDiskUsage returns the disk usage of a space

func (*Client) GetSpaceDiskUsageContext 

func (c *Client) GetSpaceDiskUsageContext(ctx context.Context) (*SpaceDiskUsage, error)

GetSpaceDiskUsageContext returns the disk usage of a space with context

func (*Client) GetSpaceIcon 

func (c *Client) GetSpaceIcon(writer io.Writer) error

GetSpaceIcon downloads space icon

func (*Client) GetSpaceIconContext 

func (c *Client) GetSpaceIconContext(ctx context.Context, writer io.Writer) error

GetSpaceIconContext downloads space icon with context

func (*Client) GetSpaceNotification 

func (c *Client) GetSpaceNotification() (*SpaceNotification, error)

GetSpaceNotification returns a space notification

func (*Client) GetSpaceNotificationContext 

func (c *Client) GetSpaceNotificationContext(ctx context.Context) (*SpaceNotification, error)

GetSpaceNotificationContext returns a space notification with context

func (*Client) GetStatuses 

func (c *Client) GetStatuses(projectIDOrKey interface{}) ([]*Status, error)

GetStatuses returns the statuses of a project

func (*Client) GetStatusesContext 

func (c *Client) GetStatusesContext(ctx context.Context, projectIDOrKey interface{}) ([]*Status, error)

GetStatusesContext returns the statuses of a project with context

func (*Client) GetTeam 

func (c *Client) GetTeam(teamID int) (*Team, error)

GetTeam returns a teams

func (*Client) GetTeamContext 

func (c *Client) GetTeamContext(ctx context.Context, teamID int) (*Team, error)

GetTeamContext returns a team with context

func (*Client) GetTeamIcon 

func (c *Client) GetTeamIcon(teamID int, writer io.Writer) error

GetTeamIcon downloads team icon

func (*Client) GetTeamIconContext 

func (c *Client) GetTeamIconContext(ctx context.Context, teamID int, writer io.Writer) error

GetTeamIconContext downloads team icon with context

func (*Client) GetTeams 

func (c *Client) GetTeams(opts *GetTeamsOptions) ([]*Team, error)

GetTeams returns the list of teams

func (*Client) GetTeamsContext 

func (c *Client) GetTeamsContext(ctx context.Context, opts *GetTeamsOptions) ([]*Team, error)

GetTeamsContext returns the list of teams with context

func (*Client) GetUser 

func (c *Client) GetUser(id int) (*User, error)

GetUser returns a user by id

func (*Client) GetUserActivities 

func (c *Client) GetUserActivities(id int, opts *GetUserActivitiesOptions) ([]*Activity, error)

GetUserActivities returns the list of a user's activities

func (*Client) GetUserActivitiesContext 

func (c *Client) GetUserActivitiesContext(ctx context.Context, id int, opts *GetUserActivitiesOptions) ([]*Activity, error)

GetUserActivitiesContext returns the list of a user's activities with context

func (*Client) GetUserContext 

func (c *Client) GetUserContext(ctx context.Context, id int) (*User, error)

GetUserContext will retrieve the complete user information by id with a custom context

func (*Client) GetUserIcon 

func (c *Client) GetUserIcon(id int, writer io.Writer) error

GetUserIcon downloads user icon

func (*Client) GetUserIconContext 

func (c *Client) GetUserIconContext(ctx context.Context, id int, writer io.Writer) error

GetUserIconContext downloads user icon with context

func (*Client) GetUserMySelf 

func (c *Client) GetUserMySelf() (*User, error)

GetUserMySelf returns get my user information

func (*Client) GetUserMySelfContext 

func (c *Client) GetUserMySelfContext(ctx context.Context) (*User, error)

GetUserMySelfContext will retrieve the complete my user information by id with a custom context

func (*Client) GetUserMySelfRecentrlyViewedIssues 

func (c *Client) GetUserMySelfRecentrlyViewedIssues(opts *GetUserMySelfRecentrlyViewedIssuesOptions) (Issues, error)

GetUserMySelfRecentrlyViewedIssues returns the list of issues a user view recently This api returns a json below: [ 

		{
        "issue":{
				"id":1111111,
				...
			}
		},
		{
        "issue":{
				"id":2222222,
				...
			}
		}
		...

]

func (*Client) GetUserMySelfRecentrlyViewedIssuesContext 

func (c *Client) GetUserMySelfRecentrlyViewedIssuesContext(ctx context.Context, opts *GetUserMySelfRecentrlyViewedIssuesOptions) (Issues, error)

GetUserMySelfRecentrlyViewedIssuesContext returns the list of issues a user view recently with context

func (*Client) GetUserStarCount 

func (c *Client) GetUserStarCount(id int, opts *GetUserStarCountOptions) (int, error)

GetUserStarCount returns the count of stars

func (*Client) GetUserStarCountContext 

func (c *Client) GetUserStarCountContext(ctx context.Context, id int, opts *GetUserStarCountOptions) (int, error)

GetUserStarCountContext returns the count of stars with context

func (*Client) GetUserStars 

func (c *Client) GetUserStars(id int, opts *GetUserStarsOptions) ([]*Star, error)

GetUserStars returns the list of stared contents

func (*Client) GetUserStarsContext 

func (c *Client) GetUserStarsContext(ctx context.Context, id int, opts *GetUserStarsOptions) ([]*Star, error)

GetUserStarsContext returns the list of a user's activities with context

func (*Client) GetUserWatchings 

func (c *Client) GetUserWatchings(userID int) ([]*Watching, error)

GetUserWatchings returns the list of user's watchings

func (*Client) GetUserWatchingsContext 

func (c *Client) GetUserWatchingsContext(ctx context.Context, userID int) ([]*Watching, error)

GetUserWatchingsContext returns the list of user's watchings with context

func (*Client) GetUserWatchingsCount 

func (c *Client) GetUserWatchingsCount(userID int, opts *GetUserWatchingsCountOptions) (int, error)

GetUserWatchingsCount returns the count of user's watchings

func (*Client) GetUserWatchingsCountContext 

func (c *Client) GetUserWatchingsCountContext(ctx context.Context, userID int, opts *GetUserWatchingsCountOptions) (int, error)

GetUserWatchingsCountContext returns the count of user's watchings with context

func (*Client) GetUsers 

func (c *Client) GetUsers() ([]*User, error)

GetUsers returns the list of users

func (*Client) GetUsersContext 

func (c *Client) GetUsersContext(ctx context.Context) ([]*User, error)

GetUsersContext returns the list of users

func (*Client) GetVersions 

func (c *Client) GetVersions(projectIDOrKey interface{}) ([]*Version, error)

GetVersions returns the list of versions in a project

func (*Client) GetVersionsContext 

func (c *Client) GetVersionsContext(ctx context.Context, projectIDOrKey interface{}) ([]*Version, error)

GetVersionsContext returns a version of a project with context

func (*Client) GetWatching 

func (c *Client) GetWatching(watchingID int) (*Watching, error)

GetWatching returns a watching

func (*Client) GetWatchingContext 

func (c *Client) GetWatchingContext(ctx context.Context, watchingID int) (*Watching, error)

GetWatchingContext returns a watching with context

func (*Client) GetWebhook 

func (c *Client) GetWebhook(projectIDOrKey interface{}, webhookID int) (*Webhook, error)

GetWebhook returns the list of webhooks

func (*Client) GetWebhookContext 

func (c *Client) GetWebhookContext(ctx context.Context, projectIDOrKey interface{}, webhookID int) (*Webhook, error)

GetWebhookContext returns the list of webhooks with context

func (*Client) GetWebhooks 

func (c *Client) GetWebhooks(projectIDOrKey interface{}) ([]*Webhook, error)

GetWebhooks returns the list of webhooks

func (*Client) GetWebhooksContext 

func (c *Client) GetWebhooksContext(ctx context.Context, projectIDOrKey interface{}) ([]*Webhook, error)

GetWebhooksContext returns the list of webhooks with context

func (*Client) GetWiki 

func (c *Client) GetWiki(wikiID int) (*Wiki, error)

GetWiki returns wiki by id

func (*Client) GetWikiAttachmentContent 

func (c *Client) GetWikiAttachmentContent(wikiID, attachmentID int, w io.Writer) error

GetWikiAttachmentContent writes the content to writer

func (*Client) GetWikiAttachmentContentContext 

func (c *Client) GetWikiAttachmentContentContext(ctx context.Context, wikiID, attachmentID int, w io.Writer) error

GetWikiAttachmentContentContext writes the content to writer

func (*Client) GetWikiAttachments 

func (c *Client) GetWikiAttachments(wikiID int) ([]*Attachment, error)

GetWikiAttachments returns attachements of a wiki

func (*Client) GetWikiAttachmentsContext 

func (c *Client) GetWikiAttachmentsContext(ctx context.Context, wikiID int) ([]*Attachment, error)

GetWikiAttachmentsContext returns attachements of a wiki with context

func (*Client) GetWikiContext 

func (c *Client) GetWikiContext(ctx context.Context, wikiID int) (*Wiki, error)

GetWikiContext returns wiki by id

func (*Client) GetWikiCount 

func (c *Client) GetWikiCount(opts *GetWikiCountOptions) (int, error)

GetWikiCount returns the number of wikis

func (*Client) GetWikiCountContext 

func (c *Client) GetWikiCountContext(ctx context.Context, opts *GetWikiCountOptions) (int, error)

GetWikiCountContext returns the number of wikis

func (*Client) GetWikiTags 

func (c *Client) GetWikiTags(opts *GetWikiTagsOptions) ([]*Tag, error)

GetWikiTags returns the tags of wikis

func (*Client) GetWikiTagsContext 

func (c *Client) GetWikiTagsContext(ctx context.Context, opts *GetWikiTagsOptions) ([]*Tag, error)

GetWikiTagsContext returns the tags of wikis

func (*Client) GetWikis 

func (c *Client) GetWikis(opts *GetWikisOptions) ([]*Wiki, error)

GetWikis returns the list of wikis

func (*Client) GetWikisContext 

func (c *Client) GetWikisContext(ctx context.Context, opts *GetWikisOptions) ([]*Wiki, error)

GetWikisContext returns the list of wikis

func (*Client) MarkAsReadWatching 

func (c *Client) MarkAsReadWatching(watchingID int) error

MarkAsReadWatching marks a watching as read

func (*Client) MarkAsReadWatchingContext 

func (c *Client) MarkAsReadWatchingContext(ctx context.Context, watchingID int) error

MarkAsReadWatchingContext marks a watching as read with Context

func (*Client) NewRequest 

func (c *Client) NewRequest(method, urlStr string, body interface{}) (*http.Request, error)

NewRequest creates an API request. A relative URL can be provided in urlStr, in which case it is resolved relative to the BaseURL of the Client. Relative URLs should always be specified without a preceding slash. If specified, the value pointed to by body is JSON encoded and included as the request body.

func (*Client) SortStatuses 

func (c *Client) SortStatuses(projectIDOrKey interface{}, input *SortStatusesInput) ([]*Status, error)

SortStatuses sorts the list of statuses

func (*Client) SortStatusesContext 

func (c *Client) SortStatusesContext(ctx context.Context, projectIDOrKey interface{}, input *SortStatusesInput) ([]*Status, error)

SortStatusesContext sorts the list of statuses with context

func (*Client) UpdateCategory 

func (c *Client) UpdateCategory(projectIDOrKey interface{}, categoryID int, input *UpdateCategoryInput) (*Category, error)

UpdateCategory updates a category

func (*Client) UpdateCategoryContext 

func (c *Client) UpdateCategoryContext(ctx context.Context, projectIDOrKey interface{}, categoryID int, input *UpdateCategoryInput) (*Category, error)

UpdateCategoryContext updates a category with Context

func (*Client) UpdateIssue 

func (c *Client) UpdateIssue(issueIDOrKey string, input *UpdateIssueInput) (*Issue, error)

UpdateIssue updates a issue

func (*Client) UpdateIssueComment 

func (c *Client) UpdateIssueComment(issueIDOrKey string, commentID int, input *UpdateIssueCommentInput) (*IssueComment, error)

UpdateIssueComment updates a issue comment

func (*Client) UpdateIssueCommentContext 

func (c *Client) UpdateIssueCommentContext(ctx context.Context, issueIDOrKey string, commentID int, input *UpdateIssueCommentInput) (*IssueComment, error)

UpdateIssueCommentContext updates a issue comment with context

func (*Client) UpdateIssueContext 

func (c *Client) UpdateIssueContext(ctx context.Context, issueIDOrKey string, input *UpdateIssueInput) (*Issue, error)

UpdateIssueContext updates a issue with context

func (*Client) UpdateIssueType 

func (c *Client) UpdateIssueType(projectIDOrKey interface{}, issueTypeID int, input *UpdateIssueTypeInput) (*IssueType, error)

UpdateIssueType updates an issue type

func (*Client) UpdateIssueTypeContext 

func (c *Client) UpdateIssueTypeContext(ctx context.Context, projectIDOrKey interface{}, issueTypeID int, input *UpdateIssueTypeInput) (*IssueType, error)

UpdateIssueTypeContext updates an issue type with Context

func (*Client) UpdateProject 

func (c *Client) UpdateProject(id int, input *UpdateProjectInput) (*Project, error)

UpdateProject updates a project

func (*Client) UpdateProjectContext 

func (c *Client) UpdateProjectContext(ctx context.Context, id int, input *UpdateProjectInput) (*Project, error)

UpdateProjectContext updates a project with Context

func (*Client) UpdateSpaceNotification 

func (c *Client) UpdateSpaceNotification(input *UpdateSpaceNotificationInput) (*SpaceNotification, error)

UpdateSpaceNotification updates a space notification

func (*Client) UpdateSpaceNotificationContext 

func (c *Client) UpdateSpaceNotificationContext(ctx context.Context, input *UpdateSpaceNotificationInput) (*SpaceNotification, error)

UpdateSpaceNotificationContext updates a space notification with context

func (*Client) UpdateStatus 

func (c *Client) UpdateStatus(projectIDOrKey interface{}, statusID int, input *UpdateStatusInput) (*Status, error)

UpdateStatus updates a status

func (*Client) UpdateStatusContext 

func (c *Client) UpdateStatusContext(ctx context.Context, projectIDOrKey interface{}, statusID int, input *UpdateStatusInput) (*Status, error)

UpdateStatusContext updates a status

func (*Client) UpdateTeam 

func (c *Client) UpdateTeam(teamID int, input *UpdateTeamInput) (*Team, error)

UpdateTeam updates a team

func (*Client) UpdateTeamContext 

func (c *Client) UpdateTeamContext(ctx context.Context, teamID int, input *UpdateTeamInput) (*Team, error)

UpdateTeamContext updates a team with Context

func (*Client) UpdateUser 

func (c *Client) UpdateUser(id int, input *UpdateUserInput) (*User, error)

UpdateUser updates a user

func (*Client) UpdateUserContext 

func (c *Client) UpdateUserContext(ctx context.Context, id int, input *UpdateUserInput) (*User, error)

UpdateUserContext updates a user with Context

func (*Client) UpdateVersion 

func (c *Client) UpdateVersion(projectIDOrKey interface{}, versionID int, input *UpdateVersionInput) (*Version, error)

UpdateVersion updates a versions (milestone) of a project

func (*Client) UpdateVersionContext 

func (c *Client) UpdateVersionContext(ctx context.Context, projectIDOrKey interface{}, versionID int, input *UpdateVersionInput) (*Version, error)

UpdateVersionContext updates a versions (milestone) of a project with Context

func (*Client) UpdateWatching 

func (c *Client) UpdateWatching(watchingID int, input *UpdateWatchingInput) (*Watching, error)

UpdateWatching updates a watching

func (*Client) UpdateWatchingContext 

func (c *Client) UpdateWatchingContext(ctx context.Context, watchingID int, input *UpdateWatchingInput) (*Watching, error)

UpdateWatchingContext updates a watching with Context

func (*Client) UpdateWebhook 

func (c *Client) UpdateWebhook(projectIDOrKey interface{}, webhookID int, input *UpdateWebhookInput) (*Webhook, error)

UpdateWebhook updates a webhook

func (*Client) UpdateWebhookContext 

func (c *Client) UpdateWebhookContext(ctx context.Context, projectIDOrKey interface{}, webhookID int, input *UpdateWebhookInput) (*Webhook, error)

UpdateWebhookContext updates a webhook with context

func (*Client) UpdateWiki 

func (c *Client) UpdateWiki(wikiID int, input *UpdateWikiInput) (*Wiki, error)

UpdateWiki updates a wiki

func (*Client) UpdateWikiContext 

func (c *Client) UpdateWikiContext(ctx context.Context, wikiID int, input *UpdateWikiInput) (*Wiki, error)

UpdateWikiContext updates a wiki with Context

func (*Client) UploadFile 

func (c *Client) UploadFile(fpath string) (*FileUploadResponse, error)

UploadFile uploads a file

func (*Client) UploadFileContext 

func (c *Client) UploadFileContext(ctx context.Context, fpath string) (*FileUploadResponse, error)

UploadFileContext uploads a file and setting a custom context

func (*Client) UploadMultipartFile 

func (c *Client) UploadMultipartFile(ctx context.Context, method, urlStr, fpath, field string, v interface{}) (err error)

UploadMultipartFile uploads multipart file

type Comment 

type Comment struct {
	ID      *int    `json:"id,omitempty"`
	Content *string `json:"content,omitempty"`
}

Comment : -

type Content 

type Content struct {
	ID          *int      `json:"id,omitempty"`
	KeyID       *int      `json:"key_id,omitempty"`
	Summary     *string   `json:"summary,omitempty"`
	Description *string   `json:"description,omitempty"`
	Comment     *Comment  `json:"comment,omitempty"`
	Changes     []*Change `json:"changes,omitempty"`
}

Content : -

type CreateCategoryInput 

type CreateCategoryInput struct {
	Name *string `json:"name"`
}

CreateCategoryInput specifies parameters to the CreateCategory method.

type CreateIssueCommentInput 

type CreateIssueCommentInput struct {
	Content         *string `json:"content"`
	NotifiedUserIDs []int   `json:"notifiedUserId,omitempty"`
	AttachmentIDs   []int   `json:"attachmentId,omitempty"`
}

CreateIssueCommentInput specifies parameters to the CreateIssueComment method.

type CreateIssueCommentsNotificationInput 

type CreateIssueCommentsNotificationInput struct {
	NotifiedUserIDs []int `json:"notifiedUserId,omitempty"`
}

CreateIssueCommentsNotificationInput specifies parameters to the CreateIssueCommentsNotification method.

type CreateIssueInput 

type CreateIssueInput struct {
	ProjectID       *int                `json:"projectId"`
	Summary         *string             `json:"summary"`
	ParentIssueID   *int                `json:"parentIssueId,omitempty"`
	Description     *string             `json:"description,omitempty"`
	StartDate       *string             `json:"startDate,omitempty"`
	DueDate         *string             `json:"dueDate,omitempty"`
	EstimatedHours  *float64            `json:"estimatedHours,omitempty"`
	ActualHours     *float64            `json:"actualHours,omitempty"`
	IssueTypeID     *int                `json:"issueTypeId"`
	CategoryIDs     []int               `json:"categoryId,omitempty"`
	VersionIDs      []int               `json:"versionId,omitempty"`
	MilestoneIDs    []int               `json:"milestoneId,omitempty"`
	PriorityID      *int                `json:"priorityId"`
	AssigneeID      *int                `json:"assigneeId,omitempty"`
	NotifiedUserIDs []int               `json:"notifiedUserId,omitempty"`
	AttachmentIDs   []int               `json:"attachmentId,omitempty"`
	CustomFields    []*IssueCustomField `json:"-"`
}

CreateIssueInput specifies parameters to the CreateIssue method.

type CreateIssueSharedFilesInput 

type CreateIssueSharedFilesInput struct {
	FileIDs []int `json:"fileId,omitempty"`
}

CreateIssueSharedFilesInput specifies parameters to the CreateIssueSharedFiles method.

type CreateIssueTypeInput 

type CreateIssueTypeInput struct {
	Name                *string `json:"name"`
	Color               *string `json:"color"`
	TemplateSummary     *string `json:"templateSummary,omitempty"`
	TemplateDescription *string `json:"templateDescription,omitempty"`
}

CreateIssueTypeInput specifies parameters to the CreateIssueType method.

type CreateProjectInput 

type CreateProjectInput struct {
	Name                              *string `json:"name"`
	Key                               *string `json:"key"`
	ChartEnabled                      *bool   `json:"chartEnabled"`
	ProjectLeaderCanEditProjectLeader *bool   `json:"projectLeaderCanEditProjectLeader,omitempty"`
	SubtaskingEnabled                 *bool   `json:"subtaskingEnabled"`
	TextFormattingRule                *string `json:"textFormattingRule"`
}

CreateProjectInput contains all the parameters necessary (including the optional ones) for a CreateProject() request.

type CreateStatusInput 

type CreateStatusInput struct {
	Name  *string `json:"name"`
	Color *string `json:"color"`
}

CreateStatusInput specifies parameters to the CreateStatus method.

type CreateTeamInput 

type CreateTeamInput struct {
	Name    *string `json:"name"`
	Members []int   `json:"members,omitempty"`
}

CreateTeamInput specifies parameters to the CreateTeam method.

type CreateUserInput 

type CreateUserInput struct {
	UserID      *string
	Password    *string
	Name        *string
	MailAddress *string
	RoleType    RoleType
}

CreateUserInput contains all the parameters necessary (including the optional ones) for a CreateUser() request.

type CreateVersionInput 

type CreateVersionInput struct {
	Name           *string `json:"name"`
	Description    *string `json:"description,omitempty"`
	StartDate      *string `json:"startDate,omitempty"`
	ReleaseDueDate *string `json:"releaseDueDate,omitempty"`
}

CreateVersionInput specifies parameters to the CreateVersion method.

type CreateWatchingInput 

type CreateWatchingInput struct {
	IssueIDOrKey *string `json:"issueIdOrKey"`
	Note         *string `json:"note,omitempty"`
}

CreateWatchingInput specifies parameters to the CreateWatching method.

type CreateWebhookInput 

type CreateWebhookInput struct {
	Name            *string `json:"name"`
	Description     *string `json:"description,omitempty"`
	HookURL         *string `json:"hookUrl"`
	AllEvent        *bool   `json:"allEvent,omitempty"`
	ActivityTypeIDs []int   `json:"activityTypeIds,omitempty"`
}

CreateWebhookInput contains all the parameters necessary (including the optional ones) for a CreateWebhook() request.

type CreateWikiInput 

type CreateWikiInput struct {
	ProjectID  *int    `json:"projectId"`
	Name       *string `json:"name"`
	Content    *string `json:"content"`
	MailNotify *bool   `json:"mailNotify,omitempty"`
}

CreateWikiInput contains all the parameters necessary (including the optional ones) for a CreateWiki() request.

type CustomField 

type CustomField struct {
	ID                   *int    `json:"id,omitempty"`
	TypeID               *int    `json:"typeId,omitempty"`
	Name                 *string `json:"name,omitempty"`
	Description          *string `json:"description,omitempty"`
	Required             *bool   `json:"required,omitempty"`
	ApplicableIssueTypes []int   `json:"applicableIssueTypes,omitempty"`
	AllowAddItem         *bool   `json:"allowAddItem,omitempty"`
	Items                []*Item `json:"items,omitempty"`
}

CustomField : custom field

type DeleteIssueTypeInput 

type DeleteIssueTypeInput struct {
	SubstituteIssueTypeID *int `json:"substituteIssueTypeId,omitempty"`
}

DeleteIssueTypeInput specifies parameters to the DeleteIssueType method.

type DeleteProjectAdministratorInput 

type DeleteProjectAdministratorInput struct {
	UserID *int `json:"userId"`
}

DeleteProjectAdministratorInput specifies parameters to the DeleteProjectAdministrator method.

type DeleteProjectTeamInput 

type DeleteProjectTeamInput struct {
	TeamID *int `json:"teamId"`
}

DeleteProjectTeamInput specifies parameters to the DeleteProjectTeam method.

type DeleteProjectUserInput 

type DeleteProjectUserInput struct {
	UserID *int `json:"userId"`
}

DeleteProjectUserInput specifies parameters to the DeleteProjectUser method.

type DeleteStatusInput 

type DeleteStatusInput struct {
	SubstituteStatusID *int `json:"substituteStatusId"`
}

DeleteStatusInput specifies parameters to the DeleteStatus method.

type Error 

type Error struct {
	Message  *string `json:"message,omitempty"`
	Code     *int    `json:"code,omitempty"`
	MoreInfo *string `json:"moreInfo,omitempty"`
}

Error is backlog error

type ErrorResponse 

type ErrorResponse struct {
	Errors []*Error `json:"errors"`
}

ErrorResponse is backlog error response

func (ErrorResponse) Errs 

func (t ErrorResponse) Errs() error

Errs : error

type FileUploadResponse 

type FileUploadResponse struct {
	ID   *int    `json:"id,omitempty"`
	Name *string `json:"name,omitempty"`
	Size *int    `json:"size,omitempty"`
}

FileUploadResponse : response of uploading file

type GetIssueCommentsOptions 

type GetIssueCommentsOptions struct {
	MinID *int  `json:"minId,omitempty"`
	MaxID *int  `json:"maxId,omitempty"`
	Count *int  `json:"count,omitempty"`
	Order Order `json:"order,omitempty"`
}

GetIssueCommentsOptions specifies parameters to the GetIssueComments method.

type GetIssuesCountOptions 

type GetIssuesCountOptions struct {
	ProjectIDs     []int   `url:"projectId[],omitempty"`
	IssueTypeIDs   []int   `url:"issueTypeId[],omitempty"`
	CategoryIDs    []int   `url:"categoryId[],omitempty"`
	VersionIDs     []int   `url:"versionId[],omitempty"`
	MilestoneIDs   []int   `url:"milestoneId[],omitempty"`
	StatusIDs      []int   `url:"statusId[],omitempty"`
	PriorityIDs    []int   `url:"priorityId[],omitempty"`
	AssigneeIDs    []int   `url:"assigneeId[],omitempty"`
	CreatedUserIDs []int   `url:"createdUserId[],omitempty"`
	ResolutionIDs  []int   `url:"resolutionId[],omitempty"`
	ParentChild    *int    `url:"parentChild,omitempty"`
	Attachment     *bool   `url:"attachment,omitempty"`
	SharedFile     *bool   `url:"sharedFile,omitempty"`
	Sort           Sort    `url:"sort,omitempty"`
	Order          Order   `url:"order,omitempty"`
	Offset         *int    `url:"offset,omitempty"`
	Count          *int    `url:"count,omitempty"`
	CreatedSince   *string `url:"createdSince,omitempty"`
	CreatedUntil   *string `url:"createdUntil,omitempty"`
	UpdatedSince   *string `url:"updatedSince,omitempty"`
	UpdatedUntil   *string `url:"updatedUntil,omitempty"`
	StartDateSince *string `url:"startDateSince,omitempty"`
	StartDateUntil *string `url:"startDateUntil,omitempty"`
	DueDateSince   *string `url:"dueDateSince,omitempty"`
	DueDateUntil   *string `url:"dueDateUntil,omitempty"`
	IDs            []int   `url:"id[],omitempty"`
	ParentIssueIDs []int   `url:"parentIssueId[],omitempty"`
	Keyword        *string `url:"keyword,omitempty"`
}

GetIssuesCountOptions specifies parameters to the GetIssueCount method.

type GetIssuesOptions 

type GetIssuesOptions struct {
	ProjectIDs     []int   `url:"projectId[],omitempty"`
	IssueTypeIDs   []int   `url:"issueTypeId[],omitempty"`
	CategoryIDs    []int   `url:"categoryId[],omitempty"`
	VersionIDs     []int   `url:"versionId[],omitempty"`
	MilestoneIDs   []int   `url:"milestoneId[],omitempty"`
	StatusIDs      []int   `url:"statusId[],omitempty"`
	PriorityIDs    []int   `url:"priorityId[],omitempty"`
	AssigneeIDs    []int   `url:"assigneeId[],omitempty"`
	CreatedUserIDs []int   `url:"createdUserId[],omitempty"`
	ResolutionIDs  []int   `url:"resolutionId[],omitempty"`
	ParentChild    *int    `url:"parentChild,omitempty"`
	Attachment     *bool   `url:"attachment,omitempty"`
	SharedFile     *bool   `url:"sharedFile,omitempty"`
	Sort           Sort    `url:"sort,omitempty"`
	Order          Order   `url:"order,omitempty"`
	Offset         *int    `url:"offset,omitempty"`
	Count          *int    `url:"count,omitempty"`
	CreatedSince   *string `url:"createdSince,omitempty"`
	CreatedUntil   *string `url:"createdUntil,omitempty"`
	UpdatedSince   *string `url:"updatedSince,omitempty"`
	UpdatedUntil   *string `url:"updatedUntil,omitempty"`
	StartDateSince *string `url:"startDateSince,omitempty"`
	StartDateUntil *string `url:"startDateUntil,omitempty"`
	DueDateSince   *string `url:"dueDateSince,omitempty"`
	DueDateUntil   *string `url:"dueDateUntil,omitempty"`
	IDs            []int   `url:"id[],omitempty"`
	ParentIssueIDs []int   `url:"parentIssueId[],omitempty"`
	Keyword        *string `url:"keyword,omitempty"`
}

GetIssuesOptions specifies parameters to the GetIssues method.

type GetMyRecentlyViewedProjectsOptions 

type GetMyRecentlyViewedProjectsOptions struct {
	Order  Order `url:"order,omitempty"`
	Offset *int  `url:"offset,omitempty"`
	Count  *int  `url:"count,omitempty"`
}

GetMyRecentlyViewedProjectsOptions specifies parameters to the GetMyRecentlyViewedProject method.

type GetMyRecentlyViewedWikisOptions 

type GetMyRecentlyViewedWikisOptions struct {
	Order  Order `url:"order,omitempty"`
	Offset *int  `url:"offset,omitempty"`
	Count  *int  `url:"count,omitempty"`
}

GetMyRecentlyViewedWikisOptions specifies parameters to the GetMyRecentlyViewedWikis method.

type GetProjectActivitiesOptions 

type GetProjectActivitiesOptions struct {
	ActivityTypeIDs []int `url:"activityTypeId[],omitempty"`
	MinID           *int  `url:"minId,omitempty"`
	MaxID           *int  `url:"maxId,omitempty"`
	Count           *int  `url:"count,omitempty"`
	Order           Order `url:"order,omitempty"`
}

GetProjectActivitiesOptions specifies parameters to the GetProjectActivities method.

type GetProjectUsersOptions 

type GetProjectUsersOptions struct {
	ExcludeGroupMembers *bool `url:"excludeGroupMembers,omitempty"`
}

GetProjectUsersOptions specifies parameters to the GetProjectUsers method.

type GetProjectsOptions 

type GetProjectsOptions struct {
	Archived *bool `url:"archived"`
	All      *bool `url:"all"`
}

GetProjectsOptions contains all the parameters necessary (including the optional ones) for a GetProjects() request.

type GetTeamsOptions 

type GetTeamsOptions struct {
	Order  Order `url:"order,omitempty"`
	Offset *int  `url:"offset,omitempty"`
	Count  *int  `url:"count,omitempty"`
}

GetTeamsOptions specifies parameters to the GetTeams method.

type GetUserActivitiesOptions 

type GetUserActivitiesOptions struct {
	ActivityTypeIDs []int `url:"activityTypeId[],omitempty"`
	MinID           *int  `url:"minId,omitempty"`
	MaxID           *int  `url:"maxId,omitempty"`
	Count           *int  `url:"count,omitempty"`
	Order           Order `url:"order,omitempty"`
}

GetUserActivitiesOptions specifies parameters to the GetUserActivities method.

type GetUserMySelfRecentrlyViewedIssuesOptions 

type GetUserMySelfRecentrlyViewedIssuesOptions struct {
	Order  Order `url:"order,omitempty"`
	Offset *int  `url:"offset,omitempty"`
	Count  *int  `url:"count,omitempty"`
}

GetUserMySelfRecentrlyViewedIssuesOptions specifies parameters to the GetUserMySelfRecentrlyViewedIssues method.

type GetUserStarCountOptions 

type GetUserStarCountOptions struct {
	Since *string `url:"since,omitempty"`
	Until *string `url:"until,omitempty"`
}

GetUserStarCountOptions specifies parameters to the GetUserStarCount method.

type GetUserStarsOptions 

type GetUserStarsOptions struct {
	MinID *int  `url:"minId,omitempty"`
	MaxID *int  `url:"maxId,omitempty"`
	Count *int  `url:"count,omitempty"`
	Order Order `url:"order,omitempty"`
}

GetUserStarsOptions specifies parameters to the GetUserStars method.

type GetUserWatchingsCountOptions 

type GetUserWatchingsCountOptions struct {
	ResourceAlreadyRead *bool `url:"resourceAlreadyRead,omitempty"`
	AlreadyRead         *bool `url:"alreadyRead,omitempty"`
}

GetUserWatchingsCountOptions specifies parameters to the GetUserWatchingsCount method.

type GetUserWatchingsOptions 

type GetUserWatchingsOptions struct {
	Order               *Order  `url:"order,omitempty"`
	Sort                *string `url:"sort,omitempty"`
	Count               *int    `url:"count,omitempty"`
	Offset              *int    `url:"offset,omitempty"`
	ResourceAlreadyRead *bool   `url:"resourceAlreadyRead,omitempty"`
	IssueIDs            []int   `url:"issueId[],omitempty"`
}

GetUserWatchingsOptions specifies parameters to the GetUserWatchings method.

type GetWikiCountOptions 

type GetWikiCountOptions struct {
	ProjectIDOrKey interface{} `url:"projectIdOrKey,omitempty"`
}

GetWikiCountOptions specifies parameters to the GetWikiCount method.

type GetWikiTagsOptions 

type GetWikiTagsOptions struct {
	ProjectIDOrKey interface{} `url:"projectIdOrKey,omitempty"`
}

GetWikiTagsOptions specifies parameters to the GetWikiTags method.

type GetWikisOptions 

type GetWikisOptions struct {
	ProjectIDOrKey interface{} `url:"projectIdOrKey"`
	Keyword        *string     `url:"keyword,omitempty"`
}

GetWikisOptions specifies parameters to the GetWikis method.

type Issue 

type Issue struct {
	ID             *int                `json:"id,omitempty"`
	ProjectID      *int                `json:"projectId,omitempty"`
	IssueKey       *string             `json:"issueKey,omitempty"`
	KeyID          *int                `json:"keyId,omitempty"`
	IssueType      *IssueType          `json:"issueType,omitempty"`
	Summary        *string             `json:"summary,omitempty"`
	Description    *string             `json:"description,omitempty"`
	Resolution     *Resolution         `json:"resolution,omitempty"`
	Priority       *Priority           `json:"priority,omitempty"`
	Status         *Status             `json:"status,omitempty"`
	Assignee       *User               `json:"assignee,omitempty"`
	Category       []*Category         `json:"category,omitempty"`
	Versions       []*Version          `json:"versions,omitempty"`
	Milestone      []*Milestone        `json:"milestone,omitempty"`
	StartDate      *string             `json:"startDate,omitempty"`
	DueDate        *string             `json:"dueDate,omitempty"`
	EstimatedHours *float64            `json:"estimatedHours,omitempty"`
	ActualHours    *float64            `json:"actualHours,omitempty"`
	ParentIssueID  *int                `json:"parentIssueId,omitempty"`
	CreatedUser    *User               `json:"createdUser,omitempty"`
	Created        *Timestamp          `json:"created,omitempty"`
	UpdatedUser    *User               `json:"updatedUser,omitempty"`
	Updated        *Timestamp          `json:"updated,omitempty"`
	CustomFields   []*IssueCustomField `json:"customFields,omitempty"`
	Attachments    []*Attachment       `json:"attachments,omitempty"`
	SharedFiles    []*SharedFile       `json:"sharedFiles,omitempty"`
	Stars          []*Star             `json:"stars,omitempty"`
}

Issue : -

type IssueComment 

type IssueComment struct {
	ID            *int            `json:"id,omitempty"`
	Content       *string         `json:"content,omitempty"`
	ChangeLog     []*ChangeLog    `json:"changeLog,omitempty"`
	CreatedUser   *User           `json:"createdUser,omitempty"`
	Created       *Timestamp      `json:"created,omitempty"`
	Updated       *Timestamp      `json:"updated,omitempty"`
	Stars         []*Star         `json:"stars,omitempty"`
	Notifications []*Notification `json:"notifications,omitempty"`
}

IssueComment : issue comment

type IssueCustomField 

type IssueCustomField struct {
	ID          *int        `json:"id,omitempty"`
	FieldTypeID *int        `json:"fieldTypeId,omitempty"`
	Name        *string     `json:"name,omitempty"`
	Value       interface{} `json:"value,omitempty"`
}

IssueCustomField : custom field in issue

type IssueType 

type IssueType struct {
	ID                  *int    `json:"id,omitempty"`
	ProjectID           *int    `json:"projectId,omitempty"`
	Name                *string `json:"name,omitempty"`
	Color               *string `json:"color,omitempty"`
	DisplayOrder        *int    `json:"displayOrder,omitempty"`
	TemplateSummary     *string `json:"templateSummary,omitempty"`
	TemplateDescription *string `json:"templateDescription,omitempty"`
}

IssueType : issue type

type Issues 

type Issues []*struct {
	Issue *Issue `json:"issue"`
}

Issues : list of issue

type Item 

type Item struct {
	ID           *int    `json:"id,omitempty"`
	Name         *string `json:"name,omitempty"`
	DisplayOrder *int    `json:"displayOrder,omitempty"`
}

Item : item

type License 

type License struct {
	Active                            *bool      `json:"active,omitempty"`
	AttachmentLimit                   *int       `json:"attachmentLimit,omitempty"`
	AttachmentLimitPerFile            *int       `json:"attachmentLimitPerFile,omitempty"`
	AttachmentNumLimit                *int       `json:"attachmentNumLimit,omitempty"`
	Attribute                         *bool      `json:"attribute,omitempty"`
	AttributeLimit                    *int       `json:"attributeLimit,omitempty"`
	Burndown                          *bool      `json:"burndown,omitempty"`
	CommentLimit                      *int       `json:"commentLimit,omitempty"`
	ComponentLimit                    *int       `json:"componentLimit,omitempty"`
	FileSharing                       *bool      `json:"fileSharing,omitempty"`
	Gantt                             *bool      `json:"gantt,omitempty"`
	Git                               *bool      `json:"git,omitempty"`
	IssueLimit                        *int       `json:"issueLimit,omitempty"`
	LicenceTypeID                     *int       `json:"licenceTypeId,omitempty"`
	LimitDate                         *Timestamp `json:"limitDate,omitempty"`
	NulabAccount                      *bool      `json:"nulabAccount,omitempty"`
	ParentChildIssue                  *bool      `json:"parentChildIssue,omitempty"`
	PostIssueByMail                   *bool      `json:"postIssueByMail,omitempty"`
	ProjectGroup                      *bool      `json:"projectGroup,omitempty"`
	ProjectLimit                      *int       `json:"projectLimit,omitempty"`
	PullRequestAttachmentLimitPerFile *int       `json:"pullRequestAttachmentLimitPerFile,omitempty"`
	PullRequestAttachmentNumLimit     *int       `json:"pullRequestAttachmentNumLimit,omitempty"`
	RemoteAddress                     *bool      `json:"remoteAddress,omitempty"`
	RemoteAddressLimit                *int       `json:"remoteAddressLimit,omitempty"`
	StartedOn                         *Timestamp `json:"startedOn,omitempty"`
	StorageLimit                      *int64     `json:"storageLimit,omitempty"`
	Subversion                        *bool      `json:"subversion,omitempty"`
	SubversionExternal                *bool      `json:"subversionExternal,omitempty"`
	UserLimit                         *int       `json:"userLimit,omitempty"`
	VersionLimit                      *int       `json:"versionLimit,omitempty"`
	WikiAttachment                    *bool      `json:"wikiAttachment,omitempty"`
	WikiAttachmentLimitPerFile        *int       `json:"wikiAttachmentLimitPerFile,omitempty"`
	WikiAttachmentNumLimit            *int       `json:"wikiAttachmentNumLimit,omitempty"`
}

License : license

type LimitStatus 

type LimitStatus struct {
	Limit     *int `json:"limit,omitempty"`
	Remaining *int `json:"remaining,omitempty"`
	Reset     *int `json:"reset,omitempty"`
}

LimitStatus : limit status

func (*LimitStatus) ResetAsTime 

func (ls *LimitStatus) ResetAsTime() time.Time

ResetAsTime returns reset as time

type Milestone 

type Milestone struct {
	ID             *int    `json:"id,omitempty"`
	ProjectID      *int    `json:"projectId,omitempty"`
	Name           *string `json:"name,omitempty"`
	Description    *string `json:"description,omitempty"`
	StartDate      *string `json:"startDate,omitempty"`
	ReleaseDueDate *string `json:"releaseDueDate,omitempty"`
	Archived       *bool   `json:"archived,omitempty"`
}

Milestone : milestone

type Notification 

type Notification struct {
	ID                  *int  `json:"id,omitempty"`
	AlreadyRead         *bool `json:"alreadyRead,omitempty"`
	Reason              *int  `json:"reason,omitempty"`
	User                *User `json:"user,omitempty"`
	ResourceAlreadyRead *bool `json:"resourceAlreadyRead,omitempty"`
}

Notification : -

type NotificationInfo 

type NotificationInfo struct {
	Type *string `json:"type,omitempty"`
}

NotificationInfo : notification information

type Option 

type Option func(*Client)

Option defines an option for a Client

type Order 

type Order string

Order : asc or desc

func (Order) String 

func (k Order) String() string

type Page 

type Page struct {
	Count *int `json:"count,omitempty"`
}

Page : wiki page information

type Priority 

type Priority struct {
	ID   *int    `json:"id,omitempty"`
	Name *string `json:"name,omitempty"`
}

Priority : priority

type Project 

type Project struct {
	ID                                *int    `json:"id,omitempty"`
	ProjectKey                        *string `json:"projectKey,omitempty"`
	Name                              *string `json:"name,omitempty"`
	ChartEnabled                      *bool   `json:"chartEnabled,omitempty"`
	SubtaskingEnabled                 *bool   `json:"subtaskingEnabled,omitempty"`
	ProjectLeaderCanEditProjectLeader *bool   `json:"projectLeaderCanEditProjectLeader,omitempty"`
	TextFormattingRule                *string `json:"textFormattingRule,omitempty"`
	Archived                          *bool   `json:"archived,omitempty"`
	DisplayOrder                      *int    `json:"displayOrder,omitempty"`
}

Project : project

type ProjectDiskUsage 

type ProjectDiskUsage struct {
	ProjectID  *int `json:"projectId,omitempty"`
	Issue      *int `json:"issue,omitempty"`
	Wiki       *int `json:"wiki,omitempty"`
	File       *int `json:"file,omitempty"`
	Subversion *int `json:"subversion,omitempty"`
	Git        *int `json:"git,omitempty"`
	GitLFS     *int `json:"gitLFS,omitempty"`
}

ProjectDiskUsage : disk usage of project

type RateLimit 

type RateLimit struct {
	Read   *LimitStatus `json:"read,omitempty"`
	Update *LimitStatus `json:"update,omitempty"`
	Search *LimitStatus `json:"search,omitempty"`
	Icon   *LimitStatus `json:"icon,omitempty"`
}

RateLimit : rate limit

type RecentlyViewedProject 

type RecentlyViewedProject struct {
	Project *Project   `json:"project"`
	Updated *Timestamp `json:"updated"`
}

RecentlyViewedProject : recently viewed project

type RecentlyViewedWiki 

type RecentlyViewedWiki struct {
	Page    *Wiki      `json:"page"`
	Updated *Timestamp `json:"updated"`
}

RecentlyViewedWiki : recently viewed wiki

type Resolution 

type Resolution struct {
	ID   *int    `json:"id,omitempty"`
	Name *string `json:"name,omitempty"`
}

Resolution : resolutions

type ResponseIssue 

type ResponseIssue struct {
	Issue   *Issue     `json:"issue,omitempty"`
	Updated *Timestamp `json:"updated,omitempty"`
}

ResponseIssue : response of issue api

type ResponseRateLimit 

type ResponseRateLimit struct {
	RateLimit *RateLimit `json:"rateLimit,omitempty"`
}

ResponseRateLimit : rate limit API response

type RoleType 

type RoleType int

RoleType : role type

func (RoleType) Int 

func (k RoleType) Int() int

Int converts const RoleType* into int

type SharedFile 

type SharedFile struct {
	ID          *int       `json:"id,omitempty"`
	Type        *string    `json:"type,omitempty"`
	Dir         *string    `json:"dir,omitempty"`
	Name        *string    `json:"name,omitempty"`
	Size        *int       `json:"size,omitempty"`
	CreatedUser *User      `json:"createdUser,omitempty"`
	Created     *Timestamp `json:"created,omitempty"`
	UpdatedUser *User      `json:"updatedUser,omitempty"`
	Updated     *Timestamp `json:"updated,omitempty"`
}

SharedFile : shared file of wiki

type Sort 

type Sort string

Sort : sort

func (Sort) String 

func (k Sort) String() string

type SortStatusesInput 

type SortStatusesInput struct {
	StatusIDs []int `json:"statusId,omitempty"`
}

SortStatusesInput specifies parameters to the SortStatuses method.

type Space 

type Space struct {
	SpaceKey           *string    `json:"spaceKey,omitempty"`
	Name               *string    `json:"name,omitempty"`
	OwnerID            *int       `json:"ownerId,omitempty"`
	Lang               *string    `json:"lang,omitempty"`
	Timezone           *string    `json:"timezone,omitempty"`
	ReportSendTime     *string    `json:"reportSendTime,omitempty"`
	TextFormattingRule *string    `json:"textFormattingRule,omitempty"`
	Created            *Timestamp `json:"created,omitempty"`
	Updated            *Timestamp `json:"updated,omitempty"`
}

Space : backlog space

type SpaceDiskUsage 

type SpaceDiskUsage struct {
	Capacity   *int                    `json:"capacity,omitempty"`
	Issue      *int                    `json:"issue,omitempty"`
	Wiki       *int                    `json:"wiki,omitempty"`
	File       *int                    `json:"file,omitempty"`
	Subversion *int                    `json:"subversion,omitempty"`
	Git        *int                    `json:"git,omitempty"`
	GitLFS     *int                    `json:"gitLFS,omitempty"`
	Details    []*SpaceDiskUsageDetail `json:"details,omitempty"`
}

SpaceDiskUsage : disk usage of space

type SpaceDiskUsageDetail 

type SpaceDiskUsageDetail struct {
	ProjectID  *int `json:"projectId,omitempty"`
	Issue      *int `json:"issue,omitempty"`
	Wiki       *int `json:"wiki,omitempty"`
	File       *int `json:"file,omitempty"`
	Subversion *int `json:"subversion,omitempty"`
	Git        *int `json:"git,omitempty"`
	GitLFS     *int `json:"gitLFS,omitempty"`
}

SpaceDiskUsageDetail : the detail of disk usage of a space

type SpaceNotification 

type SpaceNotification struct {
	Content *string    `json:"content,omitempty"`
	Updated *Timestamp `json:"updated,omitempty"`
}

SpaceNotification : backlog space notification

type Star 

type Star struct {
	ID        *int       `json:"id,omitempty"`
	Comment   *string    `json:"comment,omitempty"`
	URL       *string    `json:"url,omitempty"`
	Title     *string    `json:"title,omitempty"`
	Presenter *User      `json:"presenter,omitempty"`
	Created   *Timestamp `json:"created,omitempty"`
}

Star : star of wiki

type Status 

type Status struct {
	ID           *int    `json:"id,omitempty"`
	ProjectID    *int    `json:"projectId,omitempty"`
	Name         *string `json:"name,omitempty"`
	Color        *string `json:"color,omitempty"`
	DisplayOrder *int    `json:"displayOrder,omitempty"`
}

Status : the status of project

type Tag 

type Tag struct {
	ID   *int    `json:"id,omitempty"`
	Name *string `json:"name,omitempty"`
}

Tag : tag

type Team 

type Team struct {
	ID           *int       `json:"id,omitempty"`
	Name         *string    `json:"name,omitempty"`
	Members      []*User    `json:"members,omitempty"`
	DisplayOrder *int       `json:"displayOrder,omitempty"`
	CreatedUser  *User      `json:"createdUser,omitempty"`
	Created      *Timestamp `json:"created,omitempty"`
	UpdatedUser  *User      `json:"updatedUser,omitempty"`
	Updated      *Timestamp `json:"updated,omitempty"`
}

Team : team

type Timestamp 

type Timestamp struct {
	time.Time
}

Timestamp represents a time that can be unmarshalled from a JSON string formatted as either an RFC3339 or Unix timestamp. This is necessary for some fields since the GitHub API is inconsistent in how it represents times. All exported methods of time.Time can be called on Timestamp.

func (Timestamp) String 

func (t Timestamp) String() string

func (*Timestamp) UnmarshalJSON 

func (t *Timestamp) UnmarshalJSON(data []byte) (err error)

UnmarshalJSON implements the json.Unmarshaler interface. Time is expected in RFC3339 or Unix format.

type UpdateCategoryInput 

type UpdateCategoryInput struct {
	Name *string `json:"name"`
}

UpdateCategoryInput specifies parameters to the UpdateCategory method.

type UpdateIssueCommentInput 

type UpdateIssueCommentInput struct {
	Content *string `json:"content,omitempty"`
}

UpdateIssueCommentInput specifies parameters to the UpdateIssueComment method.

type UpdateIssueInput 

type UpdateIssueInput struct {
	Summary         *string             `json:"summary,omitempty"`
	ParentIssueID   *int                `json:"parentIssueId,omitempty"`
	Description     *string             `json:"description,omitempty"`
	StatusID        *int                `json:"statusId,omitempty"`
	ResolutionID    interface{}         `json:"resolutionId,omitempty"`
	StartDate       *string             `json:"startDate,omitempty"`
	DueDate         *string             `json:"dueDate,omitempty"`
	EstimatedHours  interface{}         `json:"estimatedHours,omitempty"`
	ActualHours     interface{}         `json:"actualHours,omitempty"`
	IssueTypeID     *int                `json:"issueTypeId,omitempty"`
	CategoryIDs     []int               `json:"categoryId,omitempty"`
	VersionIDs      []int               `json:"versionId,omitempty"`
	MilestoneIDs    []int               `json:"milestoneId,omitempty"`
	PriorityID      *int                `json:"priorityId,omitempty"`
	AssigneeID      interface{}         `json:"assigneeId,omitempty"`
	NotifiedUserIDs []int               `json:"notifiedUserId,omitempty"`
	AttachmentIDs   []int               `json:"attachmentId,omitempty"`
	Comment         *string             `json:"comment,omitempty"`
	CustomFields    []*IssueCustomField `json:"-"`
}

UpdateIssueInput specifies parameters to the UpdateIssue method.

The following values ​​are updated as integer or an empty string: - resolutionId - estimatedHours - actualHours - assigneeId

ex. update `estimatedHours` to 10 - UpdateIssue("EX-1", &UpdateIssueInput{ EstimatedHours: Int(10) })

ex. update `estimatedHours` to an empty string - UpdateIssue("EX-1", &UpdateIssueInput{ EstimatedHours: String("") })

type UpdateIssueTypeInput 

type UpdateIssueTypeInput struct {
	Name                *string `json:"name,omitempty"`
	Color               *string `json:"color,omitempty"`
	TemplateSummary     *string `json:"templateSummary,omitempty"`
	TemplateDescription *string `json:"templateDescription,omitempty"`
}

UpdateIssueTypeInput specifies parameters to the UpdateIssueType method.

type UpdateProjectInput 

type UpdateProjectInput struct {
	Name                              *string `json:"name,omitempty"`
	Key                               *string `json:"key,omitempty"`
	ChartEnabled                      *bool   `json:"chartEnabled,omitempty"`
	SubtaskingEnabled                 *bool   `json:"subtaskingEnabled,omitempty"`
	ProjectLeaderCanEditProjectLeader *bool   `json:"projectLeaderCanEditProjectLeader,omitempty"`
	TextFormattingRule                *string `json:"textFormattingRule,omitempty"`
	Archived                          *bool   `json:"archived,omitempty"`
}

UpdateProjectInput contains all the parameters necessary (including the optional ones) for a UpdateProject() request.

type UpdateSpaceNotificationInput 

type UpdateSpaceNotificationInput struct {
	Content *string `json:"content"`
}

UpdateSpaceNotificationInput contains all the parameters necessary (including the optional ones) for a UpdateSpaceNotification() request.

type UpdateStatusInput 

type UpdateStatusInput struct {
	Name  *string `json:"name,omitempty"`
	Color *string `json:"color,omitempty"`
}

UpdateStatusInput specifies parameters to the UpdateStatus method.

type UpdateTeamInput 

type UpdateTeamInput struct {
	Name    *string `json:"name"`
	Members []int   `json:"members,omitempty"`
}

UpdateTeamInput specifies parameters to the UpdateTeam method.

type UpdateUserInput 

type UpdateUserInput struct {
	Password    *string
	Name        *string
	MailAddress *string
	RoleType    RoleType
}

UpdateUserInput contains all the parameters necessary (including the optional ones) for a UpdateUser() request.

type UpdateVersionInput 

type UpdateVersionInput struct {
	Name           *string `json:"name"`
	Description    *string `json:"description,omitempty"`
	StartDate      *string `json:"startDate,omitempty"`
	ReleaseDueDate *string `json:"releaseDueDate,omitempty"`
	Archived       *bool   `json:"archived,omitempty"`
}

UpdateVersionInput specifies parameters to the UpdateVersion method.

type UpdateWatchingInput 

type UpdateWatchingInput struct {
	Note *string `json:"note,omitempty"`
}

UpdateWatchingInput specifies parameters to the UpdateWatching method.

type UpdateWebhookInput 

type UpdateWebhookInput struct {
	Name            *string `json:"name,omitempty"`
	Description     *string `json:"description,omitempty"`
	HookURL         *string `json:"hookUrl,omitempty"`
	AllEvent        *bool   `json:"allEvent,omitempty"`
	ActivityTypeIDs []int   `json:"activityTypeIds,omitempty"`
}

UpdateWebhookInput contains all the parameters necessary (including the optional ones) for a UpdateWebhook() request.

type UpdateWikiInput 

type UpdateWikiInput struct {
	Name       *string `json:"name"`
	Content    *string `json:"content"`
	MailNotify *bool   `json:"mailNotify,omitempty"`
}

UpdateWikiInput contains all the parameters necessary (including the optional ones) for a UpdateWiki() request.

type User 

type User struct {
	ID          *int     `json:"id,omitempty"`
	UserID      *string  `json:"userId,omitempty"`
	Name        *string  `json:"name,omitempty"`
	RoleType    RoleType `json:"roleType"`
	Lang        *string  `json:"lang,omitempty"`
	MailAddress *string  `json:"mailAddress,omitempty"`
}

User : backlog user

type Version 

type Version struct {
	ID             *int    `json:"id,omitempty"`
	ProjectID      *int    `json:"projectId,omitempty"`
	Name           *string `json:"name,omitempty"`
	Description    *string `json:"description,omitempty"`
	StartDate      *string `json:"startDate,omitempty"`      // yyyy-MM-dd
	ReleaseDueDate *string `json:"releaseDueDate,omitempty"` // yyyy-MM-dd
	Archived       *bool   `json:"archived,omitempty"`
	DisplayOrder   *int    `json:"displayOrder,omitempty"`
}

Version : milestone

type Watching 

type Watching struct {
	ID                  *int       `json:"id,omitempty"`
	ResourceAlreadyRead *bool      `json:"resourceAlreadyRead,omitempty"`
	Note                *string    `json:"note,omitempty"`
	Type                *string    `json:"type,omitempty"`
	Issue               *Issue     `json:"issue,omitempty"`
	LastContentUpdated  *Timestamp `json:"lastContentUpdated,omitempty"`
	Created             *Timestamp `json:"created,omitempty"`
	Updated             *Timestamp `json:"updated,omitempty"`
}

Watching : -

type Webhook 

type Webhook struct {
	ID              *int       `json:"id,omitempty"`
	Name            *string    `json:"name,omitempty"`
	Description     *string    `json:"description,omitempty"`
	HookURL         *string    `json:"hookUrl,omitempty"`
	AllEvent        *bool      `json:"allEvent,omitempty"`
	ActivityTypeIds []int      `json:"activityTypeIds,omitempty"`
	CreatedUser     *User      `json:"createdUser,omitempty"`
	Created         *Timestamp `json:"created,omitempty"`
	UpdatedUser     *User      `json:"updatedUser,omitempty"`
	Updated         *Timestamp `json:"updated,omitempty"`
}

Webhook : -

type Wiki 

type Wiki struct {
	ID          *int          `json:"id,omitempty"`
	ProjectID   *int          `json:"projectId,omitempty"`
	Name        *string       `json:"name,omitempty"`
	Content     *string       `json:"content,omitempty"`
	Tags        []*Tag        `json:"tags,omitempty"`
	Attachments []*Attachment `json:"attachments,omitempty"`
	SharedFiles []*SharedFile `json:"sharedFiles,omitempty"`
	Stars       []*Star       `json:"stars,omitempty"`
	CreatedUser *User         `json:"createdUser,omitempty"`
	Created     *Timestamp    `json:"created,omitempty"`
	UpdatedUser *User         `json:"updatedUser,omitempty"`
	Updated     *Timestamp    `json:"updated,omitempty"`
}

Wiki : wiki

Source Files

View all Source files

Directories

Path Synopsis
examples
file
issue
project
space
users
webhook
wiki

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.