Skip to content

Latest commit

 

History

History
89 lines (58 loc) · 4.86 KB

README.md

File metadata and controls

89 lines (58 loc) · 4.86 KB

Notifications

(notifications)

Overview

Available Operations

list

Get notifications

Example Usage

from novu_py import Novu
import os

with Novu(
    api_key=os.getenv("NOVU_API_KEY", ""),
) as novu:

    res = novu.notifications.list()

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
request models.NotificationsControllerListNotificationsRequest ✔️ The request object to use for the request.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.NotificationsControllerListNotificationsResponse

Errors

Error Type Status Code Content Type
models.ErrorDto 400, 404, 409 application/json
models.ValidationErrorDto 422 application/json
models.APIError 4XX, 5XX */*

retrieve

Get notification

Example Usage

from novu_py import Novu
import os

with Novu(
    api_key=os.getenv("NOVU_API_KEY", ""),
) as novu:

    res = novu.notifications.retrieve(notification_id="<id>")

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
notification_id str ✔️ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.NotificationsControllerGetNotificationResponse

Errors

Error Type Status Code Content Type
models.ErrorDto 400, 404, 409 application/json
models.ValidationErrorDto 422 application/json
models.APIError 4XX, 5XX */*