Visão geralServiçosEventosRecursos
TermoAuth

Cargo

6 funções do TermoAuth para cargo.

// npm install termo_core --save-exact
import * as auth from "termo_core/auth";
// ou: import { auth } from "termo_core";
FunçãoRotaO que faz
buscar_paginador_cargoGET /cargoLista cargos com paginação
criar_cargoPOST /cargoCadastra um cargo
buscar_auto_complete_cargoGET /cargo/autocompleteLista básica de cargos para seleção
buscar_pelo_filtro_cargoGET /cargo/filtroBusca cargos por filtro
buscar_pelo_id_cargoGET /cargo/{id}Busca um cargo pelo id
atualizar_pelo_id_cargoPATCH /cargo/{id}Renomeia um cargo

buscar_paginador_cargo

GET/cargo Exige credencial

Lista cargos 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_cargo(
  credencial_de_acesso: CredencialDeAcesso,
  parametros: ParametrosDeBuscarPaginadorCargo = {},
  opcoes_da_chamada?: OpcoesDaChamada,
): Promise<tipos.PaginaCargo>
Exemplo
import { CredencialDeAcesso } from "termo_core";
import { buscar_paginador_cargo } from "termo_core/auth";

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

Argumentos

Nome

Tipo

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

criar_cargo

POST/cargo Exige credencial

Cadastra um cargo

Só master. nome é obrigatório, de 1 a 120 caracteres, e não pode repetir outro cargo (sem diferenciar maiúsculas).

function criar_cargo(
  credencial_de_acesso: CredencialDeAcesso,
  corpo_da_requisicao: tipos.CargoCriar,
  opcoes_da_chamada?: OpcoesDaChamada,
): Promise<tipos.Cargo>
Exemplo
import { CredencialDeAcesso } from "termo_core";
import { criar_cargo } from "termo_core/auth";

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

Argumentos

Nome

Tipo

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

buscar_auto_complete_cargo

GET/cargo/autocomplete Exige credencial

Lista básica de cargos 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_cargo(
  credencial_de_acesso: CredencialDeAcesso,
  parametros: ParametrosDeBuscarAutoCompleteCargo = {},
  opcoes_da_chamada?: OpcoesDaChamada,
): Promise<tipos.PaginaCargoAutoComplete>
Exemplo
import { CredencialDeAcesso } from "termo_core";
import { buscar_auto_complete_cargo } from "termo_core/auth";

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

Argumentos

Nome

Tipo

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

buscar_pelo_filtro_cargo

GET/cargo/filtro Exige credencial

Busca cargos por filtro

Só master. Devolve todos os cargos que casam com o filtro, sem paginação, em ordem alfabética. busca procura no nome.

function buscar_pelo_filtro_cargo(
  credencial_de_acesso: CredencialDeAcesso,
  parametros: ParametrosDeBuscarPeloFiltroCargo = {},
  opcoes_da_chamada?: OpcoesDaChamada,
): Promise<Array<tipos.Cargo>>
Exemplo
import { CredencialDeAcesso } from "termo_core";
import { buscar_pelo_filtro_cargo } from "termo_core/auth";

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

Argumentos

Nome

Tipo

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

buscar_pelo_id_cargo

GET/cargo/{id} Exige credencial

Busca um cargo pelo id

Só master. quantidade_de_colaboradores conta os usuários ligados ao cargo.

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

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

Argumentos

Nome

Tipo

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

atualizar_pelo_id_cargo

PATCH/cargo/{id} Exige credencial

Renomeia um cargo

Só master. Renomear avisa os apps de novo sobre cada colaborador do cargo, porque eles recebem o nome.

function atualizar_pelo_id_cargo(
  credencial_de_acesso: CredencialDeAcesso,
  id: string,
  corpo_da_requisicao: tipos.CargoAtualizar,
  opcoes_da_chamada?: OpcoesDaChamada,
): Promise<tipos.Cargo>
Exemplo
import { CredencialDeAcesso } from "termo_core";
import { atualizar_pelo_id_cargo } from "termo_core/auth";

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

Argumentos

Nome

Tipo

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

Tipos

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

Cargo

import type { Cargo } from "termo_core/auth";

export interface Cargo {
  atualizado_em: string;
  criado_em: string;
  id: string;
  nome: string;
  quantidade_de_colaboradores: number;
}

CargoAtualizar

import type { CargoAtualizar } from "termo_core/auth";

export interface CargoAtualizar {
  nome?: string | null;
}

CargoCriar

import type { CargoCriar } from "termo_core/auth";

export interface CargoCriar {
  nome: string;
}

PaginaCargo

import type { PaginaCargo } from "termo_core/auth";

export interface PaginaCargo {
  itens: Array<PaginaCargoItensItem>;
  pagina: number;
  tamanho: number;
  total: number;
}

PaginaCargoAutoComplete

import type { PaginaCargoAutoComplete } from "termo_core/auth";

export interface PaginaCargoAutoComplete {
  itens: Array<PaginaCargoAutoCompleteItensItem>;
  pagina: number;
  tamanho: number;
  total: number;
}

PaginaCargoAutoCompleteItensItem

import type { PaginaCargoAutoCompleteItensItem } from "termo_core/auth";

export interface PaginaCargoAutoCompleteItensItem {
  id: string;
  nome: string;
}

PaginaCargoItensItem

import type { PaginaCargoItensItem } from "termo_core/auth";

export interface PaginaCargoItensItem {
  atualizado_em: string;
  criado_em: string;
  id: string;
  nome: string;
  quantidade_de_colaboradores: number;
}

App

6 funções do TermoAuth para app.

Função

6 funções do TermoAuth para função.

Nesta página

buscar_paginador_cargocriar_cargobuscar_auto_complete_cargobuscar_pelo_filtro_cargobuscar_pelo_id_cargoatualizar_pelo_id_cargoTiposCargoCargoAtualizarCargoCriarPaginaCargoPaginaCargoAutoCompletePaginaCargoAutoCompleteItensItemPaginaCargoItensItem