Categorygithub.com/theartofeducation/clickup-go
modulepackage
0.2.1
Repository: https://github.com/theartofeducation/clickup-go.git
Documentation: pkg.go.dev

# README

ClickUp Go

CI Go Reference

A client for using the ClickUp API.

Support Features

Signatures

The library will validate a request against the request's signature.

Webhooks

The library will parse ClickUp Webhooks from an HTTP request.

Get Task

The library will fetch a Task by Task ID.

Update Task

The library will update an existing Task.

Mocking

Full mocks for all features are included to make testing consuming modules easier.

# Functions

NewClient creates and returns a new ClickUp Client.

# Constants

Webhook Events.
ClickUp Statuses.
ClickUp Statuses.
ClickUp Statuses.

# Variables

Custom errors.
Custom errors.
ErrTest is returned for testing method errors.

# Structs

Assignees holds lists of users to be added or removed from the Task.
Client handles interaction with the ClickUp API.
MockClient is a mock Client to use for testing.
Options are the settings needed when creating a new Client.
Task holds information for a ClickUp Task.
TaskStatus holds a Task's Status information.
UpdateTaskRequest holds the payload for UpdateTask.
Webhook holds the information for a ClickUp Webhook.

# Interfaces

CUClient defines available methods.

# Type aliases

Event is the action that triggered the Webhook.
Status holds the various statuses of a ClickUp Task.