@botozap/sdk 0.21.0 → 0.23.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/dist/index.js CHANGED
@@ -3779,6 +3779,25 @@ var AI_OPERATIONS = [
3779
3779
  }
3780
3780
  }
3781
3781
  },
3782
+ // Diagnóstico do agente, o mesmo do painel (paridade tela ⇄ API, out/2026).
3783
+ {
3784
+ group: "agents",
3785
+ name: "diagnostic",
3786
+ method: "GET",
3787
+ path: "/ai/agents/:id/diagnostic",
3788
+ shape: "item",
3789
+ description: "Diagn\xF3stico do agente, o mesmo do painel, para o rascunho ou, sem rascunho, a vers\xE3o publicada: checks com status ok/warning/blocked/unknown, ready e a \xFAltima prova de gera\xE7\xE3o registrada. S\xF3 l\xEA: n\xE3o faz prova nem chamada ao provedor e n\xE3o gera custo. ready=false \xE9 a mesma regra que recusa a publica\xE7\xE3o (diagnostic_blocked).",
3790
+ fields: {
3791
+ customer_id: {
3792
+ type: "uuid",
3793
+ optional: false
3794
+ },
3795
+ id: {
3796
+ type: "uuid",
3797
+ optional: false
3798
+ }
3799
+ }
3800
+ },
3782
3801
  {
3783
3802
  group: "evolution",
3784
3803
  name: "get",
@@ -3954,6 +3973,14 @@ var AiAgentsResource = class {
3954
3973
  capabilityUsage(input) {
3955
3974
  return request(this.client, named("agents", "capabilityUsage"), input);
3956
3975
  }
3976
+ /**
3977
+ * Diagnóstico do agente, o mesmo do painel (rascunho, ou a versão publicada
3978
+ * sem rascunho). Só lê: não faz prova de geração nem chama o provedor.
3979
+ * `ready: false` é a regra que recusa a publicação com `diagnostic_blocked`.
3980
+ */
3981
+ diagnostic(input) {
3982
+ return request(this.client, named("agents", "diagnostic"), input);
3983
+ }
3957
3984
  };
3958
3985
  var AiCredentialsResource = class {
3959
3986
  constructor(client) {
@@ -4906,6 +4933,36 @@ var Journeys = class {
4906
4933
  query: { ...params }
4907
4934
  });
4908
4935
  }
4936
+ /**
4937
+ * Lista os modelos prontos de Régua, os mesmos da galeria de Automações do
4938
+ * painel, com gatilho, texto do template, `variable_map` e os `examples` que
4939
+ * vão à Meta. Scope `journeys:read`.
4940
+ */
4941
+ catalog() {
4942
+ return this.client.requestItem("GET", "/journeys/catalog");
4943
+ }
4944
+ /**
4945
+ * Liga um modelo pronto no Cliente, como "Usar modelo" no painel: cria o
4946
+ * template do modelo no número e o envia à aprovação da Meta (reaproveita o
4947
+ * template se já existe), cria o campo de data do modelo e a Régua. Com o
4948
+ * template aprovado a Régua já nasce ativa e pode enviar mensagens
4949
+ * automáticas; senão fica pausada (`pending_template`) e liga sozinha na
4950
+ * aprovação. Se o modelo já tem Régua no Cliente, responde `created: false`
4951
+ * sem mudar nada, exceto quando ela está pausada com `template_rejected`: aí
4952
+ * reenvia o template (`resubmitted: true`).
4953
+ *
4954
+ * Scope `journeys:write`; exige plano com automações (403 `plan_restricted`).
4955
+ * Recusas: `not_found` (modelo, Cliente ou número), `validation_error` (422,
4956
+ * falta `customer_id` ou o número com mais de um no Cliente), `not_connected`
4957
+ * (409), `meta_error` (422 recusa da Meta; 502 Meta indisponível).
4958
+ */
4959
+ enableModel(key, params) {
4960
+ return this.client.requestItem(
4961
+ "POST",
4962
+ `/journeys/catalog/${encodeURIComponent(key)}/enable`,
4963
+ { body: params }
4964
+ );
4965
+ }
4909
4966
  get(id, params = {}) {
4910
4967
  return this.client.requestItem(
4911
4968
  "GET",
@@ -5125,7 +5182,8 @@ var Messages = class {
5125
5182
  type: "text",
5126
5183
  text: { body: params.text },
5127
5184
  from: params.from,
5128
- ...params.quick_replies !== void 0 ? { quick_replies: params.quick_replies } : {}
5185
+ ...params.quick_replies !== void 0 ? { quick_replies: params.quick_replies } : {},
5186
+ ...replyTo(params.reply_to)
5129
5187
  }
5130
5188
  });
5131
5189
  return assertSendResult(result);
@@ -5139,7 +5197,8 @@ var Messages = class {
5139
5197
  type: "template",
5140
5198
  template: params.template,
5141
5199
  from: params.from,
5142
- ...params.consent_basis !== void 0 ? { consent_basis: params.consent_basis } : {}
5200
+ ...params.consent_basis !== void 0 ? { consent_basis: params.consent_basis } : {},
5201
+ ...replyTo(params.reply_to)
5143
5202
  }
5144
5203
  });
