teleflow 2.0.0

data/lib/teleflow/api/messages.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Teleflow
+  class Api
+    # Module Teleflow::Api::Messages provides an API for managing messages in the Teleflow application.
+    #
+    # This module includes methods for retrieving, and deleting messages.
+    #
+    # For more information on the Teleflow API(https://api-teleflow.khulnasoft.com/api#/Messages), see https://docs.teleflow.khulnasoft.com/api/get-messages/.
+    module Messages
+      # Returns a list of messages that can be paginated using the `page` query parameter and
+      # filtered by the environment where it is executed from the organization the user belongs to.
+      #
+      # @queryparams:
+      # @param `page` [Integer(optional)] Number of page for the pagination. The page to fetch, defaults to 0.
+      # @param `limit` [Integer(optional)] The number of messages to fetch, defaults to 10.
+      # @param `channel` [String(optional)] The channel for the messages you wish to list.
+      # @param `subscriberId` [String(optional)] The subscriberId for the subscriber you like to list messages for.
+      #
+      # @return [Hash] The list of messages that match the criteria of the query params are successfully returned.
+      # @return [number] status
+      #  - Returns 200 if successful
+      def messages(query = {})
+        get("/messages", query: query)
+      end
+
+      # Deletes a message entity from the Teleflow platform
+      #
+      # @pathparams:
+      # @param `message_id` [String] The ID of the message to delete.
+      #
+      # @return [Hash] of acknowledged and status.
+      # @return [number] status
+      #  - Returns 200 if the message has been deleted correctly.
+      def delete_message(message_id)
+        delete("/messages/#{message_id}")
+      end
+    end
+  end
+end

data/lib/teleflow/api/notification.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Teleflow
+  class Api
+    # Module Teleflow::Api::Notification provides an API for managing Notification in the Teleflow application.
+    #
+    # This module includes methods for retrieving notifications, notifications stats and notifications graph stats.
+    #
+    # For more information on the Teleflow API(https://api-teleflow.khulnasoft.com/api#/Notification), see https://docs.teleflow.khulnasoft.com/api/.
+    module Notification
+      # Returns a list of notifications that can be paginated using the `page` query parameter and
+      # filtered by the environment where it is executed from the organization the user belongs to.
+      #
+      # @queryparams:
+      # @param `channels` [Array[String]] Available values : in_app, email, sms, chat, push
+      # @param `templates` [Array[String]]
+      # @param `emails` [Array[String]]
+      # @param `search` [String(optional)]
+      # @param `transactionId` [String(optional)]
+      # @param `page` [Integer(optional)] Number of page for the pagination. Default value is 0
+      #
+      # @return [Hash] The list of notification that match the criteria of the query params are successfully returned.
+      # @return [number] status
+      #  - Returns 200 if successful.
+      def notifications(query = {})
+        get("/notifications", query: query)
+      end
+
+      # Returns a list of notifications stats
+      #
+      # @return [Hash] notification stats.
+      # @return [number] status
+      #  - Returns 200 if successful.
+      def notifications_stats
+        get("/notifications/stats")
+      end
+
+      # Returns a list of notifications stats
+      #
+      # @queryparams:
+      # @param `days` [Integer]
+      #
+      # @return [Hash] notification graph stats.
+      # @return [number] status
+      #  - Returns 200 if successful.
+      def notifications_graph_stats(query = {})
+        get("/notifications/graph/stats", query: query)
+      end
+
+      # Returns a notification
+      #
+      # @pathparams:
+      # @param `notification_id` [String]
+      #
+      # @return [Hash] notification entity
+      # @return [number] status
+      #  - Returns 200 if successful.
+      def notification(notification_id)
+        get("/notifications/#{notification_id}")
+      end
+    end
+  end
+end

