models

Documentation

Overview

Package models contains the data models for the Smarters project. These models represent the structure of data that will be handled by the application, including messages received from and sent to the Messenger API.

Package models contains the data models for the Smarters project.

Package models contém os modelos de dados para o projeto Smarters.

Package models contém os modelos de dados para o projeto Smarters.

Index

• type Attachment
• type Button
• type Content
• type ErrorResponse
• type LogMessage
• type Message
• type MessageReceived
• type MessageSent
• type Messaging
• type Payload
• type Postback
• type User

Types

type Attachment

type Attachment struct {
	ID        uint    `gorm:"primaryKey" json:"id"`
	Type      string  `json:"type" example:"template"` // Tipo de anexo
	PayloadID uint    `json:"payload_id"`              // Chave estrangeira para Payload
	Payload   Payload `json:"payload"`                 // Payload do anexo
}

Attachment representa um anexo na mensagem @description Estrutura que representa um anexo na mensagem

type Button

type Button struct {
	ID        uint   `gorm:"primaryKey" json:"id"`
	PayloadID uint   `json:"payload_id"`
	Type      string `json:"type" example:"postback"`         // Tipo do botão
	Title     string `json:"title" example:"Começar"`         // Título do botão
	Payload   string `json:"payload" example:"START_PAYLOAD"` // Payload do botão
}

Button representa um botão no payload @description Estrutura que representa um botão no payload

type Content

type Content struct {
	ID           uint        `gorm:"primaryKey" json:"id"`
	Text         *string     `json:"text,omitempty"`       // Texto da mensagem
	AttachmentID uint        `json:"attachment_id"`        // Chave estrangeira para Attachment
	Attachment   *Attachment `json:"attachment,omitempty"` // Anexo da mensagem
}

Content representa o conteúdo da mensagem enviada @description Estrutura que representa o conteúdo da mensagem enviada

type ErrorResponse

type ErrorResponse struct {
	Error string `json:"error"`
}

ErrorResponse representa a estrutura para resposta de erro @description Estrutura para resposta de erro

type LogMessage

type LogMessage struct {
	ID        uint      `gorm:"primaryKey" json:"id"`
	Message   string    `json:"message"`
	Timestamp time.Time `json:"timestamp"`
}

LogMessage representa uma mensagem de log @description Estrutura que contém os detalhes de uma mensagem de log

type Message

type Message struct {
	ID   uint   `gorm:"primaryKey" json:"id"`
	MID  string `json:"mid" example:"mid.1457764197618:41d102a3e1ae206a38"` // ID da mensagem
	Text string `json:"text" example:"ping"`                                // Texto da mensagem
}

Message representa os detalhes de uma mensagem de texto @description Estrutura que representa os detalhes de uma mensagem de texto

type MessageReceived

type MessageReceived struct {
	ID        uint        `gorm:"primaryKey;autoIncrement" json:"id" example:"1"` // ID da mensagem recebida
	PageID    string      `json:"page_id" example:"PAGE_ID"`                      // ID da página
	Time      int64       `json:"time" example:"1458692752478"`                   // Timestamp da mensagem
	Messaging []Messaging `json:"messaging"`                                      // Array de mensagens
}

MessageReceived representa a mensagem recebida do Messenger @description Estrutura que representa uma mensagem recebida do Messenger.

type MessageSent

type MessageSent struct {
	ID          uint    `gorm:"primaryKey" json:"id"`
	RecipientID uint    `json:"recipient_id"` // Chave estrangeira para User
	Recipient   User    `json:"recipient"`    // Informações do destinatário
	MessageID   uint    `json:"message_id"`   // Chave estrangeira para Content
	Message     Content `json:"message"`      // Conteúdo da mensagem
}

MessageSent representa a mensagem enviada ao Messenger @description Estrutura que representa uma mensagem enviada ao Messenger

type Messaging

type Messaging struct {
	ID                uint      `gorm:"primaryKey" json:"id"`
	SenderID          uint      `json:"sender_id"`                         // Chave estrangeira para User
	Sender            User      `json:"sender"`                            // Informações do remetente
	RecipientID       uint      `json:"recipient_id"`                      // Chave estrangeira para User
	Recipient         User      `json:"recipient"`                         // Informações do destinatário
	Timestamp         int64     `json:"timestamp" example:"1458692752478"` // Timestamp da mensagem
	MessageID         uint      `json:"message_id"`                        // Chave estrangeira para Message
	Message           *Message  `json:"message,omitempty"`                 // Detalhes da mensagem de texto
	PostbackID        uint      `json:"postback_id"`                       // Chave estrangeira para Postback
	Postback          *Postback `json:"postback,omitempty"`                // Detalhes do postback
	MessageReceivedID uint      `json:"message_received_id"`               // Chave estrangeira para MessageReceived
}

Messaging representa os detalhes da mensagem @description Estrutura que contém os detalhes da mensagem

type Payload

type Payload struct {
	ID           uint     `gorm:"primaryKey" json:"id"`
	TemplateType string   `json:"template_type" example:"button"`                        // Tipo de template
	Text         string   `json:"text" example:"O que você gostaria de fazer a seguir?"` // Texto do template
	Buttons      []Button `json:"buttons"`                                               // Botões do template
}

Payload representa o payload de um anexo @description Estrutura que representa o payload de um anexo

type Postback

type Postback struct {
	ID      uint   `gorm:"primaryKey" json:"id"`
	MID     string `json:"mid" example:"mid.1457764197618:41d102a3e1ae206a38"` // ID do postback
	Payload string `json:"payload" example:"START_PAYLOAD"`                    // Payload do postback
}

Postback representa os detalhes de um postback @description Estrutura que representa os detalhes de um postback

type User

type User struct {
	ID  uint   `gorm:"primaryKey" json:"id"`
	UID string `json:"uid" example:"USER_ID"` // ID do usuário
}

User representa um usuário @description Estrutura que representa um usuário