api_model

Documentation

Index

• type DigestFlow
• type DigestTiming
• type FlowType
• type Notification
• type Step
• type Subscriber
• type Tenant
• type Workflow
• type WorkflowFlowItem
• type WorkflowTriggerRequest
• type WorkflowTriggerResponse

Types

type DigestFlow

type DigestFlow struct {
	Timing DigestTiming `bson:"timing" json:"timing"`

	// EventTime Timing == DigestEvent, seconds
	EventTime int `bson:"eventTime" json:"eventTime"`
}

type DigestTiming

type DigestTiming string

const (
	DigestEvent    DigestTiming = "event"
	DigestSchedule DigestTiming = "schedule"
)

type FlowType

type FlowType string

const (
	FlowNotification FlowType = "notification"
	FlowEmail        FlowType = "email"
	FlowDigest       FlowType = "digest"
)

type Notification

type Notification struct {
	Id         string `json:"id"`
	Subject    string `json:"subject"`
	Step       Step   `json:"step"`
	ReadMarked bool   `json:"readMarked"`
	Deleted    bool   `json:"deleted"`
}

type Step

type Step struct {
	Digest     bool              `json:"digest"`
	Events     []json.RawMessage `json:"events"`
	TotalCount int               `json:"totalCount"`
}

type Subscriber

type Subscriber struct {
	AccountId string `json:"accountId" bson:"accountId"`
	FullName  string `json:"fullName" bson:"fullName"`
	Email     string `json:"email" bson:"email"`
	Locale    string `json:"locale" bson:"locale"`
}

type Tenant

type Tenant struct {
	Id   string         `json:"id" bson:"id"`
	Name string         `json:"name" bson:"name"`
	Data map[string]any `json:"data" bson:"data"`
}

type Workflow

type Workflow struct {
	Name     string              `json:"name"`
	Revision int64               `json:"revision"`
	Flow     []*WorkflowFlowItem `json:"flow"`
}

type WorkflowFlowItem

type WorkflowFlowItem struct {
	Type FlowType `bson:"type" json:"type"`

	// Type == FlowDigest
	Digest *DigestFlow `bson:"digest,omitempty" json:"digest,omitempty"`

	// Type == FlowNotification or FlowEmail
	SubjectTemplate string `bson:"subjectTemplate,omitempty" json:"subjectTemplate,omitempty"`

	// Type == FlowEmail
	ContentTemplate string `bson:"contentTemplate,omitempty" json:"contentTemplate,omitempty"`
}

type WorkflowTriggerRequest

type WorkflowTriggerRequest struct {
	Tenant     Tenant         `json:"tenant"`
	Subscriber Subscriber     `json:"subscriber"`
	Event      map[string]any `json:"event"`
}

type WorkflowTriggerResponse

type WorkflowTriggerResponse struct {
	EventId string `json:"eventId"`
}