donordata

type Attorney struct {
	// UID for the actor
	UID actoruid.UID
	// First names of the attorney
	FirstNames string `relatedhash:"-"`
	// Last name of the attorney
	LastName string
	// Email of the attorney
	Email string `relatedhash:"-"`
	// Date of birth of the attorney
	DateOfBirth date.Date `relatedhash:"-"`
	// Address of the attorney
	Address place.Address
}

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

type Attorneys struct {
	TrustCorporation TrustCorporation `relatedhash:"-"`
	Attorneys        []Attorney
}

type AuthorisedSignatory struct {
	UID        actoruid.UID
	FirstNames string
	LastName   string
}

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

type CertificateProviderRelationshipLength uint8

type CertificateProviderRelationshipLengthOptions struct {
	RelationshipLengthUnknown  CertificateProviderRelationshipLength
	LessThanTwoYears           CertificateProviderRelationshipLength
	GreaterThanEqualToTwoYears CertificateProviderRelationshipLength
}

type Correspondent struct {
	UID          actoruid.UID
	FirstNames   string
	LastName     string
	Email        string
	Organisation string
	Phone        string
	WantAddress  form.YesNo
	Address      place.Address
}

type Donor struct {
	// UID for the actor
	UID actoruid.UID `stubhash:"-"`
	// First names of the donor
	FirstNames string `relatedhash:"-"`
	// Last name of the donor
	LastName string
	// Email of the donor
	Email string `checkhash:"-" relatedhash:"-" stubhash:"-"`
	// Other names the donor is known by
	OtherNames string `relatedhash:"-" stubhash:"-"`
	// Date of birth of the donor
	DateOfBirth date.Date `relatedhash:"-"`
	// Address of the donor
	Address place.Address
	// International address of the donor
	InternationalAddress place.InternationalAddress `relatedhash:"-" stubhash:"-"`
	// Mobile phone number to contact the donor
	Mobile string `checkhash:"-" relatedhash:"-" stubhash:"-"`
	// ThinksCanSign is what the donor thinks about their ability to sign online
	ThinksCanSign YesNoMaybe `relatedhash:"-" stubhash:"-"`
	// CanSign is Yes if the donor has said they will sign online
	CanSign form.YesNo `relatedhash:"-" stubhash:"-"`
	// Channel is how the Donor is applying for their LPA (paper or online)
	Channel lpadata.Channel `relatedhash:"-" stubhash:"-"`
	// ContactLanguagePreference is the language the donor prefers to receive notifications in
	ContactLanguagePreference localize.Lang `relatedhash:"-" stubhash:"-"`
	// LpaLanguagePreference is the language the donor prefers to receive the registered LPA in
	LpaLanguagePreference localize.Lang `checkhash:"-" relatedhash:"-" stubhash:"-"`
}

type IndependentWitness struct {
	UID            actoruid.UID
	FirstNames     string
	LastName       string
	HasNonUKMobile bool   `checkhash:"-"`
	Mobile         string `checkhash:"-"`
	Address        place.Address
}

type Localizer interface {
	localize.Localizer
}

type NoVoucherDecision uint8

type NoVoucherDecisionOptions struct {
	ProveOwnIdentity NoVoucherDecision
	SelectNewVoucher NoVoucherDecision
	WithdrawLPA      NoVoucherDecision
	ApplyToCOP       NoVoucherDecision
}

type Payment struct {
	// Reference generated for the payment
	PaymentReference string
	// ID returned from GOV.UK Pay
	PaymentID string
	// Amount is the amount paid in pence
	Amount int
	// CreatedAt is when the payment was created
	CreatedAt time.Time
}

type PeopleToNotify []PersonToNotify

type PersonToNotify struct {
	UID actoruid.UID
	// First names of the person to notify
	FirstNames string
	// Last name of the person to notify
	LastName string
	// Address of the person to notify
	Address place.Address
}

