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.



581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
 
# File 'lib/twilio-ruby/rest/preview/wireless/rate_plan.rb', line 581

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) 


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

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:



612
613
614
615
616
617
 
# File 'lib/twilio-ruby/rest/preview/wireless/rate_plan.rb', line 612

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

#data_enabled ⇒ Boolean

Returns:

  • (Boolean) 


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

def data_enabled
    @properties['data_enabled']
end

#data_limit ⇒ String

Returns:

  • (String) 


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

def data_limit
    @properties['data_limit']
end

#data_metering ⇒ String

Returns:

  • (String) 


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

def data_metering
    @properties['data_metering']
end

#date_created ⇒ Time

Returns:

  • (Time) 


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

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns:

  • (Time) 


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

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the RatePlanInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



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

def delete

    context.delete
end

#fetch ⇒ RatePlanInstance

Fetch the RatePlanInstance

Returns:



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

def fetch

    context.fetch
end

#friendly_name ⇒ String

Returns:

  • (String) 


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

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#international_roaming ⇒ Array<String>

Returns:

  • (Array<String>) 


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

def international_roaming
    @properties['international_roaming']
end

#messaging_enabled ⇒ Boolean

Returns:

  • (Boolean) 


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

def messaging_enabled
    @properties['messaging_enabled']
end

#national_roaming_enabled ⇒ Boolean

Returns:

  • (Boolean) 


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

def national_roaming_enabled
    @properties['national_roaming_enabled']
end

#sid ⇒ String

Returns:

  • (String) 


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

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



737
738
739
740
 
# File 'lib/twilio-ruby/rest/preview/wireless/rate_plan.rb', line 737

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

#unique_name ⇒ String

Returns:

  • (String) 


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

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:



724
725
726
727
728
729
730
731
732
733
 
# File 'lib/twilio-ruby/rest/preview/wireless/rate_plan.rb', line 724

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

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

#url ⇒ String

Returns:

  • (String) 


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

def url
    @properties['url']
end

#voice_enabled ⇒ Boolean

Returns:

  • (Boolean) 


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

def voice_enabled
    @properties['voice_enabled']
end