Documentation ¶
Index ¶
- type AttorneyKeyType
- type AttorneyShareKeyType
- type CertificateProviderKeyType
- type CertificateProviderShareKeyType
- type Client
- func (c *Client) AllByKeys(ctx context.Context, keys []Keys) ([]map[string]types.AttributeValue, error)
- func (c *Client) AllByPartialSK(ctx context.Context, pk PK, partialSk SK, v interface{}) error
- func (c *Client) AllBySK(ctx context.Context, sk SK, v interface{}) error
- func (c *Client) AllKeysByPK(ctx context.Context, pk PK) ([]Keys, error)
- func (c *Client) BatchPut(ctx context.Context, values []interface{}) error
- func (c *Client) Create(ctx context.Context, v interface{}) error
- func (c *Client) DeleteKeys(ctx context.Context, keys []Keys) error
- func (c *Client) DeleteOne(ctx context.Context, pk PK, sk SK) error
- func (c *Client) LatestForActor(ctx context.Context, sk SK, v interface{}) error
- func (c *Client) One(ctx context.Context, pk PK, sk SK, v interface{}) error
- func (c *Client) OneByPK(ctx context.Context, pk PK, v interface{}) error
- func (c *Client) OneByPartialSK(ctx context.Context, pk PK, partialSK SK, v interface{}) error
- func (c *Client) OneBySK(ctx context.Context, sk SK, v interface{}) error
- func (c *Client) OneByUID(ctx context.Context, uid string, v interface{}) error
- func (c *Client) Put(ctx context.Context, v interface{}) error
- func (c *Client) Update(ctx context.Context, pk PK, sk SK, values map[string]types.AttributeValue, ...) error
- func (c *Client) UpdateReturn(ctx context.Context, pk PK, sk SK, values map[string]types.AttributeValue, ...) (map[string]types.AttributeValue, error)
- type ConditionalCheckFailedError
- type DocumentKeyType
- type DonorInviteKeyType
- type DonorKeyType
- type DonorShareKeyType
- type EvidenceReceivedKeyType
- type Keys
- type LpaKeyType
- type LpaOwnerKeyType
- func (k LpaOwnerKeyType) Equals(sk SK) bool
- func (k LpaOwnerKeyType) MarshalDynamoDBAttributeValue() (types.AttributeValue, error)
- func (k LpaOwnerKeyType) MarshalText() ([]byte, error)
- func (k LpaOwnerKeyType) Organisation() (OrganisationKeyType, bool)
- func (k LpaOwnerKeyType) SK() string
- func (k *LpaOwnerKeyType) UnmarshalDynamoDBAttributeValue(av types.AttributeValue) error
- func (k *LpaOwnerKeyType) UnmarshalText(text []byte) error
- type MemberIDKeyType
- type MemberInviteKeyType
- type MemberKeyType
- type MetadataKeyType
- type MultipleResultsError
- type NotFoundError
- type OrganisationKeyType
- type PK
- type SK
- type ShareKeyType
- func (k ShareKeyType) MarshalDynamoDBAttributeValue() (types.AttributeValue, error)
- func (k ShareKeyType) MarshalText() ([]byte, error)
- func (k ShareKeyType) PK() string
- func (k *ShareKeyType) UnmarshalDynamoDBAttributeValue(av types.AttributeValue) error
- func (k *ShareKeyType) UnmarshalText(text []byte) error
- type ShareSortKeyType
- func (k ShareSortKeyType) MarshalDynamoDBAttributeValue() (types.AttributeValue, error)
- func (k ShareSortKeyType) MarshalText() ([]byte, error)
- func (k ShareSortKeyType) SK() string
- func (k *ShareSortKeyType) UnmarshalDynamoDBAttributeValue(av types.AttributeValue) error
- func (k *ShareSortKeyType) UnmarshalText(text []byte) error
- type SubKeyType
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AttorneyKeyType ¶ added in v0.1151.0
type AttorneyKeyType string
func AttorneyKey ¶ added in v0.1116.0
func AttorneyKey(s string) AttorneyKeyType
AttorneyKey is used as the SK (with LpaKey as PK) for attorney entered information.
func (AttorneyKeyType) SK ¶ added in v0.1151.0
func (t AttorneyKeyType) SK() string
type AttorneyShareKeyType ¶ added in v0.1151.0
type AttorneyShareKeyType string
func AttorneyShareKey ¶ added in v0.1151.0
func AttorneyShareKey(code string) AttorneyShareKeyType
AttorneyShareKey is used as the PK for sharing an Lpa with a donor.
func (AttorneyShareKeyType) PK ¶ added in v0.1151.0
func (t AttorneyShareKeyType) PK() string
type CertificateProviderKeyType ¶ added in v0.1151.0
type CertificateProviderKeyType string
func CertificateProviderKey ¶ added in v0.1116.0
func CertificateProviderKey(s string) CertificateProviderKeyType
CertificateProviderKey is used as the SK (with LpaKey as PK) for certificate provider entered information.
func (CertificateProviderKeyType) SK ¶ added in v0.1151.0
func (t CertificateProviderKeyType) SK() string
type CertificateProviderShareKeyType ¶ added in v0.1151.0
type CertificateProviderShareKeyType string
func CertificateProviderShareKey ¶ added in v0.1151.0
func CertificateProviderShareKey(code string) CertificateProviderShareKeyType
CertificateProviderShareKey is used as the PK for sharing an Lpa with a donor.
func (CertificateProviderShareKeyType) PK ¶ added in v0.1151.0
func (t CertificateProviderShareKeyType) PK() string
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
func (*Client) AllByPartialSK ¶ added in v0.1025.0
func (*Client) AllKeysByPK ¶ added in v0.1025.0
func (*Client) DeleteKeys ¶ added in v0.785.0
func (*Client) LatestForActor ¶ added in v0.712.0
func (*Client) OneByPartialSK ¶ added in v0.1025.0
func (*Client) UpdateReturn ¶ added in v0.1045.0
type ConditionalCheckFailedError ¶ added in v0.794.0
type ConditionalCheckFailedError struct{}
func (ConditionalCheckFailedError) Error ¶ added in v0.794.0
func (c ConditionalCheckFailedError) Error() string
type DocumentKeyType ¶ added in v0.1151.0
type DocumentKeyType string
func DocumentKey ¶ added in v0.1116.0
func DocumentKey(s3Key string) DocumentKeyType
DocumentKey is used as the SK (with LpaKey as PK) for any documents uploaded as evidence for reduced fees.
func (DocumentKeyType) SK ¶ added in v0.1151.0
func (t DocumentKeyType) SK() string
type DonorInviteKeyType ¶ added in v0.1151.0
type DonorInviteKeyType string
func DonorInviteKey ¶ added in v0.1116.0
func DonorInviteKey(organisation OrganisationKeyType, lpa LpaKeyType) DonorInviteKeyType
DonorInviteKey is used as the SK (with DonorShareKey as PK) for an invitation to a donor to link an Lpa being created by a member of an organisation.
func (DonorInviteKeyType) SK ¶ added in v0.1151.0
func (t DonorInviteKeyType) SK() string
type DonorKeyType ¶ added in v0.1151.0
type DonorKeyType string
func DonorKey ¶ added in v0.1116.0
func DonorKey(s string) DonorKeyType
DonorKey is used as the SK (with LpaKey as PK) for donor entered information. It is set to PAPER when the donor information has been provided from paper forms.
func (DonorKeyType) SK ¶ added in v0.1151.0
func (t DonorKeyType) SK() string
type DonorShareKeyType ¶ added in v0.1151.0
type DonorShareKeyType string
func DonorShareKey ¶ added in v0.1116.0
func DonorShareKey(code string) DonorShareKeyType
DonorShareKey is used as the PK for sharing an Lpa with a donor.
func (DonorShareKeyType) PK ¶ added in v0.1151.0
func (t DonorShareKeyType) PK() string
type EvidenceReceivedKeyType ¶ added in v0.1151.0
type EvidenceReceivedKeyType string
func EvidenceReceivedKey ¶ added in v0.1116.0
func EvidenceReceivedKey() EvidenceReceivedKeyType
EvidenceReceivedKey is used as the SK (with LpaKey as PK) to show that paper evidence has been submitted for an Lpa.
func (EvidenceReceivedKeyType) SK ¶ added in v0.1151.0
func (t EvidenceReceivedKeyType) SK() string
type Keys ¶ added in v0.1151.0
func (*Keys) UnmarshalDynamoDBAttributeValue ¶ added in v0.1151.0
func (k *Keys) UnmarshalDynamoDBAttributeValue(av types.AttributeValue) error
func (*Keys) UnmarshalJSON ¶ added in v0.1151.0
type LpaKeyType ¶ added in v0.1151.0
type LpaKeyType string
func LpaKey ¶ added in v0.1116.0
func LpaKey(s string) LpaKeyType
LpaKey is used as the PK for all Lpa related information.
func (LpaKeyType) ID ¶ added in v0.1165.0
func (t LpaKeyType) ID() string
func (LpaKeyType) PK ¶ added in v0.1151.0
func (t LpaKeyType) PK() string
type LpaOwnerKeyType ¶ added in v0.1151.0
type LpaOwnerKeyType struct {
// contains filtered or unexported fields
}
func LpaOwnerKey ¶ added in v0.1151.0
func LpaOwnerKey(sk interface { SK lpaOwner() }) LpaOwnerKeyType
LpaOwnerKey is used as the SK (with LpaKey as PK) to allow both donors and organisations to "own" LPAs.
func (LpaOwnerKeyType) Equals ¶ added in v0.1151.0
func (k LpaOwnerKeyType) Equals(sk SK) bool
func (LpaOwnerKeyType) MarshalDynamoDBAttributeValue ¶ added in v0.1151.0
func (k LpaOwnerKeyType) MarshalDynamoDBAttributeValue() (types.AttributeValue, error)
func (LpaOwnerKeyType) MarshalText ¶ added in v0.1151.0
func (k LpaOwnerKeyType) MarshalText() ([]byte, error)
func (LpaOwnerKeyType) Organisation ¶ added in v0.1165.0
func (k LpaOwnerKeyType) Organisation() (OrganisationKeyType, bool)
func (LpaOwnerKeyType) SK ¶ added in v0.1151.0
func (k LpaOwnerKeyType) SK() string
func (*LpaOwnerKeyType) UnmarshalDynamoDBAttributeValue ¶ added in v0.1151.0
func (k *LpaOwnerKeyType) UnmarshalDynamoDBAttributeValue(av types.AttributeValue) error
func (*LpaOwnerKeyType) UnmarshalText ¶ added in v0.1151.0
func (k *LpaOwnerKeyType) UnmarshalText(text []byte) error
type MemberIDKeyType ¶ added in v0.1151.0
type MemberIDKeyType string
func MemberIDKey ¶ added in v0.1116.0
func MemberIDKey(memberID string) MemberIDKeyType
MemberIDKey is used as the SK (with OrganisationKey as PK) to allow retrieving a member using their ID instead of their OneLogin sub.
func (MemberIDKeyType) SK ¶ added in v0.1151.0
func (t MemberIDKeyType) SK() string
type MemberInviteKeyType ¶ added in v0.1151.0
type MemberInviteKeyType string
func MemberInviteKey ¶ added in v0.1116.0
func MemberInviteKey(email string) MemberInviteKeyType
MemberInviteKey is used as the SK (with OrganisationKey as PK) for a member invite.
func (MemberInviteKeyType) SK ¶ added in v0.1151.0
func (t MemberInviteKeyType) SK() string
type MemberKeyType ¶ added in v0.1151.0
type MemberKeyType string
func MemberKey ¶ added in v0.1116.0
func MemberKey(sessionID string) MemberKeyType
MemberKey is used as the SK (with OrganisationKey as PK) for a member of an organisation.
func (MemberKeyType) SK ¶ added in v0.1151.0
func (t MemberKeyType) SK() string
type MetadataKeyType ¶ added in v0.1151.0
type MetadataKeyType string
func MetadataKey ¶ added in v0.1116.0
func MetadataKey(s string) MetadataKeyType
MetadataKey is used as the SK when the value of the SK is not used for any purpose.
func (MetadataKeyType) SK ¶ added in v0.1151.0
func (t MetadataKeyType) SK() string
type MultipleResultsError ¶
type MultipleResultsError struct{}
func (MultipleResultsError) Error ¶
func (n MultipleResultsError) Error() string
type NotFoundError ¶
type NotFoundError struct{}
func (NotFoundError) Error ¶
func (n NotFoundError) Error() string
type OrganisationKeyType ¶ added in v0.1151.0
type OrganisationKeyType string
func OrganisationKey ¶ added in v0.1116.0
func OrganisationKey(organisationID string) OrganisationKeyType
OrganisationKey is used as the PK to group organisation data; or as the SK (with OrganisationKey as PK) for the organisation itself; or as the SK (with LpaKey as PK) for the donor information entered by a member of an organisation.
func (OrganisationKeyType) ID ¶ added in v0.1165.0
func (t OrganisationKeyType) ID() string
func (OrganisationKeyType) PK ¶ added in v0.1151.0
func (t OrganisationKeyType) PK() string
func (OrganisationKeyType) SK ¶ added in v0.1151.0
func (t OrganisationKeyType) SK() string
type ShareKeyType ¶ added in v0.1151.0
type ShareKeyType struct {
// contains filtered or unexported fields
}
func ShareKey ¶ added in v0.1151.0
func ShareKey(pk interface { PK share() }) ShareKeyType
ShareKey is used as the PK (with ShareSortKey as SK) for sharing an LPA with another actor.
func (ShareKeyType) MarshalDynamoDBAttributeValue ¶ added in v0.1151.0
func (k ShareKeyType) MarshalDynamoDBAttributeValue() (types.AttributeValue, error)
func (ShareKeyType) MarshalText ¶ added in v0.1151.0
func (k ShareKeyType) MarshalText() ([]byte, error)
func (ShareKeyType) PK ¶ added in v0.1151.0
func (k ShareKeyType) PK() string
func (*ShareKeyType) UnmarshalDynamoDBAttributeValue ¶ added in v0.1151.0
func (k *ShareKeyType) UnmarshalDynamoDBAttributeValue(av types.AttributeValue) error
func (*ShareKeyType) UnmarshalText ¶ added in v0.1151.0
func (k *ShareKeyType) UnmarshalText(text []byte) error
type ShareSortKeyType ¶ added in v0.1151.0
type ShareSortKeyType struct {
// contains filtered or unexported fields
}
func ShareSortKey ¶ added in v0.1151.0
func ShareSortKey(sk interface { SK shareSort() }) ShareSortKeyType
ShareSortKey is used as the SK (with ShareKey as the PK) for sharing an LPA with another actor.
func (ShareSortKeyType) MarshalDynamoDBAttributeValue ¶ added in v0.1151.0
func (k ShareSortKeyType) MarshalDynamoDBAttributeValue() (types.AttributeValue, error)
func (ShareSortKeyType) MarshalText ¶ added in v0.1151.0
func (k ShareSortKeyType) MarshalText() ([]byte, error)
func (ShareSortKeyType) SK ¶ added in v0.1151.0
func (k ShareSortKeyType) SK() string
func (*ShareSortKeyType) UnmarshalDynamoDBAttributeValue ¶ added in v0.1151.0
func (k *ShareSortKeyType) UnmarshalDynamoDBAttributeValue(av types.AttributeValue) error
func (*ShareSortKeyType) UnmarshalText ¶ added in v0.1151.0
func (k *ShareSortKeyType) UnmarshalText(text []byte) error
type SubKeyType ¶ added in v0.1151.0
type SubKeyType string
func SubKey ¶ added in v0.1116.0
func SubKey(s string) SubKeyType
SubKey is used as the SK (with LpaKey as PK) to allow queries on a OneLogin sub against all Lpas an actor may have provided information on.
func (SubKeyType) SK ¶ added in v0.1151.0
func (t SubKeyType) SK() string