NAME

BZ::Client::REST - Bugzilla client for Perl using the RESTful API

SYNOPSIS

use BZ::Client::REST;

my $client = BZ::Client::REST->new(
    {
        user     => $user,
        password => $password,
        url      => $url,
    }
);

$id   = $client->create_bug($params);
$bugs = $client->search_bugs($params);

DESCRIPTION

This module is an object-oriented interface for Bugzilla's REST api. It differs from other avaiable options in that it uses the current /rest endpoint instead of the currently deprecated XML-RPC or JSON-RPC options.

Methods

login()

$client->login();

This method triggers the modules to call Bugzilla's login api to generate a token for later use. It is not necessary to call this method, as it will be called automatically if a login is needed.

search_bugs()

$bugs = $client->search_bugs($params);

This method accepts a hashref of key/value parameters to search on. Refer to http://bugzilla.readthedocs.io/en/latest/api/core/v1/bug.html#search-bugs for the valid keys that can be used.

create_bug()

$bug_id = $client->create_bug($params);

This method accepts a hashref of key/value parameters to create a new bug with. Refer to http://bugzilla.readthedocs.io/en/latest/api/core/v1/bug.html#create-bugs for the valid keys that can be used.

update_bug()

$data = $client->update_bug($id, $params);

This method accepts a bug id and a hashref of key/value pairs to update the existing bug with.

Refer to http://bugzilla.readthedocs.io/en/latest/api/core/v1/bug.html#update-bug for the valid keys that can be used.

BUGS

Submit bugs to https://github.com/kylemhall/BZ-Client-REST/issues

COPYRIGHT

Copyright (C) 2018 Kyle M Hall

LICENSE

This module is licensed using Perl Artistic License

AUTHOR

Kyle M Hall <[email protected]> http://kylehall.info

SEE ALSO

REST::Client