aries_cloudagent.protocols.issue_credential.v2_0.models.detail package

Submodules

aries_cloudagent.protocols.issue_credential.v2_0.models.detail.dif module

DIF-specific credential exchange information with non-secrets storage.

class aries_cloudagent.protocols.issue_credential.v2_0.models.detail.dif.V20CredExRecordDIF(cred_ex_dif_id: str = None, *, cred_ex_id: str = None, item: str = None, **kwargs)

Bases: aries_cloudagent.messaging.models.base_record.BaseRecord

Credential exchange DIF detail record.

class Meta

Bases: object

V20CredExRecordDIF metadata.

schema_class = 'V20CredExRecordDIFSchema'

RECORD_ID_NAME = 'cred_ex_dif_id'

RECORD_TYPE = 'dif_cred_ex_v20'

TAG_NAMES = {'cred_ex_id'}

WEBHOOK_TOPIC = 'issue_credential_v2_0_dif'

cred_ex_dif_id

Accessor for the ID associated with this exchange.

record_value

Accessor for the JSON record value generated for this credential exchange.

classmethod retrieve_by_cred_ex_id(session: aries_cloudagent.core.profile.ProfileSession, cred_ex_id: str) → aries_cloudagent.protocols.issue_credential.v2_0.models.detail.dif.V20CredExRecordDIF

Retrieve a credential exchange DIF detail record by its cred ex id.

class aries_cloudagent.protocols.issue_credential.v2_0.models.detail.dif.V20CredExRecordDIFSchema(*args, **kwargs)

Bases: aries_cloudagent.messaging.models.base_record.BaseRecordSchema

Credential exchange DIF detail record detail schema.

class Meta

Bases: object

Credential exchange DIF detail record schema metadata.

model_class

alias of V20CredExRecordDIF

unknown = 'exclude'

cred_ex_dif_id = <fields.String(default=<marshmallow.missing>, attribute=None, validate=None, required=False, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=False, error_messages={'required': 'Missing data for required field.', 'null': 'Field may not be null.', 'validator_failed': 'Invalid value.', 'invalid': 'Not a valid string.', 'invalid_utf8': 'Not a valid utf-8 string.'})>

cred_ex_id = <fields.String(default=<marshmallow.missing>, attribute=None, validate=None, required=False, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=False, error_messages={'required': 'Missing data for required field.', 'null': 'Field may not be null.', 'validator_failed': 'Invalid value.', 'invalid': 'Not a valid string.', 'invalid_utf8': 'Not a valid utf-8 string.'})>

item = <fields.Dict(default=<marshmallow.missing>, attribute=None, validate=None, required=False, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=False, error_messages={'required': 'Missing data for required field.', 'null': 'Field may not be null.', 'validator_failed': 'Invalid value.', 'invalid': 'Not a valid mapping type.'})>

aries_cloudagent.protocols.issue_credential.v2_0.models.detail.indy module

Indy-specific credential exchange information with non-secrets storage.

class aries_cloudagent.protocols.issue_credential.v2_0.models.detail.indy.V20CredExRecordIndy(cred_ex_indy_id: str = None, *, cred_ex_id: str = None, cred_request_metadata: Mapping[KT, VT_co] = None, rev_reg_id: str = None, cred_rev_id: str = None, **kwargs)

Bases: aries_cloudagent.messaging.models.base_record.BaseRecord

Credential exchange indy detail record.

class Meta

Bases: object

V20CredExRecordIndy metadata.

schema_class = 'V20CredExRecordIndySchema'

RECORD_ID_NAME = 'cred_ex_indy_id'

RECORD_TYPE = 'indy_cred_ex_v20'

TAG_NAMES = {'cred_ex_id'}

WEBHOOK_TOPIC = 'issue_credential_v2_0_indy'

cred_ex_indy_id

Accessor for the ID associated with this exchange.

record_value

Accessor for the JSON record value generated for this credential exchange.

classmethod retrieve_by_cred_ex_id(session: aries_cloudagent.core.profile.ProfileSession, cred_ex_id: str) → aries_cloudagent.protocols.issue_credential.v2_0.models.detail.indy.V20CredExRecordIndy

Retrieve a credential exchange indy detail record by its cred ex id.

class aries_cloudagent.protocols.issue_credential.v2_0.models.detail.indy.V20CredExRecordIndySchema(*args, **kwargs)

Bases: aries_cloudagent.messaging.models.base_record.BaseRecordSchema

Credential exchange indy detail record detail schema.

class Meta

Bases: object

Credential exchange indy detail record schema metadata.

model_class

alias of V20CredExRecordIndy

unknown = 'exclude'

cred_ex_id = <fields.String(default=<marshmallow.missing>, attribute=None, validate=None, required=False, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=False, error_messages={'required': 'Missing data for required field.', 'null': 'Field may not be null.', 'validator_failed': 'Invalid value.', 'invalid': 'Not a valid string.', 'invalid_utf8': 'Not a valid utf-8 string.'})>

cred_ex_indy_id = <fields.String(default=<marshmallow.missing>, attribute=None, validate=None, required=False, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=False, error_messages={'required': 'Missing data for required field.', 'null': 'Field may not be null.', 'validator_failed': 'Invalid value.', 'invalid': 'Not a valid string.', 'invalid_utf8': 'Not a valid utf-8 string.'})>

cred_request_metadata = <fields.Dict(default=<marshmallow.missing>, attribute=None, validate=None, required=False, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=False, error_messages={'required': 'Missing data for required field.', 'null': 'Field may not be null.', 'validator_failed': 'Invalid value.', 'invalid': 'Not a valid mapping type.'})>

cred_rev_id = <fields.String(default=<marshmallow.missing>, attribute=None, validate=<aries_cloudagent.messaging.valid.IndyCredRevId object>, required=False, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=False, error_messages={'required': 'Missing data for required field.', 'null': 'Field may not be null.', 'validator_failed': 'Invalid value.', 'invalid': 'Not a valid string.', 'invalid_utf8': 'Not a valid utf-8 string.'})>

rev_reg_id = <fields.String(default=<marshmallow.missing>, attribute=None, validate=<aries_cloudagent.messaging.valid.IndyRevRegId object>, required=False, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=False, error_messages={'required': 'Missing data for required field.', 'null': 'Field may not be null.', 'validator_failed': 'Invalid value.', 'invalid': 'Not a valid string.', 'invalid_utf8': 'Not a valid utf-8 string.'})>