Pnz\MattermostClient\Api\TeamsApi

Complexity

Total Complexity

28

Size/Duplication

Total Lines	260
Duplicated Lines	13.85 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

100%

Importance

Changes

0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	createTeam()	0	8	1
A	getTeams()	0	6	1
A	deleteTeam()	0	12	3
A	getTeamByName()	0	10	2
A	addTeamMember()	16	16	3
A	getTeamMembers()	0	10	2
A	getTeamById()	10	10	2
A	getTeamMember()	10	10	3
A	removeTeamMember()	0	10	3
A	getTeamPublicChannels()	0	10	2
A	getTeamStats()	0	10	2
A	patchTeam()	0	10	2
A	updateTeam()	0	10	2

<?php

declare(strict_types=1);

namespace Pnz\MattermostClient\Api;

use Pnz\MattermostClient\Exception\InvalidArgumentException;
use Pnz\MattermostClient\Model\Channel\Channels;
use Pnz\MattermostClient\Model\Status;
use Pnz\MattermostClient\Model\Team\Team;
use Pnz\MattermostClient\Model\Team\TeamMember;
use Pnz\MattermostClient\Model\Team\TeamMembers;
use Pnz\MattermostClient\Model\Team\Teams;
use Pnz\MattermostClient\Model\Team\TeamStats;
use Psr\Http\Message\ResponseInterface;

final class TeamsApi extends HttpApi
{
    /**
     * Returns an team by its ID.
     *
     * @param string $id
     *
     * @return Team|ResponseInterface
     */
    public function getTeamById($id)

This method seems to be duplicated in your project.

    {
        if (empty($id)) {
            throw new InvalidArgumentException('Id can not be empty');
        }

        $response = $this->httpGet(sprintf('/teams/%s', $id));

        return $this->handleResponse($response, Team::class);
    }

    /**
     * Create a team. Required parameters: 'name', 'display_name' and 'type'.
     *
     * @param array $params
     *
     * @return Team|ResponseInterface
     */
    public function createTeam(array $params)
    {
        $response = $this->httpPost('/teams',
            $params
        );

        return $this->handleResponse($response, Team::class);
    }

    /**
     * Returns a collection of teams.
     *
     * @param array $params The listing params, 'page', 'per_page'
     *
     * @return Teams|ResponseInterface
     */
    public function getTeams(array $params = [])
    {
        $response = $this->httpGet('/teams', $params);

        return $this->handleResponse($response, Teams::class);
    }

    /**
     * Delete a team softly and put in archived only.
     *
     * @see https://api.mattermost.com/v4/#tag/teams%2Fpaths%2F~1teams~1%7Bteam_id%7D%2Fdelete
     *
     * @param string $teamId    Team GUID
     * @param bool   $permanent permanently delete the team, to be used for complience reasons only
     *
     * @return Status|ResponseInterface
     */
    public function deleteTeam(string $teamId, bool $permanent = false)
    {
        if (empty($teamId)) {
            throw new InvalidArgumentException('User ID can not be empty');
        }

        $pathParams = $permanent ? ['permanent' => true] : [];

        $response = $this->httpDelete(sprintf('/teams/%s', $teamId), [], $pathParams);

        return $this->handleResponse($response, Status::class);
    }

    /**
     * Returns a team given its name.
     *
     * @param string $name
     *
     * @return Team|ResponseInterface
     */
    public function getTeamByName($name)
    {
        if (empty($name)) {
            throw new InvalidArgumentException('TeamName can not be empty');
        }

        $response = $this->httpGet(sprintf('/teams/name/%s', $name));

        return $this->handleResponse($response, Team::class);
    }

    /**
     * Add a user to a team, with specific roles.
     *
     * @param string $teamId
     * @param string $userId
     * @param string $roles
     * @param array  $pathParams
     *
     * @see https://api.mattermost.com/v4/#tag/teams%2Fpaths%2F~1teams~1%7Bteam_id%7D~1members%2Fpost
     *
     * @return TeamMember|ResponseInterface
     */
    public function addTeamMember($teamId, $userId, $roles = '', $pathParams = [])

This method seems to be duplicated in your project.

    {
        if (empty($teamId) || empty($userId)) {
            throw new InvalidArgumentException('Team ID or user ID can not be empty');
        }

        $body = [
            'team_id' => $teamId,
            'user_id' => $userId,
            'roles' => $roles,
        ];

        $response = $this->httpPost(sprintf('/teams/%s/members', $teamId), $body, $pathParams);

        return $this->handleResponse($response, TeamMember::class);
    }

