assets

type Channel ¶ added in v0.15.0

type Channel interface {
	UUID() ChannelUUID
	Name() string
	Address() string
	Schemes() []string
	Roles() []ChannelRole
	Parent() *ChannelReference
	Country() envs.Country
	MatchPrefixes() []string
	AllowInternational() bool
}

Channel is something that can send/receive messages.

{
  "uuid": "14782905-81a6-4910-bc9f-93ad287b23c3",
  "name": "My Android",
  "address": "+593979011111",
  "schemes": ["tel"],
  "roles": ["send", "receive"],
  "country": "EC"
}

@asset channel

type ChannelReference ¶ added in v0.15.1

type ChannelReference struct {
	UUID ChannelUUID `json:"uuid" validate:"required,uuid"`
	Name string      `json:"name"`
}

ChannelReference is used to reference a channel

func NewChannelReference(uuid ChannelUUID, name string) *ChannelReference

func (r *ChannelReference) GenericUUID() uuids.UUID

func (r *ChannelReference) Identity() string

func (r *ChannelReference) String() string

func (r *ChannelReference) Type() string

func (r *ChannelReference) Variable() bool

type ChannelRole ¶ added in v0.15.0

type ChannelRole string

ChannelRole is a role that a channel can perform

const (
	ChannelRoleSend    ChannelRole = "send"
	ChannelRoleReceive ChannelRole = "receive"
	ChannelRoleCall    ChannelRole = "call"
	ChannelRoleAnswer  ChannelRole = "answer"
	ChannelRoleUSSD    ChannelRole = "ussd"
)

type ChannelUUID ¶ added in v0.15.0

type ChannelUUID uuids.UUID

ChannelUUID is the UUID of a channel

type Classifier ¶ added in v0.115.3

type Classifier interface {
	UUID() ClassifierUUID
	Name() string
	Type() string
	Intents() []string
}

Classifier is an NLU classifier.

{
  "uuid": "37657cf7-5eab-4286-9cb0-bbf270587bad",
  "name": "Booking",
  "type": "wit",
  "intents": ["book_flight", "book_hotel"]
}

@asset classifier

type ClassifierReference ¶ added in v0.115.3

type ClassifierReference struct {
	UUID ClassifierUUID `json:"uuid" validate:"required,uuid"`
	Name string         `json:"name"`
}

ClassifierReference is used to reference a classifier

func NewClassifierReference(uuid ClassifierUUID, name string) *ClassifierReference

func (r *ClassifierReference) GenericUUID() uuids.UUID

func (r *ClassifierReference) Identity() string

func (r *ClassifierReference) String() string

func (r *ClassifierReference) Type() string

func (r *ClassifierReference) Variable() bool

type ClassifierUUID ¶ added in v0.115.3

type ClassifierUUID uuids.UUID

ClassifierUUID is the UUID of an NLU classifier

type Field ¶ added in v0.15.0

type Field interface {
	UUID() FieldUUID
	Key() string
	Name() string
	Type() FieldType
}

Field is a custom contact property.

{
  "uuid": "d66a7823-eada-40e5-9a3a-57239d4690bf",
  "key": "gender",
  "name": "Gender",
  "type": "text"
}

@asset field

type FieldReference ¶ added in v0.15.1

type FieldReference struct {
	Key  string `json:"key" validate:"required"`
	Name string `json:"name"`
}

FieldReference is a reference to a field

func NewFieldReference(key string, name string) *FieldReference

func (r *FieldReference) Identity() string

func (r *FieldReference) String() string

func (r *FieldReference) Type() string

func (r *FieldReference) Variable() bool

type FieldType ¶ added in v0.15.0

type FieldType string

FieldType is the data type of values for each field

const (
	FieldTypeText     FieldType = "text"
	FieldTypeNumber   FieldType = "number"
	FieldTypeDatetime FieldType = "datetime"
	FieldTypeWard     FieldType = "ward"
	FieldTypeDistrict FieldType = "district"
	FieldTypeState    FieldType = "state"
)

