whatsapp_sdk 0.9.2 → 0.11.0

data/lib/whatsapp_sdk/api/responses/message_template_namespace_data_response.rb

@@ -0,0 +1,37 @@
+# typed: strict
+# frozen_string_literal: true
+
+require_relative "data_response"
+require_relative "../../resource/template"
+
+module WhatsappSdk
+  module Api
+    module Responses
+      class MessageTemplateNamespaceDataResponse < DataResponse
+        sig { returns(String) }
+        attr_accessor :message_template_namespace
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        sig { params(response: T::Hash[T.untyped, T.untyped]).void }
+        def initialize(response)
+          @id = T.let(response["id"], String)
+          @message_template_namespace = T.let(response["message_template_namespace"], String)
+
+          super(response)
+        end
+
+        sig do
+          override.params(response: T::Hash[T.untyped, T.untyped])
+                  .returns(T.nilable(MessageTemplateNamespaceDataResponse))
+        end
+        def self.build_from_response(response:)
+          return unless response["id"]
+
+          new(response)
+        end
+      end
+    end
+  end
+end

data/lib/whatsapp_sdk/api/responses/template_data_response.rb

@@ -0,0 +1,51 @@
+# typed: strict
+# frozen_string_literal: true
+
+require_relative "data_response"
+require_relative "../../resource/template"
+
+module WhatsappSdk
+  module Api
+    module Responses
+      class TemplateDataResponse < DataResponse
+        sig { returns(::WhatsappSdk::Resource::Template) }
+        attr_reader :template
+
+        sig { params(response: T::Hash[T.untyped, T.untyped]).void }
+        def initialize(response:)
+          @template = parse_template(response)
+
+          super(response)
+        end
+
+        sig { override.params(response: T::Hash[T.untyped, T.untyped]).returns(T.nilable(TemplateDataResponse)) }
+        def self.build_from_response(response:)
+          return unless response["id"]
+
+          new(response: response)
+        end
+
+        private
+
+        sig { params(template_json: T::Hash[T.untyped, T.untyped]).returns(::WhatsappSdk::Resource::Template) }
+        def parse_template(template_json)
+          status = ::WhatsappSdk::Resource::Template::Status.try_deserialize(template_json["status"])
+          category = ::WhatsappSdk::Resource::Template::Category.try_deserialize(template_json["category"])
+          id = template_json["id"]
+          language = template_json["language"]
+          name = template_json["name"]
+          components_json = template_json["components"]
+
+          ::WhatsappSdk::Resource::Template.new(
+            id: id,
+            status: status,
+            category: category,
+            language: language,
+            name: name,
+            components_json: components_json
+          )
+        end
+      end
+    end
+  end
+end

data/lib/whatsapp_sdk/api/responses/templates_data_response.rb

@@ -0,0 +1,39 @@
+# typed: strict
+# frozen_string_literal: true
+
+require_relative "data_response"
+require_relative "template_data_response"
+
+module WhatsappSdk
+  module Api
+    module Responses
+      class TemplatesDataResponse < DataResponse
+        sig { returns(T::Array[TemplateDataResponse]) }
+        attr_reader :templates
+
+        sig { params(response: T::Hash[T.untyped, T.untyped]).void }
+        def initialize(response)
+          @templates = T.let(
+            response['data']&.map { |template| parse_templates(template) },
+            T::Array[TemplateDataResponse]
+          )
+          super(response)
+        end
+
+        sig { override.params(response: T::Hash[T.untyped, T.untyped]).returns(T.nilable(TemplatesDataResponse)) }
+        def self.build_from_response(response:)
+          return unless response["data"]
+
+          new(response)
+        end
+
+        private
+
+        sig { params(template: T::Hash[T.untyped, T.untyped]).returns(TemplateDataResponse) }
+        def parse_templates(template)
+          TemplateDataResponse.new(response: template)
+        end
+      end
+    end
+  end
+end

data/lib/whatsapp_sdk/api/templates.rb

