models

Documentation

Overview

Package models describes the communication format between JS snd Go. Models are not persisted entities - they are object models that are marshalled between the backend and the consumer (UI).

Index

• type AcceptSharedFolderModel
• type AuthenticationModel
• type DocumentUploadModel
• type FolderInvitationModel
• type FolderRolesModel
• type PageLevelRequestModel
• type PageModel
• type PageSequenceRequestModel

Types

type AcceptSharedFolderModel

type AcceptSharedFolderModel struct {
	Serial    string `json:"serial"`
	Firstname string `json:"firstname"`
	Lastname  string `json:"lastname"`
	Password  string `json:"password"`
}

AcceptSharedFolderModel is used to setup a user who has accepted a shared folder.

type AuthenticationModel

type AuthenticationModel struct {
	Token string      `json:"token"`
	User  entity.User `json:"user"`
}

AuthenticationModel details authentication token and user details.

type DocumentUploadModel

type DocumentUploadModel struct {
	JobID string `json:"jobId"`
}

DocumentUploadModel details the job ID of an uploaded document.

type FolderInvitationModel

type FolderInvitationModel struct {
	Message    string
	Recipients []string
}

FolderInvitationModel details which users have been invited to a folder.

type FolderRolesModel

type FolderRolesModel struct {
	Message string
	Roles   []entity.LabelRole
}

FolderRolesModel details which users have what permissions on a given folder.

type PageLevelRequestModel

type PageLevelRequestModel struct {
	PageID string `json:"pageId"`
	Level  int    `json:"level"`
}

PageLevelRequestModel details a page ID and level.

type PageModel

type PageModel struct {
	Page entity.Page     `json:"page"`
	Meta entity.PageMeta `json:"meta"`
}

PageModel contains the page and associated meta.

type PageSequenceRequestModel

type PageSequenceRequestModel struct {
	PageID   string  `json:"pageId"`
	Sequence float64 `json:"sequence"`
}

PageSequenceRequestModel details a page ID and its sequence within the document.