Class: Whatsapp::BusinessPhoneNumber::RequestCode

Inherits:

Object

• Object
• Whatsapp::BusinessPhoneNumber::RequestCode

Extended by:

Transport, ResponseHandling

Includes:

ActiveModel::Validations

Defined in:

lib/ruby/whatsapp/business_phone_number/request_code.rb

Overview

Requests a verification code (by SMS or voice call) for a business phone number — the first step of the onboarding flow this module wraps end to end: RequestCode -> VerifyCode -> Register. Source: https://developers.facebook.com/documentation/business-messaging/whatsapp/reference/whatsapp-business-phone-number/phone-number-verification-request-code-api

Defined Under Namespace

Modules: CodeMethods, Defaults

Constant Summary

Constants included from ResponseHandling

ResponseHandling::MAX_ERROR_BODY

Instance Attribute Summary

• #code_method ⇒ String

  One of CodeMethods::ALL.

• #language ⇒ String

  The locale for the verification message (e.g. "en_US").

Class Method Summary

• .call(code_method:, language:, client: Client.new) ⇒ Response

Instance Method Summary

• #initialize(code_method:, language:) ⇒ RequestCode constructor

  A new instance of RequestCode.

• #serialize ⇒ Hash

  The request-code payload.

Constructor Details

#initialize(code_method:, language:) ⇒ RequestCode

Returns a new instance of RequestCode.

Parameters:

• code_method (String, Symbol) —

  One of Whatsapp::BusinessPhoneNumber::RequestCode::CodeMethods::ALL, either casing.

• language (String) —

  The locale for the verification message. Meta publishes no enum for this field, so only presence is checked — unlike Whatsapp::BusinessPhoneNumber::Register's pin, which has a documented format.

Raises:

• (ActiveModel::ValidationError) —

  if validation fails.

# File 'lib/ruby/whatsapp/business_phone_number/request_code.rb', line 54

def initialize(code_method:, language:)
  @code_method = CodeMethods.normalize(code_method)
  @language = language

  validate!
end

Instance Attribute Details

#code_method ⇒ String

Returns One of Whatsapp::BusinessPhoneNumber::RequestCode::CodeMethods::ALL.

Returns:

• (String) —

  One of Whatsapp::BusinessPhoneNumber::RequestCode::CodeMethods::ALL.

# File 'lib/ruby/whatsapp/business_phone_number/request_code.rb', line 40

def code_method
  @code_method
end

#language ⇒ String

Returns The locale for the verification message (e.g. "en_US").

Returns:

• (String) —

  The locale for the verification message (e.g. "en_US").

# File 'lib/ruby/whatsapp/business_phone_number/request_code.rb', line 44

def language
  @language
end

Class Method Details

.call(code_method:, language:, client: Client.new) ⇒ Response

Parameters:

• code_method (String, Symbol) —

  See #initialize.

• language (String) —

  See #initialize.

• client (Whatsapp::Client) (defaults to: Client.new) —

  The WhatsApp client instance.

Returns:

• (Response)

Raises:

• (ActiveModel::ValidationError) —

  if the code method or language is invalid.

• (Error) —

  if no phone number ID is configured, or the request fails.

# File 'lib/ruby/whatsapp/business_phone_number/request_code.rb', line 74

def call(code_method:, language:, client: Client.new)
  body = new(code_method:, language:).serialize
  response = client.connection.post(edge_path(client, Defaults::EDGE), json: body)

  Response.deserialize(
    parse_json(handle_response!(response, error_class: Error, action: "request verification code"))
  )
end

Instance Method Details

#serialize ⇒ Hash

Returns The request-code payload. Both fields are documented required, so neither is ever compacted away.

Returns:

• (Hash) —

  The request-code payload. Both fields are documented required, so neither is ever compacted away.

# File 'lib/ruby/whatsapp/business_phone_number/request_code.rb', line 63

def serialize
  { code_method:, language: }
end