CPAN::Groonga

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

# ABSTRACT: A plugin item.

use Moo;
use Types::Standard qw(Bool HashRef Maybe Str);

extends 'WebService::Mattermost::V4::API::Object';
with    qw(
    WebService::Mattermost::V4::API::Object::Role::APIMethods
    WebService::Mattermost::V4::API::Object::Role::Description
    WebService::Mattermost::V4::API::Object::Role::Name
    WebService::Mattermost::V4::API::Object::Role::ID
);

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

has backend         => (is => 'ro', isa => Maybe[HashRef]);
has prepackaged     => (is => 'ro', isa => Maybe[Bool]);
has settings_schema => (is => 'ro', isa => Maybe[HashRef]);
has version         => (is => 'ro', isa => Maybe[Str]);
has webapp          => (is => 'ro', isa => Maybe[HashRef]);

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

around BUILDARGS => sub {
    my $orig = shift;
    my $self = shift;
    my $args = shift;

    # Convert JSON::PP::Boolean into regular boolean
    $args->{prepackaged} = $args->{prepackaged} ? 1 : 0;

    return $self->$orig($args);
};

sub BUILD {
    my $self = shift;

    $self->api_resource_name('plugin');
    $self->set_available_api_methods([ qw(remove activate deactivate) ]);

    return 1;
}

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

1;

__END__

=pod

=encoding UTF-8

=head1 NAME

WebService::Mattermost::V4::API::Object::Plugin - A plugin item.

=head1 VERSION

version 0.31

=head1 DESCRIPTION

An active or inactive plugin.

=head2 METHODS

See matching methods in L<WebService::Mattermost::V4::API::Resource::Plugin>
for full documentation.

ID parameters are not required:

    my @responses = map { $_->deactivate } @{$mattermost->api->plugins->all->item->active};

Is the same as:

    my @responses = map { $mattermost->api->plugin->deactivate($_) } qw(PLUGIN-IDS-HERE);

=over 4

=item C<remove()>

=item C<activate()>

=item C<deactivate()>

=back

=head2 ATTRIBUTES

=over 4

=item C<backend>

=item C<prepackaged>

=item C<settings_schema>

=item C<version>

=item C<webapp>

=back

=head1 SEE ALSO

=over 4

=item L<WebService::Mattermost::V4::API::Resource::Plugin>

=item L<WebService::Mattermost::V4::API::Resource::Plugins>

=item L<WebService::Mattermost::V4::API::Object::Role::Description>

=item L<WebService::Mattermost::V4::API::Object::Role::Name>

=item L<WebService::Mattermost::V4::API::Object::Role::ID>

=back

=head1 AUTHOR

Mike Jones <mike@netsplit.org.uk>

=head1 COPYRIGHT AND LICENSE

This software is Copyright (c) 2023 by Mike Jones.

This is free software, licensed under:

  The MIT (X11) License

=cut