notify

Documentation

Index

• type CertificateProviderActingDigitallyHasConfirmedPersonalDetailsLPADetailsChangedPromptSMS
• type CertificateProviderActingDigitallyHasNotConfirmedPersonalDetailsLPADetailsChangedPromptSMS
• type CertificateProviderActingOnPaperDetailsChangedSMS
• type CertificateProviderActingOnPaperMeetingPromptSMS
• type CertificateProviderCertificateProvidedEmail
• type CertificateProviderInviteEmail
  • func (e CertificateProviderInviteEmail) WithShareCode(shareCode string) Email
• type CertificateProviderProvideCertificatePromptEmail
  • func (e CertificateProviderProvideCertificatePromptEmail) WithShareCode(shareCode string) Email
• type Client
  • func New(isProduction bool, baseURL, apiKey string, httpClient Doer) (*Client, error)
  • func (c *Client) SendEmail(ctx context.Context, to string, email Email) (string, error)
  • func (c *Client) SendSMS(ctx context.Context, to string, sms SMS) (string, error)
• type Doer
• type Email
• type InitialOriginalAttorneyEmail
  • func (e InitialOriginalAttorneyEmail) WithShareCode(shareCode string) Email
• type InitialReplacementAttorneyEmail
  • func (e InitialReplacementAttorneyEmail) WithShareCode(shareCode string) Email
• type MemberInviteEmail
• type SMS
• type Sms
• type WitnessCodeSMS

Types

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 CertificateProviderInviteEmail

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

func (CertificateProviderInviteEmail) WithShareCode

func (e CertificateProviderInviteEmail) WithShareCode(shareCode string) Email

type CertificateProviderProvideCertificatePromptEmail

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

func (CertificateProviderProvideCertificatePromptEmail) WithShareCode

func (e CertificateProviderProvideCertificatePromptEmail) WithShareCode(shareCode string) Email

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) SendEmail

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

func (*Client) SendSMS

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

type Doer

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

type Email

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

type InitialOriginalAttorneyEmail

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

func (InitialOriginalAttorneyEmail) WithShareCode

func (e InitialOriginalAttorneyEmail) WithShareCode(shareCode string) Email

type InitialReplacementAttorneyEmail

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

func (InitialReplacementAttorneyEmail) WithShareCode

func (e InitialReplacementAttorneyEmail) WithShareCode(shareCode string) Email

type MemberInviteEmail

type MemberInviteEmail struct {
	OrganisationName string
	InviteCode       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 WitnessCodeSMS

type WitnessCodeSMS struct {
	WitnessCode   string
	DonorFullName string
	LpaType       string
}