type FieldUUID ¶ added in v0.115.3

type FieldUUID uuids.UUID

FieldUUID is the UUID of a field

type Flow ¶ added in v0.15.0

type Flow interface {
	UUID() FlowUUID
	Name() string
	Definition() json.RawMessage
}

Flow is graph of nodes with actions and routers.

{
  "uuid": "14782905-81a6-4910-bc9f-93ad287b23c3",
  "name": "Registration",
  "definition": {
    "nodes": []
  }
}

@asset flow

type FlowReference ¶ added in v0.15.1

type FlowReference struct {
	UUID FlowUUID `json:"uuid" validate:"required,uuid4"`
	Name string   `json:"name"`
}

FlowReference is used to reference a flow from another flow

func NewFlowReference(uuid FlowUUID, name string) *FlowReference

func (r *FlowReference) GenericUUID() uuids.UUID

func (r *FlowReference) Identity() string

func (r *FlowReference) String() string

func (r *FlowReference) Type() string

func (r *FlowReference) Variable() bool

type FlowUUID ¶ added in v0.15.0

type FlowUUID uuids.UUID

FlowUUID is the UUID of a flow

type Global ¶ added in v0.115.3

type Global interface {
	Key() string
	Name() string
	Value() string
}

Global is a named constant.

{
  "key": "organization_name",
  "name": "Organization Name",
  "value": "U-Report"
}

@asset global

type GlobalReference ¶ added in v0.115.3

type GlobalReference struct {
	Key  string `json:"key" validate:"required"`
	Name string `json:"name"`
}

GlobalReference is a reference to a global

func NewGlobalReference(key string, name string) *GlobalReference

func (r *GlobalReference) Identity() string

func (r *GlobalReference) String() string

func (r *GlobalReference) Type() string

func (r *GlobalReference) Variable() bool

type Group ¶ added in v0.15.0

type Group interface {
	UUID() GroupUUID
	Name() string
	Query() string
}

Group is a set of contacts which can be added to and removed from manually, or based on a query.

{
  "uuid": "14782905-81a6-4910-bc9f-93ad287b23c3",
  "name": "Youth",
  "query": "age <= 18"
}

@asset group

type GroupReference ¶ added in v0.15.1

type GroupReference struct {
	UUID      GroupUUID `json:"uuid,omitempty" validate:"omitempty,uuid4"`
	Name      string    `json:"name,omitempty"`
	NameMatch string    `json:"name_match,omitempty" engine:"evaluated"`
}

GroupReference is used to reference a group

func NewGroupReference(uuid GroupUUID, name string) *GroupReference

func NewVariableGroupReference(nameMatch string) *GroupReference

func (r *GroupReference) GenericUUID() uuids.UUID

func (r *GroupReference) Identity() string

func (r *GroupReference) String() string

func (r *GroupReference) Type() string

func (r *GroupReference) Variable() bool

type GroupUUID ¶ added in v0.15.0

type GroupUUID uuids.UUID

GroupUUID is the UUID of a group

type Label ¶ added in v0.15.0

type Label interface {
	UUID() LabelUUID
	Name() string
}

Label is an organizational tag that can be applied to a message.

{
  "uuid": "14782905-81a6-4910-bc9f-93ad287b23c3",
  "name": "Spam"
}

@asset label

type LabelReference ¶ added in v0.15.1

type LabelReference struct {
	UUID      LabelUUID `json:"uuid,omitempty" validate:"omitempty,uuid4"`
	Name      string    `json:"name,omitempty"`
	NameMatch string    `json:"name_match,omitempty" engine:"evaluated"`
}

LabelReference is used to reference a label

func NewLabelReference(uuid LabelUUID, name string) *LabelReference

func NewVariableLabelReference(nameMatch string) *LabelReference

func (r *LabelReference) GenericUUID() uuids.UUID

