File Coverage

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

Criterion	Covered	Total	%
statement	3	5	60.0
branch			n/a
condition			n/a
subroutine	1	2	50.0
pod	1	1	100.0
total	5	8	62.5

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