github.com/novuhq/novu-go

Developer-friendly & type-safe Go SDK specifically catered to leverage github.com/novuhq/novu-go API.

Important

This SDK is not yet ready for production use. To complete setup please follow the steps outlined in your workspace. Delete this section before > publishing to a package manager.

Summary

Novu API: Novu REST API. Please see https://docs.novu.co/api-reference for more details.

For more information about the API: Novu Documentation

SDK Installation

To add the SDK as a dependency to your project:

go get github.com/novuhq/novu-go

SDK Example Usage

Trigger Notification Event

package main

import (
	"context"
	novugo "github.com/novuhq/novu-go"
	"github.com/novuhq/novu-go/models/components"
	"log"
	"os"
)

func main() {
	ctx := context.Background()

	s := novugo.New(
		novugo.WithSecurity(os.Getenv("NOVU_API_KEY")),
	)

	res, err := s.Trigger(ctx, components.TriggerEventRequestDto{
		Name: "workflow_identifier",
		Payload: map[string]any{
			"comment_id": "string",
			"post": map[string]any{
				"text": "string",
			},
		},
		BridgeURL: novugo.String("https://example.com/bridge"),
		Overrides: map[string]map[string]any{
			"fcm": map[string]any{
				"data": map[string]any{
					"key": "value",
				},
			},
		},
		To: components.CreateToSubscriberPayloadDto(
			components.SubscriberPayloadDto{
				SubscriberID: "<id>",
			},
		),
	})
	if err != nil {
		log.Fatal(err)
	}
	if res.TriggerEventResponseDto != nil {
		// handle response
	}
}

Trigger Notification Events in Bulk

package main

import (
	"context"
	novugo "github.com/novuhq/novu-go"
	"github.com/novuhq/novu-go/models/components"
	"log"
	"os"
)

func main() {
	ctx := context.Background()

	s := novugo.New(
		novugo.WithSecurity(os.Getenv("NOVU_API_KEY")),
	)

	res, err := s.TriggerBulk(ctx, components.BulkTriggerEventDto{
		Events: []components.TriggerEventRequestDto{
			components.TriggerEventRequestDto{
				Name: "workflow_identifier",
				Payload: map[string]any{
					"comment_id": "string",
					"post": map[string]any{
						"text": "string",
					},
				},
				BridgeURL: novugo.String("https://example.com/bridge"),
				Overrides: map[string]map[string]any{
					"fcm": map[string]any{
						"data": map[string]any{
							"key": "value",
						},
					},
				},
				To: components.CreateToSubscriberPayloadDto(
					components.SubscriberPayloadDto{
						SubscriberID: "<id>",
					},
				),
			},
			components.TriggerEventRequestDto{
				Name: "workflow_identifier",
				Payload: map[string]any{
					"comment_id": "string",
					"post": map[string]any{
						"text": "string",
					},
				},
				BridgeURL: novugo.String("https://example.com/bridge"),
				Overrides: map[string]map[string]any{
					"fcm": map[string]any{
						"data": map[string]any{
							"key": "value",
						},
					},
				},
				To: components.CreateToArrayOf1(
					[]components.One{
						components.CreateOneTopicPayloadDto(
							components.TopicPayloadDto{
								TopicKey: "<value>",
								Type:     components.TriggerRecipientsTypeEnumSubscriber,
							},
						),
					},
				),
			},
			components.TriggerEventRequestDto{
				Name: "workflow_identifier",
				Payload: map[string]any{
					"comment_id": "string",
					"post": map[string]any{
						"text": "string",
					},
				},
				BridgeURL: novugo.String("https://example.com/bridge"),
				Overrides: map[string]map[string]any{
					"fcm": map[string]any{
						"data": map[string]any{
							"key": "value",
						},
					},
				},
				To: components.CreateToArrayOf1(
					[]components.One{
						components.CreateOneStr(
							"SUBSCRIBER_ID",
						),
						components.CreateOneStr(
							"SUBSCRIBER_ID",
						),
					},
				),
			},
		},
	})
	if err != nil {
		log.Fatal(err)
	}
	if res.TriggerEventResponseDtos != nil {
		// handle response
	}
}

