EDoc v3: Документация

Appearance

UserRepository ​

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

Методы ​

getUser ​

Описание

Метод для получения данных пользователя. Отправляет запрос на сервер для получения информации о текущем пользователе.

HTTP метод: GET

URL: /api/v1/user

Параметры:

ИмяТипОписание
payloadIGetUserPayload

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

updateProfile ​

Описание

Метод для обновления профиля пользователя. Отправляет запрос на сервер с обновленными данными пользователя.

HTTP метод: PUT

URL: /api/v1/user

Параметры:

ИмяТипОписание
payloadIUpdateProfilePayload

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

updatePassword ​

Описание

Метод для обновления пароля пользователя. Отправляет запрос на сервер с новыми данными пароля.

HTTP метод: PUT

URL: /api/v1/user/reset

Параметры:

ИмяТипОписание
payloadIUpdatePasswordPayload

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

updateAvatar ​

Описание

Метод для обновления аватара пользователя. Отправляет запрос на сервер с файлом аватара.

HTTP метод: POST

URL: /api/v1/user/avatar/upload

Параметры:

ИмяТипОписание
fileFile

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

setUserSubject ​

Описание

Установка компании пользователя для дальнейшей работы. Обычно используется при авторизации пользователя

HTTP метод: POST

URL: /api/v1/auth/set-subject

Параметры:

ИмяТипОписание
payloadISetUserSubjectPayload
tokenstring

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

getFiles ​

Описание

Метод для получения уже ранее загруженных файлов

HTTP метод: GET

URL: /api/v1/user/files

Параметры:

ИмяТипОписание
payloadIPaginationPayload

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

sendFiles ​

Описание

Загрузка файлов на сервер и получение их загруженных файлов

HTTP метод: POST

URL: /api/v1/user/files

Параметры:

ИмяТипОписание
payloadISendFilesPayload
progressCallback(event: AxiosProgressEvent) => void

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

getSuperAdminUsers ​

Описание

Получение всех пользователей из Базы Данных

HTTP метод: GET

URL: /api-admin/v1/users

Параметры:

ИмяТипОписание
payloadIGetSuperAdminUsersPayload

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

getSuperAdminUserById ​

Описание

Получение пользователя по ID

HTTP метод: GET

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

Параметры:

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

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

updateSuperAdminUserRoles ​

Описание

Обновление ролей пользователя через СуперАдминистрирование

HTTP метод: PUT

URL: /api-admin/v1/users/{param}/roles

Параметры:

ИмяТипОписание
userIdIUser['id']
payloadIUpdateSuperAdminUserRolesPayload

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

updateSuperAdminUser ​

Описание

Обновление данный пользователя через СуперАдминистрирование

HTTP метод: PUT

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

Параметры:

ИмяТипОписание
userIdIUser['id']
payloadISuperAdminUserEditor

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

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

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

IBank ​

СвойствоТипОписание
idnumber
namestring
addressstring
bikstring
codenumber
countryICountry
is_activeboolean
is_headboolean

IBill ​

СвойствоТипОписание
idnumber
iikstring
is_defaultboolean
kbeRefNumberInString
sys_subjects_idnumber
countryICountry
currencyICurrency
bankIBank
bill_typeOmit<RefEntityShell<undefined, EBillTypeId>, 'alias'>

IContact ​

СвойствоТипОписание
idnumber
fulladdressstring
is_defaultboolean
phonestring
postalstring
sys_subjects_idnumber
contact_typeRefEntityShell
countryICountry
kato (опц.)IKATO

ICountry ​

СвойствоТипОписание
alpha2CountryIsoCode
codeRefNumberInString
idnumber
is_activeboolean
namestring

ICurrency ​

СвойствоТипОписание
idRefNumberInString
namestring
codenumber
is_activeboolean
current`{
    id: number
    code: string
    publish_date: string
    amount: string
    description: string
}` |  |

IFile ​

СвойствоТипОписание
idnumber
namestring
is_activeRefNumericBoolean
created_at (опц.)RefSystemDateTime
sys_file`{
    id: number
    name: string
    full_path: string
    mime: RefMimeTypeFromDb
    path: string
    size: number
}` |  |

IGetSuperAdminUsersPayload ​

