API Reference¶

Complete API documentation is available on pkg.go.dev.

Package Documentation¶

Package	pkg.go.dev
`aha-go` (root)	pkg.go.dev/github.com/grokify/aha-go
`canvas`	pkg.go.dev/github.com/grokify/aha-go/canvas
`browser`	pkg.go.dev/github.com/grokify/aha-go/browser
`render`	pkg.go.dev/github.com/grokify/aha-go/render

Core Types¶

Client¶

type Client struct {
    // unexported fields
}

func NewClient() (*Client, error)
func NewClientWithConfig(cfg Config) (*Client, error)

Config¶

type Config struct {
    Subdomain string
    APIKey    string
    BaseURL   string // Optional, defaults to https://{subdomain}.aha.io
}

func ConfigFromEnv() Config

Entity Types¶

Feature¶

type Feature struct {
    ID              string    `json:"id"`
    ReferenceNum    string    `json:"reference_num"`
    Name            string    `json:"name"`
    Description     string    `json:"description"`
    Status          string    `json:"workflow_status"`
    AssignedTo      *User     `json:"assigned_to_user"`
    Release         *Release  `json:"release"`
    StartDate       string    `json:"start_date"`
    DueDate         string    `json:"due_date"`
    Tags            []Tag     `json:"tags"`
    CreatedAt       time.Time `json:"created_at"`
    UpdatedAt       time.Time `json:"updated_at"`
}

Idea¶

type Idea struct {
    ID             string     `json:"id"`
    ReferenceNum   string     `json:"reference_num"`
    Name           string     `json:"name"`
    Description    string     `json:"description"`
    Votes          int        `json:"votes"`
    WorkflowStatus string     `json:"workflow_status"`
    Categories     []Category `json:"idea_categories"`
    CreatedAt      time.Time  `json:"created_at"`
    UpdatedAt      time.Time  `json:"updated_at"`
}

Release¶

type Release struct {
    ID           string    `json:"id"`
    ReferenceNum string    `json:"reference_num"`
    Name         string    `json:"name"`
    StartDate    string    `json:"start_date"`
    ReleaseDate  string    `json:"release_date"`
    Released     bool      `json:"released"`
    CreatedAt    time.Time `json:"created_at"`
}

Initiative¶

type Initiative struct {
    ID           string    `json:"id"`
    ReferenceNum string    `json:"reference_num"`
    Name         string    `json:"name"`
    Description  string    `json:"description"`
    Status       string    `json:"workflow_status"`
    Value        float64   `json:"value"`
    Effort       float64   `json:"effort"`
    Progress     float64   `json:"progress"`
    StartDate    string    `json:"start_date"`
    EndDate      string    `json:"end_date"`
    CreatedAt    time.Time `json:"created_at"`
}

Goal¶

type Goal struct {
    ID           string    `json:"id"`
    ReferenceNum string    `json:"reference_num"`
    Name         string    `json:"name"`
    Description  string    `json:"description"`
    Status       string    `json:"workflow_status"`
    Progress     float64   `json:"progress"`
    StartDate    string    `json:"start_date"`
    EndDate      string    `json:"end_date"`
    CreatedAt    time.Time `json:"created_at"`
}

Client Methods¶

Products¶

func (c *Client) ListProducts(ctx context.Context, opts ...ListProductsOption) (*ProductList, error)
func (c *Client) GetProduct(ctx context.Context, id string) (*Product, error)
func (c *Client) CreateProduct(ctx context.Context, name, referencePrefix string, opts ...CreateProductOption) (*Product, error)
func (c *Client) CreateProductLine(ctx context.Context, name, referencePrefix, productLineType string, opts ...CreateProductOption) (*Product, error)
func (c *Client) UpdateProduct(ctx context.Context, id string, opts ...UpdateProductOption) (*Product, error)

Product Options¶

