protocol_schemas module

This module implements Marshmallow schemas for deserializing and validating Swaptacular Messaging Protocol messages.

class swpt_pythonlib.protocol_schemas.AccountPurgeMessageSchema(*, only: Optional[Union[Sequence[str], AbstractSet[str]]] = None, exclude: Union[Sequence[str], AbstractSet[str]] = (), many: bool = False, context: dict | None = None, load_only: Union[Sequence[str], AbstractSet[str]] = (), dump_only: Union[Sequence[str], AbstractSet[str]] = (), partial: Optional[Union[bool, Sequence[str], AbstractSet[str]]] = None, unknown: str | None = None)

AccountPurge message schema.

class swpt_pythonlib.protocol_schemas.AccountTransferMessageSchema(*, only: Optional[Union[Sequence[str], AbstractSet[str]]] = None, exclude: Union[Sequence[str], AbstractSet[str]] = (), many: bool = False, context: dict | None = None, load_only: Union[Sequence[str], AbstractSet[str]] = (), dump_only: Union[Sequence[str], AbstractSet[str]] = (), partial: Optional[Union[bool, Sequence[str], AbstractSet[str]]] = None, unknown: str | None = None)

AccountTransfer message schema.

class swpt_pythonlib.protocol_schemas.AccountUpdateMessageSchema(*, only: Optional[Union[Sequence[str], AbstractSet[str]]] = None, exclude: Union[Sequence[str], AbstractSet[str]] = (), many: bool = False, context: dict | None = None, load_only: Union[Sequence[str], AbstractSet[str]] = (), dump_only: Union[Sequence[str], AbstractSet[str]] = (), partial: Optional[Union[bool, Sequence[str], AbstractSet[str]]] = None, unknown: str | None = None)

AccountUpdate message schema.

class swpt_pythonlib.protocol_schemas.ConfigureAccountMessageSchema(*, only: Optional[Union[Sequence[str], AbstractSet[str]]] = None, exclude: Union[Sequence[str], AbstractSet[str]] = (), many: bool = False, context: dict | None = None, load_only: Union[Sequence[str], AbstractSet[str]] = (), dump_only: Union[Sequence[str], AbstractSet[str]] = (), partial: Optional[Union[bool, Sequence[str], AbstractSet[str]]] = None, unknown: str | None = None)

ConfigureAccount message schema.

class swpt_pythonlib.protocol_schemas.FinalizeTransferMessageSchema(*, only: Optional[Union[Sequence[str], AbstractSet[str]]] = None, exclude: Union[Sequence[str], AbstractSet[str]] = (), many: bool = False, context: dict | None = None, load_only: Union[Sequence[str], AbstractSet[str]] = (), dump_only: Union[Sequence[str], AbstractSet[str]] = (), partial: Optional[Union[bool, Sequence[str], AbstractSet[str]]] = None, unknown: str | None = None)

FinalizeTransfer message schema.

class swpt_pythonlib.protocol_schemas.FinalizedTransferMessageSchema(*, only: Optional[Union[Sequence[str], AbstractSet[str]]] = None, exclude: Union[Sequence[str], AbstractSet[str]] = (), many: bool = False, context: dict | None = None, load_only: Union[Sequence[str], AbstractSet[str]] = (), dump_only: Union[Sequence[str], AbstractSet[str]] = (), partial: Optional[Union[bool, Sequence[str], AbstractSet[str]]] = None, unknown: str | None = None)

FinalizedTransfer message schema.

class swpt_pythonlib.protocol_schemas.PendingBalanceChangeMessageSchema(*, only: Optional[Union[Sequence[str], AbstractSet[str]]] = None, exclude: Union[Sequence[str], AbstractSet[str]] = (), many: bool = False, context: dict | None = None, load_only: Union[Sequence[str], AbstractSet[str]] = (), dump_only: Union[Sequence[str], AbstractSet[str]] = (), partial: Optional[Union[bool, Sequence[str], AbstractSet[str]]] = None, unknown: str | None = None)

PendingBalanceChange message schema.

This message type is an extension to the protocol. The message instructs the accounting authority to unconditionally change the balance (the principal amount) on a given account. Normally, the reason for the change is a transfer.

class swpt_pythonlib.protocol_schemas.PrepareTransferMessageSchema(*, only: Optional[Union[Sequence[str], AbstractSet[str]]] = None, exclude: Union[Sequence[str], AbstractSet[str]] = (), many: bool = False, context: dict | None = None, load_only: Union[Sequence[str], AbstractSet[str]] = (), dump_only: Union[Sequence[str], AbstractSet[str]] = (), partial: Optional[Union[bool, Sequence[str], AbstractSet[str]]] = None, unknown: str | None = None)

PrepareTransfer message schema.

class swpt_pythonlib.protocol_schemas.PreparedTransferMessageSchema(*, only: Optional[Union[Sequence[str], AbstractSet[str]]] = None, exclude: Union[Sequence[str], AbstractSet[str]] = (), many: bool = False, context: dict | None = None, load_only: Union[Sequence[str], AbstractSet[str]] = (), dump_only: Union[Sequence[str], AbstractSet[str]] = (), partial: Optional[Union[bool, Sequence[str], AbstractSet[str]]] = None, unknown: str | None = None)

PreparedTransfer message schema.

class swpt_pythonlib.protocol_schemas.RejectedConfigMessageSchema(*, only: Optional[Union[Sequence[str], AbstractSet[str]]] = None, exclude: Union[Sequence[str], AbstractSet[str]] = (), many: bool = False, context: dict | None = None, load_only: Union[Sequence[str], AbstractSet[str]] = (), dump_only: Union[Sequence[str], AbstractSet[str]] = (), partial: Optional[Union[bool, Sequence[str], AbstractSet[str]]] = None, unknown: str | None = None)

RejectedConfig message schema.

class swpt_pythonlib.protocol_schemas.RejectedTransferMessageSchema(*, only: Optional[Union[Sequence[str], AbstractSet[str]]] = None, exclude: Union[Sequence[str], AbstractSet[str]] = (), many: bool = False, context: dict | None = None, load_only: Union[Sequence[str], AbstractSet[str]] = (), dump_only: Union[Sequence[str], AbstractSet[str]] = (), partial: Optional[Union[bool, Sequence[str], AbstractSet[str]]] = None, unknown: str | None = None)

RejectedTransfer message schema.