models

type AddForumParams struct {
	cmr.CommonParams

	// Identifier of a section containing this forum.
	SectionId uint `json:"sectionId"`

	// Name of this forum.
	Name string `json:"name"`
}

type AddForumResult struct {
	cmr.CommonResult

	// ID of the created forum.
	ForumId uint `json:"forumId"`
}

type AddMessageParams struct {
	cmr.CommonParams

	// ID of a thread containing this message.
	ThreadId uint `json:"threadId"`

	// Message text.
	Text string `json:"text"`
}

type AddMessageResult struct {
	cmr.CommonResult

	// ID of the created message.
	MessageId uint `json:"messageId"`
}

type AddSectionParams struct {
	cmr.CommonParams

	// Identifier of a parent section containing this section.
	// Null means that this section is a root section.
	// Only a single root section can exist.
	Parent *uint `json:"parent"`

	// Name of this section.
	Name string `json:"name"`
}

type AddSectionResult struct {
	cmr.CommonResult

	// ID of the created section.
	SectionId uint `json:"sectionId"`
}

type AddThreadParams struct {
	cmr.CommonParams

	// ID of a forum containing this thread.
	ForumId uint `json:"forumId"`

	// Thread name.
	Name string `json:"name"`
}

type AddThreadResult struct {
	cmr.CommonResult

	// ID of the created forum.
	ThreadId uint `json:"threadId"`
}

type ChangeForumNameParams struct {
	cmr.CommonParams

	ForumId uint `json:"forumId"`

	// New name.
	Name string `json:"name"`
}

type ChangeForumNameResult struct {
	cmr.CommonResult

	OK bool `json:"ok"`
}

type ChangeForumSectionParams struct {
	cmr.CommonParams

	// Identifier of this forum.
	ForumId uint `json:"forumId"`

	// Identifier of a section containing this forum.
	SectionId uint `json:"sectionId"`
}

type ChangeForumSectionResult struct {
	cmr.CommonResult

	OK bool `json:"ok"`
}

type ChangeMessageTextParams struct {
	cmr.CommonParams

	MessageId uint `json:"messageId"`

	// New text.
	Text string `json:"text"`
}

type ChangeMessageTextResult struct {
	cmr.CommonResult

	OK bool `json:"ok"`
}

type ChangeMessageThreadParams struct {
	cmr.CommonParams

	MessageId uint `json:"messageId"`

	// ID of a new parent thread.
	ThreadId uint `json:"threadId"`
}

type ChangeMessageThreadResult struct {
	cmr.CommonResult

	OK bool `json:"ok"`
}

type ChangeSectionNameParams struct {
	cmr.CommonParams

	// Identifier of a section.
	SectionId uint `json:"sectionId"`

	// Name of this section.
	Name string `json:"name"`
}

type ChangeSectionNameResult struct {
	cmr.CommonResult

	OK bool `json:"ok"`
}

type ChangeSectionParentParams struct {
	cmr.CommonParams

	// Identifier of a section.
	SectionId uint `json:"sectionId"`

	// Identifier of a parent section containing this section.
	Parent uint `json:"parent"`
}

type ChangeSectionParentResult struct {
	cmr.CommonResult

	OK bool `json:"ok"`
}

type ChangeThreadForumParams struct {
	cmr.CommonParams

	ThreadId uint `json:"threadId"`

	// ID of a new parent forum.
	ForumId uint `json:"forumId"`
}

type ChangeThreadForumResult struct {
	cmr.CommonResult

	OK bool `json:"ok"`
}

type ChangeThreadNameParams struct {
	cmr.CommonParams

	ThreadId uint `json:"threadId"`

	// New name.
	Name string `json:"name"`
}

type ChangeThreadNameResult struct {
	cmr.CommonResult

	OK bool `json:"ok"`
}

type DeleteForumParams struct {
	cmr.CommonParams

	ForumId uint `json:"forumId"`
}

type DeleteForumResult struct {
	cmr.CommonResult

	OK bool `json:"ok"`
}

type DeleteMessageParams struct {
	cmr.CommonParams

	MessageId uint `json:"messageId"`
}

type DeleteMessageResult struct {
	cmr.CommonResult

	OK bool `json:"ok"`
}

type DeleteSectionParams struct {
	cmr.CommonParams

	SectionId uint `json:"sectionId"`
}

type DeleteSectionResult struct {
	cmr.CommonResult

	OK bool `json:"ok"`
}

type DeleteThreadParams struct {
	cmr.CommonParams

	ThreadId uint `json:"threadId"`
}

type DeleteThreadResult struct {
	cmr.CommonResult

	OK bool `json:"ok"`
}

type EventData struct {
	// Parameters of creation.
	Creator *EventParameters `json:"creator"`

	// Parameters of the last edit.
	Editor *OptionalEventParameters `json:"editor"`
}

type EventParameters struct {
	// ID of a user who initiated the event.
	UserId uint `json:"userId"`

	// Time of the event.
	Time time.Time `json:"time"`
}

type Forum struct {
	// Identifier of this forum.
	Id uint `json:"id"`

	// Identifier of a section containing this forum.
	SectionId uint `json:"sectionId"`

	// Name of this forum.
	Name string `json:"name"`

	// List of identifiers of threads of this forum.
	Threads *ul.UidList `json:"threads"`

	// Forum meta-data.
	EventData
}

