@botozap/sdk 0.18.0 → 0.20.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +56 -0
- package/README.md +122 -11
- package/dist/index.cjs +222 -11
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +556 -31
- package/dist/index.d.ts +556 -31
- package/dist/index.js +217 -11
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,61 @@
|
|
|
1
1
|
# @botozap/sdk
|
|
2
2
|
|
|
3
|
+
## 0.20.0
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- 532fd08: Paridade com a API de 16 a 20/10/2026. Consentimento: pedido de consentimento
|
|
8
|
+
(`conversations.requestConsent`, `botozap conversations request-consent`, tool
|
|
9
|
+
`request_consent`), que vale para WhatsApp e Instagram e devolve `channel`, com as
|
|
10
|
+
recusas `outside_window` (WhatsApp) e `window_closed` (Instagram); consentimentos do
|
|
11
|
+
contato (`contacts.listConsents` e `recordConsent`, `botozap contacts consents` e
|
|
12
|
+
`record-consent`, tools `list_contact_consents` e `record_contact_consent`) com as
|
|
13
|
+
origens `contact_keyword`, `template_button` e `meta_opt_out`; `warnings` no retorno
|
|
14
|
+
de `contacts.create`; `consent_basis` em `messages.sendTemplate`. Palavras de saída e
|
|
15
|
+
de volta e textos de confirmação do Cliente (`opt_out_keywords`, `opt_in_keywords`,
|
|
16
|
+
`opt_out_confirmation`, `opt_in_confirmation`) em `customers.update` e no objeto, e
|
|
17
|
+
`opt_out_buttons` em `templates.create`, `templates.update` (novo,
|
|
18
|
+
`PATCH /v1/templates/{id}`) e no objeto (MCP: tool `update_template`; o
|
|
19
|
+
`create_template` do MCP não muda para manter o perfil `assistant` idêntico). Erros
|
|
20
|
+
novos em `BotoZapErrorCode`: `consent_opted_out` (409), `consent_revoked` (422),
|
|
21
|
+
`not_connected` (409), `ip_not_allowed` (403), `admin_required` e `gone` (410), com
|
|
22
|
+
`isConsentOptedOut`, `isConsentRevoked` e `isNotConnected`. Conversas:
|
|
23
|
+
`conversations.delete` (`botozap conversations delete`, com confirmação ou `--yes`;
|
|
24
|
+
tool MCP `delete_conversation`, marcada como destrutiva). Exportação de dados:
|
|
25
|
+
`exports.create`/`list`/`get` (`exports:read` e `exports:write`; CLI `exports`; tools
|
|
26
|
+
`create_export`, `list_exports` e `get_export`). Registro de atividades:
|
|
27
|
+
`teamEvents.list` com filtros (CLI `team-events list`; tool `list_team_events`).
|
|
28
|
+
Plano: `guarantee` (garantia de 7 dias) em `billing.get`, no CLI e em `get_billing`.
|
|
29
|
+
IA: o catálogo tem só `openai` e `anthropic`; as entradas do SDK
|
|
30
|
+
(`AiEnabledProvider`; `AiAgentConfig`, `AiBindingTarget` e `AiRouterConfig` agora são
|
|
31
|
+
tipos de entrada) e as tools `ai_*` do MCP aceitam só esses dois (outro provedor
|
|
32
|
+
responde 422 `provider_not_enabled`); a leitura mantém os seis históricos
|
|
33
|
+
(`AiProvider`, `AiAgentConfigRead`, `AiBindingTargetRead`).
|
|
34
|
+
Descrições: `delete_contact` diz que a recusa fica guardada como código cifrado e
|
|
35
|
+
que a mídia é apagada; `send_message` (só no catálogo completo) explica
|
|
36
|
+
`consent_revoked` e `not_connected`; sai o rótulo `data_use_ack_required` do
|
|
37
|
+
`agent-inbox`. Tudo novo do MCP fica só no catálogo completo (chave de API).
|
|
38
|
+
|
|
39
|
+
## 0.19.0
|
|
40
|
+
|
|
41
|
+
### Minor Changes
|
|
42
|
+
|
|
43
|
+
- 8d6d00f: Limites do Free: 1 Cliente e 1 número. Quem passa do teto (por exemplo, depois do
|
|
44
|
+
teste grátis) fica suspenso, sem exclusão: continua recebendo, mas não envia, e
|
|
45
|
+
volta sozinho ao assinar. SDK: `plan_suspended?: boolean` em `Customer` e
|
|
46
|
+
`PhoneNumber`; `isFreeCap` (402 `free_cap`: 2º Cliente no Free ou envio por
|
|
47
|
+
Cliente suspenso) e `isFreeNumberCap` (402 `free_number_cap`: envio por Número
|
|
48
|
+
suspenso ou setup além do teto); `free_cap` entra em `PLAN_ERROR_CODES`, então
|
|
49
|
+
`isPlanError` passa a reconhecê-lo. Docs de `customers.create`, Regras de
|
|
50
|
+
mensagem e Perguntas e menu citam o 403 `plan_restricted` do Free. CLI: coluna
|
|
51
|
+
SUSPENSO em `customers list` e `numbers list`. MCP, só no catálogo completo:
|
|
52
|
+
`plan_suspended` na saída de `list_customers`, `get_customer`, `create_customer`,
|
|
53
|
+
`update_customer`, `list_phone_numbers`, `get_phone_number` e
|
|
54
|
+
`update_phone_number`, e descrições com as recusas do Free (`free_cap`,
|
|
55
|
+
`free_number_cap`, `plan_restricted`) em leituras, envios, `create_customer`,
|
|
56
|
+
Regras de mensagem e Perguntas e menu. O perfil `assistant` (OAuth) não muda:
|
|
57
|
+
mesmas tools, anotações, descrições e saída.
|
|
58
|
+
|
|
3
59
|
## 0.18.0
|
|
4
60
|
|
|
5
61
|
### Minor Changes
|
package/README.md
CHANGED
|
@@ -254,6 +254,9 @@ http/https: 2000. Os quatro métodos retornam o snapshot com
|
|
|
254
254
|
explicitamente o desejado. Falhas de aplicação conservam a configuração para
|
|
255
255
|
retry; `profile_busy` e `profile_sync_unconfirmed` pedem reconciliar após um
|
|
256
256
|
minuto. Sync sem configuração salva retorna `profile_not_configured`.
|
|
257
|
+
Perguntas e menu são do plano pago e do teste: no Free, salvar conteúdo
|
|
258
|
+
(PATCH) ou reaplicar uma configuração com conteúdo (sync) responde
|
|
259
|
+
`403 plan_restricted`; remover seções e DELETE seguem livres.
|
|
257
260
|
|
|
258
261
|
## Clientes e templates
|
|
259
262
|
|
|
@@ -370,13 +373,20 @@ catch (err) {
|
|
|
370
373
|
### Recusas de plano
|
|
371
374
|
|
|
372
375
|
`isPlanError(err)` reconhece recusas que só um upgrade resolve (retry não):
|
|
373
|
-
`403 plan_restricted` nas escritas de IA, Agenda, Calendário, Jornadas
|
|
376
|
+
`403 plan_restricted` nas escritas de IA, Agenda, Calendário, Jornadas, execuções,
|
|
377
|
+
Regras de mensagem do Direct e Perguntas e menu do Instagram
|
|
374
378
|
(`422 plan_restricted` em funil, aquecimento e regras de comentário),
|
|
375
|
-
`429 free_form_limit_reached` (limite de mensagens 1:1 do Free)
|
|
376
|
-
`402 free_number_cap`
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
|
|
379
|
+
`429 free_form_limit_reached` (limite de mensagens 1:1 do Free),
|
|
380
|
+
`402 free_number_cap` (setup além do teto de Números do Free ou envio por um
|
|
381
|
+
Número suspenso) e `402 free_cap` (2º Cliente no Free ou envio por um Cliente
|
|
382
|
+
suspenso). O catálogo de IA tem só `openai` e `anthropic`
|
|
383
|
+
(`AI_CREDENTIAL_PROVIDERS`, tipo `AiEnabledProvider`): as entradas (credencial,
|
|
384
|
+
vínculo, modelos, tarifa, agente) só aceitam esses dois; qualquer outro provedor
|
|
385
|
+
responde `422 provider_not_enabled`, também ao reativar a credencial (`update` com
|
|
386
|
+
`active: true`), trocar a chave, `revalidate`, vincular o provedor e salvar agente
|
|
387
|
+
com provedor descontinuado. `ai.providers.get()` lista só os dois provedores; as
|
|
388
|
+
leituras de credenciais, vínculos e agentes antigos podem trazer, desativados, os
|
|
389
|
+
provedores descontinuados (`AiProvider` mantém os seis).
|
|
380
390
|
|
|
381
391
|
```ts
|
|
382
392
|
import { isPlanError } from "@botozap/sdk";
|
|
@@ -386,6 +396,30 @@ catch (err) {
|
|
|
386
396
|
}
|
|
387
397
|
```
|
|
388
398
|
|
|
399
|
+
### Acima dos limites do Free
|
|
400
|
+
|
|
401
|
+
O Free permite 1 Cliente (com canal conectado ou não) e 1 número de WhatsApp.
|
|
402
|
+
Quem passa disso, por exemplo depois do teste grátis, não é apagado nem
|
|
403
|
+
desconectado: fica suspenso. As leituras de `customers` e `phoneNumbers`
|
|
404
|
+
(`list`, `get` e o `update` do número) trazem `plan_suspended: true`. O recurso
|
|
405
|
+
suspenso continua recebendo mensagens, mas não envia: o envio responde
|
|
406
|
+
`402 free_cap` (Cliente suspenso) ou `402 free_number_cap` (Número suspenso; o
|
|
407
|
+
Número de um Cliente suspenso também vem com `plan_suspended: true`). Criar o 2º
|
|
408
|
+
Cliente no Free responde `402 free_cap`. Assinar libera tudo na hora; para
|
|
409
|
+
seguir no Free, desconecte o outro número ou apague o Cliente que não usa.
|
|
410
|
+
|
|
411
|
+
```ts
|
|
412
|
+
import { isFreeCap, isFreeNumberCap } from "@botozap/sdk";
|
|
413
|
+
|
|
414
|
+
const numeros = await boto.phoneNumbers.list();
|
|
415
|
+
const ativos = numeros.data.filter((n) => !n.plan_suspended);
|
|
416
|
+
|
|
417
|
+
catch (err) {
|
|
418
|
+
if (isFreeNumberCap(err)) avisar("Número suspenso no Free: assine ou desconecte o outro número.");
|
|
419
|
+
else if (isFreeCap(err)) avisar("Negócio suspenso no Free: assine ou apague o outro Cliente.");
|
|
420
|
+
}
|
|
421
|
+
```
|
|
422
|
+
|
|
389
423
|
### Plano e slots adicionais
|
|
390
424
|
|
|
391
425
|
O plano pago inclui 1 negócio. Cada negócio a mais ocupa um slot adicional de
|
|
@@ -427,6 +461,79 @@ catch (err) {
|
|
|
427
461
|
}
|
|
428
462
|
```
|
|
429
463
|
|
|
464
|
+
### Consentimento e recusa
|
|
465
|
+
|
|
466
|
+
Cada contato tem um consentimento por canal (`whatsapp` ou `instagram`) e
|
|
467
|
+
finalidade (`marketing` ou `utility`), com a origem de cada registro: `manual`,
|
|
468
|
+
`import`, `api`, `keyword` (Palavra de saída), `conversation_button` (botão do
|
|
469
|
+
pedido de consentimento), `contact_keyword` (Palavra de volta), `template_button`
|
|
470
|
+
(botão de saída do template) e `meta_opt_out` (recusa informada pela Meta). Só o
|
|
471
|
+
próprio contato volta a aceitar depois de recusar.
|
|
472
|
+
|
|
473
|
+
```ts
|
|
474
|
+
const { current, history } = await boto.contacts.listConsents(contactId);
|
|
475
|
+
await boto.contacts.recordConsent(contactId, {
|
|
476
|
+
channel: "whatsapp",
|
|
477
|
+
purpose: "marketing",
|
|
478
|
+
state: "granted",
|
|
479
|
+
evidence: "Aceitou no formulário do site",
|
|
480
|
+
});
|
|
481
|
+
|
|
482
|
+
// Pedido de consentimento na conversa (botões no WhatsApp, respostas rápidas no
|
|
483
|
+
// Instagram; só com a janela de 24h aberta). A resposta traz `channel`.
|
|
484
|
+
const pedido = await boto.conversations.requestConsent(conversationId, {
|
|
485
|
+
purposes: ["marketing"],
|
|
486
|
+
});
|
|
487
|
+
```
|
|
488
|
+
|
|
489
|
+
Recusas: `409 consent_opted_out` ao registrar aceite sobre uma recusa do contato
|
|
490
|
+
(nada é gravado; `isConsentOptedOut`), `422 consent_revoked` ao enviar template de
|
|
491
|
+
marketing a quem recusou, também por outro número da Conta (`isConsentRevoked`;
|
|
492
|
+
`consent_basis` em `sendTemplate` não desfaz a recusa), `outside_window` (WhatsApp)
|
|
493
|
+
ou `window_closed` (Instagram) no pedido de consentimento com a janela fechada,
|
|
494
|
+
`channel_not_supported`, e `409 not_connected` quando o número está desconectado
|
|
495
|
+
(`isNotConnected`; vale também no envio, em mídia, transmissão e criação de
|
|
496
|
+
template). `contacts.create` aceita `consents` iniciais; recriar um contato que
|
|
497
|
+
recusou responde 201 com `warnings` (`consent_opted_out` ou `consent_unconfirmed`)
|
|
498
|
+
e o contato nasce como Recusou. Excluir o contato (`contacts.delete`) apaga a
|
|
499
|
+
mídia dele e guarda a recusa só como código cifrado (hash), que vale se ele voltar.
|
|
500
|
+
|
|
501
|
+
As Palavras de saída e de volta e os textos de confirmação são do Cliente
|
|
502
|
+
(`customers.update` com `opt_out_keywords`, `opt_in_keywords`,
|
|
503
|
+
`opt_out_confirmation` e `opt_in_confirmation`; não existe lista padrão). Num
|
|
504
|
+
template, `templates.update(id, { opt_out_buttons })` (ou `opt_out_buttons` em
|
|
505
|
+
`templates.create`) marca os botões de resposta rápida que são de saída.
|
|
506
|
+
|
|
507
|
+
### Excluir conversa
|
|
508
|
+
|
|
509
|
+
`conversations.delete(id)` exclui a conversa sem volta, com efeito imediato:
|
|
510
|
+
mensagens, notas, atribuições, vínculos com o CRM e o que a IA guardou dela, e a
|
|
511
|
+
mídia. O contato fica. Só Administrador; responde 204.
|
|
512
|
+
|
|
513
|
+
### Exportação de dados e registro de atividades
|
|
514
|
+
|
|
515
|
+
Scopes `exports:read`/`exports:write` e `team:read`; no OAuth, só pelo painel.
|
|
516
|
+
|
|
517
|
+
```ts
|
|
518
|
+
// Conta inteira ou um Cliente; o arquivo fica 7 dias, num zip por tipo de dado.
|
|
519
|
+
const pedidoExport = await boto.exports.create({ customer_id, format: "csv" });
|
|
520
|
+
const pronto = await boto.exports.get(pedidoExport.id); // pronto.download.url vale poucos minutos
|
|
521
|
+
const recentes = await boto.exports.list();
|
|
522
|
+
|
|
523
|
+
// Quem fez o quê, quando e de que IP. Só Administrador (403 admin_required).
|
|
524
|
+
const { data: eventos } = await boto.teamEvents.list({
|
|
525
|
+
action: "export.requested",
|
|
526
|
+
target_type: "conversation",
|
|
527
|
+
since: "2026-10-01T00:00:00Z",
|
|
528
|
+
});
|
|
529
|
+
```
|
|
530
|
+
|
|
531
|
+
`billing.get()` traz também `guarantee` (garantia de 7 dias: ciclo, valor e prazo
|
|
532
|
+
final) enquanto o cancelamento ainda devolve a primeira mensalidade integral.
|
|
533
|
+
Chave com lista de IPs autorizados responde `403 ip_not_allowed` a chamadas de
|
|
534
|
+
outro IP, e rotas removidas respondem `410 gone` (por exemplo, as de confirmação
|
|
535
|
+
de uso de dados da IA, que não existem mais).
|
|
536
|
+
|
|
430
537
|
### Webhooks
|
|
431
538
|
|
|
432
539
|
`WEBHOOK_CATEGORIES` lista as categorias de `webhooks.create({ events })`:
|
|
@@ -473,18 +580,20 @@ new BotoZap({
|
|
|
473
580
|
O SDK cobre os recursos da API `/v1`:
|
|
474
581
|
|
|
475
582
|
- `messages` — enviar texto (com `quick_replies` no Instagram), template e mídia por link, **listar** e buscar por id
|
|
476
|
-
- `customers` — listar, buscar, criar, **atualizar
|
|
477
|
-
- `templates` — listar, buscar, **criar**
|
|
583
|
+
- `customers` — listar, buscar, criar, **atualizar** (nome, id externo e Palavras de saída/volta com os textos de confirmação), **remover**, e **links de setup** (listar/criar/atualizar; `channel` `whatsapp` ou `instagram`, um canal por link)
|
|
584
|
+
- `templates` — listar, buscar, **criar**, **atualizar** (`opt_out_buttons`)
|
|
478
585
|
- `broadcasts` — criar, destinatários, agendar, enviar, cancelar
|
|
479
|
-
- `contacts` — listar, buscar, criar, atualizar, remover
|
|
480
|
-
- `conversations` — listar (filtros `channel` e `channel_account_id`), buscar, atualizar, responder, atribuições; leituras trazem `entry_point` (`ctwa`/`organic`/`null`), `referral` do último clique em anúncio Click-to-WhatsApp, `fep_expires_at` (fim da janela grátis informado pela Meta) e `fep_reply_by` (estimativa do prazo para responder)
|
|
586
|
+
- `contacts` — listar, buscar, criar, atualizar, remover, **`listConsents`/`recordConsent`**; `display_name` é o nome que a empresa dá ao Contato (1–200 caracteres; `null` limpa), separado do `profile_name` que vem do canal
|
|
587
|
+
- `conversations` — **`requestConsent`** e **`delete`**; listar (filtros `channel` e `channel_account_id`), buscar, atualizar, responder, atribuições; leituras trazem `entry_point` (`ctwa`/`organic`/`null`), `referral` do último clique em anúncio Click-to-WhatsApp, `fep_expires_at` (fim da janela grátis informado pela Meta) e `fep_reply_by` (estimativa do prazo para responder)
|
|
481
588
|
- `webhooks` — CRUD e teste; `customer_id` opcional limita as entregas a um Cliente da Conta (`null` no update remove o filtro); `channel_account_ids` limita a alguns canais (`null` = todos) e `channels_health` traz a saúde por canal
|
|
482
589
|
- `channelAccounts` — listar e buscar Contas de canal (WhatsApp e Instagram); **Regras de comentário** do Instagram (listar, buscar, criar, atualizar, excluir) e **Perguntas e menu** (ler, salvar/aplicar, remover, verificar/reaplicar)
|
|
483
590
|
- `phoneNumbers` — listar, buscar, **atualizar o `label`** (nome local, até 100 caracteres; `null` limpa), remover, saúde
|
|
484
591
|
- `media` — subir arquivo (obter um media_id) e **buscar metadados + URL de download** de uma mídia recebida
|
|
485
592
|
- `events` — reler inbound e mudanças de status pelo cursor durável da Conta/ambiente
|
|
486
593
|
- `usage` — `metaCosts`: custo aproximado da Meta por dia, categoria e moeda (Pricing Analytics), com estimativa por tarifa publicada onde a Meta não devolveu custo
|
|
487
|
-
- `billing` — `get`: plano e slots adicionais; `slots.create` (compra, com `idempotencyKey`) e `slots.cancel` (slot vazio, sem reembolso). Só chave de API
|
|
594
|
+
- `billing` — `get`: plano e slots adicionais; `slots.create` (compra, com `idempotencyKey`) e `slots.cancel` (slot vazio, sem reembolso); `guarantee` (garantia de 7 dias). Só chave de API
|
|
595
|
+
- `exports` — `create`, `list`, `get` (exportação de dados da Conta; `exports:read`/`exports:write`)
|
|
596
|
+
- `teamEvents` — `list`: registro de atividades da equipe, com filtros (`team:read`, só Administrador)
|
|
488
597
|
- `me` — `get`: Conta, ambiente (`live` ou `sandbox`) e scopes efetivos da chave autenticada; não retorna a chave nem uma identidade pessoal
|
|
489
598
|
- `users`, `apiLogs`, `webhookDeliveries` — leitura
|
|
490
599
|
|
|
@@ -700,6 +809,8 @@ por tempo, conforme o runbook `botozap/docs/ops/message-send-receipts.md`.
|
|
|
700
809
|
|
|
701
810
|
Regras de comentário incluem `dm_button_title`, `delivery_text` e `delivery_media`.
|
|
702
811
|
Regras de mensagem têm CRUD com gatilhos e ações tipados (`message-rules:read/write`);
|
|
812
|
+
no Free, criar ou editar responde `403 plan_restricted` (pausar com
|
|
813
|
+
`{ is_active: false }` e excluir seguem livres);
|
|
703
814
|
métricas de comentário recebem `from`/`to` (`comment-rules:read`).
|
|
704
815
|
[Contrato e exemplos de SDK, CLI e MCP](../../docs/instagram-wave-two.md).
|
|
705
816
|
|
package/dist/index.cjs
CHANGED
|
@@ -64,6 +64,11 @@ __export(index_exports, {
|
|
|
64
64
|
SavedReplies: () => SavedReplies,
|
|
65
65
|
WEBHOOK_CATEGORIES: () => WEBHOOK_CATEGORIES,
|
|
66
66
|
isBusinessPaymentRequired: () => isBusinessPaymentRequired,
|
|
67
|
+
isConsentOptedOut: () => isConsentOptedOut,
|
|
68
|
+
isConsentRevoked: () => isConsentRevoked,
|
|
69
|
+
isFreeCap: () => isFreeCap,
|
|
70
|
+
isFreeNumberCap: () => isFreeNumberCap,
|
|
71
|
+
isNotConnected: () => isNotConnected,
|
|
67
72
|
isPlanError: () => isPlanError
|
|
68
73
|
});
|
|
69
74
|
module.exports = __toCommonJS(index_exports);
|
|
@@ -126,7 +131,8 @@ var BotoZapError = class extends Error {
|
|
|
126
131
|
var PLAN_ERROR_CODES = [
|
|
127
132
|
"plan_restricted",
|
|
128
133
|
"free_form_limit_reached",
|
|
129
|
-
"free_number_cap"
|
|
134
|
+
"free_number_cap",
|
|
135
|
+
"free_cap"
|
|
130
136
|
];
|
|
131
137
|
function isPlanError(error) {
|
|
132
138
|
return error instanceof BotoZapError && PLAN_ERROR_CODES.includes(error.code);
|
|
@@ -134,6 +140,21 @@ function isPlanError(error) {
|
|
|
134
140
|
function isBusinessPaymentRequired(error) {
|
|
135
141
|
return error instanceof BotoZapError && error.code === "business_payment_required";
|
|
136
142
|
}
|
|
143
|
+
function isFreeCap(error) {
|
|
144
|
+
return error instanceof BotoZapError && error.code === "free_cap";
|
|
145
|
+
}
|
|
146
|
+
function isFreeNumberCap(error) {
|
|
147
|
+
return error instanceof BotoZapError && error.code === "free_number_cap";
|
|
148
|
+
}
|
|
149
|
+
function isConsentOptedOut(error) {
|
|
150
|
+
return error instanceof BotoZapError && error.code === "consent_opted_out";
|
|
151
|
+
}
|
|
152
|
+
function isConsentRevoked(error) {
|
|
153
|
+
return error instanceof BotoZapError && error.code === "consent_revoked";
|
|
154
|
+
}
|
|
155
|
+
function isNotConnected(error) {
|
|
156
|
+
return error instanceof BotoZapError && error.code === "not_connected";
|
|
157
|
+
}
|
|
137
158
|
|
|
138
159
|
// src/resources/ai/upload.ts
|
|
139
160
|
var receipts = /* @__PURE__ */ new WeakMap();
|
|
@@ -4022,7 +4043,7 @@ var AiCredentialsResource = class {
|
|
|
4022
4043
|
get(input) {
|
|
4023
4044
|
return request(this.client, AI_OPERATIONS[11], input);
|
|
4024
4045
|
}
|
|
4025
|
-
/** Cria credencial própria no Vault; a resposta nunca contém a chave. Só `AI_CREDENTIAL_PROVIDERS` (openai/anthropic); os demais: 422 `provider_not_enabled
|
|
4046
|
+
/** Cria credencial própria no Vault; a resposta nunca contém a chave. Só `AI_CREDENTIAL_PROVIDERS` (openai/anthropic); os demais: 422 `provider_not_enabled`, o mesmo erro de reativar (`update` com `active: true`), trocar a chave, `revalidate` e vincular um provedor descontinuado. */
|
|
4026
4047
|
create(input) {
|
|
4027
4048
|
return request(this.client, AI_OPERATIONS[12], input);
|
|
4028
4049
|
}
|
|
@@ -4044,7 +4065,12 @@ var AiProvidersResource = class {
|
|
|
4044
4065
|
this.client = client;
|
|
4045
4066
|
}
|
|
4046
4067
|
client;
|
|
4047
|
-
/**
|
|
4068
|
+
/**
|
|
4069
|
+
* GET /ai/providers. A lista `providers` traz só `openai` e `anthropic`;
|
|
4070
|
+
* `credentials` e `bindings` podem trazer, desativados, os de provedores
|
|
4071
|
+
* antigos. Salvar vínculo ou agente com provedor descontinuado: 422
|
|
4072
|
+
* `provider_not_enabled`.
|
|
4073
|
+
*/
|
|
4048
4074
|
get(input) {
|
|
4049
4075
|
return request(this.client, AI_OPERATIONS[16], input);
|
|
4050
4076
|
}
|
|
@@ -5187,7 +5213,8 @@ var Messages = class {
|
|
|
5187
5213
|
to: params.to,
|
|
5188
5214
|
type: "template",
|
|
5189
5215
|
template: params.template,
|
|
5190
|
-
from: params.from
|
|
5216
|
+
from: params.from,
|
|
5217
|
+
...params.consent_basis !== void 0 ? { consent_basis: params.consent_basis } : {}
|
|
5191
5218
|
}
|
|
5192
5219
|
});
|
|
5193
5220
|
return assertSendResult(result);
|
|
@@ -5323,13 +5350,20 @@ var Customers = class {
|
|
|
5323
5350
|
get(id) {
|
|
5324
5351
|
return this.client.requestItem("GET", `/customers/${enc(id)}`);
|
|
5325
5352
|
}
|
|
5326
|
-
/**
|
|
5353
|
+
/**
|
|
5354
|
+
* Cria um cliente. No plano Free, que permite 1 Cliente (com canal ou não), o
|
|
5355
|
+
* segundo responde 402 `free_cap` (veja `isFreeCap`).
|
|
5356
|
+
*/
|
|
5327
5357
|
create(params) {
|
|
5328
5358
|
return this.client.requestItem("POST", "/customers", {
|
|
5329
5359
|
body: params
|
|
5330
5360
|
});
|
|
5331
5361
|
}
|
|
5332
|
-
/**
|
|
5362
|
+
/**
|
|
5363
|
+
* Atualiza `name` / `external_customer_id` de um cliente e as Palavras de saída
|
|
5364
|
+
* e de volta com os textos de confirmação. Palavra repetida entre saída e volta
|
|
5365
|
+
* responde 422 `invalid_request`.
|
|
5366
|
+
*/
|
|
5333
5367
|
update(id, params) {
|
|
5334
5368
|
return this.client.requestItem("PATCH", `/customers/${enc(id)}`, {
|
|
5335
5369
|
body: params
|
|
@@ -5403,6 +5437,19 @@ var Templates = class {
|
|
|
5403
5437
|
body: params
|
|
5404
5438
|
});
|
|
5405
5439
|
}
|
|
5440
|
+
/**
|
|
5441
|
+
* Marca quais botões de resposta rápida são de saída (`opt_out_buttons`). O toque
|
|
5442
|
+
* num botão marcado grava a recusa da finalidade do template; botão não marcado
|
|
5443
|
+
* não muda nada, qualquer que seja o texto. Não altera o template na Meta.
|
|
5444
|
+
* Scope `templates:write`.
|
|
5445
|
+
*/
|
|
5446
|
+
update(id, params) {
|
|
5447
|
+
return this.client.requestItem(
|
|
5448
|
+
"PATCH",
|
|
5449
|
+
`/templates/${encodeURIComponent(id)}`,
|
|
5450
|
+
{ body: params }
|
|
5451
|
+
);
|
|
5452
|
+
}
|
|
5406
5453
|
};
|
|
5407
5454
|
|
|
5408
5455
|
// src/resources/broadcasts.ts
|
|
@@ -5523,6 +5570,12 @@ var Contacts = class {
|
|
|
5523
5570
|
get(id) {
|
|
5524
5571
|
return this.client.requestItem("GET", `/contacts/${enc3(id)}`);
|
|
5525
5572
|
}
|
|
5573
|
+
/**
|
|
5574
|
+
* Cria um contato. A resposta (201) pode trazer `warnings` por canal e
|
|
5575
|
+
* finalidade: `consent_opted_out` (o contato já recusou; o aceite pedido em
|
|
5576
|
+
* `consents` não foi gravado) ou `consent_unconfirmed` (não foi possível
|
|
5577
|
+
* confirmar o consentimento vigente).
|
|
5578
|
+
*/
|
|
5526
5579
|
create(params) {
|
|
5527
5580
|
return this.client.requestItem("POST", "/contacts", {
|
|
5528
5581
|
body: params
|
|
@@ -5533,10 +5586,38 @@ var Contacts = class {
|
|
|
5533
5586
|
body: params
|
|
5534
5587
|
});
|
|
5535
5588
|
}
|
|
5536
|
-
/**
|
|
5589
|
+
/**
|
|
5590
|
+
* Remove um contato e o que é dele (conversas, mensagens, CRM, compromissos e
|
|
5591
|
+
* Consentimentos); a mídia dele é apagada. A recusa não se perde: fica guardada
|
|
5592
|
+
* como código cifrado (hash) na lista de recusa da Conta e vale se o contato
|
|
5593
|
+
* voltar, que nasce como Recusou. Responde 204 (sem corpo).
|
|
5594
|
+
*/
|
|
5537
5595
|
delete(id) {
|
|
5538
5596
|
return this.client.request("DELETE", `/contacts/${enc3(id)}`);
|
|
5539
5597
|
}
|
|
5598
|
+
/**
|
|
5599
|
+
* Consentimentos do contato: `current` (o vigente por canal e finalidade) e
|
|
5600
|
+
* `history` (todos, do mais novo ao mais antigo). Scope `contacts:read`.
|
|
5601
|
+
*/
|
|
5602
|
+
listConsents(id) {
|
|
5603
|
+
return this.client.requestItem(
|
|
5604
|
+
"GET",
|
|
5605
|
+
`/contacts/${enc3(id)}/consents`
|
|
5606
|
+
);
|
|
5607
|
+
}
|
|
5608
|
+
/**
|
|
5609
|
+
* Registra um Consentimento do contato (origem `api`). Scope `contacts:write`.
|
|
5610
|
+
* Sobre uma recusa do próprio contato responde `409 consent_opted_out` e nada é
|
|
5611
|
+
* gravado: só ele volta a aceitar (botão do pedido de consentimento ou Palavra
|
|
5612
|
+
* de volta). Para recusar, registre `state: "revoked"`.
|
|
5613
|
+
*/
|
|
5614
|
+
recordConsent(id, params) {
|
|
5615
|
+
return this.client.requestItem(
|
|
5616
|
+
"POST",
|
|
5617
|
+
`/contacts/${enc3(id)}/consents`,
|
|
5618
|
+
{ body: params }
|
|
5619
|
+
);
|
|
5620
|
+
}
|
|
5540
5621
|
};
|
|
5541
5622
|
function enc3(id) {
|
|
5542
5623
|
return encodeURIComponent(id);
|
|
@@ -5621,6 +5702,39 @@ var Conversations = class {
|
|
|
5621
5702
|
options
|
|
5622
5703
|
);
|
|
5623
5704
|
}
|
|
5705
|
+
/**
|
|
5706
|
+
* Envia o pedido de consentimento na conversa (o "Pedir consentimento" do
|
|
5707
|
+
* composer): botões no WhatsApp, respostas rápidas no Instagram. Só com a
|
|
5708
|
+
* janela de 24h aberta, e sai também para quem recusou marketing: é o caminho
|
|
5709
|
+
* de volta. O toque do contato grava o aceite (origem `conversation_button`).
|
|
5710
|
+
* Scope `messages:send`. Responde 201 com o `channel` do envio; `warnings` com
|
|
5711
|
+
* `send_unrecorded` significa que a Meta aceitou e a gravação falhou: não
|
|
5712
|
+
* reenvie, o pedido já saiu.
|
|
5713
|
+
*
|
|
5714
|
+
* Recusas: `outside_window` (WhatsApp) ou `window_closed` (Instagram) com a
|
|
5715
|
+
* janela fechada, `channel_not_supported` (canal sem botões), `no_phone`,
|
|
5716
|
+
* `not_connected` (número desconectado ou sem token), `invalid_recipient`.
|
|
5717
|
+
* Não há chave de idempotência: não repita um pedido de resultado incerto sem
|
|
5718
|
+
* conferir o histórico da conversa.
|
|
5719
|
+
*/
|
|
5720
|
+
requestConsent(id, params = {}) {
|
|
5721
|
+
return this.client.requestItem(
|
|
5722
|
+
"POST",
|
|
5723
|
+
`/conversations/${enc4(id)}/consent-request`,
|
|
5724
|
+
{ body: params }
|
|
5725
|
+
);
|
|
5726
|
+
}
|
|
5727
|
+
/**
|
|
5728
|
+
* Exclui a conversa, com efeito imediato e sem volta: mensagens, notas,
|
|
5729
|
+
* atribuições, vínculos com oportunidades e demandas e o que a IA guardou
|
|
5730
|
+
* dela saem juntos, e os arquivos de mídia são apagados. O contato fica, com a
|
|
5731
|
+
* recusa e o consentimento. Só Administrador (por OAuth, papel de
|
|
5732
|
+
* administrador). Responde 204; id inexistente, de outra Conta ou já excluído
|
|
5733
|
+
* é 404. Scope `conversations:write`.
|
|
5734
|
+
*/
|
|
5735
|
+
delete(id) {
|
|
5736
|
+
return this.client.request("DELETE", `/conversations/${enc4(id)}`);
|
|
5737
|
+
}
|
|
5624
5738
|
update(id, params) {
|
|
5625
5739
|
return this.client.requestItem(
|
|
5626
5740
|
"PATCH",
|
|
@@ -5887,11 +6001,18 @@ var ChannelAccounts = class {
|
|
|
5887
6001
|
getMessageRule(channelAccountId, ruleId) {
|
|
5888
6002
|
return this.client.requestItem("GET", messageRulesPath(channelAccountId, ruleId));
|
|
5889
6003
|
}
|
|
5890
|
-
/**
|
|
6004
|
+
/**
|
|
6005
|
+
* Cria uma Regra de mensagem. message-rules:write. Fora do plano (Free)
|
|
6006
|
+
* responde 403 `plan_restricted`.
|
|
6007
|
+
*/
|
|
5891
6008
|
createMessageRule(channelAccountId, params) {
|
|
5892
6009
|
return this.client.requestItem("POST", messageRulesPath(channelAccountId), { body: params });
|
|
5893
6010
|
}
|
|
5894
|
-
/**
|
|
6011
|
+
/**
|
|
6012
|
+
* PATCH parcial; a API valida o estado final. message-rules:write. No Free,
|
|
6013
|
+
* só `{ is_active: false }` (pausar) passa; o resto responde 403
|
|
6014
|
+
* `plan_restricted`.
|
|
6015
|
+
*/
|
|
5895
6016
|
updateMessageRule(channelAccountId, ruleId, params) {
|
|
5896
6017
|
return this.client.requestItem("PATCH", messageRulesPath(channelAccountId, ruleId), { body: params });
|
|
5897
6018
|
}
|
|
@@ -5903,7 +6024,11 @@ var ChannelAccounts = class {
|
|
|
5903
6024
|
getMessengerProfile(channelAccountId) {
|
|
5904
6025
|
return this.client.requestItem("GET", profilePath(channelAccountId));
|
|
5905
6026
|
}
|
|
5906
|
-
/**
|
|
6027
|
+
/**
|
|
6028
|
+
* Salva/aplica apenas as seções enviadas. messenger-profile:write; sem
|
|
6029
|
+
* sandbox. No Free, só remover seções passa; salvar conteúdo responde 403
|
|
6030
|
+
* `plan_restricted`.
|
|
6031
|
+
*/
|
|
5907
6032
|
updateMessengerProfile(channelAccountId, params) {
|
|
5908
6033
|
return this.client.requestItem("PATCH", profilePath(channelAccountId), { body: params });
|
|
5909
6034
|
}
|
|
@@ -5911,7 +6036,11 @@ var ChannelAccounts = class {
|
|
|
5911
6036
|
deleteMessengerProfile(channelAccountId) {
|
|
5912
6037
|
return this.client.requestItem("DELETE", profilePath(channelAccountId));
|
|
5913
6038
|
}
|
|
5914
|
-
/**
|
|
6039
|
+
/**
|
|
6040
|
+
* Verifica/reaplica explicitamente o desejado salvo. messenger-profile:write.
|
|
6041
|
+
* No Free, reaplicar uma configuração com conteúdo responde 403
|
|
6042
|
+
* `plan_restricted`.
|
|
6043
|
+
*/
|
|
5915
6044
|
syncMessengerProfile(channelAccountId) {
|
|
5916
6045
|
return this.client.requestItem("POST", `${profilePath(channelAccountId)}/sync`);
|
|
5917
6046
|
}
|
|
@@ -6051,6 +6180,77 @@ var BillingResource = class {
|
|
|
6051
6180
|
}
|
|
6052
6181
|
};
|
|
6053
6182
|
|
|
6183
|
+
// src/resources/exports.ts
|
|
6184
|
+
var Exports = class {
|
|
6185
|
+
constructor(client) {
|
|
6186
|
+
this.client = client;
|
|
6187
|
+
}
|
|
6188
|
+
client;
|
|
6189
|
+
/**
|
|
6190
|
+
* Pede a exportação completa da Conta, ou de um Cliente (`customer_id`). Scope
|
|
6191
|
+
* `exports:write`. Responde 202 com o pedido novo; pedido igual enquanto o
|
|
6192
|
+
* anterior ainda está na fila devolve o mesmo (200). Funciona com a Conta em
|
|
6193
|
+
* somente leitura por exclusão: é o que se faz antes da exclusão começar. Cliente
|
|
6194
|
+
* inexistente é 404 `not_found`; exclusão já iniciada, 409
|
|
6195
|
+
* `account_deletion_in_progress`; muitos pedidos seguidos, 429 `rate_limited`.
|
|
6196
|
+
*/
|
|
6197
|
+
create(params = {}) {
|
|
6198
|
+
return this.client.requestItem("POST", "/exports", {
|
|
6199
|
+
body: params
|
|
6200
|
+
});
|
|
6201
|
+
}
|
|
6202
|
+
/**
|
|
6203
|
+
* Últimos pedidos da Conta (até 50), do mais novo ao mais antigo, sem o link de
|
|
6204
|
+
* download. Scope `exports:read`.
|
|
6205
|
+
*/
|
|
6206
|
+
list() {
|
|
6207
|
+
return this.client.requestItem("GET", "/exports");
|
|
6208
|
+
}
|
|
6209
|
+
/**
|
|
6210
|
+
* Estado de um pedido e, quando pronto e dentro do prazo, `download` com um
|
|
6211
|
+
* link assinado de poucos minutos: cada consulta gera um novo. Scope
|
|
6212
|
+
* `exports:read`. Pedido de outra Conta é 404 `not_found`.
|
|
6213
|
+
*/
|
|
6214
|
+
get(id) {
|
|
6215
|
+
return this.client.requestItem(
|
|
6216
|
+
"GET",
|
|
6217
|
+
`/exports/${encodeURIComponent(id)}`
|
|
6218
|
+
);
|
|
6219
|
+
}
|
|
6220
|
+
};
|
|
6221
|
+
|
|
6222
|
+
// src/resources/team-events.ts
|
|
6223
|
+
var TeamEvents = class {
|
|
6224
|
+
constructor(client) {
|
|
6225
|
+
this.client = client;
|
|
6226
|
+
}
|
|
6227
|
+
client;
|
|
6228
|
+
/**
|
|
6229
|
+
* Lista o registro (paginação por cursor). Scope `team:read`, e só
|
|
6230
|
+
* Administrador lê: a chave vale enquanto quem a criou seguir como
|
|
6231
|
+
* Administrador da Conta (senão 403 `admin_required`). Filtro inválido é 422.
|
|
6232
|
+
*/
|
|
6233
|
+
list(params = {}) {
|
|
6234
|
+
return this.client.requestCursorList(
|
|
6235
|
+
"GET",
|
|
6236
|
+
"/team_events",
|
|
6237
|
+
{
|
|
6238
|
+
query: {
|
|
6239
|
+
limit: params.limit,
|
|
6240
|
+
after: params.after,
|
|
6241
|
+
before: params.before,
|
|
6242
|
+
since: params.since,
|
|
6243
|
+
until: params.until,
|
|
6244
|
+
actor_id: params.actor_id,
|
|
6245
|
+
action: params.action,
|
|
6246
|
+
target_type: params.target_type,
|
|
6247
|
+
target_id: params.target_id
|
|
6248
|
+
}
|
|
6249
|
+
}
|
|
6250
|
+
);
|
|
6251
|
+
}
|
|
6252
|
+
};
|
|
6253
|
+
|
|
6054
6254
|
// src/resources/read-only.ts
|
|
6055
6255
|
var Users = class {
|
|
6056
6256
|
constructor(client) {
|
|
@@ -6146,6 +6346,10 @@ var BotoZap = class {
|
|
|
6146
6346
|
usage;
|
|
6147
6347
|
/** Plano da Conta e slots adicionais (só chave de API). */
|
|
6148
6348
|
billing;
|
|
6349
|
+
/** Exportação de dados da Conta (`/v1/exports`). */
|
|
6350
|
+
exports;
|
|
6351
|
+
/** Registro de atividades da equipe (`/v1/team_events`, só Administrador). */
|
|
6352
|
+
teamEvents;
|
|
6149
6353
|
users;
|
|
6150
6354
|
apiLogs;
|
|
6151
6355
|
webhookDeliveries;
|
|
@@ -6190,6 +6394,8 @@ var BotoZap = class {
|
|
|
6190
6394
|
this.events = new Events(this);
|
|
6191
6395
|
this.usage = new Usage(this);
|
|
6192
6396
|
this.billing = new BillingResource(this);
|
|
6397
|
+
this.exports = new Exports(this);
|
|
6398
|
+
this.teamEvents = new TeamEvents(this);
|
|
6193
6399
|
this.users = new Users(this);
|
|
6194
6400
|
this.apiLogs = new ApiLogs(this);
|
|
6195
6401
|
this.webhookDeliveries = new WebhookDeliveries(this);
|
|
@@ -6408,6 +6614,11 @@ var WEBHOOK_CATEGORIES = [
|
|
|
6408
6614
|
SavedReplies,
|
|
6409
6615
|
WEBHOOK_CATEGORIES,
|
|
6410
6616
|
isBusinessPaymentRequired,
|
|
6617
|
+
isConsentOptedOut,
|
|
6618
|
+
isConsentRevoked,
|
|
6619
|
+
isFreeCap,
|
|
6620
|
+
isFreeNumberCap,
|
|
6621
|
+
isNotConnected,
|
|
6411
6622
|
isPlanError
|
|
6412
6623
|
});
|
|
6413
6624
|
//# sourceMappingURL=index.cjs.map
|