rest

type Item struct {
	// ID is the item identifier.
	ID string `json:"id"`

	// Name is the item name.
	Name string `json:"name"`

	// Description is the item description.
	Description string `json:"description"`

	// OwnerID is the PlayerID of the item owner.
	OwnerID string `json:"ownerID"`

	// LocationID is the LocationID of the item's location.
	LocationID ItemLocationID `json:"locationID"`

	// Created is the time of the item's creation.
	Created arcade.Timestamp `json:"created"`

	// Updated is the time the item was last updated.
	Updated arcade.Timestamp `json:"updated"`
}

type ItemCreateRequest struct {
	ItemRequest
}

type ItemLocationID struct {
	// ID is the location identifier. This can correspond the the ID of a room, player or item.
	ID string `json:"id"`

	// Type is the type of location. This can be "room", "player" or "item".
	Type string `json:"type"`
}

type ItemRequest struct {
	// Name is the name of the item.
	Name string `json:"name"`

	// Description is the description of the item.
	Description string `json:"description"`

	// OwnerID is the ID of the owner of the item.
	OwnerID string `json:"ownerID"`

	// LocationID is the ID of the location of the item.
	LocationID ItemLocationID `json:"locationID"`
}

type ItemResponse struct {
	// Item returns the information about an item.
	Item Item `json:"item"`
}

type ItemUpdateRequest struct {
	ItemRequest
}

type ItemsResponse struct {
	// Items returns the information about multiple items.
	Items []Item `json:"items"`
}

type Link struct {
	// ID is the link identifier.
	ID string `json:"id"`

	// Name is the link name.
	Name string `json:"name"`

	// Description is the link description.
	Description string `json:"description"`

	// OwnerID is the PlayerID of the link owner.
	OwnerID string `json:"ownerID"`

	// LocationID is the RoomID of the link's location.
	LocationID string `json:"locationID"`

	// DestinationID is the RoomID of the link's destination.
	DestinationID string `json:"destinationID"`

	// Created is the time of the link's creation.
	Created arcade.Timestamp `json:"created"`

	// Updated is the time the link was last updated.
	Updated arcade.Timestamp `json:"updated"`
}

type LinkCreateRequest struct {
	LinkRequest
}

type LinkRequest struct {
	// Name is the name of the link.
	Name string `json:"name"`

	// Description is the description of the link.
	Description string `json:"description"`

	// OwnerID is the ID of the owner of the link.
	OwnerID string `json:"ownerID"`

	// LocationID is the ID of the location of the link.
	LocationID string `json:"locationID"`

	// DestinationID is the ID of the destination of the link.
	DestinationID string `json:"destinationID"`
}

type LinkResponse struct {
	// Link returns the information about a link.
	Link Link `json:"link"`
}

type LinkUpdateRequest struct {
	LinkRequest
}

type LinksResponse struct {
	// Links returns the information about multiple links.
	Links []Link `json:"links"`
}

type Player struct {
	// ID is the player identifier.
	ID string `json:"id"`

	// Name is the player name.
	Name string `json:"name"`

	// Description is the player description.
	Description string `json:"description"`

	// HomeID is the RoomID of the player's home.
	HomeID string `json:"homeID"`

	// LocationID is the RoomID of the player's location.
	LocationID string `json:"locationID"`

	// Created is the time of the player's creation.
	Created arcade.Timestamp `json:"created"`

	// Updated is the time the player was last updated.
	Updated arcade.Timestamp `json:"updated"`
}

type PlayerCreateRequest struct {
	PlayerRequest
}

type PlayerRequest struct {
	// Name is the name of the player.
	Name string `json:"name"`

	// Description is the description of the player.
	Description string `json:"description"`

	// HomeID is the ID of the home of the player.
	HomeID string `json:"homeID"`

	// LocationID is the ID of the location of the player.
	LocationID string `json:"locationID"`
}

type PlayerResponse struct {
	// Player returns the information about a player.
	Player Player `json:"player"`
}

type PlayerUpdateRequest struct {
	PlayerRequest
}

type PlayersResponse struct {
	// Players returns the information about multiple players.
	Players []Player `json:"players"`
}

type Room struct {
	// ID is the room identifier.
	ID string `json:"id"`

	// Name is the room name.
	Name string `json:"name"`

	// Description is the room description.
	Description string `json:"description"`

	// OwnerID is the PlayerID of the room owner.
	OwnerID string `json:"ownerID"`

	// ParentID is the RoomID of the room's parent.
	ParentID string `json:"parentID"`

	// Created is the time of the room's creation.
	Created arcade.Timestamp `json:"created"`

	// Updated is the time the room was last updated.
	Updated arcade.Timestamp `json:"updated"`
}

type RoomCreateRequest struct {
	RoomRequest
}

type RoomRequest struct {
	// Name is the name of the room.
	Name string `json:"name"`

	// Description is the description of the room.
	Description string `json:"description"`

	// OwnerID is the ID of the owner of the room.
	OwnerID string `json:"ownerID"`

	// ParentID is the ID of the parent of the room.
	ParentID string `json:"parentID"`
}

type RoomResponse struct {
	// Room returns the information about a room.
	Room Room `json:"room"`
}

type RoomUpdateRequest struct {
	RoomRequest
}

type RoomsResponse struct {
	// Rooms returns the information about multiple rooms.
	Rooms []Room `json:"rooms"`
}