func (r *LabelReference) Identity() string

func (r *LabelReference) String() string

func (r *LabelReference) Type() string

func (r *LabelReference) Variable() bool

type LabelUUID ¶ added in v0.15.0

type LabelUUID uuids.UUID

LabelUUID is the UUID of a label

type LocationHierarchy ¶ added in v0.15.0

type LocationHierarchy interface {
	FindByPath(path envs.LocationPath) *envs.Location
	FindByName(name string, level envs.LocationLevel, parent *envs.Location) []*envs.Location
}

LocationHierarchy is a searchable hierarchy of locations.

{
  "name": "Rwanda",
  "aliases": ["Ruanda"],
  "children": [
    {
      "name": "Kigali City",
      "aliases": ["Kigali", "Kigari"],
      "children": [
        {
          "name": "Gasabo",
          "children": [
            {
              "id": "575743222",
              "name": "Gisozi"
            },
            {
              "id": "457378732",
              "name": "Ndera"
            }
          ]
        },
        {
          "name": "Nyarugenge",
          "children": []
        }
      ]
    },
    {
      "name": "Eastern Province"
    }
  ]
}

@asset location

type MissingCallback ¶ added in v0.115.3

type MissingCallback func(Reference, error)

MissingCallback is callback to be invoked when an asset is missing

var IgnoreMissing MissingCallback = func(Reference, error) {}

var PanicOnMissing MissingCallback = func(a Reference, err error) { panic(fmt.Sprintf("missing asset: %s, due to: %s", a, err)) }

type Reference ¶ added in v0.115.3

type Reference interface {
	fmt.Stringer

	Type() string
	Identity() string
	Variable() bool
}

Reference is interface for all reference types

type Resthook ¶ added in v0.15.0

type Resthook interface {
	Slug() string
	Subscribers() []string
}

Resthook is a set of URLs which are subscribed to the named event.

{
  "slug": "new-registration",
  "subscribers": [
    "http://example.com/record.php?@contact.uuid"
  ]
}

@asset resthook

type Source ¶ added in v0.115.3

type Source interface {
	Channels() ([]Channel, error)
	Classifiers() ([]Classifier, error)
	Fields() ([]Field, error)
	FlowByUUID(FlowUUID) (Flow, error)
	FlowByName(string) (Flow, error)
	Globals() ([]Global, error)
	Groups() ([]Group, error)
	Labels() ([]Label, error)
	Locations() ([]LocationHierarchy, error)
	Resthooks() ([]Resthook, error)
	Templates() ([]Template, error)
	Ticketers() ([]Ticketer, error)
	Topics() ([]Topic, error)
	Users() ([]User, error)
}

Source is a source of assets

type Template ¶ added in v0.115.3

type Template interface {
	UUID() TemplateUUID
	Name() string
	Translations() []TemplateTranslation
}

Template is a message template, currently only used by WhatsApp channels

{
  "name": "revive-issue",
  "uuid": "14782905-81a6-4910-bc9f-93ad287b23c3",
  "translations": [
    {
       "language": "eng",
       "content": "Hi {{1}}, are you still experiencing your issue?",
       "channel": {
         "uuid": "cf26be4c-875f-4094-9e08-162c3c9dcb5b",
         "name": "Twilio Channel"
       }
    },
    {
       "language": "fra",
       "content": "Bonjour {{1}}",
       "channel": {
         "uuid": "cf26be4c-875f-4094-9e08-162c3c9dcb5b",
         "name": "Twilio Channel"
       }
    }
  ]
}

@asset template

type TemplateReference ¶ added in v0.115.3

type TemplateReference struct {
	UUID TemplateUUID `json:"uuid" validate:"required,uuid"`
	Name string       `json:"name"`
}

TemplateReference is used to reference a Template

func NewTemplateReference(uuid TemplateUUID, name string) *TemplateReference

func (r *TemplateReference) GenericUUID() uuids.UUID

func (r *TemplateReference) Identity() string

