File Coverage

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

Criterion	Covered	Total	%
statement	3	23	13.0
branch	0	4	0.0
condition	0	3	0.0
subroutine	1	6	16.6
pod	4	5	80.0
total	8	41	19.5

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

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

use Moo;

extends 'WebService::Mattermost::V4::API::Resource';

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

around [ qw(get delete get_image) ] => sub {
    my $orig = shift;
    my $self = shift;
    my $id   = shift;

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

sub custom {
    my $self = shift;

    return $self->_get({ view => 'Emoji' });
}

sub create {
    my $self       = shift;
    my $name       = shift;
    my $filename   = shift;
    my $creator_id = shift;

    unless ($filename && -f $filename) {
        return $self->error_return("'${filename}' is not a real file");
    }

    return $self->_single_view_post({
        view               => 'Emoji',
        override_data_type => 'form',
        parameters         => {
            image => { file => $filename },
            emoji => {
                name       => $name,
                creator_id => $creator_id,
            },
        },
    });
}

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

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

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

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

sub get_by_name {
    my $self = shift;
    my $name = shift;

    unless ($name) {
        return $self->error_return('The first argument should be an emoji name');
    }

    return $self->_single_view_get({
        view     => 'Emoji',
        endpoint => 'name/%s',
        ids      => [ $name ],
    });
}

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

    return $self->_single_view_get({
        view     => 'Emoji',
        endpoint => '%s/image',
        ids      => [ $id ],
    });
}

sub search {
    my $self = shift;
    my $args = shift;

    return $self->_post({
        view       => 'Emoji',
        endpoint   => 'search',
        parameters => $args,
        required   => [ 'term' ],
    });
}

sub autocomplete {
    my $self = shift;
    my $name = shift;

    return $self->_single_view_get({
        view       => 'Emoji',
        endpoint   => 'autocomplete',
        parameters => { name => $name },
    });
}

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

1;

__END__

=pod

=encoding UTF-8

=head1 NAME

WebService::Mattermost::V4::API::Resource::Emoji - Wrapped API methods for the emoji API endpoints.

=head1 VERSION

version 0.26

=head1 DESCRIPTION

    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->emoji;

=head2 METHODS

=over 4

=item C<custom()>

Get all custom emojis.

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

=item C<get()>

Get an emoji by its ID.

    my $response = $resource->get('EMOJI-ID-HERE');

=item C<delete()>

Delete an emoji by its ID.

    my $response = $resource->delete('EMOJI-ID-HERE');

=item C<get_by_name()>

Get an emoji by its name.

    my $response = $resource->get_by_name('EMOJI-NAME-HERE');

=item C<get_image()>

Get an emoji's image by its ID.

    my $response = $resource->get_image('EMOJI-ID-HERE');

=item C<search()>

Search custom emojis.

    my $response = $resource->search({
        # Required arguments
        term => 'Term here',

        # Optional arguments
        prefix_only => 'Prefix here',
    });

=item C<autocomplete()>

Autocomplete an emoji name.

    my $response = $resource->autocomplete('START-OF-EMOJI-NAME');

=back

=head1 SEE ALSO

=over 4

=item L<Official Emoji documentation|https://api.mattermost.com/#tag/emoji>

=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