@@ -0,0 +1,201 @@
+# typed: strict
+# frozen_string_literal: true
+
+require_relative "request"
+require_relative "response"
+require_relative 'responses/success_response'
+require_relative 'responses/message_template_namespace_data_response'
+require_relative 'responses/generic_error_response'
+require_relative 'responses/template_data_response'
+require_relative 'responses/templates_data_response'
+require_relative "../resource/languages"
+
+module WhatsappSdk
+  module Api
+    class Templates < Request
+      DEFAULT_HEADERS = T.let({ 'Content-Type' => 'application/json' }.freeze, Hash)
+
+      class InvalidCategoryError < StandardError
+        extend T::Sig
+
+        sig { returns(String) }
+        attr_reader :category
+
+        sig { params(category: String).void }
+        def initialize(category:)
+          @category = category
+
+          super("Invalid Category. The possible values are: AUTHENTICATION, MARKETING and UTILITY.")
+        end
+      end
+
+      # Create a template
+      #
+      # @param business_id [Integer] Business Id.
+      # @param name [String] the template's name.
+      # @param category [String] the template's category. Possible values: AUTHENTICATION, MARKETING, UTILITY.
+      # @param language [String] Template language and locale code (e.g. en_US).
+      #  See the list of possible languages https://developers.facebook.com/docs/whatsapp/api/messages/message-templates
+      # @param components_json [Component] Components that make up the template. See the list of possible components:
+      #   https://developers.facebook.com/docs/whatsapp/business-management-api/message-templates/components
+      # @param allow_category_change [Boolean] Optional Allow category change.
+      # Set to true to allow us to assign a category based on the template guidelines and the template's contents.
+      #   This can prevent your template from being rejected for miscategorization.
+      # @return [Response] Response object.
+      sig do
+        params(
+          business_id: Integer,
+          name: String,
+          category: String,
+          language: String,
+          components_json: T.nilable(T::Array[T::Hash[T.untyped, T.untyped]]),
+          allow_category_change: T.nilable(T::Boolean)
+        ).returns(Response)
+      end
+      def create(
+        business_id:, name:, category:, language:, components_json: nil, allow_category_change: nil
+      )
+        unless WhatsappSdk::Resource::Template::Category.try_deserialize(category)
+          raise InvalidCategoryError.new(category: category)
+        end
+
+        unless WhatsappSdk::Resource::Languages.available?(language)
+          raise WhatsappSdk::Resource::Errors::InvalidLanguageError.new(language: language)
+        end
+
+        params = {
+          name: name,
+          category: category,
+          language: language,
+          components: components_json
+        }
+        params["allow_category_change"] = allow_category_change if allow_category_change
+
+        response = send_request(
+          endpoint: "#{business_id}/message_templates",
+          http_method: "post",
+          params: params,
+          headers: DEFAULT_HEADERS
+        )
+
+        Response.new(
+          response: response,
+          data_class_type: Responses::TemplateDataResponse,
+          error_class_type: Responses::GenericErrorResponse
+        )
+      end
+
+      # Get templates
+      #
+      # @param business_id [Integer] The business ID.
+      # @param limit [Integer] Optional. Number of templates to return in a single page.
+      # @return [Response] Response object.
+      sig { params(business_id: Integer, limit: T.nilable(Integer)).returns(Response) }
+      def templates(business_id:, limit: 100)
+        params = {}
+        params["limit"] = limit if limit
+
+        response = send_request(
+          endpoint: "#{business_id}/message_templates",
+          http_method: "get",
+          params: params
+        )
+
+        Response.new(
+          response: response,
+          data_class_type: Responses::TemplatesDataResponse,
+          error_class_type: Responses::GenericErrorResponse
+        )
+      end
+
+      # Get Message Template Namespace
+      # The message template namespace is required to send messages using the message templates.
+      #
+      # @param business_id [Integer] The business ID.
+      # @return [Response] Response object.
+      sig { params(business_id: Integer).returns(Response) }
+      def get_message_template_namespace(business_id:)
+        response = send_request(
+          endpoint: business_id.to_s,
+          http_method: "get",
+          params: { "fields" => "message_template_namespace" }
+        )
+
+        Response.new(
+          response: response,
+          data_class_type: Responses::MessageTemplateNamespaceDataResponse,
+          error_class_type: Responses::GenericErrorResponse
+        )
+      end
+
+      # Edit Template
+      #
+      # Editing a template replaces its old contents entirely, so include any components you wish
+      # to preserve as well as components you wish to update using the components parameter.
+      #
+      # Message templates can only be edited when in an Approved, Rejected, or Paused state.
+      #
+      # @param id [String] Required. The message_template-id.
+      # @param components_json [Json] Components that make up the template..
+      # return [Response] Response object.
+      def update(template_id:, category: nil, components_json: nil)
+        if category && !WhatsappSdk::Resource::Template::Category.try_deserialize(category)
+          raise InvalidCategoryError.new(category: category)
+        end
+
+        params = {}
+        params[:components] = components_json if components_json
+        params[:category] = category if category
+
+        response = send_request(
+          endpoint: template_id.to_s,
+          http_method: "post",
+          params: params,
+          headers: { "Content-Type" => "application/json" }
+        )
+
+        Response.new(
+          response: response,
+          data_class_type: Responses::SuccessResponse,
+          error_class_type: Responses::GenericErrorResponse
+        )
+      end
+
+      # Delete Template
+      #
+      # Deleting a template by name deletes all templates that match that name
+      # (meaning templates with the same name but different languages will also be deleted).
+      # To delete a template by ID, include the template's ID along with its name in your request;
+      # only the template with the matching template ID will be deleted.
+      #
+      # @param business_id [Integer] Required. The business ID.
+      # @param name [String] Required. The template's name.
+      # @param hsm_id [String] Optional. The template's id.
+      #
+      # @return [Response] Response object.
+      sig do
+        params(
+          business_id: Integer,
+          name: String,
+          hsm_id: T.nilable(String)
+        ).returns(Response)
+      end
+      def delete(business_id:, name:, hsm_id: nil)
+        params = { name: name }
+        params[:hsm_id] = hsm_id if hsm_id
+
+        response = send_request(
+          endpoint: "#{business_id}/message_templates",
+          http_method: "delete",
+          params: params
+        )
+
+        Response.new(
+          response: response,
+          data_class_type: Responses::SuccessResponse,
+          error_class_type: Responses::GenericErrorResponse
+        )
+      end
+    end
+  end
+end