5145
5204
  return assertSendResult(result);
@@ -5153,13 +5212,17 @@ var Messages = class {
5153
5212
  if ("filename" in params && params.filename !== void 0) {
5154
5213
  media.filename = params.filename;
5155
5214
  }
5215
+ if ("voice" in params && params.voice !== void 0) {
5216
+ media.voice = params.voice;
5217
+ }
5156
5218
  const result = await this.client.requestObject("POST", "/messages", {
5157
5219
  idempotencyKey: options.idempotencyKey,
5158
5220
  body: {
5159
5221
  to: params.to,
5160
5222
  from: params.from,
5161
5223
  type: params.type,
5162
- [params.type]: media
5224
+ [params.type]: media,
5225
+ ...replyTo(params.reply_to)
5163
5226
  }
5164
5227
  });
5165
5228
  return assertSendResult(result);
@@ -5176,7 +5239,8 @@ var Messages = class {
5176
5239
  from: params.from,
5177
5240
  type: "interactive",
5178
5241
  interactive: params.interactive,
5179
- ...params.tag !== void 0 ? { tag: params.tag } : {}
5242
+ ...params.tag !== void 0 ? { tag: params.tag } : {},
5243
+ ...replyTo(params.reply_to)
5180
5244
  },
5181
5245
  options
5182
5246
  );
@@ -5191,7 +5255,7 @@ var Messages = class {
5191
5255
  if (params.address !== void 0) location.address = params.address;
5192
5256
  return postMessage(
5193
5257
  this.client,
5194
- { to: params.to, from: params.from, type: "location", location },
5258
+ { to: params.to, from: params.from, type: "location", location, ...replyTo(params.reply_to) },
5195
5259
  options
5196
5260
  );
5197
5261
  }
@@ -5236,6 +5300,9 @@ var Messages = class {
5236
5300
  );
5237
5301
  }
5238
5302
  };
