aries_cloudagent.protocols.issue_credential.v2_0.messages package
Subpackages
Submodules
aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_ack module
Credential ack message.
- class aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_ack.V20CredAck(**kwargs)[source]
Bases:
V10Ack
Credential ack.
- class aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_ack.V20CredAckSchema(*args: Any, **kwargs: Any)[source]
Bases:
V10AckSchema
Credential ack schema.
- class Meta[source]
Bases:
object
Schema metadata.
- model_class
alias of
V20CredAck
aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_ex_record_webhook module
v2.0 credential exchange webhook.
aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_format module
Issue-credential protocol message attachment format.
- class aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_format.FormatSpec(aries, detail, handler)
Bases:
tuple
- aries
Alias for field number 0
- detail
Alias for field number 1
- handler
Alias for field number 2
- class aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_format.V20CredFormat(*, attach_id: Optional[str] = None, format_: Optional[str] = None)[source]
Bases:
BaseModel
Issue-credential protocol message attachment format.
- class Format(value)[source]
Bases:
Enum
Attachment format.
- INDY = FormatSpec(aries='hlindy/', detail=<class 'aries_cloudagent.protocols.issue_credential.v2_0.models.detail.indy.V20CredExRecordIndy'>, handler=<aries_cloudagent.utils.classloader.DeferLoad object>)
Once we switch to anoncreds this will replace the above INDY definition. In the meantime there are some hardcoded references in the “…formats.indy.handler.IndyCredFormatHandler” class. INDY = FormatSpec(
“hlindy/”, V20CredExRecordIndy, DeferLoad(
“aries_cloudagent.protocols.issue_credential.v2_0” “.formats.anoncreds.handler.AnonCredsCredFormatHandler”
),
)
- LD_PROOF = FormatSpec(aries='aries/', detail=<class 'aries_cloudagent.protocols.issue_credential.v2_0.models.detail.ld_proof.V20CredExRecordLDProof'>, handler=<aries_cloudagent.utils.classloader.DeferLoad object>)
- property detail: Union[V20CredExRecordIndy, V20CredExRecordLDProof]
Accessor for credential exchange detail class.
- get_attachment_data(formats: Sequence[V20CredFormat], attachments: Sequence[AttachDecorator])[source]
Find attachment of current format, decode and return its content.
- class aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_format.V20CredFormatSchema(*args: Any, **kwargs: Any)[source]
Bases:
BaseModelSchema
Issue-credential protocol message attachment format schema.
- class Meta[source]
Bases:
object
Issue-credential protocol message attachment format schema metadata.
- model_class
alias of
V20CredFormat
aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_issue module
Credential issue message.
- class aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_issue.V20CredIssue(_id: Optional[str] = None, *, replacement_id: Optional[str] = None, comment: Optional[str] = None, formats: Optional[Sequence[V20CredFormat]] = None, credentials_attach: Optional[Sequence[AttachDecorator]] = None, **kwargs)[source]
Bases:
AgentMessage
Credential issue message.
- class aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_issue.V20CredIssueSchema(*args: Any, **kwargs: Any)[source]
Bases:
AgentMessageSchema
Credential issue schema.
- class Meta[source]
Bases:
object
Credential issue schema metadata.
- model_class
alias of
V20CredIssue
- credentials_attach
alias of
AttachDecoratorSchema
- formats
alias of
V20CredFormatSchema
- validate_fields(data, **kwargs)
Validate attachments per format.
aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_offer module
Credential offer message.
- class aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_offer.V20CredOffer(_id: Optional[str] = None, *, replacement_id: Optional[str] = None, comment: Optional[str] = None, credential_preview: Optional[V20CredPreview] = None, formats: Optional[Sequence[V20CredFormat]] = None, offers_attach: Optional[Sequence[AttachDecorator]] = None, **kwargs)[source]
Bases:
AgentMessage
Credential offer.
- class aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_offer.V20CredOfferSchema(*args: Any, **kwargs: Any)[source]
Bases:
AgentMessageSchema
Credential offer schema.
- class Meta[source]
Bases:
object
Credential offer schema metadata.
- model_class
alias of
V20CredOffer
- credential_preview
alias of
V20CredPreviewSchema
- formats
alias of
V20CredFormatSchema
- offers_attach
alias of
AttachDecoratorSchema
- validate_fields(data, **kwargs)
Validate attachments per format.
aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_problem_report module
A problem report message.
- class aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_problem_report.ProblemReportReason(value)[source]
Bases:
Enum
Supported reason codes.
- ISSUANCE_ABANDONED = 'issuance-abandoned'
- RECORD_NOT_FOUND = 'record-not-found'
- class aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_problem_report.V20CredProblemReport(*args, **kwargs)[source]
Bases:
ProblemReport
Class representing a problem report message.
- class aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_problem_report.V20CredProblemReportSchema(*args: Any, **kwargs: Any)[source]
Bases:
ProblemReportSchema
Problem report schema.
- class Meta[source]
Bases:
object
Schema metadata.
- model_class
alias of
V20CredProblemReport
- validate_fields(data, **kwargs)
Validate schema fields.
- Parameters
data – The data to validate
aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_proposal module
Credential proposal message.
- class aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_proposal.V20CredProposal(_id: Optional[str] = None, *, comment: Optional[str] = None, credential_preview: Optional[V20CredPreview] = None, formats: Optional[Sequence[V20CredFormat]] = None, filters_attach: Optional[Sequence[AttachDecorator]] = None, **kwargs)[source]
Bases:
AgentMessage
Credential proposal.
- class aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_proposal.V20CredProposalSchema(*args: Any, **kwargs: Any)[source]
Bases:
AgentMessageSchema
Credential proposal schema.
- class Meta[source]
Bases:
object
Credential proposal schema metadata.
- model_class
alias of
V20CredProposal
- credential_preview
alias of
V20CredPreviewSchema
- filters_attach
alias of
AttachDecoratorSchema
- formats
alias of
V20CredFormatSchema
- validate_fields(data, **kwargs)
Validate attachments per format.
aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_request module
Credential request message.
- class aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_request.V20CredRequest(_id: Optional[str] = None, *, comment: Optional[str] = None, formats: Optional[Sequence[V20CredFormat]] = None, requests_attach: Optional[Sequence[AttachDecorator]] = None, **kwargs)[source]
Bases:
AgentMessage
Credential request.
- class aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_request.V20CredRequestSchema(*args: Any, **kwargs: Any)[source]
Bases:
AgentMessageSchema
Credential request schema.
- class Meta[source]
Bases:
object
Credential request schema metadata.
- model_class
alias of
V20CredRequest
- formats
alias of
V20CredFormatSchema
- requests_attach
alias of
AttachDecoratorSchema
- validate_fields(data, **kwargs)
Validate attachments per format.