// ListProducts options
func WithUpdatedSince(t time.Time) ListProductsOption
func WithIdeaPortals() ListProductsOption
func WithProductsPage(page int) ListProductsOption
func WithProductsPerPage(perPage int) ListProductsOption

// CreateProduct options
func WithProductDescription(desc string) CreateProductOption
func WithProductParentID(parentID string) CreateProductOption
func WithProductWorkspaceType(workspaceType string) CreateProductOption

// UpdateProduct options
func WithUpdateProductName(name string) UpdateProductOption
func WithUpdateProductReferencePrefix(prefix string) UpdateProductOption
func WithUpdateProductDescription(desc string) UpdateProductOption
func WithUpdateProductParentID(parentID string) UpdateProductOption
func WithUpdateProductWorkspaceType(workspaceType string) UpdateProductOption

Features¶

func (c *Client) ListFeatures(ctx context.Context, productID string, opts ...Option) ([]Feature, error)
func (c *Client) GetFeature(ctx context.Context, ref string) (*Feature, error)
func (c *Client) CreateFeature(ctx context.Context, productID string, req CreateFeatureRequest) (*Feature, error)
func (c *Client) UpdateFeature(ctx context.Context, ref string, req UpdateFeatureRequest) (*Feature, error)

Ideas¶

func (c *Client) ListIdeas(ctx context.Context, productID string, opts ...Option) ([]Idea, error)
func (c *Client) GetIdea(ctx context.Context, ref string) (*Idea, error)
func (c *Client) UpdateIdea(ctx context.Context, id string, opts ...UpdateIdeaOption) (*Idea, error)

Update Idea Options¶

func WithUpdateIdeaName(name string) UpdateIdeaOption
func WithUpdateIdeaDescription(desc string) UpdateIdeaOption
func WithUpdateIdeaStatus(status string) UpdateIdeaOption
func WithUpdateIdeaCategories(categories []string) UpdateIdeaOption
func WithUpdateIdeaVisibility(visibility string) UpdateIdeaOption

Releases¶

func (c *Client) ListReleases(ctx context.Context, productID string, opts ...Option) ([]Release, error)
func (c *Client) GetRelease(ctx context.Context, ref string) (*Release, error)

Custom Field Definitions¶

func (c *Client) ListCustomFieldDefinitions(ctx context.Context) ([]CustomFieldDefinition, error)
func (c *Client) ListProductCustomFieldDefinitions(ctx context.Context, productID string) ([]CustomFieldDefinition, error)
func (c *Client) ListCustomFieldOptions(ctx context.Context, fieldID string) ([]CustomFieldOption, error)

Custom Field Types¶

type CustomFieldDefinition struct {
    ID                  string
    Name                string
    Key                 string
    Type                string
    CustomFieldableType string // Feature, Initiative, Epic, etc.
    InternalName        string
    Position            int64
    APIType             string
    AllowsOtherOption   bool
}

type CustomFieldOption struct {
    ID       string
    Value    string
    Position int64
    Color    string
}

Comments¶

func (c *Client) ListComments(ctx context.Context, opts ...Option) ([]Comment, error)
func (c *Client) GetComment(ctx context.Context, id string) (*Comment, error)
func (c *Client) CreateComment(ctx context.Context, req CreateCommentRequest) (*Comment, error)
func (c *Client) DeleteComment(ctx context.Context, id string) error

Options¶

// Pagination
func WithPage(page int) Option
func WithPerPage(perPage int) Option

// Filtering
func WithStatus(status string) Option
func WithRelease(release string) Option
func WithAssignedTo(email string) Option

// Sorting
func WithSort(field string) Option
func WithSortDirection(dir string) Option

// Date filtering
func WithUpdatedSince(t time.Time) Option
func WithCreatedSince(t time.Time) Option

Error Handling¶

func IsNotFoundError(err error) bool
func IsUnauthorizedError(err error) bool
func IsRateLimitError(err error) bool

Aha.io API Documentation¶

For details on the underlying Aha.io API: