TemplateRepository

Документация для класса TemplateRepository.

Методы

getSuperAdminTemplateById

Описание

Получение шаблона по ID для суперадмина

HTTP метод: GET

URL: /api-admin/v1/templates/{param}

Параметры:

Имя	Тип	Описание
templateId	number

Возвращает: Promise<IGetSuperAdminTemplateByIdResponse>

---

getSuperAdminTemplates

Описание

Получение списка шаблонов для суперадмина

HTTP метод: GET

URL: /api-admin/v1/templates

Параметры:

Имя	Тип	Описание
payload	IGetSuperAdminTemplatesPayload

Возвращает: Promise<IPaginationShell<ISuperAdminTemplate[]>>

---

createSuperAdminTemplate

Описание

Создание шаблона суперадмином

HTTP метод: POST

URL: /api-admin/v1/templates/create

Параметры:

Имя	Тип	Описание
payload	ICreateSuperadminTemplatePayload

Возвращает: Promise<ISuperAdminTemplate>

---

updateSuperAdminTemplate

Описание

Обновление данных шаблона суперадмином

HTTP метод: POST

URL: /api-admin/v1/templates/{param}/update

Параметры:

Имя	Тип	Описание
templateId	ISuperAdminTemplate['id']
payload	ICreateSuperadminTemplatePayload

Возвращает: Promise<ISuperAdminTemplate>

---

activate

Описание

Активировать шаблон

HTTP метод: GET

URL: /api-admin/v1/templates/{param}/activate

Параметры:

Имя	Тип	Описание
templateId	ISuperAdminTemplate['id']

Возвращает: Promise<void>

---

deactivate

Описание

Отключить шаблон

HTTP метод: GET

URL: /api-admin/v1/templates/{param}/deactivate

Параметры:

Имя	Тип	Описание
templateId	ISuperAdminTemplate['id']

Возвращает: Promise<void>

Определения типов

Определения интерфейсов, перечислений и псевдонимов типов, используемых в методах этого репозитория.

ICreateSuperadminTemplatePayload

Свойство	Тип	Описание
file	File
document_type_id	EDocumentTypeIds | null
name	string
subject_id	ISubject['id'] | null
subject_type_code (опц.)	EProcurementTypeValues | null
trade_method_id (опц.)	EProcurementMethodValues | null

---

IGetSuperAdminTemplateByIdResponse

Наследует: ISuperAdminTemplate

Свойство	Тип	Описание
fillableAttributes	`{

    id: number
    default_value: null \| string
    description: null \| string
    group: number
    is_required: boolean
    label: string
    place_type: 'single'
    value_type: 'string'
}[]` |  |

---

IGetSuperAdminTemplatesPayload

Наследует: IPaginationPayload

Свойство	Тип	Описание
name (опц.)	string
identifier (опц.)	string
document_type_id (опц.)	EDocumentTypeIds | null

---

IPaginationLinks

Свойство	Тип	Описание
first	string | null
last	string | null
next	string | null
prev	string | null

---

IPaginationMeta

Свойство	Тип	Описание
path	string
current_page	number
per_page	number
to	number
from	number
total	number
links	IPaginationMetaLink[]
last_page	number

---

IPaginationMetaLink

Свойство	Тип	Описание
active	boolean
label	string
url	string | null

---

IPaginationPayload

Свойство	Тип	Описание
page	number
per_page	number

---

IPaginationShell

Свойство	Тип	Описание
links	IPaginationLinks[]
meta	IPaginationMeta
data	list

---

ISuperAdminTemplate

Свойство	Тип	Описание
document_type	RefEntityShell
id	number
is_active	boolean
name	string
path	string
subject	`{

    id: ISubject['id']
    name: ISubject['name']
    parent_id: ISubject['parent_id']
}` |  |

---

ITemplateRepository

Интерфейс не содержит собственных свойств и не наследует другие локальные интерфейсы.

---

RefEntityShell

Свойство	Тип	Описание
id	id
alias	alias
name	string