data/lib/whatsapp_sdk/configuration.rb

@@ -19,9 +19,9 @@ module WhatsappSdk
       @access_token = access_token
     end
 
-    sig { returns(WhatsappSdk::Api::Client) }
+    sig { returns(Api::Client) }
     def client
-      WhatsappSdk::Api::Client.new(access_token)
+      Api::Client.new(access_token)
     end
   end
 end

data/lib/whatsapp_sdk/resource/component.rb

@@ -62,7 +62,7 @@ module WhatsappSdk
       # appending the text parameter to the predefined prefix URL in the template.
       #
       # @returns subtype [String]. Valid options are quick_reply and url.
-      sig { returns(T.nilable(WhatsappSdk::Resource::Component::Subtype)) }
+      sig { returns(T.nilable(Component::Subtype)) }
       attr_accessor :sub_type
 
       # Required when type=button. Not used for the other types.
@@ -80,7 +80,7 @@ module WhatsappSdk
       sig do
         params(
           type: Type, parameters: T::Array[T.any(ButtonParameter, ParameterObject)],
-          sub_type: T.nilable(WhatsappSdk::Resource::Component::Subtype), index: T.nilable(Integer)
+          sub_type: T.nilable(Component::Subtype), index: T.nilable(Integer)
         ).void
       end
       def initialize(type:, parameters: [], sub_type: nil, index: nil)

data/lib/whatsapp_sdk/resource/errors.rb