Broadcast Event to All

package main

import (
	"context"
	novugo "github.com/novuhq/novu-go"
	"github.com/novuhq/novu-go/models/components"
	"log"
	"os"
)

func main() {
	ctx := context.Background()

	s := novugo.New(
		novugo.WithSecurity(os.Getenv("NOVU_API_KEY")),
	)

	res, err := s.Broadcast(ctx, components.TriggerEventToAllRequestDto{
		Name: "<value>",
		Payload: map[string]any{
			"comment_id": "string",
			"post": map[string]any{
				"text": "string",
			},
		},
	})
	if err != nil {
		log.Fatal(err)
	}
	if res.TriggerEventResponseDto != nil {
		// handle response
	}
}

Cancel Triggered Event

package main

import (
	"context"
	novugo "github.com/novuhq/novu-go"
	"log"
	"os"
)

func main() {
	ctx := context.Background()

	s := novugo.New(
		novugo.WithSecurity(os.Getenv("NOVU_API_KEY")),
	)

	res, err := s.Cancel(ctx, "<id>")
	if err != nil {
		log.Fatal(err)
	}
	if res.DataBooleanDto != nil {
		// handle response
	}
}

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name	Type	Scheme	Environment Variable
`APIKey`	apiKey	API key	`NOVU_API_KEY`

You can configure it using the WithSecurity option when initializing the SDK client instance. For example:

package main

import (
	"context"
	novugo "github.com/novuhq/novu-go"
	"github.com/novuhq/novu-go/models/components"
	"log"
	"os"
)

func main() {
	ctx := context.Background()

	s := novugo.New(
		novugo.WithSecurity(os.Getenv("NOVU_API_KEY")),
	)

	res, err := s.Trigger(ctx, components.TriggerEventRequestDto{
		Name: "workflow_identifier",
		Payload: map[string]any{
			"comment_id": "string",
			"post": map[string]any{
				"text": "string",
			},
		},
		BridgeURL: novugo.String("https://example.com/bridge"),
		Overrides: map[string]map[string]any{
			"fcm": map[string]any{
				"data": map[string]any{
					"key": "value",
				},
			},
		},
		To: components.CreateToSubscriberPayloadDto(
			components.SubscriberPayloadDto{
				SubscriberID: "<id>",
			},
		),
	})
	if err != nil {
		log.Fatal(err)
	}
	if res.TriggerEventResponseDto != nil {
		// handle response
	}
}

Available Resources and Operations

Available methods

Integrations

List - Get integrations
Create - Create integration
ListActive - Get active integrations
Update - Update integration
Delete - Delete integration
SetPrimary - Set integration as primary

Integrations.Webhooks

GetProviderStatus - Get webhook support status for provider

Messages

List - Get messages
Delete - Delete message
DeleteByTransactionID - Delete messages by transactionId

Notifications

List - Get notifications
Get - Get notification

Notifications.Stats

Get - Get notification statistics
GetGraph - Get notification graph statistics

Novu SDK

Trigger - Trigger event
TriggerBulk - Bulk trigger event
Broadcast - Broadcast event to all
Cancel - Cancel triggered event

Subscribers

List - Get subscribers
Create - Create subscriber
Get - Get subscriber
Update - Update subscriber
Delete - Delete subscriber
CreateBulk - Bulk create subscribers
UpdateOnlineStatus - Update subscriber online status

Subscribers.Authentication

OauthCallback - Handle providers oauth redirect
ChatAccessOauth - Handle chat oauth

Subscribers.Credentials

Update - Update subscriber credentials
Append - Modify subscriber credentials
Delete - Delete subscriber credentials by providerId

