@sipuni/usedesk

    1.0.1 • Public • Published

    Модуль Node.js для работы с API Usedesk

    Build Status

    Описание

    Установка

    npm i @sipuni/usedesk
    

    Реализованные методы

    Методы сгруппированы и доступны через соответствующие свойства у объекта класса SipuniUsedeskApi, например, api.clients.create() или api.tickets.list(). Все методы возвращают Promise.

    Методы, принимающие properties, ожидают объект. В объекте укажите такие же поля как в документации, кроме поля api_token, оно подается автоматически при каждом вызове метода.

    Для списка методов ниже, предположим, что api это объект класса SipuniUsedeskApi

    const SipuniUsedeskApi = require('@sipuni/usedesk');
    const token = 'aed2e810..........f05e2e21a';
    const api = new SipuniUsedeskApi({ token });
    

    Тикеты

    api.tickets.create(ticketProperties)
    api.tickets.get(ticketId)
    api.tickets.update(ticketProperties)
    api.tickets.list(properties)
    api.tickets.createComment(commentProperties)
    api.tickets.tags()
    api.tickets.fields()
    

    Клиенты

    api.clients.create(clientProperties)
    api.clients.get(clientId)
    api.clients.update(clientProperties)
    api.clients.list(properties)
    

    Агенты

    api.users.groups()
    api.users.create(userProperties);
    api.users.get(userId);
    api.users.update(userProperties);
    api.users.list(properties);
    api.users.delete(userId);
    

    Примеры

    Для коробочной версии

    const SipuniUsedeskApi = require('@sipuni/usedesk');
    const token = 'aed2e810..........f05e2e21a';
    const host = 'api.yourdomain.com';
    const api = new SipuniUsedeskApi({ token, host });
    

    Для облачной версии

    const SipuniUsedeskApi = require('@sipuni/usedesk');
    const token = 'aed2e810..........f05e2e21a';
    const api = new SipuniUsedeskApi({ token });
    

    Создание тикета

    const created = await api.tickets.create({
      subject: 'Не работает сеть',
      message: 'Подробности...'
    });
    

    Получение тикета по id

    const ticket = await api.tickets.get(ticket_id);
    

    Создание клиента

    const client = await api.clients.create({ 
      name: 'Иван',
      emails: ['test@gmail.com'],
    });
    

    Получение клиента по id

    const found = await api.clients.get(client_id);
    

    Создание агента

    const groups = await api.users.groups();
    const user = await api.users.create({
        name: 'Николй',
        email: 'abc@cde.com',
        password: '123',
        group: `${groups[0].id}`,
    });
    

    Лицензия

    MIT © Sipuni

    Install

    npm i @sipuni/usedesk

    DownloadsWeekly Downloads

    2

    Version

    1.0.1

    License

    MIT

    Unpacked Size

    9.6 kB

    Total Files

    6

    Last publish

    Collaborators

    • freedaycirnofag
    • hbck