@oficialapi/sdk 1.0.0 → 2.0.0

package/README.md

@@ -1,17 +1,6 @@
 # OficialAPI SDK
 
-SDK oficial da OficialAPI para integração com WhatsApp, Telegram, Facebook, Instagram e WebChat. Desenvolvido em TypeScript com suporte completo a TypeScript e JavaScript.
-
-## 🚀 Características
-
-- ✅ **100% TypeScript** - Tipos completos e IntelliSense
-- ✅ **Autenticação Automática** - Renovação automática de tokens
-- ✅ **Retry Inteligente** - Retry automático em caso de falhas
-- ✅ **Tratamento de Erros** - Erros formatados e informativos
-- ✅ **Fácil de Usar** - API intuitiva e bem documentada
-- ✅ **Robusto** - Testado e pronto para produção
-- ✅ **Rápido** - Otimizado para performance
-- ✅ **Seguro** - Validação e sanitização de dados
+SDK oficial da OficialAPI para integração.
 
 ## 📦 Instalação
 
@@ -37,6 +26,15 @@ const sdk = new OficialAPISDK({
 });
 ```
 
+## 🔐 Autenticação
+
+Obtenha o token de acesso e passe-o em cada chamada ao SDK:
+
+```typescript
+const tokenResponse = await sdk.auth.getToken('client-id', 'client-secret');
+const accessToken = tokenResponse.access_token;
+```
+
 ## 📚 Exemplos de Uso
 
 ### WhatsApp
@@ -48,7 +46,7 @@ const result = await sdk.whatsapp.sendText({
   token: 'sk_live_9999999999999999999999999999',
   sender: '5511999999999',
   messageText: 'Olá! Como posso ajudar você hoje?'
-});
+}, accessToken);
 
 console.log(result.data.messageId);
 ```
@@ -62,7 +60,7 @@ await sdk.whatsapp.sendMedia({
   fileUrl: 'https://example.com/image.jpg',
   type: 'image',
   caption: 'Veja esta imagem!'
-});
+}, accessToken);
 ```
 
 #### Enviar Template
@@ -81,7 +79,7 @@ await sdk.whatsapp.sendTemplate({
       ]
     }
   ]
-});
+}, accessToken);
 ```
 
 #### Enviar Botões
@@ -107,7 +105,7 @@ await sdk.whatsapp.sendButtons({
       }
     }
   ]
-});
+}, accessToken);
 ```
 
 #### Enviar Lista Interativa
@@ -135,7 +133,7 @@ await sdk.whatsapp.sendList({
       ]
     }
   ]
-});
+}, accessToken);
 ```
 
 #### Enviar Contato
@@ -160,7 +158,7 @@ await sdk.whatsapp.sendContact({
       ]
     }
   ]
-});
+}, accessToken);
 ```
 
 #### Enviar Localização
@@ -173,7 +171,7 @@ await sdk.whatsapp.sendLocation({
   longitude: -46.6333,
   name: 'São Paulo',
   address: 'São Paulo, SP, Brasil'
-});
+}, accessToken);
 ```
 
 #### Enviar Áudio
@@ -183,7 +181,7 @@ await sdk.whatsapp.sendAudio({
   token: 'sk_live_...',
   sender: '5511999999999',
   audioUrl: 'https://example.com/audio.ogg'
-});
+}, accessToken);
 ```
 
 #### Enviar Vídeo
@@ -194,7 +192,7 @@ await sdk.whatsapp.sendVideo({
   sender: '5511999999999',
   videoUrl: 'https://example.com/video.mp4',
   caption: 'Veja este vídeo!'
-});
+}, accessToken);
 ```
 
 #### Enviar Documento
