teleflow 2.0.0

data/Rakefile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+# TODO: add rubocop back to default task once all offenses are corrected
+task default: %i[spec]

data/lib/teleflow/api/blueprints.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Teleflow
+  class Api
+    # Module Teleflow::Api::Blueprints provides an API for managing templated for notifications that are sent out in the Teleflow application.
+    #
+    # This module includes methods for retrieving blueprints by templateID and grouping blueprints by category.
+    #
+    # For more information on the Teleflow Blueprint API, see https://docs.teleflow.khulnasoft.com/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/teleflow/api/changes.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Teleflow
+  class Api
+    # Module Teleflow::Api::Changes provides an API for managing changes in the Teleflow application.
+    #
+    # This module includes methods for retrieving, count, and applying bulk changes.
+    #
+    # For more information on the Teleflow API(https://api-teleflow.khulnasoft.com/api#/Changes), see https://docs.teleflow.khulnasoft.com/api/get-changes/.
+    module Changes
+      # Returns a list of changes that can be paginated using the `page` query parameter
+      #
+      # @queryparams:
+      # @param `page` [Integer(optional)] Number of page for the pagination.
+      # @param `limit` [Integer(optional)]
+      # @param `promoted` [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 changes(query = {})
+        get("/changes", query: query)
+      end
+
+      # Returns changes count
+      #
+      # @return [Hash] changes count
+      # @return [number] status
+      #  - Returns 200 if successful
+      def count_changes
+        get("/changes/count")
+      end
+
+      # 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(changeIds)
+        post("/changes/bulk/apply", body: changeIds)
+      end
+
+      # Apply change
+      #
+      # @pathparams:
+      # @param `change_id` [Integer] The ID of the change to update.
+      #
+      # @return [Hash] updated change.
+      # @return [number] status
+      #  - Returns 201 if the change with the change_id provided has been updated correctly.
+      def apply_change(change_id)
+        post("/changes/#{change_id}/apply")
+      end
+    end
+  end
+end

data/lib/teleflow/api/connection.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Teleflow
+  class Api
+    module Connection
+
+      def get(path, options = {})
+        request :get, path, options
+      end
+
+      def post(path, options = {})
+        request :post, path, options
+      end
+
+      def put(path, options = {})
+        request :put, path, options
+      end
+
+      def patch(path, options = {})
+        request :patch, path, options
+      end
+
+      def delete(path, options = {})
+        request :delete, path, options
+      end
+
+      private
+
+      # Send API Request
+      #
+      # It applies exponential backoff strategy (if enabled) for failed requests. 
+      # It also performs an idempotent request to safely retry requests without having duplication operations.
+      #
+      def request(http_method, path, options)
+
+        if http_method.to_s == 'post' || http_method.to_s == 'patch'
+          self.class.default_options[:headers].merge!({ "Idempotency-Key" => "#{@idempotency_key.to_s.strip}"  }) 
+        end
+
+        response = self.class.send(http_method, path, options)
+
+        if  ! [401, 403, 409, 500, 502, 503, 504].include?(response.code) && ! @enable_retry
+          response
+        elsif @enable_retry
+    
+          if @retry_attempts < @max_retries
+            @retry_attempts += 1
+
+            @backoff.intervals.each do |interval|
+              sleep(interval)
+              request(http_method, path, options)
+            end
+          else
+            raise StandardError, "Max retry attempts reached"
+          end
+        else
+          response
+        end
+      end
+    end
+  end
+end

