@botozap/sdk 0.10.0 → 0.12.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.d.ts CHANGED
@@ -1,33 +1,68 @@
1
1
  /** Status de uma mensagem no envio. A API pode evoluir os valores. */
2
2
  type MessageStatus = "sent" | "delivered" | "read" | "failed" | string;
3
+ /** Canal de uma mensagem/Conta de canal. Valores novos podem surgir. */
4
+ type MessageChannel = "whatsapp" | "instagram" | (string & {});
3
5
  /**
4
6
  * Retorno de POST /v1/messages. Esta rota responde o objeto DIRETO (sem o
5
7
  * envelope `{ data }`), por isso o método `messages.send` devolve `SendResult`
6
8
  * cru. Todas as OUTRAS rotas de item vêm embrulhadas em `{ data }` (helper `ok`).
9
+ *
10
+ * No WhatsApp o identificador da Meta é `wamid`. Fora dele (Instagram) `wamid`
11
+ * vem `null` e o identificador do canal é `external_id` (o `mid` da Meta),
12
+ * acompanhado de `channel`. Ramifique por `channel`/`external_id`, não pela
13
+ * presença de `wamid`.
7
14
  */
8
15
  interface SendResult {
16
+ /** UUID interno da Mensagem; `null` quando a gravação best-effort falhou (ou a reação não tem alvo no histórico). */
9
17
  id: string | null;
10
- wamid: string;
18
+ /** ID da mensagem no WhatsApp; `null` fora do WhatsApp. */
19
+ wamid: string | null;
20
+ /** Identificador da mensagem no canal (o `mid` no Instagram). Ausente em respostas do WhatsApp. */
21
+ external_id?: string | null;
22
+ /** Canal do envio. Ausente em respostas do WhatsApp (o canal implícito). */
23
+ channel?: MessageChannel;
11
24
  to: string;
12
25
  /** Destinatário efetivamente usado após normalização de telefone/BSUID. */
13
26
  sent_to?: string;
14
27
  status: MessageStatus;
15
28
  /** Presente apenas quando a chave é do ambiente sandbox. */
16
29
  sandbox?: boolean;
17
- /** Só em `type: "reaction"`: alvo e ação (`react`/`unreact`). */
18
- type?: "reaction";
30
+ /** Avisos não bloqueantes (ex.: consentimento do Contato). */
31
+ warnings?: {
32
+ code: string;
33
+ message: string;
34
+ }[];
35
+ /**
36
+ * Tipo do envio. WhatsApp: só em `"reaction"`. Instagram: `"text"` ou o tipo
37
+ * da mídia ou `"interactive"`; ausente em reação.
38
+ */
39
+ type?: "reaction" | "interactive" | "text" | "image" | "video" | "audio" | "document" | (string & {});
40
+ /** Só em reação: alvo e ação (`react`/`unreact`). */
19
41
  reaction?: SendReactionResult;
20
42
  }
21
43
  /** Eco de `POST /v1/messages` com `type: "reaction"`. */
22
44
  interface SendReactionResult {
23
- /** UUID interno da mensagem alvo. */
45
+ /** WhatsApp: UUID interno da mensagem alvo. Instagram: o `mid` do alvo. */
24
46
  message_id: string;
25
- /** wamid da mensagem alvo. */
26
- wamid: string;
47
+ /** wamid da mensagem alvo (só no WhatsApp). */
48
+ wamid?: string;
27
49
  /** `""` quando a reação foi retirada. */
28
50
  emoji: string;
29
51
  action: "react" | "unreact";
30
52
  }
53
+ /**
54
+ * Opção de resposta (quick reply) de um direct do Instagram. `text` (padrão)
55
+ * exige `title` (até 20 caracteres) e aceita `payload` (até 1000; sem ele volta
56
+ * o próprio título). `user_phone_number`/`user_email` são preenchidos pelo
57
+ * Instagram com o dado de quem tocou: não mande `title` nem `payload`.
58
+ */
59
+ type QuickReply = {
60
+ content_type?: "text";
61
+ title: string;
62
+ payload?: string;
63
+ } | {
64
+ content_type: "user_phone_number" | "user_email";
65
+ };
31
66
  /** Componente de template do WhatsApp (header, body, button…). */
