aries_cloudagent.protocols.issue_credential.v1_0.messages package

Subpackages

aries_cloudagent.protocols.issue_credential.v1_0.messages.inner package
- Submodules
- aries_cloudagent.protocols.issue_credential.v1_0.messages.inner.credential_preview module

Submodules

aries_cloudagent.protocols.issue_credential.v1_0.messages.credential_ack module

A credential ack message.

class aries_cloudagent.protocols.issue_credential.v1_0.messages.credential_ack.CredentialAck(**kwargs)[source]

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

Class representing a credential ack message.

class Meta[source]

Bases: object

Credential ack metadata.

handler_class = 'aries_cloudagent.protocols.issue_credential.v1_0.handlers.credential_ack_handler.CredentialAckHandler'

message_type = 'issue-credential/1.0/ack'

schema_class = 'CredentialAckSchema'

class aries_cloudagent.protocols.issue_credential.v1_0.messages.credential_ack.CredentialAckSchema(*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.v1_0.messages.credential_ack.CredentialAck

aries_cloudagent.protocols.issue_credential.v1_0.messages.credential_exchange_webhook module

v1.0 credential exchange webhook.

class aries_cloudagent.protocols.issue_credential.v1_0.messages.credential_exchange_webhook.V10CredentialExchangeWebhook(**kwargs)[source]

Bases: object

Class representing a state only credential exchange webhook.

aries_cloudagent.protocols.issue_credential.v1_0.messages.credential_issue module

A credential content message.

class aries_cloudagent.protocols.issue_credential.v1_0.messages.credential_issue.CredentialIssue(_id: Optional[str] = None, *, comment: Optional[str] = None, credentials_attach: Optional[Sequence[aries_cloudagent.messaging.decorators.attach_decorator.AttachDecorator]] = None, **kwargs)[source]

Bases: aries_cloudagent.messaging.agent_message.AgentMessage

Class representing a credential.

class Meta[source]

Bases: object

Credential metadata.

handler_class = 'aries_cloudagent.protocols.issue_credential.v1_0.handlers.credential_issue_handler.CredentialIssueHandler'

message_type = 'issue-credential/1.0/issue-credential'

schema_class = 'CredentialIssueSchema'

indy_credential(index: int = 0)[source]

Retrieve and decode indy credential from attachment.

Parameters: index – ordinal in attachment list to decode and return (typically, list has length 1)

classmethod wrap_indy_credential(indy_cred: dict) → aries_cloudagent.messaging.decorators.attach_decorator.AttachDecorator[source]: Convert an indy credential offer to an attachment decorator.

class aries_cloudagent.protocols.issue_credential.v1_0.messages.credential_issue.CredentialIssueSchema(*args: Any, **kwargs: Any)[source]

Bases: marshmallow.

Credential schema.

class Meta[source]

Bases: object

Credential schema metadata.

model_class: alias of aries_cloudagent.protocols.issue_credential.v1_0.messages.credential_issue.CredentialIssue

comment

credentials_attach

aries_cloudagent.protocols.issue_credential.v1_0.messages.credential_offer module

A credential offer content message.

class aries_cloudagent.protocols.issue_credential.v1_0.messages.credential_offer.CredentialOffer(_id: Optional[str] = None, *, comment: Optional[str] = None, credential_preview: Optional[aries_cloudagent.protocols.issue_credential.v1_0.messages.inner.credential_preview.CredentialPreview] = None, offers_attach: Optional[Sequence[aries_cloudagent.messaging.decorators.attach_decorator.AttachDecorator]] = None, **kwargs)[source]

Bases: aries_cloudagent.messaging.agent_message.AgentMessage

Class representing a credential offer.

class Meta[source]

Bases: object

CredentialOffer metadata.

handler_class = 'aries_cloudagent.protocols.issue_credential.v1_0.handlers.credential_offer_handler.CredentialOfferHandler'

message_type = 'issue-credential/1.0/offer-credential'

schema_class = 'CredentialOfferSchema'

indy_offer(index: int = 0) → dict[source]

Retrieve and decode indy offer from attachment.

Parameters: index – ordinal in attachment list to decode and return (typically, list has length 1)

classmethod wrap_indy_offer(indy_offer: dict) → aries_cloudagent.messaging.decorators.attach_decorator.AttachDecorator[source]: Convert an indy credential offer to an attachment decorator.

class aries_cloudagent.protocols.issue_credential.v1_0.messages.credential_offer.CredentialOfferSchema(*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.v1_0.messages.credential_offer.CredentialOffer

comment

credential_preview

offers_attach

aries_cloudagent.protocols.issue_credential.v1_0.messages.credential_problem_report module

A problem report message.

class aries_cloudagent.protocols.issue_credential.v1_0.messages.credential_problem_report.CredentialProblemReport(*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.v1_0.handlers.credential_problem_report_handler.CredentialProblemReportHandler'

message_type = 'issue-credential/1.0/problem-report'

schema_class = 'CredentialProblemReportSchema'

class aries_cloudagent.protocols.issue_credential.v1_0.messages.credential_problem_report.CredentialProblemReportSchema(*args: Any, **kwargs: Any)[source]

Bases: marshmallow.

Problem report schema.

class Meta[source]

Bases: object

Schema metadata.

model_class: alias of aries_cloudagent.protocols.issue_credential.v1_0.messages.credential_problem_report.CredentialProblemReport

validate_fields(data, **kwargs)

Validate schema fields.

Parameters: data – The data to validate

class aries_cloudagent.protocols.issue_credential.v1_0.messages.credential_problem_report.ProblemReportReason(value)[source]

Bases: enum.Enum

Supported reason codes.

ISSUANCE_ABANDONED = 'issuance-abandoned'

aries_cloudagent.protocols.issue_credential.v1_0.messages.credential_proposal module

A credential proposal content message.

class aries_cloudagent.protocols.issue_credential.v1_0.messages.credential_proposal.CredentialProposal(_id: Optional[str] = None, *, comment: Optional[str] = None, credential_proposal: Optional[aries_cloudagent.protocols.issue_credential.v1_0.messages.inner.credential_preview.CredentialPreview] = None, schema_id: Optional[str] = None, schema_issuer_did: Optional[str] = None, schema_name: Optional[str] = None, schema_version: Optional[str] = None, cred_def_id: Optional[str] = None, issuer_did: Optional[str] = None, **kwargs)[source]

Bases: aries_cloudagent.messaging.agent_message.AgentMessage

Class representing a credential proposal.

class Meta[source]

Bases: object

CredentialProposal metadata.

handler_class = 'aries_cloudagent.protocols.issue_credential.v1_0.handlers.credential_proposal_handler.CredentialProposalHandler'

message_type = 'issue-credential/1.0/propose-credential'

schema_class = 'CredentialProposalSchema'

class aries_cloudagent.protocols.issue_credential.v1_0.messages.credential_proposal.CredentialProposalSchema(*args: Any, **kwargs: Any)[source]

Bases: marshmallow.

Credential proposal schema.

class Meta[source]

Bases: object

Credential proposal schema metadata.

model_class: alias of aries_cloudagent.protocols.issue_credential.v1_0.messages.credential_proposal.CredentialProposal

comment

cred_def_id

credential_proposal

issuer_did

schema_id

schema_issuer_did

schema_name

schema_version

aries_cloudagent.protocols.issue_credential.v1_0.messages.credential_request module

A credential request content message.

class aries_cloudagent.protocols.issue_credential.v1_0.messages.credential_request.CredentialRequest(_id: Optional[str] = None, *, comment: Optional[str] = None, requests_attach: Optional[Sequence[aries_cloudagent.messaging.decorators.attach_decorator.AttachDecorator]] = None, **kwargs)[source]

Bases: aries_cloudagent.messaging.agent_message.AgentMessage

Class representing a credential request.

class Meta[source]

Bases: object

CredentialRequest metadata.

handler_class = 'aries_cloudagent.protocols.issue_credential.v1_0.handlers.credential_request_handler.CredentialRequestHandler'

message_type = 'issue-credential/1.0/request-credential'

schema_class = 'CredentialRequestSchema'

indy_cred_req(index: int = 0)[source]

Retrieve and decode indy credential request from attachment.

Parameters: index – ordinal in attachment list to decode and return (typically, list has length 1)

classmethod wrap_indy_cred_req(indy_cred_req: dict) → aries_cloudagent.messaging.decorators.attach_decorator.AttachDecorator[source]: Convert an indy credential request to an attachment decorator.

class aries_cloudagent.protocols.issue_credential.v1_0.messages.credential_request.CredentialRequestSchema(*args: Any, **kwargs: Any)[source]

Bases: marshmallow.

Credential request schema.

class Meta[source]

Bases: object

Credential request schema metadata.

model_class: alias of aries_cloudagent.protocols.issue_credential.v1_0.messages.credential_request.CredentialRequest

comment

requests_attach