Skip to content

Latest commit

 

History

History
142 lines (93 loc) · 9.2 KB

README.md

File metadata and controls

142 lines (93 loc) · 9.2 KB

Messages

(messages)

Overview

A message in Novu represents a notification delivered to a recipient on a particular channel. Messages contain information about the request that triggered its delivery, a view of the data sent to the recipient, and a timeline of its lifecycle events. Learn more about messages. https://docs.novu.co/workflows/messages

Available Operations

retrieve

Returns a list of messages, could paginate using the page query parameter

Example Usage

from novu_py import Novu


with Novu(
    secret_key="YOUR_SECRET_KEY_HERE",
) as novu:

    res = novu.messages.retrieve(request={})

    # Handle response
    print(res)

Parameters

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

Response

models.MessagesControllerGetMessagesResponse

Errors

Error Type Status Code Content Type
models.ErrorDto 414 application/json
models.ErrorDto 400, 401, 403, 404, 405, 409, 413, 415 application/json
models.ValidationErrorDto 422 application/json
models.ErrorDto 500 application/json
models.APIError 4XX, 5XX */*

delete

Deletes a message entity from the Novu platform

Example Usage

from novu_py import Novu


with Novu(
    secret_key="YOUR_SECRET_KEY_HERE",
) as novu:

    res = novu.messages.delete(message_id="<id>")

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
message_id str ✔️ N/A
idempotency_key Optional[str] ➖ A header for idempotency purposes
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.MessagesControllerDeleteMessageResponse

Errors

Error Type Status Code Content Type
models.ErrorDto 414 application/json
models.ErrorDto 400, 401, 403, 404, 405, 409, 413, 415 application/json
models.ValidationErrorDto 422 application/json
models.ErrorDto 500 application/json
models.APIError 4XX, 5XX */*

delete_by_transaction_id

Deletes messages entity from the Novu platform using TransactionId of message

Example Usage

from novu_py import Novu


with Novu(
    secret_key="YOUR_SECRET_KEY_HERE",
) as novu:

    res = novu.messages.delete_by_transaction_id(transaction_id="<id>")

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
transaction_id str ✔️ N/A
channel Optional[models.QueryParamChannel] ➖ The channel of the message to be deleted
idempotency_key Optional[str] ➖ A header for idempotency purposes
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.MessagesControllerDeleteMessagesByTransactionIDResponse

Errors

Error Type Status Code Content Type
models.ErrorDto 414 application/json
models.ErrorDto 400, 401, 403, 404, 405, 409, 413, 415 application/json
models.ValidationErrorDto 422 application/json
models.ErrorDto 500 application/json
models.APIError 4XX, 5XX */*