@@ -206,7 +204,7 @@ await sdk.whatsapp.sendDocument({
   documentUrl: 'https://example.com/document.pdf',
   filename: 'documento.pdf',
   caption: 'Aqui está o documento'
-});
+}, accessToken);
 ```
 
 #### Enviar Pedido com Opções de Pagamento
@@ -236,17 +234,17 @@ await sdk.whatsapp.sendOrderDetails({
       name: 'Cartão de Crédito'
     }
   ]
-});
+}, accessToken);
 ```
 
 #### Gerenciar Templates
 
 ```typescript
 // Listar templates
-const templates = await sdk.whatsapp.listTemplates('sk_live_...');
+const templates = await sdk.whatsapp.listTemplates('sk_live_...', accessToken);
 
 // Obter detalhes de um template
-const template = await sdk.whatsapp.getTemplate('sk_live_...', 'template_id');
+const template = await sdk.whatsapp.getTemplate('sk_live_...', 'template_id', accessToken);
 
 // Criar template
 await sdk.whatsapp.createTemplate({
@@ -260,7 +258,7 @@ await sdk.whatsapp.createTemplate({
       text: 'Olá {{1}}! Bem-vindo ao nosso serviço.'
     }
   ]
-});
+}, accessToken);
 
 // Upload de mídia para template
 const file = new File(['...'], 'image.jpg', { type: 'image/jpeg' });
@@ -268,7 +266,7 @@ await sdk.whatsapp.uploadMedia({
   token: 'sk_live_...',
   file: file,
   filename: 'image.jpg'
-});
+}, accessToken);
 ```
 
 ### Telegram
@@ -281,7 +279,7 @@ await sdk.telegram.sendMessage({
   chatId: '123456789',
   text: 'Olá! Como posso ajudar?',
   parseMode: 'HTML'
-});
+}, accessToken);
 ```
 
 #### Enviar Mídia
@@ -293,7 +291,7 @@ await sdk.telegram.sendMedia({
   fileUrl: 'https://example.com/image.jpg',
   type: 'photo',
   caption: 'Veja esta imagem!'
-});
+}, accessToken);
 ```
 
 #### Enviar Botões
@@ -309,7 +307,7 @@ await sdk.telegram.sendButtons({
       { text: 'Opção 2', callback_data: 'option2' }
     ]
   ]
-});
+}, accessToken);
 ```
 
 #### Enviar Localização
@@ -320,7 +318,7 @@ await sdk.telegram.sendLocation({
   chatId: '123456789',
   latitude: -23.5505,
   longitude: -46.6333
-});
+}, accessToken);
 ```
 
 #### Enviar Contato
@@ -332,7 +330,7 @@ await sdk.telegram.sendContact({
   phoneNumber: '+5511999999999',
   firstName: 'João',
   lastName: 'Silva'
-});
+}, accessToken);
 ```
 
 #### Enviar Enquete
@@ -344,7 +342,7 @@ await sdk.telegram.sendPoll({
   question: 'Qual sua cor favorita?',
   options: ['Vermelho', 'Azul', 'Verde'],
   isAnonymous: false
-});
+}, accessToken);
 ```
 
 ### WebChat
@@ -356,7 +354,7 @@ await sdk.webchat.sendText({
   token: 'sk_live_...',
   sender: 'user123',
   messageText: 'Olá!'
-});
+}, accessToken);
 ```
 
 #### Enviar Card
@@ -375,7 +373,7 @@ await sdk.webchat.sendCard({
       value: 'https://example.com/product'
     }
   ]
-});
+}, accessToken);
 ```
 
 #### Enviar Formulário
@@ -400,7 +398,7 @@ await sdk.webchat.sendForm({
     }
   ],
   submitButtonText: 'Enviar'
-});
+}, accessToken);
 ```
 
 ### Facebook
@@ -412,7 +410,7 @@ const posts = await sdk.facebook.listPosts({
   token: 'sk_live_...',
   pageId: 'page_id',
   limit: 10
-});
+}, accessToken);
 ```
 
 #### Criar Post
