README.md

NovuMessages

(subscribers->messages)

Overview

Available Operations

• updateAsSeen - Mark message action as seen
• markAllAs - Mark a subscriber messages as seen, read, unseen or unread

updateAsSeen

Mark message action as seen

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use novu;
use novu\Models\Components;
use novu\Models\Operations;

$sdk = novu\Novu::builder()
    ->setSecurity(
        '<YOUR_API_KEY_HERE>'
    )
    ->build();

$request = new Operations\SubscribersV1ControllerMarkActionAsSeenRequest(
    messageId: '<id>',
    type: '<value>',
    subscriberId: '<id>',
    markMessageActionAsSeenDto: new Components\MarkMessageActionAsSeenDto(
        status: Components\MarkMessageActionAsSeenDtoStatus::Done,
    ),
);

$response = $sdk->subscribers->messages->updateAsSeen(
    request: $request
);

if ($response->messageResponseDto !== null) {
    // handle response
}

Parameters

Parameter	Type	Required	Description
$request	Operations\SubscribersV1ControllerMarkActionAsSeenRequest	✔️	The request object to use for the request.

Response

?Operations\SubscribersV1ControllerMarkActionAsSeenResponse

Errors

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

markAllAs

Mark a subscriber messages as seen, read, unseen or unread

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use novu;
use novu\Models\Components;

$sdk = novu\Novu::builder()
    ->setSecurity(
        '<YOUR_API_KEY_HERE>'
    )
    ->build();

$messageMarkAsRequestDto = new Components\MessageMarkAsRequestDto(
    messageId: '<id>',
    markAs: Components\MarkAs::Unread,
);

$response = $sdk->subscribers->messages->markAllAs(
    subscriberId: '<id>',
    messageMarkAsRequestDto: $messageMarkAsRequestDto,
    idempotencyKey: '<value>'

);

if ($response->messageResponseDtos !== null) {
    // handle response
}

Parameters

Parameter	Type	Required	Description
subscriberId	string	✔️	N/A
messageMarkAsRequestDto	Components\MessageMarkAsRequestDto	✔️	N/A
idempotencyKey	?string	➖	A header for idempotency purposes

Response

?Operations\SubscribersV1ControllerMarkMessagesAsResponse

Errors

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