termo_core 0.1.3 → 0.1.4
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/flow/rotas.d.ts +0 -849
- package/dist/flow/rotas.js +0 -1178
- package/dist/flow/tipos.d.ts +0 -688
- package/dist/portal/rotas.d.ts +54 -4
- package/dist/portal/rotas.js +86 -3
- package/dist/portal/tipos.d.ts +53 -3
- package/package.json +1 -1
package/dist/flow/rotas.d.ts
CHANGED
|
@@ -1,719 +1,6 @@
|
|
|
1
1
|
import type * as tipos from "./tipos.js";
|
|
2
2
|
import type { CredencialDeAcesso } from "../base/credencial.js";
|
|
3
3
|
import { type OpcoesDaChamada } from "../base/requisicao.js";
|
|
4
|
-
/**
|
|
5
|
-
* Parâmetros de consulta e de cabeçalho de `/auth`.
|
|
6
|
-
*/
|
|
7
|
-
export interface ParametrosDeBuscarPaginadorAuth {
|
|
8
|
-
pagina?: number;
|
|
9
|
-
tamanho?: number;
|
|
10
|
-
}
|
|
11
|
-
/**
|
|
12
|
-
* Parâmetros de consulta e de cabeçalho de `/auth/autocomplete`.
|
|
13
|
-
*/
|
|
14
|
-
export interface ParametrosDeBuscarAutoCompleteAuth {
|
|
15
|
-
busca?: string;
|
|
16
|
-
perfil?: string;
|
|
17
|
-
pagina?: number;
|
|
18
|
-
tamanho?: number;
|
|
19
|
-
}
|
|
20
|
-
/**
|
|
21
|
-
* Parâmetros de consulta e de cabeçalho de `/auth/filtro`.
|
|
22
|
-
*/
|
|
23
|
-
export interface ParametrosDeBuscarPeloFiltroAuth {
|
|
24
|
-
email?: string;
|
|
25
|
-
perfil?: string;
|
|
26
|
-
ativo?: boolean;
|
|
27
|
-
}
|
|
28
|
-
/**
|
|
29
|
-
* Parâmetros de consulta e de cabeçalho de `/cliente`.
|
|
30
|
-
*/
|
|
31
|
-
export interface ParametrosDeBuscarPaginadorCliente {
|
|
32
|
-
pagina?: number;
|
|
33
|
-
tamanho?: number;
|
|
34
|
-
busca?: string;
|
|
35
|
-
ativo?: boolean;
|
|
36
|
-
atendente_ativo?: boolean;
|
|
37
|
-
estados?: string;
|
|
38
|
-
}
|
|
39
|
-
/**
|
|
40
|
-
* Parâmetros de consulta e de cabeçalho de `/cliente/autocomplete`.
|
|
41
|
-
*/
|
|
42
|
-
export interface ParametrosDeBuscarAutoCompleteCliente {
|
|
43
|
-
busca?: string;
|
|
44
|
-
pagina?: number;
|
|
45
|
-
tamanho?: number;
|
|
46
|
-
}
|
|
47
|
-
/**
|
|
48
|
-
* Parâmetros de consulta e de cabeçalho de `/cliente/filtro`.
|
|
49
|
-
*/
|
|
50
|
-
export interface ParametrosDeBuscarPeloFiltroCliente {
|
|
51
|
-
razao_social?: string;
|
|
52
|
-
cnpj?: string;
|
|
53
|
-
email?: string;
|
|
54
|
-
cidade?: string;
|
|
55
|
-
estado?: string;
|
|
56
|
-
telefone?: string;
|
|
57
|
-
ativo?: boolean;
|
|
58
|
-
atendente_ativo?: boolean;
|
|
59
|
-
}
|
|
60
|
-
/**
|
|
61
|
-
* Parâmetros de consulta e de cabeçalho de `/colaborador`.
|
|
62
|
-
*/
|
|
63
|
-
export interface ParametrosDeBuscarPaginadorColaborador {
|
|
64
|
-
pagina?: number;
|
|
65
|
-
tamanho?: number;
|
|
66
|
-
nome?: string;
|
|
67
|
-
setor?: string;
|
|
68
|
-
cargo?: string;
|
|
69
|
-
ativo?: boolean;
|
|
70
|
-
}
|
|
71
|
-
/**
|
|
72
|
-
* Parâmetros de consulta e de cabeçalho de `/colaborador/autocomplete`.
|
|
73
|
-
*/
|
|
74
|
-
export interface ParametrosDeBuscarAutoCompleteColaborador {
|
|
75
|
-
busca?: string;
|
|
76
|
-
pagina?: number;
|
|
77
|
-
tamanho?: number;
|
|
78
|
-
}
|
|
79
|
-
/**
|
|
80
|
-
* Parâmetros de consulta e de cabeçalho de `/colaborador/filtro`.
|
|
81
|
-
*/
|
|
82
|
-
export interface ParametrosDeBuscarPeloFiltroColaborador {
|
|
83
|
-
busca?: string;
|
|
84
|
-
nome?: string;
|
|
85
|
-
email?: string;
|
|
86
|
-
setor?: string;
|
|
87
|
-
cargo?: string;
|
|
88
|
-
ativo?: boolean;
|
|
89
|
-
perfil_acesso_id?: string;
|
|
90
|
-
}
|
|
91
|
-
/**
|
|
92
|
-
* Parâmetros de consulta e de cabeçalho de `/config_system_chatwoot`.
|
|
93
|
-
*/
|
|
94
|
-
export interface ParametrosDeBuscarPaginadorConfigSystemChatwoot {
|
|
95
|
-
pagina?: number;
|
|
96
|
-
tamanho?: number;
|
|
97
|
-
}
|
|
98
|
-
/**
|
|
99
|
-
* Parâmetros de consulta e de cabeçalho de `/config_system_chatwoot/autocomplete`.
|
|
100
|
-
*/
|
|
101
|
-
export interface ParametrosDeBuscarAutoCompleteConfigSystemChatwoot {
|
|
102
|
-
busca?: string;
|
|
103
|
-
pagina?: number;
|
|
104
|
-
tamanho?: number;
|
|
105
|
-
}
|
|
106
|
-
/**
|
|
107
|
-
* Parâmetros de consulta e de cabeçalho de `/config_system_chatwoot/filtro`.
|
|
108
|
-
*/
|
|
109
|
-
export interface ParametrosDeBuscarPeloFiltroConfigSystemChatwoot {
|
|
110
|
-
nome?: string;
|
|
111
|
-
endereco?: string;
|
|
112
|
-
ativo?: boolean;
|
|
113
|
-
}
|
|
114
|
-
/**
|
|
115
|
-
* Parâmetros de consulta e de cabeçalho de `/config_system_whatsapp/autocomplete`.
|
|
116
|
-
*/
|
|
117
|
-
export interface ParametrosDeBuscarAutoCompleteConfigSystemWhatsapp {
|
|
118
|
-
busca?: string;
|
|
119
|
-
pagina?: number;
|
|
120
|
-
tamanho?: number;
|
|
121
|
-
}
|
|
122
|
-
/**
|
|
123
|
-
* Parâmetros de consulta e de cabeçalho de `/config_system_z_api/autocomplete`.
|
|
124
|
-
*/
|
|
125
|
-
export interface ParametrosDeBuscarAutoCompleteConfigSystemZApi {
|
|
126
|
-
busca?: string;
|
|
127
|
-
pagina?: number;
|
|
128
|
-
tamanho?: number;
|
|
129
|
-
}
|
|
130
|
-
/**
|
|
131
|
-
* Parâmetros de consulta e de cabeçalho de `/conversa`.
|
|
132
|
-
*/
|
|
133
|
-
export interface ParametrosDeBuscarPaginadorConversa {
|
|
134
|
-
pagina?: number;
|
|
135
|
-
tamanho?: number;
|
|
136
|
-
status?: string;
|
|
137
|
-
}
|
|
138
|
-
/**
|
|
139
|
-
* Parâmetros de consulta e de cabeçalho de `/conversa/autocomplete`.
|
|
140
|
-
*/
|
|
141
|
-
export interface ParametrosDeBuscarAutoCompleteConversa {
|
|
142
|
-
busca?: string;
|
|
143
|
-
pagina?: number;
|
|
144
|
-
tamanho?: number;
|
|
145
|
-
}
|
|
146
|
-
/**
|
|
147
|
-
* Parâmetros de consulta e de cabeçalho de `/conversa/filtro`.
|
|
148
|
-
*/
|
|
149
|
-
export interface ParametrosDeBuscarPeloFiltroConversa {
|
|
150
|
-
cliente_id?: string;
|
|
151
|
-
robo_id?: string;
|
|
152
|
-
config_system_z_api_id?: string;
|
|
153
|
-
chatwoot_conversa_id?: number;
|
|
154
|
-
status?: string;
|
|
155
|
-
contato?: string;
|
|
156
|
-
texto?: string;
|
|
157
|
-
}
|
|
158
|
-
/**
|
|
159
|
-
* Parâmetros de consulta e de cabeçalho de `/dashboard/filtro`.
|
|
160
|
-
*/
|
|
161
|
-
export interface ParametrosDeBuscarPeloFiltroDashboard {
|
|
162
|
-
dias?: number;
|
|
163
|
-
robo_id?: string;
|
|
164
|
-
}
|
|
165
|
-
/**
|
|
166
|
-
* Parâmetros de consulta e de cabeçalho de `/perfil_acesso`.
|
|
167
|
-
*/
|
|
168
|
-
export interface ParametrosDeBuscarPaginadorPerfilAcesso {
|
|
169
|
-
pagina?: number;
|
|
170
|
-
tamanho?: number;
|
|
171
|
-
}
|
|
172
|
-
/**
|
|
173
|
-
* Parâmetros de consulta e de cabeçalho de `/perfil_acesso/autocomplete`.
|
|
174
|
-
*/
|
|
175
|
-
export interface ParametrosDeBuscarAutoCompletePerfilAcesso {
|
|
176
|
-
busca?: string;
|
|
177
|
-
pagina?: number;
|
|
178
|
-
tamanho?: number;
|
|
179
|
-
}
|
|
180
|
-
/**
|
|
181
|
-
* Parâmetros de consulta e de cabeçalho de `/perfil_acesso/filtro`.
|
|
182
|
-
*/
|
|
183
|
-
export interface ParametrosDeBuscarPeloFiltroPerfilAcesso {
|
|
184
|
-
nome?: string;
|
|
185
|
-
}
|
|
186
|
-
/**
|
|
187
|
-
* Parâmetros de consulta e de cabeçalho de `/robo`.
|
|
188
|
-
*/
|
|
189
|
-
export interface ParametrosDeBuscarPaginadorRobo {
|
|
190
|
-
pagina?: number;
|
|
191
|
-
tamanho?: number;
|
|
192
|
-
}
|
|
193
|
-
/**
|
|
194
|
-
* Parâmetros de consulta e de cabeçalho de `/robo/autocomplete`.
|
|
195
|
-
*/
|
|
196
|
-
export interface ParametrosDeBuscarAutoCompleteRobo {
|
|
197
|
-
busca?: string;
|
|
198
|
-
pagina?: number;
|
|
199
|
-
tamanho?: number;
|
|
200
|
-
}
|
|
201
|
-
/**
|
|
202
|
-
* Parâmetros de consulta e de cabeçalho de `/robo/equipes`.
|
|
203
|
-
*/
|
|
204
|
-
export interface ParametrosDeBuscarEquipesRobo {
|
|
205
|
-
robo_id?: string;
|
|
206
|
-
}
|
|
207
|
-
/**
|
|
208
|
-
* Parâmetros de consulta e de cabeçalho de `/robo/filtro`.
|
|
209
|
-
*/
|
|
210
|
-
export interface ParametrosDeBuscarPeloFiltroRobo {
|
|
211
|
-
nome?: string;
|
|
212
|
-
modelo?: string;
|
|
213
|
-
ativo?: boolean;
|
|
214
|
-
}
|
|
215
|
-
/**
|
|
216
|
-
* Parâmetros de consulta e de cabeçalho de `/robo_ferramenta`.
|
|
217
|
-
*/
|
|
218
|
-
export interface ParametrosDeBuscarPaginadorRoboFerramenta {
|
|
219
|
-
pagina?: number;
|
|
220
|
-
tamanho?: number;
|
|
221
|
-
}
|
|
222
|
-
/**
|
|
223
|
-
* Parâmetros de consulta e de cabeçalho de `/robo_ferramenta/autocomplete`.
|
|
224
|
-
*/
|
|
225
|
-
export interface ParametrosDeBuscarAutoCompleteRoboFerramenta {
|
|
226
|
-
busca?: string;
|
|
227
|
-
pagina?: number;
|
|
228
|
-
tamanho?: number;
|
|
229
|
-
}
|
|
230
|
-
/**
|
|
231
|
-
* Parâmetros de consulta e de cabeçalho de `/robo_ferramenta/filtro`.
|
|
232
|
-
*/
|
|
233
|
-
export interface ParametrosDeBuscarPeloFiltroRoboFerramenta {
|
|
234
|
-
nome?: string;
|
|
235
|
-
tipo?: string;
|
|
236
|
-
ativo?: boolean;
|
|
237
|
-
}
|
|
238
|
-
/**
|
|
239
|
-
* Parâmetros de consulta e de cabeçalho de `/webhooks/chatwoot`.
|
|
240
|
-
*/
|
|
241
|
-
export interface ParametrosDeReceberEventoChatwootWebhooks {
|
|
242
|
-
/**
|
|
243
|
-
* Segredo do webhook que o TermoSell gerou e embutiu no endereço cadastrado no serviço externo
|
|
244
|
-
*/
|
|
245
|
-
segredo: string;
|
|
246
|
-
}
|
|
247
|
-
/**
|
|
248
|
-
* Parâmetros de consulta e de cabeçalho de `/webhooks/termowebhook`.
|
|
249
|
-
*/
|
|
250
|
-
export interface ParametrosDeReceberEventoTermoWebhookWebhooks {
|
|
251
|
-
/**
|
|
252
|
-
* Horário Unix em segundos usado na assinatura
|
|
253
|
-
*
|
|
254
|
-
* Enviado no cabeçalho `X-TermoWebhook-Data`.
|
|
255
|
-
*/
|
|
256
|
-
"X-TermoWebhook-Data": number;
|
|
257
|
-
/**
|
|
258
|
-
* Id (kid) da chave do hub que assinou a entrega
|
|
259
|
-
*
|
|
260
|
-
* Enviado no cabeçalho `X-TermoWebhook-Chave`.
|
|
261
|
-
*/
|
|
262
|
-
"X-TermoWebhook-Chave": string;
|
|
263
|
-
/**
|
|
264
|
-
* Id do aplicativo destino no hub, que precisa ser o do TermoSell
|
|
265
|
-
*
|
|
266
|
-
* Enviado no cabeçalho `X-TermoWebhook-Destino`.
|
|
267
|
-
*/
|
|
268
|
-
"X-TermoWebhook-Destino": string;
|
|
269
|
-
/**
|
|
270
|
-
* `ed25519=<base64url>` da assinatura de `<data>.<destino>.<corpo>`
|
|
271
|
-
*
|
|
272
|
-
* Enviado no cabeçalho `X-TermoWebhook-Assinatura`.
|
|
273
|
-
*/
|
|
274
|
-
"X-TermoWebhook-Assinatura": string;
|
|
275
|
-
}
|
|
276
|
-
/**
|
|
277
|
-
* Parâmetros de consulta e de cabeçalho de `/webhooks/z_api`.
|
|
278
|
-
*/
|
|
279
|
-
export interface ParametrosDeReceberEventoZApiWebhooks {
|
|
280
|
-
/**
|
|
281
|
-
* Segredo do webhook que o TermoSell gerou e embutiu no endereço cadastrado no serviço externo
|
|
282
|
-
*/
|
|
283
|
-
segredo: string;
|
|
284
|
-
}
|
|
285
|
-
/**
|
|
286
|
-
* Versão do backend no ar
|
|
287
|
-
*
|
|
288
|
-
* Pública, sem token. Devolve `sucesso: true` e a versão do backend publicada, no formato semver.
|
|
289
|
-
*
|
|
290
|
-
* `GET /`
|
|
291
|
-
*/
|
|
292
|
-
export declare function buscar_versao_test(opcoes_da_chamada?: OpcoesDaChamada): Promise<tipos.VersaoDoBackend>;
|
|
293
|
-
/**
|
|
294
|
-
* Lista os acessos com paginação
|
|
295
|
-
*
|
|
296
|
-
* Exige qualquer permissão da área `colaboradores` (qualquer ação liberada na área já libera a leitura). Ordena por perfil e depois por e-mail. Acessos excluídos não aparecem. `pagina` começa em 1 (padrão 1; valores menores viram 1). A página tem sempre 50 itens: `tamanho` é aceito, mas ignorado. `total` conta todos os registros não excluídos.
|
|
297
|
-
*
|
|
298
|
-
* `GET /auth`
|
|
299
|
-
*/
|
|
300
|
-
export declare function buscar_paginador_auth(credencial_de_acesso: CredencialDeAcesso, parametros?: ParametrosDeBuscarPaginadorAuth, opcoes_da_chamada?: OpcoesDaChamada): Promise<tipos.PaginaAuth>;
|
|
301
|
-
/**
|
|
302
|
-
* Cria um acesso
|
|
303
|
-
*
|
|
304
|
-
* Exige a permissão `criar` da área `colaboradores`. Cadastra quem pode entrar no TermoSell. `email` é obrigatório, com até 160 caracteres, e é gravado em minúsculas, sem espaços nas pontas; `perfil` é `colaborador` ou `cliente`. O acesso nasce ativo e sem nenhuma permissão. Para a pessoa conseguir entrar, o e-mail precisa ser `@termotubos.com.br` e existir no TermoAuth com o mesmo endereço. Para cadastrar um cliente, prefira `POST /cliente`, que cria o acesso junto.
|
|
305
|
-
*
|
|
306
|
-
* `POST /auth`
|
|
307
|
-
*/
|
|
308
|
-
export declare function criar_auth(credencial_de_acesso: CredencialDeAcesso, corpo_da_requisicao: tipos.AuthCriar, opcoes_da_chamada?: OpcoesDaChamada): Promise<tipos.Auth>;
|
|
309
|
-
/**
|
|
310
|
-
* Busca o acesso de quem está logado
|
|
311
|
-
*
|
|
312
|
-
* Livre para qualquer usuário autenticado com acesso ativo, mesmo sem nenhuma permissão liberada. Devolve o acesso de quem chamou (id, e-mail, nome, perfil e se é master do TermoAuth) e as permissões por área (`clientes`, `colaboradores` e `configuracoes`), cada uma com `ler`, `criar`, `editar` e `deletar`. Um master do TermoAuth recebe todas as permissões e, no primeiro pedido, ganha o acesso e o colaborador automaticamente. `nome` vem do TermoAuth e, se estiver vazio, repete o e-mail. É a chamada que o painel faz antes de mostrar qualquer tela.
|
|
313
|
-
*
|
|
314
|
-
* `GET /auth/acesso`
|
|
315
|
-
*/
|
|
316
|
-
export declare function buscar_acesso_auth(credencial_de_acesso: CredencialDeAcesso, opcoes_da_chamada?: OpcoesDaChamada): Promise<tipos.AcessoAtual>;
|
|
317
|
-
/**
|
|
318
|
-
* Lista básica de acessos para seleção
|
|
319
|
-
*
|
|
320
|
-
* Exige qualquer permissão da área `colaboradores` (qualquer ação liberada na área já libera a leitura). Devolve só id, e-mail e perfil, em ordem alfabética de e-mail, para escolher um acesso. `busca` procura por trecho do e-mail, sem diferenciar maiúsculas; `perfil` compara o valor exato. `pagina` começa em 1 (padrão 1) e `tamanho` tem padrão 10, sem máximo; valores menores que 1 viram 1. `total` conta os registros que casam com a busca.
|
|
321
|
-
*
|
|
322
|
-
* `GET /auth/autocomplete`
|
|
323
|
-
*/
|
|
324
|
-
export declare function buscar_auto_complete_auth(credencial_de_acesso: CredencialDeAcesso, parametros?: ParametrosDeBuscarAutoCompleteAuth, opcoes_da_chamada?: OpcoesDaChamada): Promise<tipos.PaginaAuthAutoComplete>;
|
|
325
|
-
/**
|
|
326
|
-
* Busca acessos por filtro
|
|
327
|
-
*
|
|
328
|
-
* Exige qualquer permissão da área `colaboradores` (qualquer ação liberada na área já libera a leitura). Devolve todos os acessos que casam com o filtro, sem paginação, em ordem alfabética de e-mail. `email` procura por trecho, sem diferenciar maiúsculas; `perfil` compara o valor exato (`colaborador` ou `cliente`); `ativo` filtra pela situação. Sem filtro, devolve todos. Acessos excluídos não aparecem.
|
|
329
|
-
*
|
|
330
|
-
* `GET /auth/filtro`
|
|
331
|
-
*/
|
|
332
|
-
export declare function buscar_pelo_filtro_auth(credencial_de_acesso: CredencialDeAcesso, parametros?: ParametrosDeBuscarPeloFiltroAuth, opcoes_da_chamada?: OpcoesDaChamada): Promise<Array<tipos.Auth>>;
|
|
333
|
-
/**
|
|
334
|
-
* Busca um acesso pelo id
|
|
335
|
-
*
|
|
336
|
-
* Exige qualquer permissão da área `colaboradores` (qualquer ação liberada na área já libera a leitura). Acesso excluído responde `404`. `vinculado` diz se há um colaborador ou um cliente ligado ao acesso, e `nome` é o nome desse colaborador ou a razão social desse cliente. `master` diz se a pessoa é master do TermoAuth.
|
|
337
|
-
*
|
|
338
|
-
* `GET /auth/{id}`
|
|
339
|
-
*/
|
|
340
|
-
export declare function buscar_pelo_id_auth(credencial_de_acesso: CredencialDeAcesso, id: string, opcoes_da_chamada?: OpcoesDaChamada): Promise<tipos.Auth>;
|
|
341
|
-
/**
|
|
342
|
-
* Atualiza um acesso pelo id
|
|
343
|
-
*
|
|
344
|
-
* Exige a permissão `editar` da área `colaboradores`. Atualização parcial: só os campos enviados mudam. `email` (até 160 caracteres, gravado em minúsculas) e `ativo` (acesso inativo é barrado em todas as rotas). O perfil não muda. O acesso de um master do TermoAuth não pode ser alterado.
|
|
345
|
-
*
|
|
346
|
-
* `PATCH /auth/{id}`
|
|
347
|
-
*/
|
|
348
|
-
export declare function atualizar_pelo_id_auth(credencial_de_acesso: CredencialDeAcesso, id: string, corpo_da_requisicao: tipos.AuthAtualizar, opcoes_da_chamada?: OpcoesDaChamada): Promise<tipos.Auth>;
|
|
349
|
-
/**
|
|
350
|
-
* Exclui um acesso pelo id
|
|
351
|
-
*
|
|
352
|
-
* Exige a permissão `deletar` da área `colaboradores`. A exclusão é lógica: o acesso some das consultas e a pessoa deixa de entrar, mas o registro fica guardado e não há como restaurar. Acesso com colaborador ou cliente vinculado não pode ser excluído por aqui (exclua o cliente, que leva o acesso junto). O acesso de um master do TermoAuth não pode ser excluído.
|
|
353
|
-
*
|
|
354
|
-
* `DELETE /auth/{id}`
|
|
355
|
-
*/
|
|
356
|
-
export declare function deletar_pelo_id_auth(credencial_de_acesso: CredencialDeAcesso, id: string, opcoes_da_chamada?: OpcoesDaChamada): Promise<void>;
|
|
357
|
-
/**
|
|
358
|
-
* Lista os clientes com paginação
|
|
359
|
-
*
|
|
360
|
-
* Exige qualquer permissão da área `clientes` (qualquer ação liberada na área já libera a leitura). Ordena pela razão social. `pagina` começa em 1 (padrão 1; valores menores viram 1). A página tem sempre 50 itens: `tamanho` é aceito, mas ignorado. `total` conta todos os registros não excluídos.
|
|
361
|
-
*
|
|
362
|
-
* `GET /cliente`
|
|
363
|
-
*/
|
|
364
|
-
export declare function buscar_paginador_cliente(credencial_de_acesso: CredencialDeAcesso, parametros?: ParametrosDeBuscarPaginadorCliente, opcoes_da_chamada?: OpcoesDaChamada): Promise<tipos.PaginaCliente>;
|
|
365
|
-
/**
|
|
366
|
-
* Cadastra um cliente
|
|
367
|
-
*
|
|
368
|
-
* Exige a permissão `criar` da área `clientes`. Cria o cliente e, na mesma transação, o acesso dele com perfil `cliente` e o `email` informado. Obrigatórios: `razao_social` (até 150 caracteres), `cnpj` (exatamente 14 dígitos, só números; pode se repetir, porque a intranet repete CNPJ) e `email` (até 160 caracteres, gravado em minúsculas). Opcionais: `nome_fantasia` (até 150), `telefone` (até 20; é por ele que o robô reconhece o cliente no WhatsApp), `cidade` (até 120) e `estado` (2 letras, gravado em maiúsculas). Texto vazio nos opcionais vira `null`. O cliente nasce ativo e com `atendente_ativo` desligado.
|
|
369
|
-
*
|
|
370
|
-
* `POST /cliente`
|
|
371
|
-
*/
|
|
372
|
-
export declare function criar_cliente(credencial_de_acesso: CredencialDeAcesso, corpo_da_requisicao: tipos.ClienteCriar, opcoes_da_chamada?: OpcoesDaChamada): Promise<tipos.Cliente>;
|
|
373
|
-
/**
|
|
374
|
-
* Lista básica de clientes para seleção
|
|
375
|
-
*
|
|
376
|
-
* Exige qualquer permissão da área `clientes` (qualquer ação liberada na área já libera a leitura). Devolve só id, razão social e CNPJ, em ordem alfabética da razão social. `busca` procura o trecho na razão social (sem diferenciar maiúsculas) ou no CNPJ. `pagina` começa em 1 (padrão 1) e `tamanho` tem padrão 10, sem máximo; valores menores que 1 viram 1. `total` conta os registros que casam com a busca.
|
|
377
|
-
*
|
|
378
|
-
* `GET /cliente/autocomplete`
|
|
379
|
-
*/
|
|
380
|
-
export declare function buscar_auto_complete_cliente(credencial_de_acesso: CredencialDeAcesso, parametros?: ParametrosDeBuscarAutoCompleteCliente, opcoes_da_chamada?: OpcoesDaChamada): Promise<tipos.PaginaClienteAutoComplete>;
|
|
381
|
-
/**
|
|
382
|
-
* Busca clientes por filtro
|
|
383
|
-
*
|
|
384
|
-
* Exige qualquer permissão da área `clientes` (qualquer ação liberada na área já libera a leitura). Devolve todos os clientes que casam com o filtro, sem paginação, em ordem alfabética da razão social. `razao_social` procura o trecho na razão social ou no nome fantasia; `email` e `cidade` procuram por trecho; todos sem diferenciar maiúsculas. `cnpj` procura o trecho no CNPJ (só dígitos); `telefone` compara só os dígitos, por trecho; `estado` compara a sigla exata; `ativo` e `atendente_ativo` filtram pela situação. Sem filtro, devolve todos.
|
|
385
|
-
*
|
|
386
|
-
* `GET /cliente/filtro`
|
|
387
|
-
*/
|
|
388
|
-
export declare function buscar_pelo_filtro_cliente(credencial_de_acesso: CredencialDeAcesso, parametros?: ParametrosDeBuscarPeloFiltroCliente, opcoes_da_chamada?: OpcoesDaChamada): Promise<Array<tipos.Cliente>>;
|
|
389
|
-
/**
|
|
390
|
-
* Status da sincronização dos clientes com o TermoIntranetAPI
|
|
391
|
-
*
|
|
392
|
-
* Só para o master do TermoAuth. Devolve a sincronização em andamento ou a última que terminou: `rodando`, `paginas` gravadas, `cancelada`, `erro` (sem permissão no TermoIntranetAPI, indisponibilidade ou falha no banco) e os totais em `resultado`. O status fica em memória e se perde se o servidor reiniciar; o que já foi gravado fica.
|
|
393
|
-
*
|
|
394
|
-
* `GET /cliente/sincronizar`
|
|
395
|
-
*/
|
|
396
|
-
export declare function buscar_sincronizacao_cliente(credencial_de_acesso: CredencialDeAcesso, opcoes_da_chamada?: OpcoesDaChamada): Promise<tipos.StatusDaSincronizacao>;
|
|
397
|
-
/**
|
|
398
|
-
* Inicia a sincronização dos clientes com o TermoIntranetAPI em segundo plano
|
|
399
|
-
*
|
|
400
|
-
* Só para o master do TermoAuth. Percorre toda a lista de clientes do TermoIntranetAPI (`GET /cliente`, paginada por cursor) usando o próprio token de quem chamou e grava aqui: entra todo cliente, pessoa física ou jurídica, com ou sem documento (`cnpj` guarda só os dígitos do CPF ou CNPJ, ou fica vazio); `ignorados` conta só o id repetido na mesma página. Cliente que já existe com o mesmo CNPJ e ainda sem vínculo recebe o `intranet_cliente_id`; cliente já vinculado tem razão social, nome fantasia, telefone (celular, ou telefone fixo na falta dele, só dígitos), e-mail, cidade e estado sobrescritos pela intranet; cliente novo é criado com `atendente_ativo` desligado. Os campos do TermoSell (`ativo` e `atendente_ativo`) nunca são tocados. Roda em segundo plano no servidor e grava cada página no banco assim que chega: a tela pode ser fechada. Responde 202 com o status inicial; acompanhe por `GET /cliente/sincronizar`. Sem corpo.
|
|
401
|
-
*
|
|
402
|
-
* `POST /cliente/sincronizar`
|
|
403
|
-
*/
|
|
404
|
-
export declare function sincronizar_com_intranet_cliente(credencial_de_acesso: CredencialDeAcesso, opcoes_da_chamada?: OpcoesDaChamada): Promise<tipos.StatusDaSincronizacao>;
|
|
405
|
-
/**
|
|
406
|
-
* Cancela a sincronização dos clientes em andamento
|
|
407
|
-
*
|
|
408
|
-
* Só para o master do TermoAuth. Para antes da próxima página; o que já foi gravado fica.
|
|
409
|
-
*
|
|
410
|
-
* `DELETE /cliente/sincronizar`
|
|
411
|
-
*/
|
|
412
|
-
export declare function cancelar_sincronizacao_cliente(credencial_de_acesso: CredencialDeAcesso, opcoes_da_chamada?: OpcoesDaChamada): Promise<void>;
|
|
413
|
-
/**
|
|
414
|
-
* Busca um cliente pelo id
|
|
415
|
-
*
|
|
416
|
-
* Exige qualquer permissão da área `clientes` (qualquer ação liberada na área já libera a leitura). Devolve o cliente com o e-mail do acesso e o `ultimo_pedido` dele na intranet (`null` quando não foi possível consultar). Cliente excluído responde `404`.
|
|
417
|
-
*
|
|
418
|
-
* `GET /cliente/{id}`
|
|
419
|
-
*/
|
|
420
|
-
export declare function buscar_pelo_id_cliente(credencial_de_acesso: CredencialDeAcesso, id: string, opcoes_da_chamada?: OpcoesDaChamada): Promise<tipos.ClienteDetalhe>;
|
|
421
|
-
/**
|
|
422
|
-
* Atualiza um cliente pelo id
|
|
423
|
-
*
|
|
424
|
-
* Exige a permissão `editar` da área `clientes`. Atualização parcial: só os campos enviados mudam. `razao_social` não pode ficar vazia (até 150 caracteres); `nome_fantasia` (até 150), `telefone` (até 20), `cidade` (até 120) e `estado` (2 letras) aceitam texto vazio para apagar o valor. `ativo` liga ou desliga o cliente e `atendente_ativo` liga ou desliga o atendimento pelo robô no WhatsApp: o robô só responde cliente ativo com `atendente_ativo` ligado; os demais vão direto para a equipe. CNPJ e e-mail não mudam por aqui.
|
|
425
|
-
*
|
|
426
|
-
* `PATCH /cliente/{id}`
|
|
427
|
-
*/
|
|
428
|
-
export declare function atualizar_pelo_id_cliente(credencial_de_acesso: CredencialDeAcesso, id: string, corpo_da_requisicao: tipos.ClienteAtualizar, opcoes_da_chamada?: OpcoesDaChamada): Promise<tipos.Cliente>;
|
|
429
|
-
/**
|
|
430
|
-
* Exclui um cliente pelo id
|
|
431
|
-
*
|
|
432
|
-
* Exige a permissão `deletar` da área `clientes`. A exclusão é lógica e leva junto o acesso do cliente, na mesma transação: os dois somem das consultas, o CNPJ e o e-mail ficam livres para um novo cadastro e não há como restaurar.
|
|
433
|
-
*
|
|
434
|
-
* `DELETE /cliente/{id}`
|
|
435
|
-
*/
|
|
436
|
-
export declare function deletar_pelo_id_cliente(credencial_de_acesso: CredencialDeAcesso, id: string, opcoes_da_chamada?: OpcoesDaChamada): Promise<void>;
|
|
437
|
-
/**
|
|
438
|
-
* Lista os colaboradores com paginação
|
|
439
|
-
*
|
|
440
|
-
* Exige qualquer permissão da área `colaboradores` (qualquer ação liberada na área já libera a leitura). Ordena por nome. Quando quem chama é master do TermoAuth, antes de listar o TermoSell busca no TermoAuth os colaboradores `@termotubos.com.br` que ainda não existem aqui e os cadastra sem nenhuma permissão. `pagina` começa em 1 (padrão 1; valores menores viram 1). A página tem sempre 50 itens: `tamanho` é aceito, mas ignorado. `total` conta todos os registros não excluídos.
|
|
441
|
-
*
|
|
442
|
-
* `GET /colaborador`
|
|
443
|
-
*/
|
|
444
|
-
export declare function buscar_paginador_colaborador(credencial_de_acesso: CredencialDeAcesso, parametros?: ParametrosDeBuscarPaginadorColaborador, opcoes_da_chamada?: OpcoesDaChamada): Promise<tipos.PaginaColaborador>;
|
|
445
|
-
/**
|
|
446
|
-
* Lista básica de colaboradores para seleção
|
|
447
|
-
*
|
|
448
|
-
* Exige qualquer permissão da área `colaboradores` (qualquer ação liberada na área já libera a leitura). Devolve só id, nome e e-mail, em ordem alfabética de nome. `busca` procura por trecho do nome ou do e-mail, sem diferenciar maiúsculas. `pagina` começa em 1 (padrão 1) e `tamanho` tem padrão 10, sem máximo; valores menores que 1 viram 1. `total` conta os registros que casam com a busca.
|
|
449
|
-
*
|
|
450
|
-
* `GET /colaborador/autocomplete`
|
|
451
|
-
*/
|
|
452
|
-
export declare function buscar_auto_complete_colaborador(credencial_de_acesso: CredencialDeAcesso, parametros?: ParametrosDeBuscarAutoCompleteColaborador, opcoes_da_chamada?: OpcoesDaChamada): Promise<tipos.PaginaColaboradorAutoComplete>;
|
|
453
|
-
/**
|
|
454
|
-
* Busca colaboradores por filtro
|
|
455
|
-
*
|
|
456
|
-
* Exige qualquer permissão da área `colaboradores` (qualquer ação liberada na área já libera a leitura). Devolve todos os colaboradores que casam com o filtro, sem paginação, em ordem alfabética de nome. `busca` procura por trecho do nome ou do e-mail (a busca rápida da tela); `nome`, `email` e `cargo` procuram por trecho, sem diferenciar maiúsculas; `ativo` filtra pela situação; `perfil_acesso_id` filtra pelo perfil de acesso. Sem filtro, devolve todos. O colaborador é do TermoAuth: aqui ele só é lido (chega pela sincronização e pelos eventos do TermoWebhook) e `setor`, `cargo` e `funcao` vêm de lá.
|
|
457
|
-
*
|
|
458
|
-
* `GET /colaborador/filtro`
|
|
459
|
-
*/
|
|
460
|
-
export declare function buscar_pelo_filtro_colaborador(credencial_de_acesso: CredencialDeAcesso, parametros?: ParametrosDeBuscarPeloFiltroColaborador, opcoes_da_chamada?: OpcoesDaChamada): Promise<Array<tipos.Colaborador>>;
|
|
461
|
-
/**
|
|
462
|
-
* Busca um colaborador pelo id
|
|
463
|
-
*
|
|
464
|
-
* Exige qualquer permissão da área `colaboradores` (qualquer ação liberada na área já libera a leitura). Devolve o colaborador com o e-mail e o `master` do acesso dele. Colaborador excluído responde `404`. O colaborador é do TermoAuth: aqui ele só é lido (chega pela sincronização e pelos eventos do TermoWebhook) e `setor`, `cargo` e `funcao` vêm de lá.
|
|
465
|
-
*
|
|
466
|
-
* `GET /colaborador/{id}`
|
|
467
|
-
*/
|
|
468
|
-
export declare function buscar_pelo_id_colaborador(credencial_de_acesso: CredencialDeAcesso, id: string, opcoes_da_chamada?: OpcoesDaChamada): Promise<tipos.Colaborador>;
|
|
469
|
-
/**
|
|
470
|
-
* Define o perfil de acesso de um colaborador
|
|
471
|
-
*
|
|
472
|
-
* Exige a permissão `editar` da área `colaboradores`. É a única escrita do colaborador feita pelo TermoSell: `perfil_acesso_id` aponta para um perfil de `GET /perfil_acesso/filtro` e passa a definir o que a pessoa enxerga; `null` tira o perfil e deixa a pessoa sem nenhuma área. O colaborador de um master do TermoAuth não aceita perfil (ele já tem tudo). Vale em até 5 minutos (cache do acesso).
|
|
473
|
-
*
|
|
474
|
-
* `PATCH /colaborador/{id}/perfil_acesso`
|
|
475
|
-
*/
|
|
476
|
-
export declare function vincular_perfil_acesso_colaborador(credencial_de_acesso: CredencialDeAcesso, id: string, corpo_da_requisicao: tipos.ColaboradorVincularPerfilAcesso, opcoes_da_chamada?: OpcoesDaChamada): Promise<tipos.Colaborador>;
|
|
477
|
-
/**
|
|
478
|
-
* Lista as configurações do Chatwoot com paginação
|
|
479
|
-
*
|
|
480
|
-
* Exige qualquer permissão da área `configuracoes` (qualquer ação liberada na área já libera a leitura). Ordena por nome. Para cada item, consulta o Chatwoot na hora: `chave_valida` diz se o token de acesso funcionou e `erro_chave` traz o motivo da recusa. `pagina` começa em 1 (padrão 1; valores menores viram 1). A página tem sempre 50 itens: `tamanho` é aceito, mas ignorado. `total` conta todos os registros não excluídos. O token de acesso nunca volta: as respostas trazem só `token_acesso_mascarado`.
|
|
481
|
-
*
|
|
482
|
-
* `GET /config_system_chatwoot`
|
|
483
|
-
*/
|
|
484
|
-
export declare function buscar_paginador_config_system_chatwoot(credencial_de_acesso: CredencialDeAcesso, parametros?: ParametrosDeBuscarPaginadorConfigSystemChatwoot, opcoes_da_chamada?: OpcoesDaChamada): Promise<tipos.PaginaConfigSystemChatwootValidada>;
|
|
485
|
-
/**
|
|
486
|
-
* Conecta a conta do Chatwoot
|
|
487
|
-
*
|
|
488
|
-
* Exige a permissão `criar` da área `configuracoes`. Aceita quantas contas do Chatwoot forem precisas; o `nome` e o par `endereco` + `conta_id` não se repetem (`409`). `nome` (até 100 caracteres), `endereco` do Chatwoot (`http://` ou `https://`, até 200), `conta_id` (maior que zero), `token_acesso` (de 8 a 200 caracteres) e `endereco_publico` (o endereço `https://` deste backend que o Chatwoot vai chamar, até 200) são obrigatórios. Antes de gravar, cria no Chatwoot o robô de atendimento que avisa o TermoSell das mensagens; se o Chatwoot recusar, responde `400` com o motivo. A configuração nasce ativa. O token de acesso nunca volta: as respostas trazem só `token_acesso_mascarado`.
|
|
489
|
-
*
|
|
490
|
-
* `POST /config_system_chatwoot`
|
|
491
|
-
*/
|
|
492
|
-
export declare function criar_config_system_chatwoot(credencial_de_acesso: CredencialDeAcesso, corpo_da_requisicao: tipos.ConfigSystemChatwootCriar, opcoes_da_chamada?: OpcoesDaChamada): Promise<tipos.ConfigSystemChatwoot>;
|
|
493
|
-
/**
|
|
494
|
-
* Lista básica de configurações do Chatwoot para seleção
|
|
495
|
-
*
|
|
496
|
-
* Exige qualquer permissão da área `configuracoes` (qualquer ação liberada na área já libera a leitura). Devolve só id, nome e endereço das configurações ativas, em ordem alfabética de nome. `busca` procura por trecho do nome, sem diferenciar maiúsculas. `pagina` começa em 1 (padrão 1) e `tamanho` tem padrão 10, sem máximo; valores menores que 1 viram 1. `total` conta os registros que casam com a busca.
|
|
497
|
-
*
|
|
498
|
-
* `GET /config_system_chatwoot/autocomplete`
|
|
499
|
-
*/
|
|
500
|
-
export declare function buscar_auto_complete_config_system_chatwoot(credencial_de_acesso: CredencialDeAcesso, parametros?: ParametrosDeBuscarAutoCompleteConfigSystemChatwoot, opcoes_da_chamada?: OpcoesDaChamada): Promise<tipos.PaginaConfigSystemChatwootAutoComplete>;
|
|
501
|
-
/**
|
|
502
|
-
* Busca configurações do Chatwoot por filtro
|
|
503
|
-
*
|
|
504
|
-
* Exige qualquer permissão da área `configuracoes` (qualquer ação liberada na área já libera a leitura). Devolve todas as configurações que casam com o filtro, sem paginação, em ordem alfabética de nome. `nome` e `endereco` procuram por trecho, sem diferenciar maiúsculas; `ativo` filtra pela situação. O token de acesso nunca volta: as respostas trazem só `token_acesso_mascarado`.
|
|
505
|
-
*
|
|
506
|
-
* `GET /config_system_chatwoot/filtro`
|
|
507
|
-
*/
|
|
508
|
-
export declare function buscar_pelo_filtro_config_system_chatwoot(credencial_de_acesso: CredencialDeAcesso, parametros?: ParametrosDeBuscarPeloFiltroConfigSystemChatwoot, opcoes_da_chamada?: OpcoesDaChamada): Promise<Array<tipos.ConfigSystemChatwoot>>;
|
|
509
|
-
/**
|
|
510
|
-
* Busca a configuração do Chatwoot pelo id
|
|
511
|
-
*
|
|
512
|
-
* Exige qualquer permissão da área `configuracoes` (qualquer ação liberada na área já libera a leitura). Configuração excluída responde `404`. `robo_chatwoot_id` é o id do robô de atendimento criado no Chatwoot. O token de acesso nunca volta: as respostas trazem só `token_acesso_mascarado`.
|
|
513
|
-
*
|
|
514
|
-
* `GET /config_system_chatwoot/{id}`
|
|
515
|
-
*/
|
|
516
|
-
export declare function buscar_pelo_id_config_system_chatwoot(credencial_de_acesso: CredencialDeAcesso, id: string, opcoes_da_chamada?: OpcoesDaChamada): Promise<tipos.ConfigSystemChatwoot>;
|
|
517
|
-
/**
|
|
518
|
-
* Atualiza a configuração do Chatwoot pelo id
|
|
519
|
-
*
|
|
520
|
-
* Exige a permissão `editar` da área `configuracoes`. Atualização parcial: só `nome` (até 100), `token_acesso` (de 8 a 200), `endereco_publico` (`https://`, até 200) e `ativo` mudam; o endereço e a conta do Chatwoot não. Trocar o token ou o endereço público atualiza antes o robô de atendimento no Chatwoot, e trocar o endereço público também refaz o webhook de cada número da Z-API ligado a esta conta; se o Chatwoot ou a Z-API recusarem, nada é gravado e a resposta é `400` com o motivo. O token de acesso nunca volta: as respostas trazem só `token_acesso_mascarado`.
|
|
521
|
-
*
|
|
522
|
-
* `PATCH /config_system_chatwoot/{id}`
|
|
523
|
-
*/
|
|
524
|
-
export declare function atualizar_pelo_id_config_system_chatwoot(credencial_de_acesso: CredencialDeAcesso, id: string, corpo_da_requisicao: tipos.ConfigSystemChatwootAtualizar, opcoes_da_chamada?: OpcoesDaChamada): Promise<tipos.ConfigSystemChatwoot>;
|
|
525
|
-
/**
|
|
526
|
-
* Exclui a configuração do Chatwoot pelo id
|
|
527
|
-
*
|
|
528
|
-
* Exige a permissão `deletar` da área `configuracoes`. A exclusão é lógica e não há como restaurar. Só exclui a configuração que não tem números de WhatsApp (Z-API) vinculados; exclua ou desvincule os números antes.
|
|
529
|
-
*
|
|
530
|
-
* `DELETE /config_system_chatwoot/{id}`
|
|
531
|
-
*/
|
|
532
|
-
export declare function deletar_pelo_id_config_system_chatwoot(credencial_de_acesso: CredencialDeAcesso, id: string, opcoes_da_chamada?: OpcoesDaChamada): Promise<void>;
|
|
533
|
-
/**
|
|
534
|
-
* Lista básica dos números de WhatsApp conectados por QR Code para seleção
|
|
535
|
-
*
|
|
536
|
-
* Exige qualquer permissão da área `configuracoes` (qualquer ação liberada na área já libera a leitura). Devolve só id, nome e número (vazio até o celular ler o QR Code) de cada número conectado pelo QR Code, em ordem alfabética de nome. `busca` procura o trecho no nome (sem diferenciar maiúsculas) ou no número. `pagina` começa em 1 (padrão 1) e `tamanho` tem padrão 10, sem máximo; valores menores que 1 viram 1. `total` conta os registros que casam com a busca.
|
|
537
|
-
*
|
|
538
|
-
* `GET /config_system_whatsapp/autocomplete`
|
|
539
|
-
*/
|
|
540
|
-
export declare function buscar_auto_complete_config_system_whatsapp(credencial_de_acesso: CredencialDeAcesso, parametros?: ParametrosDeBuscarAutoCompleteConfigSystemWhatsapp, opcoes_da_chamada?: OpcoesDaChamada): Promise<tipos.PaginaConfigSystemWhatsappAutoComplete>;
|
|
541
|
-
/**
|
|
542
|
-
* Exclui um número de WhatsApp conectado por QR Code pelo id
|
|
543
|
-
*
|
|
544
|
-
* Exige a permissão `deletar` da área `configuracoes`. Desvincula o aparelho do celular (some de "Aparelhos conectados"), apaga a sessão guardada e faz a exclusão lógica, sem como restaurar: o TermoSell deixa de atender as mensagens que chegam pelo número.
|
|
545
|
-
*
|
|
546
|
-
* `DELETE /config_system_whatsapp/{id}`
|
|
547
|
-
*/
|
|
548
|
-
export declare function deletar_pelo_id_config_system_whatsapp(credencial_de_acesso: CredencialDeAcesso, id: string, opcoes_da_chamada?: OpcoesDaChamada): Promise<void>;
|
|
549
|
-
/**
|
|
550
|
-
* Lista básica dos números de WhatsApp (Z-API) para seleção
|
|
551
|
-
*
|
|
552
|
-
* Exige qualquer permissão da área `configuracoes` (qualquer ação liberada na área já libera a leitura). Devolve só id, nome e número de cada número de WhatsApp conectado pela Z-API, em ordem alfabética de nome. `busca` procura o trecho no nome (sem diferenciar maiúsculas) ou no número. `pagina` começa em 1 (padrão 1) e `tamanho` tem padrão 10, sem máximo; valores menores que 1 viram 1. `total` conta os registros que casam com a busca.
|
|
553
|
-
*
|
|
554
|
-
* `GET /config_system_z_api/autocomplete`
|
|
555
|
-
*/
|
|
556
|
-
export declare function buscar_auto_complete_config_system_z_api(credencial_de_acesso: CredencialDeAcesso, parametros?: ParametrosDeBuscarAutoCompleteConfigSystemZApi, opcoes_da_chamada?: OpcoesDaChamada): Promise<tipos.PaginaConfigSystemZApiAutoComplete>;
|
|
557
|
-
/**
|
|
558
|
-
* Exclui um número de WhatsApp (Z-API) pelo id
|
|
559
|
-
*
|
|
560
|
-
* Exige a permissão `deletar` da área `configuracoes`. A exclusão é lógica e não há como restaurar: o número some das consultas e o TermoSell deixa de atender as mensagens que chegam por ele.
|
|
561
|
-
*
|
|
562
|
-
* `DELETE /config_system_z_api/{id}`
|
|
563
|
-
*/
|
|
564
|
-
export declare function deletar_pelo_id_config_system_z_api(credencial_de_acesso: CredencialDeAcesso, id: string, opcoes_da_chamada?: OpcoesDaChamada): Promise<void>;
|
|
565
|
-
/**
|
|
566
|
-
* Mostra a configuração do app (segredo do TermoAuth)
|
|
567
|
-
*
|
|
568
|
-
* Só um master do TermoAuth. O segredo do app gerado no TermoAuth nunca volta: a resposta traz só `configurado` e os últimos caracteres mascarados em `final_visivel`. `criptografia_disponivel` é falso quando o servidor está sem a `GLOBAL_SECRET_CRIPTOGRAFIA`; nesse caso nada pode ser lido nem gravado. `atualizado_em` é nulo enquanto ninguém gravou a configuração.
|
|
569
|
-
*
|
|
570
|
-
* `GET /configuracao`
|
|
571
|
-
*/
|
|
572
|
-
export declare function buscar_pelo_id_configuracao(credencial_de_acesso: CredencialDeAcesso, opcoes_da_chamada?: OpcoesDaChamada): Promise<tipos.Configuracao>;
|
|
573
|
-
/**
|
|
574
|
-
* Grava o segredo do app gerado no TermoAuth
|
|
575
|
-
*
|
|
576
|
-
* Só um master do TermoAuth. Campo ausente fica como está, texto troca e `null` limpa. O segredo é gravado cifrado (AES-256-GCM com a `GLOBAL_SECRET_CRIPTOGRAFIA`) e entregue na hora ao `termo_core`, sem deploy. Até 2.000 caracteres, sem quebra de linha.
|
|
577
|
-
*
|
|
578
|
-
* `PATCH /configuracao`
|
|
579
|
-
*/
|
|
580
|
-
export declare function atualizar_pelo_id_configuracao(credencial_de_acesso: CredencialDeAcesso, corpo_da_requisicao: tipos.ConfiguracaoAtualizar, opcoes_da_chamada?: OpcoesDaChamada): Promise<tipos.Configuracao>;
|
|
581
|
-
/**
|
|
582
|
-
* Lista as conversas com paginação
|
|
583
|
-
*
|
|
584
|
-
* Exige qualquer permissão da área `clientes` (qualquer ação liberada na área já libera a leitura). Ordena da última mensagem mais recente para a mais antiga. `pagina` começa em 1 (padrão 1; valores menores viram 1). A página tem sempre 50 itens: `tamanho` é aceito, mas ignorado. `status` (opcional) limita a um status. `total` conta os registros não excluídos que casam com o `status`.
|
|
585
|
-
*
|
|
586
|
-
* `GET /conversa`
|
|
587
|
-
*/
|
|
588
|
-
export declare function buscar_paginador_conversa(credencial_de_acesso: CredencialDeAcesso, parametros?: ParametrosDeBuscarPaginadorConversa, opcoes_da_chamada?: OpcoesDaChamada): Promise<tipos.PaginaConversa>;
|
|
589
|
-
/**
|
|
590
|
-
* Não cria conversa pela tela
|
|
591
|
-
*
|
|
592
|
-
* Exige a permissão `criar` da área `clientes`, mas responde sempre `403`: a conversa é registrada pelos webhooks do Chatwoot e da Z-API, que gravam toda mensagem visível que passa pela conta do Chatwoot. Sem corpo.
|
|
593
|
-
*
|
|
594
|
-
* `POST /conversa`
|
|
595
|
-
*/
|
|
596
|
-
export declare function criar_conversa(credencial_de_acesso: CredencialDeAcesso, opcoes_da_chamada?: OpcoesDaChamada): Promise<void>;
|
|
597
|
-
/**
|
|
598
|
-
* Lista básica de conversas para seleção
|
|
599
|
-
*
|
|
600
|
-
* Exige qualquer permissão da área `clientes` (qualquer ação liberada na área já libera a leitura). Devolve só id, id da conversa no Chatwoot, nome e telefone do contato, em ordem alfabética do nome do contato. `busca` procura o trecho no nome do contato (sem diferenciar maiúsculas) ou no telefone. `pagina` começa em 1 (padrão 1) e `tamanho` tem padrão 10, sem máximo; valores menores que 1 viram 1. `total` conta os registros que casam com a busca.
|
|
601
|
-
*
|
|
602
|
-
* `GET /conversa/autocomplete`
|
|
603
|
-
*/
|
|
604
|
-
export declare function buscar_auto_complete_conversa(credencial_de_acesso: CredencialDeAcesso, parametros?: ParametrosDeBuscarAutoCompleteConversa, opcoes_da_chamada?: OpcoesDaChamada): Promise<tipos.PaginaConversaAutoComplete>;
|
|
605
|
-
/**
|
|
606
|
-
* Busca conversas por filtro
|
|
607
|
-
*
|
|
608
|
-
* Exige qualquer permissão da área `clientes` (qualquer ação liberada na área já libera a leitura). Devolve até 500 conversas que casam com o filtro, da última mensagem mais recente para a mais antiga. `cliente_id`, `robo_id`, `config_system_z_api_id` e `chatwoot_conversa_id` comparam o valor exato; `status` compara o status exato; `contato` procura o trecho no nome do contato, na razão social do cliente ou nos dígitos do telefone; `texto` procura o trecho no conteúdo de qualquer mensagem da conversa; todos sem diferenciar maiúsculas. Sem filtro, devolve as 500 mais recentes. É por `cliente_id` que a guia "Histórico de conversas" do cliente lê o histórico.
|
|
609
|
-
*
|
|
610
|
-
* `GET /conversa/filtro`
|
|
611
|
-
*/
|
|
612
|
-
export declare function buscar_pelo_filtro_conversa(credencial_de_acesso: CredencialDeAcesso, parametros?: ParametrosDeBuscarPeloFiltroConversa, opcoes_da_chamada?: OpcoesDaChamada): Promise<Array<tipos.Conversa>>;
|
|
613
|
-
/**
|
|
614
|
-
* Busca uma conversa pelo id
|
|
615
|
-
*
|
|
616
|
-
* Exige qualquer permissão da área `clientes` (qualquer ação liberada na área já libera a leitura). Devolve a conversa do histórico interno com o nome do número do WhatsApp, do cliente e do robô, o `status` espelhado do Chatwoot (`pending` com o robô, `open` com a equipe, `resolved`, `snoozed`), a etapa atual do fluxo, a última mensagem de cada lado, `transferida_em`/`transferida_motivo` (`sem_resposta` quando o gatilho passou a conversa para a equipe), `quantidade_mensagens` e `chatwoot_endereco_conversa` (link da conversa no painel do Chatwoot). Datas em RFC 3339. Conversa excluída responde `404`.
|
|
617
|
-
*
|
|
618
|
-
* `GET /conversa/{id}`
|
|
619
|
-
*/
|
|
620
|
-
export declare function buscar_pelo_id_conversa(credencial_de_acesso: CredencialDeAcesso, id: string, opcoes_da_chamada?: OpcoesDaChamada): Promise<tipos.Conversa>;
|
|
621
|
-
/**
|
|
622
|
-
* Atualiza uma conversa pelo id
|
|
623
|
-
*
|
|
624
|
-
* Exige a permissão `editar` da área `clientes`. Atualização parcial: só os campos enviados mudam. `cliente_id` vincula a conversa a um cliente, `robo_id` a um robô e `status` corrige o status gravado (`pending`, `open`, `resolved` ou `snoozed`) sem alterar nada no Chatwoot. As mensagens e os demais campos vêm só dos webhooks.
|
|
625
|
-
*
|
|
626
|
-
* `PATCH /conversa/{id}`
|
|
627
|
-
*/
|
|
628
|
-
export declare function atualizar_pelo_id_conversa(credencial_de_acesso: CredencialDeAcesso, id: string, corpo_da_requisicao: tipos.ConversaAtualizar, opcoes_da_chamada?: OpcoesDaChamada): Promise<tipos.Conversa>;
|
|
629
|
-
/**
|
|
630
|
-
* Exclui uma conversa do histórico pelo id
|
|
631
|
-
*
|
|
632
|
-
* Exige a permissão `deletar` da área `clientes`. A exclusão é lógica e leva junto as mensagens, na mesma transação: a conversa some do histórico interno e não há como restaurar. A conversa no Chatwoot não é alterada; uma mensagem nova dela cria um registro novo no histórico.
|
|
633
|
-
*
|
|
634
|
-
* `DELETE /conversa/{id}`
|
|
635
|
-
*/
|
|
636
|
-
export declare function deletar_pelo_id_conversa(credencial_de_acesso: CredencialDeAcesso, id: string, opcoes_da_chamada?: OpcoesDaChamada): Promise<void>;
|
|
637
|
-
/**
|
|
638
|
-
* Lista as mensagens de uma conversa
|
|
639
|
-
*
|
|
640
|
-
* Exige qualquer permissão da área `clientes` (qualquer ação liberada na área já libera a leitura). Devolve as mensagens gravadas no histórico interno, em ordem de envio, sem as notas privadas da equipe. `autor` é `contato`, `atendente` ou `robo`; `etapa_id` é a etapa do fluxo em que o robô mandou a mensagem; `criada_em` é a data de criação no Chatwoot, em RFC 3339. `anexos` lista os arquivos da mensagem (`tipo` do Chatwoot, `nome`, `endereco` no Chatwoot); cada um é copiado para o TermoBucket (arquivo privado do app `spark-sell`) logo depois do webhook e, quando já está lá, traz `arquivo_id`, `tipo_mime`, `tamanho` e `url`, o download assinado por 15 minutos. O que falhar é tentado de novo a cada 30 minutos, até 5 vezes.
|
|
641
|
-
*
|
|
642
|
-
* `GET /conversa/{id}/mensagens`
|
|
643
|
-
*/
|
|
644
|
-
export declare function buscar_mensagens_conversa(credencial_de_acesso: CredencialDeAcesso, id: string, opcoes_da_chamada?: OpcoesDaChamada): Promise<Array<tipos.ConversaMensagem>>;
|
|
645
|
-
/**
|
|
646
|
-
* Indicadores gerenciais do atendimento
|
|
647
|
-
*
|
|
648
|
-
* Exige qualquer permissão da área `clientes` (qualquer ação liberada na área já libera a leitura). Monta o painel do atendimento a partir do histórico interno de conversas. `dias` é o período (padrão 30, entre 1 e 365) contado em dias inteiros no horário de Brasília, de `inicio` até agora; `robo_id` (opcional) limita às conversas de um robô. `indicadores` traz as conversas novas do período e do período anterior de mesmo tamanho, as conversas e os clientes com mensagem do contato no período, as mensagens recebidas, do robô e da equipe, as conversas novas que passaram para a equipe (transferidas, abertas ou com mensagem de atendente), as resolvidas só pelo robô, as transferidas pelo gatilho de cliente sem resposta, as conversas em aberto cuja última mensagem é do contato e a mediana, em segundos, da primeira resposta (qualquer lado) e da primeira resposta da equipe. `situacao_atual` conta todas as conversas por `status`, sem recorte de período. `por_dia` e `por_hora` distribuem as mensagens no horário de Brasília; `por_robo` e `por_canal` agrupam as conversas; `aguardando_resposta` lista as 10 conversas em aberto que esperam resposta há mais tempo.
|
|
649
|
-
*
|
|
650
|
-
* `GET /dashboard/filtro`
|
|
651
|
-
*/
|
|
652
|
-
export declare function buscar_pelo_filtro_dashboard(credencial_de_acesso: CredencialDeAcesso, parametros?: ParametrosDeBuscarPeloFiltroDashboard, opcoes_da_chamada?: OpcoesDaChamada): Promise<tipos.Dashboard>;
|
|
653
|
-
/**
|
|
654
|
-
* Lista os perfis de acesso com paginação
|
|
655
|
-
*
|
|
656
|
-
* Exige qualquer permissão da área `colaboradores` (qualquer ação liberada na área já libera a leitura). Ordena pelo nome. `pagina` começa em 1 (padrão 1; valores menores viram 1). A página tem sempre 50 itens: `tamanho` é aceito, mas ignorado. `total` conta todos os registros não excluídos.
|
|
657
|
-
*
|
|
658
|
-
* `GET /perfil_acesso`
|
|
659
|
-
*/
|
|
660
|
-
export declare function buscar_paginador_perfil_acesso(credencial_de_acesso: CredencialDeAcesso, parametros?: ParametrosDeBuscarPaginadorPerfilAcesso, opcoes_da_chamada?: OpcoesDaChamada): Promise<tipos.PaginaPerfilAcesso>;
|
|
661
|
-
/**
|
|
662
|
-
* Cria um perfil de acesso
|
|
663
|
-
*
|
|
664
|
-
* Exige a permissão `criar` da área `colaboradores`. O perfil de acesso é o conjunto de permissões que o TermoSell dá a um colaborador: cada colaborador aponta para um perfil (`PATCH /colaborador/{id}/perfil_acesso`) e enxerga o que o perfil libera. `nome` é obrigatório (até 80 caracteres, único sem diferenciar maiúsculas); `descricao` é opcional (até 200); `permissoes` traz, para cada área (`clientes`, `colaboradores`, `configuracoes`), as ações `ler`, `criar`, `editar` e `deletar` (o que não vier fica `false`). A resposta inclui `colaboradores`, quantas pessoas usam o perfil. O master do TermoAuth tem tudo liberado sem precisar de perfil.
|
|
665
|
-
*
|
|
666
|
-
* `POST /perfil_acesso`
|
|
667
|
-
*/
|
|
668
|
-
export declare function criar_perfil_acesso(credencial_de_acesso: CredencialDeAcesso, corpo_da_requisicao: tipos.PerfilAcessoCriar, opcoes_da_chamada?: OpcoesDaChamada): Promise<tipos.PerfilAcesso>;
|
|
669
|
-
/**
|
|
670
|
-
* Lista básica de perfis de acesso para seleção
|
|
671
|
-
*
|
|
672
|
-
* Exige qualquer permissão da área `colaboradores` (qualquer ação liberada na área já libera a leitura). Devolve só o id e o nome, em ordem alfabética. `busca` procura por trecho do nome, sem diferenciar maiúsculas. `pagina` começa em 1 (padrão 1) e `tamanho` tem padrão 10, sem máximo; valores menores que 1 viram 1. `total` conta os registros que casam com a busca.
|
|
673
|
-
*
|
|
674
|
-
* `GET /perfil_acesso/autocomplete`
|
|
675
|
-
*/
|
|
676
|
-
export declare function buscar_auto_complete_perfil_acesso(credencial_de_acesso: CredencialDeAcesso, parametros?: ParametrosDeBuscarAutoCompletePerfilAcesso, opcoes_da_chamada?: OpcoesDaChamada): Promise<tipos.PaginaPerfilAcessoAutoComplete>;
|
|
677
|
-
/**
|
|
678
|
-
* Busca perfis de acesso por filtro
|
|
679
|
-
*
|
|
680
|
-
* Exige qualquer permissão da área `colaboradores` (qualquer ação liberada na área já libera a leitura). Devolve todos os perfis que casam com o filtro, sem paginação, em ordem alfabética de nome. `nome` procura por trecho, sem diferenciar maiúsculas. Sem filtro, devolve todos (é o que a tela usa para listar e para escolher o perfil de um colaborador).
|
|
681
|
-
*
|
|
682
|
-
* `GET /perfil_acesso/filtro`
|
|
683
|
-
*/
|
|
684
|
-
export declare function buscar_pelo_filtro_perfil_acesso(credencial_de_acesso: CredencialDeAcesso, parametros?: ParametrosDeBuscarPeloFiltroPerfilAcesso, opcoes_da_chamada?: OpcoesDaChamada): Promise<Array<tipos.PerfilAcesso>>;
|
|
685
|
-
/**
|
|
686
|
-
* Busca um perfil de acesso pelo id
|
|
687
|
-
*
|
|
688
|
-
* Exige qualquer permissão da área `colaboradores` (qualquer ação liberada na área já libera a leitura). Perfil excluído responde `404`.
|
|
689
|
-
*
|
|
690
|
-
* `GET /perfil_acesso/{id}`
|
|
691
|
-
*/
|
|
692
|
-
export declare function buscar_pelo_id_perfil_acesso(credencial_de_acesso: CredencialDeAcesso, id: string, opcoes_da_chamada?: OpcoesDaChamada): Promise<tipos.PerfilAcesso>;
|
|
693
|
-
/**
|
|
694
|
-
* Atualiza um perfil de acesso pelo id
|
|
695
|
-
*
|
|
696
|
-
* Exige a permissão `editar` da área `colaboradores`. Atualização parcial: só os campos enviados mudam. `nome` segue o limite do cadastro; `descricao` vazia apaga o valor; `permissoes`, quando enviado, substitui o conjunto inteiro (o que não vier fica `false`). Todo colaborador do perfil passa a valer com as novas permissões em até 5 minutos (cache do acesso).
|
|
697
|
-
*
|
|
698
|
-
* `PATCH /perfil_acesso/{id}`
|
|
699
|
-
*/
|
|
700
|
-
export declare function atualizar_pelo_id_perfil_acesso(credencial_de_acesso: CredencialDeAcesso, id: string, corpo_da_requisicao: tipos.PerfilAcessoAtualizar, opcoes_da_chamada?: OpcoesDaChamada): Promise<tipos.PerfilAcesso>;
|
|
701
|
-
/**
|
|
702
|
-
* Exclui um perfil de acesso pelo id
|
|
703
|
-
*
|
|
704
|
-
* Exige a permissão `deletar` da área `colaboradores`. A exclusão é lógica e só é aceita quando nenhum colaborador usa o perfil: com gente vinculada responde `409`, e é preciso trocar o perfil dessas pessoas antes.
|
|
705
|
-
*
|
|
706
|
-
* `DELETE /perfil_acesso/{id}`
|
|
707
|
-
*/
|
|
708
|
-
export declare function deletar_pelo_id_perfil_acesso(credencial_de_acesso: CredencialDeAcesso, id: string, opcoes_da_chamada?: OpcoesDaChamada): Promise<void>;
|
|
709
|
-
/**
|
|
710
|
-
* Lista os robôs com paginação
|
|
711
|
-
*
|
|
712
|
-
* Exige qualquer permissão da área `configuracoes` (qualquer ação liberada na área já libera a leitura). Ordena por nome. `pagina` começa em 1 (padrão 1; valores menores viram 1). A página tem sempre 50 itens: `tamanho` é aceito, mas ignorado. `total` conta todos os registros não excluídos.
|
|
713
|
-
*
|
|
714
|
-
* `GET /robo`
|
|
715
|
-
*/
|
|
716
|
-
export declare function buscar_paginador_robo(credencial_de_acesso: CredencialDeAcesso, parametros?: ParametrosDeBuscarPaginadorRobo, opcoes_da_chamada?: OpcoesDaChamada): Promise<tipos.PaginaRobo>;
|
|
717
4
|
/**
|
|
718
5
|
* Cadastra um robô de atendimento
|
|
719
6
|
*
|
|
@@ -722,46 +9,6 @@ export declare function buscar_paginador_robo(credencial_de_acesso: CredencialDe
|
|
|
722
9
|
* `POST /robo`
|
|
723
10
|
*/
|
|
724
11
|
export declare function criar_robo(credencial_de_acesso: CredencialDeAcesso, corpo_da_requisicao: tipos.RoboCriar, opcoes_da_chamada?: OpcoesDaChamada): Promise<tipos.Robo>;
|
|
725
|
-
/**
|
|
726
|
-
* Lista básica de robôs para seleção
|
|
727
|
-
*
|
|
728
|
-
* Exige qualquer permissão da área `configuracoes` (qualquer ação liberada na área já libera a leitura). Devolve só id, nome e modelo, em ordem alfabética de nome. `busca` procura por trecho do nome, sem diferenciar maiúsculas. `pagina` começa em 1 (padrão 1) e `tamanho` tem padrão 10, sem máximo; valores menores que 1 viram 1. `total` conta os registros que casam com a busca.
|
|
729
|
-
*
|
|
730
|
-
* `GET /robo/autocomplete`
|
|
731
|
-
*/
|
|
732
|
-
export declare function buscar_auto_complete_robo(credencial_de_acesso: CredencialDeAcesso, parametros?: ParametrosDeBuscarAutoCompleteRobo, opcoes_da_chamada?: OpcoesDaChamada): Promise<tipos.PaginaRoboAutoComplete>;
|
|
733
|
-
/**
|
|
734
|
-
* Lista as equipes do Chatwoot
|
|
735
|
-
*
|
|
736
|
-
* Exige qualquer permissão da área `configuracoes` (qualquer ação liberada na área já libera a leitura). Consulta na hora as equipes (id e nome) de uma conta do Chatwoot ativa, para escolher a `equipe_id` da etapa `atendimento` ou do `gatilho` do fluxo. Com `robo_id`, usa a conta do Chatwoot dos números de WhatsApp (Z-API ou QR Code) ligados a esse robô; sem `robo_id` ou sem número ligado, usa a primeira conta ativa.
|
|
737
|
-
*
|
|
738
|
-
* `GET /robo/equipes`
|
|
739
|
-
*/
|
|
740
|
-
export declare function buscar_equipes_robo(credencial_de_acesso: CredencialDeAcesso, parametros?: ParametrosDeBuscarEquipesRobo, opcoes_da_chamada?: OpcoesDaChamada): Promise<Array<tipos.EquipeChatwoot>>;
|
|
741
|
-
/**
|
|
742
|
-
* Busca robôs por filtro
|
|
743
|
-
*
|
|
744
|
-
* Exige qualquer permissão da área `configuracoes` (qualquer ação liberada na área já libera a leitura). Devolve todos os robôs que casam com o filtro, com o fluxo, sem paginação, em ordem alfabética de nome. `nome` e `modelo` procuram por trecho, sem diferenciar maiúsculas; `ativo` filtra pela situação. Sem filtro, devolve todos.
|
|
745
|
-
*
|
|
746
|
-
* `GET /robo/filtro`
|
|
747
|
-
*/
|
|
748
|
-
export declare function buscar_pelo_filtro_robo(credencial_de_acesso: CredencialDeAcesso, parametros?: ParametrosDeBuscarPeloFiltroRobo, opcoes_da_chamada?: OpcoesDaChamada): Promise<Array<tipos.Robo>>;
|
|
749
|
-
/**
|
|
750
|
-
* Lista os modelos de IA que o robô pode usar
|
|
751
|
-
*
|
|
752
|
-
* Exige qualquer permissão da área `configuracoes` (qualquer ação liberada na área já libera a leitura). Consulta na hora o gateway do TermoAI (`GET /gateway/modelos`, categoria `texto_para_texto`, com o token do aplicativo) e devolve as IAs com chave ativa lá: `provedor` (o valor que vai em `modelo` do robô), `empresa`, `modelo`, `url_da_logo`, `logo_monocromatica`, `gratuito`, `aceita_ferramentas` e `chaves_ativas`. O robô com `modelo` vazio deixa o TermoAI escolher; com um `provedor`, o TermoAI usa essa IA primeiro e só troca para outra quando ela falha.
|
|
753
|
-
*
|
|
754
|
-
* `GET /robo/modelos`
|
|
755
|
-
*/
|
|
756
|
-
export declare function buscar_modelos_robo(credencial_de_acesso: CredencialDeAcesso, opcoes_da_chamada?: OpcoesDaChamada): Promise<Array<tipos.ModeloDoGateway>>;
|
|
757
|
-
/**
|
|
758
|
-
* Busca um robô pelo id
|
|
759
|
-
*
|
|
760
|
-
* Exige qualquer permissão da área `configuracoes` (qualquer ação liberada na área já libera a leitura). Devolve o robô com o fluxo completo. Robô excluído responde `404`.
|
|
761
|
-
*
|
|
762
|
-
* `GET /robo/{id}`
|
|
763
|
-
*/
|
|
764
|
-
export declare function buscar_pelo_id_robo(credencial_de_acesso: CredencialDeAcesso, id: string, opcoes_da_chamada?: OpcoesDaChamada): Promise<tipos.Robo>;
|
|
765
12
|
/**
|
|
766
13
|
* Atualiza um robô pelo id
|
|
767
14
|
*
|
|
@@ -770,99 +17,3 @@ export declare function buscar_pelo_id_robo(credencial_de_acesso: CredencialDeAc
|
|
|
770
17
|
* `PATCH /robo/{id}`
|
|
771
18
|
*/
|
|
772
19
|
export declare function atualizar_pelo_id_robo(credencial_de_acesso: CredencialDeAcesso, id: string, corpo_da_requisicao: tipos.RoboAtualizar, opcoes_da_chamada?: OpcoesDaChamada): Promise<tipos.Robo>;
|
|
773
|
-
/**
|
|
774
|
-
* Exclui um robô pelo id
|
|
775
|
-
*
|
|
776
|
-
* Exige a permissão `deletar` da área `configuracoes`. A exclusão é lógica: o robô some das consultas, o nome fica livre para um novo cadastro e não há como restaurar.
|
|
777
|
-
*
|
|
778
|
-
* `DELETE /robo/{id}`
|
|
779
|
-
*/
|
|
780
|
-
export declare function deletar_pelo_id_robo(credencial_de_acesso: CredencialDeAcesso, id: string, opcoes_da_chamada?: OpcoesDaChamada): Promise<void>;
|
|
781
|
-
/**
|
|
782
|
-
* Lista as ferramentas com paginação
|
|
783
|
-
*
|
|
784
|
-
* Exige qualquer permissão da área `configuracoes` (qualquer ação liberada na área já libera a leitura). Ordena pelo rótulo. `pagina` começa em 1 (padrão 1; valores menores viram 1). A página tem sempre 50 itens: `tamanho` é aceito, mas ignorado. `total` conta todos os registros não excluídos.
|
|
785
|
-
*
|
|
786
|
-
* `GET /robo_ferramenta`
|
|
787
|
-
*/
|
|
788
|
-
export declare function buscar_paginador_robo_ferramenta(credencial_de_acesso: CredencialDeAcesso, parametros?: ParametrosDeBuscarPaginadorRoboFerramenta, opcoes_da_chamada?: OpcoesDaChamada): Promise<tipos.PaginaRoboFerramenta>;
|
|
789
|
-
/**
|
|
790
|
-
* Cadastra uma ferramenta do robô
|
|
791
|
-
*
|
|
792
|
-
* Exige a permissão `criar` da área `configuracoes`. Cadastra uma ferramenta que as etapas do robô podem liberar para a IA. `nome` é o nome técnico (só letras minúsculas, números e `_`, até 60 caracteres, único); `rotulo` (até 80) e `descricao` (até 500) são obrigatórios; `tipo` é `leitura` ou `escrita`; `exige_confirmacao` tem padrão `false`; `esquema` é o JSON Schema dos parâmetros (padrão: objeto sem propriedades). A ferramenta nasce ativa.
|
|
793
|
-
*
|
|
794
|
-
* `POST /robo_ferramenta`
|
|
795
|
-
*/
|
|
796
|
-
export declare function criar_robo_ferramenta(credencial_de_acesso: CredencialDeAcesso, corpo_da_requisicao: tipos.RoboFerramentaCriar, opcoes_da_chamada?: OpcoesDaChamada): Promise<tipos.RoboFerramenta>;
|
|
797
|
-
/**
|
|
798
|
-
* Lista básica de ferramentas para seleção
|
|
799
|
-
*
|
|
800
|
-
* Exige qualquer permissão da área `configuracoes` (qualquer ação liberada na área já libera a leitura). Devolve só id, nome técnico e rótulo das ferramentas ativas, em ordem alfabética do rótulo. `busca` procura por trecho do rótulo ou do nome técnico, sem diferenciar maiúsculas. `pagina` começa em 1 (padrão 1) e `tamanho` tem padrão 10, sem máximo; valores menores que 1 viram 1. `total` conta os registros que casam com a busca.
|
|
801
|
-
*
|
|
802
|
-
* `GET /robo_ferramenta/autocomplete`
|
|
803
|
-
*/
|
|
804
|
-
export declare function buscar_auto_complete_robo_ferramenta(credencial_de_acesso: CredencialDeAcesso, parametros?: ParametrosDeBuscarAutoCompleteRoboFerramenta, opcoes_da_chamada?: OpcoesDaChamada): Promise<tipos.PaginaRoboFerramentaAutoComplete>;
|
|
805
|
-
/**
|
|
806
|
-
* Busca ferramentas por filtro
|
|
807
|
-
*
|
|
808
|
-
* Exige qualquer permissão da área `configuracoes` (qualquer ação liberada na área já libera a leitura). Devolve todas as ferramentas que casam com o filtro, sem paginação, em ordem alfabética do rótulo. `nome` procura por trecho do nome técnico, sem diferenciar maiúsculas; `tipo` compara o valor exato (`leitura` ou `escrita`); `ativo` filtra pela situação. Sem filtro, devolve todas.
|
|
809
|
-
*
|
|
810
|
-
* `GET /robo_ferramenta/filtro`
|
|
811
|
-
*/
|
|
812
|
-
export declare function buscar_pelo_filtro_robo_ferramenta(credencial_de_acesso: CredencialDeAcesso, parametros?: ParametrosDeBuscarPeloFiltroRoboFerramenta, opcoes_da_chamada?: OpcoesDaChamada): Promise<Array<tipos.RoboFerramenta>>;
|
|
813
|
-
/**
|
|
814
|
-
* Busca uma ferramenta pelo id
|
|
815
|
-
*
|
|
816
|
-
* Exige qualquer permissão da área `configuracoes` (qualquer ação liberada na área já libera a leitura). Ferramenta excluída responde `404`.
|
|
817
|
-
*
|
|
818
|
-
* `GET /robo_ferramenta/{id}`
|
|
819
|
-
*/
|
|
820
|
-
export declare function buscar_pelo_id_robo_ferramenta(credencial_de_acesso: CredencialDeAcesso, id: string, opcoes_da_chamada?: OpcoesDaChamada): Promise<tipos.RoboFerramenta>;
|
|
821
|
-
/**
|
|
822
|
-
* Atualiza uma ferramenta pelo id
|
|
823
|
-
*
|
|
824
|
-
* Exige a permissão `editar` da área `configuracoes`. Atualização parcial: só os campos enviados mudam. `rotulo` (até 80) e `descricao` (até 500) não podem ficar vazios; `tipo` é `leitura` ou `escrita`; `esquema` substitui o JSON Schema inteiro; `ativo` liga ou desliga a ferramenta. O nome técnico não muda.
|
|
825
|
-
*
|
|
826
|
-
* `PATCH /robo_ferramenta/{id}`
|
|
827
|
-
*/
|
|
828
|
-
export declare function atualizar_pelo_id_robo_ferramenta(credencial_de_acesso: CredencialDeAcesso, id: string, corpo_da_requisicao: tipos.RoboFerramentaAtualizar, opcoes_da_chamada?: OpcoesDaChamada): Promise<tipos.RoboFerramenta>;
|
|
829
|
-
/**
|
|
830
|
-
* Exclui uma ferramenta pelo id
|
|
831
|
-
*
|
|
832
|
-
* Exige a permissão `deletar` da área `configuracoes`. A exclusão é lógica: a ferramenta some das consultas, o nome técnico fica livre e não há como restaurar.
|
|
833
|
-
*
|
|
834
|
-
* `DELETE /robo_ferramenta/{id}`
|
|
835
|
-
*/
|
|
836
|
-
export declare function deletar_pelo_id_robo_ferramenta(credencial_de_acesso: CredencialDeAcesso, id: string, opcoes_da_chamada?: OpcoesDaChamada): Promise<void>;
|
|
837
|
-
/**
|
|
838
|
-
* Verifica se o backend está no ar
|
|
839
|
-
*
|
|
840
|
-
* Pública, sem token. Responde `200` com `sucesso: true` e a versão do backend no ar (semver) sempre que o servidor está de pé; não consulta o banco nem o TermoAuth.
|
|
841
|
-
*
|
|
842
|
-
* `GET /test`
|
|
843
|
-
*/
|
|
844
|
-
export declare function verificar_saude_test(opcoes_da_chamada?: OpcoesDaChamada): Promise<tipos.SaudeDoBackend>;
|
|
845
|
-
/**
|
|
846
|
-
* Recebe os eventos do Chatwoot
|
|
847
|
-
*
|
|
848
|
-
* Pública, sem token do usuário: é chamada pelo robô de atendimento que o TermoSell cria na conta do Chatwoot, com o `segredo` da configuração no endereço. O corpo é o evento do Chatwoot como ele envia. Só `message_created` que não é nota privada e chega por uma caixa ligada a um número da Z-API é tratado: mensagem da equipe vai para o WhatsApp pela Z-API, e mensagem do cliente numa conversa pendente é respondida pelo robô em segundo plano, seguindo o fluxo do robô do número. O resto é ignorado com `200`.
|
|
849
|
-
*
|
|
850
|
-
* `POST /webhooks/chatwoot`
|
|
851
|
-
*/
|
|
852
|
-
export declare function receber_evento_chatwoot_webhooks(parametros: ParametrosDeReceberEventoChatwootWebhooks, corpo_da_requisicao: tipos.EventoDoChatwoot, opcoes_da_chamada?: OpcoesDaChamada): Promise<void>;
|
|
853
|
-
/**
|
|
854
|
-
* Recebe as entregas do TermoWebhook
|
|
855
|
-
*
|
|
856
|
-
* Pública, sem token do usuário: é chamada pelo TermoWebhook, o hub de eventos da Termotubos, para entregar os eventos que o TermoSell assina. A entrega é conferida pela assinatura Ed25519 do hub (chave pública em `/.well-known/jwks.json` do TermoWebhook), pela data e pelo destino, que precisa ser o próprio TermoSell. Eventos tratados: `colaborador.criado` e `colaborador.atualizado`, versões 1 e 2, publicados pelo TermoAuth: criam ou atualizam o colaborador e o acesso dele (a v2 também traz setor, cargo e função), descartando o evento mais antigo que o último aplicado. Qualquer outro tipo responde `200` sem fazer nada. Como o hub entrega pelo menos uma vez, repetir o mesmo evento é seguro.
|
|
857
|
-
*
|
|
858
|
-
* `POST /webhooks/termowebhook`
|
|
859
|
-
*/
|
|
860
|
-
export declare function receber_evento_termo_webhook_webhooks(parametros: ParametrosDeReceberEventoTermoWebhookWebhooks, corpo_da_requisicao: tipos.EntregaDoTermoWebhook, opcoes_da_chamada?: OpcoesDaChamada): Promise<void>;
|
|
861
|
-
/**
|
|
862
|
-
* Recebe as mensagens do WhatsApp pela Z-API
|
|
863
|
-
*
|
|
864
|
-
* Pública, sem token do usuário: é chamada pela Z-API, com o `segredo` do número no endereço. O corpo é o evento da Z-API como ela envia; o `instanceId` dele precisa ser o da instância do número dono do `segredo`. Mensagem recebida de conversa individual, num número ativo e ligado a uma caixa do Chatwoot, é registrada no Chatwoot (a mesma mensagem não é registrada duas vezes); grupos, canais, transmissões e ecos do próprio sistema são ignorados com `200`.
|
|
865
|
-
*
|
|
866
|
-
* `POST /webhooks/z_api`
|
|
867
|
-
*/
|
|
868
|
-
export declare function receber_evento_z_api_webhooks(parametros: ParametrosDeReceberEventoZApiWebhooks, corpo_da_requisicao: tipos.EventoDaZApi, opcoes_da_chamada?: OpcoesDaChamada): Promise<void>;
|