Documentation
¶
Index ¶
- type APIError
- type AdminChangePasswordRequest
- type AdminChangePasswordResponse
- type AdminLoginRequest
- type AdminLoginResponse
- type AdminPlanCreateRequest
- type AdminPlanUpdateRequest
- type AdminService
- func (s *AdminService) ChangePassword(req AdminChangePasswordRequest) (*AdminChangePasswordResponse, error)
- func (s *AdminService) CreatePlan(req AdminPlanCreateRequest) (*Plan, error)
- func (s *AdminService) GetBugReports(page, limit *int, search *string) (*BugReportsResponse, error)
- func (s *AdminService) GetPlans() ([]Plan, error)
- func (s *AdminService) GetUsers() ([]AdminUser, error)
- func (s *AdminService) Login(req AdminLoginRequest) (*AdminLoginResponse, error)
- func (s *AdminService) UpdatePlan(id string, req AdminPlanUpdateRequest) (*Plan, error)
- type AdminUser
- type BoardService
- func (s *BoardService) CreateBoard(req CreateBoardPayload) (interface{}, error)
- func (s *BoardService) DeleteBoard(workspaceName, boardName string) (*GenericMessageResponse, error)
- func (s *BoardService) GetDeletedBoards() ([]DeletedBoard, error)
- func (s *BoardService) InviteMember(workspaceName, boardName, identifier string) (interface{}, error)
- func (s *BoardService) LeaveBoard(workspaceName, boardName string) error
- func (s *BoardService) RemoveMember(workspaceName, boardName, identifier string) (*GenericMessageResponse, error)
- func (s *BoardService) RestoreBoard(workspaceName, boardName string) (*GenericMessageResponse, error)
- func (s *BoardService) UpdateBoardStatus(workspaceName, boardName string, isActive bool) (*UpdateBoardStatusResponse, error)
- type BugReport
- type BugReportPayload
- type BugReportResponse
- type BugReportsResponse
- type BugService
- type CheckoutPayload
- type CheckoutResponse
- type Client
- type CreateBoardPayload
- type CreateTaskPayload
- type CreateWorkspacePayload
- type DeletedBoard
- type DirectoryEntry
- type DirectoryResponse
- type DirectoryService
- type GenericMessageResponse
- type GetReadStateResponse
- type GithubRepo
- type GithubService
- type InviteMemberBody
- type ListTasksResponse
- type NotificationActor
- type NotificationBoard
- type NotificationLog
- type NotificationService
- type NotificationTask
- type NotificationWorkspace
- type Plan
- type Subscription
- type SubscriptionService
- type SuccessResponse
- type Task
- type TaskService
- func (s *TaskService) AddTask(payload CreateTaskPayload) (*Task, error)
- func (s *TaskService) DeleteTask(taskID string) (*SuccessResponse, error)
- func (s *TaskService) GetTask(taskID string) (*Task, error)
- func (s *TaskService) ListTasks(workspaceName, boardName string, page, limit int) (*ListTasksResponse, error)
- func (s *TaskService) UpdateTaskStatus(taskID, status string) (*Task, error)
- type UpdateBoardStatusBody
- type UpdateBoardStatusResponse
- type User
- type UserService
- type Workspace
- type WorkspaceService
- func (s *WorkspaceService) CreateWorkspace(payload CreateWorkspacePayload) (*Workspace, error)
- func (s *WorkspaceService) DeleteWorkspace(workspaceName string) (*GenericMessageResponse, error)
- func (s *WorkspaceService) GetUserWorkspaces(includeBoards bool) (interface{}, error)
- func (s *WorkspaceService) RestoreWorkspace(workspaceName string) (*GenericMessageResponse, error)
- func (s *WorkspaceService) UpdateWorkspaceStatus(workspaceName string, isActive bool) (*UpdateBoardStatusResponse, error)
- type WorkspaceWithBoards
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type APIError ¶
type APIError struct {
Message string `json:"error"`
}
APIError represents an error returned by the API.
type AdminChangePasswordResponse ¶
type AdminChangePasswordResponse struct {
Success bool `json:"success"`
}
type AdminLoginRequest ¶
type AdminLoginResponse ¶
type AdminLoginResponse struct {
AccessToken string `json:"accessToken"`
}
type AdminPlanCreateRequest ¶
type AdminPlanCreateRequest struct {
Name string `json:"name"`
MaxWorkspaces *int `json:"maxWorkspaces,omitempty"`
MaxBoardsPerWorkspace *int `json:"maxBoardsPerWorkspace,omitempty"`
MaxMembersPerBoard *int `json:"maxMembersPerBoard,omitempty"`
MaxActiveBoards *int `json:"maxActiveBoards,omitempty"`
IsTrial *bool `json:"isTrial,omitempty"`
IsActive *bool `json:"isActive,omitempty"`
}
type AdminPlanUpdateRequest ¶
type AdminPlanUpdateRequest struct {
Name *string `json:"name,omitempty"`
MaxWorkspaces *int `json:"maxWorkspaces,omitempty"`
MaxBoardsPerWorkspace *int `json:"maxBoardsPerWorkspace,omitempty"`
MaxMembersPerBoard *int `json:"maxMembersPerBoard,omitempty"`
MaxActiveBoards *int `json:"maxActiveBoards,omitempty"`
IsTrial *bool `json:"isTrial,omitempty"`
IsActive *bool `json:"isActive,omitempty"`
}
type AdminService ¶
type AdminService struct {
// contains filtered or unexported fields
}
func (*AdminService) ChangePassword ¶
func (s *AdminService) ChangePassword(req AdminChangePasswordRequest) (*AdminChangePasswordResponse, error)
func (*AdminService) CreatePlan ¶
func (s *AdminService) CreatePlan(req AdminPlanCreateRequest) (*Plan, error)
func (*AdminService) GetBugReports ¶
func (s *AdminService) GetBugReports(page, limit *int, search *string) (*BugReportsResponse, error)
func (*AdminService) GetPlans ¶
func (s *AdminService) GetPlans() ([]Plan, error)
func (*AdminService) GetUsers ¶
func (s *AdminService) GetUsers() ([]AdminUser, error)
func (*AdminService) Login ¶
func (s *AdminService) Login(req AdminLoginRequest) (*AdminLoginResponse, error)
func (*AdminService) UpdatePlan ¶
func (s *AdminService) UpdatePlan(id string, req AdminPlanUpdateRequest) (*Plan, error)
type BoardService ¶
type BoardService struct {
// contains filtered or unexported fields
}
func (*BoardService) CreateBoard ¶
func (s *BoardService) CreateBoard(req CreateBoardPayload) (interface{}, error)
func (*BoardService) DeleteBoard ¶
func (s *BoardService) DeleteBoard(workspaceName, boardName string) (*GenericMessageResponse, error)
func (*BoardService) GetDeletedBoards ¶
func (s *BoardService) GetDeletedBoards() ([]DeletedBoard, error)
func (*BoardService) InviteMember ¶
func (s *BoardService) InviteMember(workspaceName, boardName, identifier string) (interface{}, error)
func (*BoardService) LeaveBoard ¶
func (s *BoardService) LeaveBoard(workspaceName, boardName string) error
func (*BoardService) RemoveMember ¶
func (s *BoardService) RemoveMember(workspaceName, boardName, identifier string) (*GenericMessageResponse, error)
func (*BoardService) RestoreBoard ¶
func (s *BoardService) RestoreBoard(workspaceName, boardName string) (*GenericMessageResponse, error)
func (*BoardService) UpdateBoardStatus ¶
func (s *BoardService) UpdateBoardStatus(workspaceName, boardName string, isActive bool) (*UpdateBoardStatusResponse, error)
type BugReportPayload ¶
type BugReportResponse ¶
type BugReportsResponse ¶
type BugService ¶
type BugService struct {
// contains filtered or unexported fields
}
func (*BugService) ReportBug ¶
func (s *BugService) ReportBug(payload BugReportPayload) (*BugReportResponse, error)
type CheckoutPayload ¶
type CheckoutPayload struct {
PriceID string `json:"priceId"`
}
type CheckoutResponse ¶
type CheckoutResponse struct {
ApprovalURL string `json:"approvalUrl"`
}
type Client ¶
type Client struct {
BaseURL string
Token string
HTTPClient *http.Client
Admin *AdminService
Board *BoardService
Bug *BugService
Directory *DirectoryService
Github *GithubService
Notification *NotificationService
Subscription *SubscriptionService
Task *TaskService
User *UserService
Workspace *WorkspaceService
}
Client represents the Syncoboard API client.
type CreateBoardPayload ¶
type CreateTaskPayload ¶
type CreateWorkspacePayload ¶
type CreateWorkspacePayload struct {
Name string `json:"name"`
}
type DeletedBoard ¶
type DirectoryEntry ¶
type DirectoryResponse ¶
type DirectoryService ¶
type DirectoryService struct {
// contains filtered or unexported fields
}
func (*DirectoryService) GetDirectory ¶
func (s *DirectoryService) GetDirectory(path string) (*DirectoryResponse, error)
type GenericMessageResponse ¶
type GenericMessageResponse struct {
Message string `json:"message"`
}
type GetReadStateResponse ¶
type GetReadStateResponse struct {
LastRead *string `json:"lastRead"`
}
type GithubRepo ¶
type GithubService ¶
type GithubService struct {
// contains filtered or unexported fields
}
func (*GithubService) GetRepos ¶
func (s *GithubService) GetRepos(workspaceID *string) ([]GithubRepo, error)
type InviteMemberBody ¶
type ListTasksResponse ¶
type NotificationActor ¶
type NotificationBoard ¶
type NotificationBoard struct {
Name string `json:"name"`
Workspace *NotificationWorkspace `json:"workspace,omitempty"`
}
type NotificationLog ¶
type NotificationLog struct {
Type string `json:"type"`
CreatedAt time.Time `json:"createdAt"`
Actor *NotificationActor `json:"actor,omitempty"`
Board *NotificationBoard `json:"board,omitempty"`
Task *NotificationTask `json:"task,omitempty"`
}
type NotificationService ¶
type NotificationService struct {
// contains filtered or unexported fields
}
func (*NotificationService) GetNotifications ¶
func (s *NotificationService) GetNotifications() ([]NotificationLog, error)
func (*NotificationService) GetReadState ¶
func (s *NotificationService) GetReadState() (*GetReadStateResponse, error)
func (*NotificationService) MarkAsRead ¶
func (s *NotificationService) MarkAsRead() (*SuccessResponse, error)
type NotificationTask ¶
type NotificationWorkspace ¶
type Plan ¶
type Plan struct {
ID string `json:"id"`
Name string `json:"name"`
MaxWorkspaces int `json:"maxWorkspaces"`
MaxBoardsPerWorkspace int `json:"maxBoardsPerWorkspace"`
MaxMembersPerBoard int `json:"maxMembersPerBoard"`
MaxActiveBoards int `json:"maxActiveBoards"`
IsTrial bool `json:"isTrial"`
IsActive bool `json:"isActive"`
CreatedAt time.Time `json:"createdAt"`
UpdatedAt time.Time `json:"updatedAt"`
}
type Subscription ¶
type SubscriptionService ¶
type SubscriptionService struct {
// contains filtered or unexported fields
}
func (*SubscriptionService) Checkout ¶
func (s *SubscriptionService) Checkout(priceID string) (*CheckoutResponse, error)
func (*SubscriptionService) SubscribeToFreePlan ¶
func (s *SubscriptionService) SubscribeToFreePlan() (*Subscription, error)
type SuccessResponse ¶
type SuccessResponse struct {
Success bool `json:"success"`
}
type TaskService ¶
type TaskService struct {
// contains filtered or unexported fields
}
func (*TaskService) AddTask ¶
func (s *TaskService) AddTask(payload CreateTaskPayload) (*Task, error)
func (*TaskService) DeleteTask ¶
func (s *TaskService) DeleteTask(taskID string) (*SuccessResponse, error)
func (*TaskService) ListTasks ¶
func (s *TaskService) ListTasks(workspaceName, boardName string, page, limit int) (*ListTasksResponse, error)
func (*TaskService) UpdateTaskStatus ¶
func (s *TaskService) UpdateTaskStatus(taskID, status string) (*Task, error)
type UpdateBoardStatusBody ¶
type UserService ¶
type UserService struct {
// contains filtered or unexported fields
}
func (*UserService) UpdateLastOnline ¶
func (s *UserService) UpdateLastOnline() error
type WorkspaceService ¶
type WorkspaceService struct {
// contains filtered or unexported fields
}
func (*WorkspaceService) CreateWorkspace ¶
func (s *WorkspaceService) CreateWorkspace(payload CreateWorkspacePayload) (*Workspace, error)
func (*WorkspaceService) DeleteWorkspace ¶
func (s *WorkspaceService) DeleteWorkspace(workspaceName string) (*GenericMessageResponse, error)
func (*WorkspaceService) GetUserWorkspaces ¶
func (s *WorkspaceService) GetUserWorkspaces(includeBoards bool) (interface{}, error)
func (*WorkspaceService) RestoreWorkspace ¶
func (s *WorkspaceService) RestoreWorkspace(workspaceName string) (*GenericMessageResponse, error)
func (*WorkspaceService) UpdateWorkspaceStatus ¶
func (s *WorkspaceService) UpdateWorkspaceStatus(workspaceName string, isActive bool) (*UpdateBoardStatusResponse, error)
type WorkspaceWithBoards ¶
type WorkspaceWithBoards struct {
Workspace
Boards []interface{} `json:"boards"`
}
Click to show internal directories.
Click to hide internal directories.