32
67
  interface TemplatePayload {
33
68
  name: string;
@@ -91,8 +126,34 @@ interface Customer {
91
126
  * Valores novos podem surgir.
92
127
  */
93
128
  type MessageSource = "api" | "app" | "history" | "broadcast" | (string & {});
129
+ /** Marca de edição gravada em `content.edited` (hoje, mensagens do Instagram). */
130
+ interface MessageEdit {
131
+ /** Quantas vezes a mensagem foi editada. */
132
+ count: number;
133
+ /** Quando foi a última edição (ISO 8601). */
134
+ at: string;
135
+ }
136
+ /**
137
+ * Conteúdo de uma Mensagem. A forma varia por tipo e canal; o SDK só tipa os
138
+ * campos transversais.
139
+ */
140
+ interface MessageContent {
141
+ /** Texto (forma do Instagram); no WhatsApp o texto vem em `text.body`. */
142
+ body?: string;
143
+ /** Presente quando o contato editou a mensagem: o conteúdo já é o editado. */
144
+ edited?: MessageEdit;
145
+ [key: string]: unknown;
146
+ }
94
147
  interface Message {
95
148
  id: string;
149
+ /** Canal da Mensagem (`whatsapp` ou `instagram`). */
150
+ channel?: MessageChannel;
151
+ /** Identificador no canal: `wamid` no WhatsApp, `mid` no Instagram. */
152
+ external_id?: string | null;
153
+ /** Conteúdo; `content.edited` aparece quando o contato editou a mensagem. */
154
+ content?: MessageContent;
155
+ /** Quando o remetente apagou a mensagem; `null` quando não apagada. */
156
+ revoked_at?: string | null;
96
157
  /** Origem da mensagem (ver `MessageSource`). */
97
158
  source?: MessageSource;
98
159
  /** Chegada à BotoZap (ISO 8601); chave de `sort=created_at`. */
@@ -139,14 +200,26 @@ interface ConversationReferral {
139
200
  /** Quando o BotoZap recebeu o clique (ISO 8601). */
140
201
  received_at: string | null;
141
202
  }
203
+ /** Bloco `channel_account` embutido em Conversas, Contatos e Mensagens. */
204
+ interface ChannelAccountRef {
205
+ /** UUID interno da Conta de canal (serve de `from` no envio). */
206
+ id: string;
207
+ channel: MessageChannel;
208
+ /** Telefone formatado no WhatsApp, @username no Instagram; pode ser nulo. */
209
+ display: string | null;
210
+ }
142
211
  interface Conversation {
143
212
  id: string;
144
213
  /** Pausa do agente aguardando humano (ISO 8601); null quando não pausado. */
145
214
  agent_paused_at?: string | null;
146
- /** UUID interno do Número da própria Conversa. */
147
- phone_number_id?: string;
215
+ /** Canal da Conversa (`whatsapp` ou `instagram`). */
216
+ channel?: MessageChannel;
217
+ /** Conta de canal por onde a Conversa acontece (Número ou Conta do Instagram). */
218
+ channel_account?: ChannelAccountRef | null;
219
+ /** UUID interno do Número da própria Conversa; `null` fora do WhatsApp. */
220
+ phone_number_id?: string | null;
148
221
  contact?: {
149
- /** Identidade canônica do Contato: telefone ou BSUID. */
222
+ /** Identidade canônica do Contato: telefone ou BSUID no WhatsApp, IGSID no Instagram. */
150
223
  wa_id?: string | null;
151
224
  phone?: string | null;
152
225
  [key: string]: unknown;
@@ -225,6 +298,14 @@ interface BotoZapEvent {
225
298
  id: string;
226
299
  /** Cursor monotônico e contíguo, serializado como string. */
227
300
  cursor: string;
301
+ /**
302
+ * Tipo do Evento (ex.: `whatsapp.message.received`,
303
+ * `instagram.message.received`). No Instagram, `instagram.message.edited`
304
+ * traz o texto novo em `data.edit` e o conteúdo atualizado (com
305
+ * `content.edited`) em `data.message`; `instagram.message.revoked` traz
306
+ * `data.message.revoked_at`, sem o conteúdo apagado. `instagram.message_rule.failed` registra uma falha
307
+ * de automação de Regra de mensagem. Valores novos podem surgir.
308
+ */
228
309
  type: string;
229
310
  /**
230
311
  * WAMID da mensagem do WhatsApp que originou o Evento. `null` fora do
@@ -3424,12 +3505,24 @@ interface ListMessagesParams extends CursorParams {
3424
3505
  has_media?: boolean;
3425
3506
  }
3426
3507
  interface SendTextParams {
3427
- /** Número de destino em E.164, ex: "+5531988887777". */
3508
+ /**
3509
+ * Destinatário: telefone E.164 (ex.: "+5531988887777") ou BSUID no WhatsApp;
3510
+ * IGSID do contato no Instagram. O canal sai da forma do endereço (ou do `from`).
3511
+ */
3428
3512
  to: string;
3429
3513
  /** Corpo do texto. */
3430
3514
  text: string;
3431
- /** ID Meta ou UUID interno do Número de origem (obrigatório se houver mais de um). */
3515
+ /**
3516
+ * Origem: ID Meta ou UUID interno do Número (WhatsApp), id da conta na Meta
3517
+ * ou UUID da Conta de canal (Instagram). Obrigatório quando há mais de uma
3518
+ * origem do mesmo canal.
3519
+ */
3432
3520
  from?: string;
3521
+ /**
3522
+ * Opções de resposta (só Instagram, só com texto, até 13, dentro da janela de
3523
+ * 24h). No WhatsApp a API recusa com 422 `channel_not_supported`.
3524
+ */
3525
+ quick_replies?: QuickReply[];
3433
3526
  }
3434
3527
  interface SendTemplateParams {
3435
3528
  to: string;
@@ -3465,6 +3558,11 @@ interface SendDocumentParams {
3465
3558
  filename?: string;
3466
3559
  from?: string;
3467
3560
  }
3561
+ /**
3562
+ * Mídia por URL pública. `to` aceita telefone/BSUID (WhatsApp) ou IGSID
3563
+ * (Instagram); `from` aceita a origem de qualquer canal. No Instagram não
3564
+ * existe `caption`: a API recusa com 422 `unsupported_caption`.
3565
+ */
3468
3566
  type SendMediaParams = SendImageParams | SendVideoParams | SendAudioParams | SendDocumentParams;
3469
3567
  /** Header de `interactive` (texto; mídia só em button e cta_url). */
3470
3568
  type InteractiveHeader = {
@@ -3539,12 +3637,51 @@ interface InteractiveCtaUrlPayload extends InteractiveBase {
3539
3637
  };
3540
3638
  };
3541
3639
  }
3542
- /** Objeto `interactive` no formato da Cloud API (validado pela API). */
3543
- type InteractivePayload = InteractiveButtonPayload | InteractiveListPayload | InteractiveCtaUrlPayload;
3640
+ /** Botão do Instagram: abrir link ou enviar postback (até 3 por mensagem/card). */
3641
+ type InstagramInteractiveButton = {
3642
+ type: "web_url";
3643
+ title: string;
3644
+ url: string;
3645
+ } | {
3646
+ type: "postback";
3647
+ title: string;
3648
+ payload: string;
3649
+ };
3650
+ /** Instagram: texto (até 640 caracteres) e 1–3 botões. */
3651
+ interface InstagramInteractiveButtonPayload {
3652
+ type: "button";
3653
+ body: {
3654
+ text: string;
3655
+ };
3656
+ action: {
3657
+ buttons: InstagramInteractiveButton[];
3658
+ };
3659
+ }
3660
+ /** Card Instagram: título e ao menos uma propriedade adicional. */
3661
+ interface InstagramGenericElement {
3662
+ title: string;
3663
+ subtitle?: string;
3664
+ image_url?: string;
3665
+ default_action?: {
3666
+ type: "web_url";
3667
+ url: string;
3668
+ };
3669
+ buttons?: InstagramInteractiveButton[];
3670
+ }
3671
+ /** Instagram: card único ou galeria com 1–10 elementos. */
3672
+ interface InstagramInteractiveGenericPayload {
3673
+ type: "generic";
3674
+ elements: InstagramGenericElement[];
3675
+ }
3676
+ type InstagramInteractivePayload = InstagramInteractiveButtonPayload | InstagramInteractiveGenericPayload;
3677
+ /** Objeto `interactive` por canal; os limites são validados pela API. */
3678
+ type InteractivePayload = InteractiveButtonPayload | InteractiveListPayload | InteractiveCtaUrlPayload | InstagramInteractivePayload;
3544
3679
  interface SendInteractiveParams {
3545
3680
  to: string;
3546
3681
  interactive: InteractivePayload;
3547
3682
  from?: string;
3683
+ /** Instagram: exceção human_agent, sujeita à flag e janela da API. */
3684
+ tag?: "human_agent";
3548
3685
  }
3549
3686
  interface SendLocationParams {
3550
3687
  to: string;
@@ -3556,7 +3693,10 @@ interface SendLocationParams {
3556
3693
  }
3557
3694
  interface SendReactionParams {
3558
3695
  to: string;
3559
- /** UUID interno ou wamid da mensagem RECEBIDA do contato (até 30 dias). */
3696
+ /**
3697
+ * Mensagem RECEBIDA do contato: UUID interno ou wamid no WhatsApp (até 30
3698
+ * dias); o `mid` (`external_id`) no Instagram.
3699
+ */
3560
3700
  message_id: string;
3561
3701
  /** Emoji da reação; `""` retira a reação. */
3562
3702
  emoji: string;
@@ -3577,15 +3717,15 @@ declare class Messages {
3577
3717
  /** Envia mídia por URL pública. */
3578
3718
  sendMedia(params: SendMediaParams, options?: SendOptions): Promise<SendResult>;
3579
3719
  /**
3580
- * Envia botões de resposta, lista ou botão de link (WhatsApp; mensagem livre,
3581
- * exige janela de 24h aberta).
3720
+ * Envia button/list/cta_url no WhatsApp ou button/generic no Instagram.
3721
+ * Mensagem livre sujeita à janela do canal.
3582
3722
  */
3583
3723
  sendInteractive(params: SendInteractiveParams, options?: SendOptions): Promise<SendResult>;
3584
3724
  /** Envia uma localização (WhatsApp; mensagem livre). */
3585
3725
  sendLocation(params: SendLocationParams, options?: SendOptions): Promise<SendResult>;
3586
3726
  /**
3587
- * Reage a uma mensagem recebida (WhatsApp). `emoji: ""` retira a reação.
3588
- * O retorno traz `reaction` com o alvo e a ação.
3727
+ * Reage a uma mensagem recebida (WhatsApp ou Instagram). `emoji: ""` retira
3728
+ * a reação. O retorno traz `reaction` com o alvo e a ação.
3589
3729
  */
3590
3730
  sendReaction(params: SendReactionParams, options?: SendOptions): Promise<SendResult>;
3591
3731
  /** Lista as mensagens da conta (paginação por cursor). */
@@ -3891,6 +4031,10 @@ interface ListConversationsParams extends CursorParams {
3891
4031
  contact?: string;
3892
4032
  /** Alias de busca por contato (usado quando `contact` não é informado). */
3893
4033
  phone_number?: string;
4034
+ /** Canal da Conversa: `whatsapp` ou `instagram` (outro valor é 422). */
4035
+ channel?: MessageChannel;
4036
+ /** UUID da Conta de canal (Número ou Conta do Instagram) de origem. */
4037
+ channel_account_id?: string;
3894
4038
  }
3895
4039
  interface CreateAssignmentParams {
3896
4040
  /** Membro a quem atribuir a conversa. */
@@ -3900,6 +4044,8 @@ interface CreateAssignmentParams {
3900
4044
  interface ReplyConversationParams {
3901
4045
  /** Corpo da resposta livre dentro da janela de 24h. */
3902
4046
  text: string;
4047
+ /** Opções de resposta (só em Conversas do Instagram; ver `messages.send`). */
4048
+ quick_replies?: QuickReply[];
3903
4049
  }
3904
4050
  /** Conversas (read + status) e atribuições a membros. */
3905
4051
  declare class Conversations {
@@ -3914,9 +4060,11 @@ declare class Conversations {
3914
4060
  list(params?: ListConversationsParams): Promise<CursorList<Conversation>>;
3915
4061
  get(id: string): Promise<Conversation>;
3916
4062
  /**
3917
- * Responde uma Conversa sem o chamador precisar combinar Contato e Número.
3918
- * A leitura e o envio usam a mesma chave; o POST /messages revalida Conta,
3919
- * ambiente, identidade, janela, quota e billing antes de chamar a Meta.
4063
+ * Responde uma Conversa sem o chamador precisar combinar Contato e origem.
4064
+ * No WhatsApp a origem é o Número da Conversa; no Instagram, a Conta de
4065
+ * canal (`channel_account.id`). A leitura e o envio usam a mesma chave; o
4066
+ * POST /messages revalida Conta, ambiente, identidade, janela, quota e
4067
+ * billing antes de chamar a Meta.
3920
4068
  */
3921
4069
  reply(id: string, params: ReplyConversationParams, options?: SendOptions): Promise<SendResult>;
3922
4070
  update(id: string, params: Record<string, unknown>): Promise<Conversation>;
@@ -4016,6 +4164,324 @@ declare class PhoneNumbers {
4016
4164
  health(id: string): Promise<Record<string, unknown>>;
4017
4165
  }
4018
4166
 
4167
+ /**
4168
+ * Saúde do token de uma Conta do Instagram: `ok`; `expiring` (vence em até 7
4169
+ * dias, a renovação automática ainda tenta); `expired`; `invalid` (a Meta
4170
+ * recusou o token); `revoked` (conta desconectada); `unknown` (conexão
4171
+ * pendente). Com `expired`, `invalid` ou `revoked` os envios falham até
4172
+ * reconectar a conta.
4173
+ */
4174
+ type InstagramTokenStatus = "ok" | "expiring" | "expired" | "invalid" | "revoked" | "unknown" | (string & {});
4175
+ /**
4176
+ * Conta de canal: o endpoint concreto de um Cliente num canal — o Número no
4177
+ * WhatsApp, a Conta do Instagram no Instagram. O `id` (UUID) serve de `from`
4178
+ * no envio e de filtro `channel_account_id` nas listagens.
4179
+ */
4180
+ interface ChannelAccount {
4181
+ id: string;
4182
+ channel: MessageChannel;
4183
+ customer_id: string;
4184
+ /** Telefone formatado no WhatsApp, @username no Instagram; pode ser nulo. */
4185
+ display: string | null;
4186
+ status: string;
4187
+ sandbox: boolean;
4188
+ /** Id do endpoint na Meta: `phone_number_id` no WhatsApp, id da conta no Instagram. */
4189
+ external_id: string;
4190
+ created_at: string;
4191
+ updated_at: string;
4192
+ /** Detalhes do Número; só em Contas de canal do WhatsApp. */
4193
+ whatsapp?: {
4194
+ id: string | null;
4195
+ phone_number_id: string;
4196
+ display_phone_number: string | null;
4197
+ verified_name: string | null;
4198
+ quality_rating: string | null;
4199
+ type: string | null;
4200
+ waba_connection_id: string | null;
4201
+ waba_id: string | null;
4202
+ connection_status: string | null;
4203
+ token_status: string | null;
4204
+ };
4205
+ /** Detalhes e saúde da conexão; só em Contas de canal do Instagram. Nunca traz o token. */
4206
+ instagram?: {
4207
+ /** Id da conta profissional na Meta (o mesmo `external_id`). */
4208
+ instagram_account_id: string;
4209
+ username: string | null;
4210
+ name: string | null;
4211
+ instagram_connection_id: string | null;
4212
+ connection_status: string | null;
4213
+ token_status: InstagramTokenStatus | null;
4214
+ /** Validade do token atual (60 dias, renovado sozinho a cada ~30). */
4215
+ token_expires_at: string | null;
4216
+ /** Última renovação bem-sucedida do token. */
4217
+ token_refreshed_at: string | null;
4218
+ };
4219
+ [key: string]: unknown;
4220
+ }
4221
+ /** Filtros de `channelAccounts.list` (GET /v1/channel_accounts). */
4222
+ interface ListChannelAccountsParams extends OffsetParams {
4223
+ /** `whatsapp` ou `instagram` (outro valor é 422). */
4224
+ channel?: MessageChannel;
4225
+ /** UUID do Cliente dono das Contas de canal. */
4226
+ customer_id?: string;
4227
+ }
4228
+ /** Estado de uma Regra de comentário. `paused_plan`: ativa, mas pausada pelo plano. */
4229
+ type CommentRuleStatus = "active" | "inactive" | "paused_plan" | (string & {});
4230
+ /**
4231
+ * Regra de comentário do Instagram: um comentário que casa `keyword` (ou
4232
+ * qualquer comentário, quando `null`) no post `media_id` (ou em todos, quando
4233
+ * `null`) recebe a abertura `dm_text` e, opcionalmente, a resposta pública
4234
+ * `reply_text`. Com `dm_button_title`, o toque entrega texto/imagem.
4235
+ */
4236
+ interface CommentRule {
4237
+ id: string;
4238
+ channel_account_id: string;
4239
+ /** Palavra-chave (até 60 caracteres); `null` = qualquer comentário. */
4240
+ keyword: string | null;
4241
+ /** Expressões alternativas; lista vazia = qualquer comentário. */
4242
+ keywords?: string[];
4243
+ excluded_keywords?: string[];
4244
+ reply_variations?: string[];
4245
+ /** Aguarda o próximo post quando true e media_id é null. */
4246
+ next_post?: boolean;
4247
+ next_post_activated_at?: string | null;
4248
+ /** Abertura: 1000 bytes sem botão; 640 caracteres com botão. */
4249
+ dm_text: string;
4250
+ /** Título do botão (20 caracteres); null mantém direct simples. */
4251
+ dm_button_title?: string | null;
4252
+ /** Texto entregue após o toque (1000 bytes). */
4253
+ delivery_text?: string | null;
4254
+ /** URL HTTPS pública de imagem entregue após o toque. */
4255
+ delivery_media?: string | null;
4256
+ /** Resposta pública ao comentário (até 2200 caracteres); `null` = sem resposta. */
4257
+ reply_text: string | null;
4258
+ /** Id numérico do post (`media.id`); `null` = todos os posts. */
4259
+ media_id: string | null;
4260
+ /** Configuração gravada; o efeito real está em `status`. */
4261
+ is_active: boolean;
4262
+ status: CommentRuleStatus;
4263
+ /** `true` quando a regra está ativa mas o plano não permite operá-la. */
4264
+ paused_by_plan: boolean;
4265
+ /** Aviso não bloqueante (regra sem palavra-chave valendo para todos os posts). */
4266
+ notice: string | null;
4267
+ created_at: string;
4268
+ updated_at: string;
4269
+ [key: string]: unknown;
4270
+ }
4271
+ /** Corpo de `createCommentRule` (POST /v1/channel_accounts/:id/comment-rules). */
4272
+ interface CreateCommentRuleParams {
4273
+ /** Texto do direct enviado a quem comentou (obrigatório). */
4274
+ dm_text: string;
4275
+ /** Botão de até 20 caracteres; com botão dm_text aceita até 640 caracteres. */
4276
+ dm_button_title?: string | null;
4277
+ /** Obrigatório com botão; até 1000 bytes. null remove. */
4278
+ delivery_text?: string | null;
4279
+ /** Imagem HTTPS pública sem credenciais; null remove. */
4280
+ delivery_media?: string | null;
4281
+ /** Palavra-chave; `null`/vazio = qualquer comentário. */
4282
+ keyword?: string | null;
4283
+ /** Até 20 expressões (60 caracteres cada); prevalece sobre keyword. */
4284
+ keywords?: string[];
4285
+ /** Até 20 exclusões (60 caracteres cada). */
4286
+ excluded_keywords?: string[];
4287
+ /** Até 10 respostas públicas (2200 caracteres cada); prevalece sobre reply_text. */
4288
+ reply_variations?: string[];
4289
+ /** Próximo post; não combinar com media_id explícito. */
4290
+ next_post?: boolean;
4291
+ /** Resposta pública ao comentário; `null`/vazio = sem resposta. */
4292
+ reply_text?: string | null;
4293
+ /** Id numérico do post; `null`/vazio = todos os posts. */
4294
+ media_id?: string | null;
4295
+ /** Padrão `true`. */
4296
+ is_active?: boolean;
4297
+ }
4298
+ /** Corpo de `updateCommentRule` (PATCH): só os campos enviados mudam. */
4299
+ type UpdateCommentRuleParams = Partial<CreateCommentRuleParams>;
4300
+ /** Resultado da exclusão de uma Regra de comentário. */
4301
+ interface DeleteCommentRuleResult {
4302
+ id: string;
4303
+ deleted: true;
4304
+ }
4305
+ /** Gatilhos aceitos pelas Regras de mensagem do Instagram. */
4306
+ type MessageRuleTrigger = "keyword" | "story_reply" | "story_mention" | "share" | "ref" | "ad";
4307
+ type FixedRuleMessage = {
4308
+ type: "text";
4309
+ text: string;
4310
+ quick_replies?: QuickReply[];
4311
+ } | {
4312
+ type: "image" | "video" | "audio" | "document";
4313
+ link: string;
4314
+ filename?: string;
4315
+ } | {
4316
+ type: "interactive";
4317
+ interactive: InstagramInteractivePayload;
4318
+ };
4319
+ type MessageRuleAction = {
4320
+ type: "message";
4321
+ message: FixedRuleMessage;
4322
+ } | {
4323
+ type: "agent";
4324
+ agent_id: string;
4325
+ router_id?: never;
4326
+ } | {
4327
+ type: "agent";
4328
+ router_id: string;
4329
+ agent_id?: never;
4330
+ } | {
4331
+ type: "stage";
4332
+ stage_id: string | null;
4333
+ } | {
4334
+ type: "tags";
4335
+ add?: string[];
4336
+ remove?: string[];
4337
+ } | {
4338
+ type: "assign";
4339
+ user_id: string;
4340
+ };
4341
+ /** POST: a API valida combinações de gatilho e ações. */
4342
+ interface CreateMessageRuleParams {
4343
+ /** 1–100 caracteres. */
4344
+ name: string;
4345
+ trigger: MessageRuleTrigger;
4346
+ /** Até 20 expressões de 60 caracteres; keyword exige ao menos uma. */
4347
+ keywords?: string[];
4348
+ excluded_keywords?: string[];
4349
+ /** Só em story_reply, até 200 caracteres. */
4350
+ story_contains?: string | null;
4351
+ /** Só em ref; ausente/null gera ref no servidor. */
4352
+ ref?: string | null;
4353
+ /** Só em ad, até 32 dígitos. */
4354
+ ad_id?: string | null;
4355
+ /** Inteiro 0–1000; padrão 100. Menor prioridade vence. */
4356
+ priority?: number;
4357
+ is_active?: boolean;
4358
+ /** 1–5 ações; no máximo uma de cada tipo. */
4359
+ actions: MessageRuleAction[];
4360
+ }
4361
+ type UpdateMessageRuleParams = Partial<CreateMessageRuleParams>;
4362
+ interface MessageRule {
4363
+ id: string;
4364
+ account_id: string;
4365
+ channel_account_id: string;
4366
+ name: string;
4367
+ trigger: MessageRuleTrigger;
4368
+ keywords: string[];
4369
+ excluded_keywords: string[];
4370
+ story_contains: string | null;
4371
+ ref: string | null;
4372
+ ad_id: string | null;
4373
+ priority: number;
4374
+ is_active: boolean;
4375
+ actions: MessageRuleAction[];
4376
+ created_at: string;
4377
+ updated_at: string;
4378
+ }
4379
+ interface DeleteMessageRuleResult {
4380
+ id: string;
4381
+ deleted: true;
4382
+ }
4383
+ interface CommentRuleMetricsParams {
4384
+ /** ISO 8601 com fuso; from deve ser anterior a to. */
4385
+ from: string;
4386
+ to: string;
4387
+ }
4388
+ interface CommentRuleCounters {
4389
+ comments_matched: number;
4390
+ dms_delivered: number;
4391
+ public_replies: number;
4392
+ dm_touches: number;
4393
+ conversations_opened: number;
4394
+ /** Razão, não percentual; null sem DM entregue. Pode superar 1. */
4395
+ touch_rate: number | null;
4396
+ }
4397
+ interface CommentRuleMetrics extends CommentRuleMetricsParams {
4398
+ rule_id: string;
4399
+ channel_account_id: string;
4400
+ totals: CommentRuleCounters;
4401
+ posts: (CommentRuleCounters & {
4402
+ media_id: string | null;
4403
+ })[];
4404
+ }
4405
+ interface InstagramIceBreaker {
4406
+ question: string;
4407
+ payload: string;
4408
+ }
4409
+ type InstagramPersistentMenuItem = {
4410
+ type: "postback";
4411
+ title: string;
4412
+ payload: string;
4413
+ } | {
4414
+ type: "web_url";
4415
+ title: string;
4416
+ url: string;
4417
+ };
4418
+ /** Até 4 perguntas e 5 itens no menu. */
4419
+ interface MessengerProfileConfig {
4420
+ ice_breakers: InstagramIceBreaker[];
4421
+ persistent_menu: InstagramPersistentMenuItem[];
4422
+ }
4423
+ /** Ausente preserva a seção; null ou [] remove. */
4424
+ interface UpdateMessengerProfileParams {
4425
+ ice_breakers?: InstagramIceBreaker[] | null;
4426
+ persistent_menu?: InstagramPersistentMenuItem[] | null;
4427
+ }
4428
+ /** Espelho desejado e confirmação de aplicação na Meta. */
4429
+ interface MessengerProfile {
4430
+ channel_account_id: string;
4431
+ config: MessengerProfileConfig;
4432
+ revision: number;
4433
+ sync_status: string;
4434
+ synced_at: string | null;
4435
+ last_error_code: number | null;
4436
+ updated_at: string | null;
4437
+ }
4438
+ /** Contas de canal e configurações do Instagram. */
4439
+ declare class ChannelAccounts {
4440
+ private readonly client;
4441
+ constructor(client: BotoZap);
4442
+ /** Lista as Contas de canal da conta (paginação por offset/página). numbers:read. */
4443
+ list(params?: ListChannelAccountsParams): Promise<OffsetList<ChannelAccount>>;
4444
+ /** Busca uma Conta de canal pelo UUID interno ou pelo id na Meta (`external_id`). numbers:read. */
4445
+ get(id: string): Promise<ChannelAccount>;
4446
+ /** Lista as Regras de comentário de uma Conta do Instagram (UUID). comment-rules:read. */
4447
+ listCommentRules(channelAccountId: string, params?: OffsetParams): Promise<OffsetList<CommentRule>>;
4448
+ /** Busca uma Regra de comentário. comment-rules:read. */
4449
+ getCommentRule(channelAccountId: string, ruleId: string): Promise<CommentRule>;
4450
+ /**
4451
+ * Cria uma Regra de comentário. comment-rules:write. Exige plano que inclua
4452
+ * Regras de comentário (senão 422 `plan_restricted`); palavra-chave repetida
4453
+ * para o mesmo alvo é 409 `duplicate_rule`.
4454
+ */
4455
+ createCommentRule(channelAccountId: string, params: CreateCommentRuleParams): Promise<CommentRule>;
4456
+ /**
4457
+ * Altera uma Regra de comentário (só os campos enviados). comment-rules:write.
4458
+ * `is_active: false` desliga a regra.
4459
+ */
4460
+ updateCommentRule(channelAccountId: string, ruleId: string, params: UpdateCommentRuleParams): Promise<CommentRule>;
4461
+ /** Exclui uma Regra de comentário. comment-rules:write. */
4462
+ deleteCommentRule(channelAccountId: string, ruleId: string): Promise<DeleteCommentRuleResult>;
4463
+ /** Resultados da Regra por período e post. comment-rules:read. */
4464
+ getCommentRuleMetrics(channelAccountId: string, ruleId: string, params: CommentRuleMetricsParams): Promise<CommentRuleMetrics>;
4465
+ /** Lista Regras de mensagem com paginação offset. message-rules:read. */
4466
+ listMessageRules(channelAccountId: string, params?: OffsetParams): Promise<OffsetList<MessageRule>>;
4467
+ /** Busca uma Regra de mensagem. message-rules:read. */
4468
+ getMessageRule(channelAccountId: string, ruleId: string): Promise<MessageRule>;
4469
+ /** Cria uma Regra de mensagem. message-rules:write. */
4470
+ createMessageRule(channelAccountId: string, params: CreateMessageRuleParams): Promise<MessageRule>;
4471
+ /** PATCH parcial; a API valida o estado final. message-rules:write. */
4472
+ updateMessageRule(channelAccountId: string, ruleId: string, params: UpdateMessageRuleParams): Promise<MessageRule>;
4473
+ /** Exclui a Regra preservando Disparos e Eventos. message-rules:write. */
4474
+ deleteMessageRule(channelAccountId: string, ruleId: string): Promise<DeleteMessageRuleResult>;
4475
+ /** Lê o espelho salvo (sem consultar a Meta). messenger-profile:read; sem sandbox. */
4476
+ getMessengerProfile(channelAccountId: string): Promise<MessengerProfile>;
4477
+ /** Salva/aplica apenas as seções enviadas. messenger-profile:write; sem sandbox. */
4478
+ updateMessengerProfile(channelAccountId: string, params: UpdateMessengerProfileParams): Promise<MessengerProfile>;
4479
+ /** Remove perguntas e menu, conservando configuração vazia. messenger-profile:write. */
4480
+ deleteMessengerProfile(channelAccountId: string): Promise<MessengerProfile>;
4481
+ /** Verifica/reaplica explicitamente o desejado salvo. messenger-profile:write. */
4482
+ syncMessengerProfile(channelAccountId: string): Promise<MessengerProfile>;
4483
+ }
4484
+
4019
4485
  /** Corpo do `POST /v1/media` — espelha o contrato real da rota. */
4020
4486
  interface UploadMediaParams {
4021
4487
  /** URL http(s) de origem do arquivo. A BotoZap baixa (com guard SSRF) e sobe pra Cloud API. */
@@ -4294,6 +4760,8 @@ declare class BotoZap {
4294
4760
  readonly conversations: Conversations;
4295
4761
  readonly webhooks: Webhooks;
4296
4762
  readonly phoneNumbers: PhoneNumbers;
4763
+ /** Contas de canal (WhatsApp e Instagram) e Regras de comentário do Instagram. */
4764
+ readonly channelAccounts: ChannelAccounts;
4297
4765
  readonly contactStages: ContactStages;
4298
4766
  readonly contactFields: ContactFields;
4299
4767
  readonly calendar: Calendar;
@@ -4373,4 +4841,4 @@ declare const PLAN_ERROR_CODES: readonly ["plan_restricted", "free_form_limit_re
4373
4841
  /** True quando o erro é recusa por plano (upgrade resolve; retry não). */
4374
4842
  declare function isPlanError(error: unknown): error is BotoZapError;
4375
4843
 
4376
- export { AI_CONFIGURABLE_PURPOSES, AI_CREDENTIAL_PROVIDERS, AI_OPERATIONS, AI_PURPOSES, type AddRecipientsError, type AddRecipientsResult, AgendaConfiguration, AgendaExceptions, type AgendaRecord, Ai, type AiAgent, type AiAgentConfig, type AiAgentCoverage, type AiAgentInput, type AiAgentVersion, AiAgentsResource, type AiAlert, type AiAlertBulkFilters, type AiAlertListItem, AiAlertsResource, type AiArtifactUploadInput, type AiAudioPricing, type AiBinding, type AiBindingTarget, type AiBudget, type AiBudgetInput, type AiCapabilitySignal, type AiCapabilityUsage, type AiCapabilityUsageList, type AiCase, type AiCaseChat, type AiCaseEvent, type AiCaseKind, type AiCaseReply, type AiCaseReplyInput, type AiCaseSource, AiCasesResource, type AiCatalogItems, type AiCatalogModel, type AiCatalogProduct, type AiCatalogSyncInput, type AiCatalogSyncResult, type AiChannelGate, type AiCommercialDecision, type AiCommercialEffect, type AiCommercialJob, type AiCommercialProposal, AiCommercialProposalsResource, type AiCommercialRequest, type AiCommercialSettings, type AiConfigurablePurpose, type AiContactAuthorization, type AiConversationCheckpoint, type AiCredential, AiCredentialsResource, type AiDraftResult, type AiEligibilityOverview, AiEligibilityResource, type AiEligibilitySettings, type AiEnrollment, type AiEvolution, AiEvolutionResource, type AiEvolutionSource, type AiExecution, type AiExecutionCitations, type AiExecutionSecurity, AiExecutionsResource, type AiField, type AiFlow, type AiFlowGraph, type AiFlowInput, type AiFlowSettings, type AiFlowVersion, type AiFollowupEffect, type AiFollowupEvent, AiFollowupFlowsResource, type AiFollowupPromise, type AiFollowupPromiseDetail, type AiFollowupPromiseStatus, type AiFollowupQueueFilters, type AiFollowupQueuePage, type AiFollowupQueueRow, AiFollowupsResource, type AiGateMode, type AiInference, type AiInferenceOrigin, type AiInferenceOutcome, type AiInferenceSummary, AiInferencesResource, type AiKnowledgeChunk, type AiKnowledgeCitation, type AiKnowledgeConversation, type AiKnowledgeHit, type AiKnowledgeImport, type AiKnowledgePreview, AiKnowledgeResource, type AiKnowledgeSearchDiagnostics, type AiKnowledgeSource, type AiMemory, type AiMemoryEntry, type AiMemoryEntryEvent, AiMemoryResource, type AiModelCatalogSnapshot, type AiModelCatalogSync, type AiNoticeCheck, type AiNoticeEffect, type AiNoticeField, type AiNoticeJob, type AiNoticeSettings, AiNoticesResource, type AiOperation, type AiOperatorMetrics, AiOperatorResource, type AiPage, type AiPlatformSkill, type AiPlatformSkillComposition, type AiPreparedUpload, type AiProposal, AiProposalsResource, type AiProvider, type AiProviderInfo, type AiProviderModel, AiProvidersResource, type AiPurpose, type AiRate, type AiRateInput, type AiRecord, type AiRevision, type AiRouter, type AiRouterConfig, type AiRouterTest, AiRoutersResource, type AiScope, type AiSkill, type AiSkillInput, type AiSkillNearMiss, type AiSkillVersion, AiSkillsResource, type AiSourceKind, type AiStyleAdjustment, type AiStyleAdjustmentId, AiStyleAdjustmentsResource, type AiToolId, type AiTurnPromise, type AiUploadReceiptCallback, AiUploadsResource, AiUsageResource, type AiUsageSummary, type AiUsageTokens, type AiWindow, type ApiLog, type Appointment, type AppointmentAvailability, type AppointmentExceptionInput, type AppointmentFields, type AppointmentHistory, type AppointmentQuery, type AppointmentScheduleInput, type AppointmentServiceInput, type AppointmentStatus, Appointments, type Assignment, type AvailabilityQuery, BotoZap, BotoZapError, type BotoZapErrorCode, type BotoZapEvent, type BotoZapOptions, type Broadcast, type BroadcastRecipient, type BroadcastRecipientInput, Calendar, type CalendarConnection, type CalendarJob, type CalendarSelection, type Contact, type ContactField, ContactFields, type ContactStage, ContactStages, type Conversation, type ConversationEntryPoint, type ConversationNote, type ConversationReferral, type ConversationReminder, type CreateAppointment, type CreateAssignmentParams, type CreateBroadcastParams, type CreateContactParams, type CreateCustomerParams, type CreateDemand, type CreateOpportunity, type CreateSetupLinkParams, type CreateTemplateParams, type CreateWebhookParams, type CrmActivity, type CrmConversation, type CrmFields, type CrmMetadata, type CrmQuery, type CrmRecord, CrmResource, type CursorList, type CursorPaging, type CursorParams, type Customer, type Demand, type DemandFields, type EventList, type EventPaging, Inbox, type InboxMutation, type InboxMutationResult, type InboxState, type InboxTools, type InteractiveButtonPayload, type InteractiveCtaUrlPayload, type InteractiveHeader, type InteractiveListPayload, type InteractivePayload, type Journey, type JourneyConfig, type JourneyEnrollment, type JourneyQuery, type JourneyRun, type JourneyStep, Journeys, type ListApiLogsParams, type ListBroadcastsParams, type ListContactsParams, type ListConversationsParams, type ListEventsParams, type ListMessagesParams, type ListPhoneNumbersParams, type ListRecipientsParams, type ListTemplatesParams, type ListWebhookDeliveriesParams, type Me, type MediaAsset, type MediaUploadResult, type Message, type MessageSort, type MessageSource, type MessageStatus, type MetaCostCategory, type MetaCostDay, type MetaCostEstimate, type MetaCostGroup, type MetaCostReport, type MetaCostSource, type MetaCostSync, type MetaCostUnavailableReason, type MetaCostsParams, type OffsetList, type OffsetMeta, type OffsetParams, type Opportunity, type OpportunityFields, PLAN_ERROR_CODES, type PhoneNumber, Radar, type RadarEntry, type RadarPage, type RadarQuery, type ReplyConversationParams, type RequestOptions, SavedReplies, type SavedReply, type SavedReplyInput, type SavedReplyQuery, type ScheduleBroadcastParams, type SendAudioParams, type SendDocumentParams, type SendFailureDetails, type SendImageParams, type SendInteractiveParams, type SendLocationParams, type SendMediaParams, type SendOptions, type SendReactionParams, type SendReactionResult, type SendResult, type SendTemplateParams, type SendTextParams, type SendVideoParams, type SetupLink, type StageColor, type StageRule, type StageRuleInput, type Template, type TemplatePayload, type UpdateAppointment, type UpdateBroadcastParams, type UpdateContactParams, type UpdateCustomerParams, type UpdatePhoneNumberParams, type UpdateSetupLinkParams, type UpdateWebhookParams, type UploadMediaParams, type User, WEBHOOK_CATEGORIES, type Webhook, type WebhookAuthorizationHeaders, type WebhookCategory, type WebhookDelivery, type WebhookDeliveryStatus, isPlanError };
4844
+ export { AI_CONFIGURABLE_PURPOSES, AI_CREDENTIAL_PROVIDERS, AI_OPERATIONS, AI_PURPOSES, type AddRecipientsError, type AddRecipientsResult, AgendaConfiguration, AgendaExceptions, type AgendaRecord, Ai, type AiAgent, type AiAgentConfig, type AiAgentCoverage, type AiAgentInput, type AiAgentVersion, AiAgentsResource, type AiAlert, type AiAlertBulkFilters, type AiAlertListItem, AiAlertsResource, type AiArtifactUploadInput, type AiAudioPricing, type AiBinding, type AiBindingTarget, type AiBudget, type AiBudgetInput, type AiCapabilitySignal, type AiCapabilityUsage, type AiCapabilityUsageList, type AiCase, type AiCaseChat, type AiCaseEvent, type AiCaseKind, type AiCaseReply, type AiCaseReplyInput, type AiCaseSource, AiCasesResource, type AiCatalogItems, type AiCatalogModel, type AiCatalogProduct, type AiCatalogSyncInput, type AiCatalogSyncResult, type AiChannelGate, type AiCommercialDecision, type AiCommercialEffect, type AiCommercialJob, type AiCommercialProposal, AiCommercialProposalsResource, type AiCommercialRequest, type AiCommercialSettings, type AiConfigurablePurpose, type AiContactAuthorization, type AiConversationCheckpoint, type AiCredential, AiCredentialsResource, type AiDraftResult, type AiEligibilityOverview, AiEligibilityResource, type AiEligibilitySettings, type AiEnrollment, type AiEvolution, AiEvolutionResource, type AiEvolutionSource, type AiExecution, type AiExecutionCitations, type AiExecutionSecurity, AiExecutionsResource, type AiField, type AiFlow, type AiFlowGraph, type AiFlowInput, type AiFlowSettings, type AiFlowVersion, type AiFollowupEffect, type AiFollowupEvent, AiFollowupFlowsResource, type AiFollowupPromise, type AiFollowupPromiseDetail, type AiFollowupPromiseStatus, type AiFollowupQueueFilters, type AiFollowupQueuePage, type AiFollowupQueueRow, AiFollowupsResource, type AiGateMode, type AiInference, type AiInferenceOrigin, type AiInferenceOutcome, type AiInferenceSummary, AiInferencesResource, type AiKnowledgeChunk, type AiKnowledgeCitation, type AiKnowledgeConversation, type AiKnowledgeHit, type AiKnowledgeImport, type AiKnowledgePreview, AiKnowledgeResource, type AiKnowledgeSearchDiagnostics, type AiKnowledgeSource, type AiMemory, type AiMemoryEntry, type AiMemoryEntryEvent, AiMemoryResource, type AiModelCatalogSnapshot, type AiModelCatalogSync, type AiNoticeCheck, type AiNoticeEffect, type AiNoticeField, type AiNoticeJob, type AiNoticeSettings, AiNoticesResource, type AiOperation, type AiOperatorMetrics, AiOperatorResource, type AiPage, type AiPlatformSkill, type AiPlatformSkillComposition, type AiPreparedUpload, type AiProposal, AiProposalsResource, type AiProvider, type AiProviderInfo, type AiProviderModel, AiProvidersResource, type AiPurpose, type AiRate, type AiRateInput, type AiRecord, type AiRevision, type AiRouter, type AiRouterConfig, type AiRouterTest, AiRoutersResource, type AiScope, type AiSkill, type AiSkillInput, type AiSkillNearMiss, type AiSkillVersion, AiSkillsResource, type AiSourceKind, type AiStyleAdjustment, type AiStyleAdjustmentId, AiStyleAdjustmentsResource, type AiToolId, type AiTurnPromise, type AiUploadReceiptCallback, AiUploadsResource, AiUsageResource, type AiUsageSummary, type AiUsageTokens, type AiWindow, type ApiLog, type Appointment, type AppointmentAvailability, type AppointmentExceptionInput, type AppointmentFields, type AppointmentHistory, type AppointmentQuery, type AppointmentScheduleInput, type AppointmentServiceInput, type AppointmentStatus, Appointments, type Assignment, type AvailabilityQuery, BotoZap, BotoZapError, type BotoZapErrorCode, type BotoZapEvent, type BotoZapOptions, type Broadcast, type BroadcastRecipient, type BroadcastRecipientInput, Calendar, type CalendarConnection, type CalendarJob, type CalendarSelection, type ChannelAccount, type ChannelAccountRef, ChannelAccounts, type CommentRule, type CommentRuleCounters, type CommentRuleMetrics, type CommentRuleMetricsParams, type CommentRuleStatus, type Contact, type ContactField, ContactFields, type ContactStage, ContactStages, type Conversation, type ConversationEntryPoint, type ConversationNote, type ConversationReferral, type ConversationReminder, type CreateAppointment, type CreateAssignmentParams, type CreateBroadcastParams, type CreateCommentRuleParams, type CreateContactParams, type CreateCustomerParams, type CreateDemand, type CreateMessageRuleParams, type CreateOpportunity, type CreateSetupLinkParams, type CreateTemplateParams, type CreateWebhookParams, type CrmActivity, type CrmConversation, type CrmFields, type CrmMetadata, type CrmQuery, type CrmRecord, CrmResource, type CursorList, type CursorPaging, type CursorParams, type Customer, type DeleteCommentRuleResult, type DeleteMessageRuleResult, type Demand, type DemandFields, type EventList, type EventPaging, type FixedRuleMessage, Inbox, type InboxMutation, type InboxMutationResult, type InboxState, type InboxTools, type InstagramGenericElement, type InstagramIceBreaker, type InstagramInteractiveButton, type InstagramInteractiveButtonPayload, type InstagramInteractiveGenericPayload, type InstagramInteractivePayload, type InstagramPersistentMenuItem, type InstagramTokenStatus, type InteractiveButtonPayload, type InteractiveCtaUrlPayload, type InteractiveHeader, type InteractiveListPayload, type InteractivePayload, type Journey, type JourneyConfig, type JourneyEnrollment, type JourneyQuery, type JourneyRun, type JourneyStep, Journeys, type ListApiLogsParams, type ListBroadcastsParams, type ListChannelAccountsParams, type ListContactsParams, type ListConversationsParams, type ListEventsParams, type ListMessagesParams, type ListPhoneNumbersParams, type ListRecipientsParams, type ListTemplatesParams, type ListWebhookDeliveriesParams, type Me, type MediaAsset, type MediaUploadResult, type Message, type MessageChannel, type MessageContent, type MessageEdit, type MessageRule, type MessageRuleAction, type MessageRuleTrigger, type MessageSort, type MessageSource, type MessageStatus, type MessengerProfile, type MessengerProfileConfig, type MetaCostCategory, type MetaCostDay, type MetaCostEstimate, type MetaCostGroup, type MetaCostReport, type MetaCostSource, type MetaCostSync, type MetaCostUnavailableReason, type MetaCostsParams, type OffsetList, type OffsetMeta, type OffsetParams, type Opportunity, type OpportunityFields, PLAN_ERROR_CODES, type PhoneNumber, type QuickReply, Radar, type RadarEntry, type RadarPage, type RadarQuery, type ReplyConversationParams, type RequestOptions, SavedReplies, type SavedReply, type SavedReplyInput, type SavedReplyQuery, type ScheduleBroadcastParams, type SendAudioParams, type SendDocumentParams, type SendFailureDetails, type SendImageParams, type SendInteractiveParams, type SendLocationParams, type SendMediaParams, type SendOptions, type SendReactionParams, type SendReactionResult, type SendResult, type SendTemplateParams, type SendTextParams, type SendVideoParams, type SetupLink, type StageColor, type StageRule, type StageRuleInput, type Template, type TemplatePayload, type UpdateAppointment, type UpdateBroadcastParams, type UpdateCommentRuleParams, type UpdateContactParams, type UpdateCustomerParams, type UpdateMessageRuleParams, type UpdateMessengerProfileParams, type UpdatePhoneNumberParams, type UpdateSetupLinkParams, type UpdateWebhookParams, type UploadMediaParams, type User, WEBHOOK_CATEGORIES, type Webhook, type WebhookAuthorizationHeaders, type WebhookCategory, type WebhookDelivery, type WebhookDeliveryStatus, isPlanError };