Class: Twilio::Rails::PhoneNumber

Inherits:
Object
  • Object
show all
Defined in:
lib/twilio/rails/phone_number.rb

Overview

A phone number object that includes the country and some optional metadata.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(number:, country:, label: nil, project: nil) ⇒ PhoneNumber

Returns a new instance of PhoneNumber.

Parameters:

  • number (String) —

    the phone number string.

  • country (String) —

    the country code.

  • label (String, nil) (defaults to: nil) —

    an optional label for the phone number, such as its source or purpose.

  • project (String, nil) (defaults to: nil) —

    an optional project identifier for grouping phone numbers.

Raises:



13
14
15
16
17
18
19
 
# File 'lib/twilio/rails/phone_number.rb', line 13

def initialize(number:, country:, label: nil, project: nil)
  @number = Twilio::Rails::PhoneNumberFormatter.coerce(number)
  raise Twilio::Rails::Phone::Error, "Invalid phone number '#{number}'" unless @number
  @country = country&.upcase
  @label = label
  @project = project.presence&.to_s
end

Instance Attribute Details

#country ⇒ Object (readonly)

Returns the value of attribute country.



7
8
9
 
# File 'lib/twilio/rails/phone_number.rb', line 7

def country
  @country
end

#label ⇒ Object (readonly)

Returns the value of attribute label.



7
8
9
 
# File 'lib/twilio/rails/phone_number.rb', line 7

def label
  @label
end

#number ⇒ Object (readonly)

Returns the value of attribute number.



7
8
9
 
# File 'lib/twilio/rails/phone_number.rb', line 7

def number
  @number
end

#project ⇒ Object (readonly)

Returns the value of attribute project.



7
8
9
 
# File 'lib/twilio/rails/phone_number.rb', line 7

def project
  @project
end

Instance Method Details

#to_s ⇒ String

Returns a human readable string representation of the phone number and its metadata.

Returns:

  • (String) —

    a human readable string representation of the phone number and its metadata.



22
23
24
25
26
27
 
# File 'lib/twilio/rails/phone_number.rb', line 22

def to_s
  s = "Phone number #{number} (#{country})"
  s = "#{s} #{label}" if label.present?
  s = "#{s} for #{project}" if project.present?
  s
end