actor

package
v0.0.0-...-897bb11 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 24, 2023 License: MIT Imports: 9 Imported by: 0

Documentation

Overview

Code generated by "enumerator -type AttorneysAct -linecomment -empty"; DO NOT EDIT.

Code generated by "enumerator -type CertificateProviderCarryOutBy -linecomment -empty"; DO NOT EDIT.

Code generated by "enumerator -type CertificateProviderRelationship -linecomment -empty"; DO NOT EDIT.

Code generated by "enumerator -type PaymentTask -trimprefix"; DO NOT EDIT.

Index

Constants

This section is empty.

Variables

View Source
var ActorTypes = Types{
	None:                TypeNone,
	Donor:               TypeDonor,
	Attorney:            TypeAttorney,
	ReplacementAttorney: TypeReplacementAttorney,
	CertificateProvider: TypeCertificateProvider,
	PersonToNotify:      TypePersonToNotify,
}
View Source
var AttorneysActValues = AttorneysActOptions{
	Jointly:                          Jointly,
	JointlyAndSeverally:              JointlyAndSeverally,
	JointlyForSomeSeverallyForOthers: JointlyForSomeSeverallyForOthers,
}
View Source
var CertificateProviderCarryOutByValues = CertificateProviderCarryOutByOptions{
	Paper:  Paper,
	Online: Online,
}
View Source
var CertificateProviderRelationshipValues = CertificateProviderRelationshipOptions{
	Personally:     Personally,
	Professionally: Professionally,
}
View Source
var PaymentTaskValues = PaymentTaskOptions{
	NotStarted: PaymentTaskNotStarted,
	InProgress: PaymentTaskInProgress,
	Completed:  PaymentTaskCompleted,
	Pending:    PaymentTaskPending,
	Denied:     PaymentTaskDenied,
}

Functions

This section is empty.

Types

type Attorney

type Attorney struct {
	// Identifies the attorney being edited
	ID string
	// First names of the attorney
	FirstNames string
	// Last name of the attorney
	LastName string
	// Email of the attorney
	Email string
	// Date of birth of the attorney
	DateOfBirth date.Date
	// Address of the attorney
	Address place.Address
}

Attorney contains details about an attorney or replacement attorney, provided by the applicant

func (Attorney) FullName

func (a Attorney) FullName() string

type AttorneyDecisions

type AttorneyDecisions struct {
	// How attorneys should make decisions
	How AttorneysAct
	// Details on how attorneys should make decisions if acting jointly for some decisions, and jointly and severally for other decisions
	Details string
}

AttorneyDecisions contains details about how an attorney or replacement attorney should act, provided by the applicant

func MakeAttorneyDecisions

func MakeAttorneyDecisions(existing AttorneyDecisions, how AttorneysAct, details string) AttorneyDecisions

func (AttorneyDecisions) IsComplete

func (d AttorneyDecisions) IsComplete() bool

type AttorneyProvidedDetails

type AttorneyProvidedDetails struct {
	PK, SK string
	// The identifier of the attorney or replacement attorney being edited
	ID string
	// The identifier of the LPA the attorney or replacement attorney is named in
	LpaID string
	// Tracking when AttorneyProvidedDetails is updated
	UpdatedAt time.Time
	// Determines if the details relate to an attorney or replacement attorney
	IsReplacement bool
	// Mobile number of the attorney or replacement attorney
	Mobile string
	// Confirming the attorney or replacement attorney agrees to responsibilities and confirms the tick box is a legal signature
	Confirmed time.Time
	// WouldLikeSecondSignatory captures whether two signatories will be used for a trust corporation
	WouldLikeSecondSignatory form.YesNo
	// AuthorisedSignatories captures the details of the person who signed on behalf of a trust corporation, if one is acting as an attorney
	AuthorisedSignatories [2]AuthorisedSignatory
	// Used to show attorney task list
	Tasks AttorneyTasks
}

AttorneyProvidedDetails contains details about an attorney or replacement attorney, provided by the attorney or replacement attorney

type AttorneyTasks

type AttorneyTasks struct {
	ConfirmYourDetails TaskState
	ReadTheLpa         TaskState
	SignTheLpa         TaskState
	SignTheLpaSecond   TaskState
}

type Attorneys

type Attorneys struct {
	TrustCorporation TrustCorporation
	Attorneys        []Attorney
}

func (Attorneys) Addresses

func (as Attorneys) Addresses() []place.Address

func (Attorneys) Complete

func (as Attorneys) Complete() bool

func (*Attorneys) Delete

func (as *Attorneys) Delete(attorney Attorney) bool

func (Attorneys) FirstNames

func (as Attorneys) FirstNames() []string

func (Attorneys) FullNames

func (as Attorneys) FullNames() []string

func (Attorneys) Get

func (as Attorneys) Get(id string) (Attorney, bool)

func (Attorneys) Len

func (as Attorneys) Len() int

func (*Attorneys) Put

func (as *Attorneys) Put(attorney Attorney)

type AttorneysAct