@@ -0,0 +1,68 @@
+# typed: strict
+# frozen_string_literal: true
+
+module WhatsappSdk
+  module Resource
+    module Errors
+      class MissingArgumentError < StandardError
+        extend T::Sig
+
+        sig { returns(String) }
+        attr_reader :message
+
+        sig { params(message: String).void }
+        def initialize(message)
+          @message = message
+          super(message)
+        end
+      end
+
+      class MissingValue < Error
+        extend T::Sig
+
+        sig { returns(String) }
+        attr_reader :field
+
+        sig { returns(String) }
+        attr_reader :message
+
+        sig { params(field: String, message: String).void }
+        def initialize(field, message)
+          @field = field
+          @message = message
+          super(message)
+        end
+      end
+
+      class InvalidLanguageError < StandardError
+        extend T::Sig
+
+        URL_AVAILABLE_LANGUAGES = "https://developers.facebook.com/docs/whatsapp/api/messages/message-templates"
+
+        sig { returns(String) }
+        attr_reader :language
+
+        sig { params(language: String).void }
+        def initialize(language:)
+          @language = language
+
+          super("Invalid language. Check the available languages in #{URL_AVAILABLE_LANGUAGES}.")
+        end
+      end
+
+      class InvalidField < MissingValue; end
+
+      class InvalidInteractiveBody < Error; end
+
+      class InvalidInteractiveActionReplyButton < Error; end
+
+      class InvalidInteractiveActionButton < Error; end
+
+      class InvalidInteractiveActionSection < Error; end
+
+      class InvalidInteractiveActionSectionRow < Error; end
+
+      class InvalidInteractiveFooter < Error; end
+    end
+  end
+end

data/lib/whatsapp_sdk/resource/interactive_action.rb

@@ -103,18 +103,18 @@ module WhatsappSdk
         button_length = button.length
         sections_count = sections.length
         unless button_length.positive?
-          raise WhatsappSdk::Resource::Error::InvalidInteractiveActionButton,
+          raise Errors::InvalidInteractiveActionButton,
                 "Invalid button in action. Button label is required."
         end
 
         unless button_length <= LIST_BUTTON_TITLE_MAXIMUM
-          raise WhatsappSdk::Resource::Error::InvalidInteractiveActionButton,
+          raise Errors::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,
+          raise Errors::InvalidInteractiveActionSection,
                 "Invalid length #{sections_count} for sections in action. It should be between " \
                 "#{LIST_SECTIONS_MINIMUM} and #{LIST_SECTIONS_MAXIMUM}."
         end
@@ -125,7 +125,7 @@ module WhatsappSdk
       def validate_reply_button
         buttons_count = buttons.length
         unless (REPLY_BUTTONS_MINIMUM..REPLY_BUTTONS_MAXIMUM).cover?(buttons_count)
-          raise WhatsappSdk::Resource::Error::InvalidInteractiveActionReplyButton,
+          raise Errors::InvalidInteractiveActionReplyButton,
                 "Invalid length #{buttons_count} for buttons in action. It should be between " \
                 "#{REPLY_BUTTONS_MINIMUM} and #{REPLY_BUTTONS_MAXIMUM}."
         end
@@ -133,7 +133,7 @@ module WhatsappSdk
         button_ids = buttons.map(&:id)
         return if button_ids.length.eql?(button_ids.uniq.length)
 
-        raise WhatsappSdk::Resource::Error::InvalidInteractiveActionReplyButton,
+        raise Errors::InvalidInteractiveActionReplyButton,
               "Duplicate ids #{button_ids} for buttons in action. They should be unique."
       end
     end

data/lib/whatsapp_sdk/resource/interactive_action_reply_button.rb

@@ -67,7 +67,7 @@ module WhatsappSdk
         title_length = title.length
         return if title_length <= ACTION_BUTTON_TITLE_MAXIMUM
 
-        raise WhatsappSdk::Resource::Error::InvalidInteractiveActionReplyButton,
+        raise Errors::InvalidInteractiveActionReplyButton,
               "Invalid length #{title_length} for title in button. " \
               "Maximum length: #{ACTION_BUTTON_TITLE_MAXIMUM} characters."
       end
