СправочникRequests
ApiKeyRequest v1.0.0
ApiKeyRequest
Описание: ApiKeyRequest
Namespace: Devcraft\Webshare\Requests
Extends: AbstractRequest
С версии: 1.0.0
См. также:
Endpoint: apikey
Query fields:
- optional:
ordering,label
Методы
__construct(): void
Возвращает: void
list(): ApiKeyList
Возвращает: ApiKeyList
iterate(): Generator
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
$maxPages | ?int | Лимит страниц iterate; по умолчанию App::iterateMaxPages(). По умолчанию: NULL. |
Возвращает: Generator
retrieve(): ApiKey
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
$id | int | Идентификатор ресурса. |
Возвращает: ApiKey
create(): ApiKey
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
$label | string | Метка. |
Возвращает: ApiKey
update(): ApiKey
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
$id | int | Идентификатор ресурса. |
$label | string | Метка. |
Возвращает: ApiKey
delete(): void
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
$id | int | Идентификатор ресурса. |
Возвращает: void