File Coverage

blib/lib/WebService/Mattermost/V4/API/Resource/Team/Channels.pm

Criterion	Covered	Total	%
statement	3	11	27.2
branch	0	4	0.0
condition			n/a
subroutine	1	2	50.0
pod	0	1	0.0
total	4	18	22.2

package WebService::Mattermost::V4::API::Resource::Team::Channels;

# ABSTRACT: Wrapped API methods for the team channels API endpoints.

use Moo;

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

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

around [ qw(by_ids public deleted autocomplete search by_name) ] => sub {
    my $orig = shift;
    my $self = shift;
    my $id   = shift;

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

sub by_ids {
    my $self        = shift;
    my $team_id     = shift;
    my $channel_ids = shift;

    unless (scalar @{$channel_ids}) {
        return $self->error_return('The second argument should be an arrayref of channel_ids');
    }

    return $self->_post({
        parameters => $channel_ids,
        endpoint   => '%s/channels/ids',
        ids        => [ $team_id ],
        view       => 'Channel',
    });
}

sub public {
    my $self    = shift;
    my $team_id = shift;
    my $args    = shift;

    return $self->_get({
        endpoint   => '%s/channels',
        ids        => [ $team_id ],
        parameters => $args,
        view       => 'Channel',
    });
}

sub deleted {
    my $self    = shift;
    my $team_id = shift;
    my $args    = shift;

    return $self->_get({
        endpoint   => '%s/channels/deleted',
        ids        => [ $team_id ],
        parameters => $args,
        view       => 'Channel',
    });
}

sub autocomplete {
    my $self    = shift;
    my $team_id = shift;
    my $args    = shift;

    return $self->_get({
        endpoint   => '%s/channels/autocomplete',
        ids        => [ $team_id ],
        parameters => $args,
        required   => [ 'name' ],
        view       => 'Channel',
    });
}

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

    return $self->_post({
        endpoint   => '%s/channels/search',
        ids        => [ $team_id ],
        parameters => $args,
        required   => [ 'term' ],
        view       => 'Channel',
    });
}

sub by_name {
    my $self    = shift;
    my $team_id = shift;
    my $name    = shift;

    unless ($name) {
        return $self->error_return('The second argument should be a channel name');
    }

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

sub by_name_and_team_name {
    my $self         = shift;
    my $team_name    = shift;
    my $channel_name = shift;

    unless ($team_name) {
        return $self->error_return('The first argument should be a team name');
    }

    unless ($channel_name) {
        return $self->error_return('The second argument should be a channel name');
    }

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

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

1;

__END__

=pod

=encoding UTF-8

=head1 NAME

WebService::Mattermost::V4::API::Resource::Team::Channels - Wrapped API methods for the team channels 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->team->channels;

=head2 METHODS

=over 4

=item C<by_ids()>

L<Get a list of channels by IDs|https://api.mattermost.com/#tag/channels%2Fpaths%2F~1teams~1%7Bteam_id%7D~1channels~1ids%2Fpost>

    my $response = $resource->get_by_ids('team-id-here', [ qw(
        first_channel_id
        second_channel_id
        third_channel_id
    ) ]);

=item C<public()>

L<Get public channels|https://api.mattermost.com/#tag/channels%2Fpaths%2F~1teams~1%7Bteam_id%7D~1channels%2Fget>

    my $response = $resource->public('team-id-here', {
        # Optional arguments
        page     => 1,
        per_page => 60,
    });

=item C<deleted()>

L<Get deleted channels|https://api.mattermost.com/#tag/channels%2Fpaths%2F~1teams~1%7Bteam_id%7D~1channels~1deleted%2Fget>

    my $response = $resource->deleted('team-id-here', {
        # Optional arguments
        page     => 1,
        per_page => 60,
    });

=item C<autocomplete()>

L<Autocomplete channels|https://api.mattermost.com/#tag/channels%2Fpaths%2F~1teams~1%7Bteam_id%7D~1channels~1autocomplete%2Fget>

    my $response = $resource->autocomplete('team-id-here', {
        # Required arguments
        name => 'Something',
    });

=item C<search()>

L<Search channels|https://api.mattermost.com/#tag/channels%2Fpaths%2F~1teams~1%7Bteam_id%7D~1channels~1search%2Fpost>

    my $response = $resource->search('team-id-here', {
        # Required arguments
        term => 'Something',
    });

=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