Skip to content

Add missing query parameters to Domain::index() methods #939

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Akrilla wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add missing query parameters to Domain::index() methods #939

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 28 additions & 9 deletions src/Api/Domain.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,20 +45,39 @@ class Domain extends HttpApi

/**
* Returns a list of domains on the account.
* @param int $limit
* @param int $skip
* @param array $requestHeaders
* @param array $params
* @param array $requestHeaders
* @return IndexResponse|array
* @throws ClientExceptionInterface
*/
public function index(int $limit = 100, int $skip = 0, array $requestHeaders = [])
public function index(array $params = [], array $requestHeaders = [])
{
Assert::range($limit, 1, 1000);
$params = array_merge([
'limit' => 100,
'skip' => 0,
], $params);

$params = [
'limit' => $limit,
'skip' => $skip,
];
if (isset($params['limit'])) {
Assert::range($params['limit'], 1, 1000, 'Limit must be between 1 and 1000');
}

if (isset($params['skip'])) {
Assert::greaterThanEq($params['skip'], 0, 'Skip must be non-negative');
}

if (isset($params['state'])) {
Assert::oneOf($params['state'], ['active', 'unverified', 'disabled'],
'State must be one of: active, unverified, disabled');
}

if (isset($params['sort'])) {
Assert::oneOf($params['sort'], ['name', 'name:asc', 'name:desc'],
'Sort must be one of: name, name:asc, name:desc');
}

$params = array_filter($params, function ($value) {
return !is_null($value) && $value !== '';
});

$response = $this->httpGet('/v3/domains', $params, $requestHeaders);

Expand Down
38 changes: 29 additions & 9 deletions src/Api/DomainV4.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,20 +42,40 @@ class DomainV4 extends HttpApi

/**
* Returns a list of domains on the account.
* @param int $limit
* @param int $skip
* @param array $requestHeaders
* @link https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/domains/get-v4-domains#domains/get-v4-domains/request
* @param array $params
* @param array $requestHeaders
* @return IndexResponse|array
* @throws ClientExceptionInterface
*/
public function index(int $limit = 100, int $skip = 0, array $requestHeaders = [])
public function index(array $params = [], array $requestHeaders = [])
{
Assert::range($limit, 1, 1000);
$params = array_merge([
'limit' => 100,
'skip' => 0,
], $params);

$params = [
'limit' => $limit,
'skip' => $skip,
];
if (isset($params['limit'])) {
Assert::range($params['limit'], 1, 1000, 'Limit must be between 1 and 1000');
}

if (isset($params['skip'])) {
Assert::greaterThanEq($params['skip'], 0, 'Skip must be non-negative');
}

if (isset($params['state'])) {
Assert::oneOf($params['state'], ['active', 'unverified', 'disabled'],
'State must be one of: active, unverified, disabled');
}

if (isset($params['sort'])) {
Assert::oneOf($params['sort'], ['name', 'name:asc', 'name:desc'],
'Sort must be one of: name, name:asc, name:desc');
}

$params = array_filter($params, function ($value) {
return !is_null($value) && $value !== '';
});

$response = $this->httpGet('/v4/domains', $params, $requestHeaders);

Expand Down
Loading