data/lib/teleflow/api/notification_groups.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Teleflow
+  class Api
+    # Module Teleflow::Api::NotificationGroups provides an API for managing notification groups in the Teleflow application.
+    #
+    # This module includes methods for creating, retrieving notification groups.
+    #
+    # For more information on the Teleflow API(https://api-teleflow.khulnasoft.com/api#/Notification%20groups), see https://docs.teleflow.khulnasoft.com/api/create-notification-group/.
+    module NotificationGroups
+      # Creates a notification group.
+      #
+      # @bodyparams:
+      # @param `name` [String] User defined custom name and provided by the user that will name the notification group created.
+      #
+      # @return [Hash] The created notification group entity.
+      # @return [number] status - The status code. Returns 201 if the notification group has been successfully created.
+      def create_notification_group(body)
+        post("/notification-groups", body: body)
+      end
+
+      # Returns a list of notification groups
+      #
+      # @return [Hash] list of notification groups.
+      # @return [number] status
+      #  - Returns 200 if successful
+      def notification_groups
+        get("/notification-groups")
+      end
+    end
+  end
+end

data/lib/teleflow/api/notification_templates.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+module Teleflow
+  class Api
+    # Module Teleflow::Api::NotificationTemplates provides an API for managing notification templates in the Teleflow application.
+    #
+    # This module includes methods for creating, retrieving, updating, and deleting notification templates.
+    # It also includes methods for creating and retrieving the notification blueprint.
+    #
+    # For more information on the Teleflow API(https://api-teleflow.khulnasoft.com/api#/Notification%20templates), see https://docs.teleflow.khulnasoft.com/api/get-notification-templates/.
+    module NotificationTemplates
+      # Returns a list of notification template that can be paginated using the `page` query parameter
+      #
+      # @queryparams:
+      # @param `page` [Integer(optional)] Number of page for the pagination.
+      # @param `limit` [Integer(optional)]
+      #
+      # @return [Hash] The list of notification templates that match the criteria of the query params are successfully returned.
+      # @return [number] status
+      #  - Returns 200 if successful
+      def notification_templates(query = {})
+        get("/notification-templates", query: query)
+      end
+
+      # Creates a new notification template.
+      #
+      # @bodyparams:
+      # @param `name` [String]
+      # @param `notificationGroupId` [String]
+      # @param `tags` [Array(optional)]
+      # @param `description` [String(optional)]
+      # @param `steps` [Array]
+      # @param `active` [Boolean(optional)]
+      # @param `draft` [Boolean(optional)]
+      # @param `critical` [Boolean(optional)]
+      # @param `preferenceSettings` [Hash(optional)]
+      #
+      # @return [Hash] Notification template entity.
+      # @return [number] status - The status code. Returns 201 if the notification template has been successfully created.
+      def create_notification_template(body)
+        post("/notification-templates", body: body)
+      end
+
+      # Updates new notification template.
+      #
+      # @pathparams:
+      # @param `template_id` [String] The ID of the notification template to update.
+      #
+      # @bodyparams:
+      # @param `name` [String]
+      # @param `tags` [Array(optional)]
+      # @param `description` [String(optional)]
+      # @param `identifier` [String(optional)]
+      # @param `steps` [Array(optional)]
+      # @param `notificationGroupId` [String]
+      # @param `active` [Boolean(optional)]
+      # @param `critical` [Boolean(optional)]
+      # @param `preferenceSettings` [Hash(optional)]
+      #
+      # @return [Hash] Updated notification template entity.
+      # @return [number] status - The status code. Returns 200 if the notification template has been successfully updated.
+      def update_notification_template(template_id, body)
+        put("/notification-templates/#{template_id}", body: body)
+      end
+
+      # Execute a soft delete of a notification template given a certain ID.
+      #
+      # @pathparams:
+      # @param `template_id` [String] The ID of the template to delete.
+      #
+      # @return [number] status
+      #  - Returns 200 if the notification template has been deleted correctly.
+      def delete_notification_template(template_id)
+        delete("/notification-templates/#{template_id}")
+      end
+
+      # Retrieves the notification template with the given ID.
+      #
+      # @pathparams
+      # @param `template_id` [String] The ID of the template to retrieve.
+      #
+      # @return [Hash] The retrieved template.
+      # @return [number] status
+      #  - Returns 200 if the template with the template_id provided exists in the database.
+      def notification_template(template_id)
+        get("/notification-templates/#{template_id}")
+      end
+
+      # Retrieves the notification template blueprint with the given ID.
+      #
+      # @pathparams
+      # @param `template_id` [String] The ID of the template to retrieve.
+      #
+      # @return [Hash] The retrieved template blueprint.
+      # @return [number] status
+      #  - Returns 200 if the template blueprint with the template_id provided exists in the database.
+      def notification_template_blueprint(template_id)
+        get("/notification-templates/#{template_id}/blueprint")
+      end
+
+      # Creates a new notification template blueprint.
+      #
+      # @return [Hash] Notification template blueprint entity.
+      # @return [number] status - The status code. Returns 201 if the notification template blueprint has been successfully created.
+      def create_notification_template_blueprint(template_id)
+        post("/notification-templates/#{template_id}/blueprint")
+      end
+
+      # Update notification template status
+      #
+      # @pathparams:
+      # @param `template_id` [String] The ID of the template to update.
+      #
+      # @bodyparams
+      # @param `active` [Boolean]
+      #
+      # @return [Hash] The updated notification template.
+      # @return [number] status
+      #  - Returns 200 if the notification template with the template_id provided has been updated correctly.
+      def update_notification_template_status(template_id, body)
+        put("/notification-templates/#{template_id}/status", body: body)
+      end
+    end
+  end
+end

