Some endpoints of the following section can't be hit from this SDK.

We would like to ensure that all endpoints can be hit. For this issue, we would like to build out the Messages

Some of these methods may already exist. 
If so no need to change/update them, just point out that they already exist and we will close the issue.

This is just to bring every SDK we have on par with all the methods available.

Check all the endpoints here and add the missing ones.

Please take this issue as reference novuhq/novu#5005

Also add configurations for the new base URL

Some endpoints of the following section can't be hit from this SDK.

We would like to ensure that all endpoints can be hit. For this issue, we would like to build out the Feeds

Some of these methods may already exist. 
If so no need to change/update them, just point out that they already exist and we will close the issue.

This is just to bring every SDK we have on par with all the methods available.

Check all the endpoints here and add the missing ones.

Some endpoints of the following section can't be hit from this SDK.

We would like to ensure that all endpoints can be hit. For this issue, we would like to build out the Integrations

Some of these methods may already exist. 
If so no need to change/update them, just point out that they already exist and we will close the issue.

This is just to bring every SDK we have on par with all the methods available.

Check all the endpoints here and add the missing ones.

Some endpoints of the following section can't be hit from this SDK.

We would like to ensure that all endpoints can be hit. For this issue, we would like to build out the Layouts

Some of these methods may already exist. 
If so no need to change/update them, just point out that they already exist and we will close the issue.

This is just to bring every SDK we have on par with all the methods available.

Check all the endpoints here and add the missing ones.

Some endpoints of the following section can't be hit from this SDK.

We would like to ensure that all endpoints can be hit. For this issue, we would like to build out the Execution details

Some of these methods may already exist. 
If so no need to change/update them, just point out that they already exist and we will close the issue.

This is just to bring every SDK we have on par with all the methods available.

Check all the endpoints here and add the missing ones.

In order to ensure the stability and reliability of our codebase, it is essential to have automated unit tests running for each push and pull request. Currently, our repository lacks a GitHub Actions workflow to run unit tests, and this needs to be addressed to maintain code quality and catch issues early.

Suggested Solution:

1. Create a new workflow file in .github/workflows/ directory.
   Filename: run-unit-tests.yml

2. Configure the workflow to be triggered on every push and pull_request event to the main branch.

3. Define job steps:
   Checkout the repository.
   Setup the environment/java runtime.
   Install dependencies.
   Run the unit tests.

Some endpoints of the following section can't be hit from this SDK. Please ensure that all the SDK methods are up to date. I'm adding here a list of sections to check/update:

• Notification templates
• Integrations
• Layouts
• Inbound Parse
• Environments
• Changes
• Execution details
• Feeds
• Messages
• Blueprints

Some of these methods already exist. No need to change/update them. This is just to bring every SDK we have on par with all the methods available.

Check all the endpoints here and add the missing ones.

Some endpoints of the following section can't be hit from this SDK.

We would like to ensure that all endpoints can be hit. For this issue, we would like to build out the Blueprints

Some of these methods may already exist. 
If so no need to change/update them, just point out that they already exist and we will close the issue.

This is just to bring every SDK we have on par with all the methods available.

Check all the endpoints here and add the missing ones.

We currently have quickstart guides in different languages.

We need a Kotlin Quickstart. There's a template to follow below:

Get Started with PHP

The blueprints feature is now available on the API.

This SDK needs to be updated to have this feature.

API reference: https://docs.novu.co/api-reference/get-v1blueprintsgroup-by-category

Many kotlin sdk methods are untyped such as co.novu.dto.request.MarkMessageActionAsSeenRequest and
have an Any type or String.

It would make the kotlin sdk more useful and less error prone to use if the types were more strict in this case.

Hey folks, i am trying to write some UTs around my Novu service class. For that i am using mockito to mock the behavior of Novu. However, I am blocked because the APIs are marked as internal which makes is accessible only to its project scope. Any workaround i can do to mock Novu and do something like this:

@Mock
private lateinit var novu: Novu

@InjectMocks
private lateinit var notifService: NotifService

...

@Test
fun `test-success`() = runTest {
    whenever(novu.subscribers()).thenReturn(...)     <---------- this is where it throws NPE because subscriberApi isnt mocked and is internal
    notifService.getSubscribers()
}

why no labels for this repo readme ?

meanwhile all other novu sdk repos have :

