resources

type AccessLevel struct {
	// role name to show in FE
	Name string `json:"name"`
	// role value to use in BE
	Value string `json:"value"`
}

type AddUser struct {
	// user's id from identity
	AccessLevel int `json:"access_level"`
	// action that must be handled in module, must be \"add_user\"
	Action string `json:"action"`
	// link where module has to add user
	Link string `json:"link"`
	// phone from telegram
	Phone *string `json:"phone,omitempty"`
	// user's id from identity
	UserId string `json:"user_id"`
	// user's username from gitlab
	Username *string `json:"username,omitempty"`
}

type Chat struct {
	Key
	Attributes ChatAttributes `json:"attributes"`
}

type ChatAttributes struct {
	// telegram chat access hash
	AccessHash *int64 `json:"access_hash,omitempty"`
	// telegram chat id
	Id int64 `json:"id"`
	// telegram chat members amount
	MembersAmount int64 `json:"members_amount"`
	// link to the chat photo
	Photo *string `json:"photo,omitempty"`
	// telegram chat title
	Title string `json:"title"`
}

type ChatListResponse struct {
	Data     []Chat   `json:"data"`
	Included Included `json:"included"`
	Links    *Links   `json:"links"`
}

type ChatResponse struct {
	Data     Chat     `json:"data"`
	Included Included `json:"included"`
}

type DeleteUser struct {
	// action that must be handled in module, must be \"delete_user\"
	Action string `json:"action"`
	// phone from telegram
	Phone *string `json:"phone,omitempty"`
	// user's username from telegram
	Username *string `json:"username,omitempty"`
}

type Details json.RawMessage

type EstimatedTime struct {
	Key
	Attributes EstimatedTimeAttributes `json:"attributes"`
}

type EstimatedTimeAttributes struct {
	EstimatedTime string `json:"estimated_time"`
}

type EstimatedTimeListResponse struct {
	Data     []EstimatedTime `json:"data"`
	Included Included        `json:"included"`
	Links    *Links          `json:"links"`
}

type EstimatedTimeResponse struct {
	Data     EstimatedTime `json:"data"`
	Included Included      `json:"included"`
}

type Flag struct {
	Name  string `json:"name"`
	Value int32  `json:"value"`
}

type Flagger interface {
	IsFlag() bool
}

type Flags struct {
	Mask   int32  `json:"mask"`
	Values []Flag `json:"flags"`
}

type GetUsers struct {
	// action that must be handled in module, must be \"get_users\"
	Action string `json:"action"`
	// link where module has to add user
	Link string `json:"link"`
}

type Included struct {
	// contains filtered or unexported fields
}

type Inputs struct {
	Key
	Attributes InputsAttributes `json:"attributes"`
}

type InputsAttributes struct {
	// level of access that would be given
	AccessLevel string `json:"access_level"`
	// link for which would be given access
	Link string `json:"link"`
	// phone from telegram
	Phone string `json:"phone"`
	// username from telegram
	Username string `json:"username"`
}

type InputsListResponse struct {
	Data     []Inputs `json:"data"`
	Included Included `json:"included"`
	Links    *Links   `json:"links"`
}

type InputsResponse struct {
	Data     Inputs   `json:"data"`
	Included Included `json:"included"`
}

type Key struct {
	ID   string       `json:"id"`
	Type ResourceType `json:"type"`
}

type Link struct {
	Key
	Attributes LinkAttributes `json:"attributes"`
}

type LinkAttributes struct {
	// indicates whether link exists
	IsExists *bool `json:"is_exists,omitempty"`
	// link to repository or group
	Link string `json:"link"`
}

type LinkListResponse struct {
	Data     []Link   `json:"data"`
	Included Included `json:"included"`
	Links    *Links   `json:"links"`
}

type LinkResponse struct {
	Data     Link     `json:"data"`
	Included Included `json:"included"`
}

