whatsapp_sdk 0.12.1 → 1.0.0

data/lib/whatsapp_sdk/api/phone_numbers.rb

@@ -1,8 +1,6 @@
-# typed: strict
 # frozen_string_literal: true
 
 require_relative "request"
-require_relative "response"
 
 module WhatsappSdk
   module Api
@@ -17,47 +15,37 @@ module WhatsappSdk
       #
       # @param business_id [Integer] Business Id.
       # @return [Api::Response] Response object.
-      sig { params(business_id: Integer).returns(Api::Response) }
-      def registered_numbers(business_id)
+      def list(business_id)
         response = send_request(
           http_method: "get",
           endpoint: "#{business_id}/phone_numbers?fields=#{DEFAULT_FIELDS}"
         )
 
-        Api::Response.new(
-          response: response,
-          data_class_type: Api::Responses::PhoneNumbersDataResponse
+        Api::Responses::PaginationRecords.new(
+          records: parse_phone_numbers(response['data']),
+          before: response['paging']['cursors']['before'],
+          after: response['paging']['cursors']['after']
         )
       end
 
-      # Get the registered number id.
+      # Get the registered number.
       #
       # @param phone_number_id [Integer] The registered number we want to retrieve.
-      # @return [Api::Response] Response object.
-      sig { params(phone_number_id: Integer).returns(Api::Response) }
-      def registered_number(phone_number_id)
+      # @return [Resource::PhoneNumber] A PhoneNumber object.
+      def get(phone_number_id)
         response = send_request(
           http_method: "get",
           endpoint: "#{phone_number_id}?fields=#{DEFAULT_FIELDS}"
         )
 
-        Api::Response.new(
-          response: response,
-          data_class_type: Api::Responses::PhoneNumberDataResponse
-        )
+        Resource::PhoneNumber.from_hash(response)
       end
 
       # Register a phone number.
       #
       # @param phone_number_id [Integer] The registered number we want to retrieve.
       # @param pin [Integer] Pin of 6 digits.
-      # @return [Api::Response] Response object.
-      sig do
-        params(
-          phone_number_id: Integer,
-          pin: Integer
-        ).returns(Api::Response)
-      end
+      # @return [Boolean] Whether the registration was successful.
       def register_number(phone_number_id, pin)
         response = send_request(
           http_method: "post",
@@ -65,21 +53,13 @@ module WhatsappSdk
           params: { messaging_product: 'whatsapp', pin: pin }
         )
 
-        Api::Response.new(
-          response: response,
-          data_class_type: Api::Responses::PhoneNumberDataResponse
-        )
+        Api::Responses::SuccessResponse.success_response?(response: response)
       end
 
       # Deregister a phone number.
       #
       # @param phone_number_id [Integer] The registered number we want to retrieve.
-      # @return [Api::Response] Response object.
-      sig do
-        params(
-          phone_number_id: Integer
-        ).returns(Api::Response)
-      end
+      # @return [Boolean] Whether the deregistration was successful.
       def deregister_number(phone_number_id)
         response = send_request(
           http_method: "post",
@@ -87,10 +67,26 @@ module WhatsappSdk
           params: {}
         )
 
-        Api::Response.new(
-          response: response,
-          data_class_type: Api::Responses::PhoneNumberDataResponse
-        )
+        Api::Responses::SuccessResponse.success_response?(response: response)
+      end
+
+      # deprecated methods
+      def registered_numbers(business_id)
+        warn "[DEPRECATION] `registered_numbers` is deprecated. Please use `list` instead."
+        list(business_id)
+      end
+
+      def registered_number(phone_number_id)
+        warn "[DEPRECATION] `registered_number` is deprecated. Please use `get` instead."
+        get(phone_number_id)
+      end
+
+      private
+
+      def parse_phone_numbers(phone_numbers_data)
+        phone_numbers_data.map do |phone_number|
+          Resource::PhoneNumber.from_hash(phone_number)
+        end
       end
     end
   end

data/lib/whatsapp_sdk/api/request.rb

@@ -1,11 +1,11 @@
 # typed: true
 # frozen_string_literal: true
 
+require_relative "../../whatsapp_sdk"
+
 module WhatsappSdk
   module Api
     class Request
-      extend T::Sig
-
       def initialize(client = WhatsappSdk.configuration.client)
         @client = client
       end

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

@@ -1,42 +1,24 @@
-# typed: strict
 # frozen_string_literal: true
 
-require_relative "error_response"
-
 module WhatsappSdk
   module Api
     module Responses
-      class GenericErrorResponse < ErrorResponse
-        sig { returns(Integer) }
-        attr_reader :code
-
-        sig { returns(T.nilable(Integer)) }
-        attr_reader :subcode
-
-        sig { returns(T.nilable(String)) }
-        attr_reader :message
-
-        sig { returns(T.nilable(String)) }
-        attr_reader :type
+      class GenericErrorResponse
+        attr_reader :code, :subcode, :message, :type, :data, :fbtrace_id
 
-        sig { returns(T.nilable(String)) }
-        attr_reader :data
-
-        sig { returns(T.nilable(String)) }
-        attr_reader :fbtrace_id
-
-        sig { params(response: T::Hash[T.untyped, T.untyped]).void }
         def initialize(response:)
-          @code = T.let(response["code"], Integer)
-          @subcode = T.let(response["error_subcode"], T.nilable(Integer))
-          @message = T.let(response["message"], T.nilable(String))
-          @type = T.let(response["type"], T.nilable(String))
-          @data = T.let(response["data"], T.nilable(String))
-          @fbtrace_id = T.let(response["fbtrace_id"], T.nilable(String))
-          super(response: response)
+          @code = response["code"]
+          @subcode = response["error_subcode"]
+          @message = response["message"]
+          @type = response["type"]
+          @data = response["data"]
+          @fbtrace_id = response["fbtrace_id"]
+        end
+
+        def self.response_error?(response:)
+          response["error"]
         end
 
-        sig { override.params(response: T::Hash[T.untyped, T.untyped]).returns(T.nilable(GenericErrorResponse)) }
         def self.build_from_response(response:)
           error_response = response["error"]
           return unless error_response

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module WhatsappSdk
+  module Api
+    module Responses
+      class HttpResponseError < StandardError
+        attr_reader :http_status, :body, :error_info
+
+        def initialize(http_status:, body:)
+          super
+          @http_status = http_status
+          @body = body
+          @error_info = GenericErrorResponse.build_from_response(response: body)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module WhatsappSdk
+  module Api
+    module Responses
+      class IdResponse
+        attr_accessor :id
+
+        def initialize(id)
+          @id = id
+        end
+      end
+    end
+  end
+end

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

@@ -1,53 +1,34 @@
-# typed: strict
 # frozen_string_literal: true
 
-require_relative "../request"
-require_relative "data_response"
 require_relative "../../resource/message"
 require_relative "../../resource/contact_response"
 
 module WhatsappSdk
   module Api
     module Responses
-      class MessageDataResponse < DataResponse
-        extend T::Sig
-
-        sig { returns(T::Array[Resource::ContactResponse]) }
-        attr_reader :contacts
-
-        sig { returns(T::Array[Resource::Message]) }
-        attr_reader :messages
-
-        sig { params(response: T::Hash[T.untyped, T.untyped]).void }
-        def initialize(response:)
-          @contacts = T.let(
-            response["contacts"]&.map { |contact_json| parse_contact(contact_json) },
-            T::Array[Resource::ContactResponse]
-          )
-          @messages = T.let(
-            response["messages"]&.map { |contact_json| parse_message(contact_json) },
-            T::Array[Resource::Message]
-          )
-          super(response)
-        end
+      class MessageDataResponse
+        attr_accessor :contacts, :messages
 
-        sig { override.params(response: T::Hash[T.untyped, T.untyped]).returns(T.nilable(MessageDataResponse)) }
-        def self.build_from_response(response:)
-          return unless response["messages"]
+        class << self
+          def build_from_response(response:)
+            return unless response["messages"]
 
-          new(response: response)
-        end
+            data_response = new
+            data_response.contacts = response["contacts"]&.map { |contact_json| parse_contact(contact_json) }
+            data_response.messages = response["messages"]&.map { |contact_json| parse_message(contact_json) }
 
-        private
+            data_response
+          end
 
-        sig { params(message_json: T::Hash[T.untyped, T.untyped]).returns(Resource::Message) }
-        def parse_message(message_json)
-          Resource::Message.new(id: message_json["id"])
-        end
+          private
+
+          def parse_message(message_json)
+            Resource::Message.new(id: message_json["id"])
+          end
 
-        sig { params(contact_json: T::Hash[T.untyped, T.untyped]).returns(Resource::ContactResponse) }
-        def parse_contact(contact_json)
-          Resource::ContactResponse.new(input: contact_json["input"], wa_id: contact_json["wa_id"])
+          def parse_contact(contact_json)
+            Resource::ContactResponse.new(input: contact_json["input"], wa_id: contact_json["wa_id"])
+          end
         end
       end
     end

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module WhatsappSdk
+  module Api
+    module Responses
+      class PaginationRecords
+        attr_reader :records, :before, :after
+
+        def initialize(records:, before:, after:)
+          @records = records
+          @before = before
+          @after = after
+        end
+      end
+    end
+  end
+end

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

@@ -1,28 +1,11 @@
-# typed: strict
 # frozen_string_literal: true
 
-require_relative "data_response"
-
 module WhatsappSdk
   module Api
     module Responses
-      class SuccessResponse < DataResponse
-        sig { params(response: T::Hash[T.untyped, T.untyped]).void }
-        def initialize(response:)
-          @success = T.let(response["success"], T::Boolean)
-          super(response)
-        end
-
-        sig { override.params(response: T::Hash[T.untyped, T.untyped]).returns(T.nilable(SuccessResponse)) }
-        def self.build_from_response(response:)
-          return unless response["success"]
-
-          new(response: response)
-        end
-
-        sig { returns(T::Boolean) }
-        def success?
-          @success
+      class SuccessResponse
+        def self.success_response?(response:)
+          response["success"] == true
         end
       end
     end

data/lib/whatsapp_sdk/api/templates.rb

@@ -1,27 +1,16 @@
-# 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)
+      DEFAULT_HEADERS = { 'Content-Type' => 'application/json' }.freeze
 
       class InvalidCategoryError < StandardError
-        extend T::Sig
-
-        sig { returns(String) }
         attr_reader :category
 
-        sig { params(category: String).void }
         def initialize(category:)
           @category = category
 
@@ -41,21 +30,11 @@ module WhatsappSdk
       # @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
+      # @return [Template] Template object.
       def create(
         business_id:, name:, category:, language:, components_json: nil, allow_category_change: nil
       )
-        unless WhatsappSdk::Resource::Template::Category.try_deserialize(category)
+        unless WhatsappSdk::Resource::Template::Category.valid?(category)
           raise InvalidCategoryError.new(category: category)
         end
 
@@ -78,20 +57,15 @@ module WhatsappSdk
           headers: DEFAULT_HEADERS
         )
 
