—

              
#!perl
# PODNAME: RT::Client::REST::Queue
# ABSTRACT: queue object representation.
use strict;
use warnings;
package RT::Client::REST::Queue;
$RT::Client::REST::Queue::VERSION = '0.72';
use Params::Validate qw(:types);
use RT::Client::REST;
use RT::Client::REST::Object;
use RT::Client::REST::Object::Exception;
use RT::Client::REST::SearchResult;
use RT::Client::REST::Ticket;
use parent 'RT::Client::REST::Object';
sub _attributes {{
    id  => {
        validation  => {
            type    => SCALAR,
        },
        form2value  => sub {
            shift =~ m~^queue/(\d+)$~i;
            return $1;
        },
        value2form  => sub {
            return 'queue/' . shift;
        },
    },
    name   => {
        validation  => {
            type    => SCALAR,
        },
    },
    description => {
        validation  => {
            type    => SCALAR,
        },
    },
    correspond_address => {
        validation  => {
            type    => SCALAR,
        },
        rest_name => 'CorrespondAddress',
    },
    comment_address => {
        validation  => {
            type    => SCALAR,
        },
        rest_name => 'CommentAddress',
    },
    initial_priority => {
        validation  => {
            type    => SCALAR,
        },
        rest_name => 'InitialPriority',
    },
    final_priority => {
        validation  => {
            type    => SCALAR,
        },
        rest_name => 'FinalPriority',
    },
    default_due_in => {
        validation  => {
            type    => SCALAR,
        },
        rest_name => 'DefaultDueIn',
    },
    disabled => {
        validation => {
            type   => SCALAR,
        },
        rest_name => 'Disabled',
    },
    admin_cc_addresses => {
        validation => {
            type => SCALAR,
        },
        rest_name => 'AdminCcAddresses',
    },
    cc_addresses => {
        validation => {
            type => SCALAR,
        },
        rest_name => 'CcAddresses',
    },
    sla_disabled => {
        validation => {
            type => SCALAR,
        },
        rest_name => 'SLADisabled',
    },
}}
sub tickets {
    my $self = shift;
    $self->_assert_rt_and_id;
    return RT::Client::REST::Ticket
        ->new(rt => $self->rt)
        ->search(limits => [
            {attribute => 'queue', operator => '=', value => $self->id},
        ]);
}
sub rt_type { 'queue' }
__PACKAGE__->_generate_methods;
1;
__END__
HideShow 168 lines of Pod
=pod
=encoding UTF-8
=head1 NAME
RT::Client::REST::Queue - queue object representation.
=head1 VERSION
version 0.72
=head1 SYNOPSIS
  my $rt = RT::Client::REST->new(server => $ENV{RTSERVER});
  my $queue = RT::Client::REST::Queue->new(
    rt  => $rt,
    id  => 'General',
  )->retrieve;
=head1 DESCRIPTION
B<RT::Client::REST::Queue> is based on L<RT::Client::REST::Object>.
The representation allows one to retrieve, edit, comment on, and create
queue in RT.
Note: RT currently does not allow REST client to search queues.
=head1 ATTRIBUTES
=over 2
=item B<id>
For retrieval, you can specify either the numeric ID of the queue or its
name (case-sensitive).  After the retrieval, however, this attribute will
be set to the numeric id.
=item B<name>
This is the name of the queue.
=item B<description>
Queue description.
=item B<correspond_address>
Correspond address.
=item B<comment_address>
Comment address.
=item B<initial_priority>
Initial priority.
=item B<final_priority>
Final priority.
=item B<default_due_in>
Default due in.
=item B<disabled>
Queue is disabled
=item B<admin_cc_addresses>
Admin CC Addresses (comma delimited).
=item B<cc_addresses>
CC Addresses (comma delimited).
=for stopwords SLA
=item B<sla_disabled>
Queue SLA is disabled
=item B<cf>
Access custom fields. Inherited from L<RT::Client::REST::Object>, where
you can read more details.
Trivial example:
 my $queue = RT::Client::REST::Queue->new(
   rt => $rt,
   id => $queue_id
 )->retrieve();
 my @customfields = $queue->cf();
 for my $f (@customfields) {
   my $v = $queue->cf($f);
   say "field: $f";
   say "value: $v";
 }
=back
=head1 DB METHODS
For full explanation of these, please see B<"DB METHODS"> in
L<RT::Client::REST::Object> documentation.
=over 2
=item B<retrieve>
Retrieve queue from database.
=item B<store>
Create or update the queue.
=item B<search>
Currently RT does not allow REST clients to search queues.
=back
=head1 QUEUE-SPECIFIC METHODS
=over 2
=item B<tickets>
Get tickets that are in this queue (note: this may be a lot of tickets).
Note: tickets with status "deleted" will not be shown.
Object of type L<RT::Client::REST::SearchResult> is returned which then
can be used to get to objects of type L<RT::Client::REST::Ticket>.
=back
=head1 INTERNAL METHODS
=over 2
=item B<rt_type>
Returns 'queue'.
=back
=head1 SEE ALSO
L<RT::Client::REST>, L<RT::Client::REST::Object>,
L<RT::Client::REST::SearchResult>,
L<RT::Client::REST::Ticket>.
=head1 AUTHOR
Dean Hamstead <dean@fragfest.com.au>
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2023, 2020 by Dmitri Tikhonov.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
=cut