Mozammil\Putio\Endpoints\Transfers

Complexity

Total Complexity

7

Size/Duplication

Total Lines	115
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	list()	0	4	1
A	add()	0	6	1
A	get()	0	4	1
A	retry()	0	6	1
A	cancel()	0	6	1
A	clean()	0	4	1

<?php

namespace Mozammil\Putio\Endpoints;

use Mozammil\Putio\Http\Client;

class Transfers
{
    /**
     * The Http Client.
     *
     * @var \Mozammil\Putio\Http\Client
     */
    protected $client;

    public function __construct(Client $client)
    {
        $this->client = $client;
    }

    /**
     * Lists active transfers.
     * If transfer is completed, it is removed from the list.
     *
     * @throws \GuzzleHttp\Exception\GuzzleException
     *
     * @see https://api.put.io/v2/docs/transfers.html#get--transfers-list
     *
     * @return string
     */
    public function list()
    {
        return $this->client->get('transfers/list');
    }

    /**
     * Adds a new transfer.
     *
     * @param string $url
     * @param int $save_parent_id
     * @param string $callback_url
     *
     * @throws \GuzzleHttp\Exception\GuzzleException
     *
     * @see https://api.put.io/v2/docs/transfers.html#post--transfers-add
     *
     * @return string
     */
    public function add(string $url, int $save_parent_id = 0, string $callback_url = '')
    {
        return $this->client->post('transfers/add', [
            'form_params' => compact('url', 'save_parent_id', 'callback_url'),
        ]);
    }

    /**
     * Returns a transfer’s properties.
     *
     * @param int $id
     *
     * @throws \GuzzleHttp\Exception\GuzzleException
     *
     * @see https://api.put.io/v2/docs/transfers.html#get--transfers--id-
     *
     * @return string
     */
    public function get(int $id)
    {
        return $this->client->get(sprintf('transfers/%d', $id));
    }

    /**
     * Retry previously failed transfer.
     *
     * @param int $id
     *
     * @throws \GuzzleHttp\Exception\GuzzleException
     *
     * @see https://api.put.io/v2/docs/transfers.html#retry
     *
     * @return string
     */
    public function retry(int $id)
    {
        return $this->client->post('transfers/retry', [
            'form_params' => compact('id'),
        ]);
    }

    /**
     * Deletes the given transfers.
     *
     * @param array $transfer_ids
     *
     * @throws \GuzzleHttp\Exception\GuzzleException
     *
     * @see https://api.put.io/v2/docs/transfers.html#cancel
     *
     * @return string
     */
    public function cancel(array $transfer_ids = [])
    {
        return $this->client->post('transfers/cancel', [
            'form_params' => ['transfer_ids' => implode(',', $transfer_ids)],
        ]);
    }

    /**
     * Clean completed transfers from the list.
     *
     * @throws \GuzzleHttp\Exception\GuzzleException
     *
     * @see https://api.put.io/v2/docs/transfers.html#clean
     *
     * @return string
     */
    public function clean()
    {
        return $this->client->post('transfers/clean');
    }
}