acapy_agent.protocols.coordinate_mediation.v1_0.models package

Submodules

acapy_agent.protocols.coordinate_mediation.v1_0.models.mediation_record module

Store state for Mediation requests.

class acapy_agent.protocols.coordinate_mediation.v1_0.models.mediation_record.MediationRecord(*, mediation_id: str | None = None, state: str | None = None, role: str | None = None, connection_id: str | None = None, routing_keys: Sequence[str] | None = None, endpoint: str | None = None, mediator_terms: Sequence[str] | None = None, recipient_terms: Sequence[str] | None = None, **kwargs)[source]

Bases: BaseRecord

Class representing stored mediation information.

class Meta[source]

Bases: object

RouteRecord metadata.

schema_class = 'MediationRecordSchema'

RECORD_ID_NAME = 'mediation_id'

RECORD_TOPIC: str | None = 'mediation'

RECORD_TYPE = 'mediation_requests'

ROLE_CLIENT = 'client'

ROLE_SERVER = 'server'

STATE_DENIED = 'denied'

STATE_GRANTED = 'granted'

STATE_REQUEST = 'request'

TAG_NAMES = {'connection_id', 'role', 'state'}

async classmethod exists_for_connection_id(session: ProfileSession, connection_id: str) → bool[source]

Return whether a mediation record exists for the given connection.

Parameters:

session (ProfileSession) – session
connection_id (str) – connection_id

Returns:

whether record exists

Return type:

bool

property mediation_id: str: Get Mediation ID.

property record_value: dict: Return values of record as dictionary.

async classmethod retrieve_by_connection_id(session: ProfileSession, connection_id: str) → MediationRecord[source]

Retrieve a mediation record by connection ID.

Parameters:

session (ProfileSession) – session
connection_id (str) – connection_id

Returns:

retrieved record

Return type:

MediationRecord

property state: str: Get Mediation state.

class acapy_agent.protocols.coordinate_mediation.v1_0.models.mediation_record.MediationRecordSchema(*args: Any, **kwargs: Any)[source]

Bases: BaseRecordSchema

MediationRecordSchema schema.

class Meta[source]

Bases: object

MediationRecordSchema metadata.

model_class: alias of MediationRecord