class Twilio::REST::Preview::Wireless::RatePlanList

PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.

Public Class Methods

new(version) click to toggle source

Initialize the RatePlanList @param [Version] version Version that contains the resource @return [RatePlanList] RatePlanList

Calls superclass method Twilio::REST::ListResource::new
   # File lib/twilio-ruby/rest/preview/wireless/rate_plan.rb
20 def initialize(version)
21   super(version)
22 
23   # Path Solution
24   @solution = {}
25   @uri = "/RatePlans"
26 end

Public Instance Methods

create(unique_name: :unset, friendly_name: :unset, data_enabled: :unset, data_limit: :unset, data_metering: :unset, messaging_enabled: :unset, voice_enabled: :unset, commands_enabled: :unset, national_roaming_enabled: :unset, international_roaming: :unset) click to toggle source

Create the RatePlanInstance @param [String] unique_name The unique_name @param [String] friendly_name The friendly_name @param [Boolean] data_enabled The data_enabled @param [String] data_limit The data_limit @param [String] data_metering The data_metering @param [Boolean] messaging_enabled The messaging_enabled @param [Boolean] voice_enabled The voice_enabled @param [Boolean] commands_enabled The commands_enabled @param [Boolean] national_roaming_enabled The national_roaming_enabled @param [Array] international_roaming The international_roaming @return [RatePlanInstance] Created RatePlanInstance

    # File lib/twilio-ruby/rest/preview/wireless/rate_plan.rb
121 def create(unique_name: :unset, friendly_name: :unset, data_enabled: :unset, data_limit: :unset, data_metering: :unset, messaging_enabled: :unset, voice_enabled: :unset, commands_enabled: :unset, national_roaming_enabled: :unset, international_roaming: :unset)
122   data = Twilio::Values.of({
123       'UniqueName' => unique_name,
124       'FriendlyName' => friendly_name,
125       'DataEnabled' => data_enabled,
126       'DataLimit' => data_limit,
127       'DataMetering' => data_metering,
128       'MessagingEnabled' => messaging_enabled,
129       'VoiceEnabled' => voice_enabled,
130       'CommandsEnabled' => commands_enabled,
131       'NationalRoamingEnabled' => national_roaming_enabled,
132       'InternationalRoaming' => Twilio.serialize_list(international_roaming) { |e| e },
133   })
134 
135   payload = @version.create('POST', @uri, data: data)
136 
137   RatePlanInstance.new(@version, payload, )
138 end
each() { |x| ... } click to toggle source

When passed a block, yields RatePlanInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.

   # File lib/twilio-ruby/rest/preview/wireless/rate_plan.rb
66 def each
67   limits = @version.read_limits
68 
69   page = self.page(page_size: limits[:page_size], )
70 
71   @version.stream(page,
72                   limit: limits[:limit],
73                   page_limit: limits[:page_limit]).each {|x| yield x}
74 end
get_page(target_url) click to toggle source

Retrieve a single page of RatePlanInstance records from the API. Request is executed immediately. @param [String] target_url API-generated URL for the requested results page @return [Page] Page of RatePlanInstance

    # File lib/twilio-ruby/rest/preview/wireless/rate_plan.rb
100 def get_page(target_url)
101   response = @version.domain.request(
102       'GET',
103       target_url
104   )
105   RatePlanPage.new(@version, response, @solution)
106 end
list(limit: nil, page_size: nil) click to toggle source

Lists RatePlanInstance records from the API as a list. Unlike stream(), this operation is eager and will load `limit` records into memory before returning. @param [Integer] limit Upper limit for the number of records to return. stream()

guarantees to never return more than limit.  Default is no limit

@param [Integer] page_size Number of records to fetch per request, when

not set will use the default value of 50 records.  If no page_size is defined
but a limit is defined, stream() will attempt to read the limit with the most
efficient page size, i.e. min(limit, 1000)

@return [Array] Array of up to limit results

   # File lib/twilio-ruby/rest/preview/wireless/rate_plan.rb
39 def list(limit: nil, page_size: nil)
40   self.stream(limit: limit, page_size: page_size).entries
41 end
page(page_token: :unset, page_number: :unset, page_size: :unset) click to toggle source

Retrieve a single page of RatePlanInstance records from the API. Request is executed immediately. @param [String] page_token PageToken provided by the API @param [Integer] page_number Page Number, this value is simply for client state @param [Integer] page_size Number of records to return, defaults to 50 @return [Page] Page of RatePlanInstance

   # File lib/twilio-ruby/rest/preview/wireless/rate_plan.rb
83 def page(page_token: :unset, page_number: :unset, page_size: :unset)
84   params = Twilio::Values.of({
85       'PageToken' => page_token,
86       'Page' => page_number,
87       'PageSize' => page_size,
88   })
89 
90   response = @version.page('GET', @uri, params: params)
91 
92   RatePlanPage.new(@version, response, @solution)
93 end
stream(limit: nil, page_size: nil) click to toggle source

Streams RatePlanInstance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached. @param [Integer] limit Upper limit for the number of records to return. stream()

guarantees to never return more than limit. Default is no limit.

@param [Integer] page_size Number of records to fetch per request, when

not set will use the default value of 50 records. If no page_size is defined
but a limit is defined, stream() will attempt to read the limit with the most
efficient page size, i.e. min(limit, 1000)

@return [Enumerable] Enumerable that will yield up to limit results

   # File lib/twilio-ruby/rest/preview/wireless/rate_plan.rb
54 def stream(limit: nil, page_size: nil)
55   limits = @version.read_limits(limit, page_size)
56 
57   page = self.page(page_size: limits[:page_size], )
58 
59   @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
60 end
to_s() click to toggle source

Provide a user friendly representation

    # File lib/twilio-ruby/rest/preview/wireless/rate_plan.rb
142 def to_s
143   '#<Twilio.Preview.Wireless.RatePlanList>'
144 end