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

Parameters:

  • version (Version)

    Version that contains the resource



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

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

Parameters:

  • unique_name (String) (defaults to: :unset)
  • friendly_name (String) (defaults to: :unset)
  • data_enabled (Boolean) (defaults to: :unset)
  • data_limit (String) (defaults to: :unset)
  • data_metering (String) (defaults to: :unset)
  • messaging_enabled (Boolean) (defaults to: :unset)
  • voice_enabled (Boolean) (defaults to: :unset)
  • commands_enabled (Boolean) (defaults to: :unset)
  • national_roaming_enabled (Boolean) (defaults to: :unset)
  • international_roaming (Array[String]) (defaults to: :unset)

Returns:



45
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
# File 'lib/twilio-ruby/rest/preview/wireless/rate_plan.rb', line 45

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 },
    })

    payload = @version.create('POST', @uri, data: data)
    RatePlanInstance.new(
        @version,
        payload,
    )
end

#eachObject

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



121
122
123
124
125
126
127
128
129
# File 'lib/twilio-ruby/rest/preview/wireless/rate_plan.rb', line 121

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.

Parameters:

  • target_url (String)

    API-generated URL for the requested results page

Returns:

  • (Page)

    Page of RatePlanInstance



155
156
157
158
159
160
161
# File 'lib/twilio-ruby/rest/preview/wireless/rate_plan.rb', line 155

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.

Parameters:

  • limit (Integer) (defaults to: nil)

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • page_size (Integer) (defaults to: nil)

    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)

Returns:

  • (Array)

    Array of up to limit results



90
91
92
93
94
95
# File 'lib/twilio-ruby/rest/preview/wireless/rate_plan.rb', line 90

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.

Parameters:

  • page_token (String) (defaults to: :unset)

    PageToken provided by the API

  • page_number (Integer) (defaults to: :unset)

    Page Number, this value is simply for client state

  • page_size (Integer) (defaults to: :unset)

    Number of records to return, defaults to 50

Returns:

  • (Page)

    Page of RatePlanInstance



138
139
140
141
142
143
144
145
146
147
148
# File 'lib/twilio-ruby/rest/preview/wireless/rate_plan.rb', line 138

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

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

    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.

Parameters:

  • limit (Integer) (defaults to: nil)

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • page_size (Integer) (defaults to: nil)

    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)

Returns:

  • (Enumerable)

    Enumerable that will yield up to limit results



108
109
110
111
112
113
114
115
# File 'lib/twilio-ruby/rest/preview/wireless/rate_plan.rb', line 108

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_sObject

Provide a user friendly representation



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

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