type AttorneysAct uint8
const (
	// Jointly indicates attorneys or replacement attorneys should act jointly
	Jointly AttorneysAct = iota + 1 // jointly

	// JointlyAndSeverally indicates attorneys or replacement attorneys should act
	// jointly and severally
	JointlyAndSeverally // jointly-and-severally

	// JointlyForSomeSeverallyForOthers indicates attorneys or replacement
	// attorneys should act jointly for some decisions, and jointly and severally
	// for other decisions
	JointlyForSomeSeverallyForOthers // mixed
)

func ParseAttorneysAct

func ParseAttorneysAct(s string) (AttorneysAct, error)

func (AttorneysAct) Empty

func (i AttorneysAct) Empty() bool

func (AttorneysAct) IsJointly

func (i AttorneysAct) IsJointly() bool

func (AttorneysAct) IsJointlyAndSeverally

func (i AttorneysAct) IsJointlyAndSeverally() bool

func (AttorneysAct) IsJointlyForSomeSeverallyForOthers

func (i AttorneysAct) IsJointlyForSomeSeverallyForOthers() bool

func (AttorneysAct) String

func (i AttorneysAct) String() string

type AttorneysActOptions

type AttorneysActOptions struct {
	Jointly                          AttorneysAct
	JointlyAndSeverally              AttorneysAct
	JointlyForSomeSeverallyForOthers AttorneysAct
}

type AuthorisedSignatory

type AuthorisedSignatory struct {
	FirstNames        string
	LastName          string
	ProfessionalTitle string
	Confirmed         time.Time
}

type Certificate

type Certificate struct {
	// Confirmation the certificate provider agrees to the 'provide a certificate' statement and that ticking box is a legal signature
	AgreeToStatement bool
	// Date and time the certificate provider provided the certificate
	Agreed time.Time
}

type CertificateProvider

type CertificateProvider struct {
	// First names of the certificate provider
	FirstNames string
	// Last name of the certificate provider
	LastName string
	// Address of the certificate provider
	Address place.Address
	// Mobile number of the certificate provider, used to send witness codes
	Mobile string
	// HasNonUKMobile indicates whether the value of Mobile is a non-UK mobile number
	HasNonUKMobile bool
	// Email of the certificate provider
	Email string
	// How the certificate provider wants to perform their role (paper or online)
	CarryOutBy CertificateProviderCarryOutBy
	// The certificate provider's relationship to the applicant
	Relationship CertificateProviderRelationship
	// Amount of time Relationship has been in place if Personally
	RelationshipLength string
}

CertificateProvider contains details about the certificate provider, provided by the applicant

func (CertificateProvider) FullName

func (c CertificateProvider) FullName() string

type CertificateProviderCarryOutBy

type CertificateProviderCarryOutBy uint8
const (
	Paper  CertificateProviderCarryOutBy = iota + 1 // paper
	Online                                          // online
)

func ParseCertificateProviderCarryOutBy

func ParseCertificateProviderCarryOutBy(s string) (CertificateProviderCarryOutBy, error)

func (CertificateProviderCarryOutBy) Empty

func (CertificateProviderCarryOutBy) IsOnline

func (i CertificateProviderCarryOutBy) IsOnline() bool

func (CertificateProviderCarryOutBy) IsPaper

func (i CertificateProviderCarryOutBy) IsPaper() bool

func (CertificateProviderCarryOutBy) String

type CertificateProviderCarryOutByOptions

type CertificateProviderCarryOutByOptions struct {
	Paper  CertificateProviderCarryOutBy
	Online CertificateProviderCarryOutBy
}

type CertificateProviderProvidedDetails

type CertificateProviderProvidedDetails struct {
	PK, SK string
	// The identifier of the LPA the certificate provider is providing a certificate for
	LpaID string
	// Tracking when CertificateProviderProvidedDetails is updated
	UpdatedAt time.Time
	// First names of the certificate provider
	FirstNames string
	// Last name of the certificate provider
	LastName string
	// Email of the certificate provider
	Email string
	// Address of the certificate provider
	Address place.Address
	// Mobile number of the certificate provider
	Mobile string
	// Date of birth of the certificate provider
	DateOfBirth date.Date
	// The full name provided by the certificate provider. Only requested if the certificate provider indicates their name as provided by the applicant is incorrect
	DeclaredFullName string
	// The method by which the certificate provider will complete identity checks
	IdentityOption identity.Option
	// Data returned from an identity check service
	IdentityUserData identity.UserData
	// Details of the certificate provided to the applicant
	Certificate Certificate
	// Tasks the certificate provider will complete
	Tasks CertificateProviderTasks
}

CertificateProviderProvidedDetails contains details about the certificate provider, provided by the certificate provider

func (*CertificateProviderProvidedDetails) CertificateProviderIdentityConfirmed

func (c *CertificateProviderProvidedDetails) CertificateProviderIdentityConfirmed() bool

func (CertificateProviderProvidedDetails) FullName

type CertificateProviderRelationship

type CertificateProviderRelationship uint8
const (
	Personally     CertificateProviderRelationship = iota + 1 // personally
	Professionally                                            // professionally
)

func ParseCertificateProviderRelationship

func ParseCertificateProviderRelationship(s string) (CertificateProviderRelationship, error)

func (CertificateProviderRelationship) Empty

func (CertificateProviderRelationship) IsPersonally

func (i CertificateProviderRelationship) IsPersonally() bool

func (CertificateProviderRelationship) IsProfessionally

func (i CertificateProviderRelationship) IsProfessionally() bool

func (CertificateProviderRelationship) String

type CertificateProviderRelationshipOptions

type CertificateProviderRelationshipOptions struct {
	Personally     CertificateProviderRelationship
	Professionally CertificateProviderRelationship
}

type CertificateProviderTasks

type CertificateProviderTasks struct {
	ConfirmYourDetails    TaskState
	ConfirmYourIdentity   TaskState
	ReadTheLpa            TaskState
	ProvideTheCertificate TaskState
}

type Donor

type Donor struct {
	// First names of the donor
	FirstNames string
	// Last name of the donor
	LastName string
	// Email of the donor
	Email string
	// Other names the donor is known by
	OtherNames string
	// Date of birth of the donor
	DateOfBirth date.Date
	// Address of the donor
	Address place.Address
}

Donor contains details about the donor, provided by the applicant

func (Donor) FullName

func (d Donor) FullName() string

type PaymentTask

type PaymentTask uint8
const (
	PaymentTaskNotStarted PaymentTask = iota
	PaymentTaskInProgress
	PaymentTaskCompleted
	PaymentTaskPending
	PaymentTaskDenied
)

func ParsePaymentTask

func ParsePaymentTask(s string) (PaymentTask, error)

func (PaymentTask) IsCompleted

func (i PaymentTask) IsCompleted() bool

func (PaymentTask) IsDenied

func (i PaymentTask) IsDenied() bool

func (PaymentTask) IsInProgress

func (i PaymentTask) IsInProgress() bool

func (PaymentTask) IsNotStarted

func (i PaymentTask) IsNotStarted() bool

func (PaymentTask) IsPending

func (i PaymentTask) IsPending() bool

func (PaymentTask) String

func (i PaymentTask) String() string

type PaymentTaskOptions

type PaymentTaskOptions struct {
	NotStarted PaymentTask
	InProgress PaymentTask
	Completed  PaymentTask
	Pending    PaymentTask
	Denied     PaymentTask
}

type PeopleToNotify

type PeopleToNotify []PersonToNotify

func (*PeopleToNotify) Delete

func (ps *PeopleToNotify) Delete(personToNotify PersonToNotify) bool

func (PeopleToNotify) Get

func (ps PeopleToNotify) Get(id string) (PersonToNotify, bool)

func (PeopleToNotify) Put

func (ps PeopleToNotify) Put(person PersonToNotify) bool

type PersonToNotify

type PersonToNotify struct {
	// First names of the person to notify
	FirstNames string
	// Last name of the person to notify
	LastName string
	// Email of the person to notify
	Email string
	// Address of the person to notify
	Address place.Address
	// Identifies the person to notify being edited
	ID string
}

PersonToNotify contains details about a person to notify, provided by the applicant

func (PersonToNotify) FullName

func (p PersonToNotify) FullName() string

type SameNameWarning

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

func NewSameNameWarning

func NewSameNameWarning(actor, matches Type, firstNames, lastName string) *SameNameWarning

func (*SameNameWarning) Format

func (*SameNameWarning) String

func (w *SameNameWarning) String() string

type ShareCodeData

type ShareCodeData struct {
	PK, SK                string
	SessionID             string
	LpaID                 string
	Identity              bool
	AttorneyID            string
	IsReplacementAttorney bool
	IsTrustCorporation    bool
	DonorFullname         string
	DonorFirstNames       string
}

type TaskState

type TaskState uint8
const (
	TaskNotStarted TaskState = iota
	TaskInProgress
	TaskCompleted
)

func (TaskState) Completed

func (t TaskState) Completed() bool

func (TaskState) InProgress

func (t TaskState) InProgress() bool

func (TaskState) NotStarted

func (t TaskState) NotStarted() bool

func (TaskState) String

func (t TaskState) String() string

type TrustCorporation

type TrustCorporation struct {
	// Name of the company
	Name string
	// CompanyNumber as registered by Companies House
	CompanyNumber string
	// Email to contact the company
	Email string
	// Address of the company
	Address place.Address
}

TrustCorporation contains details about a trust corporation, provided by the applicant

type Type

type Type int
const (
	TypeNone Type = iota
	TypeDonor
	TypeAttorney
	TypeReplacementAttorney
	TypeCertificateProvider
	TypePersonToNotify
)

func (Type) String

func (t Type) String() string

type Types

type Types struct {
	None                Type
	Donor               Type
	Attorney            Type
	ReplacementAttorney Type
	CertificateProvider Type
	PersonToNotify      Type
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL