whatsapp_sdk 0.7.2 → 0.8.0

data/lib/whatsapp_sdk/resource/interactive.rb

@@ -0,0 +1,89 @@
+# typed: strict
+# frozen_string_literal: true
+
+module WhatsappSdk
+  module Resource
+    class Interactive
+      extend T::Sig
+
+      class Type < T::Enum
+        extend T::Sig
+
+        enums do
+          ListMessage = new("list")
+          ReplyButton = new("button")
+          SingleProductMessage = new("product")
+          MultiProductMessage = new("product_list")
+        end
+      end
+
+      # Returns the Interactive type of message you want to send.
+      #
+      # @returns type [Type]. Supported Options are list, button, product and product_list.
+      sig { returns(Type) }
+      attr_accessor :type
+
+      # Returns the interactive header if present. Required for type product_list.
+      #
+      # @returns type [InteractiveHeader] It can be nil.
+      sig { returns(T.nilable(InteractiveHeader)) }
+      attr_accessor :header
+
+      # Returns the interactive body.
+      #
+      # @returns type [InteractiveBody] Valid option is of type text only.
+      sig { returns(InteractiveBody) }
+      attr_accessor :body
+
+      # Returns the interactive footer if present.
+      #
+      # @returns type [InteractiveFooter] Valid option is of type text only. It can be nil.
+      sig { returns(T.nilable(InteractiveFooter)) }
+      attr_accessor :footer
+
+      # Returns the interactive action.
+      #
+      # @returns type [InteractiveBody] Valid condition is buttons of length of 1, 2 or 3 if type is button.
+      sig { returns(InteractiveAction) }
+      attr_accessor :action
+
+      sig do
+        params(
+          type: Type, body: InteractiveBody, action: InteractiveAction,
+          header: T.nilable(InteractiveHeader), footer: T.nilable(InteractiveFooter)
+        ).void
+      end
+      def initialize(type:, body:, action:, header: nil, footer: nil)
+        @type = type
+        @body = body
+        @action = action
+        @header = header
+        @footer = footer
+        validate
+      end
+
+      sig { returns(T::Hash[T.untyped, T.untyped]) }
+      def to_json
+        json = { type: type.serialize }
+        json[:header] = header.to_json if header
+        json[:body] = body.to_json
+        json[:footer] = footer.to_json if footer
+        json[:action] = action.to_json
+
+        json
+      end
+
+      private
+
+      sig { void }
+      def validate
+        validate_action
+      end
+
+      sig { void }
+      def validate_action
+        action.validate
+      end
+    end
+  end
+end

data/lib/whatsapp_sdk/resource/interactive_action.rb