Subscribers.Messages

MarkAs - Mark a subscriber messages as seen, read, unseen or unread
MarkAll - Marks all the subscriber messages as read, unread, seen or unseen. Optionally you can pass feed id (or array) to mark messages of a particular feed.
UpdateAction - Mark message action as seen

Subscribers.Notifications

GetFeed - Get in-app notification feed for a particular subscriber
UnseenCount - Get the unseen in-app notifications count for subscribers feed

Subscribers.Preferences

List - Get subscriber preferences
RetrieveByLevel - Get subscriber preferences by level

SubscribersPreferences

UpdateGlobal - Update subscriber global preferences
Update - Update subscriber preference

Support

Topics

Create - Topic creation
List - Get topic list filtered
Delete - Delete topic
Get - Get topic
Rename - Rename a topic

Topics.Subscribers

Check - Check topic subscriber
Remove - Subscribers removal

TopicsSubscribers

Add - Subscribers addition

Pagination

Some of the endpoints in this SDK support pagination. To use pagination, you make your SDK calls as usual, but the returned response object will have a Next method that can be called to pull down the next group of results. If the return value of Next is nil, then there are no more pages to be fetched.

Here's an example of one such pagination call:

package main

import (
	"context"
	novugo "github.com/novuhq/novu-go"
	"log"
	"os"
)

func main() {
	ctx := context.Background()

	s := novugo.New(
		novugo.WithSecurity(os.Getenv("NOVU_API_KEY")),
	)

	res, err := s.Subscribers.List(ctx, nil, nil)
	if err != nil {
		log.Fatal(err)
	}
	if res.Object != nil {
		for {
			// handle items

			res, err = res.Next()

			if err != nil {
				// handle error
			}

			if res == nil {
				break
			}
		}
	}
}

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a retry.Config object to the call by using the WithRetries option:

package main

import (
	"context"
	novugo "github.com/novuhq/novu-go"
	"github.com/novuhq/novu-go/models/components"
	"github.com/novuhq/novu-go/retry"
	"log"
	"models/operations"
	"os"
)

func main() {
	ctx := context.Background()

	s := novugo.New(
		novugo.WithSecurity(os.Getenv("NOVU_API_KEY")),
	)

	res, err := s.Trigger(ctx, components.TriggerEventRequestDto{
		Name: "workflow_identifier",
		Payload: map[string]any{
			"comment_id": "string",
			"post": map[string]any{
				"text": "string",
			},
		},
		BridgeURL: novugo.String("https://example.com/bridge"),
		Overrides: map[string]map[string]any{
			"fcm": map[string]any{
				"data": map[string]any{
					"key": "value",
				},
			},
		},
		To: components.CreateToSubscriberPayloadDto(
			components.SubscriberPayloadDto{
				SubscriberID: "<id>",
			},
		),
	}, operations.WithRetries(
		retry.Config{
			Strategy: "backoff",
			Backoff: &retry.BackoffStrategy{
				InitialInterval: 1,
				MaxInterval:     50,
				Exponent:        1.1,
				MaxElapsedTime:  100,
			},
			RetryConnectionErrors: false,
		}))
	if err != nil {
		log.Fatal(err)
	}
	if res.TriggerEventResponseDto != nil {
		// handle response
	}
}

If you'd like to override the default retry strategy for all operations that support retries, you can use the WithRetryConfig option at SDK initialization:

package main

import (
	"context"
	novugo "github.com/novuhq/novu-go"
	"github.com/novuhq/novu-go/models/components"
	"github.com/novuhq/novu-go/retry"
	"log"
	"os"
)