-        Response.new(
-          response: response,
-          data_class_type: Responses::TemplateDataResponse,
-          error_class_type: Responses::GenericErrorResponse
-        )
+        Resource::Template.from_hash(response)
       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)
+      # @return [Template] Pagination Record containing an array of Template objects.
+      def list(business_id:, limit: 100)
         params = {}
         params["limit"] = limit if limit
 
@@ -101,19 +75,23 @@ module WhatsappSdk
           params: params
         )
 
-        Response.new(
-          response: response,
-          data_class_type: Responses::TemplatesDataResponse,
-          error_class_type: Responses::GenericErrorResponse
+        Api::Responses::PaginationRecords.new(
+          records: parse_templates(response['data']),
+          before: response['paging']['cursors']['before'],
+          after: response['paging']['cursors']['after']
         )
       end
 
+      def templates(business_id:)
+        warn "[DEPRECATION] `templates` is deprecated. Please use `list` instead."
+        list(business_id: business_id)
+      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) }
+      # @return [MessageTemplateNamespace] MessageTemplateNamespace object.
       def get_message_template_namespace(business_id:)
         response = send_request(
           endpoint: business_id.to_s,
@@ -121,11 +99,7 @@ module WhatsappSdk
           params: { "fields" => "message_template_namespace" }
         )
 