@@ -0,0 +1,133 @@
+# typed: strict
+# frozen_string_literal: true
+
+module WhatsappSdk
+  module Resource
+    class InteractiveAction
+      extend T::Sig
+
+      class Type < T::Enum
+        extend T::Sig
+
+        enums do
+          ListMessage = new("list_message")
+          ReplyButton = new("reply_button")
+        end
+      end
+
+      # Returns the type of interactive action you want to send.
+      #
+      # @returns type [Type]. Supported Options are list_message and reply_button.
+      sig { returns(Type) }
+      attr_accessor :type
+
+      # Returns the buttons of the Action. For reply_button type, it's required.
+      #
+      # @returns buttons [Array<InteractiveActionReplyButton>] .
+      sig { returns(T::Array[InteractiveActionReplyButton]) }
+      attr_accessor :buttons
+
+      # Returns the button of the Action. For list_message type, it's required.
+      #
+      # @returns button [String] .
+      sig { returns(String) }
+      attr_accessor :button
+
+      # Returns the sections of the Action. For list_message type, it's required.
+      #
+      # @returns sections [Array<InteractiveActionSection>] .
+      sig { returns(T::Array[InteractiveActionSection]) }
+      attr_accessor :sections
+
+      # TODO: attr_accessor :catalog_id
+      # TODO: attr_accessor :product_retailer_id
+
+      sig { params(reply_button: InteractiveActionReplyButton).void }
+      def add_reply_button(reply_button)
+        @buttons << reply_button
+      end
+
+      sig { params(section: InteractiveActionSection).void }
+      def add_section(section)
+        @sections << section
+      end
+
+      REPLY_BUTTONS_MINIMUM = 1
+      REPLY_BUTTONS_MAXIMUM = 3
+      LIST_BUTTON_TITLE_MAXIMUM = 20
+      LIST_SECTIONS_MINIMUM = 1
+      LIST_SECTIONS_MAXIMUM = 10
+
+      sig do
+        params(
+          type: Type, buttons: T::Array[InteractiveActionReplyButton],
+          button: String, sections: T::Array[InteractiveActionSection],
+        ).void
+      end
+      def initialize(type:, buttons: [], button: "", sections: [])
+        @type = type
+        @buttons = buttons
+        @button = button
+        @sections = sections
+      end
+
+      sig { returns(T::Hash[T.untyped, T.untyped]) }
+      def to_json
+        json = {}
+        case type.serialize
+        when "list_message"
+          json = { button: button, sections: sections.map(&:to_json) }
+        when "reply_button"
+          json = { buttons: buttons.map(&:to_json) }
+        end
+
+        json
+      end
+
+      def validate
+        validate_fields
+      end
+
+      private
+
+      def validate_fields
+        case type.serialize
+        when "list_message"
+          button_length = button.length
+          sections_count = sections.length
+          unless button_length > 0
+            raise WhatsappSdk::Resource::Error::InvalidInteractiveActionButton,
+                  "Invalid button in action. Button label is required."
+          end
+
+          unless button_length <= LIST_BUTTON_TITLE_MAXIMUM
+            raise WhatsappSdk::Resource::Error::InvalidInteractiveActionButton,
+                  "Invalid length #{button_length} for button. Maximum length: " \
+                  "#{LIST_BUTTON_TITLE_MAXIMUM} characters."
+          end
+
+          unless (LIST_SECTIONS_MINIMUM..LIST_SECTIONS_MAXIMUM).cover?(sections_count)
+            raise WhatsappSdk::Resource::Error::InvalidInteractiveActionSection,
+                  "Invalid length #{sections_count} for sections in action. It should be between " \
+                  "#{LIST_SECTIONS_MINIMUM} and #{LIST_SECTIONS_MAXIMUM}."
+          end
+
+          sections.each { |section| section.validate }
+        when "reply_button"
+          buttons_count = buttons.length
+          unless (REPLY_BUTTONS_MINIMUM..REPLY_BUTTONS_MAXIMUM).cover?(buttons_count)
+            raise WhatsappSdk::Resource::Error::InvalidInteractiveActionReplyButton,
+                  "Invalid length #{buttons_count} for buttons in action. It should be between " \
+                  "#{REPLY_BUTTONS_MINIMUM} and #{REPLY_BUTTONS_MAXIMUM}."
+          end
+
+          button_ids = buttons.map(&:id)
+          return if button_ids.length.eql?(button_ids.uniq.length)
+
+          raise WhatsappSdk::Resource::Error::InvalidInteractiveActionReplyButton,
+                "Duplicate ids #{button_ids} for buttons in action. They should be unique."
+        end
+      end
+    end
+  end
+end

data/lib/whatsapp_sdk/resource/interactive_action_reply_button.rb