    /**
     * Return the team members.
     *
     * @param string $teamId The Team ID
     * @param array  $params The listing params, 'page', 'per_page'
     *
     * @see https://api.mattermost.com/v4/#tag/teams%2Fpaths%2F~1teams~1%7Bteam_id%7D~1members%2Fget
     *
     * @return TeamMembers
     */
    public function getTeamMembers(string $teamId, array $params = [])
    {
        if (empty($teamId)) {
            throw new InvalidArgumentException('TeamID can not be empty');
        }

        $response = $this->httpGet(sprintf('/teams/%s/members', $teamId), $params);

        return $this->handleResponse($response, TeamMembers::class);
    }

    /**
     * Get a team member from the system given a Team and User IDs.
     *
     * @param string $teamId The Team GUID
     * @param string $userId The User GUID
     *
     * @return TeamMember
     */
    public function getTeamMember(string $teamId, string $userId)

This method seems to be duplicated in your project.

    {
        if (empty($teamId) || empty($userId)) {
            throw new InvalidArgumentException('TeamID and UserId can not be empty');
        }

        $response = $this->httpGet(sprintf('/teams/%s/members/%s', $teamId, $userId));

        return $this->handleResponse($response, TeamMember::class);
    }

    /**
     * Remove a team member.
     *
     * @param string $teamId The team ID
     * @param string $userId The user ID
     *
     * https://api.mattermost.com/v4/#tag/teams%2Fpaths%2F~1teams~1%7Bteam_id%7D~1members~1%7Buser_id%7D%2Fdelete
     *
     * @return Status|ResponseInterface
     */
    public function removeTeamMember(string $teamId, string $userId)
    {
        if (empty($teamId) || empty($userId)) {
            throw new InvalidArgumentException('TeamID and UserId can not be empty');
        }

        $response = $this->httpDelete(sprintf('/teams/%s/members/%s', $teamId, $userId));

        return $this->handleResponse($response, Status::class);
    }

    /**
     * Return the list of public channels in the given team.
     *
     * @param string $teamId The team ID
     * @param array  $params The listing params, 'page', 'per_page'
     *
     * @return Channels|ResponseInterface
     */
    public function getTeamPublicChannels(string $teamId, array $params = [])
    {
        if (empty($teamId)) {
            throw new InvalidArgumentException('TeamID can not be empty');
        }

        $response = $this->httpGet(sprintf('/teams/%s/channels', $teamId), $params);

        return $this->handleResponse($response, Channels::class);
    }

    /**
     * Retrieve the team statistics.
     *
     * @param string $teamId The Team ID
     *
     * @return TeamStats|ResponseInterface
     */
    public function getTeamStats($teamId)
    {
        if (empty($teamId)) {
            throw new InvalidArgumentException('TeamID can not be empty');
        }

        $response = $this->httpGet(sprintf('/teams/%s/stats', $teamId));

        return $this->handleResponse($response, TeamStats::class);
    }

    /**
     * Patch a team.
     *
     * @see https://api.mattermost.com/v4/#tag/teams%2Fpaths%2F~1teams~1%7Bteam_id%7D~1patch%2Fput
     *
     * @param string $teamId
     * @param array  $params
     *
     * @return Team|ResponseInterface
     */
    public function patchTeam(string $teamId, array $params)
    {
        if (empty($teamId)) {
            throw new InvalidArgumentException('TeamId can not be empty');
        }

        $response = $this->httpPut(sprintf('/teams/%s/patch', $teamId), $params);

        return $this->handleResponse($response, Team::class);
    }

    /**
     * Update a team.
     *
     * @see https://api.mattermost.com/v4/#tag/teams%2Fpaths%2F~1teams~1%7Bteam_id%7D%2Fput
     *
     * @param string $teamId
     * @param array  $params, required paramaters: display_name, description, company_name, allowed_domains, invite_id, allow_open_invite

There is no parameter named $params,. Did you maybe mean $params?

     *
     * @return Team|ResponseInterface
     */
    public function updateTeam(string $teamId, array $params)
    {
        if (empty($teamId)) {
            throw new InvalidArgumentException('TeamId can not be empty');
        }

        $response = $this->httpPut(sprintf('/teams/%s', $teamId), $params);

        return $this->handleResponse($response, Team::class);
    }
}