func (r *TemplateReference) String() string

func (r *TemplateReference) Type() string

func (r *TemplateReference) Variable() bool

type TemplateTranslation ¶ added in v0.115.3

type TemplateTranslation interface {
	Content() string
	Language() envs.Language
	Country() envs.Country
	Namespace() string
	VariableCount() int
	Channel() ChannelReference
}

TemplateTranslation represents a single translation for a specific template and channel

type TemplateUUID ¶ added in v0.115.3

type TemplateUUID uuids.UUID

TemplateUUID is the UUID of a template

type Ticketer ¶ added in v0.115.3

type Ticketer interface {
	UUID() TicketerUUID
	Name() string
	Type() string
}

Ticketer is a system which can open or close tickets

{
  "uuid": "37657cf7-5eab-4286-9cb0-bbf270587bad",
  "name": "Support Tickets",
  "type": "mailgun"
}

@asset ticketer

type TicketerReference ¶ added in v0.115.3

type TicketerReference struct {
	UUID TicketerUUID `json:"uuid" validate:"required,uuid"`
	Name string       `json:"name"`
}

TicketerReference is used to reference a ticketer

func NewTicketerReference(uuid TicketerUUID, name string) *TicketerReference

func (r *TicketerReference) GenericUUID() uuids.UUID

func (r *TicketerReference) Identity() string

func (r *TicketerReference) String() string

func (r *TicketerReference) Type() string

func (r *TicketerReference) Variable() bool

type TicketerUUID ¶ added in v0.115.3

type TicketerUUID uuids.UUID

TicketerUUID is the UUID of a ticketer

type Topic ¶ added in v0.115.3

type Topic interface {
	UUID() TopicUUID
	Name() string
}

Topic categorizes tickets

{
  "uuid": "cd48bd11-08b9-44e3-9778-8e26adf08a7a",
  "name": "Weather"
}

@asset topic

type TopicReference ¶ added in v0.115.3

type TopicReference struct {
	UUID TopicUUID `json:"uuid" validate:"required,uuid"`
	Name string    `json:"name"`
}

TopicReference is used to reference a topic

func NewTopicReference(uuid TopicUUID, name string) *TopicReference

func (r *TopicReference) GenericUUID() uuids.UUID

func (r *TopicReference) Identity() string

func (r *TopicReference) String() string

func (r *TopicReference) Type() string

func (r *TopicReference) Variable() bool

type TopicUUID ¶ added in v0.115.3

type TopicUUID uuids.UUID

TopicUUID is the UUID of a topic

type TypedReference ¶ added in v0.115.3

type TypedReference struct {
	Reference Reference `json:"-"`
	Type      string    `json:"type"`
}

TypedReference is a utility struct for when we need to serialize a reference with a type

func NewTypedReference(r Reference) TypedReference

func (r TypedReference) MarshalJSON() ([]byte, error)

type UUIDReference ¶ added in v0.115.3

type UUIDReference interface {
	Reference
	GenericUUID() uuids.UUID
}

UUIDReference is interface for all reference types that contain a UUID

type User ¶ added in v0.115.3

type User interface {
	Email() string
	Name() string
}

User is an person who can trigger flows or be assigned tickets etc.

{
  "email": "bob@nyaruka.com",
  "name": "Bob"
}

@asset user

type UserReference ¶ added in v0.115.3

type UserReference struct {
	Email      string `json:"email,omitempty" validate:"omitempty,email"`
	Name       string `json:"name,omitempty"`
	EmailMatch string `json:"email_match,omitempty" engine:"evaluated"`
}

UserReference is used to reference a user

func NewUserReference(email, name string) *UserReference

func NewVariableUserReference(emailMatch string) *UserReference

func (r *UserReference) Identity() string

func (r *UserReference) String() string

func (r *UserReference) Type() string

func (r *UserReference) UnmarshalJSON(data []byte) error

func (r *UserReference) Variable() bool