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

Inherits:
InstanceResource show all
Defined in:
lib/twilio-ruby/rest/pricing/v2/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) —

    The destination phone number, in E.164 format, for which to fetch the origin-based voice pricing information. E.164 format consists of a + followed by the country code and subscriber number.


118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/twilio-ruby/rest/pricing/v2/number.rb', line 118

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'],
      'terminating_prefix_prices' => payload['terminating_prefix_prices'],
      'originating_call_price' => payload['originating_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:


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

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

#country ⇒ String

Returns The name of the country.

Returns:

  • (String) —

    The name of the country


163
164
165
 
# File 'lib/twilio-ruby/rest/pricing/v2/number.rb', line 163

def country
  @properties['country']
end

#destination_number ⇒ String

Returns The destination phone number, in E.164 format.

Returns:

  • (String) —

    The destination phone number, in E.164 format


151
152
153
 
# File 'lib/twilio-ruby/rest/pricing/v2/number.rb', line 151

def destination_number
  @properties['destination_number']
end

#fetch(origination_number: :unset) ⇒ NumberInstance

Fetch the NumberInstance

Parameters:

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

    The origination phone number, in E.164 format, for which to fetch the origin-based voice pricing information. E.164 format consists of a + followed by the country code and subscriber number.

Returns:


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

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

#inspect ⇒ Object

Provide a detailed, user friendly representation


217
218
219
220
 
# File 'lib/twilio-ruby/rest/pricing/v2/number.rb', line 217

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


169
170
171
 
# File 'lib/twilio-ruby/rest/pricing/v2/number.rb', line 169

def iso_country
  @properties['iso_country']
end

#originating_call_price ⇒ String

Returns The OriginatingCallPrice record.

Returns:

  • (String) —

    The OriginatingCallPrice record


181
182
183
 
# File 'lib/twilio-ruby/rest/pricing/v2/number.rb', line 181

def originating_call_price
  @properties['originating_call_price']
end

#origination_number ⇒ String

Returns The origination phone number, in E.164 format.

Returns:

  • (String) —

    The origination phone number, in E.164 format


157
158
159
 
# File 'lib/twilio-ruby/rest/pricing/v2/number.rb', line 157

def origination_number
  @properties['origination_number']
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)


187
188
189
 
# File 'lib/twilio-ruby/rest/pricing/v2/number.rb', line 187

def price_unit
  @properties['price_unit']
end

#terminating_prefix_prices ⇒ Array[String]

Returns The terminating_prefix_prices.

Returns:

  • (Array[String]) —

    The terminating_prefix_prices


175
176
177
 
# File 'lib/twilio-ruby/rest/pricing/v2/number.rb', line 175

def terminating_prefix_prices
  @properties['terminating_prefix_prices']
end

#to_s ⇒ Object

Provide a user friendly representation


210
211
212
213
 
# File 'lib/twilio-ruby/rest/pricing/v2/number.rb', line 210

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

#url ⇒ String

Returns The absolute URL of the resource.

Returns:

  • (String) —

    The absolute URL of the resource


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

def url
  @properties['url']
end