twapi

README

Teamwork.com API - Go SDK

This is the official Go SDK for the Teamwork.com API. https://apidocs.teamwork.com/

Documentation

Index

• func Execute[T HTTPResponser](ctx context.Context, engine *Engine, requester HTTPRequester) (T, error)
• func Ptr[T any](v T) *T
• type Date
  • func (d Date) MarshalJSON() ([]byte, error)
  • func (d Date) MarshalText() ([]byte, error)
  • func (d Date) String() string
  • func (d *Date) UnmarshalJSON(data []byte) error
  • func (d *Date) UnmarshalText(text []byte) error
• type Engine
  • func NewEngine(session Session, opts ...EngineOption) *Engine
• type EngineOption
  • func WithHTTPClient(client *http.Client) EngineOption
  • func WithLogger(logger *slog.Logger) EngineOption
  • func WithRequestMiddleware(middleware func(HTTPRequester) HTTPRequester) EngineOption
  • func WithResponseMiddleware(middleware func(HTTPResponser) HTTPResponser) EngineOption
• type HTTPError
  • func NewHTTPError(resp *http.Response, message string) *HTTPError
  • func (e *HTTPError) Error() string
• type HTTPRequester
• type HTTPResponser
• type Money
  • func (m *Money) Set(value float64)
  • func (m Money) Value() float64
• type OptionalDateTime
  • func (d OptionalDateTime) MarshalJSON() ([]byte, error)
  • func (d *OptionalDateTime) UnmarshalJSON(data []byte) error
• type Relationship
• type Session
• type Time
  • func (t Time) MarshalJSON() ([]byte, error)
  • func (t Time) MarshalText() ([]byte, error)
  • func (t Time) String() string
  • func (t *Time) UnmarshalJSON(data []byte) error
  • func (t *Time) UnmarshalText(text []byte) error

Functions

func Execute

func Execute[T HTTPResponser](ctx context.Context, engine *Engine, requester HTTPRequester) (T, error)

Execute sends an HTTP request using the provided requester and handles the response using the provided responser.

func Ptr

func Ptr[T any](v T) *T

Ptr returns a pointer to the value v.

Types

type Date

type Date time.Time

Date is a type alias for time.Time, used to represent date values in the API.

func (Date) MarshalJSON

func (d Date) MarshalJSON() ([]byte, error)

MarshalJSON encodes the Date as a string in the format "2006-01-02".

func (Date) MarshalText

func (d Date) MarshalText() ([]byte, error)

MarshalText encodes the Date as a string in the format "2006-01-02".

func (Date) String

func (d Date) String() string

String returns the string representation of the Date in the format "2006-01-02".

func (*Date) UnmarshalJSON

func (d *Date) UnmarshalJSON(data []byte) error

UnmarshalJSON decodes a JSON string into a Date type.

func (*Date) UnmarshalText

func (d *Date) UnmarshalText(text []byte) error

UnmarshalText decodes a text string into a Date type. This is required when using Date type as a map key.

type Engine

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

Engine is the main structure that handles communication with the Teamwork API.

func NewEngine

func NewEngine(session Session, opts ...EngineOption) *Engine

NewEngine creates a new Engine instance with the provided HTTP client and session.

type EngineOption

type EngineOption func(*Engine)

EngineOption is a function that modifies the Engine configuration.

func WithHTTPClient

func WithHTTPClient(client *http.Client) EngineOption

WithHTTPClient sets the HTTP client for the Engine. By default, it uses http.DefaultClient.

func WithLogger

func WithLogger(logger *slog.Logger) EngineOption

WithLogger sets the logger for the Engine. By default, it uses slog.Default().

func WithRequestMiddleware

func WithRequestMiddleware(middleware func(HTTPRequester) HTTPRequester) EngineOption

WithRequestMiddleware adds a request middleware to the Engine. Middlewares are applied in the order they are added.

func WithResponseMiddleware

func WithResponseMiddleware(middleware func(HTTPResponser) HTTPResponser) EngineOption

WithResponseMiddleware adds a response middleware to the Engine. Middlewares are applied in the order they are added.

type HTTPError

type HTTPError struct {
	StatusCode int
	Headers    http.Header
	Message    string
	Details    string
}

HTTPError represents an error response from the API.

func NewHTTPError

func NewHTTPError(resp *http.Response, message string) *HTTPError

NewHTTPError creates a new HTTPError from an http.Response.

func (*HTTPError) Error

func (e *HTTPError) Error() string

Error implements the error interface.

type HTTPRequester

type HTTPRequester interface {
	HTTPRequest(ctx context.Context, server string) (*http.Request, error)
}

HTTPRequester knows how to create an HTTP request for a specific entity.

type HTTPResponser

type HTTPResponser interface {
	HandleHTTPResponse(resp *http.Response) error
}

HTTPResponser knows how to handle an HTTP response for a specific entity.

type Money

type Money int64

Money represents a monetary value in the API.

func (*Money) Set

func (m *Money) Set(value float64)

Set sets the value of Money from a float64.

func (Money) Value

func (m Money) Value() float64

Value returns the value of Money as a float64.

type OptionalDateTime

type OptionalDateTime time.Time

OptionalDateTime is a type alias for time.Time, used to represent date and time values in the API. The difference is that it will accept empty strings as valid values.

func (OptionalDateTime) MarshalJSON

func (d OptionalDateTime) MarshalJSON() ([]byte, error)

MarshalJSON encodes the OptionalDateTime as a string in the format "2006-01-02T15:04:05Z07:00".

func (*OptionalDateTime) UnmarshalJSON

func (d *OptionalDateTime) UnmarshalJSON(data []byte) error

UnmarshalJSON decodes a JSON string into an OptionalDateTime type.

type Relationship

type Relationship struct {
	ID   int64          `json:"id"`
	Type string         `json:"type"`
	Meta map[string]any `json:"meta,omitempty"`
}

Relationship describes the relation between the main entity and a sideload type.

type Session

type Session interface {
	Authenticate(ctx context.Context, req *http.Request) error
	Server() string
}

Session is an interface that defines the methods required for a session to authenticate requests to the Teamwork Engine.

type Time

type Time time.Time

Time is a type alias for time.Time, used to represent time values in the API.

func (Time) MarshalJSON

func (t Time) MarshalJSON() ([]byte, error)

MarshalJSON encodes the Time as a string in the format "15:04:05".

func (Time) MarshalText

func (t Time) MarshalText() ([]byte, error)

MarshalText encodes the Time as a string in the format "15:04:05".

func (Time) String

func (t Time) String() string

String returns the string representation of the Time in the format "15:04:05".

func (*Time) UnmarshalJSON

func (t *Time) UnmarshalJSON(data []byte) error

UnmarshalJSON decodes a JSON string into a Date type.

func (*Time) UnmarshalText

func (t *Time) UnmarshalText(text []byte) error

UnmarshalText decodes a text string into a Time type. This is required when using Time type as a map key.