Etiqueta

// npm install termo_core --save-exact
import * as support from "termo_core/support";
// ou: import { support } from "termo_core";

Função	Rota	O que faz
`buscar_paginador_etiqueta`	`GET /etiqueta`	Lista as etiquetas paginadas
`criar_etiqueta`	`POST /etiqueta`	Cadastra uma etiqueta
`buscar_auto_complete_etiqueta`	`GET /etiqueta/autocomplete`	Lista básica de etiquetas para seleção
`buscar_pelo_filtro_etiqueta`	`GET /etiqueta/filtro`	Busca etiquetas por filtro
`buscar_pelo_id_etiqueta`	`GET /etiqueta/{id}`	Busca uma etiqueta pelo id
`atualizar_pelo_id_etiqueta`	`PATCH /etiqueta/{id}`	Atualiza uma etiqueta pelo id
`deletar_pelo_id_etiqueta`	`DELETE /etiqueta/{id}`	Exclui uma etiqueta pelo id

`buscar_paginador_etiqueta`

GET/etiqueta Exige credencial

Lista as etiquetas paginadas

Exige a permissão de leitura na área projetos (qualquer das ações ler, criar, editar ou deletar libera a leitura). Lista em ordem alfabética, sempre 50 por página: tamanho é ignorado. pagina começa em 1.

function buscar_paginador_etiqueta(
  credencial_de_acesso: CredencialDeAcesso,
  parametros: ParametrosDeBuscarPaginadorEtiqueta = {},
  opcoes_da_chamada?: OpcoesDaChamada,
): Promise<tipos.PaginaEtiqueta>

Exemplo

import { CredencialDeAcesso } from "termo_core";
import { buscar_paginador_etiqueta } from "termo_core/support";

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

Argumentos

Nome

Tipo

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

`criar_etiqueta`

POST/etiqueta Exige credencial

Cadastra uma etiqueta

Exige a permissão criar na área projetos. Cria uma etiqueta para marcar tarefas (Backend, Frontend, Dados...). nome é obrigatório (até 40 caracteres) e único sem diferenciar maiúsculas. cor segue o formato #00397c (padrão #00397c).

function criar_etiqueta(
  credencial_de_acesso: CredencialDeAcesso,
  corpo_da_requisicao: tipos.EtiquetaCriar,
  opcoes_da_chamada?: OpcoesDaChamada,
): Promise<tipos.Etiqueta>

Exemplo

import { CredencialDeAcesso } from "termo_core";
import { criar_etiqueta } from "termo_core/support";

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

Argumentos

Nome

Tipo

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

`buscar_auto_complete_etiqueta`

GET/etiqueta/autocomplete Exige credencial

Lista básica de etiquetas para seleção

Exige a permissão de leitura na área projetos (qualquer das ações ler, criar, editar ou deletar libera a leitura). Devolve id, nome e cor, em ordem alfabética. busca procura o trecho no nome. pagina começa em 1 e tamanho tem padrão 10.

function buscar_auto_complete_etiqueta(
  credencial_de_acesso: CredencialDeAcesso,
  parametros: ParametrosDeBuscarAutoCompleteEtiqueta = {},
  opcoes_da_chamada?: OpcoesDaChamada,
): Promise<tipos.PaginaEtiquetaResumo>

Exemplo

import { CredencialDeAcesso } from "termo_core";
import { buscar_auto_complete_etiqueta } from "termo_core/support";

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

Argumentos

Nome

Tipo

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

`buscar_pelo_filtro_etiqueta`

GET/etiqueta/filtro Exige credencial

Busca etiquetas por filtro

Exige a permissão de leitura na área projetos (qualquer das ações ler, criar, editar ou deletar libera a leitura). Devolve todas as etiquetas não excluídas, em ordem alfabética. nome procura o trecho no nome, sem diferenciar maiúsculas.

function buscar_pelo_filtro_etiqueta(
  credencial_de_acesso: CredencialDeAcesso,
  parametros: ParametrosDeBuscarPeloFiltroEtiqueta = {},
  opcoes_da_chamada?: OpcoesDaChamada,
): Promise<Array<tipos.Etiqueta>>

Exemplo

import { CredencialDeAcesso } from "termo_core";
import { buscar_pelo_filtro_etiqueta } from "termo_core/support";

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

Argumentos

Nome

Tipo

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

`buscar_pelo_id_etiqueta`

GET/etiqueta/{id} Exige credencial

Busca uma etiqueta pelo id

Exige a permissão de leitura na área projetos (qualquer das ações ler, criar, editar ou deletar libera a leitura). Etiqueta excluída não é encontrada.

