Module mydata_did.v1_0.messages.problem_report

Classes

class DataAgreementNegotiationProblemReport (*, problem_code: str = None, explain: str = None, from_did: str = None, to_did: str = None, created_time: str = None, data_agreement_id: str = None, **kwargs)

Base class representing a data agreement negotiation problem report message.

Initialize a DataAgreementNegotiationProblemReport message instance.

Args

explain

The localized error explanation

problem_code

The standard error identifier

from_did

Sender DID

to_did

Receipient DID

created_time

The timestamp of the message

data_agreement_id

The data agreement identifier

Expand source code

class DataAgreementNegotiationProblemReport(AgentMessage):
    """Base class representing a data agreement negotiation problem report message."""

    class Meta:
        """Data agreement negotiation problem report metadata."""

        handler_class = DATA_AGREEMENT_NEGOTIATION_PROBLEM_REPORT_HANDLER_CLASS
        message_type = DATA_AGREEMENT_NEGOTIATION_PROBLEM_REPORT
        schema_class = "DataAgreementNegotiationProblemReportSchema"

    def __init__(
        self,
        *,
        problem_code: str = None,
        explain: str = None,
        from_did: str = None,
        to_did: str = None,
        created_time: str = None,
        data_agreement_id: str = None,
        **kwargs
    ):
        """
        Initialize a DataAgreementNegotiationProblemReport message instance.

        Args:
            explain: The localized error explanation
            problem_code: The standard error identifier
            from_did: Sender DID
            to_did: Receipient DID
            created_time: The timestamp of the message
            data_agreement_id: The data agreement identifier
        """
        super().__init__(**kwargs)
        self.explain = explain
        self.problem_code = problem_code
        self.from_did = from_did
        self.to_did = to_did
        self.created_time = created_time
        self.data_agreement_id = data_agreement_id

Ancestors

• aries_cloudagent.messaging.agent_message.AgentMessage
• aries_cloudagent.messaging.models.base.BaseModel
• abc.ABC

Class variables

var Meta

Data agreement negotiation problem report metadata.

class DataAgreementNegotiationProblemReportReason (value, names=None, *, module=None, qualname=None, type=None, start=1)

Supported reason codes.

Expand source code

class DataAgreementNegotiationProblemReportReason(str, Enum):
    """Supported reason codes."""

    # Trigger when data agreement signature verification fails
    SIGNATURE_VERIFICATION_FAILED = "signature_verification_failed"

    # Trigger when controller (Organisation) DID is not present in remote did registry
    CONTROLLER_DID_INVALID = "controller_did_invalid"

    # Trigger when principle (Data Subject) DID is invalid
    PRINCIPLE_DID_INVALID = "principle_did_invalid"

    # Trigger when data agreement context is invalid
    DATA_AGREEMENT_CONTEXT_INVALID = "data_agreement_context_invalid"

Ancestors

• builtins.str
• enum.Enum

Class variables

var CONTROLLER_DID_INVALID

var DATA_AGREEMENT_CONTEXT_INVALID

var PRINCIPLE_DID_INVALID

var SIGNATURE_VERIFICATION_FAILED

class DataAgreementNegotiationProblemReportSchema (*args, **kwargs)

Data agreement negotiation problem report schema.

Initialize an instance of AgentMessageSchema.

Raises

TypeError

If Meta.model_class has not been set

Expand source code

class DataAgreementNegotiationProblemReportSchema(AgentMessageSchema):
    """
    Data agreement negotiation problem report schema.
    """
    class Meta:
        """Metadata for data agreement negotiation problem report schema."""

        model_class = DataAgreementNegotiationProblemReport
        unknown = EXCLUDE

    from_did = fields.Str(data_key="from", **MYDATA_DID)
    to_did = fields.Str(data_key="to", **MYDATA_DID)
    created_time = fields.Str(data_key="created_time")
    explain = fields.Str(
        required=False,
        description="Localized error explanation",
        example="Invitation not accepted",
    )
    problem_code = fields.Str(
        data_key="problem-code",
        required=False,
        description="Standard error identifier",
        validate=validate.OneOf(
            choices=[
                dapr.value for dapr in DataAgreementNegotiationProblemReportReason],
            error="Value {input} must be one of {choices}.",
        ),
        example=DataAgreementNegotiationProblemReportReason.SIGNATURE_VERIFICATION_FAILED.value,
    )
    data_agreement_id = fields.Str(
        data_key="data-agreement-id",
        required=False,
        description="The data agreement identifier",
        example=UUIDFour.EXAMPLE,
    )