func main() {
	ctx := context.Background()

	s := novugo.New(
		novugo.WithRetryConfig(
			retry.Config{
				Strategy: "backoff",
				Backoff: &retry.BackoffStrategy{
					InitialInterval: 1,
					MaxInterval:     50,
					Exponent:        1.1,
					MaxElapsedTime:  100,
				},
				RetryConnectionErrors: false,
			}),
		novugo.WithSecurity(os.Getenv("NOVU_API_KEY")),
	)

	res, err := s.Trigger(ctx, components.TriggerEventRequestDto{
		Name: "workflow_identifier",
		Payload: map[string]any{
			"comment_id": "string",
			"post": map[string]any{
				"text": "string",
			},
		},
		BridgeURL: novugo.String("https://example.com/bridge"),
		Overrides: map[string]map[string]any{
			"fcm": map[string]any{
				"data": map[string]any{
					"key": "value",
				},
			},
		},
		To: components.CreateToSubscriberPayloadDto(
			components.SubscriberPayloadDto{
				SubscriberID: "<id>",
			},
		),
	})
	if err != nil {
		log.Fatal(err)
	}
	if res.TriggerEventResponseDto != nil {
		// handle response
	}
}

Error Handling

Handling errors in this SDK should largely match your expectations. All operations return a response object or an error, they will never return both.

By Default, an API error will return apierrors.APIError. When custom error responses are specified for an operation, the SDK may also return their associated error. You can refer to respective Errors tables in SDK docs for more details on possible error types for each operation.

For example, the Trigger function may return the following errors:

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

Example

package main

import (
	"context"
	"errors"
	novugo "github.com/novuhq/novu-go"
	"github.com/novuhq/novu-go/models/apierrors"
	"github.com/novuhq/novu-go/models/components"
	"log"
	"os"
)

func main() {
	ctx := context.Background()

	s := novugo.New(
		novugo.WithSecurity(os.Getenv("NOVU_API_KEY")),
	)

	res, err := s.Trigger(ctx, components.TriggerEventRequestDto{
		Name: "workflow_identifier",
		Payload: map[string]any{
			"comment_id": "string",
			"post": map[string]any{
				"text": "string",
			},
		},
		BridgeURL: novugo.String("https://example.com/bridge"),
		Overrides: map[string]map[string]any{
			"fcm": map[string]any{
				"data": map[string]any{
					"key": "value",
				},
			},
		},
		To: components.CreateToSubscriberPayloadDto(
			components.SubscriberPayloadDto{
				SubscriberID: "<id>",
			},
		),
	})
	if err != nil {

		var e *apierrors.ErrorDto
		if errors.As(err, &e) {
			// handle error
			log.Fatal(e.Error())
		}

		var e *apierrors.ValidationErrorDto
		if errors.As(err, &e) {
			// handle error
			log.Fatal(e.Error())
		}

		var e *apierrors.APIError
		if errors.As(err, &e) {
			// handle error
			log.Fatal(e.Error())
		}
	}
}

Server Selection

Select Server by Index

You can override the default server globally using the WithServerIndex(serverIndex int) option when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:

#	Server
0	`https://api.novu.co`
1	`https://eu.api.novu.co`

Example

package main

import (
	"context"
	novugo "github.com/novuhq/novu-go"
	"github.com/novuhq/novu-go/models/components"
	"log"
	"os"
)

func main() {
	ctx := context.Background()

	s := novugo.New(
		novugo.WithServerIndex(1),
		novugo.WithSecurity(os.Getenv("NOVU_API_KEY")),
	)

	res, err := s.Trigger(ctx, components.TriggerEventRequestDto{
		Name: "workflow_identifier",
		Payload: map[string]any{
			"comment_id": "string",
			"post": map[string]any{
				"text": "string",
			},
		},
		BridgeURL: novugo.String("https://example.com/bridge"),
		Overrides: map[string]map[string]any{
			"fcm": map[string]any{
				"data": map[string]any{
					"key": "value",
				},
			},
		},
		To: components.CreateToSubscriberPayloadDto(
			components.SubscriberPayloadDto{
				SubscriberID: "<id>",
			},
		),
	})
	if err != nil {
		log.Fatal(err)
	}
	if res.TriggerEventResponseDto != nil {
		// handle response
	}
}

