Rest

El SDK exporta los tipos para las solicitudes a la 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 comparación en el filtro de valor

Valor	Descripción
'exact_value'	Coincidencia exacta
'less'	Menor o igual (valor máximo)
'more'	Mayor o igual (valor mínimo)

FilterCompareValue

Filtro de comparación de valor

Propiedad	Tipo	Descripción
type	FilterCompareType	Tipo de comparación 'exact_value' | 'less' | 'more'
value	Primitive	Valor de comparación

FilterRangeType

Tipo de comparación en el filtro de rango

Valor	Descripción
'range'	Rango de valores

FilterRangeValue

Filtro de rango de valores

Propiedad	Tipo	Descripción
type	FilterRangeType	Tipo de comparación, acepta solo el valor 'range'
start_value	Primitive	Inicio del rango
end_value	Primitive	Fin del rango

FilterDateRangeValue

Filtro de rango de fecha/hora en formato YYYY-MM-DD HH:mm:ss

Propiedad	Tipo	Descripción
start_date	string	Inicio del período
end_date	string	Fin del período

FilterValue

Valor universal de filtro

Tipo	Descripción
Primitive | Primitive[] | FilterCompareValue | FilterRangeValue | FilterDateRangeValue	Valor del filtro

RestFilter

Tipo de parámetros de filtro para filtrar listas de registros mediante el método Rest.get()

type RestFilter = Record<string, FilterValue>

Propiedad	Tipo	Descripción
[key: string]	FilterValue	Valor del filtro

RestGetParams

Parámetros para el método Rest.get() al obtener listas de registros

Propiedad	Tipo	Descripción
limit	number	Número máximo de registros por solicitud. El valor predeterminado es 50, el máximo es 100
page	number	Número de página del resultado de la solicitud. El valor predeterminado es 1
search	string	Consulta de búsqueda
fields	string[]	Lista de campos que se devolverán en la respuesta
filter	RestFilter	Parámetros de filtro para la lista de registros

RestPostData

Tipo de datos para el método Rest.post()

type RestPostData = Record<string, any>

Propiedad	Tipo	Descripción
[key: string]	any	Datos a enviar

RestCallType

Tipo de solicitud para el método universal Rest.call()

Valor	Descripción
'get'	Método Rest.get()
'post'	Método Rest.post()

RestCallParams

Parámetros para el método universal Rest.call()

Propiedad	Tipo	Descripción
type	RestCallType	Tipo de solicitud ('get' o 'post', predeterminado es 'post')
method	string	URL del método de la API, por ejemplo '/core/user/list'
params	RestGetParams | RestPostData	Parámetros o datos de la solicitud