File Coverage

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

Criterion	Covered	Total	%
statement	6	8	75.0
branch			n/a
condition			n/a
subroutine	2	3	66.6
pod	1	1	100.0
total	9	12	75.0

package WebService::Mattermost::V4::API::Resource::DataRetention;
 2: 
 3: # ABSTRACT: Wrapped API methods for the data retention 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 => 'DataRetentionPolicy');
13: 
14: ################################################################################
15: 
16: sub policy {
17:     my $self = shift;
18: 
19:     return $self->_get({ endpoint => 'policy' });
20: }
21: 
22: ################################################################################
23: 
24: 1;
25: 
26: __END__
27: 
28: =pod
29: 
30: =encoding UTF-8
31: 
32: =head1 NAME
33: 
34: WebService::Mattermost::V4::API::Resource::DataRetention - Wrapped API methods for the data retention API endpoints.
35: 
36: =head1 VERSION
37: 
38: version 0.30
39: 
40: =head1 DESCRIPTION
41: 
42: =head2 USAGE
43: 
44:     use WebService::Mattermost;
45: 
46:     my $mm = WebService::Mattermost->new({
47:         authenticate => 1,
48:         username     => '[e-mail]',
49:         password     => 'passwordhere',
50:         base_url     => 'https://my.mattermost.server.com/api/v4/',
51:     });
52: 
53:     my $data_retention = $mm->api->data_retention;
54: 
55: =head2 METHODS
56: 
57: =over 4
58: 
59: =item C<policy()>
60: 
61:     my $response = $data_retention->policy;
62: 
63: =back
64: 
65: =head1 SEE ALSO
66: 
67: =over 4
68: 
69: =item L<https://api.mattermost.com/#tag/dataretention>
70: 
71: Official "DataRetention" API documentation.
72: 
73: =back
74: 
75: =head1 AUTHOR
76: 
77: Mike Jones <[e-mail]>
78: 
79: =head1 COPYRIGHT AND LICENSE
80: 
81: This software is Copyright (c) 2023 by Mike Jones.
82: 
83: This is free software, licensed under:
84: 
85:   The MIT (X11) License
86: 
87: =cut
88: