api

Jul 20, 2026

Changes in this version

+ type ErrReadOnly struct

+ Method string

+ Path string

+ func (e *ErrReadOnly) Error() string

Jun 15, 2026

Changes in this version

type AttachmentService

+ func (s *AttachmentService) Download(ctx context.Context, att *models.Attachment, w io.Writer) (int64, error)

+ func (s *AttachmentService) Get(ctx context.Context, id int) (*models.Attachment, error)

May 19, 2026

Changes in this version

type APIError

+ func (e *APIError) IsConflict() bool

type Client

+ CustomFields *CustomFieldService

+ Files *FileService

+ MyAccount *MyAccountService

+ Queries *QueryService

+ Relations *RelationService

+ Roles *RoleService

+ type CustomFieldService struct

+ func (s *CustomFieldService) Get(ctx context.Context, id int) (*models.CustomField, error)

+ func (s *CustomFieldService) List(ctx context.Context) ([]models.CustomField, error)

+ type FileService struct

+ func (s *FileService) Create(ctx context.Context, projectID string, file models.ProjectFileCreate) error

+ func (s *FileService) List(ctx context.Context, projectID string, limit, offset int) ([]models.ProjectFile, int, error)

type IssueService

+ func (s *IssueService) AddWatcher(ctx context.Context, issueID, userID int) error

+ func (s *IssueService) ListWatchers(ctx context.Context, issueID int) ([]models.IDName, error)

+ func (s *IssueService) RemoveWatcher(ctx context.Context, issueID, userID int) error

+ type MyAccountService struct

+ func (s *MyAccountService) Get(ctx context.Context) (*models.User, error)

+ func (s *MyAccountService) Update(ctx context.Context, update models.MyAccountUpdate) error

type ProjectService

+ func (s *ProjectService) Archive(ctx context.Context, identifier string) error

+ func (s *ProjectService) Unarchive(ctx context.Context, identifier string) error

+ type QueryService struct

+ func (s *QueryService) List(ctx context.Context, limit, offset int) ([]models.SavedQuery, int, error)

+ type RelationService struct

+ func (s *RelationService) Create(ctx context.Context, issueID int, payload models.IssueRelationCreate) (*models.IssueRelation, error)

+ func (s *RelationService) Delete(ctx context.Context, relationID int) error

+ func (s *RelationService) Get(ctx context.Context, relationID int) (*models.IssueRelation, error)

+ func (s *RelationService) ListByIssue(ctx context.Context, issueID int) ([]models.IssueRelation, error)

+ type RoleService struct

+ func (s *RoleService) Get(ctx context.Context, id int) (*models.Role, error)

+ func (s *RoleService) List(ctx context.Context) ([]models.Role, error)

type TrackerService

+ func (s *TrackerService) Get(ctx context.Context, id int) (*models.Tracker, error)

Apr 24, 2026

Changes in this version

type VersionService

+ func (s *VersionService) Create(ctx context.Context, projectID string, version models.VersionCreate) (*models.Version, error)

+ func (s *VersionService) Delete(ctx context.Context, id int) error

+ func (s *VersionService) Update(ctx context.Context, id int, update models.VersionUpdate) error

Apr 18, 2026

Changes in this version

+ func FetchAllFiltered[T any](ctx context.Context, c *Client, path string, params url.Values, key string, ...) ([]T, bool, error)

+ func FetchAll[T any](ctx context.Context, c *Client, path string, params url.Values, key string, ...) ([]T, int, error)

+ type APIError struct

+ Errors []string

+ StatusCode int

+ URL string

+ func (e *APIError) Error() string

+ func (e *APIError) IsAuthError() bool

+ func (e *APIError) IsForbidden() bool

+ func (e *APIError) IsNotFound() bool

+ func (e *APIError) IsValidationError() bool

+ type AttachmentService struct

+ func (s *AttachmentService) Upload(ctx context.Context, filename string, body io.Reader, size int64) (string, error)

+ type CategoryService struct

+ func (s *CategoryService) List(ctx context.Context, projectID string) ([]models.IssueCategory, int, error)

+ type Client struct

+ Attachments *AttachmentService

+ Categories *CategoryService

+ Enumerations *EnumerationService

+ Groups *GroupService

+ Issues *IssueService

+ Memberships *MembershipService

+ Projects *ProjectService

+ Search *SearchService

+ Statuses *StatusService

+ TimeEntries *TimeEntryService

+ Trackers *TrackerService

+ Users *UserService

+ Versions *VersionService

+ Wikis *WikiService

+ func NewClient(cfg *config.Config, log *debug.Logger) (*Client, error)

+ func NewTestClient(httpClient *http.Client, baseURL string, log *debug.Logger) *Client

+ func (c *Client) DebugLog() *debug.Logger

+ func (c *Client) Delete(ctx context.Context, path string) error

+ func (c *Client) DoRaw(ctx context.Context, method, path string, params url.Values, body io.Reader) (*RawResponse, error)

+ func (c *Client) Get(ctx context.Context, path string, params url.Values, out interface{}) error

+ func (c *Client) Post(ctx context.Context, path string, body interface{}, out interface{}) error

+ func (c *Client) Put(ctx context.Context, path string, body interface{}) error

+ type EnumerationService struct

+ func (s *EnumerationService) IssuePriorities(ctx context.Context) ([]models.Enumeration, error)

+ func (s *EnumerationService) TimeEntryActivities(ctx context.Context) ([]models.Enumeration, error)

