novu 0.1.0 → 1.0.0

data/Rakefile

@@ -9,4 +9,5 @@ require "rubocop/rake_task"
 
 RuboCop::RakeTask.new
 
-task default: %i[spec rubocop]
+# TODO: add rubocop back to default task once all offenses are corrected
+task default: %i[spec]

data/lib/novu/api/blueprints.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Novu
+  class Api
+    # Module Novu::Api::Blueprints provides an API for managing templated for notifications that are sent out in the Novu application.
+    #
+    # This module includes methods for retrieving blueprints by templateID and grouping blueprints by category.
+    #
+    # For more information on the Novu Blueprint API, see https://docs.novu.co/api/get-messages/.
+    module Blueprints
+      # Returns the details of a particular template
+      #
+      # @pathParams 
+      # @param `template_id` [String]
+      #
+      # @return [Hash] The list of properties that pertains to the template e.g. _id, name, description, active, draft, preferenceSettings, and many others.
+      # @return [number] status
+      #  - Returns 200 if successful
+      def get_blueprint(template_id)
+        get("/blueprints/#{template_id}")
+      end
+
+      # Get V1blueprintsgroup by Category
+      def group_blueprints_by_category
+        get("/blueprints/group-by-category")
+      end
+    end
+  end
+end

data/lib/novu/api/changes.rb

@@ -33,11 +33,13 @@ module Novu
 
       # Apply Bulk Change
       #
+      # @bodyParams
+      # @param changeIds [Array] The list of environment IDs to apply changes to.
       # @return [Hash] updated change.
       # @return [number] status
       #  - Returns 201 if the bulk change has been updated correctly.
-      def apply_bulk_changes
-        post("/changes/bulk/apply")
+      def apply_bulk_changes(changeIds)
+        post("/changes/bulk/apply", body: changeIds)
       end
 
       # Apply change

data/lib/novu/api/integrations.rb

@@ -100,6 +100,17 @@ module Novu
       def in_app_status
         get("/integrations/in-app/status")
       end
+
+      # Set integration as primary
+      #
+      # @pathparams
+      # @param `integration_id` [String]
+      # 
+      # @return [number] status
+      #  - Returns 200 if successful
+      def set_integration_as_primary(integration_id)
+        post("/integrations/#{integration_id}/set-primary")
+      end
     end
   end
 end

data/lib/novu/api/subscribers.rb

@@ -45,7 +45,7 @@ module Novu
       # Retrieves the subscriber with the given ID.
       #
       # @pathparams
-      # @param `subscribe_id` [String] The ID of the subscriber to retrieve.
+      # @param `subscriber_id` [String] The ID of the subscriber to retrieve.
       #
       # @return [Hash] The retrieved subscriber.
       # @return [number] status
@@ -103,6 +103,19 @@ module Novu
         put("/subscribers/#{subscriber_id}/credentials", body: body)
       end
 
+      # Delete subscriber credentials by providerId
+      # Delete subscriber credentials such as slack and expo tokens.
+      #
+      # @pathParams:
+      # @param `subscriberId` [String] The ID of the subscriber to update credentials.
+      # @param `providerId` [String] The provider identifier for the credentials
+      #
+      # @return [number] status
+      #  - Returns 204 if the subscriber credentials has been deleted successfully.
+      def delete_subscriber_credentials(subscriberId, providerId)
+        delete("/subscribers/#{subscriberId}/credentials/#{providerId}")
+      end
+
       # Used to update the subscriber isOnline flag.
       #
       # @pathparams:
@@ -207,6 +220,81 @@ module Novu
       #  - Returns 201 if successful
       def mark_message_action_seen(subscriber_id, message_id, type)
         post("/subscribers/#{subscriber_id}/messages/#{message_id}/actions/#{type}")
