README

Введение

Данный клиент разработан для работы с сайтом https://www.etxtru.ru.
Класс клиента генерируется автоматически на основе документации https://www.etxt.ru/api/

Инсталяция

composer require carono/etxtru-api

Использование

// Получение баланса
  
require '../vendor/autoload.php';

$client = new \carono\etxtru\Client();
$client->apiKey = 'token';
$client->password = 'password';

$response = $client->users()->getBalance();
  
// Создание заказа
  
$config = new \carono\etxtru\config\TasksSaveTaskConfig();
$config->public = 0;
$config->title = 'Задача 1';
$config->description = 'Описание';
$config->price = 5;
$config->price_type = 1;
$config->size = 500;
$config->id_folder = 'folder_name';
$config->deadline = '30.10.2018';
$config->id_category = 1938;
$config->file = fopen('/path/file.jpg', 'rb');

$response = $client->tasks()->saveTask($config);

Функция возвращает список тематических категорий заказов/статей

$client->categories();

Доступные методы

listCategories - Возвращает список тематический категорий заказов/статей, отсортированный по названию категории.

$client->categories()->listCategories();

Результат

Функция возвращает список папок текущего пользователя

$client->folders();

Доступные методы

listFolders - Возвращает отсортированный список папок текущего пользователя.

$client->folders()->listFolders($sort);

Входные параметры

Результат

addFolder - Cоздает папку для текущего пользователя.

$client->folders()->addFolder($name, $id_parent);

Входные параметры

Результат

moveToFolder - Фукнция перемещает объекты в папку.

$client->folders()->moveToFolder($id_folder, $type, $ids);

Входные параметры

Результат

Функция возвращает список исполнителей

$client->users();

Доступные методы

getList - Возвращает список исполнителей без сортировки.

$client->users()->getList($config);

Входные параметры

Результат

getBW - Функция возвращает список пользователей, находящихся в черном и белом списке текущего пользователя.

$client->users()->getBW($count, $from, $id_group, $type);

Входные параметры

Результат

getNote - Функция возвращает примечание к указанному пользователю.

$client->users()->getNote($id);

Входные параметры

Результат

getUser - Функция возвращает подробную информацию об указанном пользователе.

$client->users()->getUser($id, $login);

Входные параметры

Результат

getWorks - Функция возвращает виды работ и минимальные цены исполнителя по ним.

$client->users()->getWorks($id);

Входные параметры

Результат

getReports - Функция возвращает отзывы указанного незаблокированного пользователя. Отзывы разделены на два массива - negative (отрицательные отзывы) и positive (положительные) и сгруппированы по авторам.

$client->users()->getReports($id);

Входные параметры

Результат

setReport - Функция добавляет/редактирует отзыв пользователю.

$client->users()->setReport($config);

Входные параметры

Результат

getUserBW - Функция возвращает количество белых и черных списков, в которых находится пользователь.

$client->users()->getUserBW($id);

Входные параметры

Результат

setUserBW - Функция добавляет или удаляет пользователя в черный/белый список.

$client->users()->setUserBW($id, $id_group, $type);

Входные параметры

Результат

getBalance - Функция возвращает состояние лицевого счета текущего пользователя.

$client->users()->getBalance();

Результат

Функция возвращает список заказов текущего пользователя, только для заказчика

$client->tasks();

Доступные методы

listTasks - Возвращает список заказов текущего пользователя, только для заказчика.

$client->tasks()->listTasks($config);

Входные параметры

Результат

viewNotes - Функция возвращает список заявок и комментариев на указанный заказ (или список заказов) текущего пользователя, только для заказчика.

$client->tasks()->viewNotes($id);

Входные параметры

Результат

viewNotesAll - Функция возвращает список всех поданных заявок на все заказы текущего заказчика.

$client->tasks()->viewNotesAll();

Результат

setNote - Функция принятия указанной заявки на заказ, только для заказчика.

$client->tasks()->setNote($id, $comment);

Входные параметры

Результат

unsetNote - Функция отклонения указанной заявки на заказ, только для заказчика.

$client->tasks()->unsetNote($id);

Входные параметры

Результат

paidTask - Функция принятия заказа на проверке, только для заказчика.

$client->tasks()->paidTask($id);

Входные параметры

Результат

cancelTask - Функция отправки заказа на проверке на доработку, только для заказчика.

$client->tasks()->cancelTask($id, $text);

Входные параметры

Результат

getResults - Функция получения результатов по заказам, только для заказчика.

$client->tasks()->getResults($id);

Входные параметры

Результат

deleteTask - Функция удаления заказов в статусе ожидания исполнителя или из черновика, только для заказчика. Запрещено удалять заказы в течение недели после снятия исполнителя с заказа.

$client->tasks()->deleteTask($id);

Входные параметры

Результат

extraPaid - Функция начисления доплаты по заданию.

$client->tasks()->extraPaid($id, $count, $note, $autopay);

Входные параметры

Результат

saveTask - Функция добавления/редактирования заказа, только для заказчика.

$client->tasks()->saveTask($config);

Входные параметры

Результат

failTask - Функция отмены просроченного заказа, только для заказчика. Отмененный заказ невозможно удалить, он будет существовать для истории 2 недели, после чего удалится автоматически.

$client->tasks()->failTask($id, $copy, $deadline, $timeline);

Входные параметры

Результат

copyTask - Функция копирования заказа, только для заказчика. Новый заказ будет публикуемым и доступный исполнителям, настройки автопринятия и мультизаказа не копируются.

