Setor
6 funções do TermoAuth para setor.
// 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_setor | GET /setor | Lista setores com paginação |
criar_setor | POST /setor | Cadastra um setor |
buscar_auto_complete_setor | GET /setor/autocomplete | Lista básica de setores para seleção |
buscar_pelo_filtro_setor | GET /setor/filtro | Busca setores por filtro |
buscar_pelo_id_setor | GET /setor/{id} | Busca um setor pelo id |
atualizar_pelo_id_setor | PATCH /setor/{id} | Renomeia um setor |
buscar_paginador_setor
GET/setor Exige credencial
Lista setores 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_setor(
credencial_de_acesso: CredencialDeAcesso,
parametros: ParametrosDeBuscarPaginadorSetor = {},
opcoes_da_chamada?: OpcoesDaChamada,
): Promise<tipos.PaginaSetor>import { CredencialDeAcesso } from "termo_core";
import { buscar_paginador_setor } from "termo_core/auth";
const credencial_de_acesso = CredencialDeAcesso.token_do_usuario_logado(token_do_usuario);
const resposta = await buscar_paginador_setor(credencial_de_acesso, { pagina: 1 });Argumentos
Nome
Tipo
Retorno: Promise<tipos.PaginaSetor> · Rust: Result<tipos::PaginaSetor, ErroAoChamarServico> · veja PaginaSetor.
criar_setor
POST/setor Exige credencial
Cadastra um setor
Só master. nome é obrigatório, de 1 a 120 caracteres, e não pode repetir outro setor (sem diferenciar maiúsculas).
function criar_setor(
credencial_de_acesso: CredencialDeAcesso,
corpo_da_requisicao: tipos.SetorCriar,
opcoes_da_chamada?: OpcoesDaChamada,
): Promise<tipos.Setor>import { CredencialDeAcesso } from "termo_core";
import { criar_setor } from "termo_core/auth";
const credencial_de_acesso = CredencialDeAcesso.token_do_usuario_logado(token_do_usuario);
const resposta = await criar_setor(credencial_de_acesso, corpo_da_requisicao);Argumentos
Nome
Tipo
Retorno: Promise<tipos.Setor> · Rust: Result<tipos::Setor, ErroAoChamarServico> · veja Setor.
buscar_auto_complete_setor
GET/setor/autocomplete Exige credencial
Lista básica de setores 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_setor(
credencial_de_acesso: CredencialDeAcesso,
parametros: ParametrosDeBuscarAutoCompleteSetor = {},
opcoes_da_chamada?: OpcoesDaChamada,
): Promise<tipos.PaginaSetorAutoComplete>import { CredencialDeAcesso } from "termo_core";
import { buscar_auto_complete_setor } from "termo_core/auth";
const credencial_de_acesso = CredencialDeAcesso.token_do_usuario_logado(token_do_usuario);
const resposta = await buscar_auto_complete_setor(credencial_de_acesso, { busca: "..." });Argumentos
Nome
Tipo
Retorno: Promise<tipos.PaginaSetorAutoComplete> · Rust: Result<tipos::PaginaSetorAutoComplete, ErroAoChamarServico> · veja PaginaSetorAutoComplete.
buscar_pelo_filtro_setor
GET/setor/filtro Exige credencial
Busca setores por filtro
Só master. Devolve todos os setores que casam com o filtro, sem paginação, em ordem alfabética. busca procura no nome.
function buscar_pelo_filtro_setor(
credencial_de_acesso: CredencialDeAcesso,
parametros: ParametrosDeBuscarPeloFiltroSetor = {},
opcoes_da_chamada?: OpcoesDaChamada,
): Promise<Array<tipos.Setor>>import { CredencialDeAcesso } from "termo_core";
import { buscar_pelo_filtro_setor } from "termo_core/auth";
const credencial_de_acesso = CredencialDeAcesso.token_do_usuario_logado(token_do_usuario);
const resposta = await buscar_pelo_filtro_setor(credencial_de_acesso, { busca: "..." });Argumentos
Nome
Tipo
Retorno: Promise<Array<tipos.Setor>> · Rust: Result<Vec<tipos::Setor>, ErroAoChamarServico>
buscar_pelo_id_setor
GET/setor/{id} Exige credencial
Busca um setor pelo id
Só master. quantidade_de_colaboradores conta os usuários ligados ao setor.
function buscar_pelo_id_setor(
credencial_de_acesso: CredencialDeAcesso,
id: string,
opcoes_da_chamada?: OpcoesDaChamada,
): Promise<tipos.Setor>import { CredencialDeAcesso } from "termo_core";
import { buscar_pelo_id_setor } from "termo_core/auth";
const credencial_de_acesso = CredencialDeAcesso.token_do_usuario_logado(token_do_usuario);
const resposta = await buscar_pelo_id_setor(credencial_de_acesso, id);Argumentos
Nome
Tipo
Retorno: Promise<tipos.Setor> · Rust: Result<tipos::Setor, ErroAoChamarServico> · veja Setor.
atualizar_pelo_id_setor
PATCH/setor/{id} Exige credencial
Renomeia um setor
Só master. Renomear avisa os apps de novo sobre cada colaborador do setor, porque eles recebem o nome.
function atualizar_pelo_id_setor(
credencial_de_acesso: CredencialDeAcesso,
id: string,
corpo_da_requisicao: tipos.SetorAtualizar,
opcoes_da_chamada?: OpcoesDaChamada,
): Promise<tipos.Setor>import { CredencialDeAcesso } from "termo_core";
import { atualizar_pelo_id_setor } from "termo_core/auth";
const credencial_de_acesso = CredencialDeAcesso.token_do_usuario_logado(token_do_usuario);
const resposta = await atualizar_pelo_id_setor(credencial_de_acesso, id, corpo_da_requisicao);Argumentos
Nome
Tipo
Retorno: Promise<tipos.Setor> · Rust: Result<tipos::Setor, ErroAoChamarServico> · veja Setor.
Tipos
Tipos usados pelas funções desta página. O nome é o mesmo nos dois pacotes.
PaginaSetor
import type { PaginaSetor } from "termo_core/auth";
export interface PaginaSetor {
itens: Array<PaginaSetorItensItem>;
pagina: number;
tamanho: number;
total: number;
}PaginaSetorAutoComplete
import type { PaginaSetorAutoComplete } from "termo_core/auth";
export interface PaginaSetorAutoComplete {
itens: Array<PaginaSetorAutoCompleteItensItem>;
pagina: number;
tamanho: number;
total: number;
}PaginaSetorAutoCompleteItensItem
import type { PaginaSetorAutoCompleteItensItem } from "termo_core/auth";
export interface PaginaSetorAutoCompleteItensItem {
id: string;
nome: string;
}PaginaSetorItensItem
import type { PaginaSetorItensItem } from "termo_core/auth";
export interface PaginaSetorItensItem {
atualizado_em: string;
criado_em: string;
id: string;
nome: string;
quantidade_de_colaboradores: number;
}Setor
import type { Setor } from "termo_core/auth";
export interface Setor {
atualizado_em: string;
criado_em: string;
id: string;
nome: string;
quantidade_de_colaboradores: number;
}SetorAtualizar
import type { SetorAtualizar } from "termo_core/auth";
export interface SetorAtualizar {
nome?: string | null;
}SetorCriar
import type { SetorCriar } from "termo_core/auth";
export interface SetorCriar {
nome: string;
}