aries_cloudagent.protocols.issue_credential.v1_0.models package

Package-wide code and data.

Submodules

aries_cloudagent.protocols.issue_credential.v1_0.models.credential_exchange module

Aries#0036 v1.0 credential exchange information with non-secrets storage.

class aries_cloudagent.protocols.issue_credential.v1_0.models.credential_exchange.V10CredentialExchange(*, credential_exchange_id: str = None, connection_id: Optional[str] = None, thread_id: str = None, parent_thread_id: str = None, initiator: str = None, role: str = None, state: str = None, credential_definition_id: str = None, schema_id: str = None, credential_proposal_dict: Union[Mapping, aries_cloudagent.protocols.issue_credential.v1_0.messages.credential_proposal.CredentialProposal] = None, credential_offer_dict: Union[Mapping, aries_cloudagent.protocols.issue_credential.v1_0.messages.credential_offer.CredentialOffer] = None, credential_offer: Union[Mapping, aries_cloudagent.indy.models.cred_abstract.IndyCredAbstract] = None, credential_request: Union[Mapping, aries_cloudagent.indy.models.cred_request.IndyCredRequest] = None, credential_request_metadata: Mapping = None, credential_id: str = None, raw_credential: Union[Mapping, aries_cloudagent.indy.models.cred.IndyCredential] = None, credential: Union[Mapping, aries_cloudagent.indy.models.cred_precis.IndyCredInfo] = None, revoc_reg_id: str = None, revocation_id: str = None, auto_offer: bool = False, auto_issue: bool = False, auto_remove: bool = True, error_msg: str = None, trace: bool = False, **kwargs)

Bases: aries_cloudagent.messaging.models.base_record.BaseExchangeRecord

Represents an Aries#0036 credential exchange.

INITIATOR_EXTERNAL = 'external'

INITIATOR_SELF = 'self'

class Meta

Bases: object

CredentialExchange metadata.

schema_class = 'V10CredentialExchangeSchema'

RECORD_ID_NAME = 'credential_exchange_id'

RECORD_TOPIC = 'issue_credential'

RECORD_TYPE = 'credential_exchange_v10'

ROLE_HOLDER = 'holder'

ROLE_ISSUER = 'issuer'

STATE_ABANDONED = 'abandoned'

STATE_ACKED = 'credential_acked'

STATE_CREDENTIAL_RECEIVED = 'credential_received'

STATE_CREDENTIAL_REVOKED = 'credential_revoked'

STATE_ISSUED = 'credential_issued'

STATE_OFFER_RECEIVED = 'offer_received'

STATE_OFFER_SENT = 'offer_sent'

STATE_PROPOSAL_RECEIVED = 'proposal_received'

STATE_PROPOSAL_SENT = 'proposal_sent'

STATE_REQUEST_RECEIVED = 'request_received'

STATE_REQUEST_SENT = 'request_sent'

TAG_NAMES = {'thread_id'}

credential

Accessor; get deserialized view.

credential_exchange_id

Accessor for the ID associated with this exchange.

credential_offer

Accessor; get deserialized view.

credential_offer_dict

Accessor; get deserialized view.

credential_proposal_dict

Accessor; get deserialized view.

credential_request

Accessor; get deserialized view.

emit_event(session: aries_cloudagent.core.profile.ProfileSession, payload: Any = None)

Emit an event.

Parameters:

• session – The profile session to use
• payload – The event payload

raw_credential

Accessor; get deserialized view.

record_value

Accessor for the JSON record value generated for this invitation.

classmethod retrieve_by_connection_and_thread(session: aries_cloudagent.core.profile.ProfileSession, connection_id: Optional[str], thread_id: str, role: Optional[str] = None, *, for_update=False) → aries_cloudagent.protocols.issue_credential.v1_0.models.credential_exchange.V10CredentialExchange

Retrieve a credential exchange record by connection and thread ID.

save_error_state(session: aries_cloudagent.core.profile.ProfileSession, *, state: str = None, reason: str = None, log_params: Mapping[str, Any] = None, log_override: bool = False)

Save record error state if need be; log and swallow any storage error.

Parameters:

• session – The profile session to use
• reason – A reason to add to the log
• log_params – Additional parameters to log
• override – Override configured logging regimen, print to stderr instead

class aries_cloudagent.protocols.issue_credential.v1_0.models.credential_exchange.V10CredentialExchangeSchema(*args, **kwargs)

Bases: aries_cloudagent.messaging.models.base_record.BaseExchangeSchema

Schema to allow serialization/deserialization of credential exchange records.

class Meta

Bases: object

V10CredentialExchangeSchema metadata.

model_class

alias of V10CredentialExchange

auto_issue

Used by autodoc_mock_imports.

auto_offer

Used by autodoc_mock_imports.

auto_remove

Used by autodoc_mock_imports.

connection_id

Used by autodoc_mock_imports.

credential

Used by autodoc_mock_imports.

credential_definition_id

Used by autodoc_mock_imports.

credential_exchange_id

Used by autodoc_mock_imports.

credential_id

Used by autodoc_mock_imports.

credential_offer

Used by autodoc_mock_imports.

credential_offer_dict

Used by autodoc_mock_imports.

credential_proposal_dict

Used by autodoc_mock_imports.

credential_request

Used by autodoc_mock_imports.

credential_request_metadata

Used by autodoc_mock_imports.

error_msg

Used by autodoc_mock_imports.

initiator

Used by autodoc_mock_imports.

parent_thread_id

Used by autodoc_mock_imports.

raw_credential

Used by autodoc_mock_imports.

revoc_reg_id

Used by autodoc_mock_imports.

revocation_id

Used by autodoc_mock_imports.

role

Used by autodoc_mock_imports.

schema_id

Used by autodoc_mock_imports.

state

Used by autodoc_mock_imports.

thread_id

Used by autodoc_mock_imports.