@@ -80,7 +80,7 @@ module WhatsappSdk
         id_length = id.length
         return if id_length <= ACTION_BUTTON_ID_MAXIMUM
 
-        raise WhatsappSdk::Resource::Error::InvalidInteractiveActionReplyButton,
+        raise Errors::InvalidInteractiveActionReplyButton,
               "Invalid length #{id_length} for id in button. Maximum length: #{ACTION_BUTTON_ID_MAXIMUM} characters."
       end
     end

data/lib/whatsapp_sdk/resource/interactive_action_section.rb

@@ -53,7 +53,7 @@ module WhatsappSdk
         title_length = title.length
         return if title_length <= ACTION_SECTION_TITLE_MAXIMUM
 
-        raise WhatsappSdk::Resource::Error::InvalidInteractiveActionSection,
+        raise Errors::InvalidInteractiveActionSection,
               "Invalid length #{title_length} for title in section. Maximum length: " \
               "#{ACTION_SECTION_TITLE_MAXIMUM} characters."
       end
@@ -63,7 +63,7 @@ module WhatsappSdk
         rows_length = rows.length
         return if rows_length <= ACTION_SECTION_ROWS_MAXIMUM
 
-        raise WhatsappSdk::Resource::Error::InvalidInteractiveActionSection,
+        raise Errors::InvalidInteractiveActionSection,
               "Invalid number of rows #{rows_length} in section. Maximum count: " \
               "#{ACTION_SECTION_ROWS_MAXIMUM}."
       end

data/lib/whatsapp_sdk/resource/interactive_action_section_row.rb

@@ -61,8 +61,8 @@ module WhatsappSdk
         title_length = title.length
         return if title_length <= ACTION_SECTION_TITLE_MAXIMUM
 
-        raise WhatsappSdk::Resource::Error::InvalidInteractiveActionSectionRow,
-              "Invalid length #{title_length} for title in section row. "\
+        raise Errors::InvalidInteractiveActionSectionRow,
+              "Invalid length #{title_length} for title in section row. " \
               "Maximum length: #{ACTION_SECTION_TITLE_MAXIMUM} characters."
       end
 
@@ -74,8 +74,8 @@ module WhatsappSdk
         id_length = id.length
         return if id_length <= ACTION_SECTION_ID_MAXIMUM
 
-        raise WhatsappSdk::Resource::Error::InvalidInteractiveActionSectionRow,
-              "Invalid length #{id_length} for id in section row. Maximum length: "\
+        raise Errors::InvalidInteractiveActionSectionRow,
+              "Invalid length #{id_length} for id in section row. Maximum length: " \
               "#{ACTION_SECTION_ID_MAXIMUM} characters."
       end
 
@@ -84,7 +84,7 @@ module WhatsappSdk
         description_length = description.length
         return if description_length <= ACTION_SECTION_DESCRIPTION_MAXIMUM
 
-        raise WhatsappSdk::Resource::Error::InvalidInteractiveActionSectionRow,
+        raise Errors::InvalidInteractiveActionSectionRow,
               "Invalid length #{description_length} for description in section " \
               "row. Maximum length: #{ACTION_SECTION_DESCRIPTION_MAXIMUM} characters."
       end

data/lib/whatsapp_sdk/resource/interactive_body.rb

@@ -40,7 +40,7 @@ module WhatsappSdk
         text_length = text.length
         return if text_length <= MAXIMUM_LENGTH
 
-        raise WhatsappSdk::Resource::Error::InvalidInteractiveBody,
+        raise Errors::InvalidInteractiveBody,
               "Invalid length #{text_length} for text in body. Maximum length: #{MAXIMUM_LENGTH} characters."
       end
     end

data/lib/whatsapp_sdk/resource/interactive_footer.rb

@@ -40,7 +40,7 @@ module WhatsappSdk
         text_length = text.length
         return if text_length <= MAXIMUM_LENGTH
 
-        raise WhatsappSdk::Resource::Error::InvalidInteractiveFooter,
+        raise Errors::InvalidInteractiveFooter,
               "Invalid length #{text_length} for text in footer. Maximum length: #{MAXIMUM_LENGTH} characters."
       end
     end

