Pnz\MattermostClient\Api\PostsApi

Complexity

Total Complexity

13

Size/Duplication

Total Lines	129
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	createPost()	0	5	1
A	unpinPost()	0	9	2
A	getPost()	0	9	2
A	deletePost()	0	9	2
A	patchPost()	0	9	2
A	updatePost()	0	9	2
A	pinPost()	0	9	2

<?php

declare(strict_types=1);

namespace Pnz\MattermostClient\Api;

use Pnz\MattermostClient\Exception\InvalidArgumentException;
use Pnz\MattermostClient\Model\Post\Post;
use Pnz\MattermostClient\Model\Status;
use Psr\Http\Message\ResponseInterface;

final class PostsApi extends HttpApi
{
    /**
     * Create a post. Required parameters: 'channel_id', 'message'.
     *
     * @return Post|ResponseInterface
     */
    public function createPost(array $params)
    {
        $response = $this->httpPost('/posts', $params);

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

    /**
     * Partially update a post by providing only the fields you want to update.
     * Omitted fields will not be updated.
     *
     * @see https://api.mattermost.com/v4/#tag/posts%2Fpaths%2F~1posts~1%7Bpost_id%7D~1patch%2Fput
     *
     * @return Post|ResponseInterface
     */
    public function patchPost(string $postId, array $params)
    {
        if (empty($postId)) {
            throw new InvalidArgumentException('PostId can not be empty');
        }

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

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

    /**
     * Update a post.
     *
     * @see https://api.mattermost.com/v4/#tag/posts%2Fpaths%2F~1posts~1%7Bpost_id%7D%2Fput
     *
     * @param string $postId ID of the post to update
     *
     * @return Post|ResponseInterface
     */
    public function updatePost(string $postId, array $params)
    {
        if (empty($postId)) {
            throw new InvalidArgumentException('PostId can not be empty');
        }

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

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

    /**
     * Get a single post.
     *
     * @param string $postId ID of the post to get
     *
     * @return Post|ResponseInterface
     */
    public function getPost(string $postId)
    {
        if (empty($postId)) {
            throw new InvalidArgumentException('PostId can not be empty');
        }

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

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

    /**
     * Pin a post to a channel it is in based from the provided post id string.
     *
     * @see https://api.mattermost.com/v4/#tag/posts%2Fpaths%2F~1posts~1%7Bpost_id%7D~1pin%2Fpost
     *
     * @param string $postId Post GUID
     *
     * @return Status|ResponseInterface
     */
    public function pinPost($postId)
    {
        if (empty($postId)) {
            throw new InvalidArgumentException('PostId can not be empty');
        }

        $response = $this->httpPost(sprintf('/posts/%s/pin', $postId));

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

    /**
     * Unpin a post to a channel it is in based from the provided post id string.
     *
     * @see https://api.mattermost.com/v4/#tag/posts%2Fpaths%2F~1posts~1%7Bpost_id%7D~1unpin%2Fpost
     *
     * @param string $postId Post GUID
     *
     * @return Status|ResponseInterface
     */
    public function unpinPost($postId)
    {
        if (empty($postId)) {
            throw new InvalidArgumentException('PostId can not be empty');
        }

        $response = $this->httpPost(sprintf('/posts/%s/unpin', $postId));

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

    /**
     * Soft deletes a post, by marking the post as deleted in the database. Soft deleted posts will not be returned in post queries.
     *
     * @see https://api.mattermost.com/v4/#tag/posts%2Fpaths%2F~1posts~1%7Bpost_id%7D%2Fdelete
     *
     * @param string $postId ID of the post to delete
     *
     * @return Status|ResponseInterface
     */
    public function deletePost(string $postId)
    {
        if (empty($postId)) {
            throw new InvalidArgumentException('PostId can not be empty');
        }

        $response = $this->httpDelete(sprintf('/posts/%s', $postId));

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