resources

type CreateRequest struct {
	// user's id who send request
	FromUser string `json:"from_user"`
	// Module to grant permission
	Module string `json:"module"`
	// Already built payload to grant permission
	Payload json.RawMessage `json:"payload"`
	// user's id for who request was sent
	ToUser string `json:"to_user"`
}

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 FromToUser struct {
	Key
	Attributes FromToUserAttributes `json:"attributes"`
}

type FromToUserAttributes struct {
	// user's id who send request
	FromUser string `json:"from_user"`
	// user's id for who request was sent
	ToUser string `json:"to_user"`
}

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

type FromToUserResponse struct {
	Data     FromToUser `json:"data"`
	Included Included   `json:"included"`
}

type GetRequest struct {
	// timestamp when request was created
	CreatedAt string `json:"created_at"`
	// Error during request processing
	Error *string `json:"error,omitempty"`
	// user's id who send request
	FromUser string `json:"from_user"`
	// Module to grant permission
	Module string `json:"module"`
	// Already built payload to grant permission
	Payload json.RawMessage `json:"payload"`
	// Status of the request
	Status string `json:"status"`
	// user's id for who request was sent
	ToUser string `json:"to_user"`
}

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

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

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

type LinkAttributes struct {
	// flag to indicate whether link exists or not
	IsExists bool `json:"is_exists"`
	// 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 ModuleInfo struct {
	Key
	Attributes ModuleInfoAttributes `json:"attributes"`
}

type ModuleInfoAttributes struct {
	// Module icon url
	Icon string `json:"icon"`
	// Module name
	Name string `json:"name"`
	// Module prefix to use in FE
	Prefix string `json:"prefix"`
}

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

type ModuleInfoResponse struct {
	Data     ModuleInfo `json:"data"`
	Included Included   `json:"included"`
}

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 ModulesRoles struct {
	Key
	Attributes ModulesRolesAttributes `json:"attributes"`
}

type ModulesRolesAttributes struct {
}

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

type ModulesRolesResponse struct {
	Data     ModulesRoles `json:"data"`
	Included Included     `json:"included"`
}

type NewRequest struct {
	// Module to grant permission
	Module string `json:"module"`
	// Already built payload to grant permission
	Payload json.RawMessage `json:"payload"`
}

type Refresh struct {
	Key
	Attributes RefreshAttributes `json:"attributes"`
}

type RefreshAttributes struct {
	// Module name
	ModuleName *string `json:"module_name,omitempty"`
	// Submodules of module
	Submodule *[]string `json:"submodule,omitempty"`
}

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

type RefreshResponse struct {
	Data     Refresh  `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 Request struct {
	Key
	Attributes    RequestAttributes    `json:"attributes"`
	Relationships RequestRelationships `json:"relationships"`
}

type RequestAttributes struct {
	// user's id who send request
	FromUser string `json:"from_user"`
	// Module to grant permission
	Module string `json:"module"`
	// Already built payload to grant permission
	Payload json.RawMessage `json:"payload"`
	// user's id for who request was sent
	ToUser string `json:"to_user"`
	// timestamp when request was created
	CreatedAt string `json:"created_at"`
	// Error during request processing
	Error *string `json:"error,omitempty"`
	// Status of the request
	Status string `json:"status"`
}

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 Submodule struct {
	Key
	Attributes SubmoduleAttributes `json:"attributes"`
}

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

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

type SubmoduleResponse struct {
	Data     Submodule `json:"data"`
	Included Included  `json:"included"`
}

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

type UserAttributes struct {
	// submodule access level
	AccessLevel string `json:"access_level"`
	// module name
	Module string `json:"module"`
	// phone from module
	Phone *string `json:"phone,omitempty"`
	// submodule name
	Submodule string `json:"submodule"`
	// user id from identity module
	UserId int64 `json:"user_id"`
	// username from module
	Username *string `json:"username,omitempty"`
}

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

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