I think the kotlin sdk is not completely up to date.

For example co.novu.dto.request.TriggerEventRequestis missing the 'actor' field specified here: https://docs.novu.co/api-reference/events/trigger-event

Certain other fields also seem to be missing.

In order to enhance the resilience and reliability of our SDK, we would like to introduce an Exponential Retry mechanism for retrying failed requests. Additionally, to ensure the idempotent processing of requests, it's vital to incorporate support for providing an Idempotency Key as per the draft specified in the HTTP Idempotency Key Header Field.

The key requirements for this implementation include:

1. Exponential Retry Mechanism:

   • The SDK should retry failed requests following an exponential backoff strategy to minimize the contention and impact on the systems involved.
   • The SDK should ensure that the retry mechanism is configurable (e.g., max retries, initial delay, maximum delay).

2. Idempotency Key Provisioning:

   • The SDK should allow for either automatic or manual provisioning of an Idempotency Key for each request.
   • The Idempotency Key should conform to either CUID, ULID, or UUID formats as specified in the draft.
   • The Idempotency Key should be included in the HTTP Header as Idempotency-Key and following the standards outlined in the draft.

3. Configuration and Documentation:

   • The SDK should provide configuration options for enabling/disabling the Exponential Retry mechanism and Idempotency Key provisioning.
   • Comprehensive documentation should be provided explaining the configuration options, operational behavior, and the benefits of using the Exponential Retry mechanism along with Idempotency Keys.

Acceptance Criteria:

• Implementation of the Exponential Retry mechanism with configurable parameters.
• Provisioning of Idempotency Keys, either automatically or manually, conforming to specified formats (CUID, ULID, or UUID).
• Adequate unit and integration testing to ensure the robustness and reliability of the implemented features.
• Comprehensive documentation on the usage and configuration of the Exponential Retry mechanism and Idempotency Key provisioning.
• Adherence to the specifications outlined in the HTTP Idempotency Key Header Field draft.

Update: You can reference the go-lang library to keep the method signature and configuration the same.
novuhq/go-novu#62

Please refer to the draft for further details on the HTTP Idempotency Key Header Field and ensure adherence to the specified standards while implementing this feature in the SDK.

https://docs.novu.co/api-reference/subscribers/delete-subscriber-credentials-by-providerid
https://docs.novu.co/api-reference/subscribers/get-subscriber-global-preferences
https://docs.novu.co/api-reference/subscribers/update-subscriber-global-preference

https://docs.novu.co/api-reference/messages/delete-message-by-transactionid

Deprecate:
Create environment
Update environment
Update Widget Settings
Get v1blueprints

Thanks for writing this SDK in Kotlin, it's amazing to see it supported as one of the first languages ❤️

I'm trying to figure out how to send a notification to a topic. In the docs it tells me to do this with the trigger endpoint but none of the constructor methods seems to allow for this input:

to: [{ type: 'Topic', topicKey: topicKey }],

Am I overlooking something or is this something that still needs to be added?

The bulk subscription feature just became available. This SDK needs to be updated to have this feature.

API reference: https://docs.novu.co/api-reference/subscribers/bulk-create-subscribers

This feature is not yet implemented in the SDK. Add the implementation and this should include unit test
API reference: https://docs.novu.co/api-reference/integrations/set-integration-as-primary

This is important because a runBlocking call blocks the current thread which is not efficient. See https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines/run-blocking.html

Some endpoints of the following section can't be hit from this SDK.

We would like to ensure that all endpoints can be hit. For this issue, we would like to build out the Integrations

Some of these methods may already exist. 
If so no need to change/update them, just point out that they already exist and we will close the issue.

This is just to bring every SDK we have on par with all the methods available.

Check all the endpoints here and add the missing ones.

The tenants feature just became available this week in v19 on the UI and API.

This SDK needs to be updated to have this feature.

API reference: https://docs.novu.co/api-reference/tenants/

Take this issue as reference novuhq/novu#4775

Some endpoints of the following section can't be hit from this SDK.

We would like to ensure that all endpoints can be hit. For this issue, we would like to build out the Environments

Some of these methods may already exist. 
If so no need to change/update them, just point out that they already exist and we will close the issue.

This is just to bring every SDK we have on par with all the methods available.

Check all the endpoints here and add the missing ones.

