CardMembership

Bases: CardMembership_

Source code in src/plankapy/interfaces.py

class CardMembership(CardMembership_):

    @property
    def user(self) -> User:
        """User that is a member of the card

        Returns:
            User: User instance
        """
        user_route = self.routes.get_user(id=self.userId)
        return User(**user_route()['item']).bind(self.routes)

    @property
    def card(self) -> Card:
        """Card the user is a member of

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

    def delete(self) -> tuple[User, Card]:
        """Deletes the card membership

        Danger:
            This action is irreversible and cannot be undone

        Returns:
            tuple[User, Card]: The user and card that were removed from each other
        """
        self.refresh()
        route = self.routes.delete_card_membership(id=self.id)
        route()
        return (self.user, self.card)

card property

Card the user is a member of

Returns:

Name	Type	Description
Card	Card	Card instance

user property

User that is a member of the card

Returns:

Name	Type	Description
User	User	User instance

delete()

Deletes the card membership

Danger

This action is irreversible and cannot be undone

Returns:

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

Source code in src/plankapy/interfaces.py

def delete(self) -> tuple[User, Card]:
    """Deletes the card membership

    Danger:
        This action is irreversible and cannot be undone

    Returns:
        tuple[User, Card]: The user and card that were removed from each other
    """
    self.refresh()
    route = self.routes.delete_card_membership(id=self.id)
    route()
    return (self.user, self.card)