File Coverage

blib/lib/WebService/Mattermost/V4/API/Object/Compliance/Report.pm

Criterion	Covered	Total	%
statement	6	24	25.0
branch			n/a
condition			n/a
subroutine	2	10	20.0
pod	0	1	0.0
total	8	35	22.8

package WebService::Mattermost::V4::API::Object::Compliance::Report;

# ABSTRACT: A compliance report item.

use Moo;
use Types::Standard qw(Str InstanceOf Int Maybe);

extends 'WebService::Mattermost::V4::API::Object';
with    qw(
    WebService::Mattermost::V4::API::Object::Role::APIMethods
    WebService::Mattermost::V4::API::Object::Role::ID
    WebService::Mattermost::V4::API::Object::Role::Status
    WebService::Mattermost::V4::API::Object::Role::CreatedAt
    WebService::Mattermost::V4::API::Object::Role::BelongingToUser
);

################################################################################

has [ qw(count start_at end_at) ]     => (is => 'ro', isa => Maybe[Int], lazy => 1, builder => 1);
has [ qw(desc type keywords emails) ] => (is => 'ro', isa => Maybe[Str], lazy => 1, builder => 1);

has [ qw(
    started_at
    ended_at
) ] => (is => 'ro', isa => Maybe[InstanceOf['DateTime']], lazy => 1, builder => 1);

################################################################################

sub BUILD {
    my $self = shift;

    $self->api_resource_name('compliance_report');
    $self->set_available_api_methods([ 'download' ]);

    return 1;
}

################################################################################

sub _build_count {
    my $self = shift;

    return $self->raw_data->{count};
}

sub _build_start_at {
    my $self = shift;

    return $self->raw_data->{start_at};
}

sub _build_end_at {
    my $self = shift;

    return $self->raw_data->{end_at};
}

sub _build_desc {
    my $self = shift;

    return $self->raw_data->{desc};
}

sub _build_type {
    my $self = shift;

    return $self->raw_data->{type};
}

sub _build_keywords {
    my $self = shift;

    return $self->raw_data->{keywords};
}

sub _build_emails {
    my $self = shift;

    return $self->raw_data->{emails};
}

################################################################################

1;

__END__

=pod

=encoding UTF-8

=head1 NAME

WebService::Mattermost::V4::API::Object::Compliance::Report - A compliance report item.

=head1 VERSION

version 0.26

=head1 DESCRIPTION

See matching methods in L<WebService::Mattermost::V4::API::Resource::Compliance::Report>
for full documentation.

ID parameters are not required:

    my $response = $mattermost->api->compliance_report->get('ID-HERE')->item->download();

Is the same as:

    my $response = $mattermost->api->compliance_report->download('ID-HERE');

=head2 ATTRIBUTES

=over 4

=item C<count>

=item C<start_at>

=item C<end_at>

=item C<desc>

=item C<type>

=item C<keywords>

=item C<emails>

=item C<started_at>

=item C<ended_at>

=back

=head1 SEE ALSO

=over 4

=item L<WebService::Mattermost::V4::API::Resource::Compliance::Report>

=item L<WebService::Mattermost::V4::API::Object::Role::ID>

=item L<WebService::Mattermost::V4::API::Object::Role::Status>

=item L<WebService::Mattermost::V4::API::Object::Role::CreatedAt>

=item L<WebService::Mattermost::V4::API::Object::Role::BelongingToUser>

=back

=head1 AUTHOR

Mike Jones <[e-mail]>

=head1 COPYRIGHT AND LICENSE

This software is Copyright (c) 2020 by Mike Jones.

This is free software, licensed under:

  The MIT (X11) License

=cut