Наследует: IPaginationPayload

СвойствоТипОписание
q (опц.)string
'filters[subject_id]' (опц.)ISubject['id']
'filters[is_disable]' (опц.)boolean

IGetUserPayload ​

СвойствоТипОписание
token (опц.)string

IKATO ​

СвойствоТипОписание
idnumber
full_namestring
namestring
testring
СвойствоТипОписание
firststring | null
laststring | null
nextstring | null
prevstring | null

IPaginationMeta ​

СвойствоТипОписание
pathstring
current_pagenumber
per_pagenumber
tonumber
fromnumber
totalnumber
linksIPaginationMetaLink[]
last_pagenumber
СвойствоТипОписание
activeboolean
labelstring
urlstring | null

IPaginationPayload ​

СвойствоТипОписание
pagenumber
per_pagenumber

IPaginationShell ​

СвойствоТипОписание
linksIPaginationLinks[]
metaIPaginationMeta
datalist

ISendFilesPayload ​

СвойствоТипОписание
store (опц.)File[]
delete (опц.)number[]

ISetUserSubjectPayload ​

СвойствоТипОписание
subject_idnumber | null

ISubject ​

СвойствоТипОписание
idnumberId компании
namestring
name_rustring
name_kzstring
name_enstring
created_atRefDate
identifierstring
parent_id (опц.)RefParentId
billsIBill[]
contactsIContact[]
countryICountry
logo`{
    default: boolean
    url: string
}` |  |

| kopf | { id: number name: number alias: string code: string } | | | available_document_types | Omit<RefEntityShell<EDocumentTypeAlias, EDocumentTypeIds>, 'name'>[] | | | is_customer (опц.) | boolean | | | is_supplier (опц.) | boolean | |

ISubjectRole ​

СвойствоТипОписание
idnumber
namestring
currentboolean
identifierstring
kopfISubject['kopf']
permissionsstring[]
rolesIUserRole[]

ISubjectUnit ​

СвойствоТипОписание
idnumber
namestring
parent_idnull
sort_pidnumber
sys_subjects_idnumber

ISuperAdminSubjectUser ​

СвойствоТипОписание
idnumber
created_atRefDate
deleted_atRefDate
is_disableboolean
is_disabled_reasonnull | string
job_titlestring
request_typenull
sort_pidnumber
statusnull
roles`{
    id: number
    sys_subjects_id: null
    sys_users_id: number
    role: IUserRole
}[]` |  |

| subject | ISubject | | | user | IUser | | | sys_subject_unit | ISubjectUnit | |

ISuperAdminUser ​

Наследует: IUser

СвойствоТипОписание
subject_usersISuperAdminSubjectUser[]

ISuperAdminUserEditor ​

СвойствоТипОписание
emailstring
is_disableboolean
lastnamestring
namestring
phonestring
surnamestring
is_disabled_reason (опц.)string
subjects`{
    id: ISubject['id']
    roles: IUserRole['id'][]
    is_disabled: boolean
    is_disabled_reason: string
}[]` |  |

IUpdatePasswordPayload ​

СвойствоТипОписание
old_passwordstring
passwordstring
password_confirmationstring

IUpdateProfilePayload ​

СвойствоТипОписание
phonestring
emailstring

IUpdateSuperAdminUserRolesPayload ​

СвойствоТипОписание
rolesnumber[]

IUser ​

СвойствоТипОписание
idnumber
created_atRefDate
birth_dateRefDate
emailstring
email_verifiedboolean
verification_token (опц.)string
identifierstring
is_disableboolean
phonestring
set_passwordboolean
lastname (опц.)string
namestring
surname (опц.)string
unread_notifications_countnumber
permissionsEUserPermissions[]
profile_photo_urlRefEntityMedia
rolesIUserRole[]
subject_rolesISubjectRole[]
is_disabled_reason (опц.)string
has_password (опц.)boolean

IUserRepository ​

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

IUserRole ​

СвойствоТипОписание
idnumber
namestring
aliasEUserRoleAlias
created_atRefDate

RefEntityMedia ​

СвойствоТипОписание
defaultboolean
urlstring

RefEntityShell ​

СвойствоТипОписание
idid
aliasalias
namestring