function buscar_pelo_id_etiqueta(
  credencial_de_acesso: CredencialDeAcesso,
  id: string,
  opcoes_da_chamada?: OpcoesDaChamada,
): Promise<tipos.Etiqueta>

Exemplo

import { CredencialDeAcesso } from "termo_core";
import { buscar_pelo_id_etiqueta } from "termo_core/support";

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

Argumentos

Nome

Tipo

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

`atualizar_pelo_id_etiqueta`

PATCH/etiqueta/{id} Exige credencial

Atualiza uma etiqueta pelo id

Exige a permissão editar na área projetos. Atualização parcial de nome e cor, com as mesmas regras do cadastro.

function atualizar_pelo_id_etiqueta(
  credencial_de_acesso: CredencialDeAcesso,
  id: string,
  corpo_da_requisicao: tipos.EtiquetaAtualizar,
  opcoes_da_chamada?: OpcoesDaChamada,
): Promise<tipos.Etiqueta>

Exemplo

import { CredencialDeAcesso } from "termo_core";
import { atualizar_pelo_id_etiqueta } from "termo_core/support";

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

Argumentos

Nome

Tipo

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

`deletar_pelo_id_etiqueta`

DELETE/etiqueta/{id} Exige credencial

Exclui uma etiqueta pelo id

Exige a permissão deletar na área projetos. Exclusão lógica: a etiqueta some das leituras e sai das tarefas que a usavam.

function deletar_pelo_id_etiqueta(
  credencial_de_acesso: CredencialDeAcesso,
  id: string,
  opcoes_da_chamada?: OpcoesDaChamada,
): Promise<void>

Exemplo

import { CredencialDeAcesso } from "termo_core";
import { deletar_pelo_id_etiqueta } from "termo_core/support";

const credencial_de_acesso = CredencialDeAcesso.token_do_usuario_logado(token_do_usuario);
await deletar_pelo_id_etiqueta(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.

import type { Etiqueta } from "termo_core/support";

export interface Etiqueta {
  atualizado_em: string;
  cor: string;
  criado_em: string;
  id: string;
  nome: string;
}

EtiquetaAtualizar

import type { EtiquetaAtualizar } from "termo_core/support";

export interface EtiquetaAtualizar {
  cor?: string | null;
  nome?: string | null;
}

EtiquetaCriar

import type { EtiquetaCriar } from "termo_core/support";

export interface EtiquetaCriar {
  cor?: string | null;
  nome: string;
}

PaginaEtiqueta

import type { PaginaEtiqueta } from "termo_core/support";

export interface PaginaEtiqueta {
  itens: Array<PaginaEtiquetaItensItem>;
  pagina: number;
  tamanho: number;
  total: number;
}

PaginaEtiquetaItensItem

import type { PaginaEtiquetaItensItem } from "termo_core/support";

export interface PaginaEtiquetaItensItem {
  atualizado_em: string;
  cor: string;
  criado_em: string;
  id: string;
  nome: string;
}

PaginaEtiquetaResumo

import type { PaginaEtiquetaResumo } from "termo_core/support";

export interface PaginaEtiquetaResumo {
  itens: Array<PaginaEtiquetaResumoItensItem>;
  pagina: number;
  tamanho: number;
  total: number;
}

PaginaEtiquetaResumoItensItem

A etiqueta como aparece dentro da tarefa.

import type { PaginaEtiquetaResumoItensItem } from "termo_core/support";

export interface PaginaEtiquetaResumoItensItem {
  cor: string;
  id: string;
  nome: string;
}

Etiqueta

buscar_paginador_etiquetaCopiar link

criar_etiquetaCopiar link

buscar_auto_complete_etiquetaCopiar link

buscar_pelo_filtro_etiquetaCopiar link

buscar_pelo_id_etiquetaCopiar link

atualizar_pelo_id_etiquetaCopiar link

deletar_pelo_id_etiquetaCopiar link

TiposCopiar link

EtiquetaCopiar link

EtiquetaAtualizarCopiar link

EtiquetaCriarCopiar link

PaginaEtiquetaCopiar link

PaginaEtiquetaItensItemCopiar link

PaginaEtiquetaResumoCopiar link

PaginaEtiquetaResumoItensItemCopiar link

Nesta página

`buscar_paginador_etiqueta`

`criar_etiqueta`

`buscar_auto_complete_etiqueta`

`buscar_pelo_filtro_etiqueta`

`buscar_pelo_id_etiqueta`

`atualizar_pelo_id_etiqueta`

`deletar_pelo_id_etiqueta`

Tipos

Etiqueta

EtiquetaAtualizar

EtiquetaCriar

PaginaEtiqueta

PaginaEtiquetaItensItem

PaginaEtiquetaResumo

PaginaEtiquetaResumoItensItem