Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/novuhq/novu-ruby
Ruby SDK for Novu - The open-source notification infrastructure for engineers. 🚀
https://github.com/novuhq/novu-ruby
api-client api-wrapper hacktoberfest novu novu-api ruby-gem
Last synced: about 1 month ago
JSON representation
Ruby SDK for Novu - The open-source notification infrastructure for engineers. 🚀
- Host: GitHub
- URL: https://github.com/novuhq/novu-ruby
- Owner: novuhq
- License: mit
- Created: 2023-02-28T06:57:40.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-30T04:25:11.000Z (9 months ago)
- Last Synced: 2024-11-14T15:22:50.687Z (about 1 month ago)
- Topics: api-client, api-wrapper, hacktoberfest, novu, novu-api, ruby-gem
- Language: Ruby
- Homepage: https://rubygems.org/gems/novu
- Size: 191 KB
- Stars: 24
- Watchers: 8
- Forks: 10
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Novu Ruby client library
[](https://rubygems.org/gems/novu)
[](https://rubygems.org/gems/novu/)
> This is a Ruby client library for communicating with the [Novu API](https://api.novu.co/api).
## Installation
You can install the client library via RubyGems:
```ruby
gem install novu
```
Or add it to your Gemfile:
```ruby
gem 'novu'
```
Then run `bundle install`.
## Usage
To use the library, first initialize the client with your API token:
```ruby
require 'novu'
client = Novu::Client.new(access_token: 'YOUR_NOVU_API_TOKEN')
```
You can then call methods on the client to interact with the Novu API:
```ruby
client.notifications
```
## List of all methods
The client methods map directly to the Novu API endpoints. Here's a list of all the available methods. Check [the API docs](https://docs.novu.co/api/overview) for list of available `methods`.
### Blueprints
- Get V1blueprints: `get_blueprint(template_id)`
```ruby
client.get_blueprint('')
```
- Get V1blueprints by category: `group_blueprints_by_category()`
```ruby
client.group_blueprints_by_category()
```
### Changes
- Get changes: `changes(query = {})`
```ruby
client.changes({
'page' => 1, # optional
'limit' => 10, # optional
'promoted' => 'hello'
})
```
- Get changes count: `count_changes()`
```ruby
client.count_changes()
```
- Apply changes: `apply_bulk_changes()`
```ruby
client.apply_bulk_changes({
'changeIds' => ['']
})
```
- Apply change: `apply_change(change_id)`
```ruby
client.apply_change('7789')
```
### Environments
- Get current environment: `current_environment()`
```ruby
client.current_environment()
```
- Create environment: `create_environment(body)`
```ruby
payload = {
'name' => 'Staging',
'parentId' => '7789' # optional
}
client.create_environment(payload)
```
- Get environments: `environments()`
```ruby
client.environments()
```
- Update environment by id: `update_environment(environment_id, body)`
```ruby
client.update_environment('64a713bdexxxxxx', {
'name' => 'Local', # optional
'identifier' => 'local', # optional
'parentId' => '7789', # optional
'dns' => { # optional
'inboundParseDomain' => 'dev.test' # optional
}
})
```
- Get api keys: `api_keys()`
```ruby
client.api_keys()
```
- Regenerate api keys: `regenerate_api_keys()`
```ruby
client.regenerate_api_keys()
```
- `update_widget_settings(body)`
```ruby
client.update_widget_settings({ 'notificationCenterEncryption' => true})
```
### Events
- Trigger event: `trigger_event(body)`
```ruby
payload = {
'name' => 'Trigger1',
'payload' => { # optional
'first-name' => 'Adam' # optional
},
'to' => {
'subscriberId' => '7789'
},
'transactionId' => '89kjfke9893' #optional
}
client.trigger_event(payload)
```
- Bulk trigger event: `trigger_bulk_event(body)`
```ruby
payload = {
'events' => [
{
'name' => 'Trigger1',
'payload' => { # optional
'first-name' => 'Adam' # optional
},
'to' => {
'subscriberId' => '7789'
},
'transactionId' => '89kjfke9893' #optional
},
{
'name' => 'Trigger2',
'payload' => { # optional
'last-name' => 'Eve' # optional
},
'to' => {
'subscriberId' => '7789'
},
'transactionId' => 'sw900999as' #optional
}
]
}
client.trigger_bulk_event(payload)
```
- Broadcast event to all: `broadcast_event(body)`
```ruby
payload = {
'name' => 'Trigger',
'payload' => {
'first-name' => 'Adam',
'last-name' => 'Eve'
},
'transactionId' => 'sw900999as' #optional
}
client.broadcast_event(payload)
```
- Cancel triggered event: `cancel_triggered_event(transaction_id)`
```ruby
client.cancel_triggered_event('8fxxxee-xxx-4f2b-a0e8-xxxxx')
```
### Execution Details
- Get execution details: `execution_details(query = {})`
```ruby
client.execution_details({
'notificationId' => '8fxxx-xxx-ef9xxxxce66',
'subscriberId' => '7789'
})
```
### Feeds
- Create feed: `create_feed(body)`
```ruby
client.create_feed({
'name' => 'New feed'
})
```
- Get feeds: `feeds()`
```ruby
client.feeds()
```
- Delete feed: `delete_feed(feed_id)`
```ruby
client.delete_feed('xxxx714xxa8cbxxxxx2d932')
```
### Inbound Parse
- Validate the mx record setup for the inbound parse functionality: `validate_mx_record_setup_for_inbound_parse()`
```ruby
client.validate_mx_record_setup_for_inbound_parse()
```
### Integrations
- Get integrations: `integrations()`
```ruby
client.integrations()
```
- Create integration: `create_integration(body)`
```ruby
body = {
'providerId' => '',
'channel' => '',
'credentials' => {
# insert all the fields
},
'active' => true,
'check' => true
}
client.create_integration(body)
```
- Get active integrations: `active_integrations()`
```ruby
client.active_integrations()
```
- Get webhook support status for provider: `webhook_provider_status(provider_id)`
```ruby
client.webhook_provider_status('')
```
- Update integration: `update_integration(integration_id, body)`
```ruby
body = {
'active' => true,
'check' => true
'credentials' => {
# insert all the fields
},
}
client.update_integration('', body)
```
- Delete integration: `delete_integration(integration_id)`
```ruby
client.delete_integration('')
```
- Get channel limit: `channel_limit(channel_type)`
```ruby
client.channel_limit('')
```
- Get in-app status: `in_app_status()`
```ruby
client.in_app_status()
```
- Set integration as primary: `set_integration_as_primary(integration_id)`
```ruby
client.set_integration_as_primary('')
```
### Layouts
- Layout creation: `create_layout(body)`
```ruby
payload = {
'name' => 'New layout',
'content' => '{{{body}}}',
'variables' => [''], # optional
'description' => 'This is a description for the new layout', # optional
'isDefault' => true # optional
}
client.create_layout(payload)
```
- Filter layouts: `layouts(query = {})`
```ruby
client.layouts({
'page' => 1, # optional
'pageSize' => 10, # optional
'sortBy' => 'createdAt', # optional
'orderBy' => 1 # optional
})
```
- Get layout: `layout(layout_id)`
```ruby
client.layout('')
```
- Delete layout: `delete_layout(layout_id)`
```ruby
client.delete_layout('')
```
- Update a layout: `update_layout(layout_id, body)`
```ruby
payload = {
'name' => 'Update layout', # optional
'content' => '{{{body}}}', # optional
'description' => 'This is a description for the new layout', # optional
'isDefault' => true # optional
'variables' => [''], # optional
}
client.update_layout('', payload)
```
- Set default layout: `make_default_layout(layout_id)`
```ruby
client.make_default_layout('')
```
### Messages
- Get messages: `messages(query = {})`
```ruby
payload = {
'channel' => 'slack', # optional
'subscriberId' => '7789', # optional
'transactionId' =>'sw900999as', # optional
'page' => 4, # optional
'limit' => 10, # optional
}
client.messages(payload)
```
- Delete message: `delete_message(message_id)`
```ruby
client.delete_message('')
```
### Notification Groups
- Create Notification group: `create_notification_group(body)`
```ruby
client.create_notification_group({
'name' => ''
})
```
- Get Notification groups: `notification_groups()`
```ruby
client.notification_groups()
```
### Notification Templates
- Get notification templates: `notification_templates(query = {})`
```ruby
client.notification_templates({
'page' => 4, # optional
'limit' => 10, # optional
})
```
- Create notification template: `create_notification_template(body)`
```ruby
body = {
'name' => '',
'notificationGroupId' => 'notificationGroupId',
'tags' => ['tags'], # optional
'description' => 'description', # optional
'steps' => [ # optional
# insert all fields here
],
'active' => true, # optional
'draft' => true, # optional
'critical' => true, # optional
'preferenceSettings' => { # optional
# insert all fields here
},
'blueprintId' => 'blueprintId' # optional
}
client.create_notification_template(body)
```
- Update notification template: `update_notification_template(template_id, body)`
```ruby
body = {
'name' => '',
'notificationGroupId' => 'notificationGroupId',
'tags' => ['tags'], # optional
'description' => 'description', # optional
'steps' => [ # optional
# insert all fields here
],
'active' => true, # optional
'draft' => true, # optional
'critical' => true, # optional
'preferenceSettings' => { # optional
# insert all fields here
},
'blueprintId' => 'blueprintId' # optional
}
client.update_notification_template('', body)
```
- Delete notification template`delete_notification_template(template_id)`
```ruby
client.delete_notification_template('')
```
- Get a notification template: `notification_template(template_id)`
```ruby
client.notification_template('')
```
- Get a notification template blueprint: `notification_template_blueprint(template_id)`
```ruby
client.notification_template_blueprint('')
```
- Create a new notification template blueprint: `create_notification_template_blueprint(template_id)`
```ruby
client.create_notification_template_blueprint('')
```
- Update notification template status: `update_notification_template_status(template_id, body)`
```ruby
client.update_notification_template_status('', { 'active' => true })
```
### Notification
- Get notifications: `notifications(query = {})`
```ruby
body = {
'channels' => [''],
'templates' => [''],
'emails' => [''],
'search' => ''
'page' => 2 , # optional
'transactionId' =>'sw900999as', # optional
}
client.notifications(body)
```
- Get notification statistics: `notifications_stats()`
```ruby
client.notifications_stats()
```
- Get notification graph statistics: `notifications_graph_stats(query = {})`
```ruby
client.notifications_graph_stats({
'days' => 5 # optional
})
```
- Get notification: `notification(notification_id)`
```ruby
client.notification('')
```
### Organizations
- Create an organization: `create_organization(body)`
```ruby
client.create_organization({
'logo' => '',
'name' => '',
})
```
- Get all organizations: `organizations()`
```ruby
client.organizations()
```
- Get current organization: `current_organization()`
```ruby
client.current_organization()
```
- Get all members of current organization: `current_organization_members()`
```ruby
client.current_organization_members()
```
- Rename organization: `rename_organization(body)`
```ruby
client.rename_organization({
name: ''
})
```
- Rename organization: `organization_branding(body)`
```ruby
client.organization_branding({
logo: '',
color: '',
fontColor: '',
contentBackground: '',
fontFamily: ''
})
```
- Delete member from organization: `delete_organization_member(member_id)`
```ruby
client.delete_organization_member('')
```
### Subscribers
- Get subscribers: `subscribers(query = {}) `
```ruby
client.subscribers({
'page' => 1, # optional
'limit' => 15, # optional
})
```
- Create subscriber: `create_subscriber(body)`
```ruby
payload = {
'subscriberId' => '7789',
'email' => '', # optional
'firstName' => '', # optional
'lastName' => '', # optional
'phone' => '', # optional
'avatar' => '' # optional
}
client.create_subscriber(payload)
```
- `subscriber(subscriber_id)`
```ruby
client.subscriber('')
```
- Update subscriber: `update_subscriber(subscriber_id, body)`
```ruby
payload = {
'email' => '', # optional
'firstName' => '', # optional
'lastName' => '', # optional
'phone' => '', # optional
'avatar' => '' # optional
}
client.update_subscriber('', payload)
```
- Delete subscriber: `delete_subscriber(subscriber_id)`
```ruby
client.delete_subscriber('')
```
- Update subscriber credentials: `update_subscriber_credentials(subscriber_id, body)`
```ruby
body = {
'providerId' => '',
'credentials' => {
# Insert all fields here
}
}
client.update_subscriber_credentials('', body)
```
- Delete subscriber credentials by providerId: `delete_subscriber_credentials(subscriberId, providerId)`
```ruby
client.delete_subscriber_credentials('', '')
```
- Update subscriber online status: `update_subscriber_online_status(subscriber_id, body)`
```ruby
client.update_subscriber_online_status('', { 'isOnline' => true })
```
- Get subscriber preferences: `subscriber_preferences(subscriber_id)`
```ruby
client.subscriber_preferences('')
```
- Update subscriber preference: `update_subscriber_preference(subscriber_id, template_id, body)`
```ruby
body = {
'channel' => {
# Insert all fields here
},
'enabled' => true
}
client.update_subscriber_preference('', '', body)
```
- Create bulk subscribers: `bulk_create_subscribers(body)`
```ruby
payload = {
'subscribers' => [
{
'name' => 'subscriber-1',
'email' => '[email protected]',
'firstName' => 'test1',
'lastName' => 'test1',
'phone' => '08122442244',
'subscriberId' => 'subscriber-test-1221'
},
{
'name' => 'subscriber2',
'email' => '[email protected]',
'firstName' => 'test2',
'lastName' => 'test2',
'phone' => '0814422334',
'subscriberId' => 'subscriber-test-9090'
}
]
}
client.bulk_create_subscribers(payload)
```
- Get in-app notification feed for a particular subscriber: `subscriber_notification_feed(subscriber_id, query = {})`
```ruby
client.subscriber_notification_feed('', {
'page' => 3, # optional
'limit' => 15, # optional
'read' => true, # optional
'seen' => true, # optional
})
```
- Get the unseen in-app notifications count for subscribers feed: `subscriber_unseen_notification_count(subscriber_id, query = {})`
```ruby
client.subscriber_unseen_notification_count('', {
'limit' => 15, # optional
'seen' => false, # optional
})
```
- Mark a subscriber feed message as seen: `mark_subscriber_feed_seen(subscriber_id, body)`
```ruby
client.mark_subscriber_feed_seen('', {
'messageId' => '',
'mark' => {
'seen' => true,
'read' => true
}
})
```
- Mark message action as seen: `mark_message_action_seen(subscriber_id, message_id, type)`
```ruby
client.mark_message_action_seen('', '', '')
```
- Marks all the subscriber messages: `mark_all_subscriber_messages(subscriber_id, body)`
```ruby
body = {
'markAs' => 'seen'
}
client.mark_all_subscriber_messages('', body)
```
- Handle providers OAUTH redirect: `provider_oauth_redirect(subscriber_id, provider_id, query)`
```ruby
query = {
'environmentId' => '',
'code' => '',
'hmacHash' => '',
'integrationIdentifier' => ''
}
client.provider_oauth_redirect('', '', query)
```
- Handle chat OAUTH: `chat_oauth(subscriber_id, provider_id, query)`
```ruby
query = {
'environmentId' => '',
'hmacHash' => '',
'integrationIdentifier' => ''
}
client.chat_oauth('', '', query)
```
### Tenants
- Tenant create: `create_tenant(body)`
```ruby
client.create_tenant({
'identifier' => '',
'name' => '',
'data' => {
'company' => 'a company',
'date-registered' => '2023-0-15'
}
})
```
- Get tenants: `tenants(query = {})`
```ruby
client.tenants({
'page' => 1, # optional
'limit' => 10, # optional
})
```
- Get tenant: `tenant(identifier)`
```ruby
client.tenant('')
```
- Update tenant: `update_tenant(identifier, body)`
```ruby
client.update_tenant('', {
'identifier' => '',
'name' => '',
})
```
- Delete tenant: `delete_tenant(identifier)`
```ruby
client.delete_tenant('')
```
### Topics
- Topic creation: `create_topic(body)`
```ruby
client.create_topic({
'key' => 'key',
'name' => 'name'
})
```
- Filter topics: `topics(query = {})`
```ruby
client.topics({
'name' => 'name', # optional
'page' => 1, # optional
'pageSize' => 10, # optional
})
```
- Subscribers addition: `add_subscribers(topic_key, body)`
```ruby
client.add_subscribers('', {
'subscribers' => ['']
})
```
- `remove_subscribers(topic_key, body)`
```ruby
client.
```
- Get topic: `topic(topic_key)`
```ruby
client.topic('')
```
- Rename a topic: `rename_topic(topic_key, body)`
```ruby
client.rename_topic('', {
'name' => 'new name'
})
```
- Delete topic: `delete_topic(topic_key)`
```ruby
client.delete_topic('')
```
- Check topic subsriber: `subscriber_topic(topic_key, externalSubscriberId)`
```ruby
client.subscriber_topic('', '')
```
### Idempotent Request
This SDK allows you to perform idempotent requests, that is safely retrying requests without accidentally performing the same operation twice.
To achieve this, provide an `idempotency_key` argument during initialization of the NOVU client. We strongly recommend that you use [UUID](https://datatracker.ietf.org/doc/html/rfc4122) format when you're generating your idempotency key.
```ruby
client = Novu::Client.new(
access_token: '',
idempotency_key: ''
)
```
### Exponential Retry Mechanism
You can configure this SDK to retry failed requests. This is done by using [Exponential backoff strategy](https://en.wikipedia.org/wiki/Exponential_backoff). It is a common algorithm for retrying requests. The retries gradually extend the waiting time until reaching a specific limit. The concept is to prevent overloading the server with simultaneous requests once it is back online, especially in cases of temporary downtime.
```ruby
client = Novu::Client.new(
access_token: '',
idempotency_key: '',
enable_retry: true, # it is disabled by default,
retry_config: {
max_retries: 3,
initial_delay: 4,
max_delay: 60
}
)
```
## The retry configuration is explained in the following table:
| Options | Detail | Default Value | Data Type |
| ------------- | -------------------------------------------------------------------| --------------- | --------- |
| max_retries | Specifies total number of retries to perform in case of failure | 1 | Integer |
| initial_delay | Specifies the minimum time to wait before retrying (in seconds) | 4 | Integer |
| max_delay | Specifies the maximum time to wait before retrying (in seconds) | 60 | Integer |
| enable_retry | enabling/disable the Exponential Retry mechanism | false | Boolean |
### Custom backend URL
To use a custom backend URL, for example to be able to use the EU Novu API, you can pass a custom `backend_url` when initializing the client.
```ruby
client = Novu::Client.new(
access_token: '',
backend_url: 'https://eu.api.novu.co/v1'
)
```
### For more information about these methods and their parameters, see the [API documentation](https://docs.novu.co/api-reference).
## Contributing
Bug reports and pull requests are welcome [here.](https://github.com/novuhq/novu-ruby)
## Support and Feedback
Be sure to visit the Novu official [documentation website](https://docs.novu.co/docs) for additional information about our API.
If you need additional assistance, join our Discord server [here](https://discord.novu.co).
## License
Novu Ruby SDK is licensed under the MIT License - see the [LICENSE](https://github.com/novuhq/novu-ruby/blob/main/LICENSE.txt) file for details.