Model

hyoo_api_model
	inherit OTriggered

hyoo_api_entity
	descr \Бизнес сущность
	inherit hyoo_api_model
	field
		id
			descr \Уникальный человекопонятный идентификатор
			example \person=jin
			key unique
			type text
			edit author
		name
			descr \Человекопонятное название
			example \Автор данной спецификации
			key lucene
			type text
			edit author
		history
			descr \Лог изменений сущности
			type list record
				who
					descr \Автор изменения
					type link hyoo_api_person
				when
					descr \Время изменения
					example \2020-01-02T10:20:30.000Z
					type iso8601
				what
					descr \Суть изменений в свободной форме
					example \{ "name": "Pupkin" }
					type json

hyoo_api_person
	descr \Живой пользователь сервиса
	inherit hyoo_api_entity
	field
		avatar
			descr \Ссылки на аватары
			type list hyoo_api_image
			edit author
		mail
			descr \Привязанные имейлы
			type set hyoo_api_mail
		phone
			descr \Привязанные телефонные номера
			type set hyoo_api_phone
		social
			descr \Привязанная социальная сеть
			type set hyoo_api_social
		token
			descr \Выданные авторизационные токены
			type set hyoo_api_token
		refer_to
			descr \Пользователи, кторые пригласили этого в систему
			type set hyoo_api_person
		refer_from
			descr \Поользователи, которых этот пригласил в систему
			type set hyoo_api_person
		notification
			descr \Непрочитанные уведомления
			type set hyoo_api_notification
		team
			descr \Группы, в которых пользователь состоит
			type set hyoo_api_team

hyoo_api_team
	inherit hyoo_api_entity
	descr \Группа пользователей
	field
		member
			descr \Пользователи, входящие в группу
			type set hyoo_api_person
			edit author

hyoo_api_mail
	descr \Электронная почта
	inherit hyoo_api_model
	field
		value
			descr \Адресс почты
			key unique
			type text
			crypted system
		confirmation
			descr \Код подтверждения
			type text
			crypted
			crypted system
		person
			descr \Привязанный пользователь
			type link hyoo_api_person

hyoo_api_phone
	descr \Номер телефона
	inherit hyoo_api_model
	field
		value
			descr \Значение номера
			key unique
			type text
			crypted system
		confirmation
			descr \Код подтверждения
			type text
			crypted system
		person
			descr \Привязанный пользователь
			type link hyoo_api_person

hyoo_api_social
	inherit hyoo_api_model
	descr \Информаця о пользователе, полученная из социальной сети
	field
		identity
			descr \
			key unique
			type text
			crypted system
		profile
			descr \
			type uri
			crypted system
		phone
			descr \
			type text
			crypted system
		country
			descr \
			type text
			crypted system
		city
			descr \
			type text
			crypted system
		mail
			descr \
			type text
			crypted system
		provider
			descr \
			type text
			crypted system
		photo
			descr \
			type uri
			crypted system
		name_first
			descr \
			type text
			crypted system
		name_last
			descr \
			type text
			crypted system
		name_nick
			descr \
			type text
			crypted system
		birthday
			descr \
			type iso8601
			crypted system
		sex
			descr \
			type variant
				\male
				\female
			crypted system
		person
			descr \
			type link hyoo_api_person

hyoo_api_token
	inherit hyoo_api_model
	descr \Аутентификационный токен
	field
		value
			descr \
			key unique
			type string
			crypted system
		description
			descr \
			type string
		expires
			descr \
			type string
		device_id
			descr \
			type text
		person
			descr \
			type link hyoo_api_person
		application
			descr \
			type set hyoo_api_application

hyoo_api_application
	inherit hyoo_api_model
	descr \Зарегистрированное клиентское приложение
	field
		push_service
			descr \
			type variant
				\apn
				\gcm
				\c2dm
				\wns
		private_key
			descr \
			type text
			crypted system
		certificate
			descr \
			type text
			crypted system
		token
			descr \
			type set hyoo_api_token

hyoo_api_chat
	inherit hyoo_api_entity
	descr \Беседа нескольких пользователей
	field
		member
			descr \Пользователи, участвующие в обсуждении
			type set hyoo_api_person

hyoo_api_message
	inherit hyoo_api_entity
	descr \Сообщение в беседе
	field
		chat
			descr \Беседа в которой оставлено сообщение
			type link hyoo_api_chat
		value
			descr \Тест сообщения
			type text
			edit from
			crypto chat

hyoo_api_image
	inherit hyoo_api_model
	descr \Мета информация о фотографии
	field
		container
			descr \Ссылка на контейнер к которому прикреплена фотография
			type link hyoo_api_entity
		small
			descr \Ссылка на превью картинки
			type string
			crypto container
		big
			descr \Ссылка на большой размер картинки
			type string
			crypto container
		orig
			descr \Ссылка на оригинал картинки
			type string
			crypto container
		width
			descr \Оригинальная ширина картинки
			type integer
		height
			descr \Оригинальная высота картинки
			type integer

hyoo_api_notification
	inherit hyoo_api_model
	descr \Уведомление с гарантированной доставкой
	field
		sent
			descr \Было ли уведомление отослано
			type boolean
		read
			descr \Было ли уведомление прочитано адресатом
			type boolean
			edit recipient
		kind
			descr \
			type text
		message
			descr \
			type text
		start
			descr \
			type iso8601
		link
			descr \
			type uri
		sender
			descr \
			type uri
		recipient
			descr \
			type link hyoo_api_person