actor and Tenant can either be String or Object

Some endpoints of the following section can't be hit from this SDK.

We would like to ensure that all endpoints can be hit. For this issue, we would like to build out the Changes

Some of these methods may already exist. 
If so no need to change/update them, just point out that they already exist and we will close the issue.

This is just to bring every SDK we have on par with all the methods available.

Check all the endpoints here and add the missing ones.

Some endpoints of the following section can't be hit from this SDK.

We would like to ensure that all endpoints can be hit. For this issue, we would like to build out the Notification templates

Some of these methods may already exist. 
If so no need to change/update them, just point out that they already exist and we will close the issue.

This is just to bring every SDK we have on par with all the methods available.

Check all the endpoints here and add the missing ones.

Some endpoints of the following section can't be hit from this SDK.

We would like to ensure that all endpoints can be hit. For this issue, we would like to build out the Inbound Parse

Some of these methods may already exist. 
If so no need to change/update them, just point out that they already exist and we will close the issue.

This is just to bring every SDK we have on par with all the methods available.

Check all the endpoints here and add the missing ones.

I'm trying to use the Bulk Trigger functionality but I'm running into a 400 HTTP status code. Below is the log of the OkHTTPClient (with some stuff redacted or left out because it's not relevant).

To me it looks like the body should be an object with a key events which contains all the events. Now, the events are on the top level as an array.

--> POST https://api.novu.co/v1/events/trigger/bulk 
Content-Type: application/json; charset=UTF-8 
Content-Length: 195 
Authorization: ApiKey <REDACTED> 
 
[{"to":{"subscriberId":"ac88dd17-32bf-45a6-a863-48961525a87e"},"name":"simple","payload":{"redacted": "redacted"}}] 
--> END POST (195-byte body) 

<-- 400 https://api.novu.co/v1/events/trigger/bulk (694ms) 
date: Fri, 23 Jun 2023 13:24:44 GMT 
content-type: application/json; charset=utf-8 
content-length: 155 
...
 
{"statusCode":400,"message":["events must contain no more than 100 elements","events should not be empty","events must be an array"],"error":"Bad Request"} 
<-- END HTTP (155-byte body) 

When calling the Novu#markSubscriberFeed method with a MarkSubscriberFeedAsRequestthe following exception is thrown:

java.lang.IllegalStateException: Expected BEGIN_OBJECT but was BEGIN_ARRAY at line 1 column 10 path $.data
	at com.google.gson.stream.JsonReader.beginObject(JsonReader.java:395)
	at com.google.gson.internal.bind.ReflectiveTypeAdapterFactory$Adapter.read(ReflectiveTypeAdapterFactory.java:259)
	at com.google.gson.internal.bind.ReflectiveTypeAdapterFactory$1.read(ReflectiveTypeAdapterFactory.java:161)
	at com.google.gson.internal.bind.ReflectiveTypeAdapterFactory$Adapter.read(ReflectiveTypeAdapterFactory.java:266)
	at retrofit2.converter.gson.GsonResponseBodyConverter.convert(GsonResponseBodyConverter.java:40)
	at retrofit2.converter.gson.GsonResponseBodyConverter.convert(GsonResponseBodyConverter.java:27)
	at retrofit2.OkHttpCall.parseResponse(OkHttpCall.java:243)
	at retrofit2.OkHttpCall$1.onResponse(OkHttpCall.java:153)
	at okhttp3.internal.connection.RealCall$AsyncCall.run(RealCall.kt:519)
	at java.base/java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1136)
	at java.base/java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:635)
	at java.base/java.lang.Thread.run(Thread.java:840)

Code snippet used:

 fun markNotificationAs(user: User, messageId: String, isRead: Boolean) {
        val markRequest = MarkSubscriberFeedAsRequest(
            messageId = messageId,
            mark = Mark(read = isRead, seen = true),
        )
        runBlocking {
            novu.markSubscriberFeed(user.id, markRequest)
        }
    }

Add the user-agent request header to every call in this sdk.

Example:

headers: {
Authorization: Bearer ${ApiKey},
"User-Agent": novu/${sdk}@${version},
},

Why? (Context)

Having request headers in the SDKs will help us in monitoring which SDK is mostly used by the community and customers. It will help us make the decisions in the future on which SDKs to officially support in the future.