aries_cloudagent.messaging.credentials.models package¶

Submodules¶

aries_cloudagent.messaging.credentials.models.credential_exchange module¶

Handle credential exchange information interface with non-secrets storage.

class aries_cloudagent.messaging.credentials.models.credential_exchange.CredentialExchange(*, credential_exchange_id: str = None, connection_id: str = None, thread_id: str = None, parent_thread_id: str = None, initiator: str = None, state: str = None, credential_definition_id: str = None, schema_id: str = None, credential_offer: dict = None, credential_request: dict = None, credential_request_metadata: dict = None, credential_id: str = None, raw_credential: dict = None, credential: dict = None, credential_values: dict = None, auto_issue: bool = False, error_msg: str = None, **kwargs)[source]¶

Bases: aries_cloudagent.messaging.models.base_record.BaseRecord

Represents a credential exchange.

INITIATOR_EXTERNAL = 'external'¶

INITIATOR_SELF = 'self'¶

LOG_STATE_FLAG = 'debug.credentials'¶

class Meta[source]¶

Bases: object

CredentialExchange metadata.

schema_class = 'CredentialExchangeSchema'¶

RECORD_ID_NAME = 'credential_exchange_id'¶

RECORD_TYPE = 'credential_exchange'¶

STATE_CREDENTIAL_RECEIVED = 'credential_received'¶

STATE_ISSUED = 'issued'¶

STATE_OFFER_RECEIVED = 'offer_received'¶

STATE_OFFER_SENT = 'offer_sent'¶

STATE_REQUEST_RECEIVED = 'request_received'¶

STATE_REQUEST_SENT = 'request_sent'¶

STATE_STORED = 'stored'¶

WEBHOOK_TOPIC = 'credentials'¶

credential_exchange_id¶: Accessor for the ID associated with this exchange.

record_tags¶: Accessor for the record tags generated for this credential exchange.

record_value¶: Accessor to for the JSON record value props for this credential exchange.

class aries_cloudagent.messaging.credentials.models.credential_exchange.CredentialExchangeSchema(*args, **kwargs)[source]¶

Bases: aries_cloudagent.messaging.models.base_record.BaseRecordSchema

Schema to allow serialization/deserialization of credential exchange records.

class Meta[source]¶

Bases: object

CredentialExchangeSchema metadata.

model_class¶: alias of CredentialExchange

auto_issue¶: 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_request¶: Used by autodoc_mock_imports.

credential_request_metadata¶: Used by autodoc_mock_imports.

credential_values¶: 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.

schema_id¶: Used by autodoc_mock_imports.

state¶: Used by autodoc_mock_imports.

thread_id¶: Used by autodoc_mock_imports.