Class: Twilio::REST::Preview::Wireless::RatePlanInstance

Inherits:
InstanceResource show all
Defined in:
lib/twilio-ruby/rest/preview/wireless/rate_plan.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, sid: nil) ⇒ RatePlanInstance

Initialize the RatePlanInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • account_sid (String) —

    The SID of the Account that created this RatePlan resource.

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

    The SID of the Call resource to fetch.



589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
 
# File 'lib/twilio-ruby/rest/preview/wireless/rate_plan.rb', line 589

def initialize(version, payload , sid: nil)
    super(version)
    
    
    # Marshaled Properties
    @properties = { 
        'sid' => payload['sid'],
        'unique_name' => payload['unique_name'],
        'account_sid' => payload['account_sid'],
        'friendly_name' => payload['friendly_name'],
        'data_enabled' => payload['data_enabled'],
        'data_metering' => payload['data_metering'],
        'data_limit' => payload['data_limit'] == nil ? payload['data_limit'] : payload['data_limit'].to_i,
        'messaging_enabled' => payload['messaging_enabled'],
        'voice_enabled' => payload['voice_enabled'],
        'national_roaming_enabled' => payload['national_roaming_enabled'],
        'international_roaming' => payload['international_roaming'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
        'url' => payload['url'],
    }

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

Instance Method Details

#account_sid ⇒ String

Returns:

  • (String) 


641
642
643
 
# File 'lib/twilio-ruby/rest/preview/wireless/rate_plan.rb', line 641

def 
    @properties['account_sid']
end

#context ⇒ RatePlanContext

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

Returns:



620
621
622
623
624
625
 
# File 'lib/twilio-ruby/rest/preview/wireless/rate_plan.rb', line 620

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

#data_enabled ⇒ Boolean

Returns:

  • (Boolean) 


653
654
655
 
# File 'lib/twilio-ruby/rest/preview/wireless/rate_plan.rb', line 653

def data_enabled
    @properties['data_enabled']
end

#data_limit ⇒ String

Returns:

  • (String) 


665
666
667
 
# File 'lib/twilio-ruby/rest/preview/wireless/rate_plan.rb', line 665

def data_limit
    @properties['data_limit']
end

#data_metering ⇒ String

Returns:

  • (String) 


659
660
661
 
# File 'lib/twilio-ruby/rest/preview/wireless/rate_plan.rb', line 659

def data_metering
    @properties['data_metering']
end

#date_created ⇒ Time

Returns:

  • (Time) 


695
696
697
 
# File 'lib/twilio-ruby/rest/preview/wireless/rate_plan.rb', line 695

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns:

  • (Time) 


701
702
703
 
# File 'lib/twilio-ruby/rest/preview/wireless/rate_plan.rb', line 701

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the RatePlanInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



714
715
716
717
 
# File 'lib/twilio-ruby/rest/preview/wireless/rate_plan.rb', line 714

def delete

    context.delete
end

#fetch ⇒ RatePlanInstance

Fetch the RatePlanInstance

Returns:



722
723
724
725
 
# File 'lib/twilio-ruby/rest/preview/wireless/rate_plan.rb', line 722

def fetch

    context.fetch
end

#friendly_name ⇒ String

Returns:

  • (String) 


647
648
649
 
# File 'lib/twilio-ruby/rest/preview/wireless/rate_plan.rb', line 647

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



752
753
754
755
 
# File 'lib/twilio-ruby/rest/preview/wireless/rate_plan.rb', line 752

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

#international_roaming ⇒ Array<String>

Returns:

  • (Array<String>) 


689
690
691
 
# File 'lib/twilio-ruby/rest/preview/wireless/rate_plan.rb', line 689

def international_roaming
    @properties['international_roaming']
end

#messaging_enabled ⇒ Boolean

Returns:

  • (Boolean) 


671
672
673
 
# File 'lib/twilio-ruby/rest/preview/wireless/rate_plan.rb', line 671

def messaging_enabled
    @properties['messaging_enabled']
end

#national_roaming_enabled ⇒ Boolean

Returns:

  • (Boolean) 


683
684
685
 
# File 'lib/twilio-ruby/rest/preview/wireless/rate_plan.rb', line 683

def national_roaming_enabled
    @properties['national_roaming_enabled']
end

#sid ⇒ String

Returns:

  • (String) 


629
630
631
 
# File 'lib/twilio-ruby/rest/preview/wireless/rate_plan.rb', line 629

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



745
746
747
748
 
# File 'lib/twilio-ruby/rest/preview/wireless/rate_plan.rb', line 745

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

#unique_name ⇒ String

Returns:

  • (String) 


635
636
637
 
# File 'lib/twilio-ruby/rest/preview/wireless/rate_plan.rb', line 635

def unique_name
    @properties['unique_name']
end

#update(unique_name: :unset, friendly_name: :unset) ⇒ RatePlanInstance

Update the RatePlanInstance

Parameters:

  • unique_name (String) (defaults to: :unset)
  • friendly_name (String) (defaults to: :unset)

Returns:



732
733
734
735
736
737
738
739
740
741
 
# File 'lib/twilio-ruby/rest/preview/wireless/rate_plan.rb', line 732

def update(
  unique_name: :unset, 
  friendly_name: :unset
)

    context.update(
        unique_name: unique_name, 
        friendly_name: friendly_name, 
    )
end

#url ⇒ String

Returns:

  • (String) 


707
708
709
 
# File 'lib/twilio-ruby/rest/preview/wireless/rate_plan.rb', line 707

def url
    @properties['url']
end

#voice_enabled ⇒ Boolean

Returns:

  • (Boolean) 


677
678
679
 
# File 'lib/twilio-ruby/rest/preview/wireless/rate_plan.rb', line 677

def voice_enabled
    @properties['voice_enabled']
end