Override Server URL Per-Client

The default server can also be overridden globally using the WithServerURL(serverURL string) option when initializing the SDK client instance. For example:

package main

import (
	"context"
	novugo "github.com/novuhq/novu-go"
	"github.com/novuhq/novu-go/models/components"
	"log"
	"os"
)

func main() {
	ctx := context.Background()

	s := novugo.New(
		novugo.WithServerURL("https://api.novu.co"),
		novugo.WithSecurity(os.Getenv("NOVU_API_KEY")),
	)

	res, err := s.Trigger(ctx, components.TriggerEventRequestDto{
		Name: "workflow_identifier",
		Payload: map[string]any{
			"comment_id": "string",
			"post": map[string]any{
				"text": "string",
			},
		},
		BridgeURL: novugo.String("https://example.com/bridge"),
		Overrides: map[string]map[string]any{
			"fcm": map[string]any{
				"data": map[string]any{
					"key": "value",
				},
			},
		},
		To: components.CreateToSubscriberPayloadDto(
			components.SubscriberPayloadDto{
				SubscriberID: "<id>",
			},
		),
	})
	if err != nil {
		log.Fatal(err)
	}
	if res.TriggerEventResponseDto != nil {
		// handle response
	}
}

Custom HTTP Client

The Go SDK makes API calls that wrap an internal HTTP client. The requirements for the HTTP client are very simple. It must match this interface:

type HTTPClient interface {
	Do(req *http.Request) (*http.Response, error)
}

The built-in net/http client satisfies this interface and a default client based on the built-in is provided by default. To replace this default with a client of your own, you can implement this interface yourself or provide your own client configured as desired. Here's a simple example, which adds a client with a 30 second timeout.

import (
	"net/http"
	"time"
	"github.com/myorg/your-go-sdk"
)

var (
	httpClient = &http.Client{Timeout: 30 * time.Second}
	sdkClient  = sdk.New(sdk.WithClient(httpClient))
)

This can be a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration.

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.

Name		Name	Last commit message	Last commit date
Latest commit History 3 Commits
.devcontainer		.devcontainer
.github/workflows		.github/workflows
.speakeasy		.speakeasy
docs		docs
internal		internal
models		models
retry		retry
types		types
.gitattributes		.gitattributes
.gitignore		.gitignore
CONTRIBUTING.md		CONTRIBUTING.md
README.md		README.md
RELEASES.md		RELEASES.md
USAGE.md		USAGE.md
authentication.go		authentication.go
credentials.go		credentials.go
go.mod		go.mod
go.sum		go.sum
integrations.go		integrations.go
messages.go		messages.go
notifications.go		notifications.go
novu.go		novu.go
novumessages.go		novumessages.go
novusubscribersnotifications.go		novusubscribersnotifications.go
novutopicssubscribers.go		novutopicssubscribers.go
preferences.go		preferences.go
stats.go		stats.go
subscribers.go		subscribers.go
subscriberspreferences.go		subscriberspreferences.go
support.go		support.go
topics.go		topics.go
topicssubscribers.go		topicssubscribers.go
webhooks.go		webhooks.go

novuhq/novu-go

Folders and files

Latest commit

History

Repository files navigation

github.com/novuhq/novu-go

Summary

Table of Contents

SDK Installation

SDK Example Usage

Trigger Notification Event

Trigger Notification Events in Bulk

Broadcast Event to All

Cancel Triggered Event

Authentication

Per-Client Security Schemes

Available Resources and Operations

Pagination

Retries

Error Handling

Example

Server Selection

Select Server by Index

Example

Override Server URL Per-Client

Custom HTTP Client

Development

Maturity

Contributions

SDK Created by Speakeasy

About

Resources

Stars

Watchers

Forks

Languages