Boletim técnico medida

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

Função	Rota	O que faz
`buscar_paginador_boletim_tecnico_medida`	`GET /boletim_tecnico_medida`	Lista as medidas de uma categoria com a descrição
`criar_boletim_tecnico_medida`	`POST /boletim_tecnico_medida`	Descreve uma medida do boletim técnico
`buscar_auto_complete_boletim_tecnico_medida`	`GET /boletim_tecnico_medida/autocomplete`	Lista básica das medidas descritas para seleção
`buscar_pelo_filtro_boletim_tecnico_medida`	`GET /boletim_tecnico_medida/filtro`	Busca medidas descritas por boletim ou medida
`buscar_informacoes_paginador_boletim_tecnico_medida`	`GET /boletim_tecnico_medida/paginador`	Totais das medidas de uma categoria
`buscar_pelo_id_boletim_tecnico_medida`	`GET /boletim_tecnico_medida/{id}`	Busca a descrição de uma medida pelo id
`atualizar_pelo_id_boletim_tecnico_medida`	`PATCH /boletim_tecnico_medida/{id}`	Atualiza a descrição de uma medida
`deletar_pelo_id_boletim_tecnico_medida`	`DELETE /boletim_tecnico_medida/{id}`	Exclui a descrição de uma medida

`buscar_paginador_boletim_tecnico_medida`

GET/boletim_tecnico_medida Exige credencial

Lista as medidas de uma categoria com a descrição

Exige sessão. sku_categoria obrigatório. Uma linha por medida da categoria (as dos produtos e as já descritas): boletim_tecnico_medida_id, descricao e atualizado_em vêm nulos quando a medida ainda não foi descrita; total_produtos e exemplo_produto (o primeiro nome em ordem alfabética) vêm dos produtos. busca procura na medida, na descrição e no nome do produto; situacao é descrita ou pendente. Ordem pela medida, 50 por página, por cursor: cursor é o sku_medida da última linha recebida. As medidas de cada categoria saem de um cache em memória, descartado a cada gravação em boletim, medida, tabela auxiliar ou produto (e recarregado do banco no máximo a cada 10 minutos).

function buscar_paginador_boletim_tecnico_medida(
  credencial_de_acesso: CredencialDeAcesso,
  parametros: ParametrosDeBuscarPaginadorBoletimTecnicoMedida = {},
  opcoes_da_chamada?: OpcoesDaChamada,
): Promise<Array<tipos.BoletimTecnicoMedidaLinha>>

Exemplo

import { CredencialDeAcesso } from "termo_core";
import { buscar_paginador_boletim_tecnico_medida } from "termo_core/portal";

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

Argumentos

Nome

Tipo

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

`criar_boletim_tecnico_medida`

POST/boletim_tecnico_medida Exige credencial

Descreve uma medida do boletim técnico

Exige o módulo Configuracoes (criar). A medida é filha do boletim da categoria. boletim_tecnico_id (uuid do boletim), sku_medida (os 4 caracteres do SKU depois da categoria, ex.: 0064; gravado em maiúsculas) e descricao (texto, até 10.000 caracteres; cada linha é um item) obrigatórios. Uma medida só tem uma descrição por boletim.

function criar_boletim_tecnico_medida(
  credencial_de_acesso: CredencialDeAcesso,
  corpo_da_requisicao: tipos.BoletimTecnicoMedidaCriar,
  opcoes_da_chamada?: OpcoesDaChamada,
): Promise<tipos.BoletimTecnicoMedida>

Exemplo

import { CredencialDeAcesso } from "termo_core";
import { criar_boletim_tecnico_medida } from "termo_core/portal";

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

Argumentos

Nome

Tipo

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

`buscar_auto_complete_boletim_tecnico_medida`

GET/boletim_tecnico_medida/autocomplete Exige credencial

Lista básica das medidas descritas para seleção

