certificateproviderdata

Documentation

Overview

Package certificateproviderdata provides types that describe the data entered by a certificate provider.

Index

• type DynamoClient
• type Provided
  • func (c *Provided) CertificateProviderIdentityConfirmed(firstNames, lastName string) bool
• type Store
  • func NewStore(dynamoClient DynamoClient) *Store
  • func (s *Store) Create(ctx context.Context, shareCode sharecode.Data, email string) (*Provided, error)
  • func (s *Store) Delete(ctx context.Context) error
  • func (s *Store) Get(ctx context.Context) (*Provided, error)
  • func (s *Store) GetAny(ctx context.Context) (*Provided, error)
  • func (s *Store) Put(ctx context.Context, certificateProvider *Provided) error
• type Tasks

Types

type DynamoClient

type DynamoClient interface {
	One(ctx context.Context, pk dynamo.PK, sk dynamo.SK, v interface{}) error
	OneByPK(ctx context.Context, pk dynamo.PK, v interface{}) error
	OneByPartialSK(ctx context.Context, pk dynamo.PK, partialSK dynamo.SK, v interface{}) error
	AllByPartialSK(ctx context.Context, pk dynamo.PK, partialSK dynamo.SK, v interface{}) error
	LatestForActor(ctx context.Context, sk dynamo.SK, v interface{}) error
	AllBySK(ctx context.Context, sk dynamo.SK, v interface{}) error
	AllByKeys(ctx context.Context, keys []dynamo.Keys) ([]map[string]dynamodbtypes.AttributeValue, error)
	AllKeysByPK(ctx context.Context, pk dynamo.PK) ([]dynamo.Keys, error)
	Put(ctx context.Context, v interface{}) error
	Create(ctx context.Context, v interface{}) error
	DeleteKeys(ctx context.Context, keys []dynamo.Keys) error
	DeleteOne(ctx context.Context, pk dynamo.PK, sk dynamo.SK) error
	Update(ctx context.Context, pk dynamo.PK, sk dynamo.SK, values map[string]dynamodbtypes.AttributeValue, expression string) error
	BatchPut(ctx context.Context, items []interface{}) error
	OneBySK(ctx context.Context, sk dynamo.SK, v interface{}) error
	OneByUID(ctx context.Context, uid string, v interface{}) error
	WriteTransaction(ctx context.Context, transaction *dynamo.Transaction) error
}

type Provided

type Provided struct {
	PK dynamo.LpaKeyType
	SK dynamo.CertificateProviderKeyType
	// UID of the actor
	UID actoruid.UID
	// The identifier of the LPA the certificate provider is providing a certificate for
	LpaID string
	// Tracking when CertificateProviderProvidedDetails is updated
	UpdatedAt time.Time
	// Date of birth of the certificate provider
	DateOfBirth date.Date
	// HomeAddress is the personal address of the certificate provider
	HomeAddress place.Address
	// Data returned from an identity check
	IdentityUserData identity.UserData
	// SignedAt is when the certificate provider submitted their signature
	SignedAt time.Time
	// Tasks the certificate provider will complete
	Tasks Tasks
	// ContactLanguagePreference is the language the certificate provider prefers to receive notifications in
	ContactLanguagePreference localize.Lang
	// Email is the email address returned from OneLogin when the certificate provider logged in
	Email string
}

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

func (*Provided) CertificateProviderIdentityConfirmed

func (c *Provided) CertificateProviderIdentityConfirmed(firstNames, lastName string) bool

type Store

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

func NewStore

func NewStore(dynamoClient DynamoClient) *Store

func (*Store) Create

func (s *Store) Create(ctx context.Context, shareCode sharecode.Data, email string) (*Provided, error)

func (*Store) Delete

func (s *Store) Delete(ctx context.Context) error

func (*Store) Get

func (s *Store) Get(ctx context.Context) (*Provided, error)

func (*Store) GetAny

func (s *Store) GetAny(ctx context.Context) (*Provided, error)

func (*Store) Put

func (s *Store) Put(ctx context.Context, certificateProvider *Provided) error

type Tasks

type Tasks struct {
	ConfirmYourDetails    task.State
	ConfirmYourIdentity   task.State
	ReadTheLpa            task.State
	ProvideTheCertificate task.State
}