@@ -0,0 +1,88 @@
+# typed: strict
+# frozen_string_literal: true
+
+module WhatsappSdk
+  module Resource
+    class InteractiveActionReplyButton
+      extend T::Sig
+
+      class Type < T::Enum
+        extend T::Sig
+
+        enums do
+          Reply = new("reply")
+        end
+      end
+
+      # Returns the ActionButton type of message you want to send.
+      #
+      # @returns type [String]. Supported Options are reply only.
+      sig { returns(Type) }
+      attr_accessor :type
+
+      # Returns the ActionButton title you want to send.
+      #
+      # @returns title [String]. The character limit is 20 characters.
+      sig { returns(String) }
+      attr_accessor :title
+
+      # Returns the ActionButton unique identifier you want to send.
+      # This ID is returned in the webhook when the button is clicked by the user.
+      #
+      # @returns id [String]. The character limit is 256 characters.
+      sig { returns(String) }
+      attr_accessor :id
+
+      ACTION_BUTTON_TITLE_MAXIMUM = 20
+      ACTION_BUTTON_ID_MAXIMUM = 256
+
+      sig { params(title: String, id: String).void }
+      def initialize(title:, id:)
+        @type = Type::Reply
+        @title = title
+        @id = id
+        validate
+      end
+
+      def to_json
+        json = { type: type.serialize }
+        json[type.serialize.to_sym] = {
+          id: id,
+          title: title
+        }
+
+        json
+      end
+
+      private
+
+      sig { void }
+      def validate
+        validate_title
+        validate_id
+      end
+
+      sig { void }
+      def validate_title
+        title_length = title.length
+        return if title_length <= ACTION_BUTTON_TITLE_MAXIMUM
+
+        raise WhatsappSdk::Resource::Error::InvalidInteractiveActionReplyButton,
+              "Invalid length #{title_length} for title in button. " \
+              "Maximum length: #{ACTION_BUTTON_TITLE_MAXIMUM} characters."
+      end
+
+      sig { void }
+      def validate_id
+        id_unfrozen = id.dup
+        id_unfrozen.strip!  # You cannot have leading or trailing spaces when setting the ID.
+        id = id_unfrozen.freeze
+        id_length = id.length
+        return if id_length <= ACTION_BUTTON_ID_MAXIMUM
+
+        raise WhatsappSdk::Resource::Error::InvalidInteractiveActionReplyButton,
+              "Invalid length #{id_length} for id in button. Maximum length: #{ACTION_BUTTON_ID_MAXIMUM} characters."
+      end
+    end
+  end
+end

data/lib/whatsapp_sdk/resource/interactive_action_section.rb

@@ -0,0 +1,75 @@
+# typed: strict
+# frozen_string_literal: true
+
+module WhatsappSdk
+  module Resource
+    class InteractiveActionSection
+      extend T::Sig
+
+      # Returns the ActionSection title you want to send.
+      #
+      # @returns title [String]. The character limit is 24 characters.
+      sig { returns(String) }
+      attr_accessor :title
+
+      # Returns the ActionSection rows you want to send.
+      #
+      # @returns id [T::Array[InteractiveActionSectionRow]]. There must be at least one rows object.
+      sig { returns(T::Array[InteractiveActionSectionRow]) }
+      attr_accessor :rows
+
+      sig { params(row: InteractiveActionSectionRow).void }
+      def add_row(row)
+        @rows << row
+      end
+
+      ACTION_SECTION_TITLE_MAXIMUM = 24
+      ACTION_SECTION_ROWS_MAXIMUM = 10
+
+      sig { params(title: String, rows: T::Array[InteractiveActionSectionRow]).void }
+      def initialize(title:, rows: [])
+        @title = title
+        @rows = rows
+        validate(skip_rows: true)
+      end
+
+      def to_json
+        json = {
+          title: title,
+          rows: rows.map(&:to_json),
+        }
+
+        json
+      end
+
+      sig { params(skip_rows: T.nilable(T::Boolean)).void }
+      def validate(skip_rows: false)
+        validate_title
+        validate_rows unless skip_rows
+      end
+
+      private
+
+      sig { void }
+      def validate_title
+        title_length = title.length
+        return if title_length <= ACTION_SECTION_TITLE_MAXIMUM
+
+        raise WhatsappSdk::Resource::Error::InvalidInteractiveActionSection,
+              "Invalid length #{title_length} for title in section. Maximum length: " \
+              "#{ACTION_SECTION_TITLE_MAXIMUM} characters."
+      end
+
+      sig { void }
+      def validate_rows
+        rows_length = rows.length
+        return if rows_length <= ACTION_SECTION_ROWS_MAXIMUM
+
+        raise WhatsappSdk::Resource::Error::InvalidInteractiveActionSection,
+              "Invalid number of rows #{rows_length} in section. Maximum count: " \
+              "#{ACTION_SECTION_ROWS_MAXIMUM}."
+      end
+    end
+  end
+end
+

data/lib/whatsapp_sdk/resource/interactive_action_section_row.rb