Exige sessão. Só id e a medida (label), em ordem alfabética. boletim_tecnico_id restringe a um boletim; busca procura na medida. tamanho tem padrão 10 e vai de 1 a 50; pagina começa em 1.

function buscar_auto_complete_boletim_tecnico_medida(
  credencial_de_acesso: CredencialDeAcesso,
  parametros: ParametrosDeBuscarAutoCompleteBoletimTecnicoMedida = {},
  opcoes_da_chamada?: OpcoesDaChamada,
): Promise<tipos.PaginaBoletimTecnicoMedidaAutoComplete>

Exemplo

import { CredencialDeAcesso } from "termo_core";
import { buscar_auto_complete_boletim_tecnico_medida } from "termo_core/portal";

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

Argumentos

Nome

Tipo

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

`buscar_pelo_filtro_boletim_tecnico_medida`

GET/boletim_tecnico_medida/filtro Exige credencial

Busca medidas descritas por boletim ou medida

Exige sessão. Até 50 por página (pagina, a partir de 1, padrão 1). boletim_tecnico_id e sku_medida são exatos e opcionais.

function buscar_pelo_filtro_boletim_tecnico_medida(
  credencial_de_acesso: CredencialDeAcesso,
  parametros: ParametrosDeBuscarPeloFiltroBoletimTecnicoMedida = {},
  opcoes_da_chamada?: OpcoesDaChamada,
): Promise<Array<tipos.BoletimTecnicoMedida>>

Exemplo

import { CredencialDeAcesso } from "termo_core";
import { buscar_pelo_filtro_boletim_tecnico_medida } from "termo_core/portal";

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

Argumentos

Nome

Tipo

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

`buscar_informacoes_paginador_boletim_tecnico_medida`

GET/boletim_tecnico_medida/paginador Exige credencial

Totais das medidas de uma categoria

Exige sessão. Mesmos filtros de GET /boletim_tecnico_medida (cursor é ignorado). total respeita todos os filtros; total_medidas, descritas e pendentes respeitam só a categoria e a busca.

function buscar_informacoes_paginador_boletim_tecnico_medida(
  credencial_de_acesso: CredencialDeAcesso,
  parametros: ParametrosDeBuscarInformacoesPaginadorBoletimTecnicoMedida = {},
  opcoes_da_chamada?: OpcoesDaChamada,
): Promise<tipos.BoletimTecnicoMedidaPaginador>

Exemplo

import { CredencialDeAcesso } from "termo_core";
import { buscar_informacoes_paginador_boletim_tecnico_medida } from "termo_core/portal";

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

Argumentos

Nome

Tipo

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

`buscar_pelo_id_boletim_tecnico_medida`

GET/boletim_tecnico_medida/{id} Exige credencial

Busca a descrição de uma medida pelo id

Exige sessão. Medida excluída não é encontrada.

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

Exemplo

import { CredencialDeAcesso } from "termo_core";
import { buscar_pelo_id_boletim_tecnico_medida } from "termo_core/portal";

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

Argumentos

Nome

Tipo

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

`atualizar_pelo_id_boletim_tecnico_medida`

PATCH/boletim_tecnico_medida/{id} Exige credencial

Atualiza a descrição de uma medida

Exige o módulo Configuracoes (editar). Muda só a descricao (não pode ficar vazia, até 10.000 caracteres); campo ausente mantém o valor atual.

function atualizar_pelo_id_boletim_tecnico_medida(
  credencial_de_acesso: CredencialDeAcesso,
  id: string,
  corpo_da_requisicao: tipos.BoletimTecnicoMedidaAtualizar,
  opcoes_da_chamada?: OpcoesDaChamada,
): Promise<tipos.BoletimTecnicoMedida>

Exemplo

import { CredencialDeAcesso } from "termo_core";
import { atualizar_pelo_id_boletim_tecnico_medida } from "termo_core/portal";

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

Argumentos

Nome

Tipo

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

`deletar_pelo_id_boletim_tecnico_medida`

