Yeahdesk
Содержание
Установка
Поддерживаются версии node.js >=12
$ npm install yeahdesk
Использование
Создание экземпляра
import { Yeahdesk } from 'yeahdesk'
const yd = new Yeahdesk()
const persons = await yd.getPersons()
Авторизация
Передача токена при создании экземпляра
const yd = new Yeahdesk(TOKEN)
Передача токена в переменной окружения
Если при создании экземпляра в конструкторе не указан токен, то будет попытка получить токен из переменной окружения YEAHDESK_TOKEN
.
const yd = new Yeahdesk() // Токен из process.env.YEAHDESK_TOKEN
Общие понятия
Клиент (Person) - карточка клиента в сервисе Yeahdesk
Контакт (Contact) - контактные данные входящие в карточку Клиента (email, номер телефона и пр.)
API
Чет пока не охото писать доки :) Может потом прикрутить автогенерашку. А так, всё есть в тестах. Да и комментарии к методам и аргументам старался писать максимально подробно (иначе сам запутался бы).