Notification Service¶

CLASS	DESCRIPTION
`NotificationService`	Python interface for Planka NotificationServices

NotificationService ¶

NotificationService(schema: Schema, session: Planka)

Bases: PlankaModel[NotificationService]

Python interface for Planka NotificationServices

Returned by:

Plankapy v2 models
- Project Project notification_services
- User User

Used by:

Plankapy v2 models User User
- add_notification_service
- delete_notification_service

METHOD	DESCRIPTION
`copy`	Create a deepcopy of the model and its associated schema.
`delete`	Delete the NotificationService
`diff`	Get a schema diff between two model schemas.
`sync`	Sync the NotificationService with the Planka server
`update`	Update the NotificationService

ATTRIBUTE	DESCRIPTION
`__formatter__`	Formatter func that allows overriding str behavior for models TYPE: `ModelFormatter[Self]`
`board`	The Board the NotificationService is associated with TYPE: `Board`
`created_at`	When the NotificationService was created TYPE: `datetime`
`format`	Format for notification messages TYPE: `NotificationServiceFormat`
`updated_at`	When the NotificationService was last updated TYPE: `datetime`
`url`	URL endpoint for Notifications TYPE: `str`
`user`	The User the NotificationService is associated with TYPE: `User`

Source code in src/plankapy/v2/models/_base.py

def __init__(self, schema: Schema, session: Planka) -> None:
    self._schema = schema
    self.session = session
    self.endpoints = session.endpoints
    self.client = session.client
    self.current_role = session.current_role
    self.current_id = session.current_id

formatter `class-attribute` `instance-attribute` ¶

__formatter__: ModelFormatter[Self] = DEFAULT_FORMATTER

Formatter func that allows overriding str behavior for models

board `property` ¶

board: Board

The Board the NotificationService is associated with

created_at `property` ¶

created_at: datetime

When the NotificationService was created

format `property` `writable` ¶

format: NotificationServiceFormat

Format for notification messages

updated_at `property` ¶

updated_at: datetime

When the NotificationService was last updated

url `property` `writable` ¶

url: str

URL endpoint for Notifications

user `property` ¶

user: User

The User the NotificationService is associated with

copy ¶

copy() -> Self

Create a deepcopy of the model and its associated schema.

Note

Since the endpoints for both instances of the Model are the same, any calls to update will restore the state and bring both copies into sync. copies like this are meant more for comparing changes when running a sync or update/assignemnt operation.

Example:

    >>> card_copy = card.copy()
    >>> card.name = 'Updated Name'
    >>> card_copy.name
    'Original Name'
    >>> card.name
    'Updated Name'
    >>> # This update may have had side effects
    >>> print(card_copy.diff(card))
    {'name': ('Original Name', 'Updated Name'), 'updatedAt': ('...2:00pm', '...2:45pm'), ...}

Source code in src/plankapy/v2/models/_base.py

def copy(self) -> Self:
    """Create a deepcopy of the model and its associated schema.

    Note:
        Since the endpoints for both instances of the Model are the same, any 
        calls to update will restore the state and bring both copies into sync. 
        copies like this are meant more for comparing changes when running a sync 
        or update/assignemnt operation.

    Example:
    ```python
        >>> card_copy = card.copy()
        >>> card.name = 'Updated Name'
        >>> card_copy.name
        'Original Name'
        >>> card.name
        'Updated Name'
        >>> # This update may have had side effects
        >>> print(card_copy.diff(card))
        {'name': ('Original Name', 'Updated Name'), 'updatedAt': ('...2:00pm', '...2:45pm'), ...}
    ```
    """
    return copy.deepcopy(self)

delete ¶

delete()

Delete the NotificationService

Source code in src/plankapy/v2/models/notification_service.py

def delete(self):
    """Delete the NotificationService"""
    self.endpoints.deleteNotificationService(self.id)

diff ¶

diff(other: PlankaModel[Schema]) -> Diff

Get a schema diff between two model schemas.

Note

Only matching keys are diffed. Any schema keys that are not in the source schema will not be checked in the target schema

Source code in src/plankapy/v2/models/_base.py

def diff(self, other: PlankaModel[Schema]) -> Diff:
    """Get a schema diff between two model schemas.

    Note:
        Only matching keys are diffed. Any schema keys that are not in the source schema 
        will not be checked in the target schema
    """
    return {
        k: (source, delta) 
        for k, source in self.schema
        if k in other.schema
        and (delta := other.schema[k]) 
        and delta != source
    }

sync ¶

sync()

Sync the NotificationService with the Planka server

Source code in src/plankapy/v2/models/notification_service.py

def sync(self):
    """Sync the NotificationService with the Planka server"""
    _nss = [ns for ns in self.board.project.notification_services if ns == self]
    if _nss:
        self.schema = _nss.pop().schema

update ¶

update(**kwargs: Unpack[Request_updateNotificationService])

Update the NotificationService

Source code in src/plankapy/v2/models/notification_service.py

def update(self, **kwargs: Unpack[paths.Request_updateNotificationService]):
    """Update the NotificationService"""
    self.schema = self.endpoints.updateNotificationService(self.id, **kwargs)['item']

Notification Service¶