data/lib/teleflow/api/environments.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module Teleflow
+  class Api
+    # Module Teleflow::Api::Environments provides an API for managing environments in the Teleflow application.
+    #
+    # This module includes methods for creating, retrieving, and updating environments.
+    # It also includes methods for getting and regenerating the api keys also for updatation of widget settings .
+    #
+    # For more information on the Teleflow API(https://api-teleflow.khulnasoft.com/api#/Environments), see https://docs.teleflow.khulnasoft.com/api/get-current-environment/.
+    module Environments
+      # Retrieves the current environment
+      #
+      # @return [Hash] The retrieved environment.
+      # @return [number] status
+      #  - Returns 200 if successful
+      def current_environment
+        get("/environments/me")
+      end
+
+      # Creates a new environment.
+      #
+      # @bodyparams:
+      # @param `name` [String]
+      # @param `parentId` [String(optional)]
+      #
+      # @return [Hash]  The created environment entity.
+      # @return [number] status - The status code. Returns 201 if the environment has been successfully created.
+      def create_environment(body)
+        post("/environments", body: body)
+      end
+
+      # Returns a list of environments
+      #
+      # @return [Hash] The list of environments.
+      # @return [number] status
+      #  - Returns 200 if successful
+      def environments
+        get("/environments")
+      end
+
+      # Update the environment.
+      #
+      # @pathparams:
+      # @param `environment_id` [String] The ID of the environment to update.
+      #
+      # @bodyparams
+      # @param `name` [String(optional)]
+      # @param `identifier` [String(optional)]
+      # @param `parentId` [String(optional)]
+      # @param `dns` [Hash]
+      #
+      # @return [Hash] The updated environment.
+      # @return [number] status
+      #  - Returns 200 if the environment with the environment_id provided has been updated correctly.
+      def update_environment(environment_id, body)
+        put("/environments/#{environment_id}", body: body)
+      end
+
+      # Returns a list of api keys
+      #
+      # @return [Hash] The list of api keys.
+      # @return [number] status
+      #  - Returns 200 if successful
+      def api_keys
+        get("/environments/api-keys")
+      end
+
+      # Return regenerated api keys
+      #
+      # @return [Hash] Api keys.
+      # @return [number] status
+      #  - Returns 200 if successful
+      def regenerate_api_keys
+        post("/environments/api-keys/regenerate")
+      end
+
+      # Update the widget settings.
+      #
+      # @bodyparams
+      # @param `notificationCenterEncryption` [Boolean]
+      #
+      # @return [Hash] The updated environment entity.
+      # @return [number] status
+      #  - Returns 200 if the environment entity updated.
+      def update_widget_settings(body)
+        put("/environments/widget/settings", body: body)
+      end
+    end
+  end
+end

data/lib/teleflow/api/events.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module Teleflow
+  class Api
+    # Module Teleflow::Api::Events provides an API for managing events in the Teleflow application.
+    #
+    # This module includes methods for trigger, bulk trigger, broadcast and cancel events.
+    #
+    # For more information on the Teleflow API(https://api-teleflow.khulnasoft.com/api#/Events), see https://docs.teleflow.khulnasoft.com/api/trigger-event/.
+    module Events
+      # Trigger event is the main (and the only) way to send notification to subscribers.
+      # The trigger identifier is used to match the particular template associated with it.
+      # Additional information can be passed according the body interface below
+      #
+      # @bodyparams:
+      # @param `name` [String] The trigger identifier of the template you wish to send. This identifier can be found on the template page.
+      # @param `payload` [Hash] The payload object is used to pass additional custom information that could be used to render the template, or perform routing rules based on it. This data will also be available when fetching the notifications feed from the API to display certain parts of the UI.
+      # @param `overrides` [Hash(optional)] This could be used to override provider specific configurations.
+      # @param `to` [Hash] The recipients list of people who will receive the notification.
+      # @param `transactionId` [String(optional)] A unique identifier for this transaction, we will generated a UUID if not provided.
+      # @param `actor` [Hash(optional)] It is used to display the Avatar of the provided actor's subscriber id or actor object. If a new actor object is provided, we will create a new subscriber in our system
+      #
+      # @return [Hash]
+      #   - acknowledged [Boolean] - If trigger was acknowledged or not
+      #   - status [String] - Status for trigger
+      #   - error [Array(optional)] - In case of an error, this field will contain the error message
+      #   - transactionId [String(optional)] - Transaction id for trigger
+      # @return [number] status - The status code. Returns 201 if the event has been successfully triggered.
+      def trigger_event(body)
+        post("/events/trigger", body: body)
+      end
+
+      # Using this endpoint you can trigger multiple events at once, to avoid multiple calls to the API.
+      # The bulk API is limited to 100 events per request.
+      #
+      # @bodyparams:
+      # @param `events` [Array[event]]
+      #     @event : event structure
+      #     @param `name` [String] The trigger identifier of the template you wish to send. This identifier can be found on the template page.
+      #     @param `payload` [Hash] The payload object is used to pass additional custom information that could be used to render the template, or perform routing rules based on it. This data will also be available when fetching the notifications feed from the API to display certain parts of the UI.
+      #     @param `overrides` [Hash(optional)] This could be used to override provider specific configurations.
+      #     @param `to` [Hash] The recipients list of people who will receive the notification.
+      #     @param `transactionId` [String(optional)] A unique identifier for this transaction, we will generated a UUID if not provided.
+      #     @param `actor` [Hash(optional)] It is used to display the Avatar of the provided actor's subscriber id or actor object. If a new actor object is provided, we will create a new subscriber in our system
+      #
+      # @return [Hash]
+      #   - acknowledged [Boolean] - If trigger was acknowledged or not
+      #   - status [String] - Status for trigger
+      #   - error [Array(optional)] - In case of an error, this field will contain the error message
+      #   - transactionId [String(optional)] - Transaction id for trigger
+      # @return [number] status - The status code. Returns 201 if the event has been successfully triggered.
+      def trigger_bulk_event(body)
+        post("/events/trigger/bulk", body: body.to_json, headers: {'Content-Type': 'application/json'})
+      end
+
+      # Trigger a broadcast event to all existing subscribers, could be used to send announcements, etc.
+      # In the future could be used to trigger events to a subset of subscribers based on defined filters.
+      #
+      # @bodyparams:
+      # @param `name` [String] The trigger identifier associated for the template you wish to send. This identifier can be found on the template page.
+      # @param `payload` [Hash] The payload object is used to pass additional custom information that could be used to render the template, or perform routing rules based on it. This data will also be available when fetching the notifications feed from the API to display certain parts of the UI
+      # @param `overrides` [Hash(optional)] This could be used to override provider specific configurations.
+      # @param `transactionId` [String(optional)] A unique identifier for this transaction, we will generated a UUID if not provided.
+      # @param `actor` [Hash(optional)] It is used to display the Avatar of the provided actor's subscriber id or actor object. If a new actor object is provided, we will create a new subscriber in our system
+      #
+      # @return [Hash]
+      #   - acknowledged [Boolean] - If trigger was acknowledged or not
+      #   - status [String] - Status for trigger
+      #   - error [Array(optional)] - In case of an error, this field will contain the error message
+      #   - transactionId [String(optional)] - Transaction id for trigger
+      # @return [number] status - The status code. Returns 201 if the event has been successfully broadcast to all existing subscribers.
+      def broadcast_event(body)
+        post("/events/trigger/broadcast", body: body)
+      end
+
+      # Using a previously generated transactionId during the event trigger, will cancel any active or pending workflows.
+      # This is useful to cancel active digests, delays etc...
+      #
+      # @pathparams:
+      # @param `transactionId` [String] - transaction id of the event
+      #
+      # @return [number] status - The status code. Returns 200 if the event has been successfully cancelled.
+      def cancel_triggered_event(transaction_id)
+        delete("/events/trigger/#{transaction_id}")
+      end
+    end
+  end
+end