data/lib/teleflow/api/organizations.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module Teleflow
+	class Api
+		# Module Teleflow::Api::Organizations provides an API for managing Organization within your Teleflow account.
+		#
+		# This module includes methods for creating, retrieving, updating and deleting organization.
+		#
+		# For more information on the Teleflow API see https://api-teleflow.khulnasoft.com/api#/Organizations, https://docs.teleflow.khulnasoft.com/api-reference/organizations/create-organization.
+		module Organizations
+			# Create an organization
+      #
+      # @bodyparams:
+      # @param `logo` [String] - A valid image URL with one of the following extensions: jpg, jpeg, png, gif, svg.
+      # @param `name` [String] - A human-readable name of the organization.
+      #
+      # @return [Hash] data - The list of information with respect to the created organization.
+      # @return [number] status - The status code. Returns 200 if the organization has been successfully created.
+      def create_organization(body)
+        post("/organizations", body: body)
+      end
+
+      # Get all organizations
+      #
+      # @return [Hash] data - The list of organizations already created.
+      # @return [number] status - Returns 200 if successful
+      def organizations()
+        get("/organizations")
+      end
+
+      # Get details of the current organization
+      #
+      # @return [Hash] data - The details of the current organization.
+      # @return [number] status - Returns 200 if successful
+      def current_organization()
+        get("/organizations/me")
+      end
+
+      # Get all members of the current organization
+      #
+      # @return [Hash] data - The list of all members of the current organization.
+      # @return [number] status - Returns 200 if successful
+      def current_organization_members()
+        get("/organizations/members")
+      end
+
+      # Rename organization name
+      #
+      # @return [Hash] data - The list of updated details of the organization.
+      # @return [number] status - Returns 200 if successful
+      def rename_organization(body)
+        patch("/organizations", body: body)
+      end
+
+      # Update organization branding details
+      #
+      # @bodyparams:
+      # @param `logo` [String] - A valid image URL with one of the following extensions: jpg, jpeg, png, gif, svg.
+      # @param `color` [String] - The hexadecimal color style of the organization.
+      # @param `contentBackground` [String] - The hexadecimal content background style of the organization.
+      # @param `fontColor` [String] - The hexadecimal font color style of the organization.
+      # @param `fontFamily` [String(optional)] - The font family style of the organization.
+      #
+      # @return [Hash] data - The list of branding details of the organization.
+      # @return [number] status - Returns 200 if successful
+      def organization_branding(body)
+        put("/organizations/branding", body: body)
+      end
+
+      # Remove a member from organization
+      #
+      # @pathparams
+      # @param `member_id` [String]
+      #
+      # @return [number] status - The status code. Returns 200 if memeber was removed successfully by their id.
+      def delete_organization_member(member_id)
+        delete("/organizations/members/#{member_id}")
+      end
+		end
+	end
+end

