Documentation
¶
Index ¶
- type AgentCreateRequest
- type AgentRegisterRequest
- type AgentRequest
- type AgentTicketUpdateRequest
- type AgentUpdateRequest
- type AgentWorkResponse
- type AuthResponse
- type Client
- func (c *Client) AddComment(id string, comment string) (store.Comment, error)
- func (c *Client) AddDependency(request DependencyRequest) (store.Dependency, error)
- func (c *Client) AddProjectMember(projectID int64, request ProjectMemberRequest) (store.ProjectMember, error)
- func (c *Client) AddProjectTeamMember(projectID int64, request ProjectTeamMemberRequest) (store.ProjectTeamMember, error)
- func (c *Client) AddTeamAgent(teamID int64, agentID string) (store.TeamAgent, error)
- func (c *Client) AddTeamMember(teamID int64, request TeamMemberRequest) (store.TeamMember, error)
- func (c *Client) AddTicketLabel(ticketID string, labelID int64) error
- func (c *Client) AddWorkflowStage(workflowID int64, request WorkflowStageRequest) (store.WorkflowStage, error)
- func (c *Client) AgentUpdateTicket(id string, request AgentTicketUpdateRequest) (store.Ticket, error)
- func (c *Client) ArchiveTicket(id string) (store.Ticket, error)
- func (c *Client) CloneTicket(id string) (store.Ticket, error)
- func (c *Client) CloseTicket(id string) (store.Ticket, error)
- func (c *Client) Count(projectID *int64) (CountSummary, error)
- func (c *Client) CreateAgent(request AgentCreateRequest) (store.Agent, string, error)
- func (c *Client) CreateLabel(projectID int64, request libticket.LabelRequest) (store.Label, error)
- func (c *Client) CreateProject(request ProjectCreateRequest) (store.Project, error)
- func (c *Client) CreateRole(request RoleRequest) (store.Role, error)
- func (c *Client) CreateStory(projectID int64, title, description string) (store.Story, error)
- func (c *Client) CreateTeam(request TeamRequest) (store.Team, error)
- func (c *Client) CreateTicket(request TicketCreateRequest) (store.Ticket, error)
- func (c *Client) CreateUser(username, password string) (store.User, error)
- func (c *Client) CreateWorkflow(request WorkflowRequest) (store.Workflow, error)
- func (c *Client) DeleteAgent(id string) error
- func (c *Client) DeleteAgentConfig(agentID string, key string) error
- func (c *Client) DeleteLabel(id int64) error
- func (c *Client) DeleteProject(id int64) error
- func (c *Client) DeleteRole(id int64) error
- func (c *Client) DeleteStory(id int64) error
- func (c *Client) DeleteTeam(id int64) error
- func (c *Client) DeleteTicket(id string) error
- func (c *Client) DeleteTimeEntry(id int64) error
- func (c *Client) DeleteUser(username string) error
- func (c *Client) DeleteWorkflow(id int64) error
- func (c *Client) ExportWorkflow(id int64) (store.WorkflowExport, error)
- func (c *Client) GetProject(id string) (store.Project, error)
- func (c *Client) GetStory(id int64) (store.Story, error)
- func (c *Client) GetTicket(ref string) (store.Ticket, error)
- func (c *Client) GetTicketByID(id string) (store.Ticket, error)
- func (c *Client) GetWorkflow(id int64) (store.WorkflowWithStages, error)
- func (c *Client) HeartbeatAgent(agentID, password, status string) error
- func (c *Client) ImportWorkflow(export store.WorkflowExport) (store.Workflow, error)
- func (c *Client) ListAgentConfig(agentID string) ([]store.AgentConfigEntry, error)
- func (c *Client) ListAgentStatuses() ([]store.AgentStatus, error)
- func (c *Client) ListAgents() ([]store.Agent, error)
- func (c *Client) ListComments(id string) ([]store.Comment, error)
- func (c *Client) ListDependencies(id string) ([]store.Dependency, error)
- func (c *Client) ListHistory(id string) ([]store.HistoryEvent, error)
- func (c *Client) ListLabels(projectID int64) ([]store.Label, error)
- func (c *Client) ListProjectHistory(projectID int64, limit int) ([]store.HistoryEvent, error)
- func (c *Client) ListProjectMembers(projectID int64) ([]store.ProjectMember, error)
- func (c *Client) ListProjectTeamMembers(projectID int64) ([]store.ProjectTeamMember, error)
- func (c *Client) ListProjects() ([]store.Project, error)
- func (c *Client) ListRoles() ([]store.Role, error)
- func (c *Client) ListStories(projectID int64) ([]store.Story, error)
- func (c *Client) ListTeamAgents(teamID int64) ([]store.TeamAgent, error)
- func (c *Client) ListTeamMembers(teamID int64) ([]store.TeamMember, error)
- func (c *Client) ListTeams() ([]store.Team, error)
- func (c *Client) ListTicketLabels(ticketID string) ([]store.Label, error)
- func (c *Client) ListTickets(projectID int64) ([]store.Ticket, error)
- func (c *Client) ListTicketsFiltered(projectID int64, ticketType, stage, state, status, search, assignee string, ...) ([]store.Ticket, error)
- func (c *Client) ListTimeEntries(ticketID string) ([]store.TimeEntry, error)
- func (c *Client) ListUsers() ([]store.User, error)
- func (c *Client) ListWorkflows() ([]store.Workflow, error)
- func (c *Client) LogTime(ticketID string, request libticket.TimeEntryRequest) (store.TimeEntry, error)
- func (c *Client) Login(username, password string) (AuthResponse, error)
- func (c *Client) Logout() error
- func (c *Client) NotReadyTicket(id string) (store.Ticket, error)
- func (c *Client) OpenTicket(id string) (store.Ticket, error)
- func (c *Client) ReadyTicket(id string) (store.Ticket, error)
- func (c *Client) Register(username, password string) (store.User, error)
- func (c *Client) RegisterAgent(request AgentRegisterRequest) (store.Agent, error)
- func (c *Client) RemoveDependency(request DependencyRequest) error
- func (c *Client) RemoveProjectMember(projectID int64, userID string) error
- func (c *Client) RemoveProjectTeamMember(projectID, teamID int64) error
- func (c *Client) RemoveTeamAgent(teamID int64, agentID string) error
- func (c *Client) RemoveTeamMember(teamID int64, userID string) error
- func (c *Client) RemoveTicketLabel(ticketID string, labelID int64) error
- func (c *Client) RemoveWorkflowStage(stageID int64) error
- func (c *Client) ReorderWorkflowStages(workflowID int64, stageIDs []int64) error
- func (c *Client) RequestAgentWork(request AgentRequest) (AgentWorkResponse, error)
- func (c *Client) RequestTicket(request TicketRequest) (TicketRequestResponse, error)
- func (c *Client) ResetUserPassword(username, newPassword string) (store.User, error)
- func (c *Client) SetAgentConfig(agentID string, key, value string) error
- func (c *Client) SetAgentEnabled(id string, enabled bool) (store.Agent, error)
- func (c *Client) SetProjectEnabled(id int64, enabled bool) (store.Project, error)
- func (c *Client) SetRegistrationEnabled(enabled bool) error
- func (c *Client) SetTicketHealth(id string, score int) (store.Ticket, error)
- func (c *Client) SetTicketParent(id, parentID string) (store.Ticket, error)
- func (c *Client) SetTicketWorkflow(id string, workflowID int64) (store.Ticket, error)
- func (c *Client) SetUserEnabled(username string, enabled bool) error
- func (c *Client) Status() (StatusResponse, error)
- func (c *Client) TotalTimeForTicket(ticketID string) (int, error)
- func (c *Client) UnarchiveTicket(id string) (store.Ticket, error)
- func (c *Client) UnsetTicketParent(id string) (store.Ticket, error)
- func (c *Client) UnsetTicketWorkflow(id string) (store.Ticket, error)
- func (c *Client) UpdateAgent(id string, request AgentUpdateRequest) (store.Agent, error)
- func (c *Client) UpdateProject(id int64, request ProjectUpdateRequest) (store.Project, error)
- func (c *Client) UpdateRole(id int64, request RoleRequest) (store.Role, error)
- func (c *Client) UpdateStory(id int64, title, description string) (store.Story, error)
- func (c *Client) UpdateTeam(id int64, request TeamRequest) (store.Team, error)
- func (c *Client) UpdateTicket(id string, request TicketUpdateRequest) (store.Ticket, error)
- type CommentCreateRequest
- type CountSummary
- type DependencyRequest
- type ProjectCreateRequest
- type ProjectMemberRequest
- type ProjectTeamMemberRequest
- type ProjectUpdateRequest
- type RoleRequest
- type StatusResponse
- type TeamMemberRequest
- type TeamRequest
- type TicketCreateRequest
- type TicketHealthRequest
- type TicketRequest
- type TicketRequestResponse
- type TicketUpdateRequest
- type WorkflowReorderRequest
- type WorkflowRequest
- type WorkflowStageRequest
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AgentCreateRequest ¶
type AgentCreateRequest struct {
Password string `json:"password,omitempty"`
}
type AgentRegisterRequest ¶
type AgentRequest ¶
type AgentUpdateRequest ¶
type AgentUpdateRequest struct {
Password *string `json:"password,omitempty"`
}
type AgentWorkResponse ¶
type AgentWorkResponse struct {
Status string `json:"status"`
Project *store.Project `json:"project"`
Ticket *store.Ticket `json:"ticket"`
Parents []store.Ticket `json:"parents"`
Workflow *store.WorkflowWithStages `json:"workflow,omitempty"`
Role *store.Role `json:"role,omitempty"`
Config map[string]string `json:"config,omitempty"`
ConfigUpdatedAt string `json:"config_updated_at,omitempty"`
}
type AuthResponse ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
func (*Client) AddComment ¶
func (*Client) AddDependency ¶
func (c *Client) AddDependency(request DependencyRequest) (store.Dependency, error)
func (*Client) AddProjectMember ¶
func (c *Client) AddProjectMember(projectID int64, request ProjectMemberRequest) (store.ProjectMember, error)
func (*Client) AddProjectTeamMember ¶
func (c *Client) AddProjectTeamMember(projectID int64, request ProjectTeamMemberRequest) (store.ProjectTeamMember, error)
func (*Client) AddTeamAgent ¶
func (*Client) AddTeamMember ¶
func (c *Client) AddTeamMember(teamID int64, request TeamMemberRequest) (store.TeamMember, error)
func (*Client) AddTicketLabel ¶
func (*Client) AddWorkflowStage ¶
func (c *Client) AddWorkflowStage(workflowID int64, request WorkflowStageRequest) (store.WorkflowStage, error)
func (*Client) AgentUpdateTicket ¶
func (*Client) CreateAgent ¶
func (*Client) CreateLabel ¶
func (*Client) CreateProject ¶
func (c *Client) CreateProject(request ProjectCreateRequest) (store.Project, error)
func (*Client) CreateRole ¶
func (c *Client) CreateRole(request RoleRequest) (store.Role, error)
func (*Client) CreateStory ¶
func (*Client) CreateTeam ¶
func (c *Client) CreateTeam(request TeamRequest) (store.Team, error)
func (*Client) CreateTicket ¶
func (c *Client) CreateTicket(request TicketCreateRequest) (store.Ticket, error)
func (*Client) CreateUser ¶
func (*Client) CreateWorkflow ¶
func (c *Client) CreateWorkflow(request WorkflowRequest) (store.Workflow, error)
func (*Client) DeleteAgent ¶
func (*Client) DeleteAgentConfig ¶
func (*Client) DeleteLabel ¶
func (*Client) DeleteProject ¶
func (*Client) DeleteRole ¶
func (*Client) DeleteStory ¶
func (*Client) DeleteTeam ¶
func (*Client) DeleteTicket ¶
func (*Client) DeleteTimeEntry ¶
func (*Client) DeleteUser ¶
func (*Client) DeleteWorkflow ¶
func (*Client) ExportWorkflow ¶
func (c *Client) ExportWorkflow(id int64) (store.WorkflowExport, error)
func (*Client) GetWorkflow ¶
func (c *Client) GetWorkflow(id int64) (store.WorkflowWithStages, error)
func (*Client) HeartbeatAgent ¶
func (*Client) ImportWorkflow ¶
func (*Client) ListAgentConfig ¶
func (c *Client) ListAgentConfig(agentID string) ([]store.AgentConfigEntry, error)
func (*Client) ListAgentStatuses ¶
func (c *Client) ListAgentStatuses() ([]store.AgentStatus, error)
func (*Client) ListDependencies ¶
func (c *Client) ListDependencies(id string) ([]store.Dependency, error)
func (*Client) ListHistory ¶
func (c *Client) ListHistory(id string) ([]store.HistoryEvent, error)
func (*Client) ListProjectHistory ¶
func (*Client) ListProjectMembers ¶
func (c *Client) ListProjectMembers(projectID int64) ([]store.ProjectMember, error)
func (*Client) ListProjectTeamMembers ¶
func (c *Client) ListProjectTeamMembers(projectID int64) ([]store.ProjectTeamMember, error)
func (*Client) ListTeamAgents ¶
func (*Client) ListTeamMembers ¶
func (c *Client) ListTeamMembers(teamID int64) ([]store.TeamMember, error)
func (*Client) ListTicketLabels ¶
func (*Client) ListTicketsFiltered ¶
func (*Client) ListTimeEntries ¶
func (*Client) RegisterAgent ¶
func (c *Client) RegisterAgent(request AgentRegisterRequest) (store.Agent, error)
func (*Client) RemoveDependency ¶
func (c *Client) RemoveDependency(request DependencyRequest) error
func (*Client) RemoveProjectMember ¶
func (*Client) RemoveProjectTeamMember ¶
func (*Client) RemoveTeamAgent ¶
func (*Client) RemoveTeamMember ¶
func (*Client) RemoveTicketLabel ¶
func (*Client) RemoveWorkflowStage ¶
func (*Client) ReorderWorkflowStages ¶
func (*Client) RequestAgentWork ¶
func (c *Client) RequestAgentWork(request AgentRequest) (AgentWorkResponse, error)
func (*Client) RequestTicket ¶
func (c *Client) RequestTicket(request TicketRequest) (TicketRequestResponse, error)
func (*Client) ResetUserPassword ¶
func (*Client) SetAgentConfig ¶
func (*Client) SetAgentEnabled ¶
func (*Client) SetProjectEnabled ¶
func (*Client) SetRegistrationEnabled ¶
func (*Client) SetTicketHealth ¶
func (*Client) SetTicketParent ¶
func (*Client) SetTicketWorkflow ¶
func (*Client) SetUserEnabled ¶
func (*Client) Status ¶
func (c *Client) Status() (StatusResponse, error)
func (*Client) TotalTimeForTicket ¶
func (*Client) UnsetTicketParent ¶
func (*Client) UnsetTicketWorkflow ¶
func (*Client) UpdateAgent ¶
func (*Client) UpdateProject ¶
func (*Client) UpdateRole ¶
func (*Client) UpdateStory ¶
func (*Client) UpdateTeam ¶
func (*Client) UpdateTicket ¶
type CommentCreateRequest ¶
type CommentCreateRequest struct {
Comment string `json:"comment"`
}
type CountSummary ¶
type CountSummary = store.CountSummary
type DependencyRequest ¶
type ProjectCreateRequest ¶
type ProjectCreateRequest struct {
Prefix string `json:"prefix"`
Title string `json:"title"`
Description string `json:"description"`
AcceptanceCriteria string `json:"acceptance_criteria"`
GitRepository string `json:"git_repository"`
GitBranch string `json:"git_branch"`
Notes string `json:"notes"`
Visibility string `json:"visibility"`
WorkflowID *int64 `json:"workflow_id,omitempty"`
}
type ProjectMemberRequest ¶
type ProjectUpdateRequest ¶
type ProjectUpdateRequest struct {
Title string `json:"title"`
Description string `json:"description"`
AcceptanceCriteria string `json:"acceptance_criteria"`
GitRepository string `json:"git_repository"`
GitBranch string `json:"git_branch"`
Notes string `json:"notes"`
Status string `json:"status"`
Visibility string `json:"visibility"`
WorkflowID *int64 `json:"workflow_id,omitempty"`
}
type RoleRequest ¶
type StatusResponse ¶
type StatusResponse struct {
Status string `json:"status"`
Authenticated bool `json:"authenticated"`
RegistrationEnabled bool `json:"registration_enabled,omitempty"`
ChatEnabled bool `json:"chat_enabled,omitempty"`
ServerVersion string `json:"server_version"`
User *store.User `json:"user,omitempty"`
}
type TeamMemberRequest ¶
type TeamRequest ¶
type TicketCreateRequest ¶
type TicketCreateRequest struct {
ProjectID int64 `json:"project_id"`
ParentID *string `json:"parent_id,omitempty"`
CloneOf *string `json:"clone_of,omitempty"`
Type string `json:"type"`
Title string `json:"title"`
Description string `json:"description"`
AcceptanceCriteria string `json:"acceptance_criteria"`
GitRepository string `json:"git_repository"`
GitBranch string `json:"git_branch"`
Priority int `json:"priority"`
EstimateEffort int `json:"estimate_effort"`
EstimateComplete string `json:"estimate_complete,omitempty"`
Assignee string `json:"assignee"`
Status string `json:"status,omitempty"`
Stage string `json:"stage,omitempty"`
State string `json:"state,omitempty"`
}
type TicketHealthRequest ¶
type TicketHealthRequest struct {
Score int `json:"score"`
}
type TicketRequest ¶
type TicketRequestResponse ¶
type TicketRequestResponse struct {
Status string `json:"status"`
Ticket *store.Ticket `json:"ticket,omitempty"`
Project *store.Project `json:"project,omitempty"`
Parents []store.Ticket `json:"parents,omitempty"`
Workflow *store.WorkflowWithStages `json:"workflow,omitempty"`
Role *store.Role `json:"role,omitempty"`
}
type TicketUpdateRequest ¶
type TicketUpdateRequest struct {
Title string `json:"title"`
Description string `json:"description"`
AcceptanceCriteria string `json:"acceptance_criteria"`
GitRepository string `json:"git_repository"`
GitBranch string `json:"git_branch"`
ParentID *string `json:"parent_id,omitempty"`
Assignee string `json:"assignee"`
Status string `json:"status,omitempty"`
Stage string `json:"stage,omitempty"`
State string `json:"state,omitempty"`
Priority int `json:"priority"`
Order int `json:"order"`
EstimateEffort int `json:"estimate_effort"`
EstimateComplete string `json:"estimate_complete,omitempty"`
}
type WorkflowReorderRequest ¶
type WorkflowReorderRequest struct {
StageIDs []int64 `json:"stage_ids"`
}
type WorkflowRequest ¶
Click to show internal directories.
Click to hide internal directories.