types

Documentation

Index

• func NewChannel(uuid assets.ChannelUUID, name string, address string, schemes []string, ...) assets.Channel
• func NewField(key string, name string, valueType assets.FieldType) assets.Field
• func NewGroup(uuid assets.GroupUUID, name string, query string) assets.Group
• func NewLabel(uuid assets.LabelUUID, name string) assets.Label
• func NewResthook(slug string, subscribers []string) assets.Resthook
• func NewTelChannel(uuid assets.ChannelUUID, name string, address string, ...) assets.Channel
• type Channel
  • func (c *Channel) Address() string
  • func (c *Channel) Country() string
  • func (c *Channel) MatchPrefixes() []string
  • func (c *Channel) Name() string
  • func (c *Channel) Parent() *assets.ChannelReference
  • func (c *Channel) Roles() []assets.ChannelRole
  • func (c *Channel) Schemes() []string
  • func (c *Channel) UUID() assets.ChannelUUID
• type Field
  • func (f *Field) Key() string
  • func (f *Field) Name() string
  • func (f *Field) Type() assets.FieldType
• type Flow
  • func (f *Flow) Definition() json.RawMessage
  • func (f *Flow) Name() string
  • func (f *Flow) UUID() assets.FlowUUID
  • func (f *Flow) UnmarshalJSON(data []byte) error
• type Group
  • func (g *Group) Name() string
  • func (g *Group) Query() string
  • func (g *Group) UUID() assets.GroupUUID
• type Label
  • func (l *Label) Name() string
  • func (l *Label) UUID() assets.LabelUUID
• type Resthook
  • func (r *Resthook) Slug() string
  • func (r *Resthook) Subscribers() []string

Functions

func NewChannel

func NewChannel(uuid assets.ChannelUUID, name string, address string, schemes []string, roles []assets.ChannelRole, parent *assets.ChannelReference) assets.Channel

NewChannel creates a new channel

func NewField

func NewField(key string, name string, valueType assets.FieldType) assets.Field

NewField creates a new field from the passed in key, name and type

func NewGroup

func NewGroup(uuid assets.GroupUUID, name string, query string) assets.Group

NewGroup creates a new group from the passed in UUID, name and query

func NewLabel

func NewLabel(uuid assets.LabelUUID, name string) assets.Label

NewLabel creates a new label from the passed in UUID and name

func NewResthook

func NewResthook(slug string, subscribers []string) assets.Resthook

NewResthook creates a new resthook

func NewTelChannel

func NewTelChannel(uuid assets.ChannelUUID, name string, address string, roles []assets.ChannelRole, parent *assets.ChannelReference, country string, matchPrefixes []string) assets.Channel

NewTelChannel creates a new tel channel

Types

type Channel

type Channel struct {
	UUID_          assets.ChannelUUID       `json:"uuid" validate:"required,uuid"`
	Name_          string                   `json:"name"`
	Address_       string                   `json:"address"`
	Schemes_       []string                 `json:"schemes" validate:"min=1"`
	Roles_         []assets.ChannelRole     `json:"roles" validate:"min=1,dive,eq=send|eq=receive|eq=call|eq=answer|eq=ussd"`
	Parent_        *assets.ChannelReference `json:"parent" validate:"omitempty,dive"`
	Country_       string                   `json:"country,omitempty"`
	MatchPrefixes_ []string                 `json:"match_prefixes,omitempty"`
}

Channel is a JSON serializable implementation of a channel asset

func (*Channel) Address

func (c *Channel) Address() string

Address returns the address of this channel

func (*Channel) Country

func (c *Channel) Country() string

Country returns this channel's associated country code (if any)

func (*Channel) MatchPrefixes

func (c *Channel) MatchPrefixes() []string

MatchPrefixes returns this channel's match prefixes values used for selecting a channel for a URN (if any)

func (*Channel) Name

func (c *Channel) Name() string

Name returns the name of this channel

func (*Channel) Parent

func (c *Channel) Parent() *assets.ChannelReference

Parent returns a reference to this channel's parent (if any)

func (*Channel) Roles

func (c *Channel) Roles() []assets.ChannelRole

Roles returns the roles of this channel

func (*Channel) Schemes

func (c *Channel) Schemes() []string

Schemes returns the supported schemes of this channel

func (*Channel) UUID

func (c *Channel) UUID() assets.ChannelUUID

UUID returns the UUID of this channel

type Field

type Field struct {
	Key_  string           `json:"key" validate:"required"`
	Name_ string           `json:"name"`
	Type_ assets.FieldType `json:"value_type" validate:"required"`
}

Field is a JSON serializable implementation of a field asset

func (*Field) Key

func (f *Field) Key() string

Key returns the unique key of the field

func (*Field) Name

func (f *Field) Name() string

Name returns the name of the field

func (*Field) Type

func (f *Field) Type() assets.FieldType

Type returns the value type of the field

type Flow

type Flow struct {
	UUID_       assets.FlowUUID `json:"uuid" validate:"required,uuid4"`
	Name_       string          `json:"name"`
	Definition_ json.RawMessage
}

Flow is a JSON serializable implementation of a flow asset

func (*Flow) Definition

func (f *Flow) Definition() json.RawMessage

func (*Flow) Name

func (f *Flow) Name() string

Name returns the name of the flow

func (*Flow) UUID

func (f *Flow) UUID() assets.FlowUUID

UUID returns the UUID of the flow

func (*Flow) UnmarshalJSON

func (f *Flow) UnmarshalJSON(data []byte) error

type Group

type Group struct {
	UUID_  assets.GroupUUID `json:"uuid" validate:"required,uuid4"`
	Name_  string           `json:"name"`
	Query_ string           `json:"query,omitempty"`
}

Group is a JSON serializable implementation of a group asset

func (*Group) Name

func (g *Group) Name() string

Name returns the name of the group

func (*Group) Query

func (g *Group) Query() string

Query returns the query of a dynamic group

func (*Group) UUID

func (g *Group) UUID() assets.GroupUUID

UUID returns the UUID of the group

type Label

type Label struct {
	UUID_ assets.LabelUUID `json:"uuid" validate:"required,uuid4"`
	Name_ string           `json:"name"`
}

Label is a JSON serializable implementation of a label asset

func (*Label) Name

func (l *Label) Name() string

Name returns the name of the label

func (*Label) UUID

func (l *Label) UUID() assets.LabelUUID

UUID returns the UUID of the label

type Resthook

type Resthook struct {
	Slug_        string   `json:"slug" validate:"required"`
	Subscribers_ []string `json:"subscribers" validate:"required,dive,url"`
}

Resthook is a JSON serializable implementation of a resthook asset

func (*Resthook) Slug

func (r *Resthook) Slug() string

Slug returns the slug of the resthook

func (*Resthook) Subscribers

func (r *Resthook) Subscribers() []string

Subscribers returns the subscribers to the resthook