Class: Twilio::REST::Preview::Wireless::RatePlanList

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

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ RatePlanList

Initialize the RatePlanList



26
27
28
29
30
31
32
 
# File 'lib/twilio-ruby/rest/preview/wireless/rate_plan.rb', line 26

def initialize(version)
    super(version)
    # Path Solution
    @solution = {  }
    @uri = "/RatePlans"
    
end

Instance Method Details

#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) ⇒ RatePlanInstance

Create the RatePlanInstance



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/twilio-ruby/rest/preview/wireless/rate_plan.rb', line 46

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
)

    data = Twilio::Values.of({
        'UniqueName' => unique_name,
        'FriendlyName' => friendly_name,
        'DataEnabled' => data_enabled,
        'DataLimit' => data_limit,
        'DataMetering' => data_metering,
        'MessagingEnabled' => messaging_enabled,
        'VoiceEnabled' => voice_enabled,
        'CommandsEnabled' => commands_enabled,
        'NationalRoamingEnabled' => national_roaming_enabled,
        'InternationalRoaming' => Twilio.serialize_list(international_roaming) { |e| e },
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.create('POST', @uri, data: data, headers: headers)
    RatePlanInstance.new(
        @version,
        payload,
    )
end

#each ⇒ Object

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



128
129
130
131
132
133
134
135
136
 
# File 'lib/twilio-ruby/rest/preview/wireless/rate_plan.rb', line 128

def each
    limits = @version.read_limits

    page = self.page(page_size: limits[:page_size], )

    @version.stream(page,
        limit: limits[:limit],
        page_limit: limits[:page_limit]).each {|x| yield x}
end

#get_page(target_url) ⇒ Page

Retrieve a single page of RatePlanInstance records from the API. Request is executed immediately.



165
166
167
168
169
170
171
 
# File 'lib/twilio-ruby/rest/preview/wireless/rate_plan.rb', line 165

def get_page(target_url)
    response = @version.domain.request(
        'GET',
        target_url
    )
RatePlanPage.new(@version, response, @solution)
end

#list(limit: nil, page_size: nil) ⇒ Array

Lists RatePlanInstance records from the API as a list. Unlike stream(), this operation is eager and will load ‘limit` records into memory before returning.



97
98
99
100
101
102
 
# File 'lib/twilio-ruby/rest/preview/wireless/rate_plan.rb', line 97

def list(limit: nil, page_size: nil)
    self.stream(
        limit: limit,
        page_size: page_size
    ).entries
end

#page(page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

Retrieve a single page of RatePlanInstance records from the API. Request is executed immediately.



145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/twilio-ruby/rest/preview/wireless/rate_plan.rb', line 145

def page(page_token: :unset, page_number: :unset, page_size: :unset)
    params = Twilio::Values.of({
        'PageToken' => page_token,
        'Page' => page_number,
        'PageSize' => page_size,
    })
    headers = Twilio::Values.of({})
    
    

    response = @version.page('GET', @uri, params: params, headers: headers)

    RatePlanPage.new(@version, response, @solution)
end

#stream(limit: nil, page_size: nil) ⇒ Enumerable

Streams Instance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.



115
116
117
118
119
120
121
122
 
# File 'lib/twilio-ruby/rest/preview/wireless/rate_plan.rb', line 115

def stream(limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)

    page = self.page(
        page_size: limits[:page_size], )

    @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
end

#to_s ⇒ Object

Provide a user friendly representation



176
177
178
 
# File 'lib/twilio-ruby/rest/preview/wireless/rate_plan.rb', line 176

def to_s
    '#<Twilio.Preview.Wireless.RatePlanList>'
end