Module crowdin_api.api_resources.notifications.resource

Classes

class NotificationResource (requester: APIRequester, project_id: Optional[int] = None, page_size=25)

Resource for Notifications.

Available on both Crowdin and Crowdin Enterprise. send_notification_to_organization_members is Crowdin Enterprise only.

Link to documentation: https://support.crowdin.com/developer/api/v2/#tag/Notifications

Link to documentation for enterprise: https://support.crowdin.com/developer/enterprise/api/v2/#tag/Notifications

Ancestors

• BaseResource

Methods

def send_notification_to_authenticated_user(self, message: str)

Send Notification to Authenticated User

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.notify.post

Link to documentation for enterprise: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.notify.post

def send_notification_to_organization_members(self, request_data: Union[ByUserIdsRequestScheme, ByOrganizationRoleRequestScheme])

Send Notification To Organization Members

Crowdin Enterprise only. Notify organization members by userIds or by role (owner or admin).

Link to documentation (Enterprise): https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.notify.post

def send_notification_to_project_members(self, request_data: Union[ByUserIdsRequestScheme, ByRoleRequestScehme], projectId: Optional[int] = None)

Send Notification To Project Members

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.projects.notify.post

Link to documentation (Enterprise): https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.projects.notify.post