notify

Documentation

Index

• type Client
  • func New(isProduction bool, baseURL, apiKey string, httpClient Doer) (*Client, error)
  • func (c *Client) Email(ctx context.Context, email Email) (string, error)
  • func (c *Client) Sms(ctx context.Context, sms Sms) (string, error)
  • func (c *Client) TemplateID(id Template) string
• type Doer
• type Email
• type Sms
• type Template

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

func New

func New(isProduction bool, baseURL, apiKey string, httpClient Doer) (*Client, error)

func (*Client) Email

func (c *Client) Email(ctx context.Context, email Email) (string, error)

func (*Client) Sms

func (c *Client) Sms(ctx context.Context, sms Sms) (string, error)

func (*Client) TemplateID

func (c *Client) TemplateID(id Template) string

type Doer

type Doer interface {
	Do(*http.Request) (*http.Response, error)
}

type Email

type Email struct {
	EmailAddress    string            `json:"email_address"`
	TemplateID      string            `json:"template_id"`
	Personalisation map[string]string `json:"personalisation,omitempty"`
	Reference       string            `json:"reference,omitempty"`
	EmailReplyToID  string            `json:"email_reply_to_id,omitempty"`
}

type Sms

type Sms struct {
	PhoneNumber     string            `json:"phone_number"`
	TemplateID      string            `json:"template_id"`
	Personalisation map[string]string `json:"personalisation,omitempty"`
	Reference       string            `json:"reference,omitempty"`
}

type Template

type Template uint8

const (
	AttorneyInviteEmail Template = iota
	AttorneyNameChangeEmail
	CertificateProviderDigitalLpaDetailsChangedNotSeenLpaSMS
	CertificateProviderDigitalLpaDetailsChangedSeenLpaSMS
	CertificateProviderInviteEmail
	CertificateProviderNameChangeEmail
	CertificateProviderPaperLpaDetailsChangedSMS
	CertificateProviderPaperMeetingPromptSMS
	CertificateProviderReturnEmail
	ReplacementAttorneyInviteEmail
	ReplacementTrustCorporationInviteEmail
	SignatureCodeEmail
	SignatureCodeSMS
	TrustCorporationInviteEmail
)