login($login, $password, $serviceName = '')¶
Принимает на вход
- login - Логин от главного аккаунта
- password - Пароль от главного аккаунта
- serviceName - Имя сервиса
Использует метод /login
Возвращает экземпляр класса LPTracker\authentication\AccessToken
logout()¶
На вход не принимает параметров
Использует метод /logout
getProjectList()¶
На вход не принимает параметров
Использует метод /projects
Возвращает массив экземпляров класса LPTracker\models\Project
getProject($id)¶
Принимает на вход
- id - ID проекта (сайта)
Использует метод /project/ID
Возвращает экземпляр класса LPTracker\models\Project
getProjectCustoms($project)¶
Принимает на вход
- project - ID проекта или экземпляр класса LPTracker\models\Project
Использует метод /project/ID/customs
Возвращает массив экземпляров класса LPTracker\models\Custom
getProjectFields($project)¶
Принимает на вход
- project - ID проекта или экземпляр класса LPTracker\models\Project
Использует метод /project/ID/fields
Возвращает массив экземпляров класса LPTracker\models\ContactField
createContact($project, array $details, array $contactData = [], array $fields = [])¶
Принимает на вход
- project - ID проекта или экземпляр класса LPTracker\models\Project
- details - Массив контактных данных
- contactData - Дополнительные данные контакта
- fields - Поля контакта со значениями для конкретного контакта
Использует метод /contact
Возвращает экземпляр класса LPTracker\models\Contact
getContact($contact)¶
Принимает на вход
- contact - ID контакта или экземпляр класса LPTracker\models\Contact
Использует метод /contact/ID
Возвращает экземпляр класса LPTracker\models\Contact
saveContact(Contact $contact)¶
Принимает на вход
- contact - экземпляр класса LPTracker\models\Contact
Использует метод /contact/ID
Возвращает экземпляр класса LPTracker\models\Contact
editContact($contactId, array $details, array $contactData = [], array $fields = [])¶
Принимает на вход
- contactId - ID контакта
- details - Массив контактных данных
- contactData - Дополнительные данные контакта
- fields - Поля контакта со значениями для конкретного контакта
Использует метод /contact/ID
Возвращает экземпляр класса LPTracker\models\Contact
searchContacts($project, array $searchOptions = [])¶
Поиск по контактам¶
Принимает на вход
- project - ID проекта или объект класса LPTracker\models\Project
- searchOptions - Массив данных для поиска.
Если searchOptions будет пустым - будут получены все контакты проекта.
Доступные параметры для поиска: * email - Почта контакта. Одна запись или массив записей * phone - Телефон контакта. Одна или массив записей
Возвращает массив экземпляров класса LPTracker\models\Contact
contactLeads($contact)¶
Получение лидов привязанных к контактам¶
Принимаает на вход
- contact - ID контакта или экземпляр класса LPTracker\models\Contact
Возвращает массив экземпляров класса LPTracker\models\Lead
updateContactField($contact, $field, $newValue)¶
Принимает на вход
- contact - ID контакта или экземпляр класса LPTracker\models\Contact
- field - ID поля контакта или экземпляр класса LPTracker\models\ContactField
- newValue - Новое значение поля
Использует метод /contact/ID/field/FIELD_ID
Возвращает экземпляр класса LPTracker\models\Contact
createLead($contact, array $leadData = [], array $options = [])¶
Принимает на вход
- contact - ID контакта или экземпляр класса LPTracker\models\Contact
- leadData - Данные лида
- options - Параметры создания лида
Использует метод /lead
Возвращает экземпляр класса LPTracker\models\Lead
getLead($lead)¶
Принимает на вход
- lead - ID лида или экземпляр класса LPTracker\models\Lead
Использует метод /lead/ID
Возвращает экземпляр класса LPTracker\models\Lead
saveLead(Lead $lead)¶
Принимает на вход
- lead - экземпляр класса LPTracker\models\Lead
Использует метод /lead/ID
Возвращает экземпляр класса LPTracker\models\Lead
editLead($leadId, array $leadData = [])¶
Принимает на вход
- leadId - ID лида
- leadData - Данные лида
Использует метод /lead/ID
Возвращает экземпляр класса LPTracker\models\Lead
addLeadPayment($lead, $category, $purpose, $sum)¶
Принимает на вход
- lead - ID лида или экземпляр класса LPTracker\models\Lead
- category - Название категории платежа
- purpose - Название назначения платежа
- sum - Сумма платежа
Использует метод /lead/ID/payment
Возвращает экземпляр класса LPTracker\models\Lead
changeLeadFunnel($lead, $newFunnelId)¶
Принимает на вход
- lead - ID лида или экземпляр класса LPTracker\models\Lead
- newFunnelId - ID шага воронки, который необходимо выставить у лида
Использует метод /lead/ID
Возвращает экземпляр класса LPTracker\models\Lead
getLeadComments($lead)¶
Принимает на вход
- lead - ID лида или экземпляр класса LPTracker\models\Lead
Использует метод /lead/ID/comments
Возвращает массив экземпляров класса LPTracker\models\Comment
addCommentToLead($lead, $text)¶
Принимает на вход
- lead - ID лида или экземпляр класса LPTracker\models\Lead
- text - Текст комментария
Возвращает экземпляр класса LPTracker\models\Comment
saveLeadCustom(Custom $custom)¶
Принимает на вход
- custom - экземпляр класса LPTracker\models\Custom
Использует метод /lead/LEAD_ID/custom/CUSTOM_ID
Возвращает экземпляр класса LPTracker\models\Custom
editLeadCustom($lead, $custom, $newValue)¶
Принимает на вход
- lead - ID лида или экземпляр класса LPTracker\models\Lead
- custom - ID поля из конструктора полей или экземпляр класса LPTracker\models\Custom
- newValue - Новое значение поля
Использует метод /lead/LEAD_ID/custom/CUSTOM_ID
Возвращает экземпляр класса LPTracker\models\Custom
addFileToLead($lead, $custom, $absolutePath)¶
Принимает на вход
- lead - ID лида или экземпляр класса LPTracker\models\Lead
- custom - ID поля из конструктора полей или экземпляр класса LPTracker\models\Custom
- absolutePath - Путь до загружаемого файла
Использует метод /lead/LEAD_ID/file
getCustomFile($lead, $custom, $file)¶
Принимает на вход
- lead - ID лида или экземпляр класса LPTracker\models\Lead
- custom - ID поля из конструктора полей или экземпляр класса LPTracker\models\Custom
- file - ID файла из кастомного поля (custom['value'] = FILE_ID,FILE_ID)
Использует метод /lead/LEAD_ID/custom/CUSTOM_ID/file/FILE_ID
Возвращает экземпляр класса LPTracker\models\LeadFile
getLeadsList($project, $offset = null, $limit = null, $sort = [], $isDeal = false, $filter = [])¶
Принимает на вход
- project - ID проекта или экземпляр класса LPTracker\models\Project
- offset - Количество записей, которое необходимо пропустить (необязательное поле)
- limit - Количество записей, которое необходимо вернуть (необязательное поле)
- sort - Поле и направление сортировки (необязательное поле)
- isDeal - Возвращать только сделки (true) или только лиды (false)
- filter - Фильтр поиска (необязательное поле)
Поле sort принимает ассоциативный массив с возможными ключами:
- created_at - Сортировка по дате создания
- updated_at - Сортировка по дате изменения
В качестве значений принимаются константы:
- SORT_ASC - Сортировка по возрастанию
- SORT_DESC - Сортировка по убыванию
Поле filter принимает ассоциативный массив с возможными ключами:
- created_at_from - Время создания лида от (timestamp)
- created_at_to - Время создания лида до (timestamp)
- updated_at_from - Время обновления лида от (timestamp)
- updated_at_to - Время обновления лида до (timestamp)
Использует метод /lead/PROJECT_ID/list
Возвращает список лидов
createCustom($project, $options)¶
Принимает на вход
- project - ID проекта или экземпляр класса LPTracker\models\Project
- options - Данные для создания поля (см. раздел Описание полей)
Использует метод /custom/PROJECT_ID/create
Возвращает экземпляр класса LPTracker\models\CustomField