@@ -0,0 +1,94 @@
+# typed: strict
+# frozen_string_literal: true
+
+module WhatsappSdk
+  module Resource
+    class InteractiveActionSectionRow
+      extend T::Sig
+
+      # Returns the ActionSection title you want to send.
+      #
+      # @returns title [String]. The character limit is 24 characters.
+      sig { returns(String) }
+      attr_accessor :title
+
+      # Returns the ActionSection description you want to send.
+      #
+      # @returns description [String]. The character limit is 72 characters if present.
+      sig { returns(String) }
+      attr_accessor :description
+
+      # Returns the ActionSection unique identifier you want to send.
+      # This ID is returned in the webhook when the section is selected by the user.
+      #
+      # @returns id [String]. The character limit is 256 characters.
+      sig { returns(String) }
+      attr_accessor :id
+
+      ACTION_SECTION_TITLE_MAXIMUM = 24
+      ACTION_SECTION_DESCRIPTION_MAXIMUM = 72
+      ACTION_SECTION_ID_MAXIMUM = 256
+
+      sig { params(title: String, id: String, description: T::nilable(String)).void }
+      def initialize(title:, id:, description: "")
+        @title = title
+        @id = id
+        @description = description
+        validate
+      end
+
+      def to_json
+        json = {
+          id: id,
+          title: title
+        }
+        json[:description] = description if description.length > 0
+
+        json
+      end
+
+      private
+
+      sig { void }
+      def validate
+        validate_title
+        validate_id
+        validate_description
+      end
+
+      sig { void }
+      def validate_title
+        title_length = title.length
+        return if title_length <= ACTION_SECTION_TITLE_MAXIMUM
+
+        raise WhatsappSdk::Resource::Error::InvalidInteractiveActionSectionRow.new(
+          "Invalid length #{title_length} for title in section row. Maximum length: #{ACTION_SECTION_TITLE_MAXIMUM} characters.",
+        )
+      end
+
+      sig { void }
+      def validate_id
+        id_unfrozen = id.dup
+        id_unfrozen.strip!  # You cannot have leading or trailing spaces when setting the ID.
+        id = id_unfrozen.freeze
+        id_length = id.length
+        return if id_length <= ACTION_SECTION_ID_MAXIMUM
+
+        raise WhatsappSdk::Resource::Error::InvalidInteractiveActionSectionRow.new(
+          "Invalid length #{id_length} for id in section row. Maximum length: #{ACTION_SECTION_ID_MAXIMUM} characters.",
+        )
+      end
+
+      sig { void }
+      def validate_description
+        description_length = description.length
+        return if description_length <= ACTION_SECTION_DESCRIPTION_MAXIMUM
+
+        raise WhatsappSdk::Resource::Error::InvalidInteractiveActionSectionRow.new(
+          "Invalid length #{description_length} for description in section row. Maximum length: #{ACTION_SECTION_DESCRIPTION_MAXIMUM} characters.",
+        )
+      end
+    end
+  end
+end
+

data/lib/whatsapp_sdk/resource/interactive_body.rb

@@ -0,0 +1,48 @@
+# typed: strict
+# frozen_string_literal: true
+
+module WhatsappSdk
+  module Resource
+    class InteractiveBody
+      extend T::Sig
+
+      # Returns Text string if the parameter object type is text.
+      # For the body interactive, the character limit is 1024 characters.
+      #
+      # @returns text [String]
+      sig { returns(String) }
+      attr_accessor :text
+
+      sig do
+        params(text: String).void
+      end
+      def initialize(text:)
+        @text = text
+        validate
+      end
+
+      sig { returns(T::Hash[T.untyped, T.untyped]) }
+      def to_json
+        { text: text }
+      end
+
+      MAXIMUM_LENGTH = 1024
+
+      private
+
+      sig { void }
+      def validate
+        validate_text
+      end
+
+      sig { void }
+      def validate_text
+        text_length = text.length
+        return if text_length <= MAXIMUM_LENGTH
+
+        raise WhatsappSdk::Resource::Error::InvalidInteractiveBody,
+              "Invalid length #{text_length} for text in body. Maximum length: #{MAXIMUM_LENGTH} characters."
+      end
+    end
+  end
+end

data/lib/whatsapp_sdk/resource/interactive_footer.rb

