aries_cloudagent.protocols.coordinate_mediation.v1_0.messages package

Submodules

aries_cloudagent.protocols.coordinate_mediation.v1_0.messages.keylist module

Response to keylist-query message.

class aries_cloudagent.protocols.coordinate_mediation.v1_0.messages.keylist.Keylist(*, keys: Sequence[str] = None, pagination: aries_cloudagent.protocols.coordinate_mediation.v1_0.messages.inner.keylist_query_paginate.KeylistQueryPaginate = None, **kwargs)[source]

Bases: aries_cloudagent.messaging.agent_message.AgentMessage

Class representing a keylist-query response.

class Meta[source]

Bases: object

Metadata for a keylist query response.

handler_class = 'aries_cloudagent.protocols.coordinate_mediation.v1_0.handlers.keylist_handler.KeylistHandler'
message_type = 'coordinate-mediation/1.0/keylist'
schema_class = 'KeylistSchema'
class aries_cloudagent.protocols.coordinate_mediation.v1_0.messages.keylist.KeylistSchema(*args, **kwargs)[source]

Bases: aries_cloudagent.messaging.agent_message.AgentMessageSchema

Keylist query response schema class.

class Meta[source]

Bases: object

Keylist query response schema metadata.

model_class

alias of Keylist

keys

Used by autodoc_mock_imports.

pagination

Used by autodoc_mock_imports.

aries_cloudagent.protocols.coordinate_mediation.v1_0.messages.keylist_query module

keylist-query message used to request list of keys handled by mediator.

class aries_cloudagent.protocols.coordinate_mediation.v1_0.messages.keylist_query.KeylistQuery(*, filter: dict = None, paginate: aries_cloudagent.protocols.coordinate_mediation.v1_0.messages.inner.keylist_query_paginate.KeylistQueryPaginate = None, **kwargs)[source]

Bases: aries_cloudagent.messaging.agent_message.AgentMessage

Class representing a keylist query message.

class Meta[source]

Bases: object

Metadata for a keylist query.

handler_class = 'aries_cloudagent.protocols.coordinate_mediation.v1_0.handlers.keylist_query_handler.KeylistQueryHandler'
message_type = 'coordinate-mediation/1.0/keylist-query'
schema_class = 'KeylistQuerySchema'
class aries_cloudagent.protocols.coordinate_mediation.v1_0.messages.keylist_query.KeylistQuerySchema(*args, **kwargs)[source]

Bases: aries_cloudagent.messaging.agent_message.AgentMessageSchema

Keylist query schema class.

class Meta[source]

Bases: object

Keylist query schema metadata.

model_class

alias of KeylistQuery

filter

Used by autodoc_mock_imports.

paginate

Used by autodoc_mock_imports.

aries_cloudagent.protocols.coordinate_mediation.v1_0.messages.keylist_update module

keylist-update message used to notify mediator of keylist changes.

class aries_cloudagent.protocols.coordinate_mediation.v1_0.messages.keylist_update.KeylistUpdate(*, updates: Sequence[aries_cloudagent.protocols.coordinate_mediation.v1_0.messages.inner.keylist_update_rule.KeylistUpdateRule] = None, **kwargs)[source]

Bases: aries_cloudagent.messaging.agent_message.AgentMessage

Class representing a keylist update message.

class Meta[source]

Bases: object

Metadata for a keylist update.

handler_class = 'aries_cloudagent.protocols.coordinate_mediation.v1_0.handlers.keylist_update_handler.KeylistUpdateHandler'
message_type = 'coordinate-mediation/1.0/keylist-update'
schema_class = 'KeylistUpdateSchema'
class aries_cloudagent.protocols.coordinate_mediation.v1_0.messages.keylist_update.KeylistUpdateSchema(*args, **kwargs)[source]

Bases: aries_cloudagent.messaging.agent_message.AgentMessageSchema

Keylist update schema class.

class Meta[source]

Bases: object

Keylist update schema metadata.

model_class

alias of KeylistUpdate

updates

Used by autodoc_mock_imports.

aries_cloudagent.protocols.coordinate_mediation.v1_0.messages.keylist_update_response module

Response to keylist-update used to notify mediation client of applied updates.

class aries_cloudagent.protocols.coordinate_mediation.v1_0.messages.keylist_update_response.KeylistUpdateResponse(*, updated: Sequence[aries_cloudagent.protocols.coordinate_mediation.v1_0.messages.inner.keylist_updated.KeylistUpdated] = None, **kwargs)[source]

Bases: aries_cloudagent.messaging.agent_message.AgentMessage

Class representing a keylist update result message.

class Meta[source]

Bases: object

Metadata for a keylist update result.

handler_class = 'aries_cloudagent.protocols.coordinate_mediation.v1_0.handlers.keylist_update_response_handler.KeylistUpdateResponseHandler'
message_type = 'coordinate-mediation/1.0/keylist-update-response'
schema_class = 'KeylistUpdateResponseSchema'
class aries_cloudagent.protocols.coordinate_mediation.v1_0.messages.keylist_update_response.KeylistUpdateResponseSchema(*args, **kwargs)[source]

Bases: aries_cloudagent.messaging.agent_message.AgentMessageSchema

Keylist update result schema class.

class Meta[source]

Bases: object

Keylist update result schema metadata.

model_class

alias of KeylistUpdateResponse

updated

Used by autodoc_mock_imports.

