File Coverage

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