@@ -423,7 +421,7 @@ await sdk.facebook.createPost({
   pageId: 'page_id',
   message: 'Novo post!',
   link: 'https://example.com'
-});
+}, accessToken);
 ```
 
 #### Enviar Mensagem
@@ -433,7 +431,7 @@ await sdk.facebook.sendText({
   token: 'sk_live_...',
   recipientId: 'user_id',
   message: 'Olá!'
-});
+}, accessToken);
 ```
 
 ### Instagram
@@ -445,7 +443,7 @@ await sdk.instagram.sendText({
   token: 'sk_live_...',
   recipientId: 'user_id',
   message: 'Olá!'
-});
+}, accessToken);
 ```
 
 #### Enviar Mídia
@@ -457,7 +455,7 @@ await sdk.instagram.sendMedia({
   fileUrl: 'https://example.com/image.jpg',
   type: 'image',
   caption: 'Veja esta imagem!'
-});
+}, accessToken);
 ```
 
 #### Enviar Resposta Privada a Comentário
@@ -467,7 +465,7 @@ await sdk.instagram.sendPrivateReply({
   token: 'sk_live_...',
   commentId: 'comment_id',
   message: 'Obrigado pelo comentário!'
-});
+}, accessToken);
 ```
 
 ### Canais
@@ -475,7 +473,7 @@ await sdk.instagram.sendPrivateReply({
 #### Listar Canais
 
 ```typescript
-const channels = await sdk.channels.list();
+const channels = await sdk.channels.list(accessToken);
 console.log(channels);
 ```
 
@@ -487,36 +485,18 @@ console.log(channels);
 const webhook = await sdk.integrations.createWebhook({
   url: 'https://example.com/webhook',
   expiresInDays: 365
-});
-```
-
-## 🔐 Autenticação
-
-O SDK gerencia automaticamente a autenticação. Quando você cria uma instância do SDK, ele automaticamente:
-
-1. Obtém um token de acesso usando suas credenciais
-2. Renova o token quando necessário
-3. Adiciona o token em todas as requisições
-
-Se precisar definir um token manualmente (útil para testes):
-
-```typescript
-sdk.setAccessToken('seu-token-aqui', 86400); // expiresIn em segundos
-```
-
-Para limpar o token:
-
-```typescript
-sdk.clearToken();
+}, accessToken);
 ```
 
 ## 🛠️ Tratamento de Erros
 
-O SDK formata todos os erros de forma consistente:
-
 ```typescript
 try {
-  await sdk.whatsapp.sendText({...});
+  await sdk.whatsapp.sendText({
+    token: 'sk_live_...',
+    sender: '5511999999999',
+    messageText: 'Olá!'
+  }, accessToken);
 } catch (error) {
   console.error('Erro:', error.message);
   console.error('Status:', error.status);
@@ -526,15 +506,12 @@ try {
 
 ## 📝 Tipos TypeScript
 
-Todos os tipos estão disponíveis para importação:
-
 ```typescript
 import type {
   SDKConfig,
   Channel,
   SendWhatsAppTextParams,
-  ApiResponse,
-  // ... outros tipos
+  ApiResponse
 } from '@oficialapi/sdk';
 ```
 
@@ -545,19 +522,12 @@ O SDK possui retry automático configurável:
 - **maxRetries**: Número máximo de tentativas (padrão: 3)
 - **retryDelay**: Delay entre tentativas em ms (padrão: 1000)
 
-O retry é aplicado automaticamente em:
-- Erros de rede
-- Erros 5xx (erros do servidor)
-- Timeouts
+O retry é aplicado automaticamente em erros de rede, erros 5xx e timeouts.
 
 ## 📖 Documentação Completa
 
 Para mais informações, consulte a [documentação completa da API](https://api.oficialapi.com.br/api/docs).
 
-## 🤝 Suporte
-
-Para suporte, entre em contato através do [painel administrativo](https://access.oficialapi.com.br) ou abra uma issue no repositório.
-
 ## 📄 Licença
 
 MIT