Ancestors

• aries_cloudagent.messaging.agent_message.AgentMessageSchema
• aries_cloudagent.messaging.models.base.BaseModelSchema
• marshmallow.schema.Schema
• marshmallow.base.SchemaABC

Class variables

var Meta

Metadata for data agreement negotiation problem report schema.

var opts

class DataAgreementProblemReport (*, problem_code: str = None, explain: str = None, from_did: str = None, to_did: str = None, created_time: str = None, **kwargs)

Base class representing a data agreement problem report message.

Initialize a DataAgreementProblemReport message instance.

Expand source code

class DataAgreementProblemReport(AgentMessage):
    """Base class representing a data agreement problem report message."""

    class Meta:
        """Data agreement problem report metadata."""

        handler_class = DATA_AGREEMENT_PROBLEM_REPORT_HANDLER_CLASS
        message_type = DATA_AGREEMENT_PROBLEM_REPORT
        schema_class = "DataAgreementProblemReportSchema"

    def __init__(
        self,
        *,
        problem_code: str = None,
        explain: str = None,
        from_did: str = None,
        to_did: str = None,
        created_time: str = None,
        **kwargs
    ):
        """
        Initialize a DataAgreementProblemReport message instance.
        """
        super().__init__(**kwargs)
        self.explain = explain
        self.problem_code = problem_code
        self.from_did = from_did
        self.to_did = to_did
        self.created_time = created_time

Ancestors

• aries_cloudagent.messaging.agent_message.AgentMessage
• aries_cloudagent.messaging.models.base.BaseModel
• abc.ABC

Class variables

var Meta

Data agreement problem report metadata.

class DataAgreementProblemReportReason (value, names=None, *, module=None, qualname=None, type=None, start=1)

Supported reason codes.

Expand source code

class DataAgreementProblemReportReason(str, Enum):
    """Supported reason codes."""

    # Triggered when data agreement was not found.
    DATA_AGREEMENT_NOT_FOUND = "data_agreement_not_found"

    # Triggered when read-data-agreement failed due to processing error.
    READ_DATA_AGREEMENT_FAILED = "read_data_agreement_failed"

Ancestors

• builtins.str
• enum.Enum

Class variables

var DATA_AGREEMENT_NOT_FOUND

var READ_DATA_AGREEMENT_FAILED

class DataAgreementProblemReportSchema (*args, **kwargs)

AgentMessage schema.

Initialize an instance of AgentMessageSchema.

Raises

TypeError

If Meta.model_class has not been set

Expand source code

class DataAgreementProblemReportSchema(AgentMessageSchema):

    class Meta:
        """Metadata for data agreement problem report schema."""

        model_class = DataAgreementProblemReport
        unknown = EXCLUDE

    from_did = fields.Str(data_key="from", **MYDATA_DID)
    to_did = fields.Str(data_key="to", **MYDATA_DID)
    created_time = fields.Str(data_key="created_time")
    explain = fields.Str(
        required=False,
        description="Localized error explanation",
        example="Invitation not accepted",
    )
    problem_code = fields.Str(
        data_key="problem-code",
        required=False,
        description="Standard error identifier",
        validate=validate.OneOf(
            choices=[dapr.value for dapr in DataAgreementProblemReportReason],
            error="Value {input} must be one of {choices}.",
        ),
        example=DataAgreementProblemReportReason.DATA_AGREEMENT_NOT_FOUND.value,
    )

Ancestors

• aries_cloudagent.messaging.agent_message.AgentMessageSchema
• aries_cloudagent.messaging.models.base.BaseModelSchema
• marshmallow.schema.Schema
• marshmallow.base.SchemaABC

Class variables

var Meta

Metadata for data agreement problem report schema.

var opts

class DataAgreementTerminationProblemReport (*, problem_code: str = None, explain: str = None, from_did: str = None, to_did: str = None, created_time: str = None, data_agreement_id: str = None, **kwargs)

