Visão geralServiçosEventosRecursos
TermoPortal

Configuração

7 funções do TermoPortal para configuração.

// npm install termo_core --save-exact
import * as portal from "termo_core/portal";
// ou: import { portal } from "termo_core";
FunçãoRotaO que faz
buscar_paginador_configuracaoGET /configuracaoLista as configurações paginadas
criar_configuracaoPOST /configuracaoGrava uma configuração do portal
buscar_auto_complete_configuracaoGET /configuracao/autocompleteLista básica de configurações para seleção
buscar_pelo_filtro_configuracaoGET /configuracao/filtroBusca configurações por filtro
buscar_pelo_id_configuracaoGET /configuracao/{id}Busca uma configuração pelo id
atualizar_pelo_id_configuracaoPATCH /configuracao/{id}Atualiza o valor de uma configuração
deletar_pelo_id_configuracaoDELETE /configuracao/{id}Exclui uma configuração

buscar_paginador_configuracao

GET/configuracao Exige credencial

Lista as configurações paginadas

Exige só uma sessão válida (qualquer pessoa logada no portal). Ordem de chave. Paginado com 50 itens por página (fixo); pagina começa em 1 (padrão 1). A resposta traz itens, total (registros que casam), pagina e tamanho.

function buscar_paginador_configuracao(
  credencial_de_acesso: CredencialDeAcesso,
  parametros: ParametrosDeBuscarPaginadorConfiguracao = {},
  opcoes_da_chamada?: OpcoesDaChamada,
): Promise<tipos.PaginaConfiguracao>
Exemplo
import { CredencialDeAcesso } from "termo_core";
import { buscar_paginador_configuracao } from "termo_core/portal";

const credencial_de_acesso = CredencialDeAcesso.token_do_usuario_logado(token_do_usuario);
const resposta = await buscar_paginador_configuracao(credencial_de_acesso, { pagina: 1 });

Argumentos

Nome

Tipo

Retorno: Promise<tipos.PaginaConfiguracao> · Rust: Result<tipos::PaginaConfiguracao, ErroAoChamarServico> · veja PaginaConfiguracao.

criar_configuracao

POST/configuracao Exige credencial

Grava uma configuração do portal

Exige a permissão criar no módulo Configuracoes do perfil de quem chama (administrador e master têm tudo). Configuração chave/valor do portal (vitrine). chave precisa ser uma das chaves conhecidas (ex.: produtos_mostrar_preco) e valor (texto) segue o tipo da chave: booleano true/false, hora HH:MM, decimal ou texto com limite. Cada chave existe uma vez só.

function criar_configuracao(
  credencial_de_acesso: CredencialDeAcesso,
  corpo_da_requisicao: tipos.ConfiguracaoCriar,
  opcoes_da_chamada?: OpcoesDaChamada,
): Promise<tipos.Configuracao>
Exemplo
import { CredencialDeAcesso } from "termo_core";
import { criar_configuracao } from "termo_core/portal";

const credencial_de_acesso = CredencialDeAcesso.token_do_usuario_logado(token_do_usuario);
const resposta = await criar_configuracao(credencial_de_acesso, corpo_da_requisicao);

Argumentos

Nome

Tipo

Retorno: Promise<tipos.Configuracao> · Rust: Result<tipos::Configuracao, ErroAoChamarServico> · veja Configuracao.

buscar_auto_complete_configuracao

GET/configuracao/autocomplete Exige credencial

Lista básica de configurações para seleção

Exige só uma sessão válida (qualquer pessoa logada no portal). Devolve só id e chave, em ordem de chave. busca procura o trecho na chave. tamanho tem padrão 10 e vai de 1 a 50; pagina começa em 1. A resposta traz itens, total, pagina e tamanho.

function buscar_auto_complete_configuracao(
  credencial_de_acesso: CredencialDeAcesso,
  parametros: ParametrosDeBuscarAutoCompleteConfiguracao = {},
  opcoes_da_chamada?: OpcoesDaChamada,
): Promise<tipos.PaginaConfiguracaoAutoComplete>
Exemplo
import { CredencialDeAcesso } from "termo_core";
import { buscar_auto_complete_configuracao } from "termo_core/portal";

const credencial_de_acesso = CredencialDeAcesso.token_do_usuario_logado(token_do_usuario);
const resposta = await buscar_auto_complete_configuracao(credencial_de_acesso, { busca: "..." });

Argumentos

Nome

Tipo

Retorno: Promise<tipos.PaginaConfiguracaoAutoComplete> · Rust: Result<tipos::PaginaConfiguracaoAutoComplete, ErroAoChamarServico> · veja PaginaConfiguracaoAutoComplete.

buscar_pelo_filtro_configuracao

GET/configuracao/filtro Exige credencial

Busca configurações por filtro

Exige só uma sessão válida (qualquer pessoa logada no portal). Devolve as configurações não excluídas que casam com o filtro, até 50 por página (pagina, a partir de 1, padrão 1), em ordem de chave. chave é exata; prefixo pega as chaves que começam com o texto (ex.: produtos_).

function buscar_pelo_filtro_configuracao(
  credencial_de_acesso: CredencialDeAcesso,
  parametros: ParametrosDeBuscarPeloFiltroConfiguracao = {},
  opcoes_da_chamada?: OpcoesDaChamada,
): Promise<Array<tipos.Configuracao>>
Exemplo
import { CredencialDeAcesso } from "termo_core";
import { buscar_pelo_filtro_configuracao } from "termo_core/portal";

const credencial_de_acesso = CredencialDeAcesso.token_do_usuario_logado(token_do_usuario);
const resposta = await buscar_pelo_filtro_configuracao(credencial_de_acesso, { chave: "..." });