5303
+ function replyTo(value) {
5304
+ return value === void 0 ? {} : { reply_to: { message_id: value.message_id } };
5305
+ }
5239
5306
  async function postMessage(client, body, options) {
5240
5307
  const result = await client.requestObject("POST", "/messages", {
5241
5308
  idempotencyKey: options.idempotencyKey,
@@ -5622,7 +5689,8 @@ var Conversations = class {
5622
5689
  to,
5623
5690
  text: params.text,
5624
5691
  from,
5625
- ...params.quick_replies !== void 0 ? { quick_replies: params.quick_replies } : {}
5692
+ ...params.quick_replies !== void 0 ? { quick_replies: params.quick_replies } : {},
5693
+ ...params.reply_to !== void 0 ? { reply_to: params.reply_to } : {}
5626
5694
  },
5627
5695
  options
5628
5696
  );
@@ -5649,6 +5717,43 @@ var Conversations = class {
5649
5717
  { body: params }
5650
5718
  );
5651
5719
  }
5720
+ /**
5721
+ * Mostra "digitando…" ao contato enquanto a integração prepara a resposta,
5722
+ * como o Painel quando o atendente digita. O sinal vai na última mensagem
5723
+ * recebida do contato, que fica como lida (tiques azuis no WhatsApp, "visto"
5724
+ * no Instagram); a Meta tira o indicador quando a resposta sai ou em ~25 s.
5725
+ * Repetir em menos de 20 s não chama a Meta de novo (`repeated: true`); para
5726
+ * uma resposta demorada, chame de novo a cada 20 s. Sem corpo. Scope
5727
+ * `messages:send`; não aceita chave sandbox.
5728
+ *
5729
+ * Recusas: `no_inbound_message` (409, a conversa não tem mensagem recebida:
5730
+ * template e primeira mensagem não têm "digitando…"), `outside_window`
5731
+ * (WhatsApp) ou `window_closed` (Instagram) com a janela de 24h fechada (422),
5732
+ * `not_connected` (409), `meta_error` (422 na recusa da Meta, 502 se ela
5733
+ * falhar; a resposta em si pode ser enviada normalmente) e `not_found` (404).
5734
+ */
5735
+ typing(id) {
5736
+ return this.client.requestItem(
5737
+ "POST",
5738
+ `/conversations/${enc4(id)}/typing`
5739
+ );
5740
+ }
5741
+ /**
5742
+ * Marca a conversa como lida, como abrir a conversa no Painel: grava
5743
+ * `last_read_at` (a conversa deixa de aparecer como não lida) e, logo depois
5744
+ * da resposta, a última mensagem recebida fica como lida para o contato
5745
+ * (tiques azuis no WhatsApp, "visto" no Instagram). A mesma mensagem não é
5746
+ * marcada duas vezes na Meta: repetir só atualiza `last_read_at`. O aviso ao
5747
+ * contato é de melhor esforço (canal desconectado ou recusa da Meta não mudam
5748
+ * a resposta). Sem corpo. Scope `conversations:write`; aceita chave sandbox
5749
+ * (grava a leitura sem avisar a Meta).
5750
+ */
5751
+ markRead(id) {
5752
+ return this.client.requestItem(
5753
+ "POST",
5754
+ `/conversations/${enc4(id)}/read`
5755
+ );
5756
+ }
5652
5757
  /**
5653
5758
  * Exclui a conversa, com efeito imediato e sem volta: mensagens, notas,
5654
5759
  * atribuições, vínculos com oportunidades e demandas e o que a IA guardou
@@ -5746,11 +5851,106 @@ function enc5(id) {
5746
5851
  }
5747
5852
 
5748
5853
  // src/resources/phone-numbers.ts
5854
+ var PhoneNumberQrCodes = class {
5855
+ constructor(client) {
5856
+ this.client = client;
5857
+ }
5858
+ client;
5859
+ /** Lista os QR codes do número (sem a imagem; use `get`). Scope `numbers:read`. */
5860
+ list(id) {
5861
+ return this.client.requestItem("GET", `/phone_numbers/${enc6(id)}/qr-codes`);
5862
+ }
5863
+ /**
5864
+ * Cria um QR code com mensagem pronta (até 140 caracteres) e devolve
5865
+ * `qr_image_url` (201). NÃO é idempotente: em 504 `meta_unconfirmed`, liste
5866
+ * antes de criar de novo para não duplicar. Scope `numbers:write`.
5867
+ */
5868
+ create(id, params) {
5869
+ return this.client.requestItem("POST", `/phone_numbers/${enc6(id)}/qr-codes`, {
5870
+ body: params
5871
+ });
5872
+ }
5873
+ /**
5874
+ * Um QR code com `qr_image_url` no formato pedido (`PNG` padrão, ou `SVG`).
5875
+ * A URL é temporária, do CDN da Meta: baixe na hora. Scope `numbers:read`.
5876
+ */
5877
+ get(id, code, params = {}) {
5878
+ return this.client.requestItem(
5879
+ "GET",
5880
+ `/phone_numbers/${enc6(id)}/qr-codes/${enc6(code)}`,
5881
+ { query: { image_format: params.image_format } }
5882
+ );
5883
+ }
5884
+ /** Troca a mensagem pronta; código, link e imagem continuam os mesmos. Scope `numbers:write`. */
5885
+ update(id, code, params) {
5886
+ return this.client.requestItem(
5887
+ "PATCH",
5888
+ `/phone_numbers/${enc6(id)}/qr-codes/${enc6(code)}`,
5889
+ { body: { prefilled_message: params.prefilled_message } }
5890
+ );
5891
+ }
5892
+ /**
5893
+ * Apaga o QR code na Meta, SEM VOLTA: quem escanear o código impresso ou
5894
+ * abrir o link passa a ver "expirado". Responde 204. No acesso por OAuth, só
5895
+ * Administrador. Scope `numbers:write`.
5896
+ */
5897
+ delete(id, code) {
5898
+ return this.client.request("DELETE", `/phone_numbers/${enc6(id)}/qr-codes/${enc6(code)}`);
5899
+ }
5900
+ };
5901
+ var PhoneNumberBlockedUsers = class {
5902
+ constructor(client) {
5903
+ this.client = client;
5904
+ }
5905
+ client;
5906
+ /**
5907
+ * Bloqueados do número, 100 por página. A próxima página vem em
5908
+ * `paging.cursors.after` (passe em `after`); `null` quando acabou. Quando o
5909
+ * `wa_id` é de um contato da Conta, vêm `contact_id` e `name`. Scope
5910
+ * `numbers:read`.
5911
+ */
5912
+ list(id, params = {}) {
5913
+ return this.client.requestCursorList(
5914
+ "GET",
5915
+ `/phone_numbers/${enc6(id)}/blocked-users`,
5916
+ { query: { after: params.after } }
5917
+ );
5918
+ }
5919
+ /**
5920
+ * Bloqueia um contato no número, por `contact_id` (contato da Conta neste
5921
+ * número) ou `user` (telefone com DDI). Contato bloqueado não manda mensagem
5922
+ * nem liga, e o número não envia nada para ele. Regra da Meta: só quem
5923
+ * escreveu nas últimas 24 h (senão 422 `block_window_closed`). Outros:
5924
+ * `cannot_block_self`, `blocklist_full` (409), `contact_other_number`,
5925
+ * `channel_not_supported` (contato do Instagram). Scope `numbers:write`.
5926
+ */
5927
+ block(id, params) {
5928
+ return this.client.requestItem("POST", `/phone_numbers/${enc6(id)}/blocked-users`, {
5929
+ body: params
5930
+ });
5931
+ }
5932
+ /**
5933
+ * Desbloqueia pelo `wa_id` da lista (ou telefone com DDI). Para bloquear de
5934
+ * novo, o contato precisa ter escrito nas últimas 24 h. Scope `numbers:write`.
5935
+ */
5936
+ unblock(id, user) {
5937
+ return this.client.requestItem(
5938
+ "DELETE",
5939
+ `/phone_numbers/${enc6(id)}/blocked-users/${enc6(user)}`
5940
+ );
5941
+ }
5942
+ };
5749
5943
  var PhoneNumbers = class {
5750
5944
  constructor(client) {
5751
5945
  this.client = client;
5946
+ this.qrCodes = new PhoneNumberQrCodes(client);
5947
+ this.blockedUsers = new PhoneNumberBlockedUsers(client);
5752
5948
  }
5753
5949
  client;
5950
+ /** QR codes com mensagem pronta e link curto `wa.me/message`. */
5951
+ qrCodes;
5952
+ /** Contatos bloqueados no número. */
5953
+ blockedUsers;
5754
5954
  /** Lista os números da conta (paginação por offset/página). */
5755
5955
  list(params = {}) {
5756
5956
  return this.client.requestOffsetList(
@@ -5788,6 +5988,96 @@ var PhoneNumbers = class {
5788
5988
  delete(id) {
5789
5989
  return this.client.request("DELETE", `/phone_numbers/${enc6(id)}`);
5790
5990
  }
5991
+ /**
5992
+ * Perfil do WhatsApp do número, lido na Meta: Sobre, descrição, endereço,
5993
+ * e-mail, sites, categoria e foto. `editable: false` em coexistência.
5994
+ * Recusas comuns às configurações do número: `sandbox_not_supported`,
5995
+ * `connection_inactive`, `reconnect_required` (409), `meta_rate_limited`
5996
+ * (429), `meta_permission_denied` (403), `meta_unavailable` (504) e
5997
+ * `meta_error` (502). Scope `numbers:read`.
5998
+ */
5999
+ getProfile(id) {
6000
+ return this.client.requestItem("GET", `/phone_numbers/${enc6(id)}/profile`);
6001
+ }
6002
+ /**
6003
+ * Muda campos do perfil na Meta e devolve o perfil relido. É o contato
6004
+ * público do negócio: mude só a pedido de quem opera. Coexistência responde
6005
+ * 409 `coexistence_not_supported`. Pelo acesso OAuth (apps conectados), a
6006
+ * API responde 403: só painel e chave de API mudam o perfil. Em 502
6007
+ * `saved_unread` a Meta recebeu e a releitura falhou: confira com
6008
+ * `getProfile` antes de repetir. Scope `numbers:write`.
6009
+ */
6010
+ updateProfile(id, params) {
6011
+ return this.client.requestItem("PATCH", `/phone_numbers/${enc6(id)}/profile`, {
6012
+ body: params
6013
+ });
6014
+ }
6015
+ /**
6016
+ * Troca a foto do perfil (`multipart/form-data`, campo `file`; JPG ou PNG
6017
+ * até 4 MB) e devolve o perfil relido. Mesmas regras de `updateProfile`
6018
+ * (coexistência 409, OAuth 403). Recusas da foto: `invalid_picture` (422),
6019
+ * `too_large` (413), `missing_file` (422). Scope `numbers:write`.
6020
+ */
6021
+ uploadProfilePhoto(id, params) {
6022
+ const type = params.mime_type ?? params.file.type;
6023
+ const file = params.mime_type && params.file.type !== params.mime_type ? new Blob([params.file], { type: params.mime_type }) : params.file;
6024
+ const form = new FormData();
6025
+ form.append("file", file, params.file_name ?? (type === "image/png" ? "foto.png" : "foto.jpg"));
6026
+ return this.client.requestItem("POST", `/phone_numbers/${enc6(id)}/profile/photo`, {
6027
+ body: form
6028
+ });
6029
+ }
6030
+ /**
6031
+ * Perguntas prontas (`prompts`, ice breakers) e comandos (`commands`) do
6032
+ * número, lidos na Meta. Scope `numbers:read`.
6033
+ */
6034
+ getConversationalAutomation(id) {
6035
+ return this.client.requestItem(
6036
+ "GET",
6037
+ `/phone_numbers/${enc6(id)}/conversational-automation`
6038
+ );
6039
+ }
6040
+ /**
6041
+ * Grava perguntas prontas e/ou comandos na Meta e devolve o que ficou. Campo
6042
+ * omitido mantém; lista vazia remove. Gravar conteúdo exige plano com
6043
+ * automações (403 `plan_restricted`); só remover é livre. Tocar numa
6044
+ * pergunta ou mandar um comando chega como mensagem de texto comum. Scope
6045
+ * `numbers:write`.
6046
+ */
6047
+ updateConversationalAutomation(id, params) {
6048
+ return this.client.requestItem(
6049
+ "PATCH",
6050
+ `/phone_numbers/${enc6(id)}/conversational-automation`,
6051
+ { body: params }
6052
+ );
6053
+ }
6054
+ /** Remove todas as perguntas prontas e comandos do número (livre em qualquer plano). Scope `numbers:write`. */
6055
+ clearConversationalAutomation(id) {
6056
+ return this.client.requestItem(
6057
+ "DELETE",
6058
+ `/phone_numbers/${enc6(id)}/conversational-automation`
6059
+ );
6060
+ }
6061
+ /**
6062
+ * Quanto das conversas antigas do app WhatsApp Business o número importa
6063
+ * (coexistência): estado, janela escolhida e até quando dá para escolher.
6064
+ * Número sem importação (não está em coexistência, ou foi conectado antes
6065
+ * deste recurso) responde 404 `history_import_not_available`. Scope `numbers:read`.
6066
+ */
6067
+ getHistoryImport(id) {
6068
+ return this.client.requestItem("GET", `/phone_numbers/${enc6(id)}/history-import`);
6069
+ }
6070
+ /**
6071
+ * Escolhe quanto importar: `window_days` 0 (nada), 30 ou 180. Vale uma vez
6072
+ * por conexão, enquanto `can_choose`; repetir a mesma escolha devolve 200,
6073
+ * outra escolha depois responde 409 `history_import_locked`. Sem escolha,
6074
+ * o último mês vale 20 h depois da conexão. Scope `numbers:write`.
6075
+ */
6076
+ setHistoryImport(id, params) {
6077
+ return this.client.requestItem("PUT", `/phone_numbers/${enc6(id)}/history-import`, {
6078
+ body: { window_days: params.window_days }
6079
+ });
6080
+ }
5791
6081
  /** Saúde do número (qualidade, limite, status na Meta). */
5792
6082
  health(id) {
5793
6083
  return this.client.requestItem(