TariffRepository
Документация для класса TariffRepository.
Методы
getTariffs
Описание
Получение всех тарифов проекта eDoc
HTTP метод: GET
URL: /api/v1/tariffs
Параметры: Нет
Возвращает: Promise<ITariff[]>
getSubjectOrders
Описание
Получение всех заказов тарифов в компанию
HTTP метод: GET
URL: /api/v1/tariff-orders
Параметры: Нет
Возвращает: Promise<ITariffOrder[]>
getSubjectOrderById
Описание
Получение данных заказа тарифа по ID заказа
HTTP метод: GET
URL: /api/v1/tariff-orders/{param}
Параметры:
| Имя | Тип | Описание |
|---|---|---|
orderId | number |
Возвращает: Promise<ITariffOrder>
Определения типов
Определения интерфейсов, перечислений и псевдонимов типов, используемых в методах этого репозитория.
ITariff
| Свойство | Тип | Описание |
|---|---|---|
id | number | |
name | string | |
price | number | |
color | string | |
tariff_attributes | ITariffAttribute[] | |
type | RefEntityShell | |
connection_price | number | |
current | boolean | |
description | string[] |
ITariffAttribute
| Свойство | Тип | Описание |
|---|---|---|
id | number | |
amount | number | |
tariff_attribute_type | ITariffAttributeType |
ITariffAttributeType
Наследует: RefEntityShell
| Свойство | Тип | Описание |
|---|---|---|
is_active | boolean | |
price | number |
ITariffOrder
| Свойство | Тип | Описание |
|---|---|---|
id | number | |
created_at | RefSystemDateTime | |
price | number | |
subject | Pick<ISubject, 'id' | 'identifier' | 'name' | 'parent_id'> | |
tariff | Omit<ITariff, 'tariff_attributes' | 'type'> | |
tariff_orders_payment_status | RefEntityShell | |
user | RefBaseUserProfile | |
attributes (опц.) | ITariffAttribute[] |
ITariffRepository
Интерфейс не содержит собственных свойств и не наследует другие локальные интерфейсы.
RefBaseUserProfile
| Свойство | Тип | Описание |
|---|---|---|
email | string | |
id | number | |
identifier | string | |
lastname (опц.) | string | |
name | string | |
phone | string | |
surname (опц.) | string |
RefEntityShell
| Свойство | Тип | Описание |
|---|---|---|
id | id | |
alias | alias | |
name | string |