File Coverage

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

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

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

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

use Moo;

extends 'WebService::Mattermost::V4::API::Resource';
with    qw(
    WebService::Mattermost::V4::API::Resource::Role::Single
);

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

around [ qw(activate deactivate remove) ] => sub {
    my $orig = shift;
    my $self = shift;
    my $id   = shift || $self->id;

    return $self->validate_id($orig, $id, @_);
};

sub remove {
    my $self = shift;
    my $id   = shift;

    return $self->_single_view_delete({
        endpoint => '%s',
        ids      => [ $id ],
        view     => 'Status',
    });
}

sub activate {
    my $self = shift;
    my $id   = shift;

    return $self->_single_view_post({
        endpoint => '%s/activate',
        ids      => [ $id ],
        view     => 'Status',
    });
}

sub deactivate {
    my $self = shift;
    my $id   = shift;

    return $self->_single_view_post({
        endpoint => '%s/deactivate',
        ids      => [ $id ],
        view     => 'Status',
    });
}

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

1;

__END__

=pod

=encoding UTF-8

=head1 NAME

WebService::Mattermost::V4::API::Resource::Plugin - Wrapped API methods for the plugin 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->plugin;

Optionally, you can set a global plugin ID and not pass that argument to every
method:

    $resource->id('PLUGIN-ID-HERE');

This would make the C<deactivate()> call look like:

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

=head2 METHODS

=over 4

=item C<remove()>

L<Remove plugin|https://api.mattermost.com/#tag/plugins%2Fpaths%2F~1plugins~1%7Bplugin_id%7D%2Fdelete>

    my $response = $resource->remove('PLUGIN-ID-HERE');

=item C<activate()>

L<Activate plugin|https://api.mattermost.com/#tag/plugins%2Fpaths%2F~1plugins~1%7Bplugin_id%7D~1activate%2Fpost>

    my $response = $resource->activate('PLUGIN-ID-HERE');

=item C<deactivate()>

L<Deactivate plugin|https://api.mattermost.com/#tag/plugins%2Fpaths%2F~1plugins~1%7Bplugin_id%7D~1deactivate%2Fpost>

    my $response = $resource->deactivate('PLUGIN-ID-HERE');

=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