-        Response.new(
-          response: response,
-          data_class_type: Responses::MessageTemplateNamespaceDataResponse,
-          error_class_type: Responses::GenericErrorResponse
-        )
+        WhatsappSdk::Resource::MessageTemplateNamespace.from_hash(response)
       end
 
       # Edit Template
@@ -137,9 +111,9 @@ module WhatsappSdk
       #
       # @param id [String] Required. The message_template-id.
       # @param components_json [Json] Components that make up the template..
-      # return [Response] Response object.
+      # @return [Boolean] Whether the update was successful.
       def update(template_id:, category: nil, components_json: nil)
-        if category && !WhatsappSdk::Resource::Template::Category.try_deserialize(category)
+        if category && !WhatsappSdk::Resource::Template::Category.valid?(category)
           raise InvalidCategoryError.new(category: category)
         end
 
@@ -154,11 +128,7 @@ module WhatsappSdk
           headers: { "Content-Type" => "application/json" }
         )
 
-        Response.new(
-          response: response,
-          data_class_type: Responses::SuccessResponse,
-          error_class_type: Responses::GenericErrorResponse
-        )
+        Api::Responses::SuccessResponse.success_response?(response: response)
       end
 
       # Delete Template
@@ -172,14 +142,7 @@ module WhatsappSdk
       # @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
