CardLabel

Bases: CardLabel_

Source code in src/plankapy/interfaces.py

class CardLabel(CardLabel_):

    @property
    def card(self) -> Card:
        """Card the label is attached to

        Returns:
            Card: Card instance
        """
        card_route = self.routes.get_card(id=self.cardId)
        return Card(**card_route()['item']).bind(self.routes)

    @property
    def board(self) -> Board:
        """Board the card belongs to

        Returns:
            Board: Board instance
        """
        board_route = self.routes.get_board(id=self.card.boardId)
        return Board(**board_route()['item']).bind(self.routes)

    @property
    def label(self) -> Label:
        """Label attached to the card

        Returns:
            Label: Label instance
        """
        for label in self.board.labels:
            if label.id == self.labelId:
                return label

    def delete(self) -> tuple[Card, Label]:
        """Deletes the card label relationship

        Danger:
            This action is irreversible and cannot be undone

        Returns:
            tuple[Card, Label]: The card and label that were removed from each other
        """
        self.refresh()
        route = self.routes.delete_card_label(cardId=self.card.id, labelId=self.labelId)
        route()
        return (self.card, self.label)

board property

Board the card belongs to

Returns:

Name	Type	Description
Board	Board	Board instance

card property

Card the label is attached to

Returns:

Name	Type	Description
Card	Card	Card instance

label property

Label attached to the card

Returns:

Name	Type	Description
Label	Label	Label instance

delete()

Deletes the card label relationship

Danger

This action is irreversible and cannot be undone

Returns:

Type	Description
tuple[Card, Label]	tuple[Card, Label]: The card and label that were removed from each other

Source code in src/plankapy/interfaces.py

def delete(self) -> tuple[Card, Label]:
    """Deletes the card label relationship

    Danger:
        This action is irreversible and cannot be undone

    Returns:
        tuple[Card, Label]: The card and label that were removed from each other
    """
    self.refresh()
    route = self.routes.delete_card_label(cardId=self.card.id, labelId=self.labelId)
    route()
    return (self.card, self.label)