aries_cloudagent.protocols.connections.v1_0.messages package

Submodules

aries_cloudagent.protocols.connections.v1_0.messages.connection_invitation module

Represents an invitation message for establishing connection.

class aries_cloudagent.protocols.connections.v1_0.messages.connection_invitation.ConnectionInvitation(*, label: str = None, did: str = None, recipient_keys: Sequence[str] = None, endpoint: str = None, routing_keys: Sequence[str] = None, image_url: str = None, **kwargs)

Bases: aries_cloudagent.messaging.agent_message.AgentMessage

Class representing a connection invitation.

class Meta

Bases: object

Metadata for a connection invitation.

handler_class = 'aries_cloudagent.protocols.connections.v1_0.handlers.connection_invitation_handler.ConnectionInvitationHandler'

message_type = 'connections/1.0/invitation'

schema_class = 'ConnectionInvitationSchema'

classmethod from_url(url: str) → aries_cloudagent.protocols.connections.v1_0.messages.connection_invitation.ConnectionInvitation

Parse a URL-encoded invitation into a ConnectionInvitation message.

Parameters:url – Url to decode Returns:A ConnectionInvitation object.

to_url(base_url: str = None) → str

Convert an invitation to URL format for sharing.

Returns:An invite url

class aries_cloudagent.protocols.connections.v1_0.messages.connection_invitation.ConnectionInvitationSchema(*args, **kwargs)

Bases: aries_cloudagent.messaging.agent_message.AgentMessageSchema

Connection invitation schema class.

class Meta

Bases: object

Connection invitation schema metadata.

model_class

alias of ConnectionInvitation

unknown = 'exclude'

did = <fields.String(default=<marshmallow.missing>, attribute=None, validate=<aries_cloudagent.messaging.valid.IndyDID 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.'})>

endpoint = <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.'})>

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

label = <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.'})>

recipient_keys = <fields.List(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 list.'})>

routing_keys = <fields.List(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 list.'})>

validate_fields(data, **kwargs)

Validate schema fields.

Parameters:data – The data to validate Raises:ValidationError – If any of the fields do not validate

aries_cloudagent.protocols.connections.v1_0.messages.connection_request module

Represents a connection request message.

class aries_cloudagent.protocols.connections.v1_0.messages.connection_request.ConnectionRequest(*, connection: aries_cloudagent.protocols.connections.v1_0.models.connection_detail.ConnectionDetail = None, label: str = None, image_url: str = None, **kwargs)

Bases: aries_cloudagent.messaging.agent_message.AgentMessage

Class representing a connection request.

class Meta

Bases: object

Metadata for a connection request.

handler_class = 'aries_cloudagent.protocols.connections.v1_0.handlers.connection_request_handler.ConnectionRequestHandler'

message_type = 'connections/1.0/request'

schema_class = 'ConnectionRequestSchema'

class aries_cloudagent.protocols.connections.v1_0.messages.connection_request.ConnectionRequestSchema(*args, **kwargs)

Bases: aries_cloudagent.messaging.agent_message.AgentMessageSchema

Connection request schema class.

class Meta

Bases: object

Connection request schema metadata.

model_class

alias of ConnectionRequest

unknown = 'exclude'

connection = <fields.Nested(default=<marshmallow.missing>, attribute=None, validate=None, required=True, 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.', 'type': 'Invalid type.'})>

image_url = <fields.String(default=<marshmallow.missing>, attribute=None, validate=None, required=False, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=True, 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.'})>

label = <fields.String(default=<marshmallow.missing>, attribute=None, validate=None, required=True, 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.'})>

aries_cloudagent.protocols.connections.v1_0.messages.connection_response module

Represents a connection response message.

class aries_cloudagent.protocols.connections.v1_0.messages.connection_response.ConnectionResponse(*, connection: aries_cloudagent.protocols.connections.v1_0.models.connection_detail.ConnectionDetail = None, **kwargs)

Bases: aries_cloudagent.messaging.agent_message.AgentMessage

Class representing a connection response.

class Meta

Bases: object

Metadata for a connection response.

handler_class = 'aries_cloudagent.protocols.connections.v1_0.handlers.connection_response_handler.ConnectionResponseHandler'

message_type = 'connections/1.0/response'

schema_class = 'ConnectionResponseSchema'

class aries_cloudagent.protocols.connections.v1_0.messages.connection_response.ConnectionResponseSchema(*args, **kwargs)

Bases: aries_cloudagent.messaging.agent_message.AgentMessageSchema

Connection response schema class.

class Meta

Bases: object

Connection response schema metadata.

model_class

alias of ConnectionResponse

signed_fields = ('connection',)

unknown = 'exclude'

connection = <fields.Nested(default=<marshmallow.missing>, attribute=None, validate=None, required=True, 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.', 'type': 'Invalid type.'})>

aries_cloudagent.protocols.connections.v1_0.messages.problem_report module

Represents a connection problem report message.

class aries_cloudagent.protocols.connections.v1_0.messages.problem_report.ProblemReport(*, problem_code: str = None, explain: str = None, **kwargs)

Bases: aries_cloudagent.messaging.agent_message.AgentMessage

Base class representing a connection problem report message.

class Meta

Bases: object

Connection problem report metadata.

handler_class = 'aries_cloudagent.messaging.problem_report.handler.ProblemReportHandler'

message_type = 'connections/1.0/problem_report'

schema_class = 'ProblemReportSchema'

class aries_cloudagent.protocols.connections.v1_0.messages.problem_report.ProblemReportReason

Bases: str, enum.Enum

Supported reason codes.

INVITATION_NOT_ACCEPTED = 'invitation_not_accepted'

REQUEST_NOT_ACCEPTED = 'request_not_accepted'

REQUEST_PROCESSING_ERROR = 'request_processing_error'

RESPONSE_NOT_ACCEPTED = 'response_not_accepted'

RESPONSE_PROCESSING_ERROR = 'response_processing_error'

class aries_cloudagent.protocols.connections.v1_0.messages.problem_report.ProblemReportSchema(*args, **kwargs)

Bases: aries_cloudagent.messaging.agent_message.AgentMessageSchema

Schema for ProblemReport base class.

class Meta

Bases: object

Metadata for problem report schema.

model_class

alias of ProblemReport

unknown = 'exclude'

explain = <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.'})>

problem_code = <fields.String(default=<marshmallow.missing>, attribute=None, validate=<OneOf(choices=['invitation_not_accepted', 'request_not_accepted', 'request_processing_error', 'response_not_accepted', 'response_processing_error'], labels=[], error='Value {input} must be one of {choices}.')>, 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.'})>