data/lib/teleflow/api/subscribers.rb

@@ -0,0 +1,301 @@
+# frozen_string_literal: true
+
+module Teleflow
+  class Api
+    # Module Teleflow::Api::Subscribers provides an API for managing subscribers in the Teleflow application.
+    #
+    # This module includes methods for creating, retrieving, updating, and deleting subscribers.
+    # It also includes methods for updating subscriber credentials, online status, preferences etc.
+    #
+    # For more information on the Teleflow API(https://api-teleflow.khulnasoft.com/api#/Subscribers), see https://docs.teleflow.khulnasoft.com/api/get-subscribers/.
+    module Subscribers
+      # Returns a list of subscribers, could paginated using the `page` query parameter
+      #
+      # @queryparams:
+      # @param `page` [Integer(optional)] Number of page for the pagination. The page to fetch, defaults to 0.
+      #
+      # @return [Hash] The list of subscribers that match the criteria of the query params are successfully returned.
+      # @return [number] status
+      #  - Returns 200 if successful
+      def subscribers(query = {})
+        get("/subscribers", query: query)
+      end
+
+      # Creates a subscriber entity, in the Teleflow platform.
+      # The subscriber will be later used to receive notifications, and access notification feeds.
+      # Communication credentials such as email, phone number, and 3 rd party credentials
+      # i.e slack tokens could be later associated to this entity.
+      #
+      # @bodyparams:
+      # @param `subscriberId` [String] The internal identifier you used to create this subscriber, usually correlates to the id the user in your systems.
+      # @param `email` [String(optional)]
+      # @param `firstName` [String(optional)]
+      # @param `lastName` [String(optional)]
+      # @param `phone` [String(optional)]
+      # @param `avatar` [String(optional)] An http url to the profile image of your subscriber
+      # @param `locale` [String(optional)]
+      # @param `data` [Hash(optional)]
+      #
+      # @return [Hash] The hash of subscriber data is successfully returned.
+      # @return [number] status - The status code. Returns 201 if the susbscriber has been successfully created.
+      def create_subscriber(body)
+        post("/subscribers", body: body)
+      end
+
+      # Retrieves the subscriber with the given ID.
+      #
+      # @pathparams
+      # @param `subscriber_id` [String] The ID of the subscriber to retrieve.
+      #
+      # @return [Hash] The retrieved subscriber.
+      # @return [number] status
+      #  - Returns 200 if the subscriber with the subscriber_id provided exists in the database.
+      def subscriber(subscriber_id)
+        get("/subscribers/#{subscriber_id}")
+      end
+
+      # Used to update the subscriber entity with new information
+      #
+      # @pathparams:
+      # @param `subscriber_id` [String] The ID of the subscriber to update.
+      #
+      # @bodyparams
+      # @param `email` [String(optional)]
+      # @param `firstName` [String(optional)]
+      # @param `lastName` [String(optional)]
+      # @param `phone` [String(optional)]
+      # @param `avatar` [String(optional)]
+      # @param `locale` [String(optional)]
+      # @param `data` [String(optional)]
+      #
+      # @return [Hash] The updated subscriber entity.
+      # @return [number] status
+      #  - Returns 200 if the subscriber with the subscriber_id provided has been updated correctly.
+      def update_subscriber(subscriber_id, body)
+        put("/subscribers/#{subscriber_id}", body: body)
+      end
+
+      # Deletes a subscriber entity from the Teleflow platform
+      #
+      # @pathparams:
+      # @param `subscriber_id` [String] The ID of the subscriber to delete.
+      #
+      # @return [Hash] Hash of acknowledged and status.
+      # @return [number] status
+      #  - Returns 200 if the subscriber has been deleted correctly.
+      def delete_subscriber(subscriber_id)
+        delete("/subscribers/#{subscriber_id}")
+      end
+
+      # Update subscriber credentials from the Teleflow platform. Subscriber credentials associated to the delivery methods such as slack and push tokens.
+      #
+      # @pathparams:
+      # @param `subscriber_id` [String] The ID of the subscriber to update credentials.
+      #
+      # @bodyparams:
+      # @param `providerId` [String] The provider identifier for the credentials
+      # @param `credentials` [Hash] Credentials payload for the specified provider
+      #
+      # @return [Hash] Hash of updated subscriber credentials entity
+      # @return [number] status
+      #  - Returns 200 if the subscriber credentials has been updated correctly.
+      def update_subscriber_credentials(subscriber_id, body)
+        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:
+      # @param `subscriber_id` [String] The ID of the subscriber to update online status.
+      #
+      # @bodyparams:
+      # @param `isOnline` [Boolean]
+      #
+      # @return [Hash] The updated subscriber entity.
+      # @return [number] status
+      #  - Returns 200 if the subscriber online status has been updated correctly.
+      def update_subscriber_online_status(subscriber_id, body)
+        patch("/subscribers/#{subscriber_id}/online-status", body: body)
+      end
+
+      # Used to get the subscriber preference
+      #
+      # @pathparams:
+      # @param `subscriber_id` [String] The ID of the subscriber.
+      #
+      # @return [Hash] Hash of template and preference.
+      # @return [number] status
+      #  - Returns 200 if the subscriber preference has been retrieved successfully.
+      def subscriber_preferences(subscriber_id)
+        get("/subscribers/#{subscriber_id}/preferences")
+      end
+
+      # Used to update the subscriber preference
+      #
+      # @pathparams:
+      # @param `subscriber_id` [String] The ID of the subscriber to update preference.
+      # @param `template_id` [String] The ID of the template to update preference.
+      #
+      # @bodyparams:
+      # @param `channel` [Hash(optional)] The subscriber preferences for every ChannelTypeEnum for the notification template assigned.
+      # @param `enabled` [Boolean(optional)] Sets if the notification template is fully enabled for all channels or not for the subscriber.
+      #
+      # @return [Hash] Hash of template and preference.
+      # @return [number] status
+      #  - Returns 200 if the subscriber preference has been updated correctly.
+      def update_subscriber_preference(subscriber_id, template_id, body)
+        patch("/subscribers/#{subscriber_id}/preferences/#{template_id}", body: body)
+      end
+
+      # Returns a notification feed for a particular subscriber
+      #
+      # @pathparams
+      # @param `subscriber_id` [String]
+      #
+      # @queryparams:
+      # @param `page` [Integer(optional)] Number of page for the pagination.
+      # @param `feedIdentifier` [String]
+      # @param `seen` [Boolean(optional)]
+      #
+      # @return [Hash] List of notification feed of a subscriber that match the criteria of the query params are successfully returned.
+      # @return [number] status
+      #  - Returns 200 if successful
+      def subscriber_notification_feed(subscriber_id, query = {})
+        get("/subscribers/#{subscriber_id}/notifications/feed", query: query)
+      end
+
+      # Returns the unseen notification count for subscribers feed
+      #
+      # @pathparams
+      # @param `subscriber_id` [String]
+      #
+      # @queryparams:
+      # @param `seen` [Boolean]
+      #
+      # @return [Hash] the unseen notification count
+      # @return [number] status
+      #  - Returns 200 if successful
+      def subscriber_unseen_notification_count(subscriber_id, query = {})
+        get("/subscribers/#{subscriber_id}/notifications/unseen", query: query)
+      end
+
+      # Mark a subscriber feed message as seen
+      #
+      # @pathparams
+      # @param `subscriber_id` [String]
+      #
+      # @bodyparams:
+      # @param `messageId` [Hash]
+      # @param `mark` [Hash]
+      #
+      # @return [Hash] the unseen notification count
+      # @return [number] status
+      #  - Returns 201 if successful
+      def mark_subscriber_feed_seen(subscriber_id, body)
+        post("/subscribers/#{subscriber_id}/messages/markAs", body: body)
+      end
+
+      # Mark message action as seen
+      #
+      # @pathparams
+      # @param `message_id` [String]
+      # @param `type` [String]
+      # @param `subscriber_id` [String]
+      #
+      # @return [Hash] the unseen notification count
+      # @return [number] status
+      #  - 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
+end