aries_cloudagent.protocols.coordinate_mediation.v1_0.messages.mediate_deny module

mediate-deny message used to notify mediation client of a denied mediation request.

class aries_cloudagent.protocols.coordinate_mediation.v1_0.messages.mediate_deny.MediationDeny(*, mediator_terms: Sequence[str] = None, recipient_terms: Sequence[str] = None, **kwargs)[source]

Bases: aries_cloudagent.messaging.agent_message.AgentMessage

Class representing a mediation deny message.

class Meta[source]

Bases: object

Metadata for a mediation deny.

handler_class = 'aries_cloudagent.protocols.coordinate_mediation.v1_0.handlers.mediation_deny_handler.MediationDenyHandler'
message_type = 'coordinate-mediation/1.0/mediate-deny'
schema_class = 'MediationDenySchema'
class aries_cloudagent.protocols.coordinate_mediation.v1_0.messages.mediate_deny.MediationDenySchema(*args, **kwargs)[source]

Bases: aries_cloudagent.messaging.agent_message.AgentMessageSchema

Mediation grant schema class.

class Meta[source]

Bases: object

Mediation deny schema metadata.

model_class

alias of MediationDeny

mediator_terms

Used by autodoc_mock_imports.

recipient_terms

Used by autodoc_mock_imports.

aries_cloudagent.protocols.coordinate_mediation.v1_0.messages.mediate_grant module

mediate-grant message.

Used to notify mediation client of a granted mediation request.

class aries_cloudagent.protocols.coordinate_mediation.v1_0.messages.mediate_grant.MediationGrant(*, endpoint: str = None, routing_keys: Sequence[str] = None, **kwargs)[source]

Bases: aries_cloudagent.messaging.agent_message.AgentMessage

Class representing a mediation grant message.

class Meta[source]

Bases: object

Metadata for a mediation grant.

handler_class = 'aries_cloudagent.protocols.coordinate_mediation.v1_0.handlers.mediation_grant_handler.MediationGrantHandler'
message_type = 'coordinate-mediation/1.0/mediate-grant'
schema_class = 'MediationGrantSchema'
class aries_cloudagent.protocols.coordinate_mediation.v1_0.messages.mediate_grant.MediationGrantSchema(*args, **kwargs)[source]

Bases: aries_cloudagent.messaging.agent_message.AgentMessageSchema

Mediation grant schema class.

class Meta[source]

Bases: object

Mediation grant schema metadata.

model_class

alias of MediationGrant

endpoint

Used by autodoc_mock_imports.

routing_keys

Used by autodoc_mock_imports.

aries_cloudagent.protocols.coordinate_mediation.v1_0.messages.mediate_request module

mediate-request message used to request mediation from a mediator.

class aries_cloudagent.protocols.coordinate_mediation.v1_0.messages.mediate_request.MediationRequest(*, mediator_terms: Sequence[str] = None, recipient_terms: Sequence[str] = None, **kwargs)[source]

Bases: aries_cloudagent.messaging.agent_message.AgentMessage

Represents a request for mediation.

class Meta[source]

Bases: object

MediationRequest metadata.

handler_class = 'aries_cloudagent.protocols.coordinate_mediation.v1_0.handlers.mediation_request_handler.MediationRequestHandler'
message_type = 'coordinate-mediation/1.0/mediate-request'
schema_class = 'MediationRequestSchema'
class aries_cloudagent.protocols.coordinate_mediation.v1_0.messages.mediate_request.MediationRequestSchema(*args, **kwargs)[source]

Bases: aries_cloudagent.messaging.agent_message.AgentMessageSchema

Mediation request schema class.

class Meta[source]

Bases: object

Mediation request schema metadata.

model_class

alias of MediationRequest

mediator_terms

Used by autodoc_mock_imports.

recipient_terms

Used by autodoc_mock_imports.

aries_cloudagent.protocols.coordinate_mediation.v1_0.messages.problem_report module

Represents a coordinate-mediation problem report message.

class aries_cloudagent.protocols.coordinate_mediation.v1_0.messages.problem_report.CMProblemReport(*args, **kwargs)[source]

Bases: aries_cloudagent.protocols.problem_report.v1_0.message.ProblemReport

Base class representing a coordinate mediation problem report message.

class Meta[source]

Bases: object

CMProblemReport metadata.

handler_class = 'aries_cloudagent.protocols.coordinate_mediation.v1_0.handlers.problem_report_handler.CMProblemReportHandler'
message_type = 'coordinate-mediation/1.0/problem-report'
schema_class = 'CMProblemReportSchema'
class aries_cloudagent.protocols.coordinate_mediation.v1_0.messages.problem_report.CMProblemReportSchema(*args, **kwargs)[source]

Bases: aries_cloudagent.protocols.problem_report.v1_0.message.ProblemReportSchema

Schema for ProblemReport base class.

class Meta[source]

Bases: object

Metadata for problem report schema.

model_class

alias of CMProblemReport

unknown

Used by autodoc_mock_imports.

validate_fields(data, **kwargs)[source]

Validate schema fields.

class aries_cloudagent.protocols.coordinate_mediation.v1_0.messages.problem_report.ProblemReportReason[source]

Bases: enum.Enum

Supported reason codes.

MEDIATION_NOT_GRANTED = 'mediation_not_granted'
MEDIATION_REQUEST_REPEAT = 'request_already_exists_from_connection'