Action

Bases: Action_

Source code in src/plankapy/interfaces.py

class Action(Action_): 

    @property
    def card(self) -> Card:
        card_route = self.routes.get_card(id=self.cardId)
        return Card(**card_route()['item']).bind(self.routes)

    @property
    def user(self) -> User:
        user_route = self.routes.get_user(id=self.userId)
        return User(**user_route()['item']).bind(self.routes)

    @overload
    def update(self): ...

    @overload
    def update(self, action: Action): ...

    @overload
    def update(self, text: str=None): ...

    def update(self, *args, **kwargs) -> Action:
        overload = parse_overload(
            args, kwargs, 
            model='action', 
            options=('text',),
            noarg=self)

        route = self.routes.patch_comment_action(id=self.id)
        self.__init__(**route(**overload)['item'])
        return self

    def delete(self) -> Action:
        """Deletes the comment action

        Danger:
            This action is irreversible and cannot be undone

        Returns:
            Action: Deleted comment action instance
        """
        self.refresh()
        route = self.routes.delete_comment_action(id=self.id)
        route()
        return self

    def refresh(self) -> None:
        """Refreshes the action data"""
        for action in self.card.comments:
            if action.id == self.id:
                self.__init__(**action)

delete()

Deletes the comment action

Danger

This action is irreversible and cannot be undone

Returns:

Name	Type	Description
Action	Action	Deleted comment action instance

Source code in src/plankapy/interfaces.py

def delete(self) -> Action:
    """Deletes the comment action

    Danger:
        This action is irreversible and cannot be undone

    Returns:
        Action: Deleted comment action instance
    """
    self.refresh()
    route = self.routes.delete_comment_action(id=self.id)
    route()
    return self

refresh()

Refreshes the action data

Source code in src/plankapy/interfaces.py

def refresh(self) -> None:
    """Refreshes the action data"""
    for action in self.card.comments:
        if action.id == self.id:
            self.__init__(**action)