type Links struct {
	First string `json:"first"`
	Last  string `json:"last"`
	Next  string `json:"next"`
	Prev  string `json:"prev"`
	Self  string `json:"self"`
}

type Module struct {
	Key
	Attributes ModuleAttributes `json:"attributes"`
}

type ModuleAttributes struct {
	// indicates whether module (gitlab, telegram etc.) or service (unverified, role etc.)
	IsModule bool `json:"is_module"`
	// Module url
	Link string `json:"link"`
	// Module name
	Name string `json:"name"`
	// Module prefix to use in FE
	Prefix string `json:"prefix"`
	// Module name to use in FE
	Title string `json:"title"`
	// Module topic for sender and others
	Topic string `json:"topic"`
}

type ModuleListResponse struct {
	Data     []Module `json:"data"`
	Included Included `json:"included"`
	Links    *Links   `json:"links"`
}

type ModuleResponse struct {
	Data     Module   `json:"data"`
	Included Included `json:"included"`
}

type ModuleRoles struct {
	Key
	Attributes ModuleRolesAttributes `json:"attributes"`
}

type ModuleRolesAttributes struct {
}

type ModuleRolesListResponse struct {
	Data     []ModuleRoles `json:"data"`
	Included Included      `json:"included"`
	Links    *Links        `json:"links"`
}

type ModuleRolesResponse struct {
	Data     ModuleRoles `json:"data"`
	Included Included    `json:"included"`
}

type Relation struct {
	Data  *Key   `json:"data,omitempty"`
	Links *Links `json:"links,omitempty"`
}

type RelationCollection struct {
	Data  []Key  `json:"data"`
	Links *Links `json:"links,omitempty"`
}

type RemoveUser struct {
	// action that must be handled in module, must be \"remove_user\"
	Action string `json:"action"`
	// link where module has to add user
	Link string `json:"link"`
	// phone from telegram
	Phone *string `json:"phone,omitempty"`
	// user's username from telegram
	Username *string `json:"username,omitempty"`
}

type Request struct {
	Key
	Attributes    RequestAttributes    `json:"attributes"`
	Relationships RequestRelationships `json:"relationships"`
}

type RequestAttributes struct {
	// Module to grant permission
	Module string `json:"module"`
	// Already built payload to grant permission <br><br> -> \"add_user\" = action to add user in chat in telegram<br> -> \"verify_user\" = action to verify user in telegram module (connect user id from identity with telegram info)<br> -> \"update_user\" = action to update user access level in chat in telegram<br> -> \"get_users\" = action to get users with their permissions from chats in telegram<br> -> \"delete_user\" = action to delete user from module (from all links)<br> -> \"remove_user\" = action to remove user from chat in telegram<br>
	Payload json.RawMessage `json:"payload"`
}

type RequestListResponse struct {
	Data     []Request `json:"data"`
	Included Included  `json:"included"`
	Links    *Links    `json:"links"`
}

type RequestRelationships struct {
	User Relation `json:"user"`
}

type RequestResponse struct {
	Data     Request  `json:"data"`
	Included Included `json:"included"`
}

type Resource interface {
	//GetKey - returns key of the Resource
	GetKey() Key
}

type ResourceType string

type Role struct {
	Key
	Attributes RoleAttributes `json:"attributes"`
}

type RoleAttributes struct {
	// role name to show in FE
	Name string `json:"name"`
	// role value to use in BE
	Value string `json:"value"`
}

type RoleListResponse struct {
	Data     []Role   `json:"data"`
	Included Included `json:"included"`
	Links    *Links   `json:"links"`
}

type RoleResponse struct {
	Data     Role     `json:"data"`
	Included Included `json:"included"`
}

type Roles struct {
	Key
	Attributes RolesAttributes `json:"attributes"`
}

type RolesAttributes struct {
	Chats []Chat `json:"chats"`
	// flag to show if any role was found for given link
	Req   bool          `json:"req"`
	Roles []AccessLevel `json:"roles"`
}

