Documentation
¶
Index ¶
Constants ¶
const ( // ProofTypeSmartContract captures enum value "SmartContract" ProofTypeSmartContract string = "SmartContract" // ProofTypeRSASignature captures enum value "RSASignature" ProofTypeRSASignature string = "RSASignature" // ProofTypeSecp256k1 captures enum value "Secp256k1" ProofTypeSecp256k1 string = "Secp256k1" // ProofTypeSecp256r1 captures enum value "Secp256r1" ProofTypeSecp256r1 string = "Secp256r1" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type APIResponse ¶
type APIResponse struct {
// code
Code int32 `json:"code,omitempty"`
// message
Message string `json:"message,omitempty"`
// type
Type string `json:"type,omitempty"`
}
APIResponse is the response to an API call.
func (*APIResponse) MarshalBinary ¶
func (m *APIResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*APIResponse) UnmarshalBinary ¶
func (m *APIResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Credential ¶
type Credential struct {
// credential data
CredentialData *CredentialData `json:"credentialData,omitempty"`
// metadata
Metadata *CredentialMetadata `json:"metadata,omitempty"`
}
Credential credential swagger:model Credential
func (*Credential) MarshalBinary ¶
func (m *Credential) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*Credential) UnmarshalBinary ¶
func (m *Credential) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CredentialData ¶
type CredentialData struct {
// The claims about a DID or identity that will be signed by Credential Provider
// Required: true
CredentialSubject interface{} `json:"credentialSubject"`
// The evidence obtained from the validation of the claims, may be photos, physical documents, links, etc
Evidence interface{} `json:"evidence,omitempty"`
// The credential ID generated by the Provider Credential
// Required: true
ID *string `json:"id"`
// credential issuance date
// Format: date-time
IssuanceDate strfmt.DateTime `json:"issuanceDate,omitempty"`
// The DID or identity of Provider Credential
Issuer string `json:"issuer,omitempty"`
// proof
// Required: true
Proof *Proof `json:"proof"`
// The types of this credential
// Required: true
Type []string `json:"type"`
}
CredentialData credential data swagger:model CredentialData
func (*CredentialData) MarshalBinary ¶
func (m *CredentialData) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CredentialData) UnmarshalBinary ¶
func (m *CredentialData) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CredentialMetadata ¶
type CredentialMetadata struct {
// The block number where the transaction was inserted
BlockNumber string `json:"blockNumber,omitempty"`
// The dateTime when the block was generated YYYY-MM-DDTHH:MM:SSZ
Timestamp string `json:"timestamp,omitempty"`
// The transaction hash
Transaction string `json:"transaction,omitempty"`
// mail of contact
Email string `json:"email,omitempty"`
}
CredentialMetadata credential metadata swagger:model CredentialMetadata
func (*CredentialMetadata) MarshalBinary ¶
func (m *CredentialMetadata) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CredentialMetadata) UnmarshalBinary ¶
func (m *CredentialMetadata) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CredentialRenewal ¶
type CredentialRenewal struct {
// Credential ID
ID string `json:"id,omitempty"`
// new expiration date
// Format: date-time
NewExpirationDate strfmt.DateTime `json:"newExpirationDate,omitempty"`
}
CredentialRenewal credential renewal swagger:model CredentialRenewal
func (*CredentialRenewal) MarshalBinary ¶
func (m *CredentialRenewal) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CredentialRenewal) UnmarshalBinary ¶
func (m *CredentialRenewal) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CredentialSubject ¶
type CredentialSubject struct {
// The claims that will be generated with the credential
Content interface{} `json:"content,omitempty"`
// The evidence obtained from the validation of the claims, may be photos, physical documents, links, etc
Evidence interface{} `json:"evidence,omitempty"`
// credential expiration date
// Format: date-time
ExpirationDate strfmt.DateTime `json:"expirationDate,omitempty"`
// credential issuance date
// Format: date-time
IssuanceDate strfmt.DateTime `json:"issuanceDate,omitempty"`
// Credential Type
Type string `json:"type,omitempty"`
// mail of contact
Email string `json:"email,omitempty"`
}
CredentialSubject credential subject swagger:model CredentialSubject
func (*CredentialSubject) MarshalBinary ¶
func (m *CredentialSubject) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CredentialSubject) UnmarshalBinary ¶
func (m *CredentialSubject) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Error ¶
type Error struct {
// Internal error code
Code string `json:"code,omitempty"`
// Internal error message
Message string `json:"message,omitempty"`
}
Error error swagger:model Error
func (*Error) MarshalBinary ¶
MarshalBinary interface implementation
func (*Error) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type MailRequest ¶
type MailRequest struct {
// folderId
FolderId int32 `json:"folder_id"`
// name
Name string `json:"name"`
// fileData
FileData string `json:"file_data"`
}
MailRequest is the request to an API call.
type MergeFields ¶
type MergeFields struct {
FNAME string `json:"FNAME"`
LNAME string `json:"LNAME"`
MMERGE5 string `json:"QRURL"`
MMERGE6 string `json:"HASH"`
}
MergeFields ...
type Proof ¶
type Proof struct {
// The date of the digital signature with format YYYY-MM-DDTHH:MM:SSZ
// Format: date-time
Created strfmt.DateTime `json:"created,omitempty"`
// the digital signature of credential provider
SignatureValue string `json:"signatureValue,omitempty"`
// Sign Algorithm
// Enum: [SmartContract RSASignature Secp256k1 Secp256r1]
Type string `json:"type,omitempty"`
// The method to proof if a credential is valid. The methods can include smart contracts, public keys
VerificationMethod string `json:"verificationMethod,omitempty"`
}
Proof proof swagger:model Proof
func (*Proof) MarshalBinary ¶
MarshalBinary interface implementation
func (*Proof) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type SendMailRequest ¶
type SendMailRequest struct {
// emailAddress
EmailAddress string `json:"email_address"`
// status
Status string `json:"status"`
// mergeFiles
MergeFields MergeFields `json:"merge_fields"`
}
SendMailRequest is the request to Email API call
type VerifyResponse ¶
type VerifyResponse struct {
// Error code and message ocurred
Error *Error `json:"error,omitempty"`
// Credentials are validated
Valid bool `json:"valid,omitempty"`
}
VerifyResponse verify response swagger:model VerifyResponse
func (*VerifyResponse) MarshalBinary ¶
func (m *VerifyResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*VerifyResponse) UnmarshalBinary ¶
func (m *VerifyResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation