Models

Models will be switched to Pydantic models prior to 1.0 release.

Models (Shared across services)

This is a temporary implementation. A shim-layer to be replaced by Pydantic models pre version 1.0. See: https://docs.pydantic.dev/latest/

Attachment

Stand-In for a future Attachment Model.

Parameters:

Name	Type	Description	Default
id	str	Discord Attachment id	required
url	str	URL to attachment	required
filename	str	Attachment filename	required

Returns:

Type	Description
	None

Source code in services/transceiver/src/transceiver/models.py

class Attachment():
    '''Stand-In for a future Attachment Model.

    Args:
        id (str): Discord Attachment id
        url (str): URL to attachment
        filename (str): Attachment filename

    Returns:
        None
    '''

    id: str  = ''
    url: str  = ''
    filename: str = ''

    def mapping(self) -> dict[str, Any]:
        '''Future proofing this class.

        Returns:
            dict[str, Any]: Dictionary respresentation
        '''
        return {
            'id': self.id,
            'url': self.url,
            'filename': self.filename
        }

mapping()

Future proofing this class.

Returns:

Type	Description
dict[str, Any]	dict[str, Any]: Dictionary respresentation

Source code in services/transceiver/src/transceiver/models.py

def mapping(self) -> dict[str, Any]:
    '''Future proofing this class.

    Returns:
        dict[str, Any]: Dictionary respresentation
    '''
    return {
        'id': self.id,
        'url': self.url,
        'filename': self.filename
    }

Channel

Stand-In for a future Channel Model.

Parameters:

Name	Type	Description	Default
id	str	Discord Channel id	required
server_id	str	Discord Server id	required
name	str	Channel name	required
parse	int	Allow processing messages from channel. 0 or 1.	required
response	int	Allow responding to channel. 0 or 1.	required

Returns:

Type	Description
	None

Source code in services/transceiver/src/transceiver/models.py

class Channel():
    '''Stand-In for a future Channel Model.

    Args:
        id (str): Discord Channel id
        server_id (str): Discord Server id
        name (str): Channel name
        parse (int): Allow processing messages from channel. 0 or 1.
        response (int): Allow responding to channel. 0 or 1.

    Returns:
        None
    '''

    id: str = ''
    name: str = ''
    server_id: str = ''
    parse: int = 1
    respond: int = 1

    def mapping(self) -> dict[str, Any]:
        '''Future proofing this class.

        Returns:
            dict[str, Any]: Dictionary respresentation
        '''
        return {
            'id': self.id,
            'name': self.name,
            'server_id': self.server_id,
            'parse': self.parse,
            'respond': self.respond
        }

mapping()

Future proofing this class.

Returns:

Type	Description
dict[str, Any]	dict[str, Any]: Dictionary respresentation

Source code in services/transceiver/src/transceiver/models.py

def mapping(self) -> dict[str, Any]:
    '''Future proofing this class.

    Returns:
        dict[str, Any]: Dictionary respresentation
    '''
    return {
        'id': self.id,
        'name': self.name,
        'server_id': self.server_id,
        'parse': self.parse,
        'respond': self.respond
    }

Message

Stand-In for a future Message Model.

Source code in services/transceiver/src/transceiver/models.py

class Message():
    '''Stand-In for a future Message Model.

    '''

    JSON_TEMPLATE: dict = {
        'id': None,
        'time': None,
        'content': None,
        'read': None,
        'response': None,
        'origin': {
            'server': {
                'id': None,
                'name': None,
                'channel': {
                    'id': None,
                    'name': None,
                }
            }
        },
        'user': {
            'id': None,
            'bot': 0,
            'name': None,
            'nick': None,
            'avatar': None,
        },
        'objects': {
            'links': [],
            'attachments': []
        }
    }

    def mapping(self) -> dict[str, Any]:
        '''Future proofing this class.

        Returns:
            dict[str, Any]: Dictionary respresentation
        '''
        return self.JSON_TEMPLATE

mapping()

Future proofing this class.

Returns:

Type	Description
dict[str, Any]	dict[str, Any]: Dictionary respresentation

Source code in services/transceiver/src/transceiver/models.py

def mapping(self) -> dict[str, Any]:
    '''Future proofing this class.

    Returns:
        dict[str, Any]: Dictionary respresentation
    '''
    return self.JSON_TEMPLATE

Server

Stand-In for a future Server Model.

Parameters:

Name	Type	Description	Default
id	str	Discord Server id	required
name	str	Channel name	required
parse	int	Allow processing messages from channel. 0 or 1.	required
response	int	Allow responding to channel. 0 or 1.	required

Returns:

Type	Description
	None

Source code in services/transceiver/src/transceiver/models.py

class Server():
    '''Stand-In for a future Server Model.

    Args:
        id (str): Discord Server id
        name (str): Channel name
        parse (int): Allow processing messages from channel. 0 or 1.
        response (int): Allow responding to channel. 0 or 1.

    Returns:
        None
    '''

    id: str = ''
    name: str = ''
    parse: int = 1
    respond: int = 1

    def mapping(self) -> dict[str, Any]:
        '''Future proofing this class.

        Returns:
            dict[str, Any]: Dictionary respresentation
        '''
        return {
            'id': self.id,
            'name': self.name,
            'parse': self.parse,
            'respond': self.respond,
        }

mapping()

Future proofing this class.

Returns:

Type	Description
dict[str, Any]	dict[str, Any]: Dictionary respresentation

Source code in services/transceiver/src/transceiver/models.py

def mapping(self) -> dict[str, Any]:
    '''Future proofing this class.

    Returns:
        dict[str, Any]: Dictionary respresentation
    '''
    return {
        'id': self.id,
        'name': self.name,
        'parse': self.parse,
        'respond': self.respond,
    }

User

Stand-In for a future User Model

Parameters:

Name	Type	Description	Default
id	str	Discord User id	required
name	str	Username	required
parse	int	Allow processing messages from user. 0 or 1.	required
response	int	Allow responding to user. 0 or 1.	required

Returns:

Type	Description
	None

Source code in services/transceiver/src/transceiver/models.py

class User():
    '''Stand-In for a future User Model

    Args:
        id (str): Discord User id
        name (str): Username
        parse (int): Allow processing messages from user. 0 or 1.
        response (int): Allow responding to user. 0 or 1.

    Returns:
        None
    '''

    id = None
    name = None
    parse = 1
    respond = 1

    def mapping(self) -> dict[str, Any]:
        '''Future proofing this class.

        Returns:
            dict[str, Any]: Dictionary respresentation
        '''
        return {
            'id': self.id,
            'name': self.name,
            'parse': self.parse,
            'respond': self.respond
        }

mapping()

Future proofing this class.

Returns:

Type	Description
dict[str, Any]	dict[str, Any]: Dictionary respresentation

Source code in services/transceiver/src/transceiver/models.py

def mapping(self) -> dict[str, Any]:
    '''Future proofing this class.

    Returns:
        dict[str, Any]: Dictionary respresentation
    '''
    return {
        'id': self.id,
        'name': self.name,
        'parse': self.parse,
        'respond': self.respond
    }