type ForumAndThreads struct {
	// Forum parameters.
	ForumId        uint   `json:"forumId"`
	ForumSectionId uint   `json:"forumSectionId"`
	ForumName      string `json:"forumName"`
	EventData

	// Thread parameters. If pagination is used, these lists contain
	// information after the application of pagination.
	ThreadIds *ul.UidList `json:"threadIds"`
	Threads   []Thread    `json:"threads"`

	// Number of the current page of threads.
	Page *uint `json:"page,omitempty"`

	// Total number of available pages of threads.
	TotalPages *uint `json:"totalPages,omitempty"`

	// Total number of available threads.
	TotalThreads *uint `json:"totalThreads,omitempty"`
}

type GetForumParams struct {
	cmr.CommonParams

	ForumId uint `json:"forumId"`
}

type GetForumResult struct {
	cmr.CommonResult

	Forum *Forum `json:"forum"`
}

type GetMessageParams struct {
	cmr.CommonParams

	MessageId uint `json:"messageId"`
}

type GetMessageResult struct {
	cmr.CommonResult

	Message *Message `json:"message"`
}

type GetSectionParams struct {
	cmr.CommonParams

	SectionId uint `json:"sectionId"`
}

type GetSectionResult struct {
	cmr.CommonResult

	Section *Section `json:"section"`
}

type GetThreadParams struct {
	cmr.CommonParams

	ThreadId uint `json:"threadId"`
}

type GetThreadResult struct {
	cmr.CommonResult

	Thread *Thread `json:"thread"`
}

type ListForumAndThreadsOnPageParams struct {
	cmr.CommonParams

	ForumId uint `json:"forumId"`
	Page    uint `json:"page"`
}

type ListForumAndThreadsOnPageResult struct {
	cmr.CommonResult

	ForumAndThreadsOnPage *ForumAndThreads `json:"fatop"`
}

type ListForumAndThreadsParams struct {
	cmr.CommonParams

	ForumId uint `json:"forumId"`
}

type ListForumAndThreadsResult struct {
	cmr.CommonResult

	ForumAndThreads *ForumAndThreads `json:"fat"`
}

type ListSectionsAndForumsParams struct {
	cmr.CommonParams
}

type ListSectionsAndForumsResult struct {
	cmr.CommonResult

	SectionsAndForums *SectionsAndForums `json:"saf"`
}

type ListThreadAndMessagesOnPageParams struct {
	cmr.CommonParams

	ThreadId uint `json:"threadId"`
	Page     uint `json:"page"`
}

type ListThreadAndMessagesOnPageResult struct {
	cmr.CommonResult

	ThreadAndMessagesOnPage *ThreadAndMessages `json:"tamop"`
}

type ListThreadAndMessagesParams struct {
	cmr.CommonParams

	ThreadId uint `json:"threadId"`
}

type ListThreadAndMessagesResult struct {
	cmr.CommonResult

	ThreadAndMessages *ThreadAndMessages `json:"tam"`
}

type Message struct {
	// Identifier of this message.
	Id uint `json:"id"`

	// Identifier of a thread containing this message.
	ThreadId uint `json:"threadId"`

	// Textual information of this message.
	Text string `json:"text"`

	// Check sum of the Text field.
	TextChecksum uint32 `json:"textChecksum"`

	// Message meta-data.
	EventData
}

type OptionalEventParameters struct {
	// ID of a user who initiated the event.
	UserId *uint `json:"userId"`

	// Time of the event.
	Time *time.Time `json:"time"`
}

type PingParams = cmr.PingParams

type PingResult = cmr.PingResult

type Section struct {
	// Identifier of a section.
	Id uint `json:"id"`

	// Identifier of a parent section containing this section.
	// Null means that this section is a root section.
	// Only a single root section can exist.
	Parent *uint `json:"parent"`

	// Type of child elements: either sub-sections or forums.
	ChildType byte `json:"childType"`

	// List of IDs of child elements (either sub-sections or forums).
	// Null means that this section has no children.
	Children *ul.UidList `json:"children"`

	// Name of this section.
	Name string `json:"name"`

	// Section meta-data.
	EventData
}

type SectionsAndForums struct {
	Sections []Section `json:"sections"`
	Forums   []Forum   `json:"forums"`
}

type ShowDiagnosticDataParams struct{}

type ShowDiagnosticDataResult struct {
	cmr.CommonResult
	cmr.RequestsCount
}

type TestParams struct {
	N uint `json:"n"`
}

type TestResult struct {
	cmr.CommonResult
}

type Thread struct {
	// Identifier of this thread.
	Id uint `json:"id"`

	// Identifier of a forum containing this thread.
	ForumId uint `json:"forumId"`

	// Name of this thread.
	Name string `json:"name"`

	// List of identifiers of messages of this thread.
	Messages *ul.UidList `json:"messages"`

	// Thread meta-data.
	EventData
}

type ThreadAndMessages struct {
	// Thread parameters.
	ThreadId      uint   `json:"threadId"`
	ThreadForumId uint   `json:"threadForumId"`
	ThreadName    string `json:"threadName"`
	EventData

	// Message parameters. If pagination is used, these lists contain
	// information after the application of pagination.
	MessageIds *ul.UidList `json:"messageIds"`
	Messages   []Message   `json:"messages"`

	// Number of the current page of messages.
	Page *uint `json:"page,omitempty"`

	// Total number of available pages of messages.
	TotalPages *uint `json:"totalPages,omitempty"`

	// Total number of available messages.
	TotalMessages *uint `json:"totalMessages,omitempty"`
}