File Coverage

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

Criterion	Covered	Total	%
statement	9	9	100.0
branch			n/a
condition			n/a
subroutine	3	3	100.0
pod	1	1	100.0
total	13	13	100.0

package WebService::Mattermost::V4::API::Resource::Audits;
 2: 
 3: # ABSTRACT: Wrapped API methods for the audits API endpoints. 4: 
 5: use Moo;
 6: use Types::Standard 'Str';
 7: 
 8: extends 'WebService::Mattermost::V4::API::Resource';
 9: 
10: ################################################################################
11: 
12: has view_name => (is => 'ro', isa => Str, default => 'Audit');
13: 
14: ################################################################################
15: 
16: sub get {
17:     my $self = shift;
18:     my $args = shift;
19: 
20:     return $self->_get({ parameters => $args });
21: }
22: 
23: ################################################################################
24: 
25: 1;
26: 
27: __END__
28: 
29: =pod
30: 
31: =encoding UTF-8
32: 
33: =head1 NAME
34: 
35: WebService::Mattermost::V4::API::Resource::Audits - Wrapped API methods for the audits API endpoints.
36: 
37: =head1 VERSION
38: 
39: version 0.30
40: 
41: =head1 DESCRIPTION
42: 
43: =head2 USAGE
44: 
45:     use WebService::Mattermost;
46: 
47:     my $mm = WebService::Mattermost->new({
48:         authenticate => 1,
49:         username     => '[e-mail]',
50:         password     => 'hunter2',
51:         base_url     => 'https://my.mattermost.server.com/api/v4/',
52:     });
53: 
54:     my $resource = $mm->api->audits;
55: 
56: =head2 METHODS
57: 
58: =over 4
59: 
60: =item C<get()>
61: 
62: L<Get audits|https://api.mattermost.com/#tag/system%2Fpaths%2F~1audits%2Fget>
63: 
64:     my $response = $resource->get({
65:         # Optional parameters:
66:         page     => 0,
67:         per_page => 60,
68:     });
69: 
70: =back
71: 
72: =head1 AUTHOR
73: 
74: Mike Jones <[e-mail]>
75: 
76: =head1 COPYRIGHT AND LICENSE
77: 
78: This software is Copyright (c) 2023 by Mike Jones.
79: 
80: This is free software, licensed under:
81: 
82:   The MIT (X11) License
83: 
84: =cut
85: