notify

Documentation

Overview

Package notify provides a client for GOV.UK's Notify service.

Index

• type AttorneyOptedOutEmail
• type CertificateProviderActingDigitallyHasConfirmedPersonalDetailsLPADetailsChangedPromptSMS
• type CertificateProviderActingDigitallyHasNotConfirmedPersonalDetailsLPADetailsChangedPromptSMS
• type CertificateProviderActingOnPaperDetailsChangedSMS
• type CertificateProviderActingOnPaperMeetingPromptSMS
• type CertificateProviderCertificateProvidedEmail
• type CertificateProviderFailedIDCheckEmail
• type CertificateProviderInviteEmail
• type CertificateProviderOptedOutPostWitnessingEmail
• type CertificateProviderOptedOutPreWitnessingEmail
• type CertificateProviderProvideCertificatePromptEmail
• type Client
  • func New(logger Logger, isProduction bool, baseURL, apiKey string, httpClient Doer, ...) (*Client, error)
  • func (c *Client) EmailGreeting(lpa *lpadata.Lpa) string
  • func (c *Client) SendActorEmail(ctx context.Context, to, lpaUID string, email Email) error
  • func (c *Client) SendActorSMS(ctx context.Context, to, lpaUID string, sms SMS) error
  • func (c *Client) SendEmail(ctx context.Context, to string, email Email) error
• type Doer
• type DonorAccessEmail
• type DonorIdentityCheckExpiredEmail
• type Email
• type EventClient
• type InitialOriginalAttorneyEmail
• type InitialReplacementAttorneyEmail
• type Logger
• type OrganisationMemberInviteEmail
• type PaymentConfirmationEmail
• type SMS
• type Sms
• type VoucherFailedIdentityCheckEmail
• type VoucherInviteEmail
• type VouchingFailedAttempt
• type VouchingShareCodeEmail
• type VouchingShareCodeSMS
• type WitnessCodeSMS

Types

type AttorneyOptedOutEmail

type AttorneyOptedOutEmail struct {
	Greeting          string
	AttorneyFullName  string
	DonorFullName     string
	LpaType           string
	LpaUID            string
	DonorStartPageURL string
}

type CertificateProviderActingDigitallyHasConfirmedPersonalDetailsLPADetailsChangedPromptSMS

type CertificateProviderActingDigitallyHasConfirmedPersonalDetailsLPADetailsChangedPromptSMS struct {
	DonorFullNamePossessive string
	LpaType                 string
	LpaUID                  string
	DonorFirstNames         string
}

type CertificateProviderActingDigitallyHasNotConfirmedPersonalDetailsLPADetailsChangedPromptSMS

type CertificateProviderActingDigitallyHasNotConfirmedPersonalDetailsLPADetailsChangedPromptSMS struct {
	DonorFullName string
	LpaType       string
}

type CertificateProviderActingOnPaperDetailsChangedSMS

type CertificateProviderActingOnPaperDetailsChangedSMS struct {
	DonorFullName   string
	LpaUID          string
	DonorFirstNames string
}

type CertificateProviderActingOnPaperMeetingPromptSMS

type CertificateProviderActingOnPaperMeetingPromptSMS struct {
	DonorFullName                   string
	LpaType                         string
	DonorFirstNames                 string
	CertificateProviderStartPageURL string
}

type CertificateProviderCertificateProvidedEmail

type CertificateProviderCertificateProvidedEmail struct {
	DonorFullNamePossessive     string
	LpaType                     string
	CertificateProviderFullName string
	CertificateProvidedDateTime string
	DonorFirstNamesPossessive   string
}

type CertificateProviderFailedIDCheckEmail

type CertificateProviderFailedIDCheckEmail struct {
	Greeting                    string
	DonorFullName               string
	CertificateProviderFullName string
	LpaType                     string
	DonorStartPageURL           string
}

type CertificateProviderInviteEmail

type CertificateProviderInviteEmail struct {
	DonorFullName                string
	LpaType                      string
	CertificateProviderFullName  string
	DonorFirstNames              string
	DonorFirstNamesPossessive    string
	WhatLpaCovers                string
	CertificateProviderStartURL  string
	ShareCode                    string
	CertificateProviderOptOutURL string
}

type CertificateProviderOptedOutPostWitnessingEmail

type CertificateProviderOptedOutPostWitnessingEmail struct {
	Greeting                      string
	CertificateProviderFirstNames string
	CertificateProviderFullName   string
	DonorFullName                 string
	LpaType                       string
	LpaUID                        string
	DonorStartPageURL             string
}

type CertificateProviderOptedOutPreWitnessingEmail

type CertificateProviderOptedOutPreWitnessingEmail struct {
	Greeting                    string
	CertificateProviderFullName string
	DonorFullName               string
	LpaType                     string
	LpaUID                      string
	DonorStartPageURL           string
}

type CertificateProviderProvideCertificatePromptEmail

type CertificateProviderProvideCertificatePromptEmail struct {
	DonorFullName               string
	DonorFullNamePossessive     string
	LpaType                     string
	CertificateProviderFullName string
	CertificateProviderStartURL string
	ShareCode                   string
}

type Client

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

func New

func New(logger Logger, isProduction bool, baseURL, apiKey string, httpClient Doer, eventClient EventClient, bundle *localize.Bundle) (*Client, error)

func (*Client) EmailGreeting

func (c *Client) EmailGreeting(lpa *lpadata.Lpa) string

func (*Client) SendActorEmail

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

func (*Client) SendActorSMS

func (c *Client) SendActorSMS(ctx context.Context, to, lpaUID string, sms SMS) error

func (*Client) SendEmail

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

type Doer

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

type DonorAccessEmail

type DonorAccessEmail struct {
	SupporterFullName string
	OrganisationName  string
	LpaType           string
	DonorName         string
	URL               string
	ShareCode         string
}

type DonorIdentityCheckExpiredEmail

type DonorIdentityCheckExpiredEmail struct{}

type Email

type Email interface {
	// contains filtered or unexported methods
}

type EventClient

type EventClient interface {
	SendNotificationSent(ctx context.Context, event event.NotificationSent) error
}

type InitialOriginalAttorneyEmail

type InitialOriginalAttorneyEmail struct {
	DonorFullName             string
	LpaType                   string
	AttorneyFullName          string
	DonorFirstNames           string
	AttorneyStartPageURL      string
	ShareCode                 string
	DonorFirstNamesPossessive string
	AttorneyOptOutURL         string
}

type InitialReplacementAttorneyEmail

type InitialReplacementAttorneyEmail struct {
	DonorFullName             string
	LpaType                   string
	AttorneyFullName          string
	DonorFirstNames           string
	AttorneyStartPageURL      string
	ShareCode                 string
	DonorFirstNamesPossessive string
	AttorneyOptOutURL         string
}

type Logger

type Logger interface {
	ErrorContext(ctx context.Context, msg string, args ...any)
}

type OrganisationMemberInviteEmail

type OrganisationMemberInviteEmail struct {
	OrganisationName      string
	InviterFullName       string
	InviterEmail          string
	InviteCode            string
	JoinAnOrganisationURL string
}

type PaymentConfirmationEmail

type PaymentConfirmationEmail struct {
	DonorFullNamesPossessive string
	LpaType                  string
	PaymentCardFullName      string
	LpaReferenceNumber       string
	PaymentReferenceID       string
	PaymentConfirmationDate  string
	AmountPaidWithCurrency   string
}

type SMS

type SMS interface {
	// contains filtered or unexported methods
}

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 VoucherFailedIdentityCheckEmail

type VoucherFailedIdentityCheckEmail struct {
	Greeting          string
	DonorFullName     string
	VoucherFullName   string
	LpaType           string
	DonorStartPageURL string
}

type VoucherInviteEmail

type VoucherInviteEmail struct {
	VoucherFullName           string
	DonorFullName             string
	DonorFirstNamesPossessive string
	DonorFirstNames           string
	LpaType                   string
	VoucherStartPageURL       string
}

type VouchingFailedAttempt

type VouchingFailedAttempt struct {
	Greeting          string
	VoucherFullName   string
	DonorStartPageURL string
}

type VouchingShareCodeEmail

type VouchingShareCodeEmail struct {
	ShareCode       string
	VoucherFullName string
	DonorFullName   string
	LpaType         string
}

type VouchingShareCodeSMS

type VouchingShareCodeSMS struct {
	ShareCode                 string
	DonorFullNamePossessive   string
	LpaType                   string
	VoucherFullName           string
	DonorFirstNamesPossessive string
}

type WitnessCodeSMS

type WitnessCodeSMS struct {
	WitnessCode   string
	DonorFullName string
	LpaType       string
}