Base class representing a data agreement termination problem report message.

Initialize a DataAgreementTerminationProblemReport message instance.

Args

explain

The localized error explanation

problem_code

The standard error identifier

from_did

Sender DID

to_did

Receipient DID

created_time

The timestamp of the message

data_agreement_id

The data agreement identifier

Expand source code

class DataAgreementTerminationProblemReport(AgentMessage):
    """Base class representing a data agreement termination problem report message."""

    class Meta:
        """Data agreement termination problem report metadata."""

        handler_class = DATA_AGREEMENT_TERMINATION_PROBLEM_REPORT_HANDLER_CLASS
        message_type = DATA_AGREEMENT_TERMINATION_PROBLEM_REPORT
        schema_class = "DataAgreementTerminationProblemReportSchema"

    def __init__(
        self,
        *,
        problem_code: str = None,
        explain: str = None,
        from_did: str = None,
        to_did: str = None,
        created_time: str = None,
        data_agreement_id: str = None,
        **kwargs
    ):
        """
        Initialize a DataAgreementTerminationProblemReport message instance.

        Args:
            explain: The localized error explanation
            problem_code: The standard error identifier
            from_did: Sender DID
            to_did: Receipient DID
            created_time: The timestamp of the message
            data_agreement_id: The data agreement identifier
        """
        super().__init__(**kwargs)
        self.explain = explain
        self.problem_code = problem_code
        self.from_did = from_did
        self.to_did = to_did
        self.created_time = created_time
        self.data_agreement_id = data_agreement_id

Ancestors

• aries_cloudagent.messaging.agent_message.AgentMessage
• aries_cloudagent.messaging.models.base.BaseModel
• abc.ABC

Class variables

var Meta

Data agreement termination problem report metadata.

class DataAgreementTerminationProblemReportReason (value, names=None, *, module=None, qualname=None, type=None, start=1)

Supported reason codes.

Expand source code

class DataAgreementTerminationProblemReportReason(str, Enum):
    """Supported reason codes."""

    # Trigger when data agreement signature verification fails.
    SIGNATURE_VERIFICATION_FAILED = "signature_verification_failed"

    # Trigger when data agreement is not found.
    DATA_AGREEMENT_NOT_FOUND = "data_agreement_not_found"

    # Trigger when principle (Data Subject) DID is invalid.
    PRINCIPLE_DID_INVALID = "principle_did_invalid"

Ancestors

• builtins.str
• enum.Enum

Class variables

var DATA_AGREEMENT_NOT_FOUND

var PRINCIPLE_DID_INVALID

var SIGNATURE_VERIFICATION_FAILED

class DataAgreementTerminationProblemReportSchema (*args, **kwargs)

Data agreement termination problem report schema.

Initialize an instance of AgentMessageSchema.

Raises

TypeError

If Meta.model_class has not been set

Expand source code

class DataAgreementTerminationProblemReportSchema(AgentMessageSchema):
    """
    Data agreement termination problem report schema.
    """
    class Meta:
        """Metadata for data agreement termination problem report schema."""

        model_class = DataAgreementTerminationProblemReport
        unknown = EXCLUDE

    from_did = fields.Str(data_key="from", **MYDATA_DID)
    to_did = fields.Str(data_key="to", **MYDATA_DID)
    created_time = fields.Str(data_key="created_time")
    explain = fields.Str(
        required=False,
        description="Localized error explanation",
        example="Invitation not accepted",
    )
    problem_code = fields.Str(
        data_key="problem-code",
        required=False,
        description="Standard error identifier",
        validate=validate.OneOf(
            choices=[
                dapr.value for dapr in DataAgreementTerminationProblemReportReason],
            error="Value {input} must be one of {choices}.",
        ),
        example=DataAgreementTerminationProblemReportReason.SIGNATURE_VERIFICATION_FAILED.value,
    )
    data_agreement_id = fields.Str(
        data_key="data-agreement-id",
        required=False,
        description="The data agreement identifier",
        example=UUIDFour.EXAMPLE,
    )

Ancestors

• aries_cloudagent.messaging.agent_message.AgentMessageSchema
• aries_cloudagent.messaging.models.base.BaseModelSchema
• marshmallow.schema.Schema
• marshmallow.base.SchemaABC

Class variables