DELETE/boletim_tecnico_medida/{id} Exige credencial

Exclui a descrição de uma medida

Exige o módulo Configuracoes (excluir). Exclusão lógica: a medida volta a aparecer como pendente na lista enquanto houver produto com ela.

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

Exemplo

import { CredencialDeAcesso } from "termo_core";
import { deletar_pelo_id_boletim_tecnico_medida } from "termo_core/portal";

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

BoletimTecnicoMedida

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

export interface BoletimTecnicoMedida {
  atualizado_em: string;
  boletim_tecnico_id: string;
  criado_em: string;
  descricao: string;
  id: string;
  sku_medida: string;
}

BoletimTecnicoMedidaAtualizar

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

export interface BoletimTecnicoMedidaAtualizar {
  descricao?: string | null;
}

BoletimTecnicoMedidaCriar

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

export interface BoletimTecnicoMedidaCriar {
  boletim_tecnico_id: string;
  descricao: string;
  sku_medida: string;
}

BoletimTecnicoMedidaLinha

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

export interface BoletimTecnicoMedidaLinha {
  atualizado_em?: string | null;
  boletim_tecnico_medida_id?: string | null;
  descricao?: string | null;
  exemplo_produto?: string | null;
  sku_medida: string;
  total_produtos: number;
}

BoletimTecnicoMedidaPaginador

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

export interface BoletimTecnicoMedidaPaginador {
  descritas: number;
  paginas: number;
  pendentes: number;
  tamanho: number;
  total: number;
  total_medidas: number;
}

PaginaBoletimTecnicoMedidaAutoComplete

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

export interface PaginaBoletimTecnicoMedidaAutoComplete {
  itens: Array<PaginaBoletimTecnicoMedidaAutoCompleteItensItem>;
  pagina: number;
  tamanho: number;
  total: number;
}

PaginaBoletimTecnicoMedidaAutoCompleteItensItem

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

export interface PaginaBoletimTecnicoMedidaAutoCompleteItensItem {
  id: string;
  label: string;
}

Boletim técnico medida

buscar_paginador_boletim_tecnico_medidaCopiar link

criar_boletim_tecnico_medidaCopiar link

buscar_auto_complete_boletim_tecnico_medidaCopiar link

buscar_pelo_filtro_boletim_tecnico_medidaCopiar link

buscar_informacoes_paginador_boletim_tecnico_medidaCopiar link

buscar_pelo_id_boletim_tecnico_medidaCopiar link

atualizar_pelo_id_boletim_tecnico_medidaCopiar link

deletar_pelo_id_boletim_tecnico_medidaCopiar link

TiposCopiar link

BoletimTecnicoMedidaCopiar link

BoletimTecnicoMedidaAtualizarCopiar link

BoletimTecnicoMedidaCriarCopiar link

BoletimTecnicoMedidaLinhaCopiar link

BoletimTecnicoMedidaPaginadorCopiar link

PaginaBoletimTecnicoMedidaAutoCompleteCopiar link

PaginaBoletimTecnicoMedidaAutoCompleteItensItemCopiar link

Nesta página

`buscar_paginador_boletim_tecnico_medida`

`criar_boletim_tecnico_medida`

`buscar_auto_complete_boletim_tecnico_medida`

`buscar_pelo_filtro_boletim_tecnico_medida`

`buscar_informacoes_paginador_boletim_tecnico_medida`

`buscar_pelo_id_boletim_tecnico_medida`

`atualizar_pelo_id_boletim_tecnico_medida`

`deletar_pelo_id_boletim_tecnico_medida`

Tipos

BoletimTecnicoMedida

BoletimTecnicoMedidaAtualizar

BoletimTecnicoMedidaCriar

BoletimTecnicoMedidaLinha

BoletimTecnicoMedidaPaginador

PaginaBoletimTecnicoMedidaAutoComplete

PaginaBoletimTecnicoMedidaAutoCompleteItensItem