File Coverage

blib/lib/WebService/Mattermost/V4/API/Resource/Compliance.pm

Criterion	Covered	Total	%
statement	6	11	54.5
branch			n/a
condition			n/a
subroutine	2	4	50.0
pod	2	2	100.0
total	10	17	58.8

package WebService::Mattermost::V4::API::Resource::Compliance;

# ABSTRACT: Wrapped API methods for the compliance API endpoints.

use Moo;
use Types::Standard 'Str';

extends 'WebService::Mattermost::V4::API::Resource';

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

has view_name => (is => 'ro', isa => Str, default => 'Compliance::Report');

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

sub create_report {
    my $self = shift;

    return $self->_post({ endpoint => 'reports' });
}

sub get_reports {
    my $self = shift;
    my $args = shift;

    return $self->_get({
        view       => 'Compliance::Report',
        endpoint   => 'reports',
        parameters => $args,
    });
}

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

1;

__END__

=pod

=encoding UTF-8

=head1 NAME

WebService::Mattermost::V4::API::Resource::Compliance - Wrapped API methods for the compliance API endpoints.

=head1 VERSION

version 0.26

=head1 DESCRIPTION

=head2 USAGE

    use WebService::Mattermost;

    my $mm = WebService::Mattermost->new({
        authenticate => 1,
        username     => '[e-mail]',
        password     => 'hunter2',
        base_url     => 'https://my.mattermost.server.com/api/v4/',
    });

    my $resource = $mm->api->compliance;

=head2 METHODS

=over 4

=item C<create_report()>

Create a new compliance report.

    my $response = $resource->create_report();

=item C<get_reports()>

Get all compliance reports.

    my $response = $resource->get_reports({
        # Optional parameters
        page     => 0,  # default values
        per_page => 60,
    });

=back

=head1 SEE ALSO

=over 4

=item L<Official compliance documentation|https://api.mattermost.com/#tag/compliance>

=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