+      end
+
+			# Using this endpoint you can create multiple subscribers at once, to avoid multiple calls to the API.
+      # The bulk API is limited to 500 subscribers per request.
+      #
+      # @bodyparams:
+      # @param `subscribers` [Array[subscriber]]
+      #     @subscriber : subscriber structure
+      #     @param `firstName` [Stringoptional)] The first name of the subscriber.
+      #     @param `lastName` [Stringoptional)] The last name of the subscriber.
+      #     @param `email` [Stringoptional)] The email of the subscriber.
+      #     @param `data` [Hash(optional)] The data object is used to pass additional custom information that could be used to identify the subscriber.
+      #     @param `phone` [Hash(optional)] This phone of the subscriber.
+      #     @param `locale` [String(optional)] The location of the subscriber.
+      #     @param `subscriberId` [String] A unique identifier for the subscriber, usually correlates to the id the user in your systems.
+      #     @param `avatar` [String(optional)] An http url to the profile image of your subscriber
+			#
+      # @return data [Hash]
+      #   - updated [Array] - If the subscriber was updated
+      #   - created [Array] - Array of objects for the subsribers ID created
+      #   - failed [Array] - In case of an error, this field will contain the error message
+      #   
+      # @return [number] status - The status code. Returns 201 if the subscribers were created successfully.
+			def bulk_create_subscribers(body)
+        post("/subscribers/bulk", body: body.to_json, headers: {'Content-Type': 'application/json'})
+			end
+      # Marks all the subscriber messages as read, unread, seen or unseen.
+      # 
+      # @pathparams
+      # @param `subscriber_id` [String]
+      # 
+      # @bodyParams:
+      # @param `markAs` [String] The type of action to perform either read, unread, seen or unseen.
+      # @param `feedIdentifier` [String|Array(Optional)]  The feed id (or array) to mark messages of a particular feed.
+      #
+      # @return [number] status
+      #  - Returns 201 if successful
+      def mark_all_subscriber_messages(subscriber_id, body)
+        post("/subscribers/#{subscriber_id}/messages/mark-all", body: body)
+      end
+
+      # Handle providers OAUTH redirect
+      #
+      # @pathparams:
+      # @param `subscriberId` [String]
+      # @param `providerId` [String]
+      #
+      # @queryparams:
+      # @param `code` [String]
+      # @param `hmacHash` [String]
+      # @param `environmentId` [String]
+      # @param `integrationIdentifier` [String]
+      #
+      # @return [Hash] The list of changes that match the criteria of the query params are successfully returned.
+      # @return [number] status
+      #  - Returns 200 if successful
+      def provider_oauth_redirect(subscriberId, providerId, query = {})
+        get("/subscribers/#{subscriberId}/credentials/#{providerId}/oauth/callback", query: query)
+      end
+
+      # Handle chat OAUTH
+      #
+      # @pathparams:
+      # @param `subscriberId` [String]
+      # @param `providerId` [String]
+      #
+      # @queryparams:
+      # @param `hmacHash` [String]
+      # @param `environmentId` [String]
+      # @param `integrationIdentifier` [String]
+      #
+      # @return [number] status
+      #  - Returns 200 if successful
+      def chat_oauth(subscriberId, providerId, query = {})
+        get("/subscribers/#{subscriberId}/credentials/#{providerId}/oauth", query: query)
       end
     end
   end

data/lib/novu/api/tenants.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module Novu
+  class Api
+    # Module Novu::Api::Tenants provides an API for managing tenants in the Novu application.
+    #
+    # This module includes methods for creating, retrieving, updating and deleting tenant.
+    #
+    # For more information on the tenants feature (https://docs.novu.co/tenants/introduction), 
+    # for API documentation see https://docs.novu.co/api-reference/tenants/get-tenants.
+    module Tenants
+      # Create a tenant
+      #
+      # @bodyparams:
+      # @param `identifier` [String] - A unique value, and can be used later when pointing to this tenant during trigger calls.
+      # @param `name` [String] - A human-readable name of the tenant.
+      # @param `data` [Hash] - A custom data object that can store information about the tenant. 
+      #
+      # @return [Hash] data - The list of information with respect to the created tenant are successfully returned.
+      # @return [number] status - The status code. Returns 200 if the tenant has been successfully created.
+      def create_tenant(body)
+        post("/tenants", body: body)
+      end
+
+      # Returns a list of tenant that can be paginated using the `page` query parameter and
+      #  set the number of tenants to be with the `limit` query parameter
+      #
+      # @queryparams:
+      # @param `page` [Integer(optional)] - Number of page for the pagination.
+      # @param `limit` [Integer(optional)] - Size of page for the pagination.
+      #
+      # @return [Hash] data - The list of tenants that match the criteria of the query params are successfully returned.
+      # @return [Boolean] hasMore - To specify if the list have more items to fetch
+      # @return [number] page - The current page of the paginated response
+      # @return [number] pageSize - The number of size of each page
+      # @return [number] status
+      #  - Returns 200 if successful
+      def tenants(query = {})
+        get("/tenants", query: query)
+      end
+
+      # Get a tenant by the tenant identifier
+      #
+      # @pathparams
+      # @param `identifier` [String]
+      #
+      # @return [Hash] data -The retrieved topic.
+      # @return [number] status
+      #  - Returns 200 if successful
+      def tenant(identifier)
+        get("/tenants/#{identifier}")
+      end
+
+      # Update a tenant
+      #
+      # @pathparams
+      # @param `identifier` [String]
+      #
+      # @bodyparams:
+      # @param `identifier` [String] - A unique value, and can be used later when pointing to this tenant during trigger calls.
+      # @param `name` [String] - A human-readable name of the tenant.
+      # @param `data` [Hash] - A custom data object that can store information about the tenant. This data can be later accessed inside workflows.
+      #
+      # @return [Hash] data - The list of information with respect to the created tenant are successfully returned.
+      # @return [number] status - The status code. Returns 200 if the tenant has been successfully created.
+      def update_tenant(identifier, body)
+        patch("/tenants/#{identifier}", body: body)
+      end
+
+      # Using a previously create identifier during the tenant ceation, will cancel any active or pending workflows.
+      # This is useful to cancel active digests, delays etc...
+      #
+      # @pathparams:
+      # @param `identifier` [String] - identifier of the tenant
+      #
+      # @return [number] status - The status code. Returns 200 if the event has been successfully cancelled.
+      def delete_tenant(identifier)
+        delete("/tenants/#{identifier}")
+      end
+    end
+  end
+end

