whatsapp_sdk 0.3.2 → 0.4.0

data/lib/whatsapp_sdk/api/medias.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: strict
 
 require "faraday"
 require "faraday/multipart"
@@ -12,8 +13,12 @@ module WhatsappSdk
   module Api
     class Medias < Request
       class FileNotFoundError < StandardError
+        extend T::Sig
+
+        sig { returns(String) }
         attr_reader :file_path
 
+        sig { params(file_path: String).void }
         def initialize(file_path)
           @file_path = file_path
           super("Couldn't find file_path: #{file_path}")
@@ -22,8 +27,9 @@ module WhatsappSdk
 
       # Get Media by ID.
       #
-      # @param media_id [Integer] Media Id.
+      # @param media_id [String] Media Id.
       # @return [WhatsappSdk::Api::Response] Response object.
+      sig { params(media_id: String).returns(WhatsappSdk::Api::Response) }
       def media(media_id:)
         response = send_request(
           http_method: "get",
@@ -38,9 +44,10 @@ module WhatsappSdk
 
       # Download Media by URL.
       #
-      # @param media_id [Integer] Media Id.
+      # @param url URL.
       # @param file_path [String] The file_path to download the media e.g. "tmp/downloaded_image.png".
       # @return [WhatsappSdk::Api::Response] Response object.
+      sig { params(url: String, file_path: String).returns(WhatsappSdk::Api::Response) }
       def download(url:, file_path:)
         response = download_file(url, file_path)
 
@@ -64,6 +71,7 @@ module WhatsappSdk
       # see the official documentation https://developers.facebook.com/docs/whatsapp/cloud-api/reference/media#supported-media-types.
       #
       # @return [WhatsappSdk::Api::Response] Response object.
+      sig { params(sender_id: Integer, file_path: String, type: String).returns(WhatsappSdk::Api::Response) }
       def upload(sender_id:, file_path:, type:)
         raise FileNotFoundError, file_path unless File.file?(file_path)
 
@@ -83,8 +91,9 @@ module WhatsappSdk
 
       # Delete a Media by ID.
       #
-      # @param media_id [Integer] Media Id.
+      # @param media_id [String] Media Id.
       # @return [WhatsappSdk::Api::Response] Response object.
+      sig { params(media_id: String).returns(WhatsappSdk::Api::Response) }
       def delete(media_id:)
         response = send_request(
           http_method: "delete",

data/lib/whatsapp_sdk/api/messages.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: strict
 
 require_relative "request"
 require_relative "response"
@@ -6,9 +7,15 @@ require_relative "response"
 module WhatsappSdk
   module Api
     class Messages < Request
+      extend T::Sig
+
       class MissingArgumentError < StandardError
+        extend T::Sig
+
+        sig { returns(String) }
         attr_reader :message
 
+        sig { params(message: String).void }
         def initialize(message)
           @message = message
           super(message)
@@ -21,6 +28,7 @@ module WhatsappSdk
       # @param recipient_number [Integer] Recipient' Phone number.
       # @param message [String] Text to send.
       # @return [WhatsappSdk::Api::Response] Response object.
+      sig { params(sender_id: Integer, recipient_number: Integer, message: String).returns(WhatsappSdk::Api::Response) }
       def send_text(sender_id:, recipient_number:, message:)
         params = {
           messaging_product: "whatsapp",
@@ -50,6 +58,12 @@ module WhatsappSdk
       # @param name [String] Location name.
       # @param address [String] Location address.
       # @return [WhatsappSdk::Api::Response] Response object.
+      sig do
+        params(
+          sender_id: Integer, recipient_number: Integer,
+          longitude: Float, latitude: Float, name: String, address: String
+        ).returns(WhatsappSdk::Api::Response)
+      end
       def send_location(sender_id:, recipient_number:, longitude:, latitude:, name:, address:)
         params = {
           messaging_product: "whatsapp",
@@ -79,10 +93,16 @@ module WhatsappSdk
       #
       # @param sender_id [Integer] Sender' phone number.
       # @param recipient_number [Integer] Recipient' Phone number.
-      # @param image_id [Integer] Image ID.
+      # @param image_id [String] Image ID.
       # @param link [String] Image link.
       # @param caption [String] Image caption.
       # @return [WhatsappSdk::Api::Response] Response object.
+      sig do
+        params(
+          sender_id: Integer, recipient_number: Integer, image_id: T.nilable(String),
+          link: T.nilable(String), caption: T.nilable(String)
+        ).returns(WhatsappSdk::Api::Response)
+      end
       def send_image(sender_id:, recipient_number:, image_id: nil, link: nil, caption: "")
         raise MissingArgumentError, "image_id or link is required" if !image_id && !link
 
@@ -113,9 +133,14 @@ module WhatsappSdk
       #
       # @param sender_id [Integer] Sender' phone number.
       # @param recipient_number [Integer] Recipient' Phone number.
-      # @param audio_id [Integer] Audio ID.
+      # @param audio_id [String] Audio ID.
       # @param link [String] Audio link.
       # @return [WhatsappSdk::Api::Response] Response object.
+      sig do
+        params(
+          sender_id: Integer, recipient_number: Integer, audio_id: T.nilable(String), link: T.nilable(String)
+        ).returns(WhatsappSdk::Api::Response)
+      end
       def send_audio(sender_id:, recipient_number:, audio_id: nil, link: nil)
         raise MissingArgumentError, "audio_id or link is required" if !audio_id && !link
 
@@ -142,10 +167,16 @@ module WhatsappSdk
       #
       # @param sender_id [Integer] Sender' phone number.
       # @param recipient_number [Integer] Recipient' Phone number.
-      # @param video_id [Integer] Video ID.
+      # @param video_id [String] Video ID.
       # @param link [String] Image link.
       # @param caption [String] Image caption.
       # @return [WhatsappSdk::Api::Response] Response object.
+      sig do
+        params(
+          sender_id: Integer, recipient_number: Integer,
+          video_id: T.nilable(String), link: T.nilable(String), caption: String
+        ).returns(WhatsappSdk::Api::Response)
+      end
       def send_video(sender_id:, recipient_number:, video_id: nil, link: nil, caption: "")
         raise MissingArgumentError, "video_id or link is required" if !video_id && !link
 
@@ -176,10 +207,16 @@ module WhatsappSdk
       #
       # @param sender_id [Integer] Sender' phone number.
       # @param recipient_number [Integer] Recipient' Phone number.
-      # @param document_id [Integer] document ID.
+      # @param document_id [String] document ID.
       # @param link [String] Image link.
       # @param caption [String] Image caption.
       # @return [WhatsappSdk::Api::Response] Response object.
+      sig do
+        params(
+          sender_id: Integer, recipient_number: Integer,
+          document_id: T.nilable(String), link: T.nilable(String), caption: String
+        ).returns(WhatsappSdk::Api::Response)
+      end
       def send_document(sender_id:, recipient_number:, document_id: nil, link: nil, caption: "")
         raise MissingArgumentError, "document or link is required" if !document_id && !link
 
@@ -210,8 +247,14 @@ module WhatsappSdk
       #
       # @param sender_id [Integer] Sender' phone number.
       # @param recipient_number [Integer] Recipient' Phone number.
+      # @param sticker_id [String] The sticker ID.
       # @param link [String] Image link.
       # @return [WhatsappSdk::Api::Response] Response object.
+      sig do
+        params(
+          sender_id: Integer, recipient_number: Integer, sticker_id: T.nilable(String), link: T.nilable(String)
+        ).returns(WhatsappSdk::Api::Response)
+      end
       def send_sticker(sender_id:, recipient_number:, sticker_id: nil, link: nil)
         raise MissingArgumentError, "sticker or link is required" if !sticker_id && !link
 
@@ -219,7 +262,7 @@ module WhatsappSdk
           messaging_product: "whatsapp",
           to: recipient_number,
           recipient_type: "individual",
-          type: "sticker"
+          type: Resource::Media::Type::Sticker
         }
         params[:sticker] = link ? { link: link } : { id: sticker_id }
 
@@ -242,6 +285,12 @@ module WhatsappSdk
       # @param contacts [Array<Contact>] Contacts.
       # @param contacts_json [Json] Contacts.
       # @return [WhatsappSdk::Api::Response] Response object.
+      sig do
+        params(
+          sender_id: Integer, recipient_number: Integer,
+          contacts: T.nilable(T::Array[WhatsappSdk::Resource::Contact]), contacts_json: T::Hash[T.untyped, T.untyped]
+        ).returns(WhatsappSdk::Api::Response)
+      end
       def send_contacts(sender_id:, recipient_number:, contacts: nil, contacts_json: {})
         params = {
           messaging_product: "whatsapp",
@@ -262,23 +311,24 @@ module WhatsappSdk
         )
       end
 
-      def send_interactive_button
-        # TODO: https://developers.facebook.com/docs/whatsapp_sdk/cloud-api/reference/messages#contacts-object
-      end
+      # def send_interactive_button
+      #   # TODO: https://developers.facebook.com/docs/whatsapp_sdk/cloud-api/reference/messages#contacts-object
+      # end
 
-      def send_interactive_reply_buttons
-        # TODO: https://developers.facebook.com/docs/whatsapp_sdk/cloud-api/reference/messages#contacts-object
-      end
+      # def send_interactive_reply_buttons
+      #   # TODO: https://developers.facebook.com/docs/whatsapp_sdk/cloud-api/reference/messages#contacts-object
+      # end
 
-      def send_interactive_section
-        # TODO: https://developers.facebook.com/docs/whatsapp_sdk/cloud-api/reference/messages#contacts-object
-      end
+      # def send_interactive_section
+      #   # TODO: https://developers.facebook.com/docs/whatsapp_sdk/cloud-api/reference/messages#contacts-object
+      # end
 
       # Mark a message as read.
       #
       # @param sender_id [Integer] Sender' phone number.
       # @param message_id [Integer] Message ID.
       # @return [WhatsappSdk::Api::Response] Response object.
+      sig { params(sender_id: Integer, message_id: String).returns(WhatsappSdk::Api::Response) }
       def read_message(sender_id:, message_id:)
         params = {
           messaging_product: "whatsapp",
@@ -306,6 +356,13 @@ module WhatsappSdk
       # @param components [Component] Component.
       # @param components_json [Json] The component as a Json. If you pass components_json, you can't pass components.
       # @return [WhatsappSdk::Api::Response] Response object.
+      sig do
+        params(
+          sender_id: Integer, recipient_number: Integer, name: String, language: String,
+          components: T.nilable(T::Array[WhatsappSdk::Resource::Component]),
+          components_json: T.nilable(T::Array[T::Hash[T.untyped, T.untyped]])
+        ).returns(WhatsappSdk::Api::Response)
+      end
       def send_template(sender_id:, recipient_number:, name:, language:, components: nil, components_json: nil)
         raise MissingArgumentError, "components or components_json is required" if !components && !components_json
 
@@ -339,6 +396,7 @@ module WhatsappSdk
 
       private
 
+      sig { params(sender_id: Integer).returns(String) }
       def endpoint(sender_id)
         "#{sender_id}/messages"
       end

data/lib/whatsapp_sdk/api/phone_numbers.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: strict
 
 require_relative "request"
 require_relative "response"
@@ -10,6 +11,7 @@ module WhatsappSdk
       #
       # @param business_id [Integer] Business Id.
       # @return [WhatsappSdk::Api::Response] Response object.
+      sig { params(business_id: Integer).returns(WhatsappSdk::Api::Response) }
       def registered_numbers(business_id)
         response = send_request(
           http_method: "get",
@@ -26,6 +28,7 @@ module WhatsappSdk
       #
       # @param phone_number_id [Integer] The registered number we want to retrieve.
       # @return [WhatsappSdk::Api::Response] Response object.
+      sig { params(phone_number_id: Integer).returns(WhatsappSdk::Api::Response) }
       def registered_number(phone_number_id)
         response = send_request(
           http_method: "get",

data/lib/whatsapp_sdk/api/request.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
+# typed: true
 
 module WhatsappSdk
   module Api
     class Request
-      API_VERSION = "v14.0"
-      API_CLIENT = "https://graph.facebook.com/#{API_VERSION}/"
+      extend T::Sig
 
       def initialize(client = WhatsappSdk.configuration.client)
         @client = client

data/lib/whatsapp_sdk/api/response.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: strict
 
 require_relative "responses/message_data_response"
 require_relative "responses/phone_number_data_response"
@@ -9,19 +10,34 @@ require_relative "responses/message_error_response"
 module WhatsappSdk
   module Api
     class Response
-      attr_accessor :error, :data
+      extend T::Sig
 
+      sig { returns(T.nilable(WhatsappSdk::Api::Responses::ErrorResponse)) }
+      attr_accessor :error
+
+      sig { returns(T.nilable(WhatsappSdk::Api::Responses::DataResponse)) }
+      attr_accessor :data
+
+      sig do
+        params(
+          response: T::Hash[T.untyped, T.untyped],
+          data_class_type: T.class_of(WhatsappSdk::Api::Responses::DataResponse),
+          error_class_type: T.class_of(WhatsappSdk::Api::Responses::ErrorResponse)
+        ).void
+      end
       def initialize(response:, data_class_type:, error_class_type: Responses::MessageErrorResponse)
         @data = data_class_type.build_from_response(response: response)
         @error = error_class_type.build_from_response(response: response)
       end
 
       # @return [Boolean] Whether or not the response is successful.
+      sig { returns(T::Boolean) }
       def ok?
         @error.nil?
       end
 
       # @return [Boolean] Whether or not the response has an error.
+      sig { returns(T::Boolean) }
       def error?
         !!@error
       end

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

@@ -1,18 +1,25 @@
 # frozen_string_literal: true
+# typed: strict
 
 module WhatsappSdk
   module Api
     module Responses
       class DataResponse
+        extend ::T::Sig
+        extend ::T::Helpers
+
+        abstract!
+
+        sig { returns(T::Hash[T.untyped, T.untyped]) }
         attr_reader :raw_data_response
 
+        sig { params(response: T::Hash[T.untyped, T.untyped]).void }
         def initialize(response)
           @raw_data_response = response
         end
 
-        def self.build_from_response(response:) # rubocop:disable Lint/UnusedMethodArgument:
-          raise NotImplemented
-        end
+        sig { abstract.params(response: T::Hash[T.untyped, T.untyped]).returns(T.nilable(DataResponse)) }
+        def self.build_from_response(response:); end
       end
     end
   end

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: strict
 
 require_relative "data_response"
 
@@ -6,14 +7,20 @@ module WhatsappSdk
   module Api
     module Responses
       class ErrorResponse < DataResponse
-        attr_accessor :error, :status
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_accessor :error
 
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :status
+
+        sig { params(response: T::Hash[T.untyped, T.untyped]).void }
         def initialize(response:)
           @error = response["error"]
           @status = response["status"]
           super(response)
         end
 
+        sig { override.params(response: T::Hash[T.untyped, T.untyped]).returns(T.nilable(ErrorResponse)) }
         def self.build_from_response(response:)
           return unless response["error"]
 

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: strict
 
 require_relative "data_response"
 
@@ -6,18 +7,36 @@ module WhatsappSdk
   module Api
     module Responses
       class MediaDataResponse < DataResponse
-        attr_accessor :id, :url, :mime_type, :sha256, :file_size, :messaging_product
+        sig { returns(String) }
+        attr_accessor :id
 
+        sig { returns(T.nilable(String)) }
+        attr_accessor :url
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :mime_type
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :sha256
+
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :file_size
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :messaging_product
+
+        sig { params(response: T::Hash[T.untyped, T.untyped]).void }
         def initialize(response)
-          @id = response["id"]
-          @messaging_product = response["messaging_product"]
-          @url = response["url"]
-          @mime_type = response["mime_type"]
-          @sha256 = response["sha256"]
-          @file_size = response["file_size"]
+          @id = T.let(response["id"], String)
+          @messaging_product = T.let(response["messaging_product"], T.nilable(String))
+          @url = T.let(response["url"], T.nilable(String))
+          @mime_type = T.let(response["mime_type"], T.nilable(String))
+          @sha256 = T.let(response["sha256"], T.nilable(String))
+          @file_size = T.let(response["file_size"], T.nilable(Integer))
           super(response)
         end
 
+        sig { override.params(response: T::Hash[T.untyped, T.untyped]).returns(T.nilable(MediaDataResponse)) }
         def self.build_from_response(response:)
           return unless response["id"]
 

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

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

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: strict
 
 require_relative "error_response"
 
@@ -6,18 +7,36 @@ module WhatsappSdk
   module Api
     module Responses
       class MessageErrorResponse < ErrorResponse
-        attr_reader :code, :subcode, :message, :type, :data, :fbtrace_id
+        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
+
+        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 = response["code"]
-          @subcode = response["error_subcode"]
-          @message = response["message"]
-          @type = response["type"]
-          @data = response["data"]
-          @fbtrace_id = response["fbtrace_id"]
+          @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)
         end
 
+        sig { override.params(response: T::Hash[T.untyped, T.untyped]).returns(T.nilable(MessageErrorResponse)) }
         def self.build_from_response(response:)
           error_response = response["error"]
           return unless error_response

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: strict
 
 require_relative "data_response"
 
@@ -6,16 +7,28 @@ module WhatsappSdk
   module Api
     module Responses
       class PhoneNumberDataResponse < DataResponse
-        attr_accessor :id, :verified_name, :display_phone_number, :quality_rating
+        sig { returns(String) }
+        attr_accessor :id
 
+        sig { returns(String) }
+        attr_accessor :verified_name
+
+        sig { returns(String) }
+        attr_accessor :display_phone_number
+
+        sig { returns(String) }
+        attr_accessor :quality_rating
+
+        sig { params(response: T::Hash[T.untyped, T.untyped]).void }
         def initialize(response)
-          @id = response["id"]
-          @verified_name = response["verified_name"]
-          @display_phone_number = response["display_phone_number"]
-          @quality_rating = response["quality_rating"]
+          @id = T.let(response["id"], String)
+          @verified_name = T.let(response["verified_name"], String)
+          @display_phone_number = T.let(response["display_phone_number"], String)
+          @quality_rating = T.let(response["quality_rating"], String)
           super(response)
         end
 
+        sig { override.params(response: T::Hash[T.untyped, T.untyped]).returns(T.nilable(PhoneNumberDataResponse)) }
         def self.build_from_response(response:)
           return unless response["id"]
 

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: strict
 
 require_relative "data_response"
 require_relative "phone_number_data_response"
@@ -7,13 +8,19 @@ module WhatsappSdk
   module Api
     module Responses
       class PhoneNumbersDataResponse < DataResponse
+        sig { returns(T::Array[PhoneNumberDataResponse]) }
         attr_reader :phone_numbers
 
+        sig { params(response: T::Hash[T.untyped, T.untyped]).void }
         def initialize(response)
-          @phone_numbers = response['data']&.map { |phone_number| parse_phone_number(phone_number) }
+          @phone_numbers = T.let(
+            response['data']&.map { |phone_number| parse_phone_number(phone_number) },
+            T::Array[PhoneNumberDataResponse]
+          )
           super(response)
         end
 
+        sig { override.params(response: T::Hash[T.untyped, T.untyped]).returns(T.nilable(PhoneNumbersDataResponse)) }
         def self.build_from_response(response:)
           return unless response["data"]
 
@@ -22,6 +29,7 @@ module WhatsappSdk
 
         private
 
+        sig { params(phone_number: T::Hash[T.untyped, T.untyped]).returns(PhoneNumberDataResponse) }
         def parse_phone_number(phone_number)
           PhoneNumberDataResponse.new(phone_number)
         end

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: strict
 
 require_relative "../request"
 require_relative "data_response"
@@ -9,18 +10,24 @@ module WhatsappSdk
   module Api
     module Responses
       class ReadMessageDataResponse < DataResponse
-        attr_reader :success
-
+        extend T::Sig
+        sig { params(response: T::Hash[T.untyped, T.untyped]).void }
         def initialize(response:)
-          @success = response["success"]
+          @success = T.let(response["success"], T::Boolean)
           super(response)
         end
 
+        sig { override.params(response: T::Hash[T.untyped, T.untyped]).returns(T.nilable(ReadMessageDataResponse)) }
         def self.build_from_response(response:)
           return if response["error"]
 
           new(response: response)
         end
+
+        sig { returns(T::Boolean) }
+        def success?
+          @success
+        end
       end
     end
   end