type Provided struct {
	PK dynamo.LpaKeyType      `hash:"-" checkhash:"-"`
	SK dynamo.LpaOwnerKeyType `hash:"-" checkhash:"-"`
	// Hash is used to determine whether the Lpa has been changed since last read
	Hash uint64 `hash:"-" checkhash:"-"`
	// HashVersion is used to determine the fields used to calculate Hash
	HashVersion uint8 `hash:"-" checkhash:"-"`
	// LpaID identifies the LPA being drafted
	LpaID string
	// LpaUID is a unique identifier created after sending basic LPA details to the UID service
	LpaUID string `dynamodbav:",omitempty"`
	// CreatedAt is when the LPA was created
	CreatedAt time.Time `checkhash:"-"`
	// UpdatedAt is when the LPA was last updated
	UpdatedAt time.Time `hash:"-" checkhash:"-"`
	// The donor the LPA relates to
	Donor Donor
	// Attorneys named in the LPA
	Attorneys Attorneys
	// Information on how the applicant wishes their attorneys to act
	AttorneyDecisions AttorneyDecisions
	// The certificate provider named in the LPA
	CertificateProvider CertificateProvider
	// Type of LPA being drafted
	Type lpadata.LpaType
	// Whether the applicant wants to add replacement attorneys
	WantReplacementAttorneys form.YesNo
	// When the LPA can be used
	WhenCanTheLpaBeUsed lpadata.CanBeUsedWhen
	// Preferences on life sustaining treatment (applicable to personal welfare LPAs only)
	LifeSustainingTreatmentOption lpadata.LifeSustainingTreatment
	// Restrictions on attorneys actions
	Restrictions string
	// Used to show the task list
	Tasks Tasks `checkhash:"-"`
	// PaymentDetails are records of payments made for the LPA via GOV.UK Pay
	PaymentDetails []Payment `checkhash:"-"`
	// Information returned by the identity service related to the Donor or Voucher
	IdentityUserData identity.UserData `checkhash:"-"`
	// Replacement attorneys named in the LPA
	ReplacementAttorneys Attorneys
	// Information on how the applicant wishes their replacement attorneys to act
	ReplacementAttorneyDecisions AttorneyDecisions
	// How to bring in replacement attorneys, if set
	HowShouldReplacementAttorneysStepIn lpadata.ReplacementAttorneysStepIn
	// Details on how replacement attorneys must step in if HowShouldReplacementAttorneysStepIn is set to "other"
	HowShouldReplacementAttorneysStepInDetails string
	// Whether the applicant wants to add a correspondent
	AddCorrespondent form.YesNo `checkhash:"-"`
	// Correspondent is sent updates on an application in place of a (supporter) donor
	Correspondent Correspondent `checkhash:"-"`
	// Whether the applicant wants to notify people about the application
	DoYouWantToNotifyPeople form.YesNo
	// People to notify about the application
	PeopleToNotify PeopleToNotify
	// The AuthorisedSignatory signs on the donor's behalf if they are unable to sign
	AuthorisedSignatory AuthorisedSignatory
	// The IndependentWitness acts as an additional witness when the LPA is signed
	IndependentWitness IndependentWitness
	// Confirmation that the applicant wants to apply to register the LPA
	WantToApplyForLpa bool `checkhash:"-"`
	// Confirmation that the applicant wants to sign the LPA
	WantToSignLpa bool `checkhash:"-"`
	// CertificateProviderNotRelatedConfirmedAt is when the donor confirmed the
	// certificate provider is not related to another similar actor
	CertificateProviderNotRelatedConfirmedAt time.Time
	// CertificateProviderNotRelatedConfirmedHash is the hash of data that was confirmed by
	// CertificateProviderNotRelatedConfirmedAt
	CertificateProviderNotRelatedConfirmedHash uint64
	// CertificateProviderNotRelatedConfirmedHashVersion is used to determine the
	// fields used to calculate CertificateProviderNotRelatedConfirmedHash
	CertificateProviderNotRelatedConfirmedHashVersion uint8
	// CheckedAt is when the donor checked their LPA
	CheckedAt time.Time `checkhash:"-"`
	// CheckedHash is the Hash value of the LPA when last checked
	CheckedHash uint64 `hash:"-" checkhash:"-"`
	// CheckedHashVersion is used to determine the fields used to calculate CheckedHash
	CheckedHashVersion uint8 `hash:"-" checkhash:"-"`
	// SignedAt is when the donor submitted their signature
	SignedAt time.Time `checkhash:"-"`
	// WithdrawnAt is when the Lpa was withdrawn by the donor
	WithdrawnAt time.Time `checkhash:"-"`
	// StatutoryWaitingPeriodAt is when the Lpa transitioned to the
	// statutory-waiting-period status in the lpa-store
	StatutoryWaitingPeriodAt time.Time `checkhash:"-"`
	// DoNotRegisterAt is when the Lpa transitioned to do-not-register status in
	// the lpa-store
	DoNotRegisterAt time.Time `checkhash:"-"`
	// RegisteringWithCourtOfProtection is set when the donor wishes to take the
	// Lpa to the Court of Protection for registration.
	RegisteringWithCourtOfProtection bool `checkhash:"-"`
	// Version is the number of times the LPA has been updated (auto-incremented
	// on PUT)
	Version int `hash:"-" checkhash:"-"`

	// WantVoucher indicates if the donor knows someone who can vouch for them and wants
	// then to do so
	WantVoucher form.YesNo `checkhash:"-"`
	// Voucher is a person the donor has nominated to vouch for their identity
	Voucher Voucher `checkhash:"-"`
	// VouchAttempts are the number of attempts a voucher has made to confirm the Donors identity
	VouchAttempts int `checkhash:"-"`
	// FailedVoucher is the last voucher that was unable to vouch for the donor
	FailedVoucher Voucher `checkhash:"-"`
	// VoucherCodeSentBySMS records the whether the voucher access code was sent
	// to the donor by sms (if not it was email).
	VoucherCodeSentBySMS bool `checkhash:"-"`
	// VoucherCodeSentTo records the mobile number or email address that the
	// voucher access code was sent to.
	VoucherCodeSentTo string `checkhash:"-"`

	// Codes used for the certificate provider to witness signing
	CertificateProviderCodes WitnessCodes `checkhash:"-"`
	// When the signing was witnessed by the certificate provider
	WitnessedByCertificateProviderAt time.Time `checkhash:"-"`
	// Codes used for the independent witness to witness signing
	IndependentWitnessCodes WitnessCodes `checkhash:"-"`
	// When the signing was witnessed by the independent witness
	WitnessedByIndependentWitnessAt time.Time `checkhash:"-"`
	// Used to rate limit witness code attempts
	WitnessCodeLimiter *rate.Limiter `checkhash:"-"`

	// FeeType is the type of fee the user is applying for
	FeeType pay.FeeType `checkhash:"-"`
	// EvidenceDelivery is the method by which the user wants to send evidence
	EvidenceDelivery pay.EvidenceDelivery `checkhash:"-"`
	// PreviousApplicationNumber if the application is related to an existing application
	PreviousApplicationNumber string `checkhash:"-"`
	// PreviousFee is the fee previously paid for an LPA, if applying for a repeat
	// of an LPA with reference prefixed 7 or have selected HalfFee for
	// CostOfRepeatApplication.
	PreviousFee pay.PreviousFee `checkhash:"-"`
	// CostOfRepeatApplication is the fee the donor believes they are eligible
	// for, if applying for a repeat of an LPA with reference prefixed M.
	CostOfRepeatApplication pay.CostOfRepeatApplication `checkhash:"-"`

	// CertificateProviderInvitedAt records when the invite is sent to the
	// certificate provider to act.
	CertificateProviderInvitedAt time.Time `checkhash:"-"`

	// CertificateProviderInvitedEmail records the email address used to send the
	// invite. It will be empty if the certificate provider is using paper.
	CertificateProviderInvitedEmail string `checkhash:"-"`

	// AttorneysInvitedAt records when the invites are sent to the attorneys.
	AttorneysInvitedAt time.Time `checkhash:"-"`

	// VoucherInvitedAt records when the invite is sent to the voucher to vouch.
	VoucherInvitedAt time.Time `checkhash:"-"`

	// DetailsVerifiedByVoucher records that a voucher has verified details supplied by
	// the donor match their identity.
	DetailsVerifiedByVoucher bool `checkhash:"-"`

	// MoreEvidenceRequiredAt records when a request for further information on an
	// exemption/remission was received.
	MoreEvidenceRequiredAt time.Time `checkhash:"-"`

	// PriorityCorrespondenceSentAt records when a caseworker sent a letter to the
	// donor informing them of a problem.
	PriorityCorrespondenceSentAt time.Time `checkhash:"-"`

	// HasSeenSuccessfulVouchBanner records if the donor has seen the progress
	// tracker successful vouch banner
	HasSeenSuccessfulVouchBanner bool `checkhash:"-"`

	// HasSeenReducedFeeApprovalNotification records if the donor has seen the
	// progress tracker exemption/remission fee approved banner
	HasSeenReducedFeeApprovalNotification bool `checkhash:"-"`

	// HasSeenCertificateProviderIdentityMismatchResolvedNotification records if
	// the donor has seen the progress tracker certificate provider identity
	// confirmed banner
	HasSeenCertificateProviderIdentityMismatchResolvedNotification bool `checkhash:"-"`

	// ReducedFeeDecisionAt records when an exemption/remission was approved or denied
	ReducedFeeDecisionAt time.Time `checkhash:"-"`

	// IdentityDetailsCausedCheck is set when details are updated to match
	// confirmed identity, and check and send hasn't been done with those new
	// details
	IdentityDetailsCausedCheck bool `checkhash:"-"`

	// ContinueWithMismatchedDetails is set when the donor wishes to continue
	// using details that do not match those returned by the identity check.
	ContinueWithMismatchedDetails bool `checkhash:"-"`

	// LpaStubHash is the hash of data required to generate an LPA UID
	LpaStubHash uint64 `hash:"-" checkhash:"-"`
	// LpaStubHashVersion is used to determine the fields used to calculate LpaStubHash
	LpaStubHashVersion uint8 `hash:"-" checkhash:"-"`
}

