termo_core 0.1.15 → 0.1.17
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 +59 -2
- package/dist/flow/rotas.js +69 -2
- package/dist/flow/tipos.d.ts +30 -2
- package/dist/support/rotas.d.ts +16 -0
- package/dist/support/rotas.js +34 -0
- package/dist/support/tipos.d.ts +39 -0
- package/package.json +1 -1
package/dist/flow/rotas.d.ts
CHANGED
|
@@ -1,18 +1,75 @@
|
|
|
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 `/robo`.
|
|
6
|
+
*/
|
|
7
|
+
export interface ParametrosDeBuscarPaginadorRobo {
|
|
8
|
+
pagina?: number;
|
|
9
|
+
tamanho?: number;
|
|
10
|
+
busca?: string;
|
|
11
|
+
ativo?: boolean;
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* Parâmetros de consulta e de cabeçalho de `/robo/autocomplete`.
|
|
15
|
+
*/
|
|
16
|
+
export interface ParametrosDeBuscarAutoCompleteRobo {
|
|
17
|
+
busca?: string;
|
|
18
|
+
pagina?: number;
|
|
19
|
+
tamanho?: number;
|
|
20
|
+
}
|
|
21
|
+
/**
|
|
22
|
+
* Parâmetros de consulta e de cabeçalho de `/robo/filtro`.
|
|
23
|
+
*/
|
|
24
|
+
export interface ParametrosDeBuscarPeloFiltroRobo {
|
|
25
|
+
nome?: string;
|
|
26
|
+
modelo?: string;
|
|
27
|
+
ativo?: boolean;
|
|
28
|
+
}
|
|
29
|
+
/**
|
|
30
|
+
* Lista os robôs com paginação
|
|
31
|
+
*
|
|
32
|
+
* Exige qualquer permissão da área `robos`, `whatsapp` ou `chatwoot` (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. `busca` (opcional) procura no nome, na descrição e no modelo; `ativo` (opcional) traz só os ativos ou só os inativos. `total` conta os robôs não excluídos que casam com a busca.
|
|
33
|
+
*
|
|
34
|
+
* `GET /robo`
|
|
35
|
+
*/
|
|
36
|
+
export declare function buscar_paginador_robo(credencial_de_acesso: CredencialDeAcesso, parametros?: ParametrosDeBuscarPaginadorRobo, opcoes_da_chamada?: OpcoesDaChamada): Promise<tipos.PaginaRobo>;
|
|
4
37
|
/**
|
|
5
38
|
* Cadastra um robô de atendimento
|
|
6
39
|
*
|
|
7
|
-
* Exige a permissão `criar` da área `robos`. `nome` é obrigatório (até 80 caracteres, único entre os robôs); `modelo` é a IA preferida do gateway do TermoAI, um `provedor` de `GET /robo/modelos` (opcional, até 80; vazio deixa o TermoAI escolher); `descricao` vai até 200 e `prompt_base` até 4000 (padrão vazio). Sem `fluxo`, o robô nasce só com a etapa de início. O robô nasce ativo, na versão 1. `fluxo` é o caminho do atendimento: `nos` (até 40 etapas, exatamente uma do tipo `inicio`; os outros tipos são `inicio_contato_novo`, `instrucao`, `mensagem`, `botoes`, `atendimento` e `gatilho`) e `ligacoes` (`origem`, `destino` e `origem_saida`, que é o id do botão ou da regra de onde a ligação sai, `null` no início e na mensagem). Cada etapa fora o início precisa de `nome` (até 60 caracteres); `objetivo` vai até 200, `instrucao` até 2000 e `mensagem` até 1000; `ferramentas` lista até 20 ids de ferramentas do robô. A `instrucao` precisa de 1 a 10 `regras` de saída (`condicao` até 200 caracteres); `botoes` precisa de 1 a 10 botões (`rotulo` até 20 caracteres) e de texto fixo em `mensagem` ou, com `mensagem_por_ia`, da `instrucao` para a IA escrever; `mensagem` também exige texto fixo ou `mensagem_por_ia`; `atendimento` encerra o robô, passa a conversa para a equipe do Chatwoot em `equipe_id` (opcional, de `GET /robo/equipes`) e não tem saída; `gatilho` (no máximo um, sem ligação de entrada nem de saída) é o gatilho de cliente sem resposta: `minutos_sem_resposta` (1 a 1440) e `
|
|
40
|
+
* Exige a permissão `criar` da área `robos`. `nome` é obrigatório (até 80 caracteres, único entre os robôs); `modelo` é a IA preferida do gateway do TermoAI, um `provedor` de `GET /robo/modelos` (opcional, até 80; vazio deixa o TermoAI escolher); `descricao` vai até 200 e `prompt_base` até 4000 (padrão vazio). Sem `fluxo`, o robô nasce só com a etapa de início. O robô nasce ativo, na versão 1. `fluxo` é o caminho do atendimento: `nos` (até 40 etapas, exatamente uma do tipo `inicio`; os outros tipos são `inicio_contato_novo`, `instrucao`, `mensagem`, `botoes`, `atendimento`, `vendedor` e `gatilho`) e `ligacoes` (`origem`, `destino` e `origem_saida`, que é o id do botão ou da regra de onde a ligação sai, `null` no início e na mensagem). Cada etapa fora o início precisa de `nome` (até 60 caracteres); `objetivo` vai até 200, `instrucao` até 2000 e `mensagem` até 1000; `ferramentas` lista até 20 ids de ferramentas do robô. A `instrucao` precisa de 1 a 10 `regras` de saída (`condicao` até 200 caracteres); `botoes` precisa de 1 a 10 botões (`rotulo` até 20 caracteres) e de texto fixo em `mensagem` ou, com `mensagem_por_ia`, da `instrucao` para a IA escrever; `mensagem` também exige texto fixo ou `mensagem_por_ia`; `atendimento` encerra o robô, passa a conversa para a equipe do Chatwoot em `equipe_id` (opcional, de `GET /robo/equipes`) e, se vier `vendedor_id` (opcional, de `GET /robo/vendedores?equipe_id=`), para esse vendedor da equipe, e não tem saída; `vendedor` encerra o robô do mesmo jeito, mas passa a conversa só para o vendedor do Chatwoot em `vendedor_id` (obrigatório, de `GET /robo/vendedores`), sem equipe; `gatilho` (no máximo um, sem ligação de entrada nem de saída) é o gatilho de cliente sem resposta: `minutos_sem_resposta` (1 a 1440), `equipe_id` e `vendedor_id` opcionais (um, os dois ou nenhum), e uma varredura a cada minuto passa para essa equipe e esse vendedor toda conversa com o robô em que o cliente ficou esse tempo sem responder. Ids de etapas, botões e regras são únicos; nenhuma ligação volta ao início nem liga a etapa nela mesma, e cada saída tem no máximo uma próxima etapa. `inicio_contato_novo` (no máximo um, sem ligação de entrada) é o início de quem não está na lista de clientes: com ele no fluxo o robô atende contatos novos (sem ele, o contato novo vai para a equipe) e, sem ligação, o contato novo sai pelo `inicio`. O texto fixo aceita marcadores como `{{cliente.nome}}` e `{{ultimo_pedido.itens}}`.
|
|
8
41
|
*
|
|
9
42
|
* `POST /robo`
|
|
10
43
|
*/
|
|
11
44
|
export declare function criar_robo(credencial_de_acesso: CredencialDeAcesso, corpo_da_requisicao: tipos.RoboCriar, opcoes_da_chamada?: OpcoesDaChamada): Promise<tipos.Robo>;
|
|
45
|
+
/**
|
|
46
|
+
* Lista básica de robôs para seleção
|
|
47
|
+
*
|
|
48
|
+
* Exige qualquer permissão da área `robos`, `whatsapp` ou `chatwoot` (qualquer ação liberada na área já libera a leitura). Devolve só id, nome e modelo, em ordem alfabética de nome, para achar o id de um robô. `busca` procura por trecho do nome, sem diferenciar maiúsculas. `pagina` começa em 1 (padrão 1) e `tamanho` tem padrão 10; valores menores que 1 viram 1. `total` conta os robôs que casam com a busca.
|
|
49
|
+
*
|
|
50
|
+
* `GET /robo/autocomplete`
|
|
51
|
+
*/
|
|
52
|
+
export declare function buscar_auto_complete_robo(credencial_de_acesso: CredencialDeAcesso, parametros?: ParametrosDeBuscarAutoCompleteRobo, opcoes_da_chamada?: OpcoesDaChamada): Promise<tipos.PaginaDeRoboAutoComplete>;
|
|
53
|
+
/**
|
|
54
|
+
* Busca robôs por filtro
|
|
55
|
+
*
|
|
56
|
+
* Exige qualquer permissão da área `robos`, `whatsapp` ou `chatwoot` (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.
|
|
57
|
+
*
|
|
58
|
+
* `GET /robo/filtro`
|
|
59
|
+
*/
|
|
60
|
+
export declare function buscar_pelo_filtro_robo(credencial_de_acesso: CredencialDeAcesso, parametros?: ParametrosDeBuscarPeloFiltroRobo, opcoes_da_chamada?: OpcoesDaChamada): Promise<Array<tipos.Robo>>;
|
|
61
|
+
/**
|
|
62
|
+
* Busca um robô pelo id
|
|
63
|
+
*
|
|
64
|
+
* Exige qualquer permissão da área `robos`, `whatsapp` ou `chatwoot` (qualquer ação liberada na área já libera a leitura). Devolve o robô com o prompt e o fluxo completo (etapas e ligações), no mesmo formato aceito pelo `PATCH`. Robô excluído responde `404`.
|
|
65
|
+
*
|
|
66
|
+
* `GET /robo/{id}`
|
|
67
|
+
*/
|
|
68
|
+
export declare function buscar_pelo_id_robo(credencial_de_acesso: CredencialDeAcesso, id: string, opcoes_da_chamada?: OpcoesDaChamada): Promise<tipos.Robo>;
|
|
12
69
|
/**
|
|
13
70
|
* Atualiza um robô pelo id
|
|
14
71
|
*
|
|
15
|
-
* Exige a permissão `editar` da área `robos`. Atualização parcial: só os campos enviados mudam, com os mesmos limites do cadastro; `descricao` vazia apaga o valor `ativo` liga ou desliga o
|
|
72
|
+
* Exige a permissão `editar` da área `robos`. Atualização parcial: só os campos enviados mudam, com os mesmos limites do cadastro; `descricao` vazia apaga o valor `ativo` liga ou desliga o robô. `fluxo`, quando enviado, substitui o fluxo inteiro. Enviar `prompt_base` ou `fluxo` sobe a `versao` em 1. `fluxo` é o caminho do atendimento: `nos` (até 40 etapas, exatamente uma do tipo `inicio`; os outros tipos são `inicio_contato_novo`, `instrucao`, `mensagem`, `botoes`, `atendimento`, `vendedor` e `gatilho`) e `ligacoes` (`origem`, `destino` e `origem_saida`, que é o id do botão ou da regra de onde a ligação sai, `null` no início e na mensagem). Cada etapa fora o início precisa de `nome` (até 60 caracteres); `objetivo` vai até 200, `instrucao` até 2000 e `mensagem` até 1000; `ferramentas` lista até 20 ids de ferramentas do robô. A `instrucao` precisa de 1 a 10 `regras` de saída (`condicao` até 200 caracteres); `botoes` precisa de 1 a 10 botões (`rotulo` até 20 caracteres) e de texto fixo em `mensagem` ou, com `mensagem_por_ia`, da `instrucao` para a IA escrever; `mensagem` também exige texto fixo ou `mensagem_por_ia`; `atendimento` encerra o robô, passa a conversa para a equipe do Chatwoot em `equipe_id` (opcional, de `GET /robo/equipes`) e, se vier `vendedor_id` (opcional, de `GET /robo/vendedores?equipe_id=`), para esse vendedor da equipe, e não tem saída; `vendedor` encerra o robô do mesmo jeito, mas passa a conversa só para o vendedor do Chatwoot em `vendedor_id` (obrigatório, de `GET /robo/vendedores`), sem equipe; `gatilho` (no máximo um, sem ligação de entrada nem de saída) é o gatilho de cliente sem resposta: `minutos_sem_resposta` (1 a 1440), `equipe_id` e `vendedor_id` opcionais (um, os dois ou nenhum), e uma varredura a cada minuto passa para essa equipe e esse vendedor toda conversa com o robô em que o cliente ficou esse tempo sem responder. Ids de etapas, botões e regras são únicos; nenhuma ligação volta ao início nem liga a etapa nela mesma, e cada saída tem no máximo uma próxima etapa. `inicio_contato_novo` (no máximo um, sem ligação de entrada) é o início de quem não está na lista de clientes: com ele no fluxo o robô atende contatos novos (sem ele, o contato novo vai para a equipe) e, sem ligação, o contato novo sai pelo `inicio`. O texto fixo aceita marcadores como `{{cliente.nome}}` e `{{ultimo_pedido.itens}}`.
|
|
16
73
|
*
|
|
17
74
|
* `PATCH /robo/{id}`
|
|
18
75
|
*/
|
package/dist/flow/rotas.js
CHANGED
|
@@ -1,10 +1,27 @@
|
|
|
1
1
|
// Gerado pelo gerador do TermoCore (`cargo run -p gerador`). Não edite à mão: a próxima geração sobrescreve.
|
|
2
2
|
import { chamar_servico, codificar_parametro_de_caminho } from "../base/requisicao.js";
|
|
3
3
|
import { TERMO_FLOW as SERVICO_DESTA_API } from "../base/servicos.js";
|
|
4
|
+
/**
|
|
5
|
+
* Lista os robôs com paginação
|
|
6
|
+
*
|
|
7
|
+
* Exige qualquer permissão da área `robos`, `whatsapp` ou `chatwoot` (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. `busca` (opcional) procura no nome, na descrição e no modelo; `ativo` (opcional) traz só os ativos ou só os inativos. `total` conta os robôs não excluídos que casam com a busca.
|
|
8
|
+
*
|
|
9
|
+
* `GET /robo`
|
|
10
|
+
*/
|
|
11
|
+
export function buscar_paginador_robo(credencial_de_acesso, parametros = {}, opcoes_da_chamada) {
|
|
12
|
+
return chamar_servico({
|
|
13
|
+
servico: SERVICO_DESTA_API,
|
|
14
|
+
metodo_http: "GET",
|
|
15
|
+
caminho_da_rota: "/robo",
|
|
16
|
+
credencial_de_acesso,
|
|
17
|
+
parametros_de_consulta: parametros,
|
|
18
|
+
formato_da_resposta: "json",
|
|
19
|
+
}, opcoes_da_chamada);
|
|
20
|
+
}
|
|
4
21
|
/**
|
|
5
22
|
* Cadastra um robô de atendimento
|
|
6
23
|
*
|
|
7
|
-
* Exige a permissão `criar` da área `robos`. `nome` é obrigatório (até 80 caracteres, único entre os robôs); `modelo` é a IA preferida do gateway do TermoAI, um `provedor` de `GET /robo/modelos` (opcional, até 80; vazio deixa o TermoAI escolher); `descricao` vai até 200 e `prompt_base` até 4000 (padrão vazio). Sem `fluxo`, o robô nasce só com a etapa de início. O robô nasce ativo, na versão 1. `fluxo` é o caminho do atendimento: `nos` (até 40 etapas, exatamente uma do tipo `inicio`; os outros tipos são `inicio_contato_novo`, `instrucao`, `mensagem`, `botoes`, `atendimento` e `gatilho`) e `ligacoes` (`origem`, `destino` e `origem_saida`, que é o id do botão ou da regra de onde a ligação sai, `null` no início e na mensagem). Cada etapa fora o início precisa de `nome` (até 60 caracteres); `objetivo` vai até 200, `instrucao` até 2000 e `mensagem` até 1000; `ferramentas` lista até 20 ids de ferramentas do robô. A `instrucao` precisa de 1 a 10 `regras` de saída (`condicao` até 200 caracteres); `botoes` precisa de 1 a 10 botões (`rotulo` até 20 caracteres) e de texto fixo em `mensagem` ou, com `mensagem_por_ia`, da `instrucao` para a IA escrever; `mensagem` também exige texto fixo ou `mensagem_por_ia`; `atendimento` encerra o robô, passa a conversa para a equipe do Chatwoot em `equipe_id` (opcional, de `GET /robo/equipes`) e não tem saída; `gatilho` (no máximo um, sem ligação de entrada nem de saída) é o gatilho de cliente sem resposta: `minutos_sem_resposta` (1 a 1440) e `
|
|
24
|
+
* Exige a permissão `criar` da área `robos`. `nome` é obrigatório (até 80 caracteres, único entre os robôs); `modelo` é a IA preferida do gateway do TermoAI, um `provedor` de `GET /robo/modelos` (opcional, até 80; vazio deixa o TermoAI escolher); `descricao` vai até 200 e `prompt_base` até 4000 (padrão vazio). Sem `fluxo`, o robô nasce só com a etapa de início. O robô nasce ativo, na versão 1. `fluxo` é o caminho do atendimento: `nos` (até 40 etapas, exatamente uma do tipo `inicio`; os outros tipos são `inicio_contato_novo`, `instrucao`, `mensagem`, `botoes`, `atendimento`, `vendedor` e `gatilho`) e `ligacoes` (`origem`, `destino` e `origem_saida`, que é o id do botão ou da regra de onde a ligação sai, `null` no início e na mensagem). Cada etapa fora o início precisa de `nome` (até 60 caracteres); `objetivo` vai até 200, `instrucao` até 2000 e `mensagem` até 1000; `ferramentas` lista até 20 ids de ferramentas do robô. A `instrucao` precisa de 1 a 10 `regras` de saída (`condicao` até 200 caracteres); `botoes` precisa de 1 a 10 botões (`rotulo` até 20 caracteres) e de texto fixo em `mensagem` ou, com `mensagem_por_ia`, da `instrucao` para a IA escrever; `mensagem` também exige texto fixo ou `mensagem_por_ia`; `atendimento` encerra o robô, passa a conversa para a equipe do Chatwoot em `equipe_id` (opcional, de `GET /robo/equipes`) e, se vier `vendedor_id` (opcional, de `GET /robo/vendedores?equipe_id=`), para esse vendedor da equipe, e não tem saída; `vendedor` encerra o robô do mesmo jeito, mas passa a conversa só para o vendedor do Chatwoot em `vendedor_id` (obrigatório, de `GET /robo/vendedores`), sem equipe; `gatilho` (no máximo um, sem ligação de entrada nem de saída) é o gatilho de cliente sem resposta: `minutos_sem_resposta` (1 a 1440), `equipe_id` e `vendedor_id` opcionais (um, os dois ou nenhum), e uma varredura a cada minuto passa para essa equipe e esse vendedor toda conversa com o robô em que o cliente ficou esse tempo sem responder. Ids de etapas, botões e regras são únicos; nenhuma ligação volta ao início nem liga a etapa nela mesma, e cada saída tem no máximo uma próxima etapa. `inicio_contato_novo` (no máximo um, sem ligação de entrada) é o início de quem não está na lista de clientes: com ele no fluxo o robô atende contatos novos (sem ele, o contato novo vai para a equipe) e, sem ligação, o contato novo sai pelo `inicio`. O texto fixo aceita marcadores como `{{cliente.nome}}` e `{{ultimo_pedido.itens}}`.
|
|
8
25
|
*
|
|
9
26
|
* `POST /robo`
|
|
10
27
|
*/
|
|
@@ -18,10 +35,60 @@ export function criar_robo(credencial_de_acesso, corpo_da_requisicao, opcoes_da_
|
|
|
18
35
|
formato_da_resposta: "json",
|
|
19
36
|
}, opcoes_da_chamada);
|
|
20
37
|
}
|
|
38
|
+
/**
|
|
39
|
+
* Lista básica de robôs para seleção
|
|
40
|
+
*
|
|
41
|
+
* Exige qualquer permissão da área `robos`, `whatsapp` ou `chatwoot` (qualquer ação liberada na área já libera a leitura). Devolve só id, nome e modelo, em ordem alfabética de nome, para achar o id de um robô. `busca` procura por trecho do nome, sem diferenciar maiúsculas. `pagina` começa em 1 (padrão 1) e `tamanho` tem padrão 10; valores menores que 1 viram 1. `total` conta os robôs que casam com a busca.
|
|
42
|
+
*
|
|
43
|
+
* `GET /robo/autocomplete`
|
|
44
|
+
*/
|
|
45
|
+
export function buscar_auto_complete_robo(credencial_de_acesso, parametros = {}, opcoes_da_chamada) {
|
|
46
|
+
return chamar_servico({
|
|
47
|
+
servico: SERVICO_DESTA_API,
|
|
48
|
+
metodo_http: "GET",
|
|
49
|
+
caminho_da_rota: "/robo/autocomplete",
|
|
50
|
+
credencial_de_acesso,
|
|
51
|
+
parametros_de_consulta: parametros,
|
|
52
|
+
formato_da_resposta: "json",
|
|
53
|
+
}, opcoes_da_chamada);
|
|
54
|
+
}
|
|
55
|
+
/**
|
|
56
|
+
* Busca robôs por filtro
|
|
57
|
+
*
|
|
58
|
+
* Exige qualquer permissão da área `robos`, `whatsapp` ou `chatwoot` (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.
|
|
59
|
+
*
|
|
60
|
+
* `GET /robo/filtro`
|
|
61
|
+
*/
|
|
62
|
+
export function buscar_pelo_filtro_robo(credencial_de_acesso, parametros = {}, opcoes_da_chamada) {
|
|
63
|
+
return chamar_servico({
|
|
64
|
+
servico: SERVICO_DESTA_API,
|
|
65
|
+
metodo_http: "GET",
|
|
66
|
+
caminho_da_rota: "/robo/filtro",
|
|
67
|
+
credencial_de_acesso,
|
|
68
|
+
parametros_de_consulta: parametros,
|
|
69
|
+
formato_da_resposta: "json",
|
|
70
|
+
}, opcoes_da_chamada);
|
|
71
|
+
}
|
|
72
|
+
/**
|
|
73
|
+
* Busca um robô pelo id
|
|
74
|
+
*
|
|
75
|
+
* Exige qualquer permissão da área `robos`, `whatsapp` ou `chatwoot` (qualquer ação liberada na área já libera a leitura). Devolve o robô com o prompt e o fluxo completo (etapas e ligações), no mesmo formato aceito pelo `PATCH`. Robô excluído responde `404`.
|
|
76
|
+
*
|
|
77
|
+
* `GET /robo/{id}`
|
|
78
|
+
*/
|
|
79
|
+
export function buscar_pelo_id_robo(credencial_de_acesso, id, opcoes_da_chamada) {
|
|
80
|
+
return chamar_servico({
|
|
81
|
+
servico: SERVICO_DESTA_API,
|
|
82
|
+
metodo_http: "GET",
|
|
83
|
+
caminho_da_rota: `/robo/${codificar_parametro_de_caminho(id)}`,
|
|
84
|
+
credencial_de_acesso,
|
|
85
|
+
formato_da_resposta: "json",
|
|
86
|
+
}, opcoes_da_chamada);
|
|
87
|
+
}
|
|
21
88
|
/**
|
|
22
89
|
* Atualiza um robô pelo id
|
|
23
90
|
*
|
|
24
|
-
* Exige a permissão `editar` da área `robos`. Atualização parcial: só os campos enviados mudam, com os mesmos limites do cadastro; `descricao` vazia apaga o valor `ativo` liga ou desliga o
|
|
91
|
+
* Exige a permissão `editar` da área `robos`. Atualização parcial: só os campos enviados mudam, com os mesmos limites do cadastro; `descricao` vazia apaga o valor `ativo` liga ou desliga o robô. `fluxo`, quando enviado, substitui o fluxo inteiro. Enviar `prompt_base` ou `fluxo` sobe a `versao` em 1. `fluxo` é o caminho do atendimento: `nos` (até 40 etapas, exatamente uma do tipo `inicio`; os outros tipos são `inicio_contato_novo`, `instrucao`, `mensagem`, `botoes`, `atendimento`, `vendedor` e `gatilho`) e `ligacoes` (`origem`, `destino` e `origem_saida`, que é o id do botão ou da regra de onde a ligação sai, `null` no início e na mensagem). Cada etapa fora o início precisa de `nome` (até 60 caracteres); `objetivo` vai até 200, `instrucao` até 2000 e `mensagem` até 1000; `ferramentas` lista até 20 ids de ferramentas do robô. A `instrucao` precisa de 1 a 10 `regras` de saída (`condicao` até 200 caracteres); `botoes` precisa de 1 a 10 botões (`rotulo` até 20 caracteres) e de texto fixo em `mensagem` ou, com `mensagem_por_ia`, da `instrucao` para a IA escrever; `mensagem` também exige texto fixo ou `mensagem_por_ia`; `atendimento` encerra o robô, passa a conversa para a equipe do Chatwoot em `equipe_id` (opcional, de `GET /robo/equipes`) e, se vier `vendedor_id` (opcional, de `GET /robo/vendedores?equipe_id=`), para esse vendedor da equipe, e não tem saída; `vendedor` encerra o robô do mesmo jeito, mas passa a conversa só para o vendedor do Chatwoot em `vendedor_id` (obrigatório, de `GET /robo/vendedores`), sem equipe; `gatilho` (no máximo um, sem ligação de entrada nem de saída) é o gatilho de cliente sem resposta: `minutos_sem_resposta` (1 a 1440), `equipe_id` e `vendedor_id` opcionais (um, os dois ou nenhum), e uma varredura a cada minuto passa para essa equipe e esse vendedor toda conversa com o robô em que o cliente ficou esse tempo sem responder. Ids de etapas, botões e regras são únicos; nenhuma ligação volta ao início nem liga a etapa nela mesma, e cada saída tem no máximo uma próxima etapa. `inicio_contato_novo` (no máximo um, sem ligação de entrada) é o início de quem não está na lista de clientes: com ele no fluxo o robô atende contatos novos (sem ele, o contato novo vai para a equipe) e, sem ligação, o contato novo sai pelo `inicio`. O texto fixo aceita marcadores como `{{cliente.nome}}` e `{{ultimo_pedido.itens}}`.
|
|
25
92
|
*
|
|
26
93
|
* `PATCH /robo/{id}`
|
|
27
94
|
*/
|
package/dist/flow/tipos.d.ts
CHANGED
|
@@ -1,8 +1,31 @@
|
|
|
1
|
+
export interface PaginaDeRoboAutoComplete {
|
|
2
|
+
itens: Array<RoboAutoComplete>;
|
|
3
|
+
pagina: number;
|
|
4
|
+
tamanho: number;
|
|
5
|
+
total: number;
|
|
6
|
+
}
|
|
7
|
+
export interface PaginaRoboItensItem {
|
|
8
|
+
ativo: boolean;
|
|
9
|
+
atualizado_em: string;
|
|
10
|
+
criado_em: string;
|
|
11
|
+
descricao?: string | null;
|
|
12
|
+
fluxo: RoboFluxo;
|
|
13
|
+
id: string;
|
|
14
|
+
modelo: string;
|
|
15
|
+
nome: string;
|
|
16
|
+
prompt_base: string;
|
|
17
|
+
versao: number;
|
|
18
|
+
}
|
|
19
|
+
export interface PaginaRobo {
|
|
20
|
+
itens: Array<PaginaRoboItensItem>;
|
|
21
|
+
pagina: number;
|
|
22
|
+
tamanho: number;
|
|
23
|
+
total: number;
|
|
24
|
+
}
|
|
1
25
|
export interface RespostaDeErro {
|
|
2
26
|
erro: string;
|
|
3
27
|
}
|
|
4
28
|
export interface Robo {
|
|
5
|
-
atender_contatos_novos: boolean;
|
|
6
29
|
ativo: boolean;
|
|
7
30
|
atualizado_em: string;
|
|
8
31
|
criado_em: string;
|
|
@@ -15,7 +38,6 @@ export interface Robo {
|
|
|
15
38
|
versao: number;
|
|
16
39
|
}
|
|
17
40
|
export interface RoboAtualizar {
|
|
18
|
-
atender_contatos_novos?: boolean | null;
|
|
19
41
|
ativo?: boolean | null;
|
|
20
42
|
descricao?: string | null;
|
|
21
43
|
fluxo?: RoboFluxo | null;
|
|
@@ -23,6 +45,11 @@ export interface RoboAtualizar {
|
|
|
23
45
|
nome?: string | null;
|
|
24
46
|
prompt_base?: string | null;
|
|
25
47
|
}
|
|
48
|
+
export interface RoboAutoComplete {
|
|
49
|
+
id: string;
|
|
50
|
+
modelo: string;
|
|
51
|
+
nome: string;
|
|
52
|
+
}
|
|
26
53
|
export interface RoboBotao {
|
|
27
54
|
id: string;
|
|
28
55
|
rotulo: string;
|
|
@@ -58,6 +85,7 @@ export interface RoboNo {
|
|
|
58
85
|
posicao: RoboPosicao;
|
|
59
86
|
regras?: Array<RoboRegra>;
|
|
60
87
|
tipo: string;
|
|
88
|
+
vendedor_id?: number | null;
|
|
61
89
|
}
|
|
62
90
|
export interface RoboPosicao {
|
|
63
91
|
x?: number;
|
package/dist/support/rotas.d.ts
CHANGED
|
@@ -742,6 +742,22 @@ export declare function criar_tarefa(credencial_de_acesso: CredencialDeAcesso, c
|
|
|
742
742
|
* `GET /tarefa/autocomplete`
|
|
743
743
|
*/
|
|
744
744
|
export declare function buscar_auto_complete_tarefa(credencial_de_acesso: CredencialDeAcesso, parametros?: ParametrosDeBuscarAutoCompleteTarefa, opcoes_da_chamada?: OpcoesDaChamada): Promise<tipos.PaginaTarefaAutoComplete>;
|
|
745
|
+
/**
|
|
746
|
+
* Aplica a mesma mudança em várias tarefas
|
|
747
|
+
*
|
|
748
|
+
* Exige a permissão `editar` na área `projetos`. Aplica a mesma mudança em 1 a 500 tarefas (`tarefa_ids`, sem repetição), com pelo menos um destes campos: `secao_id` leva as tarefas principais para o fim dessa coluna, na ordem pedida (as tarefas e a coluna precisam ser do mesmo projeto); `responsavel_id` troca o responsável (`null` tira); `prazo` troca o prazo (`null` apaga; não pode ficar antes do início de nenhuma); `etiqueta_adicionar` põe a etiqueta em quem não a tem e `etiqueta_remover` tira de quem tem. Tudo é conferido antes de gravar: uma tarefa inexistente, subtarefa (com `secao_id`), de outro projeto ou com prazo antes do início recusa o pedido inteiro. A tarefa em que nada muda fica como está. Vale a regra da coluna que conclui do `PATCH /tarefa/{id}`: entrar nela conclui e sair reabre. Cada tarefa alterada ganha as linhas na atividade; o novo responsável e, ao concluir, o criador recebem notificação. Devolve as tarefas pedidas, já atualizadas, na ordem pedida. As tarefas são gravadas uma a uma: se o pedido parar no meio, repeti-lo completa só o que faltou. Visibilidade: projeto com `visibilidade` `MEMBROS` só aparece para o dono, os membros e o master do TermoAuth; para os demais a coluna e as tarefas dele respondem `404`. O responsável sempre enxerga a própria tarefa.
|
|
749
|
+
*
|
|
750
|
+
* `PATCH /tarefa/em_massa`
|
|
751
|
+
*/
|
|
752
|
+
export declare function atualizar_em_massa_tarefa(credencial_de_acesso: CredencialDeAcesso, corpo_da_requisicao: tipos.TarefaAtualizarEmMassa, opcoes_da_chamada?: OpcoesDaChamada): Promise<Array<tipos.Tarefa>>;
|
|
753
|
+
/**
|
|
754
|
+
* Exclui várias tarefas
|
|
755
|
+
*
|
|
756
|
+
* Exige a permissão `deletar` na área `projetos`. Exclusão lógica de 1 a 500 tarefas (`tarefa_ids`, sem repetição) e das subtarefas delas. Tudo é conferido antes de gravar: uma tarefa inexistente ou já excluída recusa o pedido inteiro. As tarefas são excluídas uma a uma: se o pedido parar no meio, repeti-lo com as que sobraram termina a exclusão. Visibilidade: projeto com `visibilidade` `MEMBROS` só aparece para o dono, os membros e o master do TermoAuth; para os demais as tarefas dele respondem `404`. O responsável sempre enxerga a própria tarefa.
|
|
757
|
+
*
|
|
758
|
+
* `DELETE /tarefa/em_massa`
|
|
759
|
+
*/
|
|
760
|
+
export declare function deletar_em_massa_tarefa(credencial_de_acesso: CredencialDeAcesso, corpo_da_requisicao: tipos.TarefaDeletarEmMassa, opcoes_da_chamada?: OpcoesDaChamada): Promise<void>;
|
|
745
761
|
/**
|
|
746
762
|
* Busca tarefas por filtro
|
|
747
763
|
*
|
package/dist/support/rotas.js
CHANGED
|
@@ -904,6 +904,40 @@ export function buscar_auto_complete_tarefa(credencial_de_acesso, parametros = {
|
|
|
904
904
|
formato_da_resposta: "json",
|
|
905
905
|
}, opcoes_da_chamada);
|
|
906
906
|
}
|
|
907
|
+
/**
|
|
908
|
+
* Aplica a mesma mudança em várias tarefas
|
|
909
|
+
*
|
|
910
|
+
* Exige a permissão `editar` na área `projetos`. Aplica a mesma mudança em 1 a 500 tarefas (`tarefa_ids`, sem repetição), com pelo menos um destes campos: `secao_id` leva as tarefas principais para o fim dessa coluna, na ordem pedida (as tarefas e a coluna precisam ser do mesmo projeto); `responsavel_id` troca o responsável (`null` tira); `prazo` troca o prazo (`null` apaga; não pode ficar antes do início de nenhuma); `etiqueta_adicionar` põe a etiqueta em quem não a tem e `etiqueta_remover` tira de quem tem. Tudo é conferido antes de gravar: uma tarefa inexistente, subtarefa (com `secao_id`), de outro projeto ou com prazo antes do início recusa o pedido inteiro. A tarefa em que nada muda fica como está. Vale a regra da coluna que conclui do `PATCH /tarefa/{id}`: entrar nela conclui e sair reabre. Cada tarefa alterada ganha as linhas na atividade; o novo responsável e, ao concluir, o criador recebem notificação. Devolve as tarefas pedidas, já atualizadas, na ordem pedida. As tarefas são gravadas uma a uma: se o pedido parar no meio, repeti-lo completa só o que faltou. Visibilidade: projeto com `visibilidade` `MEMBROS` só aparece para o dono, os membros e o master do TermoAuth; para os demais a coluna e as tarefas dele respondem `404`. O responsável sempre enxerga a própria tarefa.
|
|
911
|
+
*
|
|
912
|
+
* `PATCH /tarefa/em_massa`
|
|
913
|
+
*/
|
|
914
|
+
export function atualizar_em_massa_tarefa(credencial_de_acesso, corpo_da_requisicao, opcoes_da_chamada) {
|
|
915
|
+
return chamar_servico({
|
|
916
|
+
servico: SERVICO_DESTA_API,
|
|
917
|
+
metodo_http: "PATCH",
|
|
918
|
+
caminho_da_rota: "/tarefa/em_massa",
|
|
919
|
+
credencial_de_acesso,
|
|
920
|
+
corpo_json: corpo_da_requisicao,
|
|
921
|
+
formato_da_resposta: "json",
|
|
922
|
+
}, opcoes_da_chamada);
|
|
923
|
+
}
|
|
924
|
+
/**
|
|
925
|
+
* Exclui várias tarefas
|
|
926
|
+
*
|
|
927
|
+
* Exige a permissão `deletar` na área `projetos`. Exclusão lógica de 1 a 500 tarefas (`tarefa_ids`, sem repetição) e das subtarefas delas. Tudo é conferido antes de gravar: uma tarefa inexistente ou já excluída recusa o pedido inteiro. As tarefas são excluídas uma a uma: se o pedido parar no meio, repeti-lo com as que sobraram termina a exclusão. Visibilidade: projeto com `visibilidade` `MEMBROS` só aparece para o dono, os membros e o master do TermoAuth; para os demais as tarefas dele respondem `404`. O responsável sempre enxerga a própria tarefa.
|
|
928
|
+
*
|
|
929
|
+
* `DELETE /tarefa/em_massa`
|
|
930
|
+
*/
|
|
931
|
+
export function deletar_em_massa_tarefa(credencial_de_acesso, corpo_da_requisicao, opcoes_da_chamada) {
|
|
932
|
+
return chamar_servico({
|
|
933
|
+
servico: SERVICO_DESTA_API,
|
|
934
|
+
metodo_http: "DELETE",
|
|
935
|
+
caminho_da_rota: "/tarefa/em_massa",
|
|
936
|
+
credencial_de_acesso,
|
|
937
|
+
corpo_json: corpo_da_requisicao,
|
|
938
|
+
formato_da_resposta: "sem_conteudo",
|
|
939
|
+
}, opcoes_da_chamada);
|
|
940
|
+
}
|
|
907
941
|
/**
|
|
908
942
|
* Busca tarefas por filtro
|
|
909
943
|
*
|
package/dist/support/tipos.d.ts
CHANGED
|
@@ -665,6 +665,36 @@ export interface TarefaAtualizar {
|
|
|
665
665
|
secao_id?: string | null;
|
|
666
666
|
titulo?: string | null;
|
|
667
667
|
}
|
|
668
|
+
/**
|
|
669
|
+
* A mesma mudança em várias tarefas de uma vez (as marcadas no quadro). Pelo menos um campo além de
|
|
670
|
+
* `tarefa_ids`; o que vem vale para todas.
|
|
671
|
+
*/
|
|
672
|
+
export interface TarefaAtualizarEmMassa {
|
|
673
|
+
/**
|
|
674
|
+
* Etiqueta a pôr nas tarefas que ainda não a têm.
|
|
675
|
+
*/
|
|
676
|
+
etiqueta_adicionar?: string | null;
|
|
677
|
+
/**
|
|
678
|
+
* Etiqueta a tirar das tarefas que a têm.
|
|
679
|
+
*/
|
|
680
|
+
etiqueta_remover?: string | null;
|
|
681
|
+
/**
|
|
682
|
+
* Novo prazo; `null` apaga o prazo.
|
|
683
|
+
*/
|
|
684
|
+
prazo?: string | null;
|
|
685
|
+
/**
|
|
686
|
+
* Novo responsável; `null` tira o responsável.
|
|
687
|
+
*/
|
|
688
|
+
responsavel_id?: string | null;
|
|
689
|
+
/**
|
|
690
|
+
* Coluna de destino: só tarefas principais do mesmo projeto da coluna.
|
|
691
|
+
*/
|
|
692
|
+
secao_id?: string | null;
|
|
693
|
+
/**
|
|
694
|
+
* Tarefas (de 1 a 500), na ordem em que entram no fim da coluna quando há `secao_id`.
|
|
695
|
+
*/
|
|
696
|
+
tarefa_ids: Array<string>;
|
|
697
|
+
}
|
|
668
698
|
export interface TarefaAutoComplete {
|
|
669
699
|
id: string;
|
|
670
700
|
projeto_nome: string;
|
|
@@ -695,6 +725,15 @@ export interface TarefaCriar {
|
|
|
695
725
|
ticket_id?: string | null;
|
|
696
726
|
titulo: string;
|
|
697
727
|
}
|
|
728
|
+
/**
|
|
729
|
+
* Tarefas para excluir de uma vez.
|
|
730
|
+
*/
|
|
731
|
+
export interface TarefaDeletarEmMassa {
|
|
732
|
+
/**
|
|
733
|
+
* Tarefas (de 1 a 500); cada uma sai com as subtarefas dela.
|
|
734
|
+
*/
|
|
735
|
+
tarefa_ids: Array<string>;
|
|
736
|
+
}
|
|
698
737
|
export interface Ticket {
|
|
699
738
|
anexos_total: number;
|
|
700
739
|
aplicativo: AplicativoResumo;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "termo_core",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.17",
|
|
4
4
|
"description": "Todos os clientes da Termotubos num pacote só: um módulo por serviço e cada rota da API como uma função com fetch, com o endereço resolvido pelo ambiente atual.",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"author": "TI Termotubos <ti@termotubos.com.br>",
|