Função
6 funções do TermoAuth para função.
// npm install termo_core --save-exact
import * as auth from "termo_core/auth";
// ou: import { auth } from "termo_core";| Função | Rota | O que faz |
|---|---|---|
buscar_paginador_funcao | GET /funcao | Lista funções com paginação |
criar_funcao | POST /funcao | Cadastra uma função |
buscar_auto_complete_funcao | GET /funcao/autocomplete | Lista básica de funções para seleção |
buscar_pelo_filtro_funcao | GET /funcao/filtro | Busca funções por filtro |
buscar_pelo_id_funcao | GET /funcao/{id} | Busca uma função pelo id |
atualizar_pelo_id_funcao | PATCH /funcao/{id} | Renomeia uma função |
buscar_paginador_funcao
GET/funcao Exige credencial
Lista funções com paginação
Só master. Em ordem alfabética. pagina começa em 1 (padrão 1); tamanho tem padrão 10 e máximo 500. busca procura no nome.
function buscar_paginador_funcao(
credencial_de_acesso: CredencialDeAcesso,
parametros: ParametrosDeBuscarPaginadorFuncao = {},
opcoes_da_chamada?: OpcoesDaChamada,
): Promise<tipos.PaginaFuncao>import { CredencialDeAcesso } from "termo_core";
import { buscar_paginador_funcao } from "termo_core/auth";
const credencial_de_acesso = CredencialDeAcesso.token_do_usuario_logado(token_do_usuario);
const resposta = await buscar_paginador_funcao(credencial_de_acesso, { pagina: 1 });Argumentos
Nome
Tipo
Retorno: Promise<tipos.PaginaFuncao> · Rust: Result<tipos::PaginaFuncao, ErroAoChamarServico> · veja PaginaFuncao.
criar_funcao
POST/funcao Exige credencial
Cadastra uma função
Só master. nome é obrigatório, de 1 a 120 caracteres, e não pode repetir outra função (sem diferenciar maiúsculas).
function criar_funcao(
credencial_de_acesso: CredencialDeAcesso,
corpo_da_requisicao: tipos.FuncaoCriar,
opcoes_da_chamada?: OpcoesDaChamada,
): Promise<tipos.Funcao>import { CredencialDeAcesso } from "termo_core";
import { criar_funcao } from "termo_core/auth";
const credencial_de_acesso = CredencialDeAcesso.token_do_usuario_logado(token_do_usuario);
const resposta = await criar_funcao(credencial_de_acesso, corpo_da_requisicao);Argumentos
Nome
Tipo
Retorno: Promise<tipos.Funcao> · Rust: Result<tipos::Funcao, ErroAoChamarServico> · veja Funcao.
buscar_auto_complete_funcao
GET/funcao/autocomplete Exige credencial
Lista básica de funções para seleção
Só master. Devolve só id e nome, em ordem alfabética. pagina começa em 1 (padrão 1); tamanho tem padrão 10 e máximo 100. busca procura no nome.
function buscar_auto_complete_funcao(
credencial_de_acesso: CredencialDeAcesso,
parametros: ParametrosDeBuscarAutoCompleteFuncao = {},
opcoes_da_chamada?: OpcoesDaChamada,
): Promise<tipos.PaginaFuncaoAutoComplete>import { CredencialDeAcesso } from "termo_core";
import { buscar_auto_complete_funcao } from "termo_core/auth";
const credencial_de_acesso = CredencialDeAcesso.token_do_usuario_logado(token_do_usuario);
const resposta = await buscar_auto_complete_funcao(credencial_de_acesso, { busca: "..." });Argumentos
Nome
Tipo
Retorno: Promise<tipos.PaginaFuncaoAutoComplete> · Rust: Result<tipos::PaginaFuncaoAutoComplete, ErroAoChamarServico> · veja PaginaFuncaoAutoComplete.
buscar_pelo_filtro_funcao
GET/funcao/filtro Exige credencial
Busca funções por filtro
Só master. Devolve todas as funções que casam com o filtro, sem paginação, em ordem alfabética. busca procura no nome.
function buscar_pelo_filtro_funcao(
credencial_de_acesso: CredencialDeAcesso,
parametros: ParametrosDeBuscarPeloFiltroFuncao = {},
opcoes_da_chamada?: OpcoesDaChamada,
): Promise<Array<tipos.Funcao>>import { CredencialDeAcesso } from "termo_core";
import { buscar_pelo_filtro_funcao } from "termo_core/auth";
const credencial_de_acesso = CredencialDeAcesso.token_do_usuario_logado(token_do_usuario);
const resposta = await buscar_pelo_filtro_funcao(credencial_de_acesso, { busca: "..." });Argumentos
Nome
Tipo
Retorno: Promise<Array<tipos.Funcao>> · Rust: Result<Vec<tipos::Funcao>, ErroAoChamarServico>
buscar_pelo_id_funcao
GET/funcao/{id} Exige credencial
Busca uma função pelo id
Só master. quantidade_de_colaboradores conta os usuários ligados à função.
function buscar_pelo_id_funcao(
credencial_de_acesso: CredencialDeAcesso,
id: string,
opcoes_da_chamada?: OpcoesDaChamada,
): Promise<tipos.Funcao>import { CredencialDeAcesso } from "termo_core";
import { buscar_pelo_id_funcao } from "termo_core/auth";
const credencial_de_acesso = CredencialDeAcesso.token_do_usuario_logado(token_do_usuario);
const resposta = await buscar_pelo_id_funcao(credencial_de_acesso, id);Argumentos
Nome
Tipo
Retorno: Promise<tipos.Funcao> · Rust: Result<tipos::Funcao, ErroAoChamarServico> · veja Funcao.
atualizar_pelo_id_funcao
PATCH/funcao/{id} Exige credencial
Renomeia uma função
Só master. Renomear avisa os apps de novo sobre cada colaborador da função, porque eles recebem o nome.
function atualizar_pelo_id_funcao(
credencial_de_acesso: CredencialDeAcesso,
id: string,
corpo_da_requisicao: tipos.FuncaoAtualizar,
opcoes_da_chamada?: OpcoesDaChamada,
): Promise<tipos.Funcao>import { CredencialDeAcesso } from "termo_core";
import { atualizar_pelo_id_funcao } from "termo_core/auth";
const credencial_de_acesso = CredencialDeAcesso.token_do_usuario_logado(token_do_usuario);
const resposta = await atualizar_pelo_id_funcao(credencial_de_acesso, id, corpo_da_requisicao);Argumentos
Nome
Tipo
Retorno: Promise<tipos.Funcao> · Rust: Result<tipos::Funcao, ErroAoChamarServico> · veja Funcao.
Tipos
Tipos usados pelas funções desta página. O nome é o mesmo nos dois pacotes.
Funcao
import type { Funcao } from "termo_core/auth";
export interface Funcao {
atualizado_em: string;
criado_em: string;
id: string;
nome: string;
quantidade_de_colaboradores: number;
}FuncaoAtualizar
import type { FuncaoAtualizar } from "termo_core/auth";
export interface FuncaoAtualizar {
nome?: string | null;
}FuncaoCriar
import type { FuncaoCriar } from "termo_core/auth";
export interface FuncaoCriar {
nome: string;
}PaginaFuncao
import type { PaginaFuncao } from "termo_core/auth";
export interface PaginaFuncao {
itens: Array<PaginaFuncaoItensItem>;
pagina: number;
tamanho: number;
total: number;
}PaginaFuncaoAutoComplete
import type { PaginaFuncaoAutoComplete } from "termo_core/auth";
export interface PaginaFuncaoAutoComplete {
itens: Array<PaginaFuncaoAutoCompleteItensItem>;
pagina: number;
tamanho: number;
total: number;
}PaginaFuncaoAutoCompleteItensItem
import type { PaginaFuncaoAutoCompleteItensItem } from "termo_core/auth";
export interface PaginaFuncaoAutoCompleteItensItem {
id: string;
nome: string;
}PaginaFuncaoItensItem
import type { PaginaFuncaoItensItem } from "termo_core/auth";
export interface PaginaFuncaoItensItem {
atualizado_em: string;
criado_em: string;
id: string;
nome: string;
quantidade_de_colaboradores: number;
}