Rest

SDK экспортирует типы для Rest API запросов:

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

Типы

Primitive

Примитивное значение

Тип
string | number | boolean | null

FilterCompareType

Вид сравнения в фильтре по значению

Значение	Описание
'exact_value'	Точное совпадение
'less'	Меньше или равно (максимальное значение)
'more'	Больше или равно (минимальное значение)

FilterCompareValue

Фильтр по значению

Свойство	Тип	Описание
type	FilterCompareType	Вид сравнения 'exact_value' | 'less' | 'more'
value	Primitive	Значение сравнения

FilterRangeType

Вид сравнения в фильтре по диапазону значений

Значение	Описание
'range'	Диапазон значений

FilterRangeValue

Фильтр по диапазону значений

Свойство	Тип	Описание
type	FilterRangeType	Вид сравнения может принимать только одно значение 'range'
start_value	Primitive	Начало диапазона
end_value	Primitive	Конец диапазона

FilterDateRangeValue

Фильтр по диапазону дат/времени в формате YYYY-MM-DD HH:mm:ss

Свойство	Тип	Описание
start_date	string	Начало периода
end_date	string	Конец периода

FilterValue

Универсальное значение фильтра

Тип	Описание
Primitive | Primitive[] | FilterCompareValue | FilterRangeValue | FilterDateRangeValue	Значение фильтра

RestFilter

Тип массива параметров для фильтрации списка записей методом Rest.get()

type RestFilter = Record<string, FilterValue>

Свойство	Тип	Описание
[key: string]	FilterValue	Значение фильтра

RestGetParams

Параметры для метода Rest.get() при получении списка записей

Свойство	Тип	Описание
limit	number	Максимальное количество записей отдаваемых на один запрос. По умолчанию 50, максимум 100
page	number	Номер страницы результата запроса. По умолчанию 1
search	string	Поисковый запрос
fields	string[]	Список полей, которые нужно вернуть в ответе
filter	RestFilter	Массив параметров для фильтрации получаемого списка записей

RestPostData

Тип данных для метода Rest.post()

type RestPostData = Record<string, any>

Свойство	Тип	Описание
[key: string]	any	Передаваемые данные

RestCallType

Тип запроса в универсальном методе Rest.call()

Значение	Описание
'get'	Метод Rest.get()
'post'	Метод Rest.post()

RestCallParams

Параметры универсального метода Rest.call()

Свойство	Тип	Описание
type	RestCallType	Тип запроса ('get' или 'post', по умолчанию 'post')
method	string	URL API метода, например '/core/user/list'
params	RestGetParams | RestPostData	Параметры или данные запроса