Rest

O SDK exporta tipos para requisições à Rest API:

import type {
  Primitive,
  FilterCompareType,
  FilterCompareValue,
  FilterRangeType,
  FilterRangeValue,
  FilterDateRangeValue,
  FilterValue,
  RestFilter,
  RestGetParams,
  RestPostData,
  RestCallType,
  RestCallParams
} from '@flowlu/miniapp-jssdk'

Tipos

Primitive

Valor primitivo

Tipo
string | number | boolean | null

FilterCompareType

Tipo de comparação no filtro de valor

Valor	Descrição
'exact_value'	Correspondência exata
'less'	Menor ou igual (valor máximo)
'more'	Maior ou igual (valor mínimo)

FilterCompareValue

Filtro de comparação de valor

Propriedade	Tipo	Descrição
type	FilterCompareType	Tipo de comparação 'exact_value' | 'less' | 'more'
value	Primitive	Valor de comparação

FilterRangeType

Tipo de comparação no filtro de intervalo

Valor	Descrição
'range'	Intervalo de valores

FilterRangeValue

Filtro de intervalo de valores

Propriedade	Tipo	Descrição
type	FilterRangeType	Tipo de comparação, aceita apenas o valor 'range'
start_value	Primitive	Início do intervalo
end_value	Primitive	Fim do intervalo

FilterDateRangeValue

Filtro de intervalo de data/hora no formato YYYY-MM-DD HH:mm:ss

Propriedade	Tipo	Descrição
start_date	string	Início do período
end_date	string	Fim do período

FilterValue

Valor universal de filtro

Tipo	Descrição
Primitive | Primitive[] | FilterCompareValue | FilterRangeValue | FilterDateRangeValue	Valor do filtro

RestFilter

Tipo de parâmetros de filtro para filtragem de listas de registros através do método Rest.get()

type RestFilter = Record<string, FilterValue>

Propriedade	Tipo	Descrição
[key: string]	FilterValue	Valor do filtro

RestGetParams

Parâmetros do método Rest.get() ao obter listas de registros

Propriedade	Tipo	Descrição
limit	number	Número máximo de registros por requisição. O padrão é 50, o máximo é 100
page	number	Número da página do resultado da requisição. O padrão é 1
search	string	Consulta de busca
fields	string[]	Lista de campos a serem retornados na resposta
filter	RestFilter	Parâmetros de filtro para a lista de registros

RestPostData

Tipo dos dados do método Rest.post()

type RestPostData = Record<string, any>

Propriedade	Tipo	Descrição
[key: string]	any	Dados a serem enviados

RestCallType

Tipo de requisição para o método universal Rest.call()

Valor	Descrição
'get'	Método Rest.get()
'post'	Método Rest.post()

RestCallParams

Parâmetros do método universal Rest.call()

Propriedade	Tipo	Descrição
type	RestCallType	Tipo de requisição ('get' ou 'post', o padrão é 'post')
method	string	URL do método da API, por exemplo, '/core/user/list'
params	RestGetParams | RestPostData	Parâmetros ou dados da requisição