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:
aries_cloudagent.protocols.notification.v1_0.messages.ack.V10Ack
Credential ack.
- class aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_ack.V20CredAckSchema(*args: Any, **kwargs: Any)[source]
Bases:
marshmallow.
Credential ack schema.
- class Meta[source]
Bases:
object
Schema metadata.
- model_class
alias of
aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_ack.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
- property aries
Alias for field number 0
- property detail
Alias for field number 1
- property 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:
aries_cloudagent.messaging.models.base.BaseModel
Issue-credential protocol message attachment format.
- class Format(value)[source]
Bases:
enum.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>)
- 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[aries_cloudagent.protocols.issue_credential.v2_0.models.detail.indy.V20CredExRecordIndy, aries_cloudagent.protocols.issue_credential.v2_0.models.detail.ld_proof.V20CredExRecordLDProof]
Accessor for credential exchange detail class.
- classmethod get(label: Union[str, aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_format.V20CredFormat.Format])[source]
Get format enum for label.
- get_attachment_data(formats: Sequence[aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_format.V20CredFormat], attachments: Sequence[aries_cloudagent.messaging.decorators.attach_decorator.AttachDecorator])[source]
Find attachment of current format, decode and return its content.
- property handler: Type[V20CredFormatHandler]
Accessor for credential exchange format handler.
- class aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_format.V20CredFormatSchema(*args: Any, **kwargs: Any)[source]
Bases:
marshmallow.
Issue-credential protocol message attachment format schema.
- class Meta[source]
Bases:
object
Issue-credential protocol message attachment format schema metadata.
- model_class
alias of
aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_format.V20CredFormat
- attach_id
- format_
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[aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_format.V20CredFormat]] = None, credentials_attach: Optional[Sequence[aries_cloudagent.messaging.decorators.attach_decorator.AttachDecorator]] = None, **kwargs)[source]
Bases:
aries_cloudagent.messaging.agent_message.AgentMessage
Credential issue message.
- class Meta[source]
Bases:
object
V20CredIssue metadata.
- handler_class = 'aries_cloudagent.protocols.issue_credential.v2_0.handlers.cred_issue_handler.V20CredIssueHandler'
- message_type = 'issue-credential/2.0/issue-credential'
- schema_class = 'V20CredIssueSchema'
- attachment(fmt: Optional[aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_format.V20CredFormat.Format] = None) dict [source]
Return attached credential.
- Parameters
fmt – format of attachment in list to decode and return
- class aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_issue.V20CredIssueSchema(*args: Any, **kwargs: Any)[source]
Bases:
marshmallow.
Credential issue schema.
- class Meta[source]
Bases:
object
Credential issue schema metadata.
- model_class
alias of
aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_issue.V20CredIssue
- comment
- credentials_attach
- formats
- replacement_id
- 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[aries_cloudagent.protocols.issue_credential.v2_0.messages.inner.cred_preview.V20CredPreview] = None, formats: Optional[Sequence[aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_format.V20CredFormat]] = None, offers_attach: Optional[Sequence[aries_cloudagent.messaging.decorators.attach_decorator.AttachDecorator]] = None, **kwargs)[source]
Bases:
aries_cloudagent.messaging.agent_message.AgentMessage
Credential offer.
- class Meta[source]
Bases:
object
V20CredOffer metadata.
- handler_class = 'aries_cloudagent.protocols.issue_credential.v2_0.handlers.cred_offer_handler.V20CredOfferHandler'
- message_type = 'issue-credential/2.0/offer-credential'
- schema_class = 'V20CredOfferSchema'
- attachment(fmt: Optional[aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_format.V20CredFormat.Format] = None) dict [source]
Return attached offer.
- Parameters
fmt – format of attachment in list to decode and return
- class aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_offer.V20CredOfferSchema(*args: Any, **kwargs: Any)[source]
Bases:
marshmallow.
Credential offer schema.
- class Meta[source]
Bases:
object
Credential offer schema metadata.
- model_class
alias of
aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_offer.V20CredOffer
- comment
- credential_preview
- formats
- offers_attach
- replacement_id
- 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.Enum
Supported reason codes.
- ISSUANCE_ABANDONED = 'issuance-abandoned'
- class aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_problem_report.V20CredProblemReport(*args, **kwargs)[source]
Bases:
aries_cloudagent.protocols.problem_report.v1_0.message.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:
marshmallow.
Problem report schema.
- 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[aries_cloudagent.protocols.issue_credential.v2_0.messages.inner.cred_preview.V20CredPreview] = None, formats: Optional[Sequence[aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_format.V20CredFormat]] = None, filters_attach: Optional[Sequence[aries_cloudagent.messaging.decorators.attach_decorator.AttachDecorator]] = None, **kwargs)[source]
Bases:
aries_cloudagent.messaging.agent_message.AgentMessage
Credential proposal.
- class Meta[source]
Bases:
object
V20CredProposal metadata.
- handler_class = 'aries_cloudagent.protocols.issue_credential.v2_0.handlers.cred_proposal_handler.V20CredProposalHandler'
- message_type = 'issue-credential/2.0/propose-credential'
- schema_class = 'V20CredProposalSchema'
- attachment(fmt: Optional[aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_format.V20CredFormat.Format] = None) dict [source]
Return attached filter.
- Parameters
fmt – format of attachment in list to decode and return
- class aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_proposal.V20CredProposalSchema(*args: Any, **kwargs: Any)[source]
Bases:
marshmallow.
Credential proposal schema.
- comment
- credential_preview
- filters_attach
- formats
- 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[aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_format.V20CredFormat]] = None, requests_attach: Optional[Sequence[aries_cloudagent.messaging.decorators.attach_decorator.AttachDecorator]] = None, **kwargs)[source]
Bases:
aries_cloudagent.messaging.agent_message.AgentMessage
Credential request.
- class Meta[source]
Bases:
object
V20CredRequest metadata.
- handler_class = 'aries_cloudagent.protocols.issue_credential.v2_0.handlers.cred_request_handler.V20CredRequestHandler'
- message_type = 'issue-credential/2.0/request-credential'
- schema_class = 'V20CredRequestSchema'
- attachment(fmt: Optional[aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_format.V20CredFormat.Format] = None) dict [source]
Return attached credential request.
- Parameters
fmt – format of attachment in list to decode and return
- class aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_request.V20CredRequestSchema(*args: Any, **kwargs: Any)[source]
Bases:
marshmallow.
Credential request schema.
- comment
- formats
- requests_attach
- validate_fields(data, **kwargs)
Validate attachments per format.