type Tasks struct {
	YourDetails                task.State
	ChooseAttorneys            task.State
	ChooseReplacementAttorneys task.State
	WhenCanTheLpaBeUsed        task.State // property and affairs only
	LifeSustainingTreatment    task.State // personal welfare only
	Restrictions               task.State
	CertificateProvider        task.State
	PeopleToNotify             task.State
	AddCorrespondent           task.State
	ChooseYourSignatory        task.State // if .Donor.CanSign.IsNo only
	CheckYourLpa               task.State
	PayForLpa                  task.PaymentState
	ConfirmYourIdentity        task.IdentityState
	SignTheLpa                 task.State
}

type TrustCorporation struct {
	// UID for the actor
	UID actoruid.UID
	// Name of the company
	Name string
	// Email to contact the company
	Email string
	// Address of the company
	Address place.Address
}

type Under18ActorDetails struct {
	FullName    string
	DateOfBirth date.Date
	UID         actoruid.UID
	Type        actor.Type
}

type Voucher struct {
	UID        actoruid.UID
	FirstNames string
	LastName   string
	Email      string
	Allowed    bool
	FailedAt   time.Time
}

type WitnessCode struct {
	Code    string
	Created time.Time
}

type WitnessCodes []WitnessCode

type YesNoMaybe uint8

type YesNoMaybeForm struct {
	Option YesNoMaybe
	// contains filtered or unexported fields
}

type YesNoMaybeOptions struct {
	Yes   YesNoMaybe
	No    YesNoMaybe
	Maybe YesNoMaybe
}