aries_cloudagent.protocols.issue_credential.v2_0.messages package¶

Subpackages¶

aries_cloudagent.protocols.issue_credential.v2_0.messages.inner package
- Submodules
- aries_cloudagent.protocols.issue_credential.v2_0.messages.inner.cred_preview module

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 Meta[source]¶

Bases: object

Credential ack metadata.

handler_class = 'aries_cloudagent.protocols.issue_credential.v2_0.handlers.cred_ack_handler.V20CredAckHandler'¶

message_type = 'issue-credential/2.0/ack'¶

schema_class = 'V20CredAckSchema'¶

class aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_ack.V20CredAckSchema(*args, **kwargs)[source]¶

Bases: aries_cloudagent.protocols.notification.v1_0.messages.ack.V10AckSchema

Credential ack schema.

class Meta[source]¶

Bases: object

Schema metadata.

model_class¶: alias of V20CredAck

unknown¶: Used by autodoc_mock_imports.

aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_ex_record_webhook module¶

v2.0 credential exchange webhook.

class aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_ex_record_webhook.V20CredExRecordWebhook(**kwargs)[source]¶

Bases: object

Class representing a state only 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: str = None, format_: str = None)[source]¶

Bases: aries_cloudagent.messaging.models.base.BaseModel

Issue-credential protocol message attachment format.

class Format[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>)¶

api¶: Admin API specifier.

aries¶: Aries specifier prefix.

detail¶: Accessor for credential exchange detail class.

get = <bound method V20CredFormat.Format.get of <enum 'Format'>>[source]¶

get_attachment_data(formats: Sequence[V20CredFormat], attachments: Sequence[aries_cloudagent.messaging.decorators.attach_decorator.AttachDecorator])[source]¶: Find attachment of current format, decode and return its content.

handler¶: Accessor for credential exchange format handler.

validate_fields(message_type: str, attachment_data: Mapping)[source]¶: Raise ValidationError for invalid attachment formats.

class Meta[source]¶

Bases: object

Issue-credential protocol message attachment format metadata.

schema_class = 'V20CredFormatSchema'¶

format¶: Return format.

class aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_format.V20CredFormatSchema(*args, **kwargs)[source]¶

Bases: aries_cloudagent.messaging.models.base.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

unknown¶: Used by autodoc_mock_imports.

attach_id¶: Used by autodoc_mock_imports.

format_¶: Used by autodoc_mock_imports.

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: str = None, *, replacement_id: str = None, comment: str = None, formats: Sequence[aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_format.V20CredFormat] = None, credentials_attach: 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: 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, **kwargs)[source]¶

Bases: aries_cloudagent.messaging.agent_message.AgentMessageSchema

Credential issue schema.

class Meta[source]¶

Bases: object

Credential issue schema metadata.

model_class¶: alias of V20CredIssue

unknown¶: Used by autodoc_mock_imports.

comment¶: Used by autodoc_mock_imports.

credentials_attach¶: Used by autodoc_mock_imports.

formats¶: Used by autodoc_mock_imports.

replacement_id¶: Used by autodoc_mock_imports.

validate_fields(data, **kwargs)[source]¶: 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: str = None, *, replacement_id: str = None, comment: str = None, credential_preview: aries_cloudagent.protocols.issue_credential.v2_0.messages.inner.cred_preview.V20CredPreview = None, formats: Sequence[aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_format.V20CredFormat] = None, offers_attach: 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: 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, **kwargs)[source]¶

Bases: aries_cloudagent.messaging.agent_message.AgentMessageSchema

Credential offer schema.

class Meta[source]¶

Bases: object

Credential offer schema metadata.

model_class¶: alias of V20CredOffer

unknown¶: Used by autodoc_mock_imports.

comment¶: Used by autodoc_mock_imports.

credential_preview¶: Used by autodoc_mock_imports.

formats¶: Used by autodoc_mock_imports.

offers_attach¶: Used by autodoc_mock_imports.

replacement_id¶: Used by autodoc_mock_imports.

validate_fields(data, **kwargs)[source]¶: 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[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 Meta[source]¶

Bases: object

Problem report metadata.

handler_class = 'aries_cloudagent.protocols.issue_credential.v2_0.handlers.cred_problem_report_handler.CredProblemReportHandler'¶

message_type = 'issue-credential/2.0/problem-report'¶

schema_class = 'V20CredProblemReportSchema'¶

class aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_problem_report.V20CredProblemReportSchema(*args, **kwargs)[source]¶

Bases: aries_cloudagent.protocols.problem_report.v1_0.message.ProblemReportSchema

Problem report schema.

class Meta[source]¶

Bases: object

Schema metadata.

model_class¶: alias of V20CredProblemReport

unknown¶: Used by autodoc_mock_imports.

validate_fields(data, **kwargs)[source]¶

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: str = None, *, comment: str = None, credential_preview: aries_cloudagent.protocols.issue_credential.v2_0.messages.inner.cred_preview.V20CredPreview = None, formats: Sequence[aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_format.V20CredFormat] = None, filters_attach: 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: 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, **kwargs)[source]¶

Bases: aries_cloudagent.messaging.agent_message.AgentMessageSchema

Credential proposal schema.

class Meta[source]¶

Bases: object

Credential proposal schema metadata.

model_class¶: alias of V20CredProposal

unknown¶: Used by autodoc_mock_imports.

comment¶: Used by autodoc_mock_imports.

credential_preview¶: Used by autodoc_mock_imports.

filters_attach¶: Used by autodoc_mock_imports.

formats¶: Used by autodoc_mock_imports.

validate_fields(data, **kwargs)[source]¶: 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: str = None, *, comment: str = None, formats: Sequence[aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_format.V20CredFormat] = None, requests_attach: 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: 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, **kwargs)[source]¶

Bases: aries_cloudagent.messaging.agent_message.AgentMessageSchema

Credential request schema.

class Meta[source]¶

Bases: object

Credential request schema metadata.

model_class¶: alias of V20CredRequest

unknown¶: Used by autodoc_mock_imports.

comment¶: Used by autodoc_mock_imports.

formats¶: Used by autodoc_mock_imports.

requests_attach¶: Used by autodoc_mock_imports.

validate_fields(data, **kwargs)[source]¶: Validate attachments per format.