data/lib/whatsapp_sdk/resource/interactive_header.rb

@@ -109,7 +109,7 @@ module WhatsappSdk
 
           next unless value.nil?
 
-          raise WhatsappSdk::Resource::Error::MissingValue.new(
+          raise Resource::Errors::MissingValue.new(
             type.serialize,
             "#{type.serialize} is required when the type is #{type_b}"
           )

data/lib/whatsapp_sdk/resource/languages.rb

@@ -0,0 +1,86 @@
+# typed: false
+# frozen_string_literal: true
+
+module WhatsappSdk
+  module Resource
+    class Languages
+      AVAILABLE_LANGUAGES = Set.new([
+                                      "af", # Afrikaans
+                                      "sq", # Albanian
+                                      "ar", # Arabic
+                                      "az", # Azerbaijani
+                                      "bn", # Bengali
+                                      "bg", # Bulgarian
+                                      "ca", # Catalan
+                                      "zh_CN", # Chinese (CHN)
+                                      "zh_HK", # Chinese (HKG)
+                                      "zh_TW", # Chinese (TAI)
+                                      "hr", # Croatian
+                                      "cs", # Czech
+                                      "da", # Danish
+                                      "nl", # Dutch
+                                      "en", # English
+                                      "en_GB", # English (UK)
+                                      "en_US", # English (US)
+                                      "et", # Estonian
+                                      "fil", # Filipino
+                                      "fi", # Finnish
+                                      "fr", # French
+                                      "ka", # Georgian
+                                      "de", # German
+                                      "el", # Greek
+                                      "gu", # Gujarati
+                                      "ha", # Hausa
+                                      "he", # Hebrew
+                                      "hi", # Hindi
+                                      "hu", # Hungarian
+                                      "id", # Indonesian
+                                      "ga", # Irish
+                                      "it", # Italian
+                                      "ja", # Japanese
+                                      "kn", # Kannada
+                                      "kk", # Kazakh
+                                      "rw_RW", # Kinyarwanda
+                                      "ko", # Korean
+                                      "ky_KG", # Kyrgyz (Kyrgyzstan)
+                                      "lo", # Lao
+                                      "lv", # Latvian
+                                      "lt", # Lithuanian
+                                      "mk", # Macedonian
+                                      "ms", # Malay
+                                      "ml", # Malayalam
+                                      "mr", # Marathi
+                                      "nb", # Norwegian
+                                      "fa", # Persian
+                                      "pl", # Polish
+                                      "pt_BR", # Portuguese (BR)
+                                      "pt_PT", # Portuguese (POR)
+                                      "pa", # Punjabi
+                                      "ro", # Romanian
+                                      "ru", # Russian
+                                      "sr", # Serbian
+                                      "sk", # Slovak
+                                      "sl", # Slovenian
+                                      "es", # Spanish
+                                      "es_AR", # Spanish (ARG)
+                                      "es_ES", # Spanish (SPA)
+                                      "es_MX", # Spanish (MEX)
+                                      "sw", # Swahili
+                                      "sv", # Swedish
+                                      "ta", # Tamil
+                                      "te", # Telugu
+                                      "th", # Thai
+                                      "tr", # Turkish
+                                      "uk", # Ukrainian
+                                      "ur", # Urdu
+                                      "uz", # Uzbek
+                                      "vi", # Vietnamese
+                                      "zu" # Zulu
+                                    ])
+
+      def self.available?(language)
+        AVAILABLE_LANGUAGES.include?(language)
+      end
+    end
+  end
+end

data/lib/whatsapp_sdk/resource/parameter_object.rb

@@ -154,8 +154,8 @@ module WhatsappSdk
           next unless type == type_b
 
           if value.nil?
-            raise WhatsappSdk::Resource::Error::MissingValue.new(type.serialize,
-                                                                 "#{type_b} is required when the type is #{type_b}")
+            raise Errors::MissingValue.new(type.serialize,
+                                           "#{type_b} is required when the type is #{type_b}")
           end
         end
       end