var Meta

Metadata for data agreement termination problem report schema.

var opts

class MyDataDIDProblemReportMessage (*, problem_code: str = None, explain: str = None, from_did: str = None, to_did: str = None, created_time: str = None, **kwargs)

Problem report message for MyData DID protocol.

Initialize mydata-did problem report message instance.

Args

problem_code

Reason code for the problem.

explain

Explanation for the problem.

from_did

DID of the sender.

to_did

DID of the receiver.

created_time

Time when the problem report was created.

Expand source code

class MyDataDIDProblemReportMessage(AgentMessage):
    """
    Problem report message for MyData DID protocol.
    """

    class Meta:
        # Handler class that should handle this message
        handler_class = HANDLER_CLASS

        # Message type for this message
        message_type = MYDATA_DID_PROBLEM_REPORT

        # Schema for this message
        schema_class = "MyDataDIDProblemReportMessageSchema"

    def __init__(
        self,
        *,
        problem_code: str = None,
        explain: str = None,
        from_did: str = None,
        to_did: str = None,
        created_time: str = None,
        **kwargs
    ):
        """
        Initialize mydata-did problem report message instance.

        Args:
            problem_code: Reason code for the problem.
            explain: Explanation for the problem.
            from_did: DID of the sender.
            to_did: DID of the receiver.
            created_time: Time when the problem report was created.
        """

        super().__init__(**kwargs)

        # Set attributes
        self.explain = explain
        self.problem_code = problem_code
        self.from_did = from_did
        self.to_did = to_did
        self.created_time = created_time

Ancestors

• aries_cloudagent.messaging.agent_message.AgentMessage
• aries_cloudagent.messaging.models.base.BaseModel
• abc.ABC

Class variables

var Meta

class MyDataDIDProblemReportMessageReason (value, names=None, *, module=None, qualname=None, type=None, start=1)

Supported reason codes for mydata-did message family.

Expand source code

class MyDataDIDProblemReportMessageReason(str, Enum):
    """Supported reason codes for mydata-did message family."""

    # MyData DID exists.
    DID_EXISTS = "mydata_did_exists"

    # DIDComm message body signature verification failed.
    MESSAGE_BODY_SIGNATURE_VERIFICATION_FAILED = "signature_verification_failed"

    # MyData DID not found.
    DID_NOT_FOUND = "mydata_did_not_found"

    # MyData DID revoked.
    DID_REVOKED = "mydata_did_revoked"

Ancestors

• builtins.str
• enum.Enum

Class variables

var DID_EXISTS

var DID_NOT_FOUND

var DID_REVOKED

var MESSAGE_BODY_SIGNATURE_VERIFICATION_FAILED

class MyDataDIDProblemReportMessageSchema (*args, **kwargs)

Schema for mydata-did problem report message.

Initialize an instance of AgentMessageSchema.

Raises

TypeError

If Meta.model_class has not been set

Expand source code

class MyDataDIDProblemReportMessageSchema(AgentMessageSchema):
    """
    Schema for mydata-did problem report message.
    """

    class Meta:
        # Message class this schema is derived from.
        model_class = MyDataDIDProblemReportMessage

        # Unknow fields are excluded.
        unknown = EXCLUDE

    # From DID
    from_did = fields.Str(data_key="from", **MYDATA_DID)

    # To DID
    to_did = fields.Str(data_key="to", **MYDATA_DID)

    # Created time
    created_time = fields.Str(data_key="created_time")

    # Explaination for the problem
    explain = fields.Str(
        required=False,
        description="Localized error explanation",
        example="Invitation not accepted",
    )

    # Reason code for the problem
    problem_code = fields.Str(
        data_key="problem-code",
        required=False,
        description="Standard error identifier",
        validate=validate.OneOf(
            choices=[prr.value for prr in MyDataDIDProblemReportMessageReason],
            error="Value {input} must be one of {choices}.",
        ),
        example=MyDataDIDProblemReportMessageReason.DID_EXISTS.value,
    )

Ancestors

• aries_cloudagent.messaging.agent_message.AgentMessageSchema
• aries_cloudagent.messaging.models.base.BaseModelSchema
• marshmallow.schema.Schema
• marshmallow.base.SchemaABC

Class variables

var Meta

var opts