+ type GroupService struct

+ func (s *GroupService) AddUser(ctx context.Context, groupID, userID int) error

+ func (s *GroupService) Create(ctx context.Context, group models.GroupCreate) (*models.Group, error)

+ func (s *GroupService) Delete(ctx context.Context, id int) error

+ func (s *GroupService) Get(ctx context.Context, id int, includes []string) (*models.Group, error)

+ func (s *GroupService) List(ctx context.Context, filter models.GroupFilter) ([]models.Group, int, error)

+ func (s *GroupService) RemoveUser(ctx context.Context, groupID, userID int) error

+ func (s *GroupService) Update(ctx context.Context, id int, update models.GroupUpdate) error

+ type IssueService struct

+ func (s *IssueService) Create(ctx context.Context, issue models.IssueCreate) (*models.Issue, error)

+ func (s *IssueService) Delete(ctx context.Context, id int) error

+ func (s *IssueService) Get(ctx context.Context, id int, includes []string) (*models.Issue, error)

+ func (s *IssueService) List(ctx context.Context, filter models.IssueFilter) ([]models.Issue, int, error)

+ func (s *IssueService) Update(ctx context.Context, id int, update models.IssueUpdate) error

+ type MembershipService struct

+ func (s *MembershipService) Create(ctx context.Context, projectID string, membership models.MembershipCreate) (*models.Membership, error)

+ func (s *MembershipService) Delete(ctx context.Context, id int) error

+ func (s *MembershipService) Get(ctx context.Context, id int) (*models.Membership, error)

+ func (s *MembershipService) List(ctx context.Context, projectID string, limit, offset int) ([]models.Membership, int, error)

+ func (s *MembershipService) Update(ctx context.Context, id int, update models.MembershipUpdate) error

+ type ProjectService struct

+ func (s *ProjectService) Create(ctx context.Context, project models.ProjectCreate) (*models.Project, error)

+ func (s *ProjectService) Delete(ctx context.Context, identifier string) error

+ func (s *ProjectService) Get(ctx context.Context, identifier string, includes []string) (*models.Project, error)

+ func (s *ProjectService) List(ctx context.Context, includes []string, limit, offset int) ([]models.Project, int, error)

+ func (s *ProjectService) Members(ctx context.Context, identifier string, limit, offset int) ([]models.Membership, int, error)

+ func (s *ProjectService) Update(ctx context.Context, identifier string, update models.ProjectUpdate) error

+ type RawResponse struct

+ Body []byte

+ Headers http.Header

+ Status string

+ StatusCode int

+ type SearchParams struct

+ AllWords bool

+ Attachments string

+ Changesets bool

+ Documents bool

+ Issues bool

+ Limit int

+ Messages bool

+ News bool

+ Offset int

+ OpenIssues bool

+ ProjectID string

+ Projects bool

+ Query string

+ Scope string

+ TitlesOnly bool

+ WikiPages bool

+ type SearchService struct

+ func (s *SearchService) Search(ctx context.Context, params SearchParams) ([]models.SearchResult, int, error)

+ type StatusService struct

+ func (s *StatusService) List(ctx context.Context) ([]models.IssueStatus, error)

+ type TimeEntryService struct

+ func (s *TimeEntryService) Create(ctx context.Context, entry models.TimeEntryCreate) (*models.TimeEntry, error)

+ func (s *TimeEntryService) Delete(ctx context.Context, id int) error

+ func (s *TimeEntryService) Get(ctx context.Context, id int) (*models.TimeEntry, error)

+ func (s *TimeEntryService) List(ctx context.Context, filter models.TimeEntryFilter) ([]models.TimeEntry, int, error)

+ func (s *TimeEntryService) Update(ctx context.Context, id int, update models.TimeEntryUpdate) error

+ type TrackerService struct

+ func (s *TrackerService) List(ctx context.Context) ([]models.Tracker, error)

+ type UserService struct

+ func (s *UserService) Create(ctx context.Context, user models.UserCreate) (*models.User, error)

+ func (s *UserService) Current(ctx context.Context) (*models.User, error)

+ func (s *UserService) Delete(ctx context.Context, id int) error

+ func (s *UserService) Get(ctx context.Context, id int) (*models.User, error)

+ func (s *UserService) List(ctx context.Context, filter models.UserFilter) ([]models.User, int, error)

+ func (s *UserService) Update(ctx context.Context, id int, update models.UserUpdate) error

+ type VersionService struct

+ func (s *VersionService) Get(ctx context.Context, id int) (*models.Version, error)

+ func (s *VersionService) List(ctx context.Context, projectID string, limit, offset int) ([]models.Version, int, error)

+ func (s *VersionService) ListFiltered(ctx context.Context, projectID string, need int, ...) ([]models.Version, bool, error)

+ type WikiService struct

+ func (s *WikiService) Create(ctx context.Context, projectID, page string, wiki models.WikiPageCreate) (*models.WikiPage, error)

+ func (s *WikiService) Delete(ctx context.Context, projectID, page string) error

+ func (s *WikiService) Get(ctx context.Context, projectID, page string, includes []string) (*models.WikiPage, error)

+ func (s *WikiService) GetVersion(ctx context.Context, projectID, page string, version int) (*models.WikiPage, error)

+ func (s *WikiService) List(ctx context.Context, projectID string, limit, offset int) ([]models.WikiPageIndex, int, error)

+ func (s *WikiService) Update(ctx context.Context, projectID, page string, update models.WikiPageUpdate) error