data/lib/teleflow/api/execution_details.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Teleflow
+  class Api
+    # Module Teleflow::Api::ExecutionDetails provides an API for managing execution details in the Teleflow application.
+    #
+    # This module includes method for retrieving execution details.
+    #
+    # For more information on the Teleflow API(https://api-teleflow.khulnasoft.com/api#/Execution%20Details), see https://docs.teleflow.khulnasoft.com/api/get-execution-details/.
+    module ExecutionDetails
+      # Returns a list of execution details
+      #
+      # @queryparams:
+      # @param `notificationId` [String]
+      # @param `subscriberId` [String]
+      #
+      # @return [Hash] The list of execution details that match the criteria of the query params are successfully returned.
+      # @return [number] status
+      #  - Returns 200 if successful
+      def execution_details(query = {})
+        get("/execution-details", query: query)
+      end
+    end
+  end
+end

data/lib/teleflow/api/feeds.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Teleflow
+  class Api
+    # Module Teleflow::Api::Feeds provides an API for managing feeds in the Teleflow application.
+    #
+    # This module includes methods for creating, retrieving, and deleting feeds.
+    #
+    # For more information on the Teleflow API(https://api-teleflow.khulnasoft.com/api#/Feeds), see https://docs.teleflow.khulnasoft.com/api/create-feed/.
+    module Feeds
+      # Creates a new feed.
+      #
+      # @bodyparams:
+      # @param `name` [String]
+      #
+      # @return [Hash] Feed entity.
+      # @return [number] status - The status code. Returns 201 if the feed has been successfully created.
+      def create_feed(body)
+        post("/feeds", body: body)
+      end
+
+      # Returns a list of feeds
+      #
+      # @return [Hash] list of feeds
+      # @return [number] status
+      #  - Returns 200 if successful
+      def feeds
+        get("/feeds")
+      end
+
+      # Execute a soft delete of a feed given a certain ID.
+      #
+      # @pathparams:
+      # @param `feed_id` [String] The ID of the feed to delete.
+      #
+      # @return [Hash] The retrieved feed.
+      # @return [number] status
+      #  - Returns 204 if the feed has been deleted correctly.
+      def delete_feed(feed_id)
+        delete("/feeds/#{feed_id}")
+      end
+    end
+  end
+end