$client->tasks()->copyTask($id, $deadline, $timeline);

Входные параметры

Результат

setDeadline - Функция увеличения срока сдачи заказа, только для заказчика. Если заказ просроченный, то он будет возвращен в работу, если в черновике, то возможна его публикации для ожидания подачи заявок.

$client->tasks()->setDeadline($id, $deadline, $timeline, $public);

Входные параметры

Результат

saveComment - Функция добавления комментария в заказ, только для заказчика или назначенного исполнителя.

$client->tasks()->saveComment($id, $text, $hide);

Входные параметры

Результат

sendNoteFail - Функция создает заявку в обратную связь на снятие исполнителя с заказа.

$client->tasks()->sendNoteFail($id, $text);

Входные параметры

Результат

Функция получения списка заказов из архива заказов, только для заказчика

$client->tasksArchive();

Доступные методы

listTasks - Возвращает список архивных заказов текущего пользователя, только для заказчика.

$client->tasksArchive()->listTasks($config);

Входные параметры

Результат

getResults - Функция получения результатов по архивному заказу, только для заказчика.

$client->tasksArchive()->getResults($id);

Входные параметры

Результат

Функция получения списка языков, используемых в системе

$client->options();

Доступные методы

getLangs - Функция получения списка языков, используемых в системе.

$client->options()->getLangs();

Результат

Функция получения списка готовых статей на продажу

$client->articles();

Доступные методы

getList - Возвращает список готовых статей на продажу. Поле "Описание статьи" не выводится во избежание автоматической выемки всех описаний статей.

$client->articles()->getList($config);

Входные параметры

Результат

buy - Функция осуществляет покупку указанной статьи текущим пользователем

$client->articles()->buy($id);

Входные параметры

Результат

getText - Функция выводит тексты запрошенных купленных статей

$client->articles()->getText($id);

Входные параметры

Результат

download - Функция создает zip архив с текстами и изображениями указанных купленных статей для текущего пользователя

$client->articles()->download($id);

Входные параметры

Результат

Возвращает список купленных пользователм статей и перенесенных в архив статей

$client->articlesArchive();

Доступные методы

getList - Возвращает список купленных пользователм статей и перенесенных в архив статей.

$client->articlesArchive()->getList($config);

Входные параметры

Результат

getText - Функция выводит тексты запрошенных статей из архива текущего пользователя

$client->articlesArchive()->getText($id);

Входные параметры

Результат

download - Функция создает zip архив с текстами и изображениями указанных статей из архива для текущего пользователя

$client->articlesArchive()->download($id);

Входные параметры

Результат

Функция возвращает список групп для БС/ЧС текущего пользователя

$client->bwgroups();

Доступные методы

listGroups - Функция возвращает список групп для БС/ЧС текущего пользователя.

$client->bwgroups()->listGroups();

Результат

saveGroup - Функция добавляет или изменяет группу для БС/ЧС текущего пользователя.

$client->bwgroups()->saveGroup($name, $id, $id_parent);

Входные параметры

Результат

deleteGroup - Функция удаляет группу для БС/ЧС и все ее подгруппы текущего пользователя.

$client->bwgroups()->deleteGroup($id);

Входные параметры

Результат

updateGroup - Функция перемещает пользователя, уже занесенного в БС/ЧС, в указанную группу текущего пользователя.

$client->bwgroups()->updateGroup($id_user, $id_group);

Входные параметры

Результат

Функция выводит непрочитанные системные сообщения пользователя

$client->messages();

Доступные методы

getList - Функция выводит непрочитанные системные сообщения пользователя. Максимальный лимит сообщений 100.

$client->messages()->getList($from);

Входные параметры

Результат

setRead - Функция помечает указанные непрочитанные системные сообщения пользователя как прочитанные.

$client->messages()->setRead($ids);

Входные параметры

Результат

setDelete - Функция удаляет указанные непрочитанные системные сообщения пользователя.

$client->messages()->setDelete($ids);

Входные параметры

Результат

readPrivate - Функция выводит сообщения из привата с указанным пользователем.

$client->messages()->readPrivate($config);

Входные параметры

Результат

getCountUnread - Функция возвращает количество непрочитанных сообщений из привата, с группировкой по авторам.

$client->messages()->getCountUnread();

Результат

writePrivate - Функция посылает сообщение в приват указанному пользователем. Данная возможность доступна пользователям с рейтингом более 10000. Таймаут между сообщениями 1 минута.

$client->messages()->writePrivate($id_user, $text);

Входные параметры

Результат

Функция выводит список отказов от заказов для заказчика

$client->rating();

Доступные методы

listTasksFails - Функция выводит список отказов от заказов для заказчика.

$client->rating()->listTasksFails($id_task, $id_user, $back);

Входные параметры

Результат

ratingUserBack - Функция возвращает рейтинг исполнителю по определенному отказу.

$client->rating()->ratingUserBack($id_task, $id_user);

Входные параметры

Результат

Функция показывает степень схожести двух текстов

$client->diff();

Доступные методы

compareText - Функция показывает степень схожести двух текстов

$client->diff()->compareText($source, $text);

Входные параметры

Результат

Функция создает задание на коррекцию текста

$client->correction();

Доступные методы

add - Функция создает задание на коррекцию.

$client->correction()->add($config);

Входные параметры

Результат

import - Функция создает задание на коррецию из заказов и статей.

$client->correction()->import($config);

Входные параметры

Результат