Class: Twilio::REST::Pricing::V2::VoiceList::NumberInstance

Inherits:
InstanceResource show all
Defined in:
lib/twilio-ruby/rest/pricing/v2/voice/number.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, destination_number: nil) ⇒ NumberInstance

Initialize the NumberInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • destination_number (String) (defaults to: nil) —

    This fetches the origin-based voice pricing information for a phone number



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/twilio-ruby/rest/pricing/v2/voice/number.rb', line 109

def initialize(version, payload, destination_number: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'destination_number' => payload['destination_number'],
      'origination_number' => payload['origination_number'],
      'country' => payload['country'],
      'iso_country' => payload['iso_country'],
      'outbound_call_prices' => payload['outbound_call_prices'],
      'inbound_call_price' => payload['inbound_call_price'],
      'price_unit' => payload['price_unit'],
      'url' => payload['url'],
  }

  # Context
  @instance_context = nil
  @params = {'destination_number' => destination_number || @properties['destination_number'], }
end

Instance Method Details

#context ⇒ NumberContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:



133
134
135
136
137
138
 
# File 'lib/twilio-ruby/rest/pricing/v2/voice/number.rb', line 133

def context
  unless @instance_context
    @instance_context = NumberContext.new(@version, @params['destination_number'], )
  end
  @instance_context
end

#country ⇒ String

Returns Name of the country.

Returns:

  • (String) —

    Name of the country



154
155
156
 
# File 'lib/twilio-ruby/rest/pricing/v2/voice/number.rb', line 154

def country
  @properties['country']
end

#destination_number ⇒ String

Returns The destination phone number, in E.164.

Returns:

  • (String) —

    The destination phone number, in E.164



142
143
144
 
# File 'lib/twilio-ruby/rest/pricing/v2/voice/number.rb', line 142

def destination_number
  @properties['destination_number']
end

#fetch(origination_number: :unset) ⇒ NumberInstance

Fetch a NumberInstance

Parameters:

  • origination_number (String) (defaults to: :unset) —

    The origination_number

Returns:



192
193
194
 
# File 'lib/twilio-ruby/rest/pricing/v2/voice/number.rb', line 192

def fetch(origination_number: :unset)
  context.fetch(origination_number: origination_number, )
end

#inbound_call_price ⇒ String

Returns List of InboundCallPrice records.

Returns:

  • (String) —

    List of InboundCallPrice records



172
173
174
 
# File 'lib/twilio-ruby/rest/pricing/v2/voice/number.rb', line 172

def inbound_call_price
  @properties['inbound_call_price']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



205
206
207
208
 
# File 'lib/twilio-ruby/rest/pricing/v2/voice/number.rb', line 205

def inspect
  values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.Pricing.V2.NumberInstance #{values}>"
end

#iso_country ⇒ String

Returns The ISO country code.

Returns:

  • (String) —

    The ISO country code



160
161
162
 
# File 'lib/twilio-ruby/rest/pricing/v2/voice/number.rb', line 160

def iso_country
  @properties['iso_country']
end

#origination_number ⇒ String

Returns The origination phone number, in E.164.

Returns:

  • (String) —

    The origination phone number, in E.164



148
149
150
 
# File 'lib/twilio-ruby/rest/pricing/v2/voice/number.rb', line 148

def origination_number
  @properties['origination_number']
end

#outbound_call_prices ⇒ String

Returns List of OutboundCallPriceWithOrigin records.

Returns:

  • (String) —

    List of OutboundCallPriceWithOrigin records



166
167
168
 
# File 'lib/twilio-ruby/rest/pricing/v2/voice/number.rb', line 166

def outbound_call_prices
  @properties['outbound_call_prices']
end

#price_unit ⇒ String

Returns The currency in which prices are measured, in ISO 4127 format (e.g. usd, eur, jpy).

Returns:

  • (String) —

    The currency in which prices are measured, in ISO 4127 format (e.g. usd, eur, jpy).



178
179
180
 
# File 'lib/twilio-ruby/rest/pricing/v2/voice/number.rb', line 178

def price_unit
  @properties['price_unit']
end

#to_s ⇒ Object

Provide a user friendly representation



198
199
200
201
 
# File 'lib/twilio-ruby/rest/pricing/v2/voice/number.rb', line 198

def to_s
  values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.Pricing.V2.NumberInstance #{values}>"
end

#url ⇒ String

Returns The URL of this resource.

Returns:

  • (String) —

    The URL of this resource.



184
185
186
 
# File 'lib/twilio-ruby/rest/pricing/v2/voice/number.rb', line 184

def url
  @properties['url']
end