@typedbywill/netpulse

Cliente TypeScript oficial da API Pública do NetPulse.

Documentação

Guia completo de uso (GUIA-DE-USO.md) — instalação, autenticação, todos os métodos, showToCustomer, exemplos e referência de tipos.

Instalação

npm install @typedbywill/netpulse

Requisito: Node.js 18+.

Uso rápido

import { NetPulsePublicClient } from '@typedbywill/netpulse';

const client = new NetPulsePublicClient({
  baseUrl: 'https://seu-netpulse.com',
  apiKey: 'pk_<uuid>.<segredo>',
});

const tickets = await client.tickets.listActive();

const uploaded = await client.files.upload(file);
await client.tickets.addUpdate('648f103b4fd8c146e279a0b1', {
  message: 'Equipe no local',
  showToCustomer: true, // visível no portal do cliente
  attachments: [{
    src: uploaded.url,
    mime: uploaded.mime,
    name: uploaded.originalName,
    size: uploaded.size,
    type: 'image',
  }],
  forecast: '2026-06-25T18:00:00.000Z',
  location: '-23.550520, -46.633308',
});

Visibilidade no portal (showToCustomer)

| Valor | Efeito | |-------|--------| | true | Mensagem e anexos aparecem no portal do cliente | | false / omitido | Atualização fica apenas no painel interno |

Previsão e localização atualizam o ticket e são exibidas no portal independentemente desse flag.

Endpoints cobertos

| Recurso SDK | Rota | |-------------|------| | clients.* | /api/public/clients | | tickets.* | /api/public/tickets | | files.upload | /api/public/files/upload |

Lista completa no guia de uso.

Licença

UNLICENSED — uso sujeito aos termos do projeto NetPulse.