SDK TinyERP (Unofficial)

SDK não oficial para a API v2 do TinyERP (Olist), desenvolvido em TypeScript com suporte completo a tipos.

📚 Ver Documentação Completa

---

🚀 Características

• TypeScript Nativo - Totalmente tipado com mais de 1.500 linhas de definições
• Zero Dependências - Usa apenas APIs nativas do Node.js
• ES Modules - Suporte completo a ESM para projetos modernos
• Testado - Cobertura completa de testes com Vitest
• Bem Documentado - JSDoc detalhado em todos os métodos e tipos
• Tratamento de Erros - Classe customizada que preserva detalhes da API

📦 Instalação

npm install sdk-tinyerp

Requisitos: Node.js >= 18

⚡ Início Rápido

import TinySDK from 'sdk-tinyerp';

// Inicializar SDK
const sdk = new TinySDK(process.env.TINY_API_TOKEN);

// Obter informações da conta
const account = await sdk.account.getInfo();
console.log('Empresa:', account.razao_social);

// Pesquisar produtos
const products = await sdk.product.search('notebook', {
  situacao: 'A',  // Apenas ativos
  pagina: 1
});

console.log(`Encontrados ${products.produtos.length} produtos`);

// Criar contato
const result = await sdk.contact.create([
  {
    sequencia: 1,
    contato: {
      nome: 'João Silva',
      tipo_pessoa: 'F',
      cpf_cnpj: '12345678901',
      email: 'joao@example.com'
    }
  }
]);

if (result[0].status === 'OK') {
  console.log('Contato criado com ID:', result[0].id);
}

📖 Ver mais exemplos na documentação

📚 Recursos Disponíveis

Resource	Métodos	Documentação
Account	getInfo()	Ver docs
Contacts	search(), getById(), create(), update()	Ver docs
Products	search(), getById(), create()	Ver docs

🔗 Documentação

• Getting Started - Instalação, autenticação e primeiros passos
• Resources - Documentação completa de cada resource
• Guias - Tratamento de erros, paginação, operações em lote
• API Reference - Documentação gerada automaticamente

🛠️ Desenvolvimento

Instalar dependências

npm install

Scripts disponíveis

npm run build          # Compilar TypeScript
npm run dev            # Modo de desenvolvimento (watch)
npm test               # Executar testes
npm run test:watch     # Testes em modo watch
npm run docs:dev       # Servidor de documentação local
npm run docs:build     # Build da documentação

Executar testes

npm test

Os testes cobrem:

• ✅ Sucesso e falha nas requisições
• ✅ Tratamento de erros da API
• ✅ Transformação de dados (wrapping/unwrapping)
• ✅ Validação de payloads

🗺️ Roadmap

• Account (Conta)
• Contacts (Contatos)
• Products (Produtos)
• Orders (Pedidos)
• Invoices (Notas Fiscais)
• Stock (Estoque)
• Financial (Financeiro)
• Webhooks

🤝 Contribuindo

Contribuições são bem-vindas! Por favor:

1. Faça um fork do projeto
2. Crie uma branch para sua feature (git checkout -b feature/MinhaFeature)
3. Commit suas mudanças seguindo Conventional Commits
4. Abra um Pull Request

Diretrizes:

• Mantenha a cobertura de testes
• Adicione JSDoc para novos métodos
• Siga o estilo de código existente
• Atualize a documentação quando necessário

📄 Licença

Este projeto é um SDK não oficial e não possui afiliação com o TinyERP ou Olist.

Lançado sob a licença ISC.

🔗 Links

• Documentação
• npm
• GitHub
• Issues
• Changelog
• API TinyERP

---

Feito com ❤️ para a comunidade de desenvolvedores

Reportar Bug · Sugerir Feature · Ver Documentação