data/lib/teleflow/api/inbound_parse.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Teleflow
+  class Api
+    # Module Teleflow::Api::InboundParse provides an API for managing inbound-parse in the Teleflow application.
+    #
+    # This module includes method for retrieving inbound-parse.
+    #
+    # For more information on the Teleflow API(https://api-teleflow.khulnasoft.com/api#/inbound-parse), see https://docs.teleflow.khulnasoft.com/api/overview/.
+    module InboundParse
+      # Validate the mx record setup for the inbound parse functionality
+      def validate_mx_record_setup_for_inbound_parse
+        get("/inbound-parse/mx/status")
+      end
+    end
+  end
+end

data/lib/teleflow/api/integrations.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+module Teleflow
+  class Api
+    # Module Teleflow::Api::Integrations provides an API for managing integrations in the Teleflow application.
+    #
+    # This module includes methods for creating, retrieving, updating, and deleting integrations.
+    # It also includes methods for retrieving channel limit, in-app status, webhook provider status.
+    #
+    # For more information on the Teleflow API(https://api-teleflow.khulnasoft.com/api#/Integrations), see https://docs.teleflow.khulnasoft.com/api/get-integrations/.
+    module Integrations
+      # Returns a list of integrations
+      #
+      # @return [Hash] The list of integrations.
+      # @return [number] status
+      #  - Returns 200 if successful
+      def integrations
+        get("/integrations")
+      end
+
+      # Creates a new integration.
+      #
+      # @bodyparams:
+      # @param `providerId` [String]
+      # @param `channel` [String]
+      # @param `credentials` [Hash]
+      # @param `active` [Boolean]
+      # @param `check` [Boolean]
+      #
+      # @return [Hash] The created integration entity.
+      # @return [number] status - The status code. Returns 201 if the intgration has been successfully created.
+      def create_integration(body)
+        post("/integrations", body: body)
+      end
+
+      # Returns a list of active integrations
+      #
+      # @return [Hash] The list of active integrations.
+      # @return [number] status
+      #  - Returns 200 if successful
+      def active_integrations
+        get("/integrations/active")
+      end
+
+      # Get webhook support status for provider
+      #
+      # @pathparams
+      # @param `provider_id` [String]
+      #
+      # @return [number] status
+      #  - Returns 200 if successful
+      def webhook_provider_status(provider_id)
+        get("/integrations/webhook/provider/#{provider_id}/status")
+      end
+
+      # Update the credentials of a integration.
+      #
+      # @pathparams:
+      # @param `integration_id` [Integer] The ID of the integration to update.
+      #
+      # @bodyparams
+      # @param `active` [Boolean]
+      # @param `credentials` [Hash]
+      # @param `check` [Boolean]
+      #
+      # @return [Hash] The updated intgration.
+      # @return [number] status
+      #  - Returns 200 if the integration with the integrationId provided has been updated correctly.
+      def update_integration(integration_id, body)
+        put("/integrations/#{integration_id}", body: body)
+      end
+
+      # Execute a soft delete of a integration given a certain ID.
+      #
+      # @pathparams:
+      # @param `integration_id` [Integer] The ID of the integration to delete.
+      #
+      # @return [Hash] The retrieved integration.
+      # @return [number] status
+      #  - Returns 200 if the integration has been deleted correctly.
+      def delete_integration(integration_id)
+        delete("/integrations/#{integration_id}")
+      end
+
+      # Returns a channel limit
+      #
+      # @pathparams
+      # @param `channel_type` [String]
+      #
+      # @return [number] status
+      #  - Returns 200 if successful
+      def channel_limit(channel_type)
+        get("/integrations/#{channel_type}/limit")
+      end
+
+      # Returns in-app status
+      #
+      # @return [number] status
+      #  - Returns 200 if successful
+      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/teleflow/api/layouts.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+module Teleflow
+  class Api
+    # Module Teleflow::Api::Layouts provides an API for managing layouts in the Teleflow application.
+    #
+    # This module includes methods for creating, retrieving, updating, and deleting layouts.
+    # It also includes methods for setting and getting the default layout.
+    #
+    # For more information on the Teleflow API(https://api-teleflow.khulnasoft.com/api#/Layouts), see https://docs.teleflow.khulnasoft.com/api/layout-creation/.
+    module Layouts
+      # Creates a new layout.
+      #
+      # @bodyparams:
+      # @param `name` [String] User defined custom name and provided by the user that will name the Layout created.
+      # @param `content` [String] User defined content for the layout.
+      # @param `description` [String(optional)] User description of the layout.
+      # @param `variables` [Array(optional)] User defined variables to render in the layout placeholders.
+      # @param `isDefault` [Boolean(optional)] User defined variables to render in the layout placeholders.
+      #
+      # @return [_id: "_id"] The created layout id.
+      # @return [number] status - The status code. Returns 201 if the layout has been successfully created.
+      def create_layout(body)
+        post("/layouts", body: body)
+      end
+
+      # Returns a list of layouts 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.
+      # @param `pageSize` [Integer(optional)] Size of page for the pagination.
+      # @param `sortBy` [String(optional)] Sort field. Currently only supported `createdAt`.
+      # @param `orderBy` [Integer(optional)] Direction of the sorting query param. Either ascending (1) or descending (-1).
+      #
+      # @return [Hash] The list of layouts that match the criteria of the query params are successfully returned.
+      # @return [number] status
+      #  - Returns 200 if successful
+      #  - Returns 400 if Page size can not be larger than the page size limit.
+      def layouts(query = {})
+        get("/layouts", query: query)
+      end
+
+      # Retrieves the layout with the given ID.
+      #
+      # @pathparams
+      # @param `layout_id` [Integer] The ID of the layout to retrieve.
+      #
+      # @return [Hash] The retrieved layout.
+      # @return [number] status
+      #  - Returns 200 if the layout with the layoutId provided exists in the database.
+      #  - Returns 404 The layout with the layoutId provided does not exist in the database.
+      def layout(layout_id)
+        get("/layouts/#{layout_id}")
+      end
+
+      # Execute a soft delete of a layout given a certain ID.
+      #
+      # @pathparams:
+      # @param `layout_id` [Integer] The ID of the layout to delete.
+      #
+      # @return [Hash] The retrieved layout.
+      # @return [number] status
+      #  - Returns 204 if the layout has been deleted correctly.
+      #  - Returns 404 if the layout with the layoutId provided does not exist in the database so it can not be deleted.
+      #  - Returns 409 if either you are trying to delete a layout that is being used or a layout that is the default in the environment.
+      def delete_layout(layout_id)
+        delete("/layouts/#{layout_id}")
+      end
+
+      # Update the name, content and variables of a layout. Also change it to be default or no.
+      #
+      # @pathparams:
+      # @param `layout_id` [Integer] The ID of the layout to update.
+      #
+      # @bodyparams
+      # @param `name` [String(optional)] User defined custom name and provided by the user that will name the Layout updated.
+      # @param `description` [String(optional)] User defined description of the layout.
+      # @param `content` [String(optional)] User defined content for the layout.
+      # @param `variables` [Array(optional)] User defined variables to render in the layout placeholders.
+      # @param `isDefault` [Boolean(optional)] Variable that defines if the layout is chosen as default when creating a layout.
+      #
+      # @return [Hash] The updated layout.
+      # @return [number] status
+      #  - Returns 200 if the layout with the layoutId provided has been updated correctly.
+      #  - Returns 400 if the payload provided or the URL param are not right.
+      #  - Returns 404 if the layout with the layoutId provided does not exist in the database so it can not be updated.
+      #  - Returns 409 if one default layout is needed. If you are trying to turn a default layout as not default, you should turn a different layout as default first and automatically it will be done by the system.
+      def update_layout(layout_id, body)
+        patch("/layouts/#{layout_id}", body: body)
+      end
+
+      # Sets the default layout for the environment and updates to non default to the existing default layout (if any).
+      #
+      # @pathparams:
+      # @param `layout_id` [Integer] The ID of the layout to set the default.
+      #
+      # @return [number] status
+      #  - Returns 204 if the selected layout has been set as the default for the environment.
+      #  - Returns 404 if the layout with the layoutId provided does not exist in the database so it can not be set as the default for the environment.
+      def make_default_layout(layout_id)
+        post("/layouts/#{layout_id}/default")
+      end
+    end
+  end
+end