@botozap/sdk 0.19.0 → 0.20.1
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 +42 -0
- package/README.md +98 -14
- package/dist/index.cjs +187 -5
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +494 -23
- package/dist/index.d.ts +494 -23
- package/dist/index.js +184 -5
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,47 @@
|
|
|
1
1
|
# @botozap/sdk
|
|
2
2
|
|
|
3
|
+
## 0.20.1
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- bef36f5: CLI: `--idempotency-key` em `messages send` (inclusive `--input`/`--stdin`), `send-media`, `send-interactive`, `send-location` e `react`, enviado no header `Idempotency-Key`. SDK: o README orienta derivar a chave do evento e lista todos os métodos de envio que aceitam `idempotencyKey`.
|
|
8
|
+
|
|
9
|
+
## 0.20.0
|
|
10
|
+
|
|
11
|
+
### Minor Changes
|
|
12
|
+
|
|
13
|
+
- 532fd08: Paridade com a API de 16 a 20/10/2026. Consentimento: pedido de consentimento
|
|
14
|
+
(`conversations.requestConsent`, `botozap conversations request-consent`, tool
|
|
15
|
+
`request_consent`), que vale para WhatsApp e Instagram e devolve `channel`, com as
|
|
16
|
+
recusas `outside_window` (WhatsApp) e `window_closed` (Instagram); consentimentos do
|
|
17
|
+
contato (`contacts.listConsents` e `recordConsent`, `botozap contacts consents` e
|
|
18
|
+
`record-consent`, tools `list_contact_consents` e `record_contact_consent`) com as
|
|
19
|
+
origens `contact_keyword`, `template_button` e `meta_opt_out`; `warnings` no retorno
|
|
20
|
+
de `contacts.create`; `consent_basis` em `messages.sendTemplate`. Palavras de saída e
|
|
21
|
+
de volta e textos de confirmação do Cliente (`opt_out_keywords`, `opt_in_keywords`,
|
|
22
|
+
`opt_out_confirmation`, `opt_in_confirmation`) em `customers.update` e no objeto, e
|
|
23
|
+
`opt_out_buttons` em `templates.create`, `templates.update` (novo,
|
|
24
|
+
`PATCH /v1/templates/{id}`) e no objeto (MCP: tool `update_template`; o
|
|
25
|
+
`create_template` do MCP não muda para manter o perfil `assistant` idêntico). Erros
|
|
26
|
+
novos em `BotoZapErrorCode`: `consent_opted_out` (409), `consent_revoked` (422),
|
|
27
|
+
`not_connected` (409), `ip_not_allowed` (403), `admin_required` e `gone` (410), com
|
|
28
|
+
`isConsentOptedOut`, `isConsentRevoked` e `isNotConnected`. Conversas:
|
|
29
|
+
`conversations.delete` (`botozap conversations delete`, com confirmação ou `--yes`;
|
|
30
|
+
tool MCP `delete_conversation`, marcada como destrutiva). Exportação de dados:
|
|
31
|
+
`exports.create`/`list`/`get` (`exports:read` e `exports:write`; CLI `exports`; tools
|
|
32
|
+
`create_export`, `list_exports` e `get_export`). Registro de atividades:
|
|
33
|
+
`teamEvents.list` com filtros (CLI `team-events list`; tool `list_team_events`).
|
|
34
|
+
Plano: `guarantee` (garantia de 7 dias) em `billing.get`, no CLI e em `get_billing`.
|
|
35
|
+
IA: o catálogo tem só `openai` e `anthropic`; as entradas do SDK
|
|
36
|
+
(`AiEnabledProvider`; `AiAgentConfig`, `AiBindingTarget` e `AiRouterConfig` agora são
|
|
37
|
+
tipos de entrada) e as tools `ai_*` do MCP aceitam só esses dois (outro provedor
|
|
38
|
+
responde 422 `provider_not_enabled`); a leitura mantém os seis históricos
|
|
39
|
+
(`AiProvider`, `AiAgentConfigRead`, `AiBindingTargetRead`).
|
|
40
|
+
Descrições: `delete_contact` diz que a recusa fica guardada como código cifrado e
|
|
41
|
+
que a mídia é apagada; `send_message` (só no catálogo completo) explica
|
|
42
|
+
`consent_revoked` e `not_connected`; sai o rótulo `data_use_ack_required` do
|
|
43
|
+
`agent-inbox`. Tudo novo do MCP fica só no catálogo completo (chave de API).
|
|
44
|
+
|
|
3
45
|
## 0.19.0
|
|
4
46
|
|
|
5
47
|
### Minor Changes
|
package/README.md
CHANGED
|
@@ -379,10 +379,14 @@ Regras de mensagem do Direct e Perguntas e menu do Instagram
|
|
|
379
379
|
`429 free_form_limit_reached` (limite de mensagens 1:1 do Free),
|
|
380
380
|
`402 free_number_cap` (setup além do teto de Números do Free ou envio por um
|
|
381
381
|
Número suspenso) e `402 free_cap` (2º Cliente no Free ou envio por um Cliente
|
|
382
|
-
suspenso).
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
|
|
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).
|
|
386
390
|
|
|
387
391
|
```ts
|
|
388
392
|
import { isPlanError } from "@botozap/sdk";
|
|
@@ -457,6 +461,79 @@ catch (err) {
|
|
|
457
461
|
}
|
|
458
462
|
```
|
|
459
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
|
+
|
|
460
537
|
### Webhooks
|
|
461
538
|
|
|
462
539
|
`WEBHOOK_CATEGORIES` lista as categorias de `webhooks.create({ events })`:
|
|
@@ -503,18 +580,20 @@ new BotoZap({
|
|
|
503
580
|
O SDK cobre os recursos da API `/v1`:
|
|
504
581
|
|
|
505
582
|
- `messages` — enviar texto (com `quick_replies` no Instagram), template e mídia por link, **listar** e buscar por id
|
|
506
|
-
- `customers` — listar, buscar, criar, **atualizar
|
|
507
|
-
- `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`)
|
|
508
585
|
- `broadcasts` — criar, destinatários, agendar, enviar, cancelar
|
|
509
|
-
- `contacts` — listar, buscar, criar, atualizar, remover
|
|
510
|
-
- `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)
|
|
511
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
|
|
512
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)
|
|
513
590
|
- `phoneNumbers` — listar, buscar, **atualizar o `label`** (nome local, até 100 caracteres; `null` limpa), remover, saúde
|
|
514
591
|
- `media` — subir arquivo (obter um media_id) e **buscar metadados + URL de download** de uma mídia recebida
|
|
515
592
|
- `events` — reler inbound e mudanças de status pelo cursor durável da Conta/ambiente
|
|
516
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
|
|
517
|
-
- `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)
|
|
518
597
|
- `me` — `get`: Conta, ambiente (`live` ou `sandbox`) e scopes efetivos da chave autenticada; não retorna a chave nem uma identidade pessoal
|
|
519
598
|
- `users`, `apiLogs`, `webhookDeliveries` — leitura
|
|
520
599
|
|
|
@@ -702,18 +781,23 @@ Informe uma única credencial. O SDK envia `Authorization: Bearer` e não realiz
|
|
|
702
781
|
|
|
703
782
|
### Repetir um envio sem duplicar a intenção
|
|
704
783
|
|
|
705
|
-
A opção `idempotencyKey` é opcional.
|
|
706
|
-
|
|
784
|
+
A opção `idempotencyKey` é opcional. Derive a chave do evento no seu sistema
|
|
785
|
+
(o pedido, a assinatura, a data do aviso), para que qualquer processo que tente
|
|
786
|
+
o mesmo envio use a mesma chave; o corpo e a credencial também devem ser os
|
|
707
787
|
mesmos. Sem a opção, o SDK mantém o comportamento anterior.
|
|
708
788
|
|
|
709
789
|
```ts
|
|
710
|
-
const options = { idempotencyKey:
|
|
790
|
+
const options = { idempotencyKey: `pedido-pronto-${pedido.id}` };
|
|
711
791
|
await boto.messages.send({ to: "5511999999999", text: "Seu pedido está pronto." }, options);
|
|
712
792
|
// Retry da mesma intenção: use novamente o mesmo payload e options.
|
|
713
793
|
```
|
|
714
794
|
|
|
715
|
-
|
|
716
|
-
|
|
795
|
+
Uma chave aleatória (`crypto.randomUUID()`) só protege se for criada e
|
|
796
|
+
guardada antes da primeira tentativa: dois processos que geram cada um a sua
|
|
797
|
+
não se enxergam, e as duas mensagens saem.
|
|
798
|
+
|
|
799
|
+
`sendTemplate`, `sendMedia`, `sendInteractive`, `sendLocation`, `sendReaction` e
|
|
800
|
+
`conversations.reply` aceitam a mesma opção como último argumento. O servidor retorna a resposta original; payload diferente ou
|
|
717
801
|
tentativa pendente retornam 409. Resultados terminais ficam disponíveis por 24h.
|
|
718
802
|
Pendências desconhecidas não reabrem automaticamente. Depois de 24h, confira o
|
|
719
803
|
histórico antes de reenviar; nunca troque a chave para contornar uma pendência.
|
package/dist/index.cjs
CHANGED
|
@@ -64,8 +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,
|
|
67
69
|
isFreeCap: () => isFreeCap,
|
|
68
70
|
isFreeNumberCap: () => isFreeNumberCap,
|
|
71
|
+
isNotConnected: () => isNotConnected,
|
|
69
72
|
isPlanError: () => isPlanError
|
|
70
73
|
});
|
|
71
74
|
module.exports = __toCommonJS(index_exports);
|
|
@@ -143,6 +146,15 @@ function isFreeCap(error) {
|
|
|
143
146
|
function isFreeNumberCap(error) {
|
|
144
147
|
return error instanceof BotoZapError && error.code === "free_number_cap";
|
|
145
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
|
+
}
|
|
146
158
|
|
|
147
159
|
// src/resources/ai/upload.ts
|
|
148
160
|
var receipts = /* @__PURE__ */ new WeakMap();
|
|
@@ -4031,7 +4043,7 @@ var AiCredentialsResource = class {
|
|
|
4031
4043
|
get(input) {
|
|
4032
4044
|
return request(this.client, AI_OPERATIONS[11], input);
|
|
4033
4045
|
}
|
|
4034
|
-
/** 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. */
|
|
4035
4047
|
create(input) {
|
|
4036
4048
|
return request(this.client, AI_OPERATIONS[12], input);
|
|
4037
4049
|
}
|
|
@@ -4053,7 +4065,12 @@ var AiProvidersResource = class {
|
|
|
4053
4065
|
this.client = client;
|
|
4054
4066
|
}
|
|
4055
4067
|
client;
|
|
4056
|
-
/**
|
|
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
|
+
*/
|
|
4057
4074
|
get(input) {
|
|
4058
4075
|
return request(this.client, AI_OPERATIONS[16], input);
|
|
4059
4076
|
}
|
|
@@ -5196,7 +5213,8 @@ var Messages = class {
|
|
|
5196
5213
|
to: params.to,
|
|
5197
5214
|
type: "template",
|
|
5198
5215
|
template: params.template,
|
|
5199
|
-
from: params.from
|
|
5216
|
+
from: params.from,
|
|
5217
|
+
...params.consent_basis !== void 0 ? { consent_basis: params.consent_basis } : {}
|
|
5200
5218
|
}
|
|
5201
5219
|
});
|
|
5202
5220
|
return assertSendResult(result);
|
|
@@ -5341,7 +5359,11 @@ var Customers = class {
|
|
|
5341
5359
|
body: params
|
|
5342
5360
|
});
|
|
5343
5361
|
}
|
|
5344
|
-
/**
|
|
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
|
+
*/
|
|
5345
5367
|
update(id, params) {
|
|
5346
5368
|
return this.client.requestItem("PATCH", `/customers/${enc(id)}`, {
|
|
5347
5369
|
body: params
|
|
@@ -5415,6 +5437,19 @@ var Templates = class {
|
|
|
5415
5437
|
body: params
|
|
5416
5438
|
});
|
|
5417
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
|
+
}
|
|
5418
5453
|
};
|
|
5419
5454
|
|
|
5420
5455
|
// src/resources/broadcasts.ts
|
|
@@ -5535,6 +5570,12 @@ var Contacts = class {
|
|
|
5535
5570
|
get(id) {
|
|
5536
5571
|
return this.client.requestItem("GET", `/contacts/${enc3(id)}`);
|
|
5537
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
|
+
*/
|
|
5538
5579
|
create(params) {
|
|
5539
5580
|
return this.client.requestItem("POST", "/contacts", {
|
|
5540
5581
|
body: params
|
|
@@ -5545,10 +5586,38 @@ var Contacts = class {
|
|
|
5545
5586
|
body: params
|
|
5546
5587
|
});
|
|
5547
5588
|
}
|
|
5548
|
-
/**
|
|
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
|
+
*/
|
|
5549
5595
|
delete(id) {
|
|
5550
5596
|
return this.client.request("DELETE", `/contacts/${enc3(id)}`);
|
|
5551
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
|
+
}
|
|
5552
5621
|
};
|
|
5553
5622
|
function enc3(id) {
|
|
5554
5623
|
return encodeURIComponent(id);
|
|
@@ -5633,6 +5702,39 @@ var Conversations = class {
|
|
|
5633
5702
|
options
|
|
5634
5703
|
);
|
|
5635
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
|
+
}
|
|
5636
5738
|
update(id, params) {
|
|
5637
5739
|
return this.client.requestItem(
|
|
5638
5740
|
"PATCH",
|
|
@@ -6078,6 +6180,77 @@ var BillingResource = class {
|
|
|
6078
6180
|
}
|
|
6079
6181
|
};
|
|
6080
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
|
+
|
|
6081
6254
|
// src/resources/read-only.ts
|
|
6082
6255
|
var Users = class {
|
|
6083
6256
|
constructor(client) {
|
|
@@ -6173,6 +6346,10 @@ var BotoZap = class {
|
|
|
6173
6346
|
usage;
|
|
6174
6347
|
/** Plano da Conta e slots adicionais (só chave de API). */
|
|
6175
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;
|
|
6176
6353
|
users;
|
|
6177
6354
|
apiLogs;
|
|
6178
6355
|
webhookDeliveries;
|
|
@@ -6217,6 +6394,8 @@ var BotoZap = class {
|
|
|
6217
6394
|
this.events = new Events(this);
|
|
6218
6395
|
this.usage = new Usage(this);
|
|
6219
6396
|
this.billing = new BillingResource(this);
|
|
6397
|
+
this.exports = new Exports(this);
|
|
6398
|
+
this.teamEvents = new TeamEvents(this);
|
|
6220
6399
|
this.users = new Users(this);
|
|
6221
6400
|
this.apiLogs = new ApiLogs(this);
|
|
6222
6401
|
this.webhookDeliveries = new WebhookDeliveries(this);
|
|
@@ -6435,8 +6614,11 @@ var WEBHOOK_CATEGORIES = [
|
|
|
6435
6614
|
SavedReplies,
|
|
6436
6615
|
WEBHOOK_CATEGORIES,
|
|
6437
6616
|
isBusinessPaymentRequired,
|
|
6617
|
+
isConsentOptedOut,
|
|
6618
|
+
isConsentRevoked,
|
|
6438
6619
|
isFreeCap,
|
|
6439
6620
|
isFreeNumberCap,
|
|
6621
|
+
isNotConnected,
|
|
6440
6622
|
isPlanError
|
|
6441
6623
|
});
|
|
6442
6624
|
//# sourceMappingURL=index.cjs.map
|