Argumentos

Nome

Tipo

Retorno: Promise<Array<tipos.Configuracao>> · Rust: Result<Vec<tipos::Configuracao>, ErroAoChamarServico>

buscar_pelo_id_configuracao

GET/configuracao/{id} Exige credencial

Busca uma configuração pelo id

Exige só uma sessão válida (qualquer pessoa logada no portal). Configuração excluída não é encontrada.

function buscar_pelo_id_configuracao(
  credencial_de_acesso: CredencialDeAcesso,
  id: string,
  opcoes_da_chamada?: OpcoesDaChamada,
): Promise<tipos.Configuracao>
Exemplo
import { CredencialDeAcesso } from "termo_core";
import { buscar_pelo_id_configuracao } from "termo_core/portal";

const credencial_de_acesso = CredencialDeAcesso.token_do_usuario_logado(token_do_usuario);
const resposta = await buscar_pelo_id_configuracao(credencial_de_acesso, id);

Argumentos

Nome

Tipo

Retorno: Promise<tipos.Configuracao> · Rust: Result<tipos::Configuracao, ErroAoChamarServico> · veja Configuracao.

atualizar_pelo_id_configuracao

PATCH/configuracao/{id} Exige credencial

Atualiza o valor de uma configuração

Exige a permissão editar no módulo Configuracoes do perfil de quem chama (administrador e master têm tudo). Troca o valor, validado pelo tipo da chave.

function atualizar_pelo_id_configuracao(
  credencial_de_acesso: CredencialDeAcesso,
  id: string,
  corpo_da_requisicao: tipos.ConfiguracaoAtualizar,
  opcoes_da_chamada?: OpcoesDaChamada,
): Promise<tipos.Configuracao>
Exemplo
import { CredencialDeAcesso } from "termo_core";
import { atualizar_pelo_id_configuracao } from "termo_core/portal";

const credencial_de_acesso = CredencialDeAcesso.token_do_usuario_logado(token_do_usuario);
const resposta = await atualizar_pelo_id_configuracao(credencial_de_acesso, id, corpo_da_requisicao);

Argumentos

Nome

Tipo

Retorno: Promise<tipos.Configuracao> · Rust: Result<tipos::Configuracao, ErroAoChamarServico> · veja Configuracao.

deletar_pelo_id_configuracao

DELETE/configuracao/{id} Exige credencial

Exclui uma configuração

Exige a permissão excluir no módulo Configuracoes do perfil de quem chama (administrador e master têm tudo). A exclusão é lógica: o registro some das leituras, mas a linha não é apagada.

function deletar_pelo_id_configuracao(
  credencial_de_acesso: CredencialDeAcesso,
  id: string,
  opcoes_da_chamada?: OpcoesDaChamada,
): Promise<void>
Exemplo
import { CredencialDeAcesso } from "termo_core";
import { deletar_pelo_id_configuracao } from "termo_core/portal";

const credencial_de_acesso = CredencialDeAcesso.token_do_usuario_logado(token_do_usuario);
await deletar_pelo_id_configuracao(credencial_de_acesso, id);

Argumentos

Nome

Tipo

Retorno: Promise<void> · Rust: Result<(), ErroAoChamarServico> · sem corpo na resposta.

Tipos

Tipos usados pelas funções desta página. O nome é o mesmo nos dois pacotes.

Configuracao

import type { Configuracao } from "termo_core/portal";

export interface Configuracao {
  atualizado_em: string;
  chave: string;
  criado_em: string;
  id: string;
  valor: string;
}

ConfiguracaoAtualizar

import type { ConfiguracaoAtualizar } from "termo_core/portal";

export interface ConfiguracaoAtualizar {
  valor: string;
}

ConfiguracaoCriar

import type { ConfiguracaoCriar } from "termo_core/portal";

export interface ConfiguracaoCriar {
  chave: string;
  valor: string;
}

PaginaConfiguracao

import type { PaginaConfiguracao } from "termo_core/portal";

export interface PaginaConfiguracao {
  itens: Array<PaginaConfiguracaoItensItem>;
  pagina: number;
  tamanho: number;
  total: number;
}

PaginaConfiguracaoAutoComplete

import type { PaginaConfiguracaoAutoComplete } from "termo_core/portal";

export interface PaginaConfiguracaoAutoComplete {
  itens: Array<PaginaConfiguracaoAutoCompleteItensItem>;
  pagina: number;
  tamanho: number;
  total: number;
}

PaginaConfiguracaoAutoCompleteItensItem

import type { PaginaConfiguracaoAutoCompleteItensItem } from "termo_core/portal";

export interface PaginaConfiguracaoAutoCompleteItensItem {
  chave: string;
  id: string;
}

PaginaConfiguracaoItensItem

import type { PaginaConfiguracaoItensItem } from "termo_core/portal";

export interface PaginaConfiguracaoItensItem {
  atualizado_em: string;
  chave: string;
  criado_em: string;
  id: string;
  valor: string;
}

Colaborador

7 funções do TermoPortal para colaborador.

Configuração provedor

2 funções do TermoPortal para configuração provedor.

Nesta página

buscar_paginador_configuracaocriar_configuracaobuscar_auto_complete_configuracaobuscar_pelo_filtro_configuracaobuscar_pelo_id_configuracaoatualizar_pelo_id_configuracaodeletar_pelo_id_configuracaoTiposConfiguracaoConfiguracaoAtualizarConfiguracaoCriarPaginaConfiguracaoPaginaConfiguracaoAutoCompletePaginaConfiguracaoAutoCompleteItensItemPaginaConfiguracaoItensItem