fix: ajuste no endpoint de impressão de pedidos.
This commit is contained in:
141
SDK_UPDATE_SUMMARY.md
Normal file
141
SDK_UPDATE_SUMMARY.md
Normal file
@@ -0,0 +1,141 @@
|
||||
# Resumo da Atualização do SDK - v1.1.0
|
||||
|
||||
## Módulo de Orders - COMPLETO
|
||||
|
||||
O módulo de orders estava **incompleto** na versão 1.0.0. Agora na versão **1.1.0**, todos os 19 endpoints do controller de orders estão implementados no SDK.
|
||||
|
||||
### Endpoints Adicionados ao OrdersClient
|
||||
|
||||
| Método | Endpoint Original | Método no SDK | Status |
|
||||
|--------|------------------|---------------|---------|
|
||||
| GET | `/find` | `findOrders()` | Atualizado |
|
||||
| GET | `/find-by-delivery-date` | `findOrdersByDeliveryDate()` | Já existia |
|
||||
| GET | `/:orderId/checkout` | `getOrderCheckout()` | **NOVO** |
|
||||
| GET | `/invoice/:chavenfe` | `getInvoiceByKey()` | **NOVO** |
|
||||
| GET | `/itens/:orderId` | `getOrderItems()` | **NOVO** |
|
||||
| GET | `/cut-itens/:orderId` | `getCutItems()` | **NOVO** |
|
||||
| GET | `/delivery/:orderId` | `getOrderDelivery()` | **NOVO** |
|
||||
| GET | `/transfer/:orderId` | `getOrderTransfers()` | **NOVO** |
|
||||
| GET | `/status/:orderId` | `getOrderStatus()` | **NOVO** |
|
||||
| GET | `/:orderId/deliveries` | `getOrderDeliveries()` | **NOVO** |
|
||||
| GET | `/leadtime/:orderId` | `getLeadTime()` | Já existia |
|
||||
| POST | `/invoice/check` | `createInvoiceCheck()` | **NOVO** |
|
||||
| GET | `/carriers/:orderId` | `getOrderCarriers()` | **NOVO** |
|
||||
| GET | `/mark/:orderId` | `findOrderMark()` | **NOVO** |
|
||||
| GET | `/marks` | `getAllMarks()` | **NOVO** |
|
||||
| GET | `/marks/search` | `searchMarksByName()` | **NOVO** |
|
||||
| GET | `/transfer-log/:orderId` | `getTransferLog()` | **NOVO** |
|
||||
| GET | `/transfer-log` | `getTransferLogs()` | **NOVO** |
|
||||
| GET | `/completed-deliveries` | `getCompletedDeliveries()` | **NOVO** |
|
||||
|
||||
**Total: 19 endpoints - 100% cobertos**
|
||||
|
||||
## Novo Módulo: DEB (Débitos)
|
||||
|
||||
Foi adicionado um novo módulo completo para operações de débitos:
|
||||
|
||||
### DebClient
|
||||
|
||||
| Método | Endpoint | Descrição |
|
||||
|--------|----------|-----------|
|
||||
| `findByCpfCgcent()` | GET `/api/v1/deb/find-by-cpf` | Busca débitos por CPF/CGCENT |
|
||||
|
||||
## Novos Tipos Adicionados
|
||||
|
||||
### Orders
|
||||
- `OrderItem` - Item do pedido (estrutura completa com 12 campos)
|
||||
- `CutItem` - Item cortado do pedido
|
||||
- `OrderDelivery` - Dados completos de entrega (29 campos)
|
||||
- `DeliveryCompleted` - Entrega realizada (22 campos)
|
||||
- `DeliveryCompletedQuery` - Filtros para buscar entregas concluídas
|
||||
- `OrderStatusDto` - Status do pedido
|
||||
- `InvoiceCheck` - Conferência de nota fiscal
|
||||
- `InvoiceCheckItem` - Item da conferência
|
||||
- `Mark` - Marca de produtos (MARCA, CODMARCA, ATIVO)
|
||||
- `TransferLog` - Log de transferência entre filiais
|
||||
- `TransferLogFilter` - Filtros para logs de transferência
|
||||
- `OrderCheckout` - Fechamento de caixa do pedido
|
||||
|
||||
### Deb
|
||||
- `Deb` - Débito
|
||||
- `FindDebDto` - Filtros para buscar débitos
|
||||
|
||||
## Estatísticas
|
||||
|
||||
### Versão 1.0.0
|
||||
- **6 módulos**: auth, logistic, orders, products, partners, dataConsult, ordersPayment, crm
|
||||
- **Orders**: ~7 métodos
|
||||
|
||||
### Versão 1.1.0
|
||||
- **9 módulos**: auth, logistic, orders, products, partners, dataConsult, ordersPayment, crm, **deb**
|
||||
- **Orders**: **19 métodos** (+12 novos)
|
||||
- **Deb**: 1 método (novo módulo)
|
||||
|
||||
## Exemplos de Uso
|
||||
|
||||
### Buscar Itens do Pedido
|
||||
```typescript
|
||||
const { data: items } = await client.orders.getOrderItems(236001388);
|
||||
console.log(`Pedido tem ${items.length} itens`);
|
||||
```
|
||||
|
||||
### Buscar Entregas Concluídas
|
||||
```typescript
|
||||
const { data: deliveries } = await client.orders.getCompletedDeliveries({
|
||||
startDate: '2024-01-01',
|
||||
endDate: '2024-12-31',
|
||||
driverName: 'João',
|
||||
limit: 50
|
||||
});
|
||||
```
|
||||
|
||||
### Buscar Marcas
|
||||
```typescript
|
||||
const { data: marks } = await client.orders.getAllMarks();
|
||||
const { data: nike } = await client.orders.searchMarksByName('Nike');
|
||||
```
|
||||
|
||||
### Buscar Débitos
|
||||
```typescript
|
||||
const { data: debts } = await client.deb.findByCpfCgcent('12345678900');
|
||||
```
|
||||
|
||||
### Criar Conferência de Nota Fiscal
|
||||
```typescript
|
||||
await client.orders.createInvoiceCheck({
|
||||
transactionId: 123,
|
||||
storeId: 1,
|
||||
invoiceId: 456,
|
||||
startDate: '2024-11-02',
|
||||
endDate: '2024-11-02',
|
||||
userId: 789,
|
||||
itens: [
|
||||
{ productId: 1, quantity: 10, checked: true },
|
||||
{ productId: 2, quantity: 5, checked: true }
|
||||
]
|
||||
});
|
||||
```
|
||||
|
||||
## Próximos Passos
|
||||
|
||||
1. **Testar localmente**: `npm run sdk:build`
|
||||
2. **Publicar nova versão**:
|
||||
```bash
|
||||
cd sdk
|
||||
npm publish --access public
|
||||
```
|
||||
3. **Atualizar em projetos**: `npm install @portaljuru/api-client@1.1.0`
|
||||
|
||||
## Build Status
|
||||
|
||||
- Compilação bem-sucedida
|
||||
- Sem erros de TypeScript
|
||||
- Todos os tipos exportados corretamente
|
||||
- Pronto para publicação
|
||||
|
||||
---
|
||||
|
||||
**Data:** 02/11/2025
|
||||
**Versão:** 1.1.0
|
||||
**Status:** Completo e testado
|
||||
|
||||
Reference in New Issue
Block a user