type RolesListResponse struct {
	Data     []Roles  `json:"data"`
	Included Included `json:"included"`
	Links    *Links   `json:"links"`
}

type RolesResponse struct {
	Data     Roles    `json:"data"`
	Included Included `json:"included"`
}

type Submodules struct {
	Key
	Attributes SubmodulesAttributes `json:"attributes"`
}

type SubmodulesAttributes struct {
	Links []string `json:"links"`
}

type SubmodulesListResponse struct {
	Data     []Submodules `json:"data"`
	Included Included     `json:"included"`
	Links    *Links       `json:"links"`
}

type SubmodulesResponse struct {
	Data     Submodules `json:"data"`
	Included Included   `json:"included"`
}

type UpdateUser struct {
	// action that must be handled in module, must be \"update_user\"
	Action string `json:"action"`
	// link where module has to add user
	Link string `json:"link"`
	// phone from telegram
	Phone *string `json:"phone,omitempty"`
	// user's username from telegram
	Username *string `json:"username,omitempty"`
}

type User struct {
	Key
	Attributes UserAttributes `json:"attributes"`
}

type UserAttributes struct {
	// submodule access level
	AccessLevel *string `json:"access_level,omitempty"`
	// timestamp without timezone when user was created
	CreatedAt *time.Time `json:"created_at,omitempty"`
	// module name
	Module string `json:"module"`
	// phone from telegram
	Phone *string `json:"phone,omitempty"`
	// submodule name
	Submodule *string `json:"submodule,omitempty"`
	// user id from identity module, if user is not verified - null
	UserId *int64 `json:"user_id,omitempty"`
	// username from telegram
	Username *string `json:"username,omitempty"`
}

type UserInfo struct {
	Key
	Attributes UserInfoAttributes `json:"attributes"`
}

type UserInfoAttributes struct {
	// name from gitlab account
	Name string `json:"name"`
	// phone from telegram
	Phone *string `json:"phone,omitempty"`
	// username from telegram
	Username *string `json:"username,omitempty"`
}

type UserInfoListResponse struct {
	Data     []UserInfo `json:"data"`
	Included Included   `json:"included"`
	Links    *Links     `json:"links"`
}

type UserInfoResponse struct {
	Data     UserInfo `json:"data"`
	Included Included `json:"included"`
}

type UserListResponse struct {
	Data     []User   `json:"data"`
	Included Included `json:"included"`
	Links    *Links   `json:"links"`
}

type UserPermission struct {
	Key
	Attributes UserPermissionAttributes `json:"attributes"`
}

type UserPermissionAttributes struct {
	AccessLevel AccessLevel `json:"access_level"`
	// chat title
	Link string `json:"link"`
	// user id from module
	ModuleId int64 `json:"module_id"`
	// chat title
	Path string `json:"path"`
	// phone from telegram
	Phone *string `json:"phone,omitempty"`
	// submodule access hash to handle submodule with the same title
	SubmoduleAccessHash *int64 `json:"submodule_access_hash,omitempty"`
	// submodule id to handle submodule with the same title
	SubmoduleId int64 `json:"submodule_id"`
	// user id from identity
	UserId *int64 `json:"user_id,omitempty"`
	// username from telegram
	Username *string `json:"username,omitempty"`
}

type UserPermissionListResponse struct {
	Data     []UserPermission `json:"data"`
	Included Included         `json:"included"`
	Links    *Links           `json:"links"`
}

type UserPermissionResponse struct {
	Data     UserPermission `json:"data"`
	Included Included       `json:"included"`
}

type UserResponse struct {
	Data     User     `json:"data"`
	Included Included `json:"included"`
}

type VerifyUser struct {
	// action that must be handled in module, must be \"verify_user\"
	Action string `json:"action"`
	// user's id from identity
	UserId string `json:"user_id"`
	// user's username from gitlab
	Username string `json:"username"`
}