data/lib/novu/api/topics.rb

@@ -61,6 +61,18 @@ module Novu
         post("/topics/#{topic_key}/subscribers/removal", body: body)
       end
 
+      # Check topic subsriber
+      # Check if a subscriber belongs to a certain topic
+      #
+      # @pathparams
+      # @param `topic_key` [String]
+      # @param `externalSubscriberId` [String] The id of the subscriber created on `/subscribers` endpoint
+      #
+      # @return [number] status - The status code. Returns 200 if subscriber was added to the topic.
+      def subscriber_topic(topic_key, externalSubscriberId)
+        get("/topics/#{topic_key}/subscribers/#{externalSubscriberId}")
+      end
+
       # Get a topic by its topic key
       #
       # @pathparams
@@ -87,6 +99,17 @@ module Novu
       def rename_topic(topic_key, body)
         patch("/topics/#{topic_key}", body: body)
       end
+
+      # Delete topic
+      # Delete a topic by its topic key if it has no subscribers
+      #
+      # @pathparams
+      # @param `topic_key` [String]
+      #
+      # @return [number] status - The status code. Returns 204 if successfully deleted topic.
+      def delete_topic(topic_key)
+        delete("/topics/#{topic_key}")
+      end
     end
   end
 end

data/lib/novu/client.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "novu/api/blueprints"
 require "novu/api/changes"
 require "novu/api/connection"
 require "novu/api/environments"
@@ -14,11 +15,13 @@ require "novu/api/notification_groups"
 require "novu/api/notification_templates"
 require "novu/api/notification"
 require "novu/api/subscribers"
+require "novu/api/tenants"
 require "novu/api/topics"
 
 module Novu
   class Client
     include HTTParty
+    include Novu::Api::Blueprints
     include Novu::Api::Changes
     include Novu::Api::Connection
     include Novu::Api::Environments
@@ -33,6 +36,7 @@ module Novu
     include Novu::Api::NotificationTemplates
     include Novu::Api::Notification
     include Novu::Api::Subscribers
+    include Novu::Api::Tenants
     include Novu::Api::Topics
 
     base_uri "https://api.novu.co/v1"

data/lib/novu/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Novu
-  VERSION = "0.1.0"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,46 +1,50 @@
 --- !ruby/object:Gem::Specification
 name: novu
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Aman Saini
+- Prosper Otemuyiwa
+- Kolawole Ezekiel
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-03-20 00:00:00.000000000 Z
+date: 2023-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.21'
   name: httparty
   prerelease: false
   type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.21'
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 6.1.7.2
   name: activesupport
   prerelease: false
   type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 6.1.7.2
 description: Client library for Novu API.
 email:
+- prosper@novu.co
 - amansaini0003@gmail.com
+- doneazy911@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -55,6 +59,7 @@ files:
 - README.md
 - Rakefile
 - lib/novu.rb
+- lib/novu/api/blueprints.rb
 - lib/novu/api/changes.rb
 - lib/novu/api/connection.rb
 - lib/novu/api/environments.rb
@@ -69,17 +74,18 @@ files:
 - lib/novu/api/notification_groups.rb
 - lib/novu/api/notification_templates.rb
 - lib/novu/api/subscribers.rb
+- lib/novu/api/tenants.rb
 - lib/novu/api/topics.rb
 - lib/novu/client.rb
 - lib/novu/version.rb
 - sig/novu.rbs
-homepage: https://github.com/amansaini0003/ruby-novu
+homepage: https://github.com/novuhq/novu-ruby
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/amansaini0003/ruby-novu
-  source_code_uri: https://github.com/amansaini0003/ruby-novu
-  changelog_uri: https://github.com/amansaini0003/ruby-novu/blob/main/CHANGELOG.md
+  homepage_uri: https://github.com/novuhq/novu-ruby
+  source_code_uri: https://github.com/novuhq/novu-ruby
+  changelog_uri: https://github.com/novuhq/novu-ruby/blob/main/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -95,7 +101,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: Client library for Novu API.