+      # @return [Boolean] Whether the deletion was successful.
       def delete(business_id:, name:, hsm_id: nil)
         params = { name: name }
         params[:hsm_id] = hsm_id if hsm_id
@@ -190,11 +153,15 @@ module WhatsappSdk
           params: params
         )
 
-        Response.new(
-          response: response,
-          data_class_type: Responses::SuccessResponse,
-          error_class_type: Responses::GenericErrorResponse
-        )
+        Api::Responses::SuccessResponse.success_response?(response: response)
+      end
+
+      private
+
+      def parse_templates(templates_data)
+        templates_data.map do |template|
+          Resource::Template.from_hash(template)
+        end
       end
     end
   end

data/lib/whatsapp_sdk/configuration.rb

@@ -1,4 +1,3 @@
-# typed: strict
 # frozen_string_literal: true
 
 module WhatsappSdk
@@ -10,31 +9,11 @@ module WhatsappSdk
   #
   # The gem have access to the client through WhatsappSdk.configuration.client
   class Configuration
-    extend T::Sig
-
-    logger_or_subclass_or_nil = T.nilable(T.any(Logger, T.class_of(Logger)))
-
-    sig { returns(String) }
-    attr_accessor :access_token
-
-    sig { returns(String) }
-    attr_accessor :api_version
+    attr_accessor :access_token, :api_version
 
     # loggers like ActiveSupport::Logger (Rails.logger) is a subclass of Logger
-    sig { returns(logger_or_subclass_or_nil) }
-    attr_accessor :logger
+    attr_accessor :logger, :logger_options
 
-    sig { returns(Hash) }
-    attr_accessor :logger_options
-
-    sig do
-      params(
-        access_token: String,
-        api_version: String,
-        logger: logger_or_subclass_or_nil,
-        logger_options: Hash
-      ).void
-    end
     def initialize(
       access_token = "",
       api_version = Api::ApiConfiguration::DEFAULT_API_VERSION,
@@ -47,7 +26,6 @@ module WhatsappSdk
       @logger_options = logger_options
     end
 
-    sig { returns(Api::Client) }
     def client
       Api::Client.new(access_token, api_version, logger, logger_options)
     end

data/lib/whatsapp_sdk/error.rb

@@ -1,4 +1,3 @@
-# typed: strict
 # frozen_string_literal: true
 
 module WhatsappSdk

data/lib/whatsapp_sdk/resource/address.rb

@@ -1,38 +1,10 @@
-# typed: strict
 # frozen_string_literal: true
 
 module WhatsappSdk
   module Resource
     class Address
-      extend T::Sig
+      attr_accessor :street, :city, :state, :zip, :country, :country_code, :type
 
-      sig { returns(String) }
-      attr_accessor :street
-
-      sig { returns(String) }
-      attr_accessor :city
-
-      sig { returns(String) }
-      attr_accessor :state
-
-      sig { returns(String) }
-      attr_accessor :zip
-
-      sig { returns(String) }
-      attr_accessor :country
-
-      sig { returns(String) }
-      attr_accessor :country_code
-
-      sig { returns(AddressType) }
-      attr_accessor :type
-
-      sig do
-        params(
-          street: String, city: String, state: String, zip: String,
-          country: String, country_code: String, type: AddressType
-        ).void
-      end
       def initialize(street:, city:, state:, zip:, country:, country_code:, type: AddressType::Home)
         @street = street
         @city = city
@@ -43,7 +15,6 @@ module WhatsappSdk
         @type = type
       end
 
-      sig { returns(T::Hash[T.untyped, T.untyped]) }
       def to_h
         {
           street: @street,

data/lib/whatsapp_sdk/resource/address_type.rb

@@ -1,15 +1,10 @@
-# typed: strict
 # frozen_string_literal: true
 
 module WhatsappSdk
   module Resource
-    class AddressType < T::Enum
-      extend T::Sig
-
-      enums do
-        Home = new("Home")
-        Work = new("Work")
-      end
+    module AddressType
+      HOME = "Home"
+      WORK = "Work"
     end
   end
 end