/ 
Kanboard-API-0.01
River stage zero No dependents
/ Kanboard::API

NAME

Kanboard::API - A Perl interface to the Kanboard API

VERSION

Version 0.01

SYNOPSIS

Kanboard::API is a Perl interface to the Kanboard API. It provides a simple way to interact with a Kanboard instance.

use Kanboard::API;

my $kanboard = Kanboard::API->new(username => 'yourusername|jsonrpc', password => 'apikey', endpoint => 'https://yourkanboardinstance.com');
...

ATTRIBUTES

username

The username to use for authentication. Defaults to "jsonrpc".

password

The password to use for authentication.

endpoint

The JSON RPC Endpoint of the Kanboard instance.

ua

The LWP::UserAgent object used to make requests.

PRIVATE METHODS

_request

PUBLIC METHODS

get_version

Purpose: Get the application version Parameters: none Result: version (Example: 1.0.12, master)

get_me

Purpose: Get the current user profile Parameters: None Result on success: user properties Result on failure: empty list

create_project

Purpose: Create a new project Parameters: name (string, required) description (string, optional) owner_id (integer, optional) identifier (string, optional) Result on success: project ID Result on failure: false

remove_project

Purpose: Remove a project Parameters: project_id (integer, required) Result on success: true Result on failure: false

get_project

Purpose: Get project details Parameters: project_id (integer, required) Result on success: project properties Result on failure: empty list

create_task

Purpose: Create a new task Parameters: title (string, required) project_id (integer, required) description (string, optional) category_id (integer, optional) owner_id (integer, optional) color_id (string, optional) column_id (integer, optional) swimlane_id (integer, optional) priority (integer, optional) date_due (timestamp, optional) Result on success: task ID Result on failure: false

remove_task

Purpose: Remove a task Parameters: task_id (integer, required) Result on success: true Result on failure: false

get_task

Purpose: Get task details Parameters: task_id (integer, required) Result on success: task properties Result on failure: empty list

get_all_tasks

Purpose: Get all tasks for a project Parameters: project_id (integer, required) Result on success: list of tasks Result on failure: empty list

get_board

Purpose: Get all necessary information to display a board Parameters: project_id (integer, required) Result on success: board properties Result on failure: empty list

AUTHOR

Dan Barbarito, <dan at barbarito.me>

BUGS

Please report any bugs or feature requests to bug-kanboard-api at rt.cpan.org, or through the web interface at https://rt.cpan.org/NoAuth/ReportBug.html?Queue=Kanboard-API. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc Kanboard::API

You can also look for information at:

ACKNOWLEDGEMENTS

LICENSE AND COPYRIGHT

This software is Copyright (c) 2024 by Dan Barbarito.

This is free software, licensed under:

The Artistic License 2.0 (GPL Compatible)