@@ -0,0 +1,48 @@
+# typed: strict
+# frozen_string_literal: true
+
+module WhatsappSdk
+  module Resource
+    class InteractiveFooter
+      extend T::Sig
+
+      # Returns Text string if the parameter object type is text.
+      # For the body interactive, the character limit is 60 characters.
+      #
+      # @returns text [String]
+      sig { returns(String) }
+      attr_accessor :text
+
+      sig do
+        params(text: String).void
+      end
+      def initialize(text:)
+        @text = text
+        validate
+      end
+
+      sig { returns(T::Hash[T.untyped, T.untyped]) }
+      def to_json
+        { text: text }
+      end
+
+      MAXIMUM_LENGTH = 60
+
+      private
+
+      sig { void }
+      def validate
+        validate_text
+      end
+
+      sig { void }
+      def validate_text
+        text_length = text.length
+        return if text_length <= MAXIMUM_LENGTH
+
+        raise WhatsappSdk::Resource::Error::InvalidInteractiveFooter,
+              "Invalid length #{text_length} for text in footer. Maximum length: #{MAXIMUM_LENGTH} characters."
+      end
+    end
+  end
+end

data/lib/whatsapp_sdk/resource/interactive_header.rb

@@ -0,0 +1,120 @@
+# typed: strict
+# frozen_string_literal: true
+
+module WhatsappSdk
+  module Resource
+    class InteractiveHeader
+      extend T::Sig
+
+      # Returns the interactive header type.
+      #
+      # @returns type [String] Valid options are text, image, document, video.
+      sig { returns(Type) }
+      attr_accessor :type
+
+      class Type < T::Enum
+        extend T::Sig
+
+        enums do
+          Text = new("text")
+          Image = new("image")
+          Document = new("document")
+          Video = new("video")
+        end
+      end
+
+      # Returns Text string if the interactive header type is text.
+      # For the header interactive, the character limit is 60 characters.
+      # For the body interactive, the character limit is 1024 characters.
+      #
+      # @returns text [String]
+      sig { returns(T.nilable(String)) }
+      attr_accessor :text
+
+      # Returns image if the interactive header type is image.
+      #
+      # @returns image [Media]
+      sig { returns(T.nilable(Media)) }
+      attr_accessor :image
+
+      # Returns document if the interactive header type is document.
+      #
+      # @returns document [Media]
+      sig { returns(T.nilable(Media)) }
+      attr_accessor :document
+
+      # Returns video if the interactive header type is video.
+      #
+      # @returns video [Media]
+      sig { returns(T.nilable(Media)) }
+      attr_accessor :video
+
+      sig do
+        params(
+          type: T.any(Type, String), text: T.nilable(String), image: T.nilable(Media),
+          document: T.nilable(Media), video: T.nilable(Media)
+        ).void
+      end
+      def initialize(type:, text: nil, image: nil, document: nil, video: nil)
+        @type = T.let(deserialize_type(type), Type)
+        @text = text
+        @image = image
+        @document = document
+        @video = video
+        validate
+      end
+
+      sig { returns(T::Hash[T.untyped, T.untyped]) }
+      def to_json
+        json = { type: type.serialize }
+        json[type.serialize.to_sym] = case type.serialize
+                                      when "text"
+                                        text
+                                      when "image"
+                                        T.must(image).to_json
+                                      when "document"
+                                        T.must(document).to_json
+                                      when "video"
+                                        T.must(video).to_json
+                                      else
+                                        raise "Invalid type: #{type}"
+                                      end
+
+        json
+      end
+
+      private
+
+      sig { params(type: T.any(String, Type)).returns(Type) }
+      def deserialize_type(type)
+        return type if type.is_a?(Type)
+
+        Type.deserialize(type)
+      end
+
+      sig { void }
+      def validate
+        validate_attributes
+      end
+
+      sig { void }
+      def validate_attributes
+        [
+          [Type::Text, text],
+          [Type::Image, image],
+          [Type::Document, document],
+          [Type::Video, video]
+        ].each do |type_b, value|
+          next unless type == type_b
+
+          next unless value.nil?
+
+          raise WhatsappSdk::Resource::Error::MissingValue.new(
+            type.serialize,
+            "#{type.serialize} is required when the type is #{type_b}"
+          )
+        end
+      end
+    end
+  end
+end