@oficialapi/sdk 7.0.0 → 8.0.0

package/README.md

@@ -341,32 +341,35 @@ await sdk.whatsapp.sendDocument({
 
 #### Enviar Pedido com Opções de Pagamento
 
+> **⚠️ Nota Importante:** O status do pedido deve ser `pending` ao usar `sendOrderDetails`. Use `sendOrderStatus` para atualizar o status após o pagamento.
+
+**Exemplo 1: Pedido Digital com PIX**
+
 ```typescript
 await sdk.whatsapp.sendOrderDetails({
-  token: 'sk_live_...',
+  token: 'sk_live_9999999999999999999999999',
   sender: '5511999999999',
-  headerText: 'Confirmação de Pedido', // Opcional
+  headerText: 'Confirmação de Pedido',
   bodyText: 'Seu pedido #12345 está pronto para pagamento!',
-  footerText: 'Obrigado por comprar conosco!', // Opcional
-  reference_id: 'pedido_12345_1704067200', // ID único do pedido
-  type: 'digital-goods', // ou 'physical-goods'
+  footerText: 'Obrigado por comprar conosco!',
+  reference_id: 'pedido_12345_1704067200',
+  type: 'digital-goods',
   currency: 'BRL',
   total_amount: {
-    value: 50000, // Valor em centavos (500.00)
-    offset: 100, // Fator de ajuste (sempre 100 para BRL)
-    description: 'Total do pedido' // Opcional
+    value: 50000,
+    offset: 100
   },
   order: {
-    status: 'pending',
+    status: 'pending', // OBRIGATÓRIO: deve ser 'pending' para review_and_pay
     items: [
       {
         retailer_id: '1234567',
-        name: 'Produto 1',
+        name: 'Cake',
         amount: {
           value: 50000,
           offset: 100
         },
-        quantity: 2
+        quantity: 1
       }
     ],
     subtotal: {
@@ -377,39 +380,248 @@ await sdk.whatsapp.sendOrderDetails({
       value: 0,
       offset: 100,
       description: 'Sem impostos'
+    }
+  },
+  payment_settings: [
+    {
+      type: 'pix_dynamic_code',
+      pix_dynamic_code: {
+        code: '00020101021226700014br.gov.bcb.pix2548pix.example.com...',
+        merchant_name: 'Minha Empresa Ltda',
+        key: '39580525000189',
+        key_type: 'CNPJ'
+      }
+    }
+  ]
+}, accessToken);
+```
+
+**Exemplo 2: Pedido Digital com Link de Pagamento**
+
+```typescript
+await sdk.whatsapp.sendOrderDetails({
+  token: 'sk_live_9999999999999999999999999',
+  sender: '5511999999999',
+  bodyText: 'Sua fatura está disponível para pagamento!',
+  reference_id: 'fatura_67890_1704067200',
+  type: 'digital-goods',
+  currency: 'BRL',
+  total_amount: {
+    value: 150000,
+    offset: 100
+  },
+  order: {
+    status: 'pending',
+    items: [
+      {
+        retailer_id: 'item_001',
+        name: 'Serviço Premium',
+        amount: {
+          value: 150000,
+          offset: 100
+        },
+        quantity: 1
+      }
+    ],
+    subtotal: {
+      value: 150000,
+      offset: 100
     },
-    shipping: { // Opcional
-      value: 1000,
-      offset: 100,
-      description: 'Frete'
+    tax: {
+      value: 0,
+      offset: 100
+    }
+  },
+  payment_settings: [
+    {
+      type: 'payment_link',
+      payment_link: {
+        uri: 'https://pagamento.exemplo.com/fatura/67890'
+      }
+    }
+  ]
+}, accessToken);
+```
+
+**Exemplo 3: Pedido Digital com Boleto**
+
+```typescript
+await sdk.whatsapp.sendOrderDetails({
+  token: 'sk_live_9999999999999999999999999',
+  sender: '5511999999999',
+  bodyText: 'Sua inscrição está confirmada! Efetue o pagamento via boleto.',
+  reference_id: 'inscricao_11111_1704067200',
+  type: 'digital-goods',
+  currency: 'BRL',
+  total_amount: {
+    value: 29900,
+    offset: 100
+  },
+  order: {
+    status: 'pending',
+    items: [
+      {
+        retailer_id: 'curso_001',
+        name: 'Curso de Programação',
+        amount: {
+          value: 29900,
+          offset: 100
+        },
+        quantity: 1
+      }
+    ],
+    subtotal: {
+      value: 29900,
+      offset: 100
+    },
+    tax: {
+      value: 0,
+      offset: 100
+    }
+  },
+  payment_settings: [
+    {
+      type: 'boleto',
+      boleto: {
+        digitable_line: '03399026944140000002628346101018898510000008848'
+      }
+    }
+  ]
+}, accessToken);
+```
+
+**Exemplo 4: Pedido Físico com Múltiplas Formas de Pagamento (PIX + Link)**
+
+```typescript
+await sdk.whatsapp.sendOrderDetails({
+  token: 'sk_live_9999999999999999999999999',
+  sender: '5511999999999',
+  bodyText: 'Seu pedido está pronto! Escolha a forma de pagamento:',
+  reference_id: 'pedido_completo_22222_1704067200',
+  type: 'physical-goods',
+  currency: 'BRL',
+  total_amount: {
+    value: 262400, // subtotal (259900) + tax (0) + shipping (2500) - discount (0)
+    offset: 100
+  },
+  order: {
+    status: 'pending',
+    catalog_id: '1234567890',
+    items: [
+      {
+        retailer_id: 'produto_001',
+        name: 'Camiseta Básica',
+        amount: {
+          value: 79000,
+          offset: 100
+        },
+        quantity: 2
+      },
+      {
+        retailer_id: 'produto_002',
+        name: 'Calça Jeans',
+        amount: {
+          value: 101900,
+          offset: 100
+        },
+        quantity: 1
+      }
+    ],
+    subtotal: {
+      value: 259900,
+      offset: 100
     },
-    discount: { // Opcional
-      value: 5000,
+    tax: {
+      value: 0,
+      offset: 100
+    },
+    shipping: {
+      value: 2500,
       offset: 100,
-      description: 'Desconto',
-      discount_program_name: 'Promoção'
+      description: 'Frete via SEDEX'
     }
   },
-  payment_settings: [ // Opcional, máximo 2 métodos
+  payment_settings: [
     {
       type: 'pix_dynamic_code',
       pix_dynamic_code: {
         code: '00020101021226700014br.gov.bcb.pix2548pix.example.com...',
-        merchant_name: 'Minha Empresa Ltda',
-        key: '39580525000189',
-        key_type: 'CNPJ' // CPF, CNPJ, EMAIL, PHONE ou EVP
+        merchant_name: 'Minha Loja Virtual',
+        key: 'minhaloja@email.com',
+        key_type: 'EMAIL'
       }
     },
     {
       type: 'payment_link',
       payment_link: {
-        uri: 'https://pagamento.exemplo.com/pedido/123'
+        uri: 'https://minhaloja.com/pagar/22222'
       }
     }
   ]
 }, accessToken);
 ```
 
+**Exemplo 5: Pedido com Desconto (Black Friday)**
+
+```typescript
+await sdk.whatsapp.sendOrderDetails({
+  token: 'sk_live_9999999999999999999999999',
+  sender: '5511999999999',
+  bodyText: 'Black Friday! Seu pedido com desconto especial:',
+  reference_id: 'black_friday_33333_1704067200',
+  type: 'digital-goods',
+  currency: 'BRL',
+  total_amount: {
+    value: 39900, // subtotal (49900) + tax (0) + shipping (0) - discount (10000)
+    offset: 100
+  },
+  order: {
+    status: 'pending',
+    items: [
+      {
+        retailer_id: 'bf_001',
+        name: 'Pacote Premium',
+        amount: {
+          value: 49900,
+          offset: 100
+        },
+        quantity: 1
+      }
+    ],
+    subtotal: {
+      value: 49900,
+      offset: 100
+    },
+    tax: {
+      value: 0,
+      offset: 100
+    },
+    discount: {
+      value: 10000,
+      offset: 100,
+      description: 'Desconto Black Friday 20%',
+      discount_program_name: 'Black Friday 2024'
+    }
+  },
+  payment_settings: [
+    {
+      type: 'pix_dynamic_code',
+      pix_dynamic_code: {
+        code: '00020101021226700014br.gov.bcb.pix2548pix.example.com...',
+        merchant_name: 'Black Friday Loja',
+        key: '5511999999999',
+        key_type: 'PHONE'
+      }
+    }
+  ]
+}, accessToken);
+```
+
+**Importante:**
+- O `total_amount.value` deve ser igual a: `subtotal + tax + shipping - discount`
+- O status do pedido deve ser `pending` ao usar `sendOrderDetails`
+- Use `sendOrderStatus` para atualizar o status após o pagamento
+
 #### Atualizar Status do Pedido
 
 ```typescript

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oficialapi/sdk",
-  "version": "7.0.0",
+  "version": "8.0.0",
   "description": "SDK oficial da OficialAPI - Integração completa com WhatsApp, Telegram, Facebook, Instagram e WebChat",
   "main": "dist/index.js",
   "module": "dist/index.mjs",