Source code for acapy_agent.protocols.introduction.v0_1.messages.invitation_request

"""Represents an request for an invitation from the introduction service."""

from typing import Optional

from marshmallow import EXCLUDE, fields

from .....messaging.agent_message import AgentMessage, AgentMessageSchema
from ..message_types import INVITATION_REQUEST, PROTOCOL_PACKAGE

HANDLER_CLASS = (
    f"{PROTOCOL_PACKAGE}.handlers.invitation_request_handler.InvitationRequestHandler"
)




class InvitationRequest(AgentMessage):
    """Class representing an invitation request."""



    class Meta:
        """Metadata for an invitation request."""

        handler_class = HANDLER_CLASS
        message_type = INVITATION_REQUEST
        schema_class = "InvitationRequestSchema"


    def __init__(
        self, *, responder: Optional[str] = None, message: Optional[str] = None, **kwargs
    ):
        """Initialize invitation request object.

        Args:
            responder: The name of the agent initiating the introduction
            message: Comments on the introduction
            kwargs: Additional key word arguments for the message

        """
        super().__init__(**kwargs)
        self.responder = responder
        self.message = message





class InvitationRequestSchema(AgentMessageSchema):
    """Invitation request schema class."""



    class Meta:
        """Invitation request schema metadata."""

        model_class = InvitationRequest
        unknown = EXCLUDE


    responder = fields.Str(
        required=True,
        metadata={
            "description": "Agent name initiating the introduction",
            "example": "Alice's agent",
        },
    )
    message = fields.Str(
        required=False,
        allow_none=True,
        metadata={
            "description": "Comments on the introduction",
            "example": "Hello Charlie, it's Alice; allow me to present Bob",
        },
    )