Skip to content

README.md

Latest commit

 

History

History
153 lines (110 loc) · 10.4 KB

README.md

File metadata and controls

153 lines (110 loc) · 10.4 KB

SubscribersMessages

Overview

Available Operations

UpdateAction

Update in-app (inbox) notification's action status by its unique key identifier messageId and type field type. type field can be primary or secondary

Example Usage

using Novu;
using Novu.Models.Components;
using Novu.Models.Requests;

var sdk = new NovuSDK(secretKey: "YOUR_SECRET_KEY_HERE");

SubscribersV1ControllerMarkActionAsSeenRequest req = new SubscribersV1ControllerMarkActionAsSeenRequest() {
    MessageId = "<id>",
    Type = "<value>",
    SubscriberId = "<id>",
    MarkMessageActionAsSeenDto = new MarkMessageActionAsSeenDto() {
        Status = MarkMessageActionAsSeenDtoStatus.Pending,
    },
};

var res = await sdk.SubscribersMessages.UpdateActionAsync(req);

// handle response

Parameters

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

Response

SubscribersV1ControllerMarkActionAsSeenResponse

Errors

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

MarkAll

Update all subscriber in-app (inbox) notifications state such as read, unread, seen or unseen by subscriberId.

Example Usage

using Novu;
using Novu.Models.Components;

var sdk = new NovuSDK(secretKey: "YOUR_SECRET_KEY_HERE");

var res = await sdk.SubscribersMessages.MarkAllAsync(
    subscriberId: "<id>",
    markAllMessageAsRequestDto: new MarkAllMessageAsRequestDto() {
        MarkAs = MarkAs.Read,
    }
);

// handle response

Parameters

Parameter Type Required Description
SubscriberId string ✔️ N/A
MarkAllMessageAsRequestDto MarkAllMessageAsRequestDto ✔️ N/A
IdempotencyKey string ➖ A header for idempotency purposes

Response

SubscribersV1ControllerMarkAllUnreadAsReadResponse

Errors

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

MarkAllAs

Update subscriber's multiple in-app (inbox) notifications state such as seen, read, unseen or unread by subscriberId. messageId is of type mongodbId of notifications

Example Usage

using Novu;
using Novu.Models.Components;
using System.Collections.Generic;

var sdk = new NovuSDK(secretKey: "YOUR_SECRET_KEY_HERE");

var res = await sdk.SubscribersMessages.MarkAllAsAsync(
    subscriberId: "<id>",
    messageMarkAsRequestDto: new MessageMarkAsRequestDto() {
        MessageId = MessageId.CreateArrayOfStr(
            new List<string>() {}
        ),
        MarkAs = MessageMarkAsRequestDtoMarkAs.Seen,
    }
);

// handle response

Parameters

Parameter Type Required Description
SubscriberId string ✔️ N/A
MessageMarkAsRequestDto MessageMarkAsRequestDto ✔️ N/A
IdempotencyKey string ➖ A header for idempotency purposes

Response

SubscribersV1ControllerMarkMessagesAsResponse

Errors

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