R6API/Client

View on GitHub
src/Api/RankApiInterface.php

Summary

Maintainability
A
0 mins
Test Coverage
<?php
declare(strict_types=1);

namespace R6API\Client\Api;

/**
 * API to manage the rank.
 *
 * @author Baptiste Leduc <baptiste.leduc@gmail.com>
 */
interface RankApiInterface
{
    /**
     * @param string $platform  Platform to use for this request
     * @see \R6API\Client\Api\Type\PlatformType
     *
     * @param string $region
     * @see \R6API\Client\Api\Type\RegionType
     *
     * @param int $season
     * @see \R6API\Client\Api\Type\SeasonType
     *
     * @param array $profileIds
     